Apply cookiecutter to newly split project
This tempest plugin is being split out of the main keystone project in
accordance with Queens goal "Split Tempest Plugins into Separate
Repos/Projects"[1]. This patch applies the standard boilerplate files
for OpenStack projects so that it can stand on its own.
[1] https://governance.openstack.org/tc/goals/queens/split-tempest-plugins.html
Nishant Kumar
8 years ago
| 0 | *.py[cod] | |
| 1 | ||
| 2 | # C extensions | |
| 3 | *.so | |
| 4 | ||
| 5 | # Packages | |
| 6 | *.egg* | |
| 7 | *.egg-info | |
| 8 | dist | |
| 9 | build | |
| 10 | eggs | |
| 11 | parts | |
| 12 | bin | |
| 13 | var | |
| 14 | sdist | |
| 15 | develop-eggs | |
| 16 | .installed.cfg | |
| 17 | lib | |
| 18 | lib64 | |
| 19 | ||
| 20 | # Installer logs | |
| 21 | pip-log.txt | |
| 22 | ||
| 23 | # Unit test / coverage reports | |
| 24 | cover/ | |
| 25 | .coverage* | |
| 26 | !.coveragerc | |
| 27 | .tox | |
| 28 | nosetests.xml | |
| 29 | .testrepository | |
| 30 | .venv | |
| 31 | ||
| 32 | # Translations | |
| 33 | *.mo | |
| 34 | ||
| 35 | # Mr Developer | |
| 36 | .mr.developer.cfg | |
| 37 | .project | |
| 38 | .pydevproject | |
| 39 | ||
| 40 | # Complexity | |
| 41 | output/*.html | |
| 42 | output/*/index.html | |
| 43 | ||
| 44 | # Sphinx | |
| 45 | doc/build | |
| 46 | ||
| 47 | # pbr generates these | |
| 48 | AUTHORS | |
| 49 | ChangeLog | |
| 50 | ||
| 51 | # Editors | |
| 52 | *~ | |
| 53 | .*.swp | |
| 54 | .*sw? | |
| 55 | ||
| 56 | # Files created by releasenotes build | |
| 57 | releasenotes/build⏎ |
| 0 | [DEFAULT] | |
| 1 | test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ | |
| 2 | OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ | |
| 3 | OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ | |
| 4 | ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION | |
| 5 | test_id_option=--load-list $IDFILE | |
| 6 | test_list_option=--list |
| 0 | If you would like to contribute to the development of OpenStack, you must | |
| 1 | follow the steps in this page: | |
| 2 | ||
| 3 | http://docs.openstack.org/infra/manual/developers.html | |
| 4 | ||
| 5 | If you already have a good understanding of how the system works and your | |
| 6 | OpenStack accounts are set up, you can skip to the development workflow | |
| 7 | section of this documentation to learn how changes to OpenStack should be | |
| 8 | submitted for review via the Gerrit tool: | |
| 9 | ||
| 10 | http://docs.openstack.org/infra/manual/developers.html#development-workflow | |
| 11 | ||
| 12 | Pull requests submitted through GitHub will be ignored. | |
| 13 | ||
| 14 | Bugs should be filed on Launchpad, not GitHub: | |
| 15 | ||
| 16 | https://bugs.launchpad.net/cinder_tempest_plugin |
| 0 | Openstack Style Commandments | |
| 1 | ||
| 2 | =============================================== | |
| 3 | ||
| 4 | Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ |
| 0 | ||
| 1 | Apache License | |
| 2 | Version 2.0, January 2004 | |
| 3 | http://www.apache.org/licenses/ | |
| 4 | ||
| 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | |
| 6 | ||
| 7 | 1. Definitions. | |
| 8 | ||
| 9 | "License" shall mean the terms and conditions for use, reproduction, | |
| 10 | and distribution as defined by Sections 1 through 9 of this document. | |
| 11 | ||
| 12 | "Licensor" shall mean the copyright owner or entity authorized by | |
| 13 | the copyright owner that is granting the License. | |
| 14 | ||
| 15 | "Legal Entity" shall mean the union of the acting entity and all | |
| 16 | other entities that control, are controlled by, or are under common | |
| 17 | control with that entity. For the purposes of this definition, | |
| 18 | "control" means (i) the power, direct or indirect, to cause the | |
| 19 | direction or management of such entity, whether by contract or | |
| 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the | |
| 21 | outstanding shares, or (iii) beneficial ownership of such entity. | |
| 22 | ||
| 23 | "You" (or "Your") shall mean an individual or Legal Entity | |
| 24 | exercising permissions granted by this License. | |
| 25 | ||
| 26 | "Source" form shall mean the preferred form for making modifications, | |
| 27 | including but not limited to software source code, documentation | |
| 28 | source, and configuration files. | |
| 29 | ||
| 30 | "Object" form shall mean any form resulting from mechanical | |
| 31 | transformation or translation of a Source form, including but | |
| 32 | not limited to compiled object code, generated documentation, | |
| 33 | and conversions to other media types. | |
| 34 | ||
| 35 | "Work" shall mean the work of authorship, whether in Source or | |
| 36 | Object form, made available under the License, as indicated by a | |
| 37 | copyright notice that is included in or attached to the work | |
| 38 | (an example is provided in the Appendix below). | |
| 39 | ||
| 40 | "Derivative Works" shall mean any work, whether in Source or Object | |
| 41 | form, that is based on (or derived from) the Work and for which the | |
| 42 | editorial revisions, annotations, elaborations, or other modifications | |
| 43 | represent, as a whole, an original work of authorship. For the purposes | |
| 44 | of this License, Derivative Works shall not include works that remain | |
| 45 | separable from, or merely link (or bind by name) to the interfaces of, | |
| 46 | the Work and Derivative Works thereof. | |
| 47 | ||
| 48 | "Contribution" shall mean any work of authorship, including | |
| 49 | the original version of the Work and any modifications or additions | |
| 50 | to that Work or Derivative Works thereof, that is intentionally | |
| 51 | submitted to Licensor for inclusion in the Work by the copyright owner | |
| 52 | or by an individual or Legal Entity authorized to submit on behalf of | |
| 53 | the copyright owner. For the purposes of this definition, "submitted" | |
| 54 | means any form of electronic, verbal, or written communication sent | |
| 55 | to the Licensor or its representatives, including but not limited to | |
| 56 | communication on electronic mailing lists, source code control systems, | |
| 57 | and issue tracking systems that are managed by, or on behalf of, the | |
| 58 | Licensor for the purpose of discussing and improving the Work, but | |
| 59 | excluding communication that is conspicuously marked or otherwise | |
| 60 | designated in writing by the copyright owner as "Not a Contribution." | |
| 61 | ||
| 62 | "Contributor" shall mean Licensor and any individual or Legal Entity | |
| 63 | on behalf of whom a Contribution has been received by Licensor and | |
| 64 | subsequently incorporated within the Work. | |
| 65 | ||
| 66 | 2. Grant of Copyright License. Subject to the terms and conditions of | |
| 67 | this License, each Contributor hereby grants to You a perpetual, | |
| 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | |
| 69 | copyright license to reproduce, prepare Derivative Works of, | |
| 70 | publicly display, publicly perform, sublicense, and distribute the | |
| 71 | Work and such Derivative Works in Source or Object form. | |
| 72 | ||
| 73 | 3. Grant of Patent License. Subject to the terms and conditions of | |
| 74 | this License, each Contributor hereby grants to You a perpetual, | |
| 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | |
| 76 | (except as stated in this section) patent license to make, have made, | |
| 77 | use, offer to sell, sell, import, and otherwise transfer the Work, | |
| 78 | where such license applies only to those patent claims licensable | |
| 79 | by such Contributor that are necessarily infringed by their | |
| 80 | Contribution(s) alone or by combination of their Contribution(s) | |
| 81 | with the Work to which such Contribution(s) was submitted. If You | |
| 82 | institute patent litigation against any entity (including a | |
| 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work | |
| 84 | or a Contribution incorporated within the Work constitutes direct | |
| 85 | or contributory patent infringement, then any patent licenses | |
| 86 | granted to You under this License for that Work shall terminate | |
| 87 | as of the date such litigation is filed. | |
| 88 | ||
| 89 | 4. Redistribution. You may reproduce and distribute copies of the | |
| 90 | Work or Derivative Works thereof in any medium, with or without | |
| 91 | modifications, and in Source or Object form, provided that You | |
| 92 | meet the following conditions: | |
| 93 | ||
| 94 | (a) You must give any other recipients of the Work or | |
| 95 | Derivative Works a copy of this License; and | |
| 96 | ||
| 97 | (b) You must cause any modified files to carry prominent notices | |
| 98 | stating that You changed the files; and | |
| 99 | ||
| 100 | (c) You must retain, in the Source form of any Derivative Works | |
| 101 | that You distribute, all copyright, patent, trademark, and | |
| 102 | attribution notices from the Source form of the Work, | |
| 103 | excluding those notices that do not pertain to any part of | |
| 104 | the Derivative Works; and | |
| 105 | ||
| 106 | (d) If the Work includes a "NOTICE" text file as part of its | |
| 107 | distribution, then any Derivative Works that You distribute must | |
| 108 | include a readable copy of the attribution notices contained | |
| 109 | within such NOTICE file, excluding those notices that do not | |
| 110 | pertain to any part of the Derivative Works, in at least one | |
| 111 | of the following places: within a NOTICE text file distributed | |
| 112 | as part of the Derivative Works; within the Source form or | |
| 113 | documentation, if provided along with the Derivative Works; or, | |
| 114 | within a display generated by the Derivative Works, if and | |
| 115 | wherever such third-party notices normally appear. The contents | |
| 116 | of the NOTICE file are for informational purposes only and | |
| 117 | do not modify the License. You may add Your own attribution | |
| 118 | notices within Derivative Works that You distribute, alongside | |
| 119 | or as an addendum to the NOTICE text from the Work, provided | |
| 120 | that such additional attribution notices cannot be construed | |
| 121 | as modifying the License. | |
| 122 | ||
| 123 | You may add Your own copyright statement to Your modifications and | |
| 124 | may provide additional or different license terms and conditions | |
| 125 | for use, reproduction, or distribution of Your modifications, or | |
| 126 | for any such Derivative Works as a whole, provided Your use, | |
| 127 | reproduction, and distribution of the Work otherwise complies with | |
| 128 | the conditions stated in this License. | |
| 129 | ||
| 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, | |
| 131 | any Contribution intentionally submitted for inclusion in the Work | |
| 132 | by You to the Licensor shall be under the terms and conditions of | |
| 133 | this License, without any additional terms or conditions. | |
| 134 | Notwithstanding the above, nothing herein shall supersede or modify | |
| 135 | the terms of any separate license agreement you may have executed | |
| 136 | with Licensor regarding such Contributions. | |
| 137 | ||
| 138 | 6. Trademarks. This License does not grant permission to use the trade | |
| 139 | names, trademarks, service marks, or product names of the Licensor, | |
| 140 | except as required for reasonable and customary use in describing the | |
| 141 | origin of the Work and reproducing the content of the NOTICE file. | |
| 142 | ||
| 143 | 7. Disclaimer of Warranty. Unless required by applicable law or | |
| 144 | agreed to in writing, Licensor provides the Work (and each | |
| 145 | Contributor provides its Contributions) on an "AS IS" BASIS, | |
| 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 147 | implied, including, without limitation, any warranties or conditions | |
| 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | |
| 149 | PARTICULAR PURPOSE. You are solely responsible for determining the | |
| 150 | appropriateness of using or redistributing the Work and assume any | |
| 151 | risks associated with Your exercise of permissions under this License. | |
| 152 | ||
| 153 | 8. Limitation of Liability. In no event and under no legal theory, | |
| 154 | whether in tort (including negligence), contract, or otherwise, | |
| 155 | unless required by applicable law (such as deliberate and grossly | |
| 156 | negligent acts) or agreed to in writing, shall any Contributor be | |
| 157 | liable to You for damages, including any direct, indirect, special, | |
| 158 | incidental, or consequential damages of any character arising as a | |
| 159 | result of this License or out of the use or inability to use the | |
| 160 | Work (including but not limited to damages for loss of goodwill, | |
| 161 | work stoppage, computer failure or malfunction, or any and all | |
| 162 | other commercial damages or losses), even if such Contributor | |
| 163 | has been advised of the possibility of such damages. | |
| 164 | ||
| 165 | 9. Accepting Warranty or Additional Liability. While redistributing | |
| 166 | the Work or Derivative Works thereof, You may choose to offer, | |
| 167 | and charge a fee for, acceptance of support, warranty, indemnity, | |
| 168 | or other liability obligations and/or rights consistent with this | |
| 169 | License. However, in accepting such obligations, You may act only | |
| 170 | on Your own behalf and on Your sole responsibility, not on behalf | |
| 171 | of any other Contributor, and only if You agree to indemnify, | |
| 172 | defend, and hold each Contributor harmless for any liability | |
| 173 | incurred by, or claims asserted against, such Contributor by reason | |
| 174 | of your accepting any such warranty or additional liability. | |
| 175 |
| 0 | =============================== | |
| 1 | cinder_tempest_plugin | |
| 2 | =============================== | |
| 3 | ||
| 4 | It contains tempest plugin tests for Cinder. | |
| 5 | ||
| 6 | Please fill here a long description which must be at least 3 lines wrapped on | |
| 7 | 80 cols, so that distribution package maintainers can use it in their packages. | |
| 8 | Note that this is a hard requirement. | |
| 9 | ||
| 10 | * Free software: Apache license | |
| 11 | * Documentation: http://docs.openstack.org/developer/openstack | |
| 12 | * Source: http://git.openstack.org/cgit/cinder-tempest-plugin | |
| 13 | * Bugs: http://bugs.launchpad.net/cinder_tempest_plugin | |
| 14 | ||
| 15 | Features | |
| 16 | -------- | |
| 17 | ||
| 18 | * TODO |
| 0 | ==================== | |
| 1 | Administrators guide | |
| 2 | ==================== | |
| 3 | ||
| 4 | Administrators guide of cinder_tempest_plugin. |
| 0 | ================================ | |
| 1 | Command line interface reference | |
| 2 | ================================ | |
| 3 | ||
| 4 | CLI reference of cinder_tempest_plugin. |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | # Licensed under the Apache License, Version 2.0 (the "License"); | |
| 2 | # you may not use this file except in compliance with the License. | |
| 3 | # You may obtain a copy of the License at | |
| 4 | # | |
| 5 | # http://www.apache.org/licenses/LICENSE-2.0 | |
| 6 | # | |
| 7 | # Unless required by applicable law or agreed to in writing, software | |
| 8 | # distributed under the License is distributed on an "AS IS" BASIS, | |
| 9 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 10 | # implied. | |
| 11 | # See the License for the specific language governing permissions and | |
| 12 | # limitations under the License. | |
| 13 | ||
| 14 | import os | |
| 15 | import sys | |
| 16 | ||
| 17 | sys.path.insert(0, os.path.abspath('../..')) | |
| 18 | # -- General configuration ---------------------------------------------------- | |
| 19 | ||
| 20 | # Add any Sphinx extension module names here, as strings. They can be | |
| 21 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |
| 22 | extensions = [ | |
| 23 | 'sphinx.ext.autodoc', | |
| 24 | 'openstackdocstheme', | |
| 25 | #'sphinx.ext.intersphinx', | |
| 26 | ] | |
| 27 | ||
| 28 | # autodoc generation is a bit aggressive and a nuisance when doing heavy | |
| 29 | # text edit cycles. | |
| 30 | # execute "export SPHINX_DEBUG=1" in your terminal to disable | |
| 31 | ||
| 32 | # The suffix of source filenames. | |
| 33 | source_suffix = '.rst' | |
| 34 | ||
| 35 | # The master toctree document. | |
| 36 | master_doc = 'index' | |
| 37 | ||
| 38 | # General information about the project. | |
| 39 | project = u'cinder_tempest_plugin' | |
| 40 | copyright = u'2017, OpenStack Developers' | |
| 41 | ||
| 42 | # openstackdocstheme options | |
| 43 | repository_name = 'cinder_tempest_plugin/cinder_tempest_plugin' | |
| 44 | bug_project = 'cinder_tempest_plugin' | |
| 45 | bug_tag = '' | |
| 46 | ||
| 47 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
| 48 | add_function_parentheses = True | |
| 49 | ||
| 50 | # If true, the current module name will be prepended to all description | |
| 51 | # unit titles (such as .. function::). | |
| 52 | add_module_names = True | |
| 53 | ||
| 54 | # The name of the Pygments (syntax highlighting) style to use. | |
| 55 | pygments_style = 'sphinx' | |
| 56 | ||
| 57 | # -- Options for HTML output -------------------------------------------------- | |
| 58 | ||
| 59 | # The theme to use for HTML and HTML Help pages. Major themes that come with | |
| 60 | # Sphinx are currently 'default' and 'sphinxdoc'. | |
| 61 | # html_theme_path = ["."] | |
| 62 | # html_theme = '_theme' | |
| 63 | # html_static_path = ['static'] | |
| 64 | html_theme = 'openstackdocs' | |
| 65 | ||
| 66 | # Output file base name for HTML help builder. | |
| 67 | htmlhelp_basename = '%sdoc' % project | |
| 68 | ||
| 69 | # Grouping the document tree into LaTeX files. List of tuples | |
| 70 | # (source start file, target name, title, author, documentclass | |
| 71 | # [howto/manual]). | |
| 72 | latex_documents = [ | |
| 73 | ('index', | |
| 74 | '%s.tex' % project, | |
| 75 | u'%s Documentation' % project, | |
| 76 | u'OpenStack Developers', 'manual'), | |
| 77 | ] | |
| 78 | ||
| 79 | # Example configuration for intersphinx: refer to the Python standard library. | |
| 80 | #intersphinx_mapping = {'http://docs.python.org/': None} |
| 0 | =========================== | |
| 1 | Contributor Documentation | |
| 2 | =========================== | |
| 3 | ||
| 4 | .. toctree:: | |
| 5 | :maxdepth: 2 | |
| 6 | ||
| 7 | contributing | |
| 8 |
| 0 | .. cinder_tempest_plugin documentation master file, created by | |
| 1 | sphinx-quickstart on Tue Jul 9 22:26:36 2013. | |
| 2 | You can adapt this file completely to your liking, but it should at least | |
| 3 | contain the root `toctree` directive. | |
| 4 | ||
| 5 | ===================================================== | |
| 6 | Welcome to the documentation of cinder_tempest_plugin | |
| 7 | ===================================================== | |
| 8 | ||
| 9 | Contents: | |
| 10 | ||
| 11 | .. toctree:: | |
| 12 | :maxdepth: 2 | |
| 13 | ||
| 14 | readme | |
| 15 | install/index | |
| 16 | library/index | |
| 17 | contributor/index | |
| 18 | configuration/index | |
| 19 | cli/index | |
| 20 | user/index | |
| 21 | admin/index | |
| 22 | reference/index | |
| 23 | ||
| 24 | Indices and tables | |
| 25 | ================== | |
| 26 | ||
| 27 | * :ref:`genindex` | |
| 28 | * :ref:`modindex` | |
| 29 | * :ref:`search` |
| 0 | 2. Edit the ``/etc/cinder_tempest_plugin/cinder_tempest_plugin.conf`` file and complete the following | |
| 1 | actions: | |
| 2 | ||
| 3 | * In the ``[database]`` section, configure database access: | |
| 4 | ||
| 5 | .. code-block:: ini | |
| 6 | ||
| 7 | [database] | |
| 8 | ... | |
| 9 | connection = mysql+pymysql://cinder_tempest_plugin:CINDER_TEMPEST_PLUGIN_DBPASS@controller/cinder_tempest_plugin |
| 0 | Prerequisites | |
| 1 | ------------- | |
| 2 | ||
| 3 | Before you install and configure the volume service, | |
| 4 | you must create a database, service credentials, and API endpoints. | |
| 5 | ||
| 6 | #. To create the database, complete these steps: | |
| 7 | ||
| 8 | * Use the database access client to connect to the database | |
| 9 | server as the ``root`` user: | |
| 10 | ||
| 11 | .. code-block:: console | |
| 12 | ||
| 13 | $ mysql -u root -p | |
| 14 | ||
| 15 | * Create the ``cinder_tempest_plugin`` database: | |
| 16 | ||
| 17 | .. code-block:: none | |
| 18 | ||
| 19 | CREATE DATABASE cinder_tempest_plugin; | |
| 20 | ||
| 21 | * Grant proper access to the ``cinder_tempest_plugin`` database: | |
| 22 | ||
| 23 | .. code-block:: none | |
| 24 | ||
| 25 | GRANT ALL PRIVILEGES ON cinder_tempest_plugin.* TO 'cinder_tempest_plugin'@'localhost' \ | |
| 26 | IDENTIFIED BY 'CINDER_TEMPEST_PLUGIN_DBPASS'; | |
| 27 | GRANT ALL PRIVILEGES ON cinder_tempest_plugin.* TO 'cinder_tempest_plugin'@'%' \ | |
| 28 | IDENTIFIED BY 'CINDER_TEMPEST_PLUGIN_DBPASS'; | |
| 29 | ||
| 30 | Replace ``CINDER_TEMPEST_PLUGIN_DBPASS`` with a suitable password. | |
| 31 | ||
| 32 | * Exit the database access client. | |
| 33 | ||
| 34 | .. code-block:: none | |
| 35 | ||
| 36 | exit; | |
| 37 | ||
| 38 | #. Source the ``admin`` credentials to gain access to | |
| 39 | admin-only CLI commands: | |
| 40 | ||
| 41 | .. code-block:: console | |
| 42 | ||
| 43 | $ . admin-openrc | |
| 44 | ||
| 45 | #. To create the service credentials, complete these steps: | |
| 46 | ||
| 47 | * Create the ``cinder_tempest_plugin`` user: | |
| 48 | ||
| 49 | .. code-block:: console | |
| 50 | ||
| 51 | $ openstack user create --domain default --password-prompt cinder_tempest_plugin | |
| 52 | ||
| 53 | * Add the ``admin`` role to the ``cinder_tempest_plugin`` user: | |
| 54 | ||
| 55 | .. code-block:: console | |
| 56 | ||
| 57 | $ openstack role add --project service --user cinder_tempest_plugin admin | |
| 58 | ||
| 59 | * Create the cinder_tempest_plugin service entities: | |
| 60 | ||
| 61 | .. code-block:: console | |
| 62 | ||
| 63 | $ openstack service create --name cinder_tempest_plugin --description "volume" volume | |
| 64 | ||
| 65 | #. Create the volume service API endpoints: | |
| 66 | ||
| 67 | .. code-block:: console | |
| 68 | ||
| 69 | $ openstack endpoint create --region RegionOne \ | |
| 70 | volume public http://controller:XXXX/vY/%\(tenant_id\)s | |
| 71 | $ openstack endpoint create --region RegionOne \ | |
| 72 | volume internal http://controller:XXXX/vY/%\(tenant_id\)s | |
| 73 | $ openstack endpoint create --region RegionOne \ | |
| 74 | volume admin http://controller:XXXX/vY/%\(tenant_id\)s |
| 0 | ======================= | |
| 1 | volume service overview | |
| 2 | ======================= | |
| 3 | The volume service provides... | |
| 4 | ||
| 5 | The volume service consists of the following components: | |
| 6 | ||
| 7 | ``cinder_tempest_plugin-api`` service | |
| 8 | Accepts and responds to end user compute API calls... |
| 0 | ================================= | |
| 1 | volume service installation guide | |
| 2 | ================================= | |
| 3 | ||
| 4 | .. toctree:: | |
| 5 | :maxdepth: 2 | |
| 6 | ||
| 7 | get_started.rst | |
| 8 | install.rst | |
| 9 | verify.rst | |
| 10 | next-steps.rst | |
| 11 | ||
| 12 | The volume service (cinder_tempest_plugin) provides... | |
| 13 | ||
| 14 | This chapter assumes a working setup of OpenStack following the | |
| 15 | `OpenStack Installation Tutorial | |
| 16 | <https://docs.openstack.org/project-install-guide/ocata/>`_. |
| 0 | .. _install-obs: | |
| 1 | ||
| 2 | ||
| 3 | Install and configure for openSUSE and SUSE Linux Enterprise | |
| 4 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 5 | ||
| 6 | This section describes how to install and configure the volume service | |
| 7 | for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1. | |
| 8 | ||
| 9 | .. include:: common_prerequisites.rst | |
| 10 | ||
| 11 | Install and configure components | |
| 12 | -------------------------------- | |
| 13 | ||
| 14 | #. Install the packages: | |
| 15 | ||
| 16 | .. code-block:: console | |
| 17 | ||
| 18 | # zypper --quiet --non-interactive install | |
| 19 | ||
| 20 | .. include:: common_configure.rst | |
| 21 | ||
| 22 | ||
| 23 | Finalize installation | |
| 24 | --------------------- | |
| 25 | ||
| 26 | Start the volume services and configure them to start when | |
| 27 | the system boots: | |
| 28 | ||
| 29 | .. code-block:: console | |
| 30 | ||
| 31 | # systemctl enable openstack-cinder_tempest_plugin-api.service | |
| 32 | ||
| 33 | # systemctl start openstack-cinder_tempest_plugin-api.service |
| 0 | .. _install-rdo: | |
| 1 | ||
| 2 | Install and configure for Red Hat Enterprise Linux and CentOS | |
| 3 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 4 | ||
| 5 | ||
| 6 | This section describes how to install and configure the volume service | |
| 7 | for Red Hat Enterprise Linux 7 and CentOS 7. | |
| 8 | ||
| 9 | .. include:: common_prerequisites.rst | |
| 10 | ||
| 11 | Install and configure components | |
| 12 | -------------------------------- | |
| 13 | ||
| 14 | #. Install the packages: | |
| 15 | ||
| 16 | .. code-block:: console | |
| 17 | ||
| 18 | # yum install | |
| 19 | ||
| 20 | .. include:: common_configure.rst | |
| 21 | ||
| 22 | Finalize installation | |
| 23 | --------------------- | |
| 24 | ||
| 25 | Start the volume services and configure them to start when | |
| 26 | the system boots: | |
| 27 | ||
| 28 | .. code-block:: console | |
| 29 | ||
| 30 | # systemctl enable openstack-cinder_tempest_plugin-api.service | |
| 31 | ||
| 32 | # systemctl start openstack-cinder_tempest_plugin-api.service |
| 0 | .. _install-ubuntu: | |
| 1 | ||
| 2 | Install and configure for Ubuntu | |
| 3 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 4 | ||
| 5 | This section describes how to install and configure the volume | |
| 6 | service for Ubuntu 14.04 (LTS). | |
| 7 | ||
| 8 | .. include:: common_prerequisites.rst | |
| 9 | ||
| 10 | Install and configure components | |
| 11 | -------------------------------- | |
| 12 | ||
| 13 | #. Install the packages: | |
| 14 | ||
| 15 | .. code-block:: console | |
| 16 | ||
| 17 | # apt-get update | |
| 18 | ||
| 19 | # apt-get install | |
| 20 | ||
| 21 | .. include:: common_configure.rst | |
| 22 | ||
| 23 | Finalize installation | |
| 24 | --------------------- | |
| 25 | ||
| 26 | Restart the volume services: | |
| 27 | ||
| 28 | .. code-block:: console | |
| 29 | ||
| 30 | # service openstack-cinder_tempest_plugin-api restart |
| 0 | .. _install: | |
| 1 | ||
| 2 | Install and configure | |
| 3 | ~~~~~~~~~~~~~~~~~~~~~ | |
| 4 | ||
| 5 | This section describes how to install and configure the | |
| 6 | volume service, code-named cinder_tempest_plugin, on the controller node. | |
| 7 | ||
| 8 | This section assumes that you already have a working OpenStack | |
| 9 | environment with at least the following components installed: | |
| 10 | .. (add the appropriate services here and further notes) | |
| 11 | ||
| 12 | Note that installation and configuration vary by distribution. | |
| 13 | ||
| 14 | .. toctree:: | |
| 15 | :maxdepth: 2 | |
| 16 | ||
| 17 | install-obs.rst | |
| 18 | install-rdo.rst | |
| 19 | install-ubuntu.rst |
| 0 | .. _next-steps: | |
| 1 | ||
| 2 | Next steps | |
| 3 | ~~~~~~~~~~ | |
| 4 | ||
| 5 | Your OpenStack environment now includes the cinder_tempest_plugin service. | |
| 6 | ||
| 7 | To add additional services, see | |
| 8 | https://docs.openstack.org/project-install-guide/ocata/. |
| 0 | .. _verify: | |
| 1 | ||
| 2 | Verify operation | |
| 3 | ~~~~~~~~~~~~~~~~ | |
| 4 | ||
| 5 | Verify operation of the volume service. | |
| 6 | ||
| 7 | .. note:: | |
| 8 | ||
| 9 | Perform these commands on the controller node. | |
| 10 | ||
| 11 | #. Source the ``admin`` project credentials to gain access to | |
| 12 | admin-only CLI commands: | |
| 13 | ||
| 14 | .. code-block:: console | |
| 15 | ||
| 16 | $ . admin-openrc | |
| 17 | ||
| 18 | #. List service components to verify successful launch and registration | |
| 19 | of each process: | |
| 20 | ||
| 21 | .. code-block:: console | |
| 22 | ||
| 23 | $ openstack volume service list |
| 0 | ======== | |
| 1 | Usage | |
| 2 | ======== | |
| 3 | ||
| 4 | To use cinder_tempest_plugin in a project:: | |
| 5 | ||
| 6 | import cinder_tempest_plugin |
| 0 | .. include:: ../../README.rst |
| 0 | # -*- coding: utf-8 -*- | |
| 1 | # Licensed under the Apache License, Version 2.0 (the "License"); | |
| 2 | # you may not use this file except in compliance with the License. | |
| 3 | # You may obtain a copy of the License at | |
| 4 | # | |
| 5 | # http://www.apache.org/licenses/LICENSE-2.0 | |
| 6 | # | |
| 7 | # Unless required by applicable law or agreed to in writing, software | |
| 8 | # distributed under the License is distributed on an "AS IS" BASIS, | |
| 9 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 10 | # implied. | |
| 11 | # See the License for the specific language governing permissions and | |
| 12 | # limitations under the License. | |
| 13 | ||
| 14 | # This file is execfile()d with the current directory set to its | |
| 15 | # containing dir. | |
| 16 | # | |
| 17 | # Note that not all possible configuration values are present in this | |
| 18 | # autogenerated file. | |
| 19 | # | |
| 20 | # All configuration values have a default; values that are commented out | |
| 21 | # serve to show the default. | |
| 22 | ||
| 23 | # If extensions (or modules to document with autodoc) are in another directory, | |
| 24 | # add these directories to sys.path here. If the directory is relative to the | |
| 25 | # documentation root, use os.path.abspath to make it absolute, like shown here. | |
| 26 | # sys.path.insert(0, os.path.abspath('.')) | |
| 27 | ||
| 28 | # -- General configuration ------------------------------------------------ | |
| 29 | ||
| 30 | # If your documentation needs a minimal Sphinx version, state it here. | |
| 31 | # needs_sphinx = '1.0' | |
| 32 | ||
| 33 | # Add any Sphinx extension module names here, as strings. They can be | |
| 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
| 35 | # ones. | |
| 36 | extensions = [ | |
| 37 | 'openstackdocstheme', | |
| 38 | 'reno.sphinxext', | |
| 39 | ] | |
| 40 | ||
| 41 | # Add any paths that contain templates here, relative to this directory. | |
| 42 | templates_path = ['_templates'] | |
| 43 | ||
| 44 | # The suffix of source filenames. | |
| 45 | source_suffix = '.rst' | |
| 46 | ||
| 47 | # The encoding of source files. | |
| 48 | # source_encoding = 'utf-8-sig' | |
| 49 | ||
| 50 | # The master toctree document. | |
| 51 | master_doc = 'index' | |
| 52 | ||
| 53 | # General information about the project. | |
| 54 | project = u'cinder_tempest_plugin Release Notes' | |
| 55 | copyright = u'2017, OpenStack Developers' | |
| 56 | ||
| 57 | # openstackdocstheme options | |
| 58 | repository_name = 'cinder_tempest_plugin/cinder_tempest_plugin' | |
| 59 | bug_project = 'cinder_tempest_plugin' | |
| 60 | bug_tag = '' | |
| 61 | ||
| 62 | # The version info for the project you're documenting, acts as replacement for | |
| 63 | # |version| and |release|, also used in various other places throughout the | |
| 64 | # built documents. | |
| 65 | # | |
| 66 | # The short X.Y version. | |
| 67 | # The full version, including alpha/beta/rc tags. | |
| 68 | release = '' | |
| 69 | # The short X.Y version. | |
| 70 | version = '' | |
| 71 | ||
| 72 | # The language for content autogenerated by Sphinx. Refer to documentation | |
| 73 | # for a list of supported languages. | |
| 74 | # language = None | |
| 75 | ||
| 76 | # There are two options for replacing |today|: either, you set today to some | |
| 77 | # non-false value, then it is used: | |
| 78 | # today = '' | |
| 79 | # Else, today_fmt is used as the format for a strftime call. | |
| 80 | # today_fmt = '%B %d, %Y' | |
| 81 | ||
| 82 | # List of patterns, relative to source directory, that match files and | |
| 83 | # directories to ignore when looking for source files. | |
| 84 | exclude_patterns = [] | |
| 85 | ||
| 86 | # The reST default role (used for this markup: `text`) to use for all | |
| 87 | # documents. | |
| 88 | # default_role = None | |
| 89 | ||
| 90 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
| 91 | # add_function_parentheses = True | |
| 92 | ||
| 93 | # If true, the current module name will be prepended to all description | |
| 94 | # unit titles (such as .. function::). | |
| 95 | # add_module_names = True | |
| 96 | ||
| 97 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
| 98 | # output. They are ignored by default. | |
| 99 | # show_authors = False | |
| 100 | ||
| 101 | # The name of the Pygments (syntax highlighting) style to use. | |
| 102 | pygments_style = 'sphinx' | |
| 103 | ||
| 104 | # A list of ignored prefixes for module index sorting. | |
| 105 | # modindex_common_prefix = [] | |
| 106 | ||
| 107 | # If true, keep warnings as "system message" paragraphs in the built documents. | |
| 108 | # keep_warnings = False | |
| 109 | ||
| 110 | ||
| 111 | # -- Options for HTML output ---------------------------------------------- | |
| 112 | ||
| 113 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
| 114 | # a list of builtin themes. | |
| 115 | html_theme = 'openstackdocs' | |
| 116 | ||
| 117 | # Theme options are theme-specific and customize the look and feel of a theme | |
| 118 | # further. For a list of options available for each theme, see the | |
| 119 | # documentation. | |
| 120 | # html_theme_options = {} | |
| 121 | ||
| 122 | # Add any paths that contain custom themes here, relative to this directory. | |
| 123 | # html_theme_path = [] | |
| 124 | ||
| 125 | # The name for this set of Sphinx documents. If None, it defaults to | |
| 126 | # "<project> v<release> documentation". | |
| 127 | # html_title = None | |
| 128 | ||
| 129 | # A shorter title for the navigation bar. Default is the same as html_title. | |
| 130 | # html_short_title = None | |
| 131 | ||
| 132 | # The name of an image file (relative to this directory) to place at the top | |
| 133 | # of the sidebar. | |
| 134 | # html_logo = None | |
| 135 | ||
| 136 | # The name of an image file (within the static path) to use as favicon of the | |
| 137 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |
| 138 | # pixels large. | |
| 139 | # html_favicon = None | |
| 140 | ||
| 141 | # Add any paths that contain custom static files (such as style sheets) here, | |
| 142 | # relative to this directory. They are copied after the builtin static files, | |
| 143 | # so a file named "default.css" will overwrite the builtin "default.css". | |
| 144 | html_static_path = ['_static'] | |
| 145 | ||
| 146 | # Add any extra paths that contain custom files (such as robots.txt or | |
| 147 | # .htaccess) here, relative to this directory. These files are copied | |
| 148 | # directly to the root of the documentation. | |
| 149 | # html_extra_path = [] | |
| 150 | ||
| 151 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
| 152 | # using the given strftime format. | |
| 153 | # html_last_updated_fmt = '%b %d, %Y' | |
| 154 | ||
| 155 | # If true, SmartyPants will be used to convert quotes and dashes to | |
| 156 | # typographically correct entities. | |
| 157 | # html_use_smartypants = True | |
| 158 | ||
| 159 | # Custom sidebar templates, maps document names to template names. | |
| 160 | # html_sidebars = {} | |
| 161 | ||
| 162 | # Additional templates that should be rendered to pages, maps page names to | |
| 163 | # template names. | |
| 164 | # html_additional_pages = {} | |
| 165 | ||
| 166 | # If false, no module index is generated. | |
| 167 | # html_domain_indices = True | |
| 168 | ||
| 169 | # If false, no index is generated. | |
| 170 | # html_use_index = True | |
| 171 | ||
| 172 | # If true, the index is split into individual pages for each letter. | |
| 173 | # html_split_index = False | |
| 174 | ||
| 175 | # If true, links to the reST sources are added to the pages. | |
| 176 | # html_show_sourcelink = True | |
| 177 | ||
| 178 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |
| 179 | # html_show_sphinx = True | |
| 180 | ||
| 181 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |
| 182 | # html_show_copyright = True | |
| 183 | ||
| 184 | # If true, an OpenSearch description file will be output, and all pages will | |
| 185 | # contain a <link> tag referring to it. The value of this option must be the | |
| 186 | # base URL from which the finished HTML is served. | |
| 187 | # html_use_opensearch = '' | |
| 188 | ||
| 189 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
| 190 | # html_file_suffix = None | |
| 191 | ||
| 192 | # Output file base name for HTML help builder. | |
| 193 | htmlhelp_basename = 'cinder_tempest_pluginReleaseNotesdoc' | |
| 194 | ||
| 195 | ||
| 196 | # -- Options for LaTeX output --------------------------------------------- | |
| 197 | ||
| 198 | latex_elements = { | |
| 199 | # The paper size ('letterpaper' or 'a4paper'). | |
| 200 | # 'papersize': 'letterpaper', | |
| 201 | ||
| 202 | # The font size ('10pt', '11pt' or '12pt'). | |
| 203 | # 'pointsize': '10pt', | |
| 204 | ||
| 205 | # Additional stuff for the LaTeX preamble. | |
| 206 | # 'preamble': '', | |
| 207 | } | |
| 208 | ||
| 209 | # Grouping the document tree into LaTeX files. List of tuples | |
| 210 | # (source start file, target name, title, | |
| 211 | # author, documentclass [howto, manual, or own class]). | |
| 212 | latex_documents = [ | |
| 213 | ('index', 'cinder_tempest_pluginReleaseNotes.tex', | |
| 214 | u'cinder_tempest_plugin Release Notes Documentation', | |
| 215 | u'OpenStack Foundation', 'manual'), | |
| 216 | ] | |
| 217 | ||
| 218 | # The name of an image file (relative to this directory) to place at the top of | |
| 219 | # the title page. | |
| 220 | # latex_logo = None | |
| 221 | ||
| 222 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
| 223 | # not chapters. | |
| 224 | # latex_use_parts = False | |
| 225 | ||
| 226 | # If true, show page references after internal links. | |
| 227 | # latex_show_pagerefs = False | |
| 228 | ||
| 229 | # If true, show URL addresses after external links. | |
| 230 | # latex_show_urls = False | |
| 231 | ||
| 232 | # Documents to append as an appendix to all manuals. | |
| 233 | # latex_appendices = [] | |
| 234 | ||
| 235 | # If false, no module index is generated. | |
| 236 | # latex_domain_indices = True | |
| 237 | ||
| 238 | ||
| 239 | # -- Options for manual page output --------------------------------------- | |
| 240 | ||
| 241 | # One entry per manual page. List of tuples | |
| 242 | # (source start file, name, description, authors, manual section). | |
| 243 | man_pages = [ | |
| 244 | ('index', 'cinder_tempest_pluginrereleasenotes', | |
| 245 | u'cinder_tempest_plugin Release Notes Documentation', | |
| 246 | [u'OpenStack Foundation'], 1) | |
| 247 | ] | |
| 248 | ||
| 249 | # If true, show URL addresses after external links. | |
| 250 | # man_show_urls = False | |
| 251 | ||
| 252 | ||
| 253 | # -- Options for Texinfo output ------------------------------------------- | |
| 254 | ||
| 255 | # Grouping the document tree into Texinfo files. List of tuples | |
| 256 | # (source start file, target name, title, author, | |
| 257 | # dir menu entry, description, category) | |
| 258 | texinfo_documents = [ | |
| 259 | ('index', 'cinder_tempest_plugin ReleaseNotes', | |
| 260 | u'cinder_tempest_plugin Release Notes Documentation', | |
| 261 | u'OpenStack Foundation', 'cinder_tempest_pluginReleaseNotes', | |
| 262 | 'One line description of project.', | |
| 263 | 'Miscellaneous'), | |
| 264 | ] | |
| 265 | ||
| 266 | # Documents to append as an appendix to all manuals. | |
| 267 | # texinfo_appendices = [] | |
| 268 | ||
| 269 | # If false, no module index is generated. | |
| 270 | # texinfo_domain_indices = True | |
| 271 | ||
| 272 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
| 273 | # texinfo_show_urls = 'footnote' | |
| 274 | ||
| 275 | # If true, do not generate a @detailmenu in the "Top" node's menu. | |
| 276 | # texinfo_no_detailmenu = False | |
| 277 | ||
| 278 | # -- Options for Internationalization output ------------------------------ | |
| 279 | locale_dirs = ['locale/'] |
| 0 | ============================================ | |
| 1 | cinder_tempest_plugin Release Notes | |
| 2 | ============================================ | |
| 3 | ||
| 4 | .. toctree:: | |
| 5 | :maxdepth: 1 | |
| 6 | ||
| 7 | unreleased |
| 0 | ============================== | |
| 1 | Current Series Release Notes | |
| 2 | ============================== | |
| 3 | ||
| 4 | .. release-notes:: |
| 0 | # The order of packages is significant, because pip processes them in the order | |
| 1 | # of appearance. Changing the order has an impact on the overall integration | |
| 2 | # process, which may cause wedges in the gate later. | |
| 3 | ||
| 4 | pbr>=2.0 # Apache-2.0 |
| 0 | [metadata] | |
| 1 | name = cinder_tempest_plugin | |
| 2 | summary = It contains tempest plugin tests for Cinder. | |
| 3 | description-file = | |
| 4 | README.rst | |
| 5 | author = OpenStack | |
| 6 | author-email = openstack-dev@lists.openstack.org | |
| 7 | home-page = http://www.openstack.org/ | |
| 8 | classifier = | |
| 9 | Environment :: OpenStack | |
| 10 | Intended Audience :: Information Technology | |
| 11 | Intended Audience :: System Administrators | |
| 12 | License :: OSI Approved :: Apache Software License | |
| 13 | Operating System :: POSIX :: Linux | |
| 14 | Programming Language :: Python | |
| 15 | Programming Language :: Python :: 2 | |
| 16 | Programming Language :: Python :: 2.7 | |
| 17 | Programming Language :: Python :: 3 | |
| 18 | Programming Language :: Python :: 3.3 | |
| 19 | Programming Language :: Python :: 3.4 | |
| 20 | ||
| 21 | [files] | |
| 22 | packages = | |
| 23 | cinder_tempest_plugin | |
| 24 | ||
| 25 | [build_sphinx] | |
| 26 | all-files = 1 | |
| 27 | warning-is-error = 1 | |
| 28 | source-dir = doc/source | |
| 29 | build-dir = doc/build | |
| 30 | ||
| 31 | [upload_sphinx] | |
| 32 | upload-dir = doc/build/html | |
| 33 | ||
| 34 | [compile_catalog] | |
| 35 | directory = cinder_tempest_plugin/locale | |
| 36 | domain = cinder_tempest_plugin | |
| 37 | ||
| 38 | [update_catalog] | |
| 39 | domain = cinder_tempest_plugin | |
| 40 | output_dir = cinder_tempest_plugin/locale | |
| 41 | input_file = cinder_tempest_plugin/locale/cinder_tempest_plugin.pot | |
| 42 | ||
| 43 | [extract_messages] | |
| 44 | keywords = _ gettext ngettext l_ lazy_gettext | |
| 45 | mapping_file = babel.cfg | |
| 46 | output_file = cinder_tempest_plugin/locale/cinder_tempest_plugin.pot | |
| 47 | ||
| 48 | [entry_points] | |
| 49 | tempest.test_plugins = | |
| 50 | cinder_tests = cinder.tests.tempest.plugin:CinderTempestPlugin |
| 0 | # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. | |
| 1 | # | |
| 2 | # Licensed under the Apache License, Version 2.0 (the "License"); | |
| 3 | # you may not use this file except in compliance with the License. | |
| 4 | # You may obtain a copy of the License at | |
| 5 | # | |
| 6 | # http://www.apache.org/licenses/LICENSE-2.0 | |
| 7 | # | |
| 8 | # Unless required by applicable law or agreed to in writing, software | |
| 9 | # distributed under the License is distributed on an "AS IS" BASIS, | |
| 10 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 11 | # implied. | |
| 12 | # See the License for the specific language governing permissions and | |
| 13 | # limitations under the License. | |
| 14 | ||
| 15 | # THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT | |
| 16 | import setuptools | |
| 17 | ||
| 18 | # In python < 2.7.4, a lazy loading of package `pbr` will break | |
| 19 | # setuptools if some other modules registered functions in `atexit`. | |
| 20 | # solution from: http://bugs.python.org/issue15881#msg170215 | |
| 21 | try: | |
| 22 | import multiprocessing # noqa | |
| 23 | except ImportError: | |
| 24 | pass | |
| 25 | ||
| 26 | setuptools.setup( | |
| 27 | setup_requires=['pbr'], | |
| 28 | pbr=True) |
| 0 | # The order of packages is significant, because pip processes them in the order | |
| 1 | # of appearance. Changing the order has an impact on the overall integration | |
| 2 | # process, which may cause wedges in the gate later. | |
| 3 | ||
| 4 | hacking>=0.12.0,<0.13 # Apache-2.0 | |
| 5 | ||
| 6 | coverage>=4.0,!=4.4 # Apache-2.0 | |
| 7 | python-subunit>=0.0.18 # Apache-2.0/BSD | |
| 8 | sphinx>=1.6.2 # BSD | |
| 9 | oslotest>=1.10.0 # Apache-2.0 | |
| 10 | testrepository>=0.0.18 # Apache-2.0/BSD | |
| 11 | testtools>=1.4.0 # MIT | |
| 12 | openstackdocstheme>=1.11.0 # Apache-2.0 | |
| 13 | # releasenotes | |
| 14 | reno>=1.8.0 # Apache-2.0 |
| 0 | [tox] | |
| 1 | minversion = 2.0 | |
| 2 | envlist = py34,py27,pypy,pep8 | |
| 3 | skipsdist = True | |
| 4 | ||
| 5 | [testenv] | |
| 6 | usedevelop = True | |
| 7 | install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages} | |
| 8 | setenv = | |
| 9 | VIRTUAL_ENV={envdir} | |
| 10 | PYTHONWARNINGS=default::DeprecationWarning | |
| 11 | deps = -r{toxinidir}/test-requirements.txt | |
| 12 | commands = python setup.py test --slowest --testr-args='{posargs}' | |
| 13 | ||
| 14 | [testenv:pep8] | |
| 15 | commands = flake8 {posargs} | |
| 16 | ||
| 17 | [testenv:venv] | |
| 18 | commands = {posargs} | |
| 19 | ||
| 20 | [testenv:cover] | |
| 21 | commands = python setup.py test --coverage --testr-args='{posargs}' | |
| 22 | ||
| 23 | [testenv:docs] | |
| 24 | commands = python setup.py build_sphinx | |
| 25 | ||
| 26 | [testenv:releasenotes] | |
| 27 | commands = | |
| 28 | sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html | |
| 29 | ||
| 30 | [testenv:debug] | |
| 31 | commands = oslo_debug_helper {posargs} | |
| 32 | ||
| 33 | [flake8] | |
| 34 | # E123, E125 skipped as they are invalid PEP-8. | |
| 35 | ||
| 36 | show-source = True | |
| 37 | ignore = E123,E125 | |
| 38 | builtins = _ | |
| 39 | exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build |