Writing unit tests for pluginsΒΆ

Here’s a brief guide to writing unit tests for plugins. However, it isn’t really ideal. It also hasn’t been well tested... yes, there’s some irony there :)

Some notes: we’re using py.test and WebTest for unit testing stuff. Keep that in mind.

My suggestion is to mime the behavior of mediagoblin/tests/ and put that in your own plugin, like myplugin/tests/. Copy over conftest.py and pytest.ini to your tests directory, but possibly change the test_app fixture to match your own tests’ config needs. For example:

import pkg_resources
# [...]

@pytest.fixture()
def test_app(request):
    return get_app(
        request,
        mgoblin_config=pkg_resources.resource_filename(
            'myplugin.tests', 'myplugin_mediagoblin.ini'))

In any test module in your tests directory you can then do:

def test_somethingorother(test_app):
    # real code goes here
    pass

And you’ll get a MediaGoblin application wrapped in WebTest passed in to your environment.

If your plugin needs to define multiple configuration setups, you can actually set up multiple fixtures very easily for this. You can just set up multiple fixtures with different names that point to different configs and pass them in as that named argument.

To run the tests, from MediaGoblin’s directory (make sure that your plugin has been added to your MediaGoblin checkout’s virtualenv!) do:

./runtests.sh /path/to/myplugin/tests/

replacing /path/to/myplugin/ with the actual path to your plugin.

NOTE: again, the above is untested, but it should probably work. If you run into trouble, contact us, preferably on IRC!