Skip to main content

Pytest plugin, meant to facilitate unit tests writing for tools consumming Web APIs.

Project description

1. TL;DR example

STEP 1

Write this code:

File tests/some_module.py

@pytest.mark.record_http
@pytest.mark.record_time
@pytest.mark.record_verify_screen
def test_some_test(record):
    some_python_object = ...

    record.add_verify(object=some_python_object)

STEP 2

Run:

pytest tests/some_module.py --record

It will:

Save all the HTTP requests

Save the execution datetime

Save the screen output

Save the data you provide to recorder object

STEP 3

Run:

pytest tests/some_module.py

It will:

Reuse the stored HTTP requests

Reuse the same datetime to execute the test

Compare the current screen output to the previous one and raise and exception if different

Compare the current recorder object data to the previous one and raise and exception if different

2. Detailed example

CODE

@pytest.mark.record_http
@pytest.mark.record_time(date=datetime(2023, 3, 1, 12, 0, 0), tic=False)
@pytest.mark.record_verify_screen(hash=True)
def test_some_test(record):
    ...
    record.hash_only = True
    record.add_verify(object=df)
    record.add_verify(object=[df])

    recorder.add_verify(
        object=df,
    )

USAGE

pytest [FILE] [--record[=none,all,http,object,screen,time]] [--record-no-overwrite] [--record-no-hash]

FILES

For a given test_function from test_module, we will have the following files:

/tests/test_module.py:test_function

/tests/record/http/test_module/test_function.yaml

/tests/record/object/test_module/test_function.json

/tests/record/object_hash/test_module/test_function.txt/json?

/tests/record/screen/test_module/test_function.txt/json?

/tests/record/screen_hash/test_module/test_function.txt/json?

/tests/record/time/test_module/test_function.txt/json?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_recorder-0.2.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

pytest_recorder-0.2.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file pytest_recorder-0.2.0.tar.gz.

File metadata

  • Download URL: pytest_recorder-0.2.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.9.16 Linux/5.19.0-35-generic

File hashes

Hashes for pytest_recorder-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cf88ba763b185bf55541be03ba344ca2533366ed36332c1b398e1694d8cc238b
MD5 13f9b2e03d0d126e81a07b2b51646ff0
BLAKE2b-256 3c62fc9f97fa064120f4eefc2a026a8f0156542563fe6d7556a5618041c1525e

See more details on using hashes here.

File details

Details for the file pytest_recorder-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pytest_recorder-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.9.16 Linux/5.19.0-35-generic

File hashes

Hashes for pytest_recorder-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d6e104e668c235569932859b11965db9233bf6722d8f91467def41101d2ae38
MD5 8ee7d584bcf2ed6779e6dfded5c6b8b3
BLAKE2b-256 4f7244f90e264c3bc02bb0ab4cd5f2efaa7dc9e4899a20aa5afe6f90a48ae1c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page