This commit add PDF building tox.ini environment and options for LaTeX
output. overview.rst is copied from README.rst. And, the original
README.rst file is shrunk because we don't need such a long information
in the README file. People can see the same contents in overview.rst
now.
Change-Id: Id654c814988e78704726d2ba8bea9a03ce8596f8
This commit moves the execution explanation of tempest run to the
current(non-legacy) docs section. In the original section of the tox
jobs are "Legacy run method" which discourages to use it. However, we
don't do it yet so far. So, this commit would make it clearer for using
the tox jobs as a tempest runner.
Change-Id: Iec6a956cba6949d0f30b0d0297ed26487e892125
Thorough replacement of git.openstack.org and review.openstack.org URLs
with their opendev.org counterparts.
Change-Id: I88e894db7b854d32593c770f5aa9b8a91fad7866
This commit bumps up the python version to 3.6. This change encourages
developers to use our latest python version on unit tests.
Change-Id: I45d79c90939aa0f743750fec4b4e286f3679563b
While releasing new version in pypi, it perform the
validation on the package and give error if there is any
formatting issue.
README file is being used to upload on pypi and so validation
check fails[1] on current README due to 'ref' used for internal
doc link. Those links would not be available for outside the built doc.
This can be checked locally by:
python setup.py check -s -r
This commit fixes those format issue by removing the ref and provide the
external links.
Needed-By: https://review.openstack.org/#/c/592276/
[1] http://logs.openstack.org/76/592276/2/check/openstack-tox-validate/3623847/job-output.txt.gz#_2018-08-16_07_04_37_877872
Change-Id: I3e8bf5df2b1292725863065b7f3a9f9cca9adb75
This commit switches to stestr in README.rst and the method name. We
already switched to use stestr instead of testr/ostestr. However,
a few are still remaining in README.rst and the unit test name. This
patch leaves some `testr` things because they are for the 'legacy run
method'. So, we don't need to remove them completely.
Change-Id: I0e8e19e2150d6e0ce9a299a10bdd51652d86497e
py26 is dead for tempest so long it does not makes sense
to speak about py26 in the main README.rst anymore.
Change-Id: I2fc7c1d01751fb54292f8481a1b9f5a47530f1db
Reviewing the README.rst of tempest,
I noticed a wrong capitalization.
The word "Scenario" is capitalized when
instead it should be lower-case.
So I fix it.
Change-Id: I22208608e0b19df6da9d718e44499a1379ecd011
Add docs to elaborate on running a single test, running
all test in a file or use regular expressions to run any
matching tests.
Change-Id: I78f3a24e01b0f5e36c6edd76cc0579ba1e4f06cb
Most of them can still be visited through http, but the following
one is necessary to update, so I change them all by this chance.
$ git clone http://git.openstack.org/openstack/tempest
Change-Id: I2b4da0670b599666e7151bddfff0fa6655640bc4
This commit updates README.rst to use stestr instead of testr for unit
tests. The patch[1] for changing to use stestr was already merged. It's
good to change the document to use stestr instead of testr for the unit
test section at least.
[1] Iff4abef50178bdc83b868eed4a906e22d790762b
Change-Id: Ib6485d8281aaa5991188ea5c1ba9a6a4c827e8a6
In the file HACKING.rst and README.rst, there still left
some bad link. This change is to fix the doc link brought
by the doc migration.
Change-Id: I7a60a5821c199afb75a47ef24412470c16991d77
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
We need put a space between a param's name and a param's value in tox
and it would be more clear.
eg: from `tox -epy35` to `tox -e py35`.
Change-Id: I86750f42669bb02dcfac2b62e294d557bf44bd4c
This reverts commit 63746daa93.
The faulty docutils version was banned (thanks to global-requirements).
The ':remote:' tag broke our badge image, see [1], so remove the
':remote:' tag.
[1] https://github.com/openstack/tempest/blob/master/README.rst
Change-Id: I484d0ba00ad24936b5a9bf17a0c8942150754878
Now that we have a gating Python 3 job running on all tempest commits we
can update the language in the Readme about the Python 3 section. This
commit does just that.
Change-Id: I2a1d35cae6c28a0b427ffd142b8a3d2f25a6dbe7
This patch removes run_tempest.sh, run_tests.sh, tools/pretty_tox.sh
tools/pretty_tox_serial.sh. They all have been deprecated between 7 and
9 months ago.
As stated in the deprecation warnings, the way forward is with os-testr,
testr or stestr.
Change-Id: I35b6f8158f702594ed81ec2211d754395cfab937
Latest docutils complains about images that are not in the same repo
unless they are properly marked as `:remote:`.
Change-Id: Ic305813473eabbe1ab43a78fc767e0d80b097a07
The python 3.4 section in the readme was a bit dated since we now also
test on python 3.5. This commit attempts to update the wording to
explain that it's python >=3.4 not just 3.4.
Change-Id: I32ebe4c278b1d5e25cd87ca03f7de1a265334610
Release notes are managed on reno mechanism and the contents are
generated automatically on a link. So this patch adds the link for
users who are interested in Tempest versioning.
Change-Id: Ieef7310e1571a0a13832203670c61b5f77f0c3f3
The oslo config-generator-tempest.conf location is defined
as still being:
'etc/config-generator.tempest.conf'
But after the changes made in tempest-run-cmd bp the location
changed to:
'tempest/cmd/config-generator.tempest.conf'.
Change-Id: I53b0ab18a217eb186c51eb5a2e35489967fc5c55
Closes-Bug: #1606586
This commit deprecates run_tests.sh script and adds a deprecation
document. We don't pay attention this script actually however, I suppose
new people are coming and see the top of the directory and find this
script and try to use this. And if something wrong happens, we need to
ask and check 'which runner did you use?'. So I would like to reduce the
ways to execute unit tests.
Change-Id: Ia764fa3a15dc9faa753d4aca4c76462a8b9dd40b
This commit makes 3 updates to the README. First it adds a link to the
official documentation at the top of the README. We've had a number of
bugs filed where people think the docs are broken because github
doesn't understand sphinx directives in its rst rendering. Including
a link to the openstack hosted logs will make it clear that the docs
output is only via sphinx. The second cleanup is adding an internal
link to the tempest configuration guide in the quickstart. The
quickstart alludes to configuring tempest, but never actually provides
an explanation on how to do it. Adding the link to the configuration
guide should clear up any potential confusion. The last change here is
removing the external shield images from the readme. These raise sphinx
warnings (which we want to stop), and violate at least one distros
packaging process for questionable value.
Closes-Bug: #1589428
Change-Id: I0f797478624df704c03a00bc3fae89bfcea5799a
This commit updates the quickstart to reflect reality when using
tempest init. The quickstart documented our original ideal expectation
of how things worked, but because of python packaging limitations we
had to adjust it's behavior. However, the quickstart was never updated
to reflect this change.
Change-Id: Icbc0c005a344c25b7ab7d3fd059a9401747eca3f
Closes-Bug: #1598882
This commit cleans up some of the tempest quickstart to have a better
flow, use consistent terminology, and clean up some wording and
formatting.
Change-Id: I889cf6d4ba92adf3b8bf185265c5ce197009c998
This commit adds details for using tempest run to execute tempest tests
to the quickstart guide in the readme.
Partially-implements: bp tempest-run-cmd
Change-Id: I7c5b51e4f055424fa62b1b262b2d1c96918e46eb
The other places show "$" as command prompt.
So this patch changes different "$>" to "$" for consistent doc.
Change-Id: If8cf624bfabc96cda26ee0339f0eeec2aacafc2b
Previously, Tempest used openstack libraries like python-novaclient
on scenario tests. However, we have changed them to call REST API
instead of libraries calls. In addition, 3rd party tests(EC2) aslo
has been removed.
Then this patch fixes the doc.
Change-Id: Ieab08742edc67294a5b27efb8ff1fb4fd1890805
The command samples represent with "$" in most places.
So this patch adds it to some places.
And this patch changes the url to the official one.
Change-Id: I6f7a70e4e4b2fb74e08999cc1c8cf2f6d16fa43e
This commit adds pypi download and version badges into README.rst.
With these badges, users can know the latest version and download
statistics.
Change-Id: Ib9ec24ea82d478e44160a6d7f381d8c43a2dcbf5
This commit adds documentation for the library interface, formerly
known as tempest-lib, and the release versioning.
Partially implements bp tempest-lib-reintegration
Change-Id: I623222a17fe3563bbe767fa803e8f771a21687a1
With the introduction of tempest plugins we can now remove the third
party tests for the ec2 api using boto. They've always been the ugly
duckling in tempest (except that it never turned into a swan) where
they go against some of the fundamental principles of tempest tests.
For exaple, like having it's own client implementation, oh and testing
OpenStack APIs. This patch removes all the pieces of the third party
test dir and deprecates all the config options related to boto. A
plugin implementation is being worked [1] that can be used to fill
the coverage hole left by removing these from the tempest tree
[1] https://github.com/mtreinish/tempest_ec2
Change-Id: Ib5e24e19bcba9808a9f49fe7f328668df77fe4f9
Pip install tempest will install a package from pip source, not from
a dir,so change it to pip install tempest/
Also change some sentences to help understand
Change-Id: I034b3e94fc35db40bd7f7f68ab20cdcbcfddbc37
Init command was not working properly as it could not locate the
configuration sample file.
Steps taken:
- Move config-generator.tempest.conf to etc so it will be installed
with pbr.
- Update all files with new path to config-generator-tempest.conf as
needed.
- Refactor init command so if it detects we are not in a virtual
environment, try to find the global config directory /etc/tempest.
If that fails fallback to [sys.prefix]/etc/tempest.
Closes-Bug: #1491058
Closes-Bug: #1490670
Change-Id: I960bc711ff78ac2b0441ef63dff8ec4fb268fd3a
This commit fixes a few things in the tempest docs. First it fixes all
of the sphinx warnings and enables fail on warn to ensure we're using
valid sphinx everywhere. It also adds a link from the configuration
guide to the sample config file.
Change-Id: I3ad645a6bbfa46b4498e1732410743e46d6eb0cb
This commit updates the tempest README to document the new workflow
for running and interacting with tempest. The quickstart section is
used for this because that is where we were previously explaining how
to run tempest. The previous instructions for running tempest will
still work (and should always continue to work, we do not want to
break that usage model) so instead of being removed a new section at
the bottom of the README is added to document this, despite not being
the currently recommended workflow. Right now tempest run is excluded
from this doc, since more work needs to be done to figure out how
that will implemented.
Partially Implements: bp tempest-cli-improvements
Change-Id: Iced98b74b7ff651423fd1efa205dc0a4aaa28d5f
Change the description to
1."- Tempest should be self-testing."
2."The etc/tempest.conf.sample attempts to be a
self-documenting version of the configuration."
3."However, because large parts of Tempest
are self-verifying there might be uncaught
issues running on Python 3.4"
Closes-Bug: #1486904
Change-Id: Ic5a5446f62a3bfa7befb5ca9acbb577446faaba4
We're using oslo-config-generator to generate a config file other than
copy the tempest.config.sample. We should update the description in
qucikstart of README.rst.
Change-Id: I5c7c3f9041da3e5c3840b440bba6e614c23fdf8a
Closes-Bug: #1481635
This commit adds references explaining the current state of python 3.4
and tempest to the readme, pkg metadata, and adds an etry to the tox
envlist for running the unit tests on python 3.4.
Change-Id: I9c1e3cdf53dbae723a9fee67ad96932709d2305f
Masayuki Igawa