[Python-modules-commits] [python-testing.common.database] 01/07: import python-testing.common.database_2.0.0.orig.tar.gz
Dominik George
natureshadow-guest at moszumanska.debian.org
Thu Sep 29 13:40:09 UTC 2016
This is an automated email from the git hooks/post-receive script.
natureshadow-guest pushed a commit to branch master
in repository python-testing.common.database.
commit b0a694f1da1bcf5ceb1815ba4315c13e86d2a654
Author: Dominik George <nik at naturalnet.de>
Date: Thu Sep 29 15:00:20 2016 +0200
import python-testing.common.database_2.0.0.orig.tar.gz
---
LICENSE | 202 ++++++++++++++
MANIFEST.in | 4 +
PKG-INFO | 234 ++++++++++++++++
README.rst | 211 ++++++++++++++
setup.cfg | 25 ++
setup.py | 49 ++++
src/testing.common.database.egg-info/PKG-INFO | 234 ++++++++++++++++
src/testing.common.database.egg-info/SOURCES.txt | 14 +
.../dependency_links.txt | 1 +
.../namespace_packages.txt | 2 +
src/testing.common.database.egg-info/requires.txt | 3 +
src/testing.common.database.egg-info/top_level.txt | 1 +
src/testing/__init__.py | 16 ++
src/testing/common/__init__.py | 16 ++
src/testing/common/database.py | 310 +++++++++++++++++++++
15 files changed, 1322 insertions(+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ 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
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..59d7558
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,4 @@
+include MANIFEST.in
+include LICENSE
+include README.rst
+recursive-include src *.py
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..d041a7b
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,234 @@
+Metadata-Version: 1.1
+Name: testing.common.database
+Version: 2.0.0
+Summary: utilities for testing.* packages
+Home-page: https://github.com/tk0miya/testing.common.database
+Author: Takeshi Komiya
+Author-email: i.tkomiya at gmail.com
+License: Apache License 2.0
+Description: About
+ =====
+ ``testing.common.database`` is utilities for testing.* package.
+
+ .. image:: https://travis-ci.org/tk0miya/testing.common.database.svg?branch=master
+ :target: https://travis-ci.org/tk0miya/testing.common.database
+
+ .. image:: https://codeclimate.com/github/tk0miya/testing.common.database/badges/gpa.svg
+ :target: https://codeclimate.com/github/tk0miya/testing.common.database
+
+
+ Install
+ =======
+ Use pip::
+
+ $ pip install testing.common.database
+
+
+ Helpers
+ =======
+ class Database(object):
+
+ ``Database`` is a base class for database testing packages.
+ To create your database testing class, inherit this class and override methods below.
+
+ def initialize(self):
+
+ Handler for initialize database object.
+
+ def get_data_directory(self):
+
+ Path to data directory of your databse.
+
+ Example::
+
+ def get_data_directory(self):
+ return os.path.join(self.base_dir, 'data')
+
+ def initialize_database(self):
+
+ Handler to initialize your database.
+
+ Example::
+
+ def initialize_database(self):
+ if not os.path.exists(os.path.join(self.base_dir, 'data', 'PG_VERSION')):
+ args = ([self.initdb, '-D', os.path.join(self.base_dir, 'data'), '--lc-messages=C'] +
+ self.settings['initdb_args'].split())
+
+ try:
+ p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ output, err = p.communicate()
+ if p.returncode != 0:
+ raise RuntimeError("initdb failed: %r" % err)
+ except OSError as exc:
+ raise RuntimeError("failed to spawn initdb: %s" % exc)
+
+ def get_server_commandline(self):
+
+ Command line to invoke your database server.
+
+ Example::
+
+ def get_server_commandline(self):
+ return (['postgres',
+ '-p', str(self.settings['port']),
+ '-D', os.path.join(self.base_dir, 'data'),
+ '-k', os.path.join(self.base_dir, 'tmp')] +
+ self.settings['postgres_args'].split())
+
+ def prestart(self):
+
+ Handler called before invoking your database server.
+
+ def poststart(self):
+
+ Hander called after invoking your database server.
+
+ def is_server_available(self):
+
+ Methods check your database server available.
+ The ``Database`` class uses this method to check the server boots up.
+
+ Example::
+
+ try:
+ with closing(pg8000.connect(**self.dsn(database='template1'))):
+ pass
+ except pg8000.Error:
+ return False
+ else:
+ return True
+
+ def is_alive(self):
+
+ Methods check the database server is alive.
+
+ @property
+ def server_pid(self):
+
+ Process ID of the database server.
+
+
+ class DatabaseFactory(object):
+
+ ``DatabaseFactory`` is a factory class for the database class.
+ To create your database factory class, inherit this class and set ``target_class`` variable::
+
+ class PostgresqlFactory(DatabaseFactory):
+ target_class = Postgresql
+
+ The factory class should work like a ``target_class``::
+
+ # The factory class generates like a ``target_class``, in this case, generates ``Postgresql`` class
+ Postgresql = PostgresqlFactory()
+
+ # The generated class works same as ``target_class``
+ with Postgresql() as pgsql:
+ #
+ # do any tests using the database ...
+ #
+
+ It can bypass parameters to the ``target_class`` on every instantiation::
+
+ Postgresql = PostgresqlFactory(copy_data_from='/path/to/database')
+
+ with Postgresql() as pgsql:
+ #
+ # Test with ``copy_data_from`` parameter :-)
+ #
+
+ Also, it is able to cache the database generated at ``Database.initialize_database()``
+ with ``cache_initialized_db`` parameter.
+ It avoids running database initialization on every tests::
+
+ # Initialize database once
+ Postgresql = PostgresqlFactory(cache_initialized_db=True)
+
+ with Postgresql() as pgsql:
+ # copy cached database for this test.
+
+ If you want to fixtures to the database, use ``on_initialized`` parameter::
+
+ def handler(pgsql):
+ # inserting fixtures
+
+ # Initialize database once, and call ``on_initialized`` handler
+ Postgresql = PostgresqlFactory(cache_initialized_db=True,
+ on_initialized=handler)
+
+ class SkipIfNotInstalledDecorator(object):
+
+ Generates decorator that skips the testcase if database command not found.
+ To create decorator, inherit this class and set ``name`` variable and override ``search_server()`` method.
+
+ Example::
+
+ class PostgresqlSkipIfNotInstalledDecorator(SkipIfNotInstalledDecorator):
+ name = 'PostgreSQL'
+
+ def search_server(self):
+ find_program('postgres', ['bin']) # raise exception if not found
+
+
+ skipIfNotFound = skipIfNotInstalled = PostgresqlSkipIfNotInstalledDecorator()
+
+ @skipIfNotFound
+ def test():
+ # testcase
+
+ def get_unused_port():
+
+ Get free TCP port.
+
+ def get_path_of(name):
+
+ Searchs command from search paths. It works like ``which`` command.
+
+
+ Requirements
+ ============
+ * Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5
+
+ License
+ =======
+ Apache License 2.0
+
+
+ History
+ =======
+
+ 2.0.0 (2016-08-20)
+ -------------------
+ * Use subprocess.Popen() instead of fork & exec
+ * Support windows platform (experimental)
+ * #4: Add boot_timeout parameter
+ * Fix bugs:
+
+ - Fix syntax errors for Python3
+ - Show error messages if rescue from GC failed (ref: #1)
+
+ 1.1.0 (2016-02-05)
+ -------------------
+ * Add Database#server_pid to get pid of the database server
+ * Add Database#is_alive() to check server is alive
+ * Define BOOT_TIMEOUT as constant
+ * Fix AttributeError if any exceptions are raised in bootstrap
+
+ 1.0.0 (2016-02-01)
+ -------------------
+ * Initial release
+
+Platform: UNKNOWN
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Testing
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..7f01967
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,211 @@
+About
+=====
+``testing.common.database`` is utilities for testing.* package.
+
+.. image:: https://travis-ci.org/tk0miya/testing.common.database.svg?branch=master
+ :target: https://travis-ci.org/tk0miya/testing.common.database
+
+.. image:: https://codeclimate.com/github/tk0miya/testing.common.database/badges/gpa.svg
+ :target: https://codeclimate.com/github/tk0miya/testing.common.database
+
+
+Install
+=======
+Use pip::
+
+ $ pip install testing.common.database
+
+
+Helpers
+=======
+class Database(object):
+
+ ``Database`` is a base class for database testing packages.
+ To create your database testing class, inherit this class and override methods below.
+
+ def initialize(self):
+
+ Handler for initialize database object.
+
+ def get_data_directory(self):
+
+ Path to data directory of your databse.
+
+ Example::
+
+ def get_data_directory(self):
+ return os.path.join(self.base_dir, 'data')
+
+ def initialize_database(self):
+
+ Handler to initialize your database.
+
+ Example::
+
+ def initialize_database(self):
+ if not os.path.exists(os.path.join(self.base_dir, 'data', 'PG_VERSION')):
+ args = ([self.initdb, '-D', os.path.join(self.base_dir, 'data'), '--lc-messages=C'] +
+ self.settings['initdb_args'].split())
+
+ try:
+ p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ output, err = p.communicate()
+ if p.returncode != 0:
+ raise RuntimeError("initdb failed: %r" % err)
+ except OSError as exc:
+ raise RuntimeError("failed to spawn initdb: %s" % exc)
+
+ def get_server_commandline(self):
+
+ Command line to invoke your database server.
+
+ Example::
+
+ def get_server_commandline(self):
+ return (['postgres',
+ '-p', str(self.settings['port']),
+ '-D', os.path.join(self.base_dir, 'data'),
+ '-k', os.path.join(self.base_dir, 'tmp')] +
+ self.settings['postgres_args'].split())
+
+ def prestart(self):
+
+ Handler called before invoking your database server.
+
+ def poststart(self):
+
+ Hander called after invoking your database server.
+
+ def is_server_available(self):
+
+ Methods check your database server available.
+ The ``Database`` class uses this method to check the server boots up.
+
+ Example::
+
+ try:
+ with closing(pg8000.connect(**self.dsn(database='template1'))):
+ pass
+ except pg8000.Error:
+ return False
+ else:
+ return True
+
+ def is_alive(self):
+
+ Methods check the database server is alive.
+
+ @property
+ def server_pid(self):
+
+ Process ID of the database server.
+
+
+class DatabaseFactory(object):
+
+ ``DatabaseFactory`` is a factory class for the database class.
+ To create your database factory class, inherit this class and set ``target_class`` variable::
+
+ class PostgresqlFactory(DatabaseFactory):
+ target_class = Postgresql
+
+ The factory class should work like a ``target_class``::
+
+ # The factory class generates like a ``target_class``, in this case, generates ``Postgresql`` class
+ Postgresql = PostgresqlFactory()
+
+ # The generated class works same as ``target_class``
+ with Postgresql() as pgsql:
+ #
+ # do any tests using the database ...
+ #
+
+ It can bypass parameters to the ``target_class`` on every instantiation::
+
+ Postgresql = PostgresqlFactory(copy_data_from='/path/to/database')
+
+ with Postgresql() as pgsql:
+ #
+ # Test with ``copy_data_from`` parameter :-)
+ #
+
+ Also, it is able to cache the database generated at ``Database.initialize_database()``
+ with ``cache_initialized_db`` parameter.
+ It avoids running database initialization on every tests::
+
+ # Initialize database once
+ Postgresql = PostgresqlFactory(cache_initialized_db=True)
+
+ with Postgresql() as pgsql:
+ # copy cached database for this test.
+
+ If you want to fixtures to the database, use ``on_initialized`` parameter::
+
+ def handler(pgsql):
+ # inserting fixtures
+
+ # Initialize database once, and call ``on_initialized`` handler
+ Postgresql = PostgresqlFactory(cache_initialized_db=True,
+ on_initialized=handler)
+
+class SkipIfNotInstalledDecorator(object):
+
+ Generates decorator that skips the testcase if database command not found.
+ To create decorator, inherit this class and set ``name`` variable and override ``search_server()`` method.
+
+ Example::
+
+ class PostgresqlSkipIfNotInstalledDecorator(SkipIfNotInstalledDecorator):
+ name = 'PostgreSQL'
+
+ def search_server(self):
+ find_program('postgres', ['bin']) # raise exception if not found
+
+
+ skipIfNotFound = skipIfNotInstalled = PostgresqlSkipIfNotInstalledDecorator()
+
+ @skipIfNotFound
+ def test():
+ # testcase
+
+def get_unused_port():
+
+ Get free TCP port.
+
+def get_path_of(name):
+
+ Searchs command from search paths. It works like ``which`` command.
+
+
+Requirements
+============
+* Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5
+
+License
+=======
+Apache License 2.0
+
+
+History
+=======
+
+2.0.0 (2016-08-20)
+-------------------
+* Use subprocess.Popen() instead of fork & exec
+* Support windows platform (experimental)
+* #4: Add boot_timeout parameter
+* Fix bugs:
+
+ - Fix syntax errors for Python3
+ - Show error messages if rescue from GC failed (ref: #1)
+
+1.1.0 (2016-02-05)
+-------------------
+* Add Database#server_pid to get pid of the database server
+* Add Database#is_alive() to check server is alive
+* Define BOOT_TIMEOUT as constant
+* Fix AttributeError if any exceptions are raised in bootstrap
+
+1.0.0 (2016-02-01)
+-------------------
+* Initial release
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..fe6c155
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,25 @@
+[egg_info]
+tag_build =
+tag_date = 0
+tag_svn_revision = 0
+
+[build]
+build-base = _build
+
+[sdist]
+formats = gztar
+
+[wheel]
+universal = 1
+
+[aliases]
+release = check -r -s register sdist bdist_wheel upload
+
+[check]
+strict = 1
+restructuredtext = 1
+
+[flake8]
+max-line-length = 120
+ignore = _
+
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..5e8b821
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+import sys
+from setuptools import setup, find_packages
+
+classifiers = [
+ "Development Status :: 4 - Beta",
+ "Intended Audience :: Developers",
+ "License :: OSI Approved :: Apache Software License",
+ "Programming Language :: Python",
+ "Programming Language :: Python :: 2.6",
+ "Programming Language :: Python :: 2.7",
+ "Programming Language :: Python :: 3.2",
+ "Programming Language :: Python :: 3.3",
+ "Programming Language :: Python :: 3.4",
+ "Programming Language :: Python :: 3.5",
+ "Topic :: Database",
+ "Topic :: Software Development",
+ "Topic :: Software Development :: Testing",
+]
+
+install_requires = []
+if sys.version_info < (2, 7):
+ install_requires.append('unittest2')
+
+
+setup(
+ name='testing.common.database',
+ version='2.0.0',
+ description='utilities for testing.* packages',
+ long_description=open('README.rst').read(),
+ classifiers=classifiers,
+ keywords=[],
+ author='Takeshi Komiya',
+ author_email='i.tkomiya at gmail.com',
+ url='https://github.com/tk0miya/testing.common.database',
+ license='Apache License 2.0',
+ packages=find_packages('src'),
+ package_dir={'': 'src'},
+ package_data={'': ['buildout.cfg']},
+ include_package_data=True,
+ install_requires=install_requires,
+ extras_require=dict(
+ testing=[
+ 'nose',
+ ],
+ ),
+ test_suite='nose.collector',
+ namespace_packages=['testing', 'testing.common'],
+)
diff --git a/src/testing.common.database.egg-info/PKG-INFO b/src/testing.common.database.egg-info/PKG-INFO
new file mode 100644
index 0000000..d041a7b
--- /dev/null
+++ b/src/testing.common.database.egg-info/PKG-INFO
@@ -0,0 +1,234 @@
+Metadata-Version: 1.1
+Name: testing.common.database
+Version: 2.0.0
+Summary: utilities for testing.* packages
+Home-page: https://github.com/tk0miya/testing.common.database
+Author: Takeshi Komiya
+Author-email: i.tkomiya at gmail.com
+License: Apache License 2.0
+Description: About
+ =====
+ ``testing.common.database`` is utilities for testing.* package.
+
+ .. image:: https://travis-ci.org/tk0miya/testing.common.database.svg?branch=master
+ :target: https://travis-ci.org/tk0miya/testing.common.database
+
+ .. image:: https://codeclimate.com/github/tk0miya/testing.common.database/badges/gpa.svg
+ :target: https://codeclimate.com/github/tk0miya/testing.common.database
+
+
+ Install
+ =======
+ Use pip::
+
+ $ pip install testing.common.database
+
+
+ Helpers
+ =======
+ class Database(object):
+
+ ``Database`` is a base class for database testing packages.
+ To create your database testing class, inherit this class and override methods below.
+
+ def initialize(self):
+
+ Handler for initialize database object.
+
+ def get_data_directory(self):
+
+ Path to data directory of your databse.
+
+ Example::
+
+ def get_data_directory(self):
+ return os.path.join(self.base_dir, 'data')
+
+ def initialize_database(self):
+
+ Handler to initialize your database.
+
+ Example::
+
+ def initialize_database(self):
+ if not os.path.exists(os.path.join(self.base_dir, 'data', 'PG_VERSION')):
+ args = ([self.initdb, '-D', os.path.join(self.base_dir, 'data'), '--lc-messages=C'] +
+ self.settings['initdb_args'].split())
+
+ try:
+ p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ output, err = p.communicate()
+ if p.returncode != 0:
+ raise RuntimeError("initdb failed: %r" % err)
+ except OSError as exc:
+ raise RuntimeError("failed to spawn initdb: %s" % exc)
+
+ def get_server_commandline(self):
+
+ Command line to invoke your database server.
+
+ Example::
+
+ def get_server_commandline(self):
+ return (['postgres',
+ '-p', str(self.settings['port']),
+ '-D', os.path.join(self.base_dir, 'data'),
+ '-k', os.path.join(self.base_dir, 'tmp')] +
+ self.settings['postgres_args'].split())
+
+ def prestart(self):
+
+ Handler called before invoking your database server.
+
+ def poststart(self):
+
+ Hander called after invoking your database server.
+
+ def is_server_available(self):
+
+ Methods check your database server available.
+ The ``Database`` class uses this method to check the server boots up.
+
+ Example::
+
+ try:
+ with closing(pg8000.connect(**self.dsn(database='template1'))):
+ pass
+ except pg8000.Error:
+ return False
+ else:
+ return True
+
+ def is_alive(self):
+
+ Methods check the database server is alive.
+
+ @property
+ def server_pid(self):
+
+ Process ID of the database server.
+
+
+ class DatabaseFactory(object):
+
+ ``DatabaseFactory`` is a factory class for the database class.
+ To create your database factory class, inherit this class and set ``target_class`` variable::
+
+ class PostgresqlFactory(DatabaseFactory):
+ target_class = Postgresql
+
+ The factory class should work like a ``target_class``::
+
+ # The factory class generates like a ``target_class``, in this case, generates ``Postgresql`` class
+ Postgresql = PostgresqlFactory()
+
+ # The generated class works same as ``target_class``
+ with Postgresql() as pgsql:
+ #
+ # do any tests using the database ...
+ #
+
+ It can bypass parameters to the ``target_class`` on every instantiation::
+
+ Postgresql = PostgresqlFactory(copy_data_from='/path/to/database')
+
+ with Postgresql() as pgsql:
+ #
+ # Test with ``copy_data_from`` parameter :-)
+ #
+
+ Also, it is able to cache the database generated at ``Database.initialize_database()``
+ with ``cache_initialized_db`` parameter.
+ It avoids running database initialization on every tests::
+
+ # Initialize database once
+ Postgresql = PostgresqlFactory(cache_initialized_db=True)
+
+ with Postgresql() as pgsql:
+ # copy cached database for this test.
+
+ If you want to fixtures to the database, use ``on_initialized`` parameter::
+
+ def handler(pgsql):
+ # inserting fixtures
+
+ # Initialize database once, and call ``on_initialized`` handler
+ Postgresql = PostgresqlFactory(cache_initialized_db=True,
+ on_initialized=handler)
+
+ class SkipIfNotInstalledDecorator(object):
+
+ Generates decorator that skips the testcase if database command not found.
+ To create decorator, inherit this class and set ``name`` variable and override ``search_server()`` method.
+
+ Example::
+
+ class PostgresqlSkipIfNotInstalledDecorator(SkipIfNotInstalledDecorator):
+ name = 'PostgreSQL'
+
+ def search_server(self):
+ find_program('postgres', ['bin']) # raise exception if not found
+
+
+ skipIfNotFound = skipIfNotInstalled = PostgresqlSkipIfNotInstalledDecorator()
+
+ @skipIfNotFound
+ def test():
+ # testcase
+
+ def get_unused_port():
+
+ Get free TCP port.
+
+ def get_path_of(name):
+
+ Searchs command from search paths. It works like ``which`` command.
+
+
+ Requirements
+ ============
+ * Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5
+
+ License
+ =======
+ Apache License 2.0
+
+
+ History
+ =======
+
+ 2.0.0 (2016-08-20)
+ -------------------
+ * Use subprocess.Popen() instead of fork & exec
+ * Support windows platform (experimental)
+ * #4: Add boot_timeout parameter
+ * Fix bugs:
+
+ - Fix syntax errors for Python3
+ - Show error messages if rescue from GC failed (ref: #1)
+
+ 1.1.0 (2016-02-05)
... 436 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-testing.common.database.git
More information about the Python-modules-commits
mailing list