[Python-modules-commits] [exam] 01/03: import exam_0.10.5.orig.tar.gz
Scott Kitterman
kitterman at moszumanska.debian.org
Sat Jul 8 03:33:25 UTC 2017
This is an automated email from the git hooks/post-receive script.
kitterman pushed a commit to branch debian/master
in repository exam.
commit 7572aaa168bfe1c7395e6f163b89b39daa18a590
Author: Scott Kitterman <scott at kitterman.com>
Date: Fri Jul 7 23:17:16 2017 -0400
import exam_0.10.5.orig.tar.gz
---
.gitignore | 6 +
.travis.yml | 11 ++
Gemfile | 8 +
Gemfile.lock | 21 +++
Guardfile | 5 +
LICENSE | 7 +
MANIFEST.in | 1 +
Makefile | 15 ++
README.rst | 464 +++++++++++++++++++++++++++++++++++++++++++++++
exam.sublime-project | 25 +++
exam/__init__.py | 5 +
exam/asserts.py | 66 +++++++
exam/cases.py | 59 ++++++
exam/decorators.py | 111 ++++++++++++
exam/fixtures.py | 15 ++
exam/helpers.py | 162 +++++++++++++++++
exam/mock.py | 26 +++
exam/objects.py | 7 +
setup.py | 51 ++++++
tests/__init__.py | 7 +
tests/dummy.py | 21 +++
tests/test_asserts.py | 63 +++++++
tests/test_cases.py | 279 ++++++++++++++++++++++++++++
tests/test_decorators.py | 82 +++++++++
tests/test_exam.py | 22 +++
tests/test_helpers.py | 120 ++++++++++++
tests/test_mock.py | 69 +++++++
tests/test_objects.py | 23 +++
28 files changed, 1751 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4f9c9f9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
+*.pyc
+.DS_Store
+*.egg
+*.egg-info
+dist/
+*.sublime-workspace
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..ffe4e3f
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,11 @@
+language: python
+
+python:
+ - "2.6"
+ - "2.7"
+ - "3.2"
+ - "3.3"
+ - "pypy"
+
+install: python setup.py develop
+script: make test
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..b73e128
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,8 @@
+source :rubygems
+
+group :development do
+ gem 'guard', '1.4.0'
+ gem 'rb-readline'
+ gem 'rb-fsevent', :require => false
+ gem 'guard-shell'
+end
diff --git a/Gemfile.lock b/Gemfile.lock
new file mode 100644
index 0000000..5950c58
--- /dev/null
+++ b/Gemfile.lock
@@ -0,0 +1,21 @@
+GEM
+ remote: http://rubygems.org/
+ specs:
+ guard (1.4.0)
+ listen (>= 0.4.2)
+ thor (>= 0.14.6)
+ guard-shell (0.5.1)
+ guard (>= 1.1.0)
+ listen (0.5.3)
+ rb-fsevent (0.9.2)
+ rb-readline (0.4.2)
+ thor (0.16.0)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ guard (= 1.4.0)
+ guard-shell
+ rb-fsevent
+ rb-readline
diff --git a/Guardfile b/Guardfile
new file mode 100644
index 0000000..d352b58
--- /dev/null
+++ b/Guardfile
@@ -0,0 +1,5 @@
+guard :shell do
+ watch(/^(tests|exam)(.*)\.py$/) do |match|
+ puts `python setup.py nosetests`
+ end
+end
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d0c2ab8
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright © 2012 Jeff Pollard
+
+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.
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..aae9579
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1 @@
+recursive-exclude tests *
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..9e57eb0
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,15 @@
+VERSION = $(shell python setup.py --version)
+
+test:
+ python setup.py nosetests
+
+release:
+ git tag $(VERSION)
+ git push origin $(VERSION)
+ git push origin master
+ python setup.py sdist upload
+
+watch:
+ bundle exec guard
+
+.PHONY: test release watch
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ad52951
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,464 @@
+.. image:: https://api.travis-ci.org/Fluxx/exam.png?branch=master
+ :target: http://travis-ci.org/fluxx/exam
+
+####
+Exam
+####
+
+.. image:: https://dl.dropbox.com/u/3663715/exam.jpeg
+
+Exam is a Python toolkit for writing better tests. It aims to remove a lot of the boiler plate testing code one often writes, while still following Python conventions and adhering to the unit testing interface.
+
+Installation
+------------
+
+A simple ``pip install exam`` should do the trick.
+
+Rationale
+--------
+
+Aside from the obvious "does the code work?", writings tests has many additional goals and benefits:
+
+1. If written semantically, reading tests can help demostrate how the code is supposed to work to other developers.
+2. If quick running, tests provide feedback during development that your changes are working or not having an adverse side effects.
+3. If they're easy to write correctly, developers will write more tests and they will be of a higher quality.
+
+Unfortunately, the common pattern for writing Python unit tests tends to not offer any of these advantages. Often times results in ineffecient and unnessarily obtuse testing code. Additionally, common uses of the `mock` library can often result in repetitive boiler-plate code or ineffeciency during test runs.
+
+`exam` aims to improve the state of Python test writing by providing a toolkit of useful functionality to make writing quick, correct and useful tests and as painless as possible.
+
+Usage
+--------
+
+Exam features a collection of useful modules:
+
+``exam.decorators``
+~~~~~~~~~~~~~~~~~~~
+
+Exam has some useful decorators to make your tests easier to write and understand. To utilize the ``@before``, ``@after``, ``@around`` and ``@patcher`` decorators, you must mixin the ``exam.cases.Exam`` class into your test case. It implements the appropriate ``setUp()`` and ``tearDown()`` methods necessary to make the decorators work.
+
+Note that the ``@fixture`` decorator works without needing to be defined inside of an Exam class. Still, it's a best practice to add the ``Exam`` mixin to your test cases.
+
+All of the decorators in ``exam.decorators``, as well as the ``Exam`` test case are available for import from the main ``exam`` package as well. I.e.:
+
+.. code:: python
+
+ from exam import Exam
+ from exam import fixture, before, after, around, patcher
+
+``exam.decorators.fixture``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``@fixture`` decorator turns a method into a property (similar to the ``@property`` decorator, but also memoizes the return value). This lets you reference the property in your tests, i.e. ``self.grounds``, and it will always reference the exact same instance every time.
+
+.. code:: python
+
+ from exam.decorators import fixture
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ @fixture
+ def user(self):
+ return User(name='jeff')
+
+ def test_user_name_is_jeff(self):
+ assert self.user.name == 'jeff'
+
+As you can see, ``self.user`` was used to reference the ``user`` property defined above.
+
+If all your fixture method is doing is contructing a new instance of type or calling a class method, exam provides a shorthand inline ``fixture`` syntax for constructing fixture objects. Simply set a class variable equal to ``fixture(type_or_class_method)`` and exam witll automatically call your type or class method.
+
+.. code:: python
+
+ from exam.decorators import fixture
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ user = fixture(User, name='jeff')
+
+ def test_user_name_is_jeff(self):
+ assert self.user.name == 'jeff'
+
+Any ``*args`` or ``**kwargs`` passed to ``fixture(type_or_class_method)`` will be passed to the ``type_or_class_method`` when called.
+
+
+``exam.decorators.before``
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``@before`` decorator adds the method to the list of methods which are run as part of the class's ``setUp()`` routine.
+
+.. code:: python
+
+ from exam.decorators import before
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ @before
+ def reset_database(self):
+ mydb.reset()
+
+
+``@before`` also hooks works through subclasses - that is to say, if a parent class has a ``@before`` hook in it, and you subclass it and define a 2nd ``@before`` hook in it, both ``@before`` hooks will be called. Exam runs the parent's ``@before`` hook first, then runs the childs'. Also, if your override a `@before` hook in your child class, the overriden method is run when the rest of the child classes `@before` hooks are run.
+
+For example, with hooks defined as such:
+
+.. code:: python
+
+ from exam.decorators import before
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ @before
+ def reset_database(self):
+ print 'parent reset_db'
+
+ @before
+ def parent_hook(self):
+ print 'parent hook'
+
+
+ class RedisTest(MyTest):
+
+ @before
+ def reset_database(self):
+ print 'child reset_db'
+
+ @before
+ def child_hook(self):
+ print 'child hook'
+
+When Exam runs these hooks, the output would be:
+
+.. code:: python
+
+ "prent hook"
+ "child reset_db"
+ "child hook"
+
+As you can see even though the parent class defines a ``reset_database``, because the child class overwrote it, the child's version is run intead, and also at the same time as the rest of the child's ``@before`` hooks.
+
+``@before`` hooks can alse be constructed with other functions in your test case, decorating actual test methods. When this strategy is used, Exam will run the function ``@before`` is constructed with before running that particular test method.
+
+.. code:: python
+
+ from exam.decorators import before, fixture
+ from exam.cases import Exam
+
+ from myapp import User
+
+ class MyTest(Exam, TestCase):
+
+ user = fixture(User)
+
+ @before
+ def create_user(self):
+ self.user.create()
+
+ def confirm_user(self):
+ self.user.confirm()
+
+ @before(confirm_user)
+ def test_confirmed_users_have_no_token(self):
+ self.assertFalse(self.user.token)
+
+ def test_user_display_name_exists(self):
+ self.assertTrue(self.user.display_name)
+
+In the above example, the ``confirm_user`` method is run immediatly before the ``test_confirmed_users_have_no_token`` method, but **not** the ``test_user_display_name_exists`` method. The ``@before`` globally decorated ``create_user`` method still runs before each test method.
+
+``@before`` can also be constructed with multiple functions to call before running the test method:
+
+.. code:: python
+
+ class MyTest(Exam, TestCase):
+
+ @before(func1, func2)
+ def test_does_things(self):
+ does_things()
+
+In the above example, ``func1`` and ``func2`` are called in order before ``test_does_things`` is run.
+
+``exam.decorators.after``
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The compliment to ``@before``, ``@after`` adds the method to the list of methods which are run as part of the class's ``tearDown()`` routine. Like ``@before``, ``@after`` runs parent class ``@after`` hooks before running ones defined in child classes.
+
+.. code:: python
+
+ from exam.decorators import after
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ @after
+ def remove_temp_files(self):
+ myapp.remove_temp_files()
+
+
+``exam.decorators.around``
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Methods decorated with ``@around`` act as a conxtext manager around each test method. In your around method, you're responsible for calling ``yield`` where you want the test case to run:
+
+.. code:: python
+
+ from exam.decorators import around
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ @around
+ def run_in_transaction(self):
+ db.begin_transaction()
+ yield # Run the test
+ db.rollback_transaction()
+
+``@around`` also follows the same parent/child ordering rules as ``@before`` and ``@after``, so parent ``@arounds`` will run (up until the ``yield`` statmement), then child ``@around``s will run. After the test method has finished, however, the rest of the child's ``@around`` will run, and then the parents's. This is done to preserve the normal behavior of nesting with context managers.
+
+
+``exam.decorators.patcher``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``@patcher`` decorator is shorthand for the following boiler plate code:
+
+.. code:: python
+
+ from mock import patch
+
+ def setUp(self):
+ self.stats_patcher = patch('mylib.stats', new=dummy_stats)
+ self.stats = self.stats_patcher.start()
+
+ def tearDown(self):
+ self.stats_patcher.stop()
+
+Often, manually controlling a patch's start/stop is done to provide a test case property (here, ``self.stats``) for the mock object you are patching with. This is handy if you want the mock to have default behavior for most tests, but change it slightly for certain ones -- i.e absorb all calls most of the time, but for certain tests have it raise an exception.
+
+Using the ``@patcher`` decorator, the above code can simply be written as:
+
+.. code:: python
+
+ from exam.decorators import patcher
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ @patcher('mylib.stats')
+ def stats(self):
+ return dummy_stats
+
+Exam takes care of starting and stopping the patcher appropriately, as well as constructing the ``patch`` object with the return value from the decorated method.
+
+If you're happy with the default constructed mock object for a patch (``MagicMock``), then ``patcher`` can simply be used as an inline as a function inside the class body. This method still starts and stops the patcher when needed, and returns the constructed ``MagicMock`` object, which you can set as a class attribute. Exam will add the ``MagicMock`` object to the test case as an instance attribute automatically.
+
+.. code:: python
+
+ from exam.decorators import patcher
+ from exam.cases import Exam
+
+ class MyTest(Exam, TestCase):
+
+ logger = patcher('coffee.logger')
+
+
+``exam.decorators.patcher.object``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``patcher.object`` decorator provides the same features as the ``patcher`` decorator, but works with patching attributes of objects (similar to mock's ``mock.patch.object``). For example, here is how you would use patcher to patch the ``objects`` property of the ``User`` class:
+
+.. code:: python
+
+ from exam.decorators import patcher
+ from exam.cases import Exam
+
+ from myapp import User
+
+ class MyTest(Exam, TestCase):
+
+ manager = patcher.object(User, 'objects')
+
+As with the vanilla ``patcher``, in your test case, ``self.manager`` will be the mock object that ``User.objects`` was patched with.
+
+
+``exam.helpers``
+~~~~~~~~~~~~~~~~
+
+The ``helpers`` module features a collection of helper methods for common testing patterns:
+
+``exam.helpers.track``
+^^^^^^^^^^^^^^^^^^^^^^
+
+The ``track`` helper is intended to assist in tracking call orders of independent mock objects. ``track`` is called with kwargs, where the key is the mock name (a string) and the value is the mock object you want to track. ``track`` returns a newly constructed ``MagicMock`` object, with each mock object attached at a attribute named after the mock name.
+
+For example, below ``track()`` creates a new mock with ``tracker.cool` as the ``cool_mock`` and ``tracker.heat`` as the ``heat_mock``.
+
+.. code:: python
+
+ from exam.helpers import track
+
+ @mock.patch('coffee.roast.heat')
+ @mock.patch('coffee.roast.cool')
+ def test_roasting_heats_then_cools_beans(self, cool_mock, heat_mock):
+ tracker = track(heat=heat_mock, cool=cool_mock)
+ roast.perform()
+ tracker.assert_has_calls([mock.call.heat(), mock.call.cool()])
+
+``exam.helpers.rm_f``
+^^^^^^^^^^^^^^^^^^^^^
+
+This is a simple helper that just removes all folders and files at a path:
+
+.. code:: python
+
+ from exam.helpers import rm_f
+
+ rm_f('/folder/i/do/not/care/about')
+
+``exam.helpers.mock_import``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Removes most of the boiler plate code needed to mock imports, which usually consists of making a ``patch.dict`` from ``sys.modules``. Instead, the ``patch_import`` helper can simply be used as a decorator or context manager for when certain modules are imported.
+
+.. code:: python
+
+ from exam.helpers import mock_import
+
+ with mock_import('os.path') as my_os_path:
+ import os.path as imported_os_path
+ assert my_os_path is imported_os_path
+
+``mock_import`` can also be used as a decorator, which passed the mock value to
+the testing method (like a normal ``@patch``) decorator:
+
+.. code:: python
+
+ from exam.helpers import mock_import
+
+ @mock_import('os.path')
+ def test_method(self):
+ import os.path as imported_os_path
+ assert my_os_path is imported_os_path
+
+``exam.helpers.effect``
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Helper class that is itself callable, whose return values when called are configured via the tuples passed in to the constructor. Useful to build ``side_effect`` callables for Mock objects. Raises TypeError if called with arguments that it was not configured with:
+
+ >>> from exam.objects import call, effect
+ >>> side_effect = effect((call(1), 'with 1'), (call(2), 'with 2'))
+ >>> side_effect(1)
+ 'with 1'
+ >>> side_effect(2)
+ 'with 2'
+
+Call argument equality is checked via equality (==) of the ``call``` object, which is the 0th item of the configuration tuple passed in to the ``effect`` constructor. By default, ``call`` objects are just ``mock.call`` objects.
+
+If you would like to customize this behavior, subclass `effect` and redefine your own `call_class` class variable. I.e.
+
+.. code:: python
+
+ class myeffect(effect):
+ call_class = my_call_class
+
+``exam.mock``
+~~~~~~~~~~~~~
+
+Exam has a subclass of the normal ``mock.Mock`` object that adds a few more useful methods to your mock objects. Use it in place of a normal ``Mock`` object:
+
+.. code:: python
+
+ from exam.mock import Mock
+
+ mock_user = Mock(spec=User)
+
+The subclass has the following extra methods:
+
+* ``assert_called()`` - Asserts the mock was called at least once.
+* ``assert_not_called()`` - Asserts the mock has never been called.
+* ``assert_not_called_with(*args, **kwargs)`` - Asserts the mock was not most recently called with the specified ``*args`` and ``**kwargs``.
+* ``assert_not_called_once_with(*args, **kwargs)`` - Asserts the mock has only every been called once with the specified ``*args`` and ``**kwargs``.
+* ``assert_not_any_call(*args, **kwargs)`` - Asserts the mock has never been called with the specified ``*args`` and ``**kwargs``.
+
+``exam.fixtures``
+~~~~~~~~~~~~~~~~~
+
+Helpful fixtures that you may want to use in your tests:
+
+* ``exam.fixtures.two_px_square_image`` - Image data as a string of a 2px square image.
+* ``exam.fixtures.one_px_spacer`` - Image data as a string of a 1px square spacer image.
+
+``exam.objects``
+~~~~~~~~~~~~~~~~
+
+Useful objects for use in testing:
+
+``exam.objects.noop`` - callable object that always returns ``None``. no matter how it was called.
+
+``exam.asserts``
+~~~~~~~~~~~~~~~~
+
+The `asserts` module contains an `AssertsMixin` class, which is mixed into the main `Exam` test case mixin. It contains additional asserts beoynd the ones in Python's `unittest`.
+
+``assertChanges``
+^^^^^^^^^^^^^^^^^
+
+Used when you want to assert that a section of code changes a value. For example, imagine if you had a function that changed a soldier's rank.
+
+To properly test this, you should save that soldier's rank to a temporary variable, then run the function to change the rank, and then finally assert that the rank is the new expected value, as well as **not** the old value:
+
+.. code:: python
+
+ test_changes_rank(self):
+ old_rank = self.soldier.rank
+ promote(self.soldier, 'general')
+ self.assertEqual(self.soldier.rank, 'general')
+ self.assertNotEqual(self.soldier.rank, old_rank)
+
+Checking the old rank is not the same is the new rank is important. If, for some reason there is a bug or something to where ``self.soldier`` is created with the rank of ``general``, but ``promote`` is not working, this test would still pass!
+
+To solve this, you can use Exam's ``assertChanges``:
+
+.. code:: python
+
+ def test_changes_rank(self):
+ with self.assertChanges(getattr, self.soldier, 'rank', after='general'):
+ promote(self.soldier, 'general')
+
+This assert is doing a few things.
+
+1. It asserts that the rank once the context is run is the expected ``general``.
+2. It asserts that the context **changes** the value of ``self.soldier.rank``.
+3. It doesn't actually care what the old value of ``self.soldier.rank`` was, as long as it changed when the context was run.
+
+The definition of ``assertChanges`` is:
+
+.. code:: python
+ def assertChanges(thing, *args, **kwargs)
+
+1. You pass it a ``thing``, which which be a callable.
+2. ``assertChanges`` then calls your ``thing`` with any ``*args`` and ``**kwargs`` additionally passed in and captures the value as the "before" value.
+3. The context is run, and then the callable is captured again as the "after" value.
+4. If before and after are not different, an ``AssertionError`` is raised.
+5. Additionally, if the special kwarg ``before`` or ``after`` are passed, those values are extracted and saved. In this case an ``AssertionError`` can also be raised if the "before" and/or "after" values provided do not match their extracted values.
+
+``assertDoesNotChange``
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Similar to ``assertChanges``, ``assertDoesNotChange`` asserts that the code inside the context does not change the value from the callable:
+
+.. code:: python
+
+ def test_does_not_change_rank(self):
+ with self.assertDoesNotChange(getattr, self.soldier, 'rank'):
+ self.soldier.march()
+
+Unlike ``assertChanges``, ``assertDoesNotChange`` does not take ``before`` or ``after`` kwargs. It simply asserts that the value of the callable did not change when the context was run.
+
+License
+-------
+
+Exam is MIT licensed. Please see the ``LICENSE`` file for details.
diff --git a/exam.sublime-project b/exam.sublime-project
new file mode 100644
index 0000000..a2b74ba
--- /dev/null
+++ b/exam.sublime-project
@@ -0,0 +1,25 @@
+{
+ "folders": [
+ {
+ "folder_exclude_patterns": [
+ "*.egg",
+ "build",
+ "dist",
+ "*.egg-info",
+ "doc/_*",
+ ".ropeproject"
+ ],
+ "file_exclude_patterns": [
+ "*.egg",
+ "*.sublime-workspace",
+ "*_pb2.py"
+ ],
+ "path": "."
+ }
+ ],
+ "settings": {
+ "tab_size": 4,
+ "translate_tabs_to_spaces": true,
+ "trim_trailing_white_space_on_save": true
+ }
+}
diff --git a/exam/__init__.py b/exam/__init__.py
new file mode 100644
index 0000000..5b1a957
--- /dev/null
+++ b/exam/__init__.py
@@ -0,0 +1,5 @@
+from __future__ import absolute_import
+
+from exam.cases import Exam # NOQA
+from exam.helpers import intercept # NOQA
+from exam.decorators import before, after, around, fixture, patcher # NOQA
diff --git a/exam/asserts.py b/exam/asserts.py
new file mode 100644
index 0000000..73ac242
--- /dev/null
+++ b/exam/asserts.py
@@ -0,0 +1,66 @@
+from functools import partial
+from operator import eq, ne
+
+
+IRRELEVANT = object()
+
+
+class ChangeWatcher(object):
+
+ POSTCONDITION_FAILURE_MESSAGE = {
+ ne: 'Value did not change',
+ eq: 'Value changed from {before} to {after}',
+ 'invalid': 'Value changed to {after}, not {expected_after}'
+ }
+
+ def __init__(self, comparator, check, *args, **kwargs):
+ self.check = check
+ self.comparator = comparator
+
+ self.args = args
+ self.kwargs = kwargs
+
+ self.expected_before = kwargs.pop('before', IRRELEVANT)
+ self.expected_after = kwargs.pop('after', IRRELEVANT)
+
+ def __enter__(self):
+ self.before = self.__apply()
+
+ if not self.expected_before is IRRELEVANT:
+ check = self.comparator(self.before, self.expected_before)
+ message = "Value before is {before}, not {expected_before}"
+
+ assert not check, message.format(**vars(self))
+
+ def __exit__(self, exec_type, exec_value, traceback):
+ if exec_type is not None:
+ return False # reraises original exception
+
+ self.after = self.__apply()
+
+ met_precondition = self.comparator(self.before, self.after)
+ after_value_matches = self.after == self.expected_after
+
+ # Changed when it wasn't supposed to, or, didn't change when it was
+ if not met_precondition:
+ self.__raise_postcondition_error(self.comparator)
+ # Do care about the after value, but it wasn't equal
+ elif self.expected_after is not IRRELEVANT and not after_value_matches:
+ self.__raise_postcondition_error('invalid')
+
+ def __apply(self):
+ return self.check(*self.args, **self.kwargs)
+
+ def __raise_postcondition_error(self, key):
+ message = self.POSTCONDITION_FAILURE_MESSAGE[key]
+ raise AssertionError(message.format(**vars(self)))
+
+
+class AssertsMixin(object):
+ assertChanges = partial(ChangeWatcher, ne)
+ assertDoesNotChange = partial(
+ ChangeWatcher,
+ eq,
+ before=IRRELEVANT,
+ after=IRRELEVANT
+ )
diff --git a/exam/cases.py b/exam/cases.py
new file mode 100644
index 0000000..4ce1d6c
--- /dev/null
+++ b/exam/cases.py
@@ -0,0 +1,59 @@
+from __future__ import absolute_import
+
+from exam.decorators import before, after, around, patcher # NOQA
+from exam.objects import noop # NOQA
+from exam.asserts import AssertsMixin
+
+import inspect
+
+
+class MultipleGeneratorsContextManager(object):
+
+ def __init__(self, *generators):
+ self.generators = generators
+
+ def __enter__(self, *args, **kwargs):
+ [next(g) for g in self.generators]
+
+ def __exit__(self, *args, **kwargs):
+ for generator in reversed(self.generators):
+ try:
+ next(generator)
+ except StopIteration:
+ pass
+
+
+class Exam(AssertsMixin):
+
+ @before
+ def __setup_patchers(self):
+ for attr, patchr in self.__attrs_of_type(patcher):
+ patch_object = patchr.build_patch(self)
+ setattr(self, attr, patch_object.start())
+ self.addCleanup(patch_object.stop)
+
+ def __attrs_of_type(self, kind):
+ for base in reversed(inspect.getmro(type(self))):
+ for attr, class_value in vars(base).items():
+ resolved_value = getattr(type(self), attr, False)
+
+ if type(resolved_value) is not kind:
+ continue
+ # If the attribute inside of this base is not the exact same
+ # value as the one in type(self), that means that it's been
+ # overwritten somewhere down the line and we shall skip it
+ elif class_value is not resolved_value:
+ continue
+ else:
+ yield attr, resolved_value
+
+ def __run_hooks(self, hook):
+ for _, value in self.__attrs_of_type(hook):
+ value(self)
+
+ def run(self, *args, **kwargs):
+ generators = (value(self) for _, value in self.__attrs_of_type(around))
+ with MultipleGeneratorsContextManager(*generators):
+ self.__run_hooks(before)
+ getattr(super(Exam, self), 'run', noop)(*args, **kwargs)
+ self.__run_hooks(after)
diff --git a/exam/decorators.py b/exam/decorators.py
new file mode 100644
index 0000000..c0eebe8
--- /dev/null
+++ b/exam/decorators.py
@@ -0,0 +1,111 @@
+from __future__ import absolute_import
+
+from mock import patch
+from functools import partial, wraps
+import types
+
+import exam.cases
+
+
+class fixture(object):
+
+ def __init__(self, thing, *args, **kwargs):
+ self.thing = thing
+ self.args = args
+ self.kwargs = kwargs
+
+ def __get__(self, testcase, type=None):
+ if not testcase:
+ # Test case fixture was accesse as a class property, so just return
+ # this fixture itself.
+ return self
+ elif self not in testcase.__dict__:
+ # If this fixture is not present in the test case's __dict__,
+ # freshly apply this fixture and store that in the dict, keyed by
+ # self
+ application = self.__apply(testcase)(*self.args, **self.kwargs)
+ testcase.__dict__[self] = application
+
+ return testcase.__dict__[self]
+
+ def __apply(self, testcase):
+ # If self.thing is a method type, it means that the function is already
+ # bound to a class and therefore we should treat it just like a normal
+ # functuion and return it.
+ if type(self.thing) in (type, types.MethodType):
+ return self.thing
+ # If not, it means that's it's a vanilla function,
+ # so either a decorated instance method in the test case
+ # body or a lambda. In either of those
+ # cases, it's called with the test case instance (self) to the author.
+ else:
+ return partial(self.thing, testcase)
+
+
+class base(object):
+
+ def __init__(self, *things):
+ self.init_callables = things
+
+ def __call__(self, instance):
+ return self.init_callables[0](instance)
+
+
+class before(base):
+
+ def __call__(self, thing):
+ # There a couple possible situations at this point:
+ #
+ # If ``thing`` is an instance of a test case, this means that we
+ # ``init_callable`` is the function we want to decorate. As such,
+ # simply call that callable with the instance.
+ if isinstance(thing, exam.cases.Exam):
+ return self.init_callables[0](thing)
+ # If ``thing is not an instance of the test case, it means thi before
+ # hook was constructed with a callable that we need to run before
+ # actually running the decorated function.
+ # It also means that ``thing`` is the function we're
+ # decorating, so we need to return a callable that
+ # accepts a test case instance and, when called, calls the
+ # ``init_callable`` first, followed by the actual function we are
+ # decorating.
+ else:
+ @wraps(thing)
+ def inner(testcase):
+ [f(testcase) for f in self.init_callables]
+ thing(testcase)
+
+ return inner
+
+
+class after(base):
+ pass
+
+
+class around(base):
+ pass
+
+
+class patcher(object):
+
+ def __init__(self, *args, **kwargs):
+ self.args = args
+ self.kwargs = kwargs
+ self.func = None
+ self.patch_func = patch
+
+ def __call__(self, func):
+ self.func = func
+ return self
+
+ def build_patch(self, instance):
+ if self.func:
+ self.kwargs['new'] = self.func(instance)
+
+ return self.patch_func(*self.args, **self.kwargs)
+
+ @classmethod
+ def object(cls, *args, **kwargs):
+ instance = cls(*args, **kwargs)
+ instance.patch_func = patch.object
+ return instance
diff --git a/exam/fixtures.py b/exam/fixtures.py
new file mode 100644
index 0000000..b07aa32
--- /dev/null
+++ b/exam/fixtures.py
@@ -0,0 +1,15 @@
+#: A string representation of a 2px square GIF, suitable for use in PIL.
+two_px_square_image = (
+ 'GIF87a\x02\x00\x02\x00\xb3\x00\x00\x00\x00\x00\xff\xff\xff\x00\x00' +
+ '\x00\x00\x00\x00\x00\x00\x00\xff\x00\xff\x00\x00\x00\x00\x00\x00' +
+ '\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00' +
+ '\x00\x00\x00\x00\x00\x00\x00\x00,\x00\x00\x00\x00\x02\x00\x02\x00' +
+ '\x00\x04\x04\x10\x94\x02"\x00;'
+ )
+
+#: A string representation of a 1px square GIF, suitable for use in PIL.
+one_px_spacer = (
+ 'GIF89a\x01\x00\x01\x00\x80\x00\x00\xdb\xdf\xef\x00\x00\x00!\xf9\x04' +
+ '\x01\x00\x00\x00\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02D' +
+ '\x01\x00;'
+ )
diff --git a/exam/helpers.py b/exam/helpers.py
new file mode 100644
index 0000000..3967aed
--- /dev/null
+++ b/exam/helpers.py
@@ -0,0 +1,162 @@
+from __future__ import absolute_import
+
+import shutil
+import os
+import functools
+
+from mock import MagicMock, patch, call
+
+
+def rm_f(path):
+ try:
+ # Assume it's a directory
+ shutil.rmtree(path, ignore_errors=True)
+ except OSError:
+ # Directory delete failed, so it's likely a file
+ os.remove(path)
+
+
+def track(**mocks):
+ tracker = MagicMock()
+
+ for name, mocker in mocks.items():
+ tracker.attach_mock(mocker, name)
+
+ return tracker
+
+
+def intercept(obj, methodname, wrapper):
+ """
+ Wraps an existing method on an object with the provided generator, which
+ will be "sent" the value when it yields control.
+
+ ::
+
+ >>> def ensure_primary_key_is_set():
+ ... assert model.pk is None
+ ... saved = yield
+ ... aasert model is saved
+ ... assert model.pk is not None
+ ...
+ >>> intercept(model, 'save', ensure_primary_key_is_set)
+ >>> model.save()
+
+ :param obj: the object that has the method to be wrapped
+ :type obj: :class:`object`
+ :param methodname: the name of the method that will be wrapped
+ :type methodname: :class:`str`
+ :param wrapper: the wrapper
... 956 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/exam.git
More information about the Python-modules-commits
mailing list