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 63746daa93694dc6a11666d7b0539fe9c3422981.
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
The cli tests have been marked for removal for ~6 months and the
framework was the first thing included in tempest lib. There has
been more than enough time for all the projects to pick this up
in the client repos. So let's remove it all!
As part of this a couple of missing entries for tempest's
requirements.txt were found. These dependencies were being installed
by the clients so the fact they were missing was never noticed prior
to this. This commit also adds these missing entries back into the
requirements file.
Change-Id: I4f8638f1c048bbdb598dd181f4af272ef9923806
This patch fixes a typo in the last paragraph of the README file. Also
this file would sometimes use a capital T for Tempest and sometimes
not. This patch uniformly does capitalization across the file.
Change-Id: I8461e01de374ad487ed7f4af6beb35db921064d7
This commit makes several needed cleanups and improvements to the
tempest readme to make things clearer and elaborate on some sections.
Also as the readme is intended to be a tempest users guide, this moves
sections which are more developer focused to the hacking guide.
Change-Id: I4180ce18268443873fe7d8d5e7d0aaebc2cd1e08
This commit adds a few sentences to the end of the python 2.6 section
in the readme to clearly articulate that there is no python 2.6 in
tempest starting with kilo, and that patches to fix python 2.6 support
will be rejected.
Change-Id: I28b4714e35b84642be47961d3f51343450504db7
This commit adds a section to the README outlining that tempest tests
should only be added for stable APIs. If the API is tested the
expectation is that it complies with the API stability guidelines.
Change-Id: I02a93f66ff45e4d687b7395fb24ee5bda6e52fb0
This commit adds a section to the tempest README outlining some things
that have to be watched when pushing changes to tempest because of
branchless tempest
Change-Id: I9dbf042cef6af51c92d48d42ba04c1582690bda7
This commit adds a new section to the tempest README regarding python2.6
with tempest. It also outlines the steps required to enable testr with
python2.6.
Change-Id: I1603b24a9654ac5e71a54f63754d874cd39ce4da
This commit just fixes a couple of issues with the README file and adds
some details about the OS_TEST_PATH env variable and unit tests.
Closes-bug: #1268440
Change-Id: I17f75f7d7b3a2ac75eac884bc403bc46d6a2e77f
Closes-Bug: #1263885
By separating the negative tests, the README example has not been valid.
This commit fix this.
Change-Id: I299618bb9da63b47af17efbe4ea226ebf770f86a
This commit just adds some documentation around using the sample config
generator. It also adds a wrapper script that sets the env variable for
running the oslo generator script with tempest.
Change-Id: I860b17defeeb85174e68b1e8b046b0e43c30683b
One of the things we should make clear is what Tempest is, and what
it isn't at any point in time. This should be up front and center
in our README
Change-Id: I3b92c8afe7031630f97a4fb060bf7b555f1bb1c2
This commit just changes the references to nose in the project README
to testr. It also adds a sentence about using run_tests.sh and tox.
Change-Id: I7512b7f954c1c83186b1f428e9371261cf50f41b