From 9300fdbbaaa0363854b3c018f0a598ac138b458b Mon Sep 17 00:00:00 2001 From: Roman Prykhodchenko Date: Wed, 17 Feb 2016 18:24:48 +0100 Subject: [PATCH] Synchronize with global requirements This patch allignes both versions and order of packages in requirements.txt and test-requirements.txt with master revision of OpenStack's global requirements in Mitaka release cycle. In order to perform the soft sync all settings from setup.py were moved to setup.cfg and setup.py was autogenerated using cookiecutter and the default project template for OpenStack projects. Partial-bug: #1469045 Change-Id: I9d99517b9016f61904ab5e25d8ffb39cfb0c1119 --- CONTRIBUTING.rst | 17 ++++ HACKING.rst | 4 + LICENSE | 176 ++++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 6 ++ README.rst | 30 +++++++ requirements.txt | 10 ++- run_tests.sh | 20 ----- setup.cfg | 37 +++++++++ setup.py | 55 +++++-------- shotgun/hooks.py | 21 +++++ test-requirements.txt | 10 ++- tox.ini | 3 +- 12 files changed, 330 insertions(+), 59 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 HACKING.rst create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.rst delete mode 100755 run_tests.sh create mode 100644 setup.cfg create mode 100644 shotgun/hooks.py diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..ffaff10 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,17 @@ +If you would like to contribute to the development of OpenStack, you must +follow the steps in this page: + + http://docs.openstack.org/infra/manual/developers.html + +If you already have a good understanding of how the system works and your +OpenStack accounts are set up, you can skip to the development workflow +section of this documentation to learn how changes to OpenStack should be +submitted for review via the Gerrit tool: + + http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/shotgun diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..3ee825e --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,4 @@ +shotgun Style Commandments +=============================================== + +Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + 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. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..c978a52 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,6 @@ +include AUTHORS +include ChangeLog +exclude .gitignore +exclude .gitreview + +global-exclude *.pyc diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..89a9f33 --- /dev/null +++ b/README.rst @@ -0,0 +1,30 @@ +=============================== +shotgun +=============================== + +Shotgun is diagnostic snapshot generator +for `Fuel `_. + + +----------------- +Project resources +----------------- + +Project status, bugs, and blueprints are tracked on Launchpad: + https://launchpad.net/fuel + +Development documentation is hosted here: + https://docs.fuel-infra.org/fuel-dev + +User guide can be found here: + http://docs.mirantis.com + +Any additional information can be found on the Fuel's project wiki + https://wiki.openstack.org/wiki/Fuel + +Anyone wishing to contribute to shotgun should follow the general +OpenStack process. A good reference for it can be found here: + https://wiki.openstack.org/wiki/How_To_Contribute + + http://docs.openstack.org/infra/manual/developers.html + diff --git a/requirements.txt b/requirements.txt index dbce8e9..21178f6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,9 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +six>=1.9.0 # MIT +cliff!=1.16.0,>=1.15.0 # Apache-2.0 + +# Packages beyond this line are not in Global Requirements list +# and must be added there. Fabric>=1.7.0 -six>=1.9.0 -cliff>=1.7.0 diff --git a/run_tests.sh b/run_tests.sh deleted file mode 100755 index e83b2d6..0000000 --- a/run_tests.sh +++ /dev/null @@ -1,20 +0,0 @@ -#!/bin/bash - -# Copyright 2015 Mirantis, Inc. -# -# 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. - -set -e -set -x - -tox -v diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..157d6e5 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,37 @@ +[metadata] +name = shotgun +version = 9.0.0 +description-file = README.rst +description = Shotgun is diagnostic snapshot generator for Fuel +author = Mirantis Inc. +author_email = product@mirantis.com +home-page = http://mirantis.com +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + +[files] +packages = shotgun + +[entry_points] +console_scripts = + shotgun=shotgun.cli:main + shotgun2=shotgun.cli2:main + +shotgun = + snapshot=shotgun.cli2:SnapshotCommand + report=shotgun.cli2:ReportCommand + +[global] +setup-hooks = + pbr.hooks.setup_hook + shotgun.hooks.setup_hook + +[wheel] +python-tag = py2 diff --git a/setup.py b/setup.py index 8ed1f1f..782bb21 100644 --- a/setup.py +++ b/setup.py @@ -1,42 +1,29 @@ -# Copyright 2013 Mirantis, Inc. +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. # -# 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 +# 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 +# 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. +# 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. +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT import setuptools +# In python < 2.7.4, a lazy loading of package `pbr` will break +# setuptools if some other modules registered functions in `atexit`. +# solution from: http://bugs.python.org/issue15881#msg170215 +try: + import multiprocessing # noqa +except ImportError: + pass setuptools.setup( - name='shotgun', - version='9.0.0', - description='Shotgun package', - long_description='Shotgun is diagnostic snapshot generator', - classifiers=[ - 'Development Status :: 4 - Beta', - 'Programming Language :: Python'], - author='Mirantis Inc.', - author_email='product@mirantis.com', - url='http://mirantis.com', - keywords='shotgun mirantis', - packages=setuptools.find_packages(), - zip_safe=False, - install_requires=[ - 'Fabric >= 1.10.0'], - entry_points={ - 'console_scripts': [ - 'shotgun = shotgun.cli:main', - 'shotgun2 = shotgun.cli2:main'], - 'shotgun': [ - 'snapshot = shotgun.cli2:SnapshotCommand', - 'report = shotgun.cli2:ReportCommand' - ] - }) + setup_requires=['pbr>=1.8'], + pbr=True) diff --git a/shotgun/hooks.py b/shotgun/hooks.py new file mode 100644 index 0000000..5b16a78 --- /dev/null +++ b/shotgun/hooks.py @@ -0,0 +1,21 @@ +# Copyright 2015 Mirantis, Inc. +# +# 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. + + +def setup_hook(config): + import pbr + import pbr.packaging + + # this monkey patch is to avoid appending git version to version + pbr.packaging._get_version_from_git = lambda pre_version: pre_version diff --git a/test-requirements.txt b/test-requirements.txt index 77b5549..a472f53 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,4 +1,10 @@ -mock==1.3.0 -unittest2==1.1.0 +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +mock>=1.2 # BSD +unittest2 # BSD + +# Packages beyond this line are not in Global Requirements list +# and must be added there. pytest==2.8.0 pytest-cov==2.1.0 diff --git a/tox.ini b/tox.ini index ec76662..4d3269b 100644 --- a/tox.ini +++ b/tox.ini @@ -7,7 +7,8 @@ envlist = py27,pep8 usedevelop = True install_command = pip install --allow-external -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} -deps = -r{toxinidir}/test-requirements.txt +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt commands = py.test -vv {posargs:shotgun/test}