Skip to main content

PHPUnit-like @dataprovider decorator for unittest

Project description

Package for this snippet: http://melp.nl/2011/02/phpunit-style-dataprovider-in-python-unit-test/

Install:

pip install unittest-data-provider

Import:

import unittest
from unittest_data_provider import data_provider

You can then use data_provider without having to stick this snippet somewhere …

Thanks drm !

Original blog post by drm pasted here in case the original link goes down

PHPUnit has a handy feature with which you can provide testdata to your tests. This is called a data provider, and is implemented by annotating a test with @dataProvider methodName. Python’s unittest module doesn’t seem to have such a feature.

PHPUnit’s version

The data provider returns a two-dimensional array of test arguments. For example:

class CssParserTest extends PHPUnit_Framework_TestCase {
    function setUp() {
        $this->parser = new CssParser();
    }

    /**
    * @dataProvider cssColors
    */
    function testParseColor($color, $notation) {
        $this->assertEquals($color, $this->parser->parseColor($notation));
    }


    function cssColors() {
        return array(
            array(array(0, 0, 0), '#000'),
            array(array(0, 0, 0), '#000000'),
            array(array(0, 0, 0), 'rgb(0, 0, 0)')
            array(array(0, 0, 0), 'black')
        );
    }
}

Running this test would call the testParseColor() test 4 times, with each of the arrays returned by cssColors() as the arguments.

Python: providing test data using a decorator

While writing tests for some Python code, I discovered that Python’s unittest doesn’t seem to have such a feature. So I implemented my own, using a decorator:

def data_provider(fn_data_provider):
    """Data provider decorator, allows another callable to provide the data for the test"""
    def test_decorator(fn):
        def repl(self, *args):
            for i in fn_data_provider():
                try:
                    fn(self, *i)
                except AssertionError:
                    print "Assertion error caught with data set ", i
                    raise
        return repl
    return test_decorator

Example usage:

class CssParserTest:
    def setUp(self):
        self.parser = CssColor()

    colors = lambda: (
        ( (0, 0, 0), '#000' ),
        ( (0, 0, 0), '#000000' ),
        ( (0, 0, 0), 'rgb(0, 0, 0)' ),
        ( (0, 0, 0), 'black' )
    )

    @data_provider(colors):
    def test_parse_color(self, color, notation):
        self.assertEquals(color, self.parser.parse_color(notation))

Suggestions of alternatives are greatly appreciated, by the way.

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

unittest-data-provider-1.0.1.tar.gz (2.9 kB view details)

Uploaded Source

File details

Details for the file unittest-data-provider-1.0.1.tar.gz.

File metadata

File hashes

Hashes for unittest-data-provider-1.0.1.tar.gz
Algorithm Hash digest
SHA256 86bc7fb6608c2570aeedadea346fe3034afc940807dd7519e95e5dbc899ac2be
MD5 922f0b805f2100fbedfe9cbece1226d8
BLAKE2b-256 c08eb95d91f4bcd2b5f02878d284b74cabbc553f30b131571ba699a4f1a2f99d

See more details on using hashes here.

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