skip to navigation
skip to content

Not Logged In

describe_it 2.2.2

A nose plugin that supports writing describe/it style unit tests with nested contexts

Describe-it is a nose plugin that allows you to write unit tests that are more like executable examples of how a component should work than just being tests.

The other benefit is the ability to describe how a component behaves in certain contexts, where one context may build on a previously defined context by using nesting.

Installing

$ pip install describe-it

Writing

Any module that ends with ‘spec’ is considered to contain specifications/tests for describe_it.

$ vim myfirst_spec.py

…and the content:

from game import Game
from describe_it import describe, it, before_each, Fixture

@describe                                               # This declares a test context.
def a_game():
    f = Fixture()                                       # Fixture is a hack to get around
                                                        # Python's implementation of closures.
                                                        # You can use other methods, such as
                                                        # nonlocal if you like.

    @before_each                                        # Will be called before each 'it'
    def setup():
        f.game = Game()

    @after_each                                         # Will be called after each 'it'
    def teardown():
        perform_post_test_cleanup_if_needed()           # This should rarely be needed!

    @it                                                 # This marks a test method.
    def is_player_ones_turn():
        assert f.game.current_player == 1               # describe_it doesn't come with an
                                                        # assertion lib. Pick any one you like.

    @describe                                           # This is a nested context that
    def in_second_round():                              # augments the context above.

        @before_each                                    # Before each 'it' method, any
        def setup():                                    # before_each in outer contexts will
            f.game.play_round()                         # be called first. Then this method
                                                        # will be called.

        @it
        def is_player_twos_turn():
            assert f.game.current_player == 2

        @xit                                            # You can skip individual test methods
        def skips_tests():                              # by using '@xit' or '@it_skip'
            assert True

        @with_data([1, 2, 3],                           # You can parameterize tests with
                   [3, 4, 7])                           # different combinations of inputs
        def adds_numbers(term_1, term_2, expected):
            assert term_1 + term_2 == expected

 @xdescribe                                             # You can skip whole contexts by
 def this_context_is_marked_as_skipped():               # using '@xdescribe' or '@describe_skip'

    @it
    def this_test_will_be_skipped():
        assert True

Running

$ nosetests --with-describe-it
 
File Type Py Version Uploaded on Size
describe_it-2.2.2.tar.gz (md5) Source 2015-07-18 4KB
  • Downloads (All Versions):
  • 18 downloads in the last day
  • 198 downloads in the last week
  • 1996 downloads in the last month
  • Author: Joakim Karlsson
  • Home Page: https://github.com/joakimkarlsson/describe_it
  • Keywords: unit testing,tdd,bdd,nose
  • License:
    The MIT License (MIT)
    
    Copyright (c) 2014 Joakim Karlsson
    
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
  • Package Index Owner: jhkarlsson
  • DOAP record: describe_it-2.2.2.xml