commit 5c2886a5ceec4131f9e17abbe40e6462df89f85e Author: Dougal Matthews Date: Thu Oct 26 16:39:23 2017 +0100 Create initial project layout diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..d5d45a9 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,6 @@ +[run] +branch = True +source = tripleo_common_tempest_plugin + +[report] +ignore_errors = True diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e29f426 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +__pycache__ +.testrepository +.tox +*.egg-info +.stestr diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..698048f --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/openstack.git diff --git a/.testr.conf b/.testr.conf new file mode 100644 index 0000000..6d83b3c --- /dev/null +++ b/.testr.conf @@ -0,0 +1,7 @@ +[DEFAULT] +test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ + OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ + OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ + ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION +test_id_option=--load-list $IDFILE +test_list_option=--list diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..9a8d56d --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,16 @@ +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 + +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/tripleo-common diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..54188d0 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,4 @@ +tripleo-common Style Commandments +================================= + +Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ 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/README.rst b/README.rst new file mode 100644 index 0000000..1e6bd6e --- /dev/null +++ b/README.rst @@ -0,0 +1,85 @@ +======================== +Team and repository tags +======================== + +.. image:: http://governance.openstack.org/badges/tripleo-common.svg + :target: http://governance.openstack.org/reference/tags/index.html + +.. Change things from this point on + +============== +tripleo-common +============== + +A common library for TripleO workflows. + +* Free software: Apache license +* Documentation: https://docs.openstack.org/tripleo-common/latest/ +* Source: http://git.openstack.org/cgit/openstack/tripleo-common +* Bugs: http://bugs.launchpad.net/tripleo-common + +Action Development +------------------ + + +When developing new actions, you will checkout a copy of tripleo-common to an +undercloud machine and add actions as needed. To test the actions they need +to be installed and selected services need to be restarted. Use the following +code to accomplish these tasks. :: + + + sudo rm -Rf /usr/lib/python2.7/site-packages/tripleo_common* + sudo python setup.py install + sudo cp /usr/share/tripleo-common/sudoers /etc/sudoers.d/tripleo-common + sudo systemctl restart openstack-mistral-executor + sudo systemctl restart openstack-mistral-engine + # this loads the actions via entrypoints + sudo mistral-db-manage populate + # make sure the new actions got loaded + mistral action-list | grep tripleo + +Validations +----------- + +Prerequisites +~~~~~~~~~~~~~ + +If you haven't installed the undercloud with the ``enable_validations`` set to +true, you will have to prepare your undercloud to run the validations:: + + $ sudo pip install git+https://git.openstack.org/openstack/tripleo-validations + $ sudo yum install ansible + $ sudo useradd validations + +Finally you need to generate an SSH keypair for the validation user and copy +it to the overcloud's authorized_keys files:: + + $ mistral execution-create tripleo.validations.v1.copy_ssh_key + +Running validations using the mistral workflow +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Create a context.json file containing the arguments passed to the workflow:: + + { + "validation_names": ["512e", "rabbitmq-limits"] + } + +Run the ``tripleo.validations.v1.run_validations`` workflow with mistral +client:: + + mistral execution-create tripleo.validations.v1.run_validations context.json + + +Running groups of validations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Create a context.json file containing the arguments passed to the workflow:: + + { + "group_names": ["network", "post-deployment"] + } + +Run the ``tripleo.validations.v1.run_groups`` workflow with mistral client:: + + mistral execution-create tripleo.validations.v1.run_groups context.json diff --git a/babel.cfg b/babel.cfg new file mode 100644 index 0000000..efceab8 --- /dev/null +++ b/babel.cfg @@ -0,0 +1 @@ +[python: **.py] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..feea97d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,13 @@ +# 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!=2.1.0,>=2.0.0 # Apache-2.0 +Babel!=2.4.0,>=2.3.4 # BSD +openstacksdk>=0.9.18 # Apache-2.0 +oslo.config!=4.3.0,!=4.4.0,>=4.0.0 # Apache-2.0 +oslo.serialization!=2.19.1,>=1.10.0 # Apache-2.0 +oslo.utils>=3.20.0 # Apache-2.0 +six>=1.9.0 # MIT +tempest>=16.1.0 # Apache-2.0 +tempest-lib>=0.14.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..808ffab --- /dev/null +++ b/setup.cfg @@ -0,0 +1,51 @@ +[metadata] +name = openstack +summary = Tempest plugin tripleo_common_tempest_plugin +description-file = + README.rst +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = https://docs.openstack.org/tripleo-docs/latest/ +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 + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.5 + +[files] +packages = + tripleo_common_tempest_plugin + +[build_sphinx] +all_files = 1 +warning-is-error = 1 +source-dir = doc/source +build-dir = doc/build + +[upload_sphinx] +upload-dir = doc/build/html + +[compile_catalog] +directory = tripleo_common_tempest_plugin/locale +domain = tripleo_common_tempest_plugin + +[update_catalog] +domain = tripleo_common_tempest_plugin +output_dir = tripleo_common_tempest_plugin/locale +input_file = tripleo_common_tempest_plugin/locale/tripleo_common_tempest_plugin.pot + +[extract_messages] +keywords = _ gettext ngettext l_ lazy_gettext +mapping_file = babel.cfg +output_file = tripleo_common_tempest_plugin/locale/tripleo_common_tempest_plugin.pot + +[entry_points] +tempest.test_plugins = + tripleo_common_tests = tripleo_common_tempest_plugin.plugin:TripleOCommonTempestPlugin + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..566d844 --- /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>=2.0.0'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..656cd31 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,18 @@ +# 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 already pins down pep8, pyflakes and flake8 +coverage!=4.4,>=4.0 # Apache-2.0 +hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 +oslotest>=1.10.0 # Apache-2.0 +os-testr>=0.8.0 # Apache-2.0 +testrepository>=0.0.18 # Apache-2.0/BSD +testtools>=1.4.0 # MIT + +# Documentation +sphinx>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 + +# Bandit build requirements +bandit>=1.1.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..3c2a3ba --- /dev/null +++ b/tox.ini @@ -0,0 +1,57 @@ +[tox] +minversion = 2.0 +envlist = py35,py27,pep8,api,functional +skipsdist = True + +[testenv] +deps = -r{toxinidir}/test-requirements.txt +usedevelop = True +install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages} +commands = + find . -type f -name "*.py[c|o]" -delete + ostestr --slowest --regex 'tripleo_common_tempest_plugin.api.*' {posargs} + +whitelist_externals = find + +[testenv:api] +basepython = python3.5 +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + OS_TEST_PATH=tripleo_common_tempest_plugin/api +commands = + find . -type f -name "*.py[c|o]" -delete + ostestr --slowest --regex 'tripleo_common_tempest_plugin.functional.*' {posargs} + +[testenv:functional] +basepython = python3.5 +setenv = VIRTUAL_ENV={envdir} + PYTHONHASHSEED=0 + OS_TEST_PATH=tripleo_common_tempest_plugin/functional +# By default ostestr will set concurrency to ncpu, to specify something else +# use the concurrency= option. +# e.g.: 'tox -efunctional -- --concurrency=4' +commands = + find . -type f -name "*.py[c|o]" -delete + ostestr --slowest {posargs} + +whitelist_externals = find + +[testenv:pep8] +commands = + flake8 tripleo_common_tempest_plugin + +[testenv:venv] +commands = {posargs} + +[testenv:releasenotes] +commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + +[flake8] +# Temporarily disable complaints about docstring for public module/class/method +# H106 Don’t put vim configuration in source files +# H203 Use assertIs(Not)None to check for None +ignore = D100,D101,D102,D103,D104,D105,D200,D201,D202,D204,D205,D300,D301,D400,D401 +enable-extensions=H106,H203 +show-source = true +exclude=.venv,.git,.tox,*lib/python*,*egg,tools,build,releasenotes +max-complexity=10 diff --git a/tripleo_common_tempest_plugin/README.rst b/tripleo_common_tempest_plugin/README.rst new file mode 100644 index 0000000..abac323 --- /dev/null +++ b/tripleo_common_tempest_plugin/README.rst @@ -0,0 +1,6 @@ +=============================================== +Tempest Integration of tripleo-common +=============================================== + +This directory contains Tempest tests to cover the tripleo-common project. + diff --git a/tripleo_common_tempest_plugin/__init__.py b/tripleo_common_tempest_plugin/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/config.py b/tripleo_common_tempest_plugin/config.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/plugin.py b/tripleo_common_tempest_plugin/plugin.py new file mode 100644 index 0000000..39d11f1 --- /dev/null +++ b/tripleo_common_tempest_plugin/plugin.py @@ -0,0 +1,34 @@ +# 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 + + +class TripleOCommonTempestPlugin(plugins.TempestPlugin): + def load_tests(self): + base_path = os.path.split(os.path.dirname( + os.path.abspath(__file__)))[0] + test_dir = "tripleo_common_tempest_plugin/tests" + full_test_dir = os.path.join(base_path, test_dir) + return full_test_dir, base_path + + def register_opts(self, conf): + pass + + def get_opt_lists(self): + pass diff --git a/tripleo_common_tempest_plugin/services/__init__.py b/tripleo_common_tempest_plugin/services/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/tests/__init__.py b/tripleo_common_tempest_plugin/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/tests/api/__init__.py b/tripleo_common_tempest_plugin/tests/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/tests/base.py b/tripleo_common_tempest_plugin/tests/base.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/tests/scenario/__init__.py b/tripleo_common_tempest_plugin/tests/scenario/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/tests/scenario/workflows/__init__.py b/tripleo_common_tempest_plugin/tests/scenario/workflows/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tripleo_common_tempest_plugin/tests/scenario/workflows/test_access.py b/tripleo_common_tempest_plugin/tests/scenario/workflows/test_access.py new file mode 100644 index 0000000..8029691 --- /dev/null +++ b/tripleo_common_tempest_plugin/tests/scenario/workflows/test_access.py @@ -0,0 +1,27 @@ +# 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 tempest.lib import decorators +from tempest import test + +from tripleo_common_tempest_plugin.tests import base + + + +class AccessWorkflowTestCase(test.BaseTestCase): + + @decorators.attr(type='openstack') + @decorators.idempotent_id('2d9bf96a-2d1f-4c79-a44d-97208bd0e1a3') + def test_noop(self): + pass