testing.mysqld-1.4.0/0000755000076600000240000000000012756013667015317 5ustar tkomiyastaff00000000000000testing.mysqld-1.4.0/LICENSE0000644000076600000240000002613612756011216016320 0ustar tkomiyastaff00000000000000 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. testing.mysqld-1.4.0/MANIFEST.in0000644000076600000240000000012212756011216017034 0ustar tkomiyastaff00000000000000include MANIFEST.in include LICENSE include README.rst recursive-include src *.py testing.mysqld-1.4.0/PKG-INFO0000644000076600000240000001766312756013667016431 0ustar tkomiyastaff00000000000000Metadata-Version: 1.1 Name: testing.mysqld Version: 1.4.0 Summary: automatically setups a mysqld instance in a temporary directory, and destroys it after testing Home-page: https://github.com/tk0miya/testing.mysqld Author: Takeshi Komiya Author-email: i.tkomiya at gmail.com License: Apache License 2.0 Description: ``testing.mysqld`` automatically setups a mysqld instance in a temporary directory, and destroys it after testing .. image:: https://travis-ci.org/tk0miya/testing.mysqld.svg?branch=master :target: https://travis-ci.org/tk0miya/testing.mysqld .. image:: https://coveralls.io/repos/tk0miya/testing.mysqld/badge.png?branch=master :target: https://coveralls.io/r/tk0miya/testing.mysqld?branch=master .. image:: https://codeclimate.com/github/tk0miya/testing.mysqld/badges/gpa.svg :target: https://codeclimate.com/github/tk0miya/testing.mysqld Install ======= Use easy_install (or pip):: $ easy_install testing.mysqld And ``testing.mysqld`` requires MySQL server in your PATH. Usage ===== Create MySQL instance using ``testing.mysqld.Mysqld``:: import testing.mysqld from sqlalchemy import create_engine # Lanuch new MySQL server with testing.mysqld.Mysqld() as mysqld: # connect to MySQL engine = create_engine(mysqld.url()) # if you use mysqldb or other drivers: # import _mysql # db = _mysql.connect(**mysqld.dsn()) # # do any tests using MySQL... # # MySQL server is terminated here ``testing.mysqld.Mysqld`` executes ``mysql_install_db`` and ``mysqld`` on instantiation. On deleting Mysqld object, it terminates MySQL instance and removes temporary directory. If you want a database including tables and any fixtures for your apps, use ``copy_data_from`` keyword:: # uses a copy of specified data directory of MySQL. mysqld = testing.mysqld.Mysqld(copy_data_from='/path/to/your/database') You can specify parameters for MySQL with ``my_cnf`` keyword:: # boot MySQL server without socket listener (use unix-domain socket) mysqld = testing.mysqld.Mysqld(my_cnf={'skip-networking': None}) For example, you can setup new MySQL server for each testcases on setUp() method:: import unittest import testing.mysqld class MyTestCase(unittest.TestCase): def setUp(self): self.mysqld = testing.mysqld.Mysqld(my_cnf={'skip-networking': None}) def tearDown(self): self.mysqld.stop() To make your tests faster ------------------------- ``testing.mysqld.Mysqld`` invokes ``initdb`` command on every instantiation. That is very simple. But, in many cases, it is very waste that generating brandnew database for each testcase. To optimize the behavior, use ``testing.mysqld.MysqldFactory``. The factory class is able to cache the generated database beyond the testcases, and it reduces the number of invocation of ``mysql_install_db`` command:: import unittest import testing.mysqld # Generate Mysqld class which shares the generated database Mysqld = testing.mysqld.MysqldFactory(cache_initialized_db=True) def tearDownModule(self): # clear cached database at end of tests Mysqld.clear_cache() class MyTestCase(unittest.TestCase): def setUp(self): # Use the generated Mysqld class instead of testing.mysqld.Mysqld self.mysqld = Mysqld() def tearDown(self): self.mysqld.stop() If you want to insert fixtures to the cached database, use ``initdb_handler`` option:: # create initial data on create as fixtures into the database def handler(mysqld): conn = psycopg2.connect(**mysqld.dsn()) cursor = conn.cursor() cursor.execute("CREATE TABLE hello(id int, value varchar(256))") cursor.execute("INSERT INTO hello values(1, 'hello'), (2, 'ciao')") cursor.close() conn.commit() conn.close() # Use `handler()` on initialize database Mysqld = testing.mysqld.MysqldFactory(cache_initialized_db=True, on_initialized=handler) Requirements ============ * Python 2.7, 3.3, 3.4, 3.5 * pymysql License ======= Apache License 2.0 History ======= 1.4.0 (2016-08-20) ------------------- * Drop py26, py32 support * Allow ``user`` and ``password`` argument to connect authorized database * Depend on testing.common.database >= 2.0.0 1.3.0 (2016-02-03) ------------------- * Add timeout to server invoker * Support MySQL-5.7 * Add testing.mysqld.MysqldFactory * Depend on ``testing.common.database`` package * Assign port if networking not disabled 1.2.8 (2015-04-06) ------------------- * Fix bugs 1.2.7 (2014-12-20) ------------------- * Support for relative mysql_install_db links * Use absolute path for which command 1.2.6 (2014-06-19) ------------------- * Add timeout on terminating mysqld * Fix bugs 1.2.5 (2014-06-11) ------------------- * Fix ImportError if caught SIGINT on py3 1.2.4 (2014-02-13) ------------------- * Fix testing.mysqld.Mysqld#start() fails if mysql_install_db does not create database named "test" 1.2.3 (2013-12-11) ------------------- * Use pymysql driver as default in Mysqld#url() 1.2.2 (2013-12-06) ------------------- * Change behavior: Mysqld#stop() cleans workdir * Fix caught AttributeError on object deletion 1.2.1 (2013-12-05) ------------------- * Add mysqld.skipIfNotInstalled decorator (alias of skipIfNotFound) * Suport python 2.6 and 3.2 1.2.0 (2013-12-04) ------------------- * Add @skipIfNotFound decorator 1.1.2 (2013-11-26) ------------------- * Fix it does not cleanup temporary directory if Mysqld object has been deleted 1.1.1 (2013-11-25) ------------------- * Add charset parameter to Mysqld#url() 1.1.0 (2013-11-22) ------------------- * Rename package: test.mysqld -> testing.mysqld * Add Mysqld#url() method (for sqlalchemy) 1.0.0 (2013-10-17) ------------------- * First 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 testing.mysqld-1.4.0/README.rst0000644000076600000240000001264212756013654017007 0ustar tkomiyastaff00000000000000``testing.mysqld`` automatically setups a mysqld instance in a temporary directory, and destroys it after testing .. image:: https://travis-ci.org/tk0miya/testing.mysqld.svg?branch=master :target: https://travis-ci.org/tk0miya/testing.mysqld .. image:: https://coveralls.io/repos/tk0miya/testing.mysqld/badge.png?branch=master :target: https://coveralls.io/r/tk0miya/testing.mysqld?branch=master .. image:: https://codeclimate.com/github/tk0miya/testing.mysqld/badges/gpa.svg :target: https://codeclimate.com/github/tk0miya/testing.mysqld Install ======= Use easy_install (or pip):: $ easy_install testing.mysqld And ``testing.mysqld`` requires MySQL server in your PATH. Usage ===== Create MySQL instance using ``testing.mysqld.Mysqld``:: import testing.mysqld from sqlalchemy import create_engine # Lanuch new MySQL server with testing.mysqld.Mysqld() as mysqld: # connect to MySQL engine = create_engine(mysqld.url()) # if you use mysqldb or other drivers: # import _mysql # db = _mysql.connect(**mysqld.dsn()) # # do any tests using MySQL... # # MySQL server is terminated here ``testing.mysqld.Mysqld`` executes ``mysql_install_db`` and ``mysqld`` on instantiation. On deleting Mysqld object, it terminates MySQL instance and removes temporary directory. If you want a database including tables and any fixtures for your apps, use ``copy_data_from`` keyword:: # uses a copy of specified data directory of MySQL. mysqld = testing.mysqld.Mysqld(copy_data_from='/path/to/your/database') You can specify parameters for MySQL with ``my_cnf`` keyword:: # boot MySQL server without socket listener (use unix-domain socket) mysqld = testing.mysqld.Mysqld(my_cnf={'skip-networking': None}) For example, you can setup new MySQL server for each testcases on setUp() method:: import unittest import testing.mysqld class MyTestCase(unittest.TestCase): def setUp(self): self.mysqld = testing.mysqld.Mysqld(my_cnf={'skip-networking': None}) def tearDown(self): self.mysqld.stop() To make your tests faster ------------------------- ``testing.mysqld.Mysqld`` invokes ``initdb`` command on every instantiation. That is very simple. But, in many cases, it is very waste that generating brandnew database for each testcase. To optimize the behavior, use ``testing.mysqld.MysqldFactory``. The factory class is able to cache the generated database beyond the testcases, and it reduces the number of invocation of ``mysql_install_db`` command:: import unittest import testing.mysqld # Generate Mysqld class which shares the generated database Mysqld = testing.mysqld.MysqldFactory(cache_initialized_db=True) def tearDownModule(self): # clear cached database at end of tests Mysqld.clear_cache() class MyTestCase(unittest.TestCase): def setUp(self): # Use the generated Mysqld class instead of testing.mysqld.Mysqld self.mysqld = Mysqld() def tearDown(self): self.mysqld.stop() If you want to insert fixtures to the cached database, use ``initdb_handler`` option:: # create initial data on create as fixtures into the database def handler(mysqld): conn = psycopg2.connect(**mysqld.dsn()) cursor = conn.cursor() cursor.execute("CREATE TABLE hello(id int, value varchar(256))") cursor.execute("INSERT INTO hello values(1, 'hello'), (2, 'ciao')") cursor.close() conn.commit() conn.close() # Use `handler()` on initialize database Mysqld = testing.mysqld.MysqldFactory(cache_initialized_db=True, on_initialized=handler) Requirements ============ * Python 2.7, 3.3, 3.4, 3.5 * pymysql License ======= Apache License 2.0 History ======= 1.4.0 (2016-08-20) ------------------- * Drop py26, py32 support * Allow ``user`` and ``password`` argument to connect authorized database * Depend on testing.common.database >= 2.0.0 1.3.0 (2016-02-03) ------------------- * Add timeout to server invoker * Support MySQL-5.7 * Add testing.mysqld.MysqldFactory * Depend on ``testing.common.database`` package * Assign port if networking not disabled 1.2.8 (2015-04-06) ------------------- * Fix bugs 1.2.7 (2014-12-20) ------------------- * Support for relative mysql_install_db links * Use absolute path for which command 1.2.6 (2014-06-19) ------------------- * Add timeout on terminating mysqld * Fix bugs 1.2.5 (2014-06-11) ------------------- * Fix ImportError if caught SIGINT on py3 1.2.4 (2014-02-13) ------------------- * Fix testing.mysqld.Mysqld#start() fails if mysql_install_db does not create database named "test" 1.2.3 (2013-12-11) ------------------- * Use pymysql driver as default in Mysqld#url() 1.2.2 (2013-12-06) ------------------- * Change behavior: Mysqld#stop() cleans workdir * Fix caught AttributeError on object deletion 1.2.1 (2013-12-05) ------------------- * Add mysqld.skipIfNotInstalled decorator (alias of skipIfNotFound) * Suport python 2.6 and 3.2 1.2.0 (2013-12-04) ------------------- * Add @skipIfNotFound decorator 1.1.2 (2013-11-26) ------------------- * Fix it does not cleanup temporary directory if Mysqld object has been deleted 1.1.1 (2013-11-25) ------------------- * Add charset parameter to Mysqld#url() 1.1.0 (2013-11-22) ------------------- * Rename package: test.mysqld -> testing.mysqld * Add Mysqld#url() method (for sqlalchemy) 1.0.0 (2013-10-17) ------------------- * First release testing.mysqld-1.4.0/setup.cfg0000644000076600000240000000043712756013667017144 0ustar tkomiyastaff00000000000000[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 = _ testing.mysqld-1.4.0/setup.py0000644000076600000240000000300312756013654017021 0ustar tkomiyastaff00000000000000# -*- 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 = ['testing.common.database >= 1.1.0', 'pymysql'] if sys.version_info < (2, 7): install_requires.append('unittest2') setup( name='testing.mysqld', version='1.4.0', description='automatically setups a mysqld instance in a temporary directory, and destroys it after testing', 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.mysqld', 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={ 'testing': ['mock', 'nose', 'SQLAlchemy'], }, test_suite='nose.collector', namespace_packages=['testing'], ) testing.mysqld-1.4.0/src/0000755000076600000240000000000012756013667016106 5ustar tkomiyastaff00000000000000testing.mysqld-1.4.0/src/testing/0000755000076600000240000000000012756013667017563 5ustar tkomiyastaff00000000000000testing.mysqld-1.4.0/src/testing/__init__.py0000644000076600000240000000123512756011216021661 0ustar tkomiyastaff00000000000000# -*- coding: utf-8 -*- # Copyright 2013 Takeshi KOMIYA # # 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. __import__('pkg_resources').declare_namespace(__name__) testing.mysqld-1.4.0/src/testing/mysqld.py0000644000076600000240000001532212756011216021435 0ustar tkomiyastaff00000000000000# -*- coding: utf-8 -*- # Copyright 2013 Takeshi KOMIYA # # 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. import os import re import pymysql import subprocess from contextlib import closing from testing.common.database import ( Database, DatabaseFactory, SkipIfNotInstalledDecorator, get_path_of, get_unused_port ) __all__ = ['Mysqld', 'skipIfNotFound'] SEARCH_PATHS = ['/usr/local/mysql'] class Mysqld(Database): DEFAULT_SETTINGS = dict(auto_start=2, base_dir=None, mysql_install_db=None, mysqld=None, pid=None, port=None, copy_data_from=None, user="root", passwd=None) subdirectories = ['etc', 'var', 'tmp'] def initialize(self): self.my_cnf = self.settings.get('my_cnf', {}) self.my_cnf.setdefault('socket', os.path.join(self.base_dir, 'tmp', 'mysql.sock')) self.my_cnf.setdefault('datadir', os.path.join(self.base_dir, 'var')) self.my_cnf.setdefault('pid-file', os.path.join(self.base_dir, 'tmp', 'mysqld.pid')) self.my_cnf.setdefault('tmpdir', os.path.join(self.base_dir, 'tmp')) self.mysql_install_db = self.settings.get('mysql_install_db') if self.mysql_install_db is None: self.mysql_install_db = find_program('mysql_install_db', ['bin', 'scripts']) self.mysqld = self.settings.get('mysqld') if self.mysqld is None: self.mysqld = find_program('mysqld', ['bin', 'libexec', 'sbin']) def dsn(self, **kwargs): params = dict(kwargs) if 'port' in self.my_cnf: params.setdefault('port', self.my_cnf['port']) if 'port' in params: if 'bind-address' in self.my_cnf: params.setdefault('host', self.my_cnf['bind-address']) else: params.setdefault('host', '127.0.0.1') else: params.setdefault('unix_socket', self.my_cnf['socket']) params.setdefault('user', self.settings.get('user')) passwd = self.settings.get('passwd') if passwd: params.setdefault('passwd', passwd) params.setdefault('db', 'test') return params def url(self, **kwargs): params = self.dsn(**kwargs) driver = params.get('driver', 'pymysql') if 'port' in params: url = ('mysql+%s://%s@%s:%d/%s' % (driver, params['user'], params['host'], params['port'], params['db'])) if 'charset' in params: url += "?charset=%s" % params['charset'] else: url = ('mysql+%s://%s@localhost/%s?unix_socket=%s' % (driver, params['user'], params['db'], params['unix_socket'])) if 'charset' in params: url += "&charset=%s" % params['charset'] return url def get_data_directory(self): return self.my_cnf['datadir'] def initialize_database(self): # assign port if networking not disabled if 'port' not in self.my_cnf and 'skip-networking' not in self.my_cnf: self.my_cnf['port'] = get_unused_port() # my.cnf with open(os.path.join(self.base_dir, 'etc', 'my.cnf'), 'wt') as my_cnf: my_cnf.write("[mysqld]\n") for key, value in self.my_cnf.items(): if value: my_cnf.write("%s=%s\n" % (key, value)) else: my_cnf.write("%s\n" % key) # initialize databse if not os.path.exists(os.path.join(self.base_dir, 'var', 'mysql')): args = ["--defaults-file=%s/etc/my.cnf" % self.base_dir, "--datadir=%s" % self.my_cnf['datadir']] mysql_base_dir = self.mysql_install_db if os.path.islink(mysql_base_dir): link = os.readlink(mysql_base_dir) mysql_base_dir = os.path.join(os.path.dirname(mysql_base_dir), link) mysql_base_dir = os.path.normpath(mysql_base_dir) if re.search('[^/]+/mysql_install_db$', mysql_base_dir): args.append("--basedir=%s" % re.sub('[^/]+/mysql_install_db$', '', mysql_base_dir)) try: mysqld_args = [self.mysqld] + args + ["--initialize-insecure"] mysqld = subprocess.Popen(mysqld_args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT) mysqld.communicate() if mysqld.returncode: # MySQL < 5.7 install_db_args = [self.mysql_install_db] + args subprocess.Popen(install_db_args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT).communicate() except Exception as exc: raise RuntimeError("failed to spawn mysql_install_db: %r" % exc) def get_server_commandline(self): return [self.mysqld, '--defaults-file=%s/etc/my.cnf' % self.base_dir, '--user=root'] def is_server_available(self): return os.path.exists(self.my_cnf['pid-file']) def poststart(self): # create test database params = self.dsn() del params['db'] with closing(pymysql.connect(**params)) as conn: conn.query('CREATE DATABASE IF NOT EXISTS test') class MysqldFactory(DatabaseFactory): target_class = Mysqld class MysqldSkipIfNotInstalledDecorator(SkipIfNotInstalledDecorator): name = 'mysqld' def search_server(self): find_program('mysqld', ['bin', 'libexec', 'sbin']) skipIfNotFound = skipIfNotInstalled = MysqldSkipIfNotInstalledDecorator() def find_program(name, subdirs): path = get_path_of(name) if path: return path mysql_paths = [os.path.join(dir, 'bin', 'mysql') for dir in SEARCH_PATHS] + \ [get_path_of('mysql')] for mysql_path in mysql_paths: if mysql_path and os.path.exists(mysql_path): for subdir in subdirs: replace = '/%s/%s' % (subdir, name) path = re.sub('/bin/mysql$', replace, mysql_path) if os.path.exists(path): return path raise RuntimeError("command not found: %s" % name) testing.mysqld-1.4.0/src/testing.mysqld.egg-info/0000755000076600000240000000000012756013667022565 5ustar tkomiyastaff00000000000000testing.mysqld-1.4.0/src/testing.mysqld.egg-info/dependency_links.txt0000644000076600000240000000000112756013662026626 0ustar tkomiyastaff00000000000000 testing.mysqld-1.4.0/src/testing.mysqld.egg-info/namespace_packages.txt0000644000076600000240000000001012756013662027102 0ustar tkomiyastaff00000000000000testing testing.mysqld-1.4.0/src/testing.mysqld.egg-info/PKG-INFO0000644000076600000240000001766312756013662023672 0ustar tkomiyastaff00000000000000Metadata-Version: 1.1 Name: testing.mysqld Version: 1.4.0 Summary: automatically setups a mysqld instance in a temporary directory, and destroys it after testing Home-page: https://github.com/tk0miya/testing.mysqld Author: Takeshi Komiya Author-email: i.tkomiya at gmail.com License: Apache License 2.0 Description: ``testing.mysqld`` automatically setups a mysqld instance in a temporary directory, and destroys it after testing .. image:: https://travis-ci.org/tk0miya/testing.mysqld.svg?branch=master :target: https://travis-ci.org/tk0miya/testing.mysqld .. image:: https://coveralls.io/repos/tk0miya/testing.mysqld/badge.png?branch=master :target: https://coveralls.io/r/tk0miya/testing.mysqld?branch=master .. image:: https://codeclimate.com/github/tk0miya/testing.mysqld/badges/gpa.svg :target: https://codeclimate.com/github/tk0miya/testing.mysqld Install ======= Use easy_install (or pip):: $ easy_install testing.mysqld And ``testing.mysqld`` requires MySQL server in your PATH. Usage ===== Create MySQL instance using ``testing.mysqld.Mysqld``:: import testing.mysqld from sqlalchemy import create_engine # Lanuch new MySQL server with testing.mysqld.Mysqld() as mysqld: # connect to MySQL engine = create_engine(mysqld.url()) # if you use mysqldb or other drivers: # import _mysql # db = _mysql.connect(**mysqld.dsn()) # # do any tests using MySQL... # # MySQL server is terminated here ``testing.mysqld.Mysqld`` executes ``mysql_install_db`` and ``mysqld`` on instantiation. On deleting Mysqld object, it terminates MySQL instance and removes temporary directory. If you want a database including tables and any fixtures for your apps, use ``copy_data_from`` keyword:: # uses a copy of specified data directory of MySQL. mysqld = testing.mysqld.Mysqld(copy_data_from='/path/to/your/database') You can specify parameters for MySQL with ``my_cnf`` keyword:: # boot MySQL server without socket listener (use unix-domain socket) mysqld = testing.mysqld.Mysqld(my_cnf={'skip-networking': None}) For example, you can setup new MySQL server for each testcases on setUp() method:: import unittest import testing.mysqld class MyTestCase(unittest.TestCase): def setUp(self): self.mysqld = testing.mysqld.Mysqld(my_cnf={'skip-networking': None}) def tearDown(self): self.mysqld.stop() To make your tests faster ------------------------- ``testing.mysqld.Mysqld`` invokes ``initdb`` command on every instantiation. That is very simple. But, in many cases, it is very waste that generating brandnew database for each testcase. To optimize the behavior, use ``testing.mysqld.MysqldFactory``. The factory class is able to cache the generated database beyond the testcases, and it reduces the number of invocation of ``mysql_install_db`` command:: import unittest import testing.mysqld # Generate Mysqld class which shares the generated database Mysqld = testing.mysqld.MysqldFactory(cache_initialized_db=True) def tearDownModule(self): # clear cached database at end of tests Mysqld.clear_cache() class MyTestCase(unittest.TestCase): def setUp(self): # Use the generated Mysqld class instead of testing.mysqld.Mysqld self.mysqld = Mysqld() def tearDown(self): self.mysqld.stop() If you want to insert fixtures to the cached database, use ``initdb_handler`` option:: # create initial data on create as fixtures into the database def handler(mysqld): conn = psycopg2.connect(**mysqld.dsn()) cursor = conn.cursor() cursor.execute("CREATE TABLE hello(id int, value varchar(256))") cursor.execute("INSERT INTO hello values(1, 'hello'), (2, 'ciao')") cursor.close() conn.commit() conn.close() # Use `handler()` on initialize database Mysqld = testing.mysqld.MysqldFactory(cache_initialized_db=True, on_initialized=handler) Requirements ============ * Python 2.7, 3.3, 3.4, 3.5 * pymysql License ======= Apache License 2.0 History ======= 1.4.0 (2016-08-20) ------------------- * Drop py26, py32 support * Allow ``user`` and ``password`` argument to connect authorized database * Depend on testing.common.database >= 2.0.0 1.3.0 (2016-02-03) ------------------- * Add timeout to server invoker * Support MySQL-5.7 * Add testing.mysqld.MysqldFactory * Depend on ``testing.common.database`` package * Assign port if networking not disabled 1.2.8 (2015-04-06) ------------------- * Fix bugs 1.2.7 (2014-12-20) ------------------- * Support for relative mysql_install_db links * Use absolute path for which command 1.2.6 (2014-06-19) ------------------- * Add timeout on terminating mysqld * Fix bugs 1.2.5 (2014-06-11) ------------------- * Fix ImportError if caught SIGINT on py3 1.2.4 (2014-02-13) ------------------- * Fix testing.mysqld.Mysqld#start() fails if mysql_install_db does not create database named "test" 1.2.3 (2013-12-11) ------------------- * Use pymysql driver as default in Mysqld#url() 1.2.2 (2013-12-06) ------------------- * Change behavior: Mysqld#stop() cleans workdir * Fix caught AttributeError on object deletion 1.2.1 (2013-12-05) ------------------- * Add mysqld.skipIfNotInstalled decorator (alias of skipIfNotFound) * Suport python 2.6 and 3.2 1.2.0 (2013-12-04) ------------------- * Add @skipIfNotFound decorator 1.1.2 (2013-11-26) ------------------- * Fix it does not cleanup temporary directory if Mysqld object has been deleted 1.1.1 (2013-11-25) ------------------- * Add charset parameter to Mysqld#url() 1.1.0 (2013-11-22) ------------------- * Rename package: test.mysqld -> testing.mysqld * Add Mysqld#url() method (for sqlalchemy) 1.0.0 (2013-10-17) ------------------- * First 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 testing.mysqld-1.4.0/src/testing.mysqld.egg-info/requires.txt0000644000076600000240000000011112756013662025151 0ustar tkomiyastaff00000000000000testing.common.database >= 1.1.0 pymysql [testing] mock nose SQLAlchemy testing.mysqld-1.4.0/src/testing.mysqld.egg-info/SOURCES.txt0000644000076600000240000000054312756013662024446 0ustar tkomiyastaff00000000000000LICENSE MANIFEST.in README.rst setup.cfg setup.py src/testing/__init__.py src/testing/mysqld.py src/testing.mysqld.egg-info/PKG-INFO src/testing.mysqld.egg-info/SOURCES.txt src/testing.mysqld.egg-info/dependency_links.txt src/testing.mysqld.egg-info/namespace_packages.txt src/testing.mysqld.egg-info/requires.txt src/testing.mysqld.egg-info/top_level.txttesting.mysqld-1.4.0/src/testing.mysqld.egg-info/top_level.txt0000644000076600000240000000001012756013662025301 0ustar tkomiyastaff00000000000000testing