seekret.apitest 0.1.1

Seekret's library for API testing runtime

Seekret API testing runtime

The seekret.apitest package contains runtime functions and tools intended to ease API testing.

The seekret.apitest package is not used directly, but is referenced within tavern tests generated by Seekret.

Quickstart

First, install tavern and seekret.apitest: pip install tavern seekret.apitest

Now, in order to run a test:

1. Store one or more generated tavern tests from the Seekret website in a directory.
2. Copy the configuration file you received from Seekret to the same directory.

Your test directory should look like this:

/testdir
|-- test_1.tavern.yaml
|-- test_2.tavern.yaml
|-- ...
|-- config.yaml

After your test directory is set up, run pytest --tavern-global-cfg config.yaml.

Tavern will collect all test_*.tavern.yaml files and run the described tests.

Understanding the configuration and generated tests

Tavern tests generated by Seekret use common variables which are expected to be set using an external configuration. This currently includes the host of the target servers and the authorization settings.

Example generated test file:

# test_1.tavern.yaml

stages:
  - name: POST /user
    request:
      headers:
        $ext:
          function: seekret.apitest:add_auth_in_headers
          # This section defines that the headers are extended with
          # the result of the `add_auth_in_headers` function.
          # The `add_auth_in_headers` function uses Seekret-format
          # authorization settings defined in the configuration file
          # in the "user" variable.
          extra_kwargs:
            auth_data: !force_format_include '{user.data}'
            auth_type: '{user.type}'
      json:
        # Randomized body values, created during test generation.
        email: [e-mail]
        name: vrdyin
        photo: https://hernandez.biz/
      method: POST
      url: '{host}/user' # The "host" variable from the configuration file.
    response:
      save:
        json:
          # Later tests can use the `userId` value from this response
          # by specifying this variable name.
          saved_0_responseBody_userId: userId
      status_code:
        - 200

Example configuration file:

name: Global test configuration
description: |
  Global configuration for running the tavern tests.

variables:
  host: http://example.com
  user:
    type: bearer
    data:
      token: <Preconfigured API token for the test user>