Skip to main content

No project description provided

Project description

expecttest

This library implements expect tests (also known as "golden" tests). Expect tests are a method of writing tests where instead of hard-coding the expected output of a test, you instead run the test to get the output, and the test framework automatically populates the expected output. If the output of the test changes, you can rerun the test with EXPECTTEST_ACCEPT=1 environment variable to automatically update the expected output.

Somewhat unusually, this file implements inline expect tests: that is to say, the expected output isn't save to an external file, it is saved directly in the Python file (and we modify your Python the file when updating the expect test.)

The general recipe for how to use this is as follows:

  1. Write your test and use assertExpectedInline() instead of a normal assertEqual. Leave the expected argument blank with an empty string:

    self.assertExpectedInline(some_func(), "")
    
  2. Run your test. It should fail, and you get an error message about accepting the output with EXPECTTEST_ACCEPT=1

  3. Rerun the test with EXPECTTEST_ACCEPT=1. Now the previously blank string literal will now contain the expected value of the test.

    self.assertExpectedInline(some_func(), "my_value")
    

Some tips and tricks:

  • Often, you will want to expect test on a multiline string. This framework understands triple-quoted strings, so you can just write """my_value""" and it will turn into triple-quoted strings.

  • Take some time thinking about how exactly you want to design the output format of the expect test. It is often profitable to design an output representation specifically for expect tests.

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

expecttest-0.1.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

expecttest-0.1.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file expecttest-0.1.0.tar.gz.

File metadata

  • Download URL: expecttest-0.1.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.5 Darwin/20.5.0

File hashes

Hashes for expecttest-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3d4dedd1002e929d4cc072f44a7f6cfc611d6073cebf815e3bdf7fd82f8450ca
MD5 62e9a35e3913a6052f9f8968ea4ed817
BLAKE2b-256 47291f24f708f3d8480d04945cd38c3a986042e1c0a1095dc93281454d223007

See more details on using hashes here.

Provenance

File details

Details for the file expecttest-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: expecttest-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.5 Darwin/20.5.0

File hashes

Hashes for expecttest-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 464d7dd42d83b32cc586b89275a5af742bc300a8394ae9cfb790fa29899f6645
MD5 5dcff9a7b15ff75b097bf8694c2de8e8
BLAKE2b-256 67f0c1f900546fcd78a4cb19b56a58d457950357ae7533530bba9eee197f9926

See more details on using hashes here.

Provenance

Supported by

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