Add docstrings, unit tests and an helper for class resource
cleanup. Check super's resource_cleanup is invoked when
overriden to ensure the cleanup stack is processed.
Change-Id: I9c89ba4efd715634dde6b1182c2025ddf9c2f7d2
This commit fixes the warning "Title level inconsistent". And the module
API docs should be shown up.
Change-Id: Ie9a3656b0a58300d611352d054868440f0ffd387
This commit moves the data directory under doc/source directory. The
data directory have only tempest-plugins-registry.header which is only
used for documentation. So, this change makes it clearer for the meaning
of the directory.
Change-Id: I73059707cb45bb241128662fbd7a48747332ea7f
1) Update doc links according to OpenStack document migration
2) Use https instead of http for docs links
Change-Id: I56ee6a1aa8fd63c336849affb8d6aff5c9e66e9e
Add unit tests for credentials_factory and mark it stable for
plugins. This is part of the work to make tempest/test.py stable
for plugins.
Change-Id: I99414cb2704ce5469fcb66406b6905e2d1871dba
compute microversion 2.52, and 2.53 are not implemented
in Tempest and should not be added in doc also.
Those were added in Icc43342e4b64f415593700cb5ab19156a5d2bc19
Change-Id: I8bdd32adcb2bb775099db3a8b8af3832a4025d96
This commit adds some better documentation with an example explaining
how to use the credential providers now in tempest/lib.
Change-Id: I9f6856645094d483f7a3f0f76a40568c28c4e9b1
This commit migrates the preprovisioned credentials provider from
tempest/common into tempest/lib. As part of this 2 dependencies are
also migrated to lib: the InvalidTestResource exception class and the
tempest.common.fixed_network module.
Change-Id: Ib9e909aaaf81f7cb57e2382cec44598e918747b8
This commit adds a flag to generate a tempest plugin list. In a local
environment, we don't need to generate a tempest plugin list, always
when we just need to see the other documents. Besides, generating the
tempest plugin list takes a long time. When GENERATE_TEMPEST_PLUGIN_LIST
environment variable is 'true'(default), the plugin list is created.
When the other value such as 'false' is specified, it isn't.
Change-Id: I6fd3cb3045ba8bbfb39c597413e13faa3cd24ae3
I've been reading our entire documentation to see where it could
be improved. It's guide good actually. While reading I've fixed
some typos, added some capitalization to project names, mostly
trivial stuff.
What's worth reviewing is the 2 paragraphs I added to the REVIEWING
guidelines.
Change-Id: I977de335119f4ff7b9aedcfbed31c264ed531ea8
This commit removes 'html_use_smartypants' config in the doc conf.py.
The config option is already deprecated. And we don't need it in the
quoted double-dashes.
Change-Id: I1884abdb6bcab606879f4d90d604fdf2dee78c7d
Existing instance diagnostics tests were moved to the new files
to test diagnostics for different microversions (2.1 and 2.48).
Depends-On: If0b1493cc5c1c7f0d9896dd68342ad4dea4f7da2
Change-Id: I7757c5beeea3d3b0bc15a51cafc5ea2ada65e76c
This microversion changes flavor property in server response.
New test case was added to do not overload some other testcase
by running all tests for two microversions (v2.1 and v2.47)
Also method create_test_server was modified. Now it adds field
'network' into request if microversion >= v2.37 because since
this microversion this field is required.
Change-Id: If7420d0c6153fe63c049c0f6dc9a748968d40315
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: If9104f4b56cd22fed87c596f990350ea877d83b6
Closes-Bug:#1693670
This commit fixes minor header wordings which were mentioned in the
previous patch review[1].
[1] Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4
Change-Id: I4db09bda5628371186e3548143c59d0841fcb7b0
After I2601433585740030ab61433f0e8ca1a919275d9f is merged,
the exception description of auth_version is no longer
true, this is to remove it.
Change-Id: I5f9d8fb852faa92708158fca7d7bc7f5ac2fd933
Read-only property 'os' has moved to 'os_primary' in version 'Pike'
and will be removed in version 'Queens', so this is to replace
the usage of 'os' with 'os_primary'.
Change-Id: I9f7c13da05a8c4a63529c11aa6213a7269abee6d
This commit updates the document theme. It is clear, simple, up-to-date
and beautiful. And this commit also updates section headers to fix the
document index.
Change-Id: Ia1e8e16e5f5ddb06e4c4ccb4979b0750b88a4db4
It could be confusing to new comers that the variables
cls.os and cls.os_primary or cls.alt_manager and cls.os_alt
actually are aliases. Besides we are not consistent in their usage.
This patch normalizes the usage around os_admin, os_primary and
os_alt. We keep the old aliases for compatibility but we should not
use them anymore.
This fix a long standing TODO item.
Change-Id: I5f7164f7a7ec5d4380ca22885000caa0183a0bf7
During ATL PTG, we discussed about the testing
of API microversions in Tempest and what all
tests can be implemented on Tempest side.
This patch adds those consensus in doc to clarify
about microversion testing scope.
Change-Id: Ifbaa66dba932a7472010bddf11545d66b95ba42e
This commit adds documentation on how to interact with clients, client
managers, and credentials objects. These are critical pieces of
information for anyone writing tempest tests, so making sure the guide
includes this information is equally important.
Change-Id: I89e2c137068eea8aeaff0561fe078eccd3a23f0e
This commit fixes the top level header for the write_tests doc.
Previously, the doc title was set as the same as the section. This
caused things like table of contents to confuse the hierarchy of the
sections in the docs. This commit fixes that by setting the doc title
to be a higher lever in the hierarchy.
Change-Id: I2ecb110c766a71e1dc2d9e663ca38ece76dc327d
All other rst files don't contain "-" in the file names instead of '_'.
This patch renames test-removal.rst for consistent format on rst files.
TrivialFix
Change-Id: I229870baa1954e1f6b2277318ae5bae332f660ad
This commit is the start of a new doc guide for helping people figure
out how to write good tempest tests. This is just a starting point for
the document and doesn't cover every aspect of writing a test case in
tempest. Right now it just covers the setupClass phase for writing
TestCases. It will be expanded upon in future commits to give a complete
guide to writing tests in Tempest.
Change-Id: Ie0db2079163f536ae72668c8fc9129ae4c6389e2
