[Python-modules-commits] [python-genty] 01/06: Import python-genty_1.3.0.orig.tar.gz.
Tristan Seligmann
mithrandi at moszumanska.debian.org
Mon Jan 18 14:22:35 UTC 2016
This is an automated email from the git hooks/post-receive script.
mithrandi pushed a commit to branch master
in repository python-genty.
commit 40ed7bb922abe31dae9afbe3ab9ee774c5af7969
Author: Tristan Seligmann <mithrandi at mithrandi.net>
Date: Mon Jan 18 15:46:29 2016 +0200
Import python-genty_1.3.0.orig.tar.gz.
---
LICENSE | 166 ++++++++++++++
MANIFEST.in | 1 +
PKG-INFO | 486 ++++++++++++++++++++++++++++++++++++++++
README.rst | 293 ++++++++++++++++++++++++
genty/__init__.py | 8 +
genty/genty.py | 510 ++++++++++++++++++++++++++++++++++++++++++
genty/genty_args.py | 81 +++++++
genty/genty_dataset.py | 214 ++++++++++++++++++
genty/genty_repeat.py | 36 +++
genty/private/__init__.py | 50 +++++
setup.cfg | 5 +
setup.py | 55 +++++
test/test_case_base.py | 17 ++
test/test_example.py | 96 ++++++++
test/test_genty.py | 539 +++++++++++++++++++++++++++++++++++++++++++++
test/test_genty_args.py | 77 +++++++
test/test_genty_dataset.py | 202 +++++++++++++++++
test/test_genty_repeat.py | 41 ++++
18 files changed, 2877 insertions(+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..167ec4d
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,166 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..0c73842
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1 @@
+include README.rst LICENSE
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..4404394
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,486 @@
+Metadata-Version: 1.1
+Name: genty
+Version: 1.3.0
+Summary: Allows you to run a test with multiple data sets
+Home-page: https://github.com/box/genty
+Author: Box
+Author-email: oss at box.com
+License: Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Description: genty
+ =====
+
+ .. image:: http://opensource.box.com/badges/active.svg
+ :target: http://opensource.box.com/badges
+
+ .. image:: https://travis-ci.org/box/genty.png?branch=master
+ :target: https://travis-ci.org/box/genty
+
+ .. image:: https://img.shields.io/pypi/v/genty.svg
+ :target: https://pypi.python.org/pypi/genty
+
+ .. image:: https://img.shields.io/pypi/dm/genty.svg
+ :target: https://pypi.python.org/pypi/genty
+
+
+ About
+ -----
+
+ Genty, pronounced "gen-tee", stands for "generate tests". It promotes generative
+ testing, where a single test can execute over a variety of input. Genty makes
+ this a breeze.
+
+ For example, consider a file sample.py containing both the code under test and
+ the tests:
+
+ .. code-block:: python
+
+ from genty import genty, genty_repeat, genty_dataset
+ from unittest import TestCase
+
+ # Here's the class under test
+ class MyClass(object):
+ def add_one(self, x):
+ return x + 1
+
+ # Here's the test code
+ @genty
+ class MyClassTests(TestCase):
+ @genty_dataset(
+ (0, 1),
+ (100000, 100001),
+ )
+ def test_add_one(self, value, expected_result):
+ actual_result = MyClass().add_one(value)
+ self.assertEqual(expected_result, actual_result)
+
+
+ Running the ``MyClassTests`` using the default unittest runner
+
+ .. code-block:: console
+
+ $ python -m unittest -v sample
+ test_add_one(0, 1) (sample.MyClassTests) ... ok
+ test_add_one(100000, 100001) (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 2 tests in 0.000s
+
+ OK
+
+ Instead of having to write multiple independent tests for various test cases,
+ code can be refactored and parametrized using genty!
+
+ It produces readable tests.
+ It produces maintainable tests.
+ It produces expressive tests.
+
+ Another option is running the same test multiple times. This is useful in stress
+ tests or when exercising code looking for race conditions. This particular test
+
+ .. code-block:: python
+
+ @genty_repeat(3)
+ def test_adding_one_to_zero(self):
+ self.assertEqual(1, MyClass().add_one(0))
+
+
+ would be run 3 times, producing output like
+
+ .. code-block:: console
+
+ $ python -m unittest -v sample
+ test_adding_one() iteration_1 (sample.MyClassTests) ... ok
+ test_adding_one() iteration_2 (sample.MyClassTests) ... ok
+ test_adding_one() iteration_3 (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 3 tests in 0.001s
+
+ OK
+
+ The 2 techniques can be combined:
+
+ .. code-block:: python
+
+ @genty_repeat(2)
+ @genty_dataset(
+ (0, 1),
+ (100000, 100001),
+ )
+ def test_add_one(self, value, expected_result):
+ actual_result = MyClass().add_one(value)
+ self.assertEqual(expected_result, actual_result)
+
+
+ There are more options to explore including naming your datasets and ``genty_args``.
+
+ .. code-block:: python
+
+ @genty_dataset(
+ default_case=(0, 1),
+ limit_case=(999, 1000),
+ error_case=genty_args(-1, -1, is_something=False),
+ )
+ def test_complex(self, value1, value2, optional_value=None, is_something=True):
+ ...
+
+
+ would run 3 tests, producing output like
+
+ .. code-block:: console
+
+ $ python -m unittest -v sample
+ test_complex(default_case) (sample.MyClassTests) ... ok
+ test_complex(limit_case) (sample.MyClassTests) ... ok
+ test_complex(error_case) (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 3 tests in 0.003s
+
+ OK
+
+
+ The ``@genty_datasets`` can be chained together. This is useful, for example, if there are semantically different datasets
+ so keeping them separate would help expressiveness.
+
+
+ .. code-block:: python
+
+ @genty_dataset(10, 100)
+ @genty_dataset('first', 'second')
+ def test_composing(self, parameter_value):
+ ...
+
+
+ would run 4 tests, producing output like
+
+ .. code-block:: console
+
+ $ python -m unittest -v sample
+ test_composing(10) (sample.MyClassTests) ... ok
+ test_composing(100) (sample.MyClassTests) ... ok
+ test_composing(u'first') (sample.MyClassTests) ... ok
+ test_composing(u'second') (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 4 tests in 0.000s
+
+ OK
+
+
+ Sometimes the parameters to a test can't be determined at module load time. For example,
+ some test might be based on results from some http request. And first the test needs to
+ authenticate, etc. This is supported using the ``@genty_dataprovider`` decorator like so:
+
+
+ .. code-block:: python
+
+ def setUp(self):
+ super(MyClassTests, self).setUp()
+
+ # http authentication happens
+ # And imagine that _some_function is actually some http request
+ self._some_function = lambda x, y: ((x + y), (x - y), (x * y))
+
+ @genty_dataset((1000, 100), (100, 1))
+ def calculate(self, x_val, y_val):
+ # when this is called... we've been authenticated
+ return self._some_function(x_val, y_val)
+
+ @genty_dataprovider(calculate)
+ def test_heavy(self, data1, data2, data3):
+ ...
+
+
+ would run 4 tests, producing output like
+
+ .. code-block:: console
+
+
+ $ python -m unittest -v sample
+ test_heavy_calculate(100, 1) (sample.MyClassTests) ... ok
+ test_heavy_calculate(1000, 100) (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 2 tests in 0.000s
+
+ OK
+
+ Notice here how the name of the helper (``calculate``) is added to the names of the 2
+ executed test cases.
+
+ Like ``@genty_dataset``, ``@genty_dataprovider`` can be chained together.
+
+ Enjoy!
+
+ Deferred Parameterization
+ -------------------------
+
+ Parametrized tests where the final parameters are not determined until test
+ execution time. It looks like so:
+
+ .. code-block:: python
+
+ @genty_dataset((1000, 100), (100, 1))
+ def calculate(self, x_val, y_val):
+ # when this is called... we've been authenticated, perhaps in
+ # some Test.setUp() method.
+
+ # Let's imagine that _some_function requires that authentication.
+ # And it returns a 3-tuple, matching that signature of
+ # of the test(s) decorated with this 'calculate' method.
+ return self._some_function(x_val, y_val)
+
+ @genty_dataprovider(calculate)
+ def test_heavy(self, data1, data2, data3):
+ ...
+
+ The ``calculate()`` method is called 2 times based on the ``@genty_dataset``
+ decorator, and each of it's return values define the final parameters that will
+ be given to the method ``test_heavy(...)``.
+
+ Installation
+ ------------
+
+ To install, simply:
+
+ .. code-block:: console
+
+ pip install genty
+
+
+ Contributing
+ ------------
+
+ See `CONTRIBUTING.rst <https://github.com/box/genty/blob/master/CONTRIBUTING.rst>`_.
+
+
+ Setup
+ ~~~~~
+
+ Create a virtual environment and install packages -
+
+ .. code-block:: console
+
+ mkvirtualenv genty
+ pip install -r requirements-dev.txt
+
+
+ Testing
+ ~~~~~~~
+
+ Run all tests using -
+
+ .. code-block:: console
+
+ tox
+
+ The tox tests include code style checks via pep8 and pylint.
+
+ The tox tests are configured to run on Python 2.6, 2.7, 3.3, 3.4, 3.5, and
+ PyPy 2.6.
+
+
+ Copyright and License
+ ---------------------
+
+ ::
+
+ Copyright 2015 Box, Inc. All rights reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+Keywords: genty,tests,generative,unittest
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Software Development
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..e3ed7f5
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,293 @@
+genty
+=====
+
+.. image:: http://opensource.box.com/badges/active.svg
+ :target: http://opensource.box.com/badges
+
+.. image:: https://travis-ci.org/box/genty.png?branch=master
+ :target: https://travis-ci.org/box/genty
+
+.. image:: https://img.shields.io/pypi/v/genty.svg
+ :target: https://pypi.python.org/pypi/genty
+
+.. image:: https://img.shields.io/pypi/dm/genty.svg
+ :target: https://pypi.python.org/pypi/genty
+
+
+About
+-----
+
+Genty, pronounced "gen-tee", stands for "generate tests". It promotes generative
+testing, where a single test can execute over a variety of input. Genty makes
+this a breeze.
+
+For example, consider a file sample.py containing both the code under test and
+the tests:
+
+.. code-block:: python
+
+ from genty import genty, genty_repeat, genty_dataset
+ from unittest import TestCase
+
+ # Here's the class under test
+ class MyClass(object):
+ def add_one(self, x):
+ return x + 1
+
+ # Here's the test code
+ @genty
+ class MyClassTests(TestCase):
+ @genty_dataset(
+ (0, 1),
+ (100000, 100001),
+ )
+ def test_add_one(self, value, expected_result):
+ actual_result = MyClass().add_one(value)
+ self.assertEqual(expected_result, actual_result)
+
+
+Running the ``MyClassTests`` using the default unittest runner
+
+.. code-block:: console
+
+ $ python -m unittest -v sample
+ test_add_one(0, 1) (sample.MyClassTests) ... ok
+ test_add_one(100000, 100001) (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 2 tests in 0.000s
+
+ OK
+
+Instead of having to write multiple independent tests for various test cases,
+code can be refactored and parametrized using genty!
+
+It produces readable tests.
+It produces maintainable tests.
+It produces expressive tests.
+
+Another option is running the same test multiple times. This is useful in stress
+tests or when exercising code looking for race conditions. This particular test
+
+.. code-block:: python
+
+ @genty_repeat(3)
+ def test_adding_one_to_zero(self):
+ self.assertEqual(1, MyClass().add_one(0))
+
+
+would be run 3 times, producing output like
+
+.. code-block:: console
+
+ $ python -m unittest -v sample
+ test_adding_one() iteration_1 (sample.MyClassTests) ... ok
+ test_adding_one() iteration_2 (sample.MyClassTests) ... ok
+ test_adding_one() iteration_3 (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 3 tests in 0.001s
+
+ OK
+
+The 2 techniques can be combined:
+
+.. code-block:: python
+
+ @genty_repeat(2)
+ @genty_dataset(
+ (0, 1),
+ (100000, 100001),
+ )
+ def test_add_one(self, value, expected_result):
+ actual_result = MyClass().add_one(value)
+ self.assertEqual(expected_result, actual_result)
+
+
+There are more options to explore including naming your datasets and ``genty_args``.
+
+.. code-block:: python
+
+ @genty_dataset(
+ default_case=(0, 1),
+ limit_case=(999, 1000),
+ error_case=genty_args(-1, -1, is_something=False),
+ )
+ def test_complex(self, value1, value2, optional_value=None, is_something=True):
+ ...
+
+
+would run 3 tests, producing output like
+
+.. code-block:: console
+
+ $ python -m unittest -v sample
+ test_complex(default_case) (sample.MyClassTests) ... ok
+ test_complex(limit_case) (sample.MyClassTests) ... ok
+ test_complex(error_case) (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 3 tests in 0.003s
+
+ OK
+
+
+The ``@genty_datasets`` can be chained together. This is useful, for example, if there are semantically different datasets
+so keeping them separate would help expressiveness.
+
+
+.. code-block:: python
+
+ @genty_dataset(10, 100)
+ @genty_dataset('first', 'second')
+ def test_composing(self, parameter_value):
+ ...
+
+
+would run 4 tests, producing output like
+
+.. code-block:: console
+
+ $ python -m unittest -v sample
+ test_composing(10) (sample.MyClassTests) ... ok
+ test_composing(100) (sample.MyClassTests) ... ok
+ test_composing(u'first') (sample.MyClassTests) ... ok
+ test_composing(u'second') (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 4 tests in 0.000s
+
+ OK
+
+
+Sometimes the parameters to a test can't be determined at module load time. For example,
+some test might be based on results from some http request. And first the test needs to
+authenticate, etc. This is supported using the ``@genty_dataprovider`` decorator like so:
+
+
+.. code-block:: python
+
+ def setUp(self):
+ super(MyClassTests, self).setUp()
+
+ # http authentication happens
+ # And imagine that _some_function is actually some http request
+ self._some_function = lambda x, y: ((x + y), (x - y), (x * y))
+
+ @genty_dataset((1000, 100), (100, 1))
+ def calculate(self, x_val, y_val):
+ # when this is called... we've been authenticated
+ return self._some_function(x_val, y_val)
+
+ @genty_dataprovider(calculate)
+ def test_heavy(self, data1, data2, data3):
+ ...
+
+
+would run 4 tests, producing output like
+
+.. code-block:: console
+
+
+ $ python -m unittest -v sample
+ test_heavy_calculate(100, 1) (sample.MyClassTests) ... ok
+ test_heavy_calculate(1000, 100) (sample.MyClassTests) ... ok
+
+ ----------------------------------------------------------------------
+ Ran 2 tests in 0.000s
+
+ OK
+
+Notice here how the name of the helper (``calculate``) is added to the names of the 2
+executed test cases.
+
+Like ``@genty_dataset``, ``@genty_dataprovider`` can be chained together.
+
+Enjoy!
+
+Deferred Parameterization
+-------------------------
+
+Parametrized tests where the final parameters are not determined until test
+execution time. It looks like so:
+
+.. code-block:: python
+
+ @genty_dataset((1000, 100), (100, 1))
+ def calculate(self, x_val, y_val):
+ # when this is called... we've been authenticated, perhaps in
+ # some Test.setUp() method.
+
+ # Let's imagine that _some_function requires that authentication.
+ # And it returns a 3-tuple, matching that signature of
+ # of the test(s) decorated with this 'calculate' method.
+ return self._some_function(x_val, y_val)
+
+ @genty_dataprovider(calculate)
+ def test_heavy(self, data1, data2, data3):
+ ...
+
+The ``calculate()`` method is called 2 times based on the ``@genty_dataset``
+decorator, and each of it's return values define the final parameters that will
+be given to the method ``test_heavy(...)``.
+
+Installation
+------------
+
+To install, simply:
+
+.. code-block:: console
+
+ pip install genty
+
+
+Contributing
+------------
+
+See `CONTRIBUTING.rst <https://github.com/box/genty/blob/master/CONTRIBUTING.rst>`_.
+
+
+Setup
+~~~~~
+
+Create a virtual environment and install packages -
+
+.. code-block:: console
+
+ mkvirtualenv genty
+ pip install -r requirements-dev.txt
+
+
+Testing
+~~~~~~~
+
+Run all tests using -
+
+.. code-block:: console
+
+ tox
+
+The tox tests include code style checks via pep8 and pylint.
+
+The tox tests are configured to run on Python 2.6, 2.7, 3.3, 3.4, 3.5, and
+PyPy 2.6.
+
+
+Copyright and License
+---------------------
+
+::
+
+ Copyright 2015 Box, Inc. All rights reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/genty/__init__.py b/genty/__init__.py
new file mode 100644
index 0000000..1ec18d2
--- /dev/null
... 2011 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-genty.git
More information about the Python-modules-commits
mailing list