Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

nodev helpers to write specification tests.

Project Description

nodev.specs helps you write robust tests that describe the abstract behaviour of your code leaving many implementation details out of your tests.

The general idea is best explained with an example, let’s write a specification test for the following function skip_comments that returns the non-comment part of every line in the input file:

def skip_comments(stream):
    return [line.partition('#')[0] for line in stream]

The simplest unit test may look like the following:

def test_skip_comments():
    assert skip_comments(['# comment']) == ['']
    assert skip_comments(['value # comment']) == ['value ']
    assert skip_comments(['value 1', '', 'value 2']) == ['value 1', '', value 2']

Such a unit test is much more tied to current skip_comments implementation than it needs to be and the test will need update every time a tiny feature is added, like turning the function into a generator:

def skip_comments(stream):
    for line in stream:
        yield line.partition('#')[0]

This can be fixed by re-writing the test in more generic way:

def test_skip_comments():
    assert '' in skip_comments(['# comment'])
    assert 'value ' in skip_comments(['value # comment'])
    assert 'value 1' in skip_comments(['value 1', '', 'value 2'])
    assert 'value 2' in skip_comments(['value 1', '', 'value 2'])

Let’s re-write the test making use of the nodev.specs.FlatContainer helper:

def test_skip_comments():
    assert '' in FlatContainer(skip_comments(['# comment']))
    assert 'value ' in FlatContainer(skip_comments(['value # comment']))
    assert 'value 1' in FlatContainer(skip_comments(['value 1', '', 'value 2']))
    assert 'value 2' in FlatContainer(skip_comments(['value 1', '', 'value 2']))

Now you can choose to skip empty lines returning the current line index instead:

def skip_comments(stream):
    for index, line in enumerate(stream):
        value = line.partition('#')[0]
        if value:
            yield index, value

Or return also the comment for every line:

def skip_comments(stream):
    for index, line in enumerate(stream):
        value, sep, comment = line.partition('#')
        if value:
            yield index, value, sep + comment

The nodev test needs no update because it makes almost no assumption on the details of the return value.

Project resources

Support https://stackoverflow.com/search?q=nodev
Development https://github.com/nodev-io/nodev.specs
Discussion To be decided, see issue #15 of the pytest-nodev repository.
Download https://pypi.python.org/pypi/nodev.specs
Code quality
nodev website http://nodev.io

Contributing

Contributions are very welcome. Please see the CONTRIBUTING document for the best way to help. If you encounter any problems, please file an issue along with a detailed description.

Authors:

Sponsors:

License

nodev.specs is free and open source software distributed under the terms of the MIT license.

Release History

Release History

This version
History Node

0.3.1

History Node

0.3.0

History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
nodev.specs-0.3.1-py2.py3-none-any.whl (8.3 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Jul 21, 2016
nodev.specs-0.3.1.tar.gz (6.8 kB) Copy SHA256 Checksum SHA256 Source Jul 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting