Skip to main content

dependent testing framework

Project description

# Deptest

Deptest is a testing framework to handle situation when your need to control
the execution order of the test units. Seriously, deptest does not follow
the rules of unit testing, in other words, using this tool means
you are thinking againest the philosophy of unit testing:
“to isolate each part of the program and show that the individual parts are correct”.

But so what? Programming needs diversity, so does testing methodology.
If the situation really exists, we should do something with it,
that's why deptest is created, it could be considered as a different
approach to organize your tests. Try it if you are stuck with unit testing,
maybe it'll be helpful :)

## Installation

pip install deptest

## Usage

The core part of using deptest is to use `depend_on` decorator on your test functions. `depend_on` describes that a test function should be run if and
only if its dependency function is `OK`. If dependency is `FAILED`, then the
test function will not be executed and the status will be set to `UNMET`.

1. Case 1, simple dependency

```python
from deptest import depend_on

@depend_on('test_b')
def test_a():
print 'a, depend on a'

def test_b():
print 'b'
```

This will ensure `test_a` run after `test_b` even though `test_a` is defined before `test_b`.

2. Case 2, passing return value

```python
from deptest import depend_on

@depend_on('test_b', with_return=True)
def test_a(name):
print 'a, depend on', name

def test_b():
print 'b'
return 'b'
```

With `with_return` argument set to `True`, the return value of `test_b`
will be passed into `test_a`. By default return values of dependencies
won't be passed.

2. Case 3, complicated dependencies

```python
from deptest import depend_on

@depend_on('test_c', with_return=True)
@depend_on('test_b', with_return=True)
def test_a(name1, name2):
print 'a, depend on', name1, name2
return 'a'

@depend_on('test_d')
def test_b():
print 'b'
return 'b'

@depend_on('test_d')
def test_c():
print 'c'
return 'c'

def test_d():
print 'd'
return 'd'
```

The dependent graph of the four functions will be:

```
d
| \
b c
| /
a
```

Thus the execute sequence will be `d, b, c, a` or `d, c, b, a`, the results are fairly the same.

```
$ deptest -s test/simple_test.py
d
→ simple_test.test_d... OK
b
→ simple_test.test_b... OK
c
→ simple_test.test_c... OK
a, depend on b c
→ simple_test.test_a... OK
______________________________________________________________________
Ran 4 tests, OK 4, FAILED 0, UNMET 0
```

You can see some practical examples in [`examples/`](examples) folder,
It's worth mentioning that [`http_api_test.py`](examples/http_api_test.py)
simulates an HTTP API testing case, which is mostly the reason why I develop this tool.

> Note: to run `http_api_test.py`, you need [HTTPretty](https://github.com/gabrielfalcao/HTTPretty) installed.

Deptest provides a cli command also called `deptest`, it supports some common
arguments of `nosetests`, like `-s` and `--nocapture`, see detail usage by `deptest -h`:

```
usage: deptest [-h] [-s] [--nologcapture] [--dry] [--debug] [PATH [PATH ...]]

positional arguments:
PATH files or dirs to scan

optional arguments:
-h, --help show this help message and exit
-s, --nocapture Don't capture stdout (any stdout output will be printed
immediately)
--nologcapture Don't capture logging
--dry Dry run, only show matched files
--debug Set logging level to debug for deptest logger
```

## Screenshots

See it in action, run `deptest examples`:

![Normal Mode](_images/normal.png)

With `--nologcapture` argument:

![With -s Stdout](_images/withstdout.png)

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

deptest-0.1.6.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

deptest-0.1.6-py2-none-any.whl (17.4 kB view details)

Uploaded Python 2

File details

Details for the file deptest-0.1.6.tar.gz.

File metadata

  • Download URL: deptest-0.1.6.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for deptest-0.1.6.tar.gz
Algorithm Hash digest
SHA256 0054364337490091881f6920a1b22e31092f5d0c0bd7fd41c389e9aeca9b21f3
MD5 aba1bd5d3b4e5fbcbef37e1433100f78
BLAKE2b-256 3e16182a405f3a3ae710b3126a43174069cfe08f41da77f764c47114e05b9d2c

See more details on using hashes here.

File details

Details for the file deptest-0.1.6-py2-none-any.whl.

File metadata

File hashes

Hashes for deptest-0.1.6-py2-none-any.whl
Algorithm Hash digest
SHA256 d8134f3b1f12c4a8bc7b2e3f1b72628d9e65c0dc48dccf9dffcd798d2d2874eb
MD5 c192be88ea4a29a19ffcfe2c782640c7
BLAKE2b-256 caddc19f860641feb8e025ff8400336c49926ff8aeae18b180469f74c8daa638

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