bean.test

bean.test is a tiny test framework.

Just enough to pick apart rotten beans.

Overview

With bean.test you get:

• A small, fluent assertion API.
• Test data generation helpers.
• Simple test registration and reporting.
• test discovery

from bean import test

@test.register()
def test_something():
    test.expect(1 + 1).Equal(2)

Note:

To quickly inspect the public API:

python -c "
    import bean.test as bean
    for v in sorted(dir(bean)):
        print(f'- {v}')
"

Installation

Using pip:

pip install --upgrade bean-test

Using curl (direct download):

curl -Ls \
    https://raw.githubusercontent.com/numen-0/bean/main/bean-test/src/bean/test.py

Command Line

bean.test can be used directly as a test runner.

python -m bean.test tests/

By default, files matching *.py are discovered. Use --pattern to change the pattern:

python -m bean.test tests/ --pattern "test_*.py"

Run only specific namespaces:

python -m bean.test tests/ -n unit integration

Note:

For more information, run:

python -m bean.test --help

API

This is a quick reference for the main API.

For full details, see the source code.

Test Registration

Tests can be registered under different namespaces.

@register("math")
def test_addition(): ...

@register("http")
def test_request(): ...

Data Generation

rand provides small helpers for generating and composing random test data.

from bean.test import rand

list(rand.cases(               # generator for tuple[bool, tuple[str, int]]
    rand(bool),                # <- retrieve bool
    rand.choice(*rand.product( # <- chose a tuple[str, int]
        ("a", "b", "c"),
        (1, 2, 3),
    )),
    count=5,
    seed=42,
))

The Lab

Lab is the singleton responsible for running tests and generating reports

Expect Assertions

Fluent assertions for inspecting values.

Note: Every method returns self, so multiple assertions can be chained

Example

from bean import test

@test.register()
def test_addition():
    test.expect(1 + 1).Equal(2)

@test.register()
def test_string():
    test.expect("hello world") \
        .IsString() \
        .NotEmpty() \
        .StartsWith("hello") \
        .EndsWith("world")

@test.register()
def test_collections():
    test.expect([1, 2, 3]).SequenceEqual([1, 2, 3])
    test.expect([3, 1, 2]).SetEqual([1, 2, 3])
    test.expect([1, 2]).Subset([1, 2, 3])

@test.register()
def test_exception():
    with test.expect.Raises(ValueError):
        int("bean")

test.Lab.print()

License

All the repo falls under the MIT License.