![\"\"](\"tavern_header.png\")
<\/p>\n<\/p>\n
\n“Tavern is a pytest<\/strong> plugin, command-line tool and Python<\/strong> library for automated testing of APIs<\/strong>, with a simple, concise and flexible YAML-based syntax” (https:\/\/taverntesting.github.io\/<\/a>)<\/p>\n<\/blockquote>\n
I created GitHub repo<\/a> containing 30+ simple Tavern test examples and decided\u00a0 to share it on my website.\u00a0 I think it can helpful for someone like me who has just started to learn Tavern\u00a0 or looking for a\u00a0 tool to automate API testing. You can find lots of examples in Tavern Documentation, but most of them you cannot just copy-paste and run to see the result (some examples require running\u00a0 server\u00a0 using Flask). Therefore I created a set of my own examples using free public APIs to help me go through Tavern documentation and learn how to use it:<\/p>\n
\n
- http:\/\/api.zippopotam.us\/<\/a><\/li>\n
- https:\/\/jsonplaceholder.typicode.com<\/a><\/li>\n
- https:\/\/gorest.co.in\/<\/a><\/li>\n
- http:\/\/www.recipepuppy.com<\/a><\/li>\n
- http:\/\/www.dropboxapi.com<\/a><\/li>\n<\/ul>\n
Some examples of Tavern tests:<\/p>\n
\n
- Sending request and checking response status code, json response, headers<\/li>\n
- Using external function to validate response<\/li>\n
- Using built-in Tavern schema validators<\/li>\n
- Test parametrization<\/li>\n
- Multi stage tests<\/li>\n
- Using external configuration files<\/li>\n
- Uploading file<\/li>\n
- Creating and reading resources using APIs<\/li>\n<\/ul>\n
Tavern Docs and useful links<\/h1>\n
Feel free to read Tavern Documentation<\/a>. It is well written and has plenty of examples.<\/p>\n
There are not many articles and tutorials on how to use Tavern. Here are a few links that I found:<\/p>\n
\n
- https:\/\/www.ontestautomation.com\/writing-api-tests-in-python-with-tavern\/<\/a><\/li>\n
- https:\/\/medium.com\/@ali.muhammadimran\/rest-api-test-automation-using-python-with-tavern-ci-part-1-707026eae702<\/a><\/li>\n
- https:\/\/apagiaro.it\/tavern-test-api\/<\/a><\/li>\n<\/ul>\n
Getting Started<\/h1>\n
If you clone this repo and use PyCharm:<\/strong><\/p>\n
\n
- clone repo<\/li>\n
- set up virtual environment<\/li>\n
- install dependancies (pip install -r requirements.txt)<\/li>\n
- install colorlog\u00a0<\/li>\n
- in PyCharm set pytest as default test runner (preferences-tools-python integrated tools-testing-pytest-apply)<\/li>\n
- make sure your yaml test is called test_x.tavern.yaml, where x should be a description of the contained tests<\/li>\n
- edit conftest.py and replace my API keys with yours:<\/li>\n<\/ul>\n
I used dotenv to inject my API keys in tests, so you will need to disable this section in conftest.py:<\/p>\n
# conftest.py\n# =========== disable this section and obtain your own API keys to run tests on your machine ================\n# =========== see comments in test_basics.tavern.yaml, test_http.tavern.yaml ================================\ntry:\n load_dotenv()\n API_KEY_DROPBOX = os.getenv('API_KEY_DROPBOX')\n API_KEY_GOREST = os.getenv('API_KEY_GOREST')\nexcept Exception as e:\n logging.info(f'disable try-except section at the top of conftest.py and obtain your own API keys to run tests '\n f'on your machine: {e}')\n\n# =====================================================================================================<\/code><\/pre>\nThen replace variables\u00a0 with your API_KEYs, example:<\/p>\n
\nstages:\n - name: Authenticate and add new random user\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\n method: POST\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY, example:\n # Authorization: "Bearer 234dflkjdf967lkjdsf"\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account<\/code><\/pre>\n<\/p>\n
If you start your own project and use PyCharm:<\/strong><\/p>\n
\n
- create new project<\/li>\n
- set up virtual environment<\/li>\n
- install tavern<\/li>\n
- install colorlog<\/li>\n
- in PyCharm set pytest as default test runner (preferences-tools-python integrated tools-testing-pytest-apply)<\/li>\n
- make sure your yaml tests are names use the following pattern test_x.tavern.yaml, where x should be a description of the contained tests<\/li>\n
- feel free to use my contest.py and pytest.ini to make test output friendlier.<\/li>\n<\/ul>\n
Project structure example<\/h1>\n
Below is the structure of my project folder<\/p>\n
.\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 __pycache__\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 conftest.cpython-38-pytest-5.4.1.pyc\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 conftest.cpython-38-pytest-5.4.2.pyc\n\u251c\u2500\u2500 accounts.yaml\n\u251c\u2500\u2500 conftest.py\n\u251c\u2500\u2500 logging.yaml\n\u251c\u2500\u2500 pytest.ini\n\u251c\u2500\u2500 readme.md\n\u251c\u2500\u2500 requirements.txt\n\u251c\u2500\u2500 tavern-demo.gif\n\u251c\u2500\u2500 test_data\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 test_pdf.pdf\n\u251c\u2500\u2500 tests\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __pycache__\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 api_urls.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 common.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 includes.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 includesA.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 includesB.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 test_basics.tavern.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 test_http.tavern.yaml\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 utils.py\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 yaml_basics.yaml\n\u251c\u2500\u2500 venv\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 bin\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 include\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 lib\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 pyvenv.cfg\n\u2514\u2500\u2500 zip_code.yaml\n<\/code><\/pre>\nSome common mistakes to avoid<\/h1>\n
Of course you can read the docs, but I decided to share some of my mistakes. Chances are you have the same problem which can be fixed quite quickly if you know where to look at.<\/p>\n
Adding folder to PYTHONPATH<\/h1>\n
To make sure that Tavern can find external functions<\/strong> you need to make sure that it is in the Python path. I had some issues with adding my test dir to PYTHONPATH. Seems like in different shells this\u00a0 command may vary. This is what works \/ does not work for me (I use zsh). For example, if utils.py<\/strong> is in the \u2018tests\u2019 folder:<\/p>\n
Not worked:<\/strong><\/p>\n
PYTHONPATH=$PYTHONPATH:\/tests pytest tests\/test_basics.tavern.yaml -k ex04\n ...\n E tavern.util.exceptions.InvalidExtFunctionError: Error importing module utils\n<\/code><\/pre>\nPYTHONPATH=$PYTHONPATH:tests pytest tests\/test_basics.tavern.yaml -k ex04\n ...\nzsh: bad substitution<\/code><\/pre>\n<\/p>\n
Worked<\/strong>:<\/p>\n
PYTHONPATH=$PYTHONPATH:.\/tests pytest tests\/test_basics.tavern.yaml -q -k ex04<\/code><\/pre>\n<\/p>\n
You can modify ~\/.bash_profile to add absolute path to your PYTHONPATH so you do not need to include PYTHONPATH in command each time (note, this might affect other projects, so just comment it out when you do not need it) . For Example:<\/p>\n
export PYTHONPATH="$PYTHONPATH:\/Users\/maksim\/repos\/tau-tools-demo\/py-tavern-api\/tests"\n# save and exit\n# then run in shell or in PyCharm terminal:\nsource ~\/.bashprofile<\/code><\/pre>\nPrinting entire response using logging<\/h1>\n
Add this hook to your contest.py file to be able to see response even if it returned not in json format. Very often it helps with debugging:<\/p>\n
#conftest.py\n\ndef pytest_tavern_beta_after_every_response(expected, response):\n try:\n logging.info(f"================= RESPONSE ================== "\n f"\\n\\nstatus code [{response.status_code}]\\n{dumps(response.json(), indent=4)}\\n\\n")\n\n except ValueError as e:\n logging.info(f"================= RESPONSE ================== "\n f"\\n\\nstatus code [{response.status_code}]\\n{response.text,}\\n\\n")\n return<\/code><\/pre>\nUse –log-cli-level in command line to enable different logging levels. Example<\/strong><\/p>\n
pytest --log-cli-level=ERROR snippets\/test_basics.tavern.yaml<\/code><\/pre>\nCan also use pytest.ini to set logging level:<\/strong><\/p>\n
log_cli = 1\nlog_level = INFO\nlog_cli_level = INFO<\/code><\/pre>\nExample of pytest.ini<\/p>\n
Here is what I have in my pytest.ini file<\/p>\n
[pytest]\ntavern-global-cfg=\n snippets\/common_snippets.yaml\n tests\/common.yaml\n tests\/secrets.yaml\n snippets\/api_urls.yaml\ntavern-strict=json:off\ntavern-beta-new-traceback = True\n\nfilterwarnings =\n ignore::UserWarning\n ignore::ImportWarning\n ignore::ResourceWarning\n\ntestpaths = \u200btests\u200b, snippets\naddopts =\n --doctest-modules\n -r xs\n -p no:warnings\n -vv\n --tb=short\n\nlog_cli = 1\nlog_level = INFO\nlog_cli_level = INFO\nlog_cli_format = %(asctime)s %(levelname)s %(message)s\nlog_cli_date_format = %H:%M:%S\n\n<\/code><\/pre>\nTest Examples<\/h1>\n
Simple request and validate status code:<\/strong><\/p>\n
---\n\ntest_name: Sending request and checking response status code ex01\n\nstages:\n - name: Check that HTTP status code equals 200\n request:\n url: http:\/\/api.zippopotam.us\/us\/90210\n method: GET\n response:\n status_code: 200\n<\/code><\/pre>\nRequest variables<\/strong><\/p>\n
---\ntest_name: Using request variables ex02\nstages:\n - name: Create a resource, verify response json using request variables\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\n method: POST\n json:\n title: foo\n body: bar\n userId: 1\n headers:\n content-type: application\/json; charset=UTF-8\n\n response:\n status_code:\n - 201\n# - 503\n json:\n title: "{tavern.request_vars.json.title}"\n body: "{tavern.request_vars.json.body}"\n userId: !int "{tavern.request_vars.json.userId}"\n id: 101<\/code><\/pre>\n<\/p>\n
Environment variables<\/strong>. Before running the test update ~\/.bash_profile:<\/p>\n
---\n# export TITLE="foo"\n# export PYTHONPATH="$PYTHONPATH:\/Users\/maksim\/repos\/tau-tools-demo\/py-tavern-api\/tests"\n# source ~\/.bash_profile\n\n\ntest_name: Using environment variables ex03\n\nstages:\n - name: Create a resource, use environment variables to validate response\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\n method: POST\n json:\n title: foo\n body: bar\n userId: 1\n headers:\n content-type: application\/json; charset=UTF-8\n\n response:\n status_code: 201\n json:\n title: "{tavern.env_vars.TITLE}"<\/code><\/pre>\n<\/p>\n
Checking the response using external functions<\/strong>. Note: you can only use an external function to create the whole body or response – #if you just want one value, you should use a pytest fixture (an example is in the documentation).<\/p>\n
Before running the test update~\/.bash_profile. Example:<\/p>\n
\n# export PYTHONPATH="Users\/maksim\/repos\/tau-tools-demo\/py-tavern-api\/tests"\n# to avoid affecting other projects after you finished work in Tavern project comment out\/delete the above line and run:\n# unset PYTHONPATH ; source ~\/.bash_profile\n\n#\n\ntest_name: Using external function to validate response ex04\nstages:\n - name: Make sure we have the right ID\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\/1\n method: GET\n\n response:\n status_code: 200\n verify_response_with:\n function: utils:get_id<\/code><\/pre>\nHere is get_id function:<\/p>\n
# conftest.py\ndef get_id(response):\n # Make sure that id=1 in the response\n\n assert response.json().get("id") == 1\n assert response.json().get("userId") == 1<\/code><\/pre>\nUsing external function with extra arguments to validate response:<\/p>\n
---\n\ntest_name: Using external function with extra arguments to validate response ex04a\nstages:\n - name: Make sure we have the right ID\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\/1\n method: GET\n\n response:\n status_code: 200\n verify_response_with:\n function: utils:demo_extra_kwargs\n extra_kwargs:\n arg1: "hello"\n arg2: "world"\n<\/code><\/pre>\nHere is demo_extra_kwargs function:<\/p>\n
def demo_extra_kwargs(response, arg1, arg2):\n # Make sure that arg1 received\n\n logging.info(f'\\nArg1: {arg1}')\n logging.info(f'\\nArg2: {arg2}')<\/code><\/pre>\n<\/p>\n
Using built-in validators<\/strong>:<\/p>\n
---\n\ntest_name: Using built-in validators ex05\nstages:\n - name: Make sure the response matches the given schema\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\/1\n method: GET\n\n response:\n status_code: 200\n verify_response_with:\n function: tavern.testutils.helpers:validate_pykwalify\n extra_kwargs:\n schema:\n type: map\n mapping:\n id:\n type: int\n required: True\n title:\n type: any\n required: True\n body:\n type: any\n required: True\n userId:\n type: any\n required: True\n\n# Expected\n#{\n# id: 1,\n# title: '[...]',\n# body: '[...]',\n# userId: 1\n#}<\/code><\/pre>\n<\/p>\n
Using built-in validator<\/strong>. The dict can have keys which are not present in the schema, and these can map to anything. Usage: allowempty: True
\nSee documentation here https:\/\/pykwalify.readthedocs.io\/en\/unstable\/validation-rules.html#mapping<\/p>\n---\n\n\ntest_name: Using built-in validators and allowempty ex06\nstages:\n - name: Make sure the response matches the given schema\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\/1\n method: GET\n\n response:\n status_code: 200\n verify_response_with:\n function: tavern.testutils.helpers:validate_pykwalify\n extra_kwargs:\n schema:\n type: map\n allowempty: True\n mapping:\n id:\n type: int\n required: True\n title:\n type: any\n required: True<\/code><\/pre>\n<\/p>\n
Simple request and validate headers:<\/strong><\/p>\n
---\n\ntest_name: Get location for US zip code 90210 and validate response content type is equal to \u2018application\/json\u2019 ex07\n\nstrict:\n - headers:off\n - json:off\n\nstages:\n - name: Check that HTTP status code equals 200 and other fields\n request:\n url: http:\/\/api.zippopotam.us\/us\/90210\n method: GET\n\n response:\n headers:\n content-type: application\/json\n<\/code><\/pre>\n<\/p>\n
Simple request and validate json content<\/strong>:<\/p>\n
---\n\n# \ntest_name: Get location for US zip code 90210 and check response body content ex08\n\nstages:\n - name: Check that place name equals Beverly Hills\n request:\n url: http:\/\/api.zippopotam.us\/us\/90210\n method: GET\n\n response:\n json:\n places:\n - place name: Beverly Hills<\/code><\/pre>\n<\/p>\n
How to use parametrization<\/strong>:<\/p>\n
\ntest_name: Using parametrization in test ex09\nmarks:\n - parametrize:\n key:\n - country_code\n - zip_code\n - place_name\n vals:\n - [us, 12345, Schenectady]\n - [ca, B2A, North Sydney South Central]\n - [nl, 3825, Vathorst]\n\nstages:\n - name: Verify place name in response body\n request:\n url: http:\/\/api.zippopotam.us\/{country_code}\/{zip_code}\n method: GET\n response:\n json:\n places:\n - place name: "{place_name}"<\/code><\/pre>\n<\/p>\n
Using external functions<\/strong>:<\/p>\n
---\n\n\ntest_name: Injecting external data into a request using external functions for other things ex10\nstages:\n - name: Injecting external data into a request\n\n request:\n url: http:\/\/www.recipepuppy.com\/api\/\n method: GET\n json:\n $ext:\n function: utils:generate_req1\n\n response:\n status_code: 200\n json:\n title: Recipe Puppy\n version: 0.1\n results:\n - title: "Ginger Champagne"\n ingredients: "champagne, ginger, ice, vodka"<\/code><\/pre>\n<\/p>\n
Here is external function\u00a0 generate_req1:<\/p>\n
# tests\/utils.py\n\nfrom box import Box\n\ndef generate_req1():\n\n req = {\n "i": "avocado",\n "q": "kale",\n "p": 1,\n }\n\n return Box(req)<\/code><\/pre>\n<\/p>\n
Saving data from response<\/strong> using external functions. In this case, both `{test_title}` and `{test_ingredients}` are available for use in later requests:<\/p>\n
---\n\ntest_name: Saving data from response using external functions ex11\nstages:\n - name: Validate status code 200\n\n request:\n url: http:\/\/www.recipepuppy.com\/api\/\n method: GET\n json:\n i: avocado\n q: kale\n p: 1\n\n response:\n json:\n title: "Recipe Puppy"\n save:\n $ext:\n function: utils:save_data\n json:\n test_ingredients: results[0].ingredients\n\n - name: Validate saved data\n\n request:\n url: http:\/\/www.recipepuppy.com\/api\/\n method: GET\n json:\n i: avocado\n q: kale\n p: 1\n\n response:\n status_code: 200\n json:\n results:\n - title: "{test_title}"\n ingredients: "{test_ingredients}"\n\n<\/code><\/pre>\nHere is save_data function:<\/p>\n
# tests\/utils.py\nfrom box import Box\ndef save_data(response):\n return Box({"test_title": response.json()["results"][0]["title"]})<\/code><\/pre>\n<\/p>\n
Reusing requests and YAML fragments:<\/p>\n
---\n\n\ntest_name: Reusing requests and YAML fragments part1 ex12\nstages:\n - name: &name_block Send request\n request: &request_block\n url: http:\/\/www.recipepuppy.com\/api\/?i=avocado&q=kale&p=1\n method: GET\n<\/code><\/pre>\n---\n\ntest_name: Reusing requests and YAML fragments part2 ex13\nstages:\n - name: Reusing req block\n request:\n *request_block\n response:\n status_code: 200\n json:\n title: Recipe Puppy\n version: 0.1\n results:\n - title: "A Ok Salad Recipe"\n ingredients: "cayenne, lemon, avocado, kale, sea salt, tomato"<\/code><\/pre>\n<\/p>\n
Including external configuration files<\/strong>, using common.yaml, \u00a0includes.yaml should be in the same folder as the tests<\/p>\n
---\n\n\ntest_name: Including external files ex15\nincludes:\n - !include includes.yaml\n\nstages:\n - name: Check that HTTP status code equals 200\n request:\n url: "{protocol1}:\/\/{host_gorest}{res_users}"\n method: GET\n response:\n status_code: 200\n json:\n result:\n name: Unauthorized\n code: 0\n status: 401<\/code><\/pre>\n# tests\/includes.yaml\n---\n\nname: Common test information\ndescription: Some information for tests\n\n# Variables should just be a mapping of key: value pairs\nvariables:\n protocol: https\n host_gorest: gorest.co.in\n res_users: \/public-api\/users<\/code><\/pre>\n# tests\/common.yaml\n---\n\nname: Common test information\ndescription: Some information for tests\n\n# Variables should just be a mapping of key: value pairs\nvariables:\n\n protocol1: https\n host_gorest: gorest.co.in\n res_users: \/public-api\/users\n\n protocol2: http\n host_rp: www.recipepuppy.com\n res_rp: \/api\/\n\n host_zipo: api.zippopotam.us\n api-arg: !raw '{"path": "\/test_pdf.pdf", "mode": "add","autorename": true, "mute": false, "strict_conflict": false}'\n # this is path in your Dropbox folder. In this case file will be uploaded to the root folder\n\n\nstages:\n - id: add_rand_user\n name: Authenticate and add new random user\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\n method: POST\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n json:\n $ext:\n function: utils:generate_req_rand\n\n response:\n status_code:\n - 200\n - 302 # the requested resource has been temporarily moved to a different URI\n json:\n _meta:\n message: "A resource was successfully created in response to a POST request. The Location header contains the URL pointing to the newly created resource."\n result:\n id: !anystr\n save:\n json:\n user_id: result.id\n\n - id: update_user_rand\n name: Update user\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id}\n method: PUT\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n json:\n $ext:\n function: utils:generate_req_rand\n\n response:\n status_code:\n - 200\n - 302 # the requested resource has been temporarily moved to a different URI\n json:\n _meta:\n message: "OK. Everything worked as expected."\n result:\n id: !anystr\n save:\n json:\n user_id_upd: result.id\n\n - id: delete_user\n name: Delete user\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id}\n method: DELETE\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n\n response:\n status_code: 200\n\n json:\n _meta:\n code: 204\n message: "The request was handled successfully and the response contains no body content."\n\n<\/code><\/pre>\nAlso pytest.ini can be used to include external files:<\/p>\n
# [pytest]\n# tavern-global-cfg=tests\/common.yaml\n# tavern-global-cfg=tests\/includesA.yaml\n# tavern-global-cfg=tests\/includesB.yaml\n<\/code><\/pre>\nIncluding global configuration files:<\/p>\n
---\n\ntest_name: Including global configuration files part1 ex16\n\nincludes:\n - !include includesA.yaml\n\nstages:\n - name: Send request\n request:\n url: "{protocol2}:\/\/{host_rp}{res_rp}{query1}"\n method: GET\n response:\n status_code: 200\n json:\n results:\n - title: A Ok Salad Recipe\n\n---\ntest_name: Including global configuration files part2 ex17\n\nincludes:\n - !include includesB.yaml\n\nstages:\n - name: Send request\n request:\n url: "{protocol2}:\/\/{host_rp}{res_rp}{query2}"\n method: GET\n response:\n status_code: 200\n json:\n results:\n - title: Chocolate-chocolate Chip Banana Muffins Recipe\n - title: Chocolate Banana Chocolate Chip Bundt Cake\n - title: Banana Fritters in Chocolate Batter And Chocolate Sauce<\/code><\/pre>\n<\/p>\n
Authentication example<\/strong>. Using saved variable. Using external function to generate request you can only use an external function to create the whole body or response – if you just want one value, you should use a pytest fixture (an example is in the documentation).<\/p>\n
\u00a0Note<\/strong> that there is also no way to use a fixture to generate a block of json – either use $ext to generate the whole
\nrequest, or a fixture to generate one value. Anything in between is currently not implemented (see issue#191 in github).<\/p>\n---\n\ntest_name: Authenticate and add new random user ex19\n\nstages:\n - name: Authenticate and add new random user\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\n method: POST\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n json:\n $ext:\n function: utils:generate_req_rand\n\n\n response:\n status_code:\n - 200\n - 302\n json:\n result:\n id: !anystr\n save:\n json:\n user_id: result.id\n\n - name: Check user's details\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id}\n method: GET\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n\n response:\n status_code: 200\n verify_response_with:\n function: utils:log_response\n json:\n result:\n first_name: Max\n gender: male\n id: "{user_id}"\n<\/code><\/pre>\n<\/p>\n
Sharing stages<\/strong> in configuration files:<\/p>\n
---\n\n\ntest_name: Sharing stages in configuration ex20\n\nstages:\n - type: ref\n id: add_rand_user\n\n - name: Check user's details\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id}\n method: GET\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n\n response:\n status_code: 200\n verify_response_with:\n function: utils:log_response\n json:\n result:\n first_name: Max\n gender: male\n id: "{user_id}"<\/code><\/pre>\n<\/p>\n
Here is stage<\/strong> defined in common.yaml:<\/p>\n
# tests\/common.yaml\n\nstages:\n - id: add_rand_user\n name: Authenticate and add new random user\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\n method: POST\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n json:\n $ext:\n function: utils:generate_req_rand\n\n response:\n status_code:\n - 200\n - 302 # the requested resource has been temporarily moved to a different URI\n json:\n _meta:\n message: "A resource was successfully created in response to a POST request. The Location header contains the URL pointing to the newly created resource."\n result:\n id: !anystr\n save:\n json:\n user_id: result.id\n<\/code><\/pre>\n<\/p>\n
Matching arbitrary return values<\/strong> in a response:;<\/p>\n
---\n\ntest_name: Match arbitrary return values ex21\n\nstages:\n - name: Check value types in user details\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\n method: GET\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n\n response:\n status_code: 200\n json:\n result:\n - first_name: !anystr\n status: active\n id: !anystr<\/code><\/pre>\n<\/p>\n
Matching via a regular expression<\/strong>:<\/p>\n
---\n\ntest_name: Matching via a regular expression ex22\n\nstages:\n - type: ref\n id: add_rand_user\n\n - name: Check value types in user details\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id}\n method: GET\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n\n response:\n status_code: 200\n json:\n result:\n# - first_name: !re_fullmatch "[A-Za-z0-9]"\n id: !re_search "[0-9]"\n first_name: !re_search "[A-Za-z0-9]"\n email: !re_search "[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+[a-zA-Z0-9-.]"\n status: active\n<\/code><\/pre>\n<\/p>\n
Adding a delay between tests<\/strong>:<\/p>\n
---\n\n\ntest_name: Adding a delay between tests ex23\n\nstages:\n - type: ref\n id: add_rand_user\n\n - type: ref\n id: update_user_rand\n\n\n - name: Check user's details\n delay_before: 4\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id_upd}\n method: GET\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n\n response:\n status_code: 200\n json:\n result:\n first_name: Max\n gender: male\n id: "{user_id_upd}"<\/code><\/pre>\n<\/p>\n
add_rand_user and update_user_rand stages are defined in common.yaml:<\/p>\n
#common.yaml\nstages:\n - id: add_rand_user\n name: Authenticate and add new random user\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\n method: POST\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n json:\n $ext:\n function: utils:generate_req_rand\n\n response:\n status_code:\n - 200\n - 302 # the requested resource has been temporarily moved to a different URI\n json:\n _meta:\n message: "A resource was successfully created in response to a POST request. The Location header contains the URL pointing to the newly created resource."\n result:\n id: !anystr\n save:\n json:\n user_id: result.id\n\n - id: update_user_rand\n name: Update user\n\n request:\n url: https:\/\/gorest.co.in\/public-api\/users\/{user_id}\n method: PUT\n headers:\n Content-Type: application\/json\n Authorization: "Bearer {tavern.env_vars.API_KEY_GOREST}"\n # replace above variable with your API_KEY\n # go to https:\/\/gorest.co.in\/user\/login.html to register free account\n json:\n $ext:\n function: utils:generate_req_rand\n\n response:\n status_code:\n - 200\n - 302 # the requested resource has been temporarily moved to a different URI\n json:\n _meta:\n message: "OK. Everything worked as expected."\n result:\n id: !anystr\n save:\n json:\n user_id_upd: result.id<\/code><\/pre>\n<\/p>\n
Retrying tests<\/strong>:<\/p>\n
---\n\ntest_name: Retrying tests ex24\nstages:\n - name: Create a resource\n max_retries: 2 # retry a stage 2 times\n request:\n url: https:\/\/jsonplaceholder.typicode.com\/posts\n method: POST\n json:\n title: foo\n body: bar\n userId: 2\n headers:\n content-type: application\/json; charset=UTF-8\n\n response:\n status_code: 201\n<\/code><\/pre>\n# Marking tests<\/strong>. Make sure pytest.ini does not contain ” addopts = –strict” otherwise add markers names:<\/p>\n
---\n\ntest_name: Marking test ex25\n\nmarks:\n - gorest\n\nstages:\n - type: ref\n id: add_rand_user\n\n - type: ref\n id: delete_user<\/code><\/pre>\nSkipping a test<\/strong>:<\/p>\n
---\n\n\ntest_name: Skipping a test ex26\n\nmarks:\n - skip\n\nstages:\n - name: Check that HTTP status code equals 200 and other fields\n request:\n url: http:\/\/api.zippopotam.us\/us\/90211\n method: GET\n\n response:\n headers:\n content-type: application\/json\n\n---\n\n\ntest_name: Skipping a test using skipif ex27\n\nmarks:\n - skipif: "'api' in '{host_zipo}'"\n\nstages:\n - name: Check that HTTP status code equals 200 and other fields\n request:\n url: "http:\/\/{host_zipo}\/us\/90211"\n method: GET\n\n response:\n headers:\n content-type: application\/json<\/code><\/pre>\n<\/p>\n
Using pytest fixtures:<\/strong><\/p>\n
---\n\ntest_name: Using fixtures ex29\n\nmarks:\n - usefixtures:\n - zipcode # fixture is defined in conftest.py\n\nstages:\n - name: Read zip code from file and use in request\n request:\n url: "http:\/\/{host_zipo}\/us\/{zipcode}"\n method: GET\n\n response:\n headers:\n content-type: application\/json\n status_code: 200<\/code><\/pre>\n<\/p>\n
Fixture is defined in conftest.py:<\/p>\n
#conftest.py\n\nimport logging\nimport os\nimport html\nimport yaml\n\n@pytest.fixture\ndef zipcode():\n current_dir = os.path.dirname(os.path.abspath(__file__))\n with open(os.path.join(current_dir, "zip_code.yaml"), "r") as file:\n zcode = yaml.load(file, Loader=yaml.FullLoader)\n file.close()\n logging.info(f'Code: {zcode["code"]}')\n return zcode["code"]<\/code><\/pre>\n<\/p>\n
Using hooks<\/strong>:<\/p>\n
---\n\ntest_name: Using hook pytest_tavern_beta_after_every_response ex30\n# hook is defined in conftest.py and logs out response\n\nmarks:\n - usefixtures:\n - zipcode # fixture defined in conftest.py\n\nstages:\n - name: Read zip code from file and use in request\n request:\n url: "http:\/\/{host_zipo}\/us\/{zipcode}"\n method: GET\n\n response:\n headers:\n content-type: application\/json<\/code><\/pre>\n<\/p>\n
Here is hook pytest_tavern_beta_after_every_response defined in conftest.py:<\/p>\n
def pytest_tavern_beta_after_every_response(expected, response):\n try:\n logging.info(f"================= RESPONSE ================== "\n f"\\n\\nstatus code [{response.status_code}]\\n{dumps(response.json(), indent=4)}\\n\\n")\n\n except ValueError as e:\n if "!DOCTYPE html" in response.text:\n logging.info(f"================= RESPONSE ================== "\n f"\\n\\nstatus code [{response.status_code}]\\n{html.unescape(response.text)}\\n\\n")\n else:\n logging.info(f"================= RESPONSE ================== "\n f"\\n\\nstatus code [{response.status_code}]\\n{response.text,}\\n\\n")\n return<\/code><\/pre>\n<\/p>\n
Authenticate and get current Dropbox account<\/strong>:<\/p>\n
test_name: Authenticate and get current Dropbox account info ex31\n\nstages:\n - name: Authenticate and check that HTTP status code equals 200\n request:\n url: https:\/\/api.dropboxapi.com\/2\/users\/get_current_account\n method: POST\n headers:\n Authorization: "Bearer {tavern.env_vars.API_KEY_DROPBOX}"\n # replace the above variable with your API_KEY\n # go to https:\/\/www.dropbox.com\/developers\/apps > create app > Dropbox API > Full dropbox > appname > create app\n\n response:\n status_code: 200\n json:\n account_id: !anystr\n name:\n display_name: !anystr\n<\/code><\/pre>\n<\/p>\n
Get the contents of Dropbox root folder:<\/p>\n
---\n# Simple request and validate status code\n\n\ntest_name: Get the contents of Dropbox root folder ex32\n\nstages:\n - name: Authenticate and get the contents of Dropbox root folder\n request:\n url: https:\/\/api.dropboxapi.com\/2\/files\/list_folder\n method: POST\n headers:\n Authorization: "Bearer {tavern.env_vars.API_KEY_DROPBOX}"\n # replace the above variable with your API_KEY\n # go to https:\/\/www.dropbox.com\/developers\/apps > create app > Dropbox API > Full dropbox > appname > create app\n\n Content-Type: application\/json\n json:\n path: ""\n recursive: false\n include_media_info: false\n include_deleted: false\n include_has_explicit_shared_members: false\n include_mounted_folders: true\n include_non_downloadable_files: true\n\n response:\n status_code: 200\n json:\n entries: !anylist<\/code><\/pre>\n<\/p>\n
Upload file using Dropbox API. Uploaded file located in test_data\/test_pdf.pdf:<\/p>\n
---\ntest_name: Upload file to Dropbox folder (file body) ex33\n\nstages:\n - name: Upload file to Dropbox folder\n request:\n url: https:\/\/content.dropboxapi.com\/2\/files\/upload\n method: POST\n file_body: "test_data\/test_pdf.pdf"\n\n headers:\n Authorization: "Bearer {tavern.env_vars.API_KEY_DROPBOX}" # replace the above variable with your API_KEY\n Content-Type: application\/octet-stream\n Dropbox-API-Arg: "{api-arg}"\n\n response:\n status_code: 200\n<\/code><\/pre>\n<\/p>\n
#tests\/common.yaml\n\napi-arg: !raw '{"path": "\/test_pdf.pdf", "mode": "add","autorename": true, "mute": false, "strict_conflict": false}'\n # this is path in your Dropbox folder. In this case file will be uploaded to the root folder\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"Tavern API Testing Examples “Tavern is a pytest plugin, command-line tool and Python library for automated testing of APIs, with a simple, concise and flexible YAML-based syntax” (https:\/\/taverntesting.github.io\/) I created GitHub repo containing 30+ simple Tavern test examples and decided\u00a0 to share it on my website.\u00a0 I think it can helpful for someone like me who has just started to learn Tavern\u00a0 or looking for a\u00a0 tool to automate API<\/p>\n