commit 0142b699bf2ba122a081d0f6886e3edc534d2aa9 Author: Daniel Mellado Date: Thu May 25 12:56:52 2017 +0200 Initial Commit Initial commit based on cookiecutter for the kuryr tempest plugin. diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..074a0683 --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +*.egg-info +*.egg[s] +*.log +*.py[co] +.coverage +.testrepository +.tox +.venv +AUTHORS +ChangeLog +build +cover +develop-eggs +dist +doc/build +doc/html +eggs +sdist +target +doc/source/sample.config + +# Files created by releasenotes build +releasenotes/build diff --git a/.gitreview b/.gitreview new file mode 100644 index 00000000..aa9770ab --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.gerrithub.io +port=29418 +project=danielmellado/kuryr-tempest-plugin.git diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..0036017f --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,20 @@ +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 + +You can find more Kuryr-Kubernetes specific info in our guide: + + https://docs.openstack.org/developer/kuryr-kubernetes/index.html + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + 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/kuryr-tempest-plugin diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 00000000..a70bb32c --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,50 @@ +Kuryr Tempest Plugin Style Commandments +======================================= + +- Step 1: Read the OpenStack Style Commandments + http://docs.openstack.org/developer/hacking/ +- Step 2: Read on + +Commit Messages +--------------- +Using a common format for commit messages will help keep our git history +readable. Follow these guidelines: + +- [S365] First, provide a brief summary of 50 characters or less. Summaries + of greater then 72 characters will be rejected by the gate. + +- [S364] The first line of the commit message should provide an accurate + description of the change, not just a reference to a bug or blueprint. + +Imports +------- +- [S366, S367] Organize your imports according to the ``Import order`` + +Dictionaries/Lists +------------------ + +- [S360] Ensure default arguments are not mutable. +- [S368] Must use a dict comprehension instead of a dict constructor with a + sequence of key-value pairs. For more information, please refer to + http://legacy.python.org/dev/peps/pep-0274/ +======= +Logs +---- + +- [S369] Check LOG.info translations + +- [S370] Check LOG.error translations + +- [S371] Check LOG.warning translations + +- [S372] Check LOG.critical translation + +- [S373] LOG.debug never used for translations + +- [S374] You used a deprecated log level + +Importing json +-------------- + +- [S375] It's more preferable to use ``jsonutils`` from ``oslo_serialization`` + instead of ``json`` for operating with ``json`` objects. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..67db8588 --- /dev/null +++ b/LICENSE @@ -0,0 +1,175 @@ + + 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/README.rst b/README.rst new file mode 100644 index 00000000..a1d1173e --- /dev/null +++ b/README.rst @@ -0,0 +1,7 @@ +============================ +Tempest Integration of Kuryr +============================ + +This project defines a tempest plugin containing tests used to verify the +functionality of a kuryr installation. The plugin will automatically load +these tests into tempest. diff --git a/kuryr_tempest_plugin/README.rst b/kuryr_tempest_plugin/README.rst new file mode 100644 index 00000000..3e80894d --- /dev/null +++ b/kuryr_tempest_plugin/README.rst @@ -0,0 +1,6 @@ +=============================================== +Tempest Integration of kuryr-tempest-plugin +=============================================== + +This directory contains Tempest tests to cover the kuryr-tempest-plugin project. + diff --git a/kuryr_tempest_plugin/__init__.py b/kuryr_tempest_plugin/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/kuryr_tempest_plugin/config.py b/kuryr_tempest_plugin/config.py new file mode 100644 index 00000000..013ba470 --- /dev/null +++ b/kuryr_tempest_plugin/config.py @@ -0,0 +1,21 @@ +# Copyright 2015 +# 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. + +from oslo_config import cfg + +service_option = cfg.BoolOpt("kuryr", + default=True, + help="Whether or not kuryr is expected to be " + "available") diff --git a/kuryr_tempest_plugin/plugin.py b/kuryr_tempest_plugin/plugin.py new file mode 100644 index 00000000..e17d58ad --- /dev/null +++ b/kuryr_tempest_plugin/plugin.py @@ -0,0 +1,37 @@ +# Copyright 2015 +# 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. + + +import os + +from tempest.test_discover import plugins + +from kuryr_tempest_plugin import config as project_config + + +class KuryrTempestPlugin(plugins.TempestPlugin): + def load_tests(self): + base_path = os.path.split(os.path.dirname( + os.path.abspath(__file__)))[0] + test_dir = "kuryr_tempest_plugin/tests" + full_test_dir = os.path.join(base_path, test_dir) + return full_test_dir, base_path + + def register_opts(self, conf): + conf.register_opt(project_config.service_option, + group='service_available') + + def get_opt_lists(self): + return [('service_available', [project_config.__service_option])] diff --git a/kuryr_tempest_plugin/services/__init__.py b/kuryr_tempest_plugin/services/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/kuryr_tempest_plugin/tests/__init__.py b/kuryr_tempest_plugin/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..adff9a5d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,12 @@ +# 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. + +pbr>=1.6 # Apache-2.0 + +oslotest>=1.10.0 # Apache-2.0 +os-testr>=0.4.1 # Apache-2.0 +six>=1.9.0 # MIT +tempest>=12.2.0 # Apache-2.0 +testrepository>=0.0.18 # Apache-2.0/BSD +testtools>=1.4.0 # MIT diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..f95b4519 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,30 @@ +[metadata] +name = kuryr-tempest-plugin +summary = Kuryr Tempest Plugin +description-file = README.rst +license = Apache Software License +classifiers = + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = http://docs.openstack.org/developer/kuryr-tempest-plugin/ + +[files] +packages = + kuryr_tempest_plugin + +[entry_points] +tempest.test_plugins = + kuryr_tempest_tests = kuryr_tempest_plugin.plugin:KuryrTempestPlugin + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..782bb21f --- /dev/null +++ b/setup.py @@ -0,0 +1,29 @@ +# 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 +# +# 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. + +# 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( + setup_requires=['pbr>=1.8'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..6ac6155d --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,14 @@ +# 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. + +hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 + +bashate>=0.2 # Apache-2.0 +coverage>=3.6 # Apache-2.0 +doc8 # Apache-2.0 +mock>=1.2 # BSD +oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 +pylint==1.4.5 # GNU GPL v2 +reno>=1.6.2 # Apache2 +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..04e15347 --- /dev/null +++ b/tox.ini @@ -0,0 +1,47 @@ +[tox] +envlist = py35,py27,pep8,releasenotes +minversion = 1.6 +skipsdist = True + +[testenv] +usedevelop = True +install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +commands = ostestr {posargs} +passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY OS_* + +[testenv:venv] +commands = {posargs} +passenv = OS_* + +[testenv:docs] +commands = + rm -rf doc/html doc/build + rm -rf doc/source/apidoc doc/source/api + python setup.py build_sphinx +whitelist_externals = + rm + +[testenv:pep8] +commands = + flake8 {posargs} + doc8 doc/source + # Run bashate checks + # E011 is intentionally ignored because it does not make sense; it is + # perfectly reasonable to put 'then' on a separate line when natural + # line breaks occur in long conditionals. + bash -c "find tools -iname '*.sh' -print0 | xargs -0 bashate -v --ignore E011" +whitelist_externals = bash + +[testenv:releasenotes] +commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + +[flake8] +show-source = true +builtins = _ +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools +select = E