Skip to main content

A rspec format reporter for pytest

Project description

A pspec format reporter for pytest

https://i.imgur.com/cCMJXHe.png

Install

pip install pytest_aspec

Usage

Add the parameter –pspec when running pytest. Ex:

pytest --pspec your-tests/

Tip: If you don’t want to type --pspec every time you run pytest, add it to addopts in your ini file. Ex:

# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
addopts = --pspec

Demo Code

Add the doc strings Ex:

import unittest

class TestWayTwo(unittest.TestCase):
    "Pspec Python TDD"

    def test_should_add(self):
        "it adds two integers and returns integer"
        self.assertEqual(2+2, 4)

    def test_should_find_difference_between_integers(self):
        self.assertEqual(4-2, 2)

running pytest --pspec outputs

demo
 🌸 it adds two integers and returns integer
 🌸 should find difference between integers

Configuration file options

pspec_passed

Specifies pspec passed character. Ex:

# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
pspec_passed=\N{heavy check mark}\N{vs16}
$ pytest test_demo.py
============================= test session starts ==============================
platform darwin -- Python 3.5.0, pytest-3.0.7, py-1.4.33, pluggy-0.4.0
rootdir: /private/tmp/demo, inifile: pytest.ini
plugins: pspec-dev
collected 2 items

test_demo.py
Pytest pspec
 ✔️ prints a BDD style output to your tests
 ✔️ lets you focus on the behavior

pspec_failed

Specifies pspec failed character. Ex:

# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
pspec_failed=\N{skull and crossbones}\N{vs16}
$ pytest test_demo.py
============================= test session starts ==============================
platform darwin -- Python 3.5.0, pytest-3.0.7, py-1.4.33, pluggy-0.4.0
rootdir: /private/tmp/demo, inifile: pytest.ini
plugins: pspec-dev
collected 2 items

test_demo.py
Pytest pspec
 🌸️ this failed??!!

pspec_skipped

Specifies pspec skipped character. Ex:

# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
pspec_skipped=\N{snowman without snow}\N{vs16}
$ pytest test_demo.py
============================= test session starts ==============================
platform darwin -- Python 3.5.0, pytest-3.0.7, py-1.4.33, pluggy-0.4.0
rootdir: /private/tmp/demo, inifile: pytest.ini
plugins: pspec-dev
collected 2 items

test_demo.py
Pytest pspec
 ☃️️ skipping this test for now

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_aspec-1.3.tar.gz (4.8 kB view details)

Uploaded Source

File details

Details for the file pytest_aspec-1.3.tar.gz.

File metadata

  • Download URL: pytest_aspec-1.3.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for pytest_aspec-1.3.tar.gz
Algorithm Hash digest
SHA256 50fd461551f2a35448e49af6fdfeb2e7b1eb45d361bc0250fed2cfd20ccedd9b
MD5 86ce5ed150d56e7c6546f74f1a8ac7b4
BLAKE2b-256 4b48ff6a4156bd8c33c3f2fe6545c3efd4c3e9758555f5b3614aa344512ee84a

See more details on using hashes here.

Supported by

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