77 Commits

Author SHA1 Message Date
Martin Kopec
d76178e682 General doc updates
Added missing doc, for example for serial tests, fixed 404 links,
spellings, formatting and etc

Change-Id: I07a8cf9508d3cba33bd04afdc301bb7145153d59
2024-01-31 09:00:16 +01:00
Masayuki Igawa
7e4ef4c823
Add PDF building
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
2019-09-11 16:42:28 +09:00
Masayuki Igawa
80105b7c54
Move tox execution to current docs section
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
2019-06-05 19:12:15 +09:00
caoyuan
349ba75410 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org and review.openstack.org URLs
with their opendev.org counterparts.

Change-Id: I88e894db7b854d32593c770f5aa9b8a91fad7866
2019-05-23 10:19:31 +00:00
sunqingliang6
8606c83b4b change http links to https links
Change-Id: I9875b8db497129baebadc8e74cf602ea1c063cbd
2018-11-09 14:26:19 +08:00
Masayuki Igawa
80d30b8178
Bump up python version of unit test
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
2018-09-03 17:25:49 +09:00
Zuul
78818b7dc8 Merge "Switch to stestr in README.rst and the method name" 2018-08-24 08:45:38 +00:00
ghanshyam
8316f962c5 Fix python pkg format issue
One issue left from below fix
https://review.openstack.org/#/c/592308/

This commit fixes the issue for Tempest
release - https://review.openstack.org/#/c/592276/

Change-Id: I2c7d6c0a3c0fd2755a5adbbed3fac4a7bcb7720b
2018-08-16 12:13:02 +00:00
ghanshyam
3662499105 Fix 'ref' format errors in README file
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
2018-08-16 08:47:38 +00:00
Masayuki Igawa
ac0b171b73 Switch to stestr in README.rst and the method name
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
2018-07-15 14:55:05 +00:00
Attila Fazekas
010c0b080b Remove python 2.6 docref
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
2018-05-31 13:39:15 +02:00
Chang Liu
98cf467c58 Fix a capitalization mistake in README.rst
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
2018-04-02 09:38:37 +08:00
melissaml
fa64e6f520 Update links in README
Change the outdated links to the latest links in README

Change-Id: I3c427e8799b443eeca8a17d7cbd3051eb738ed1e
2018-03-10 23:16:25 +08:00
junboli
9e25a57ebe Add docs for running a single test
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
2017-11-23 00:06:10 +08:00
davyyy
ac670dce6d Update URL from "http" to "https"
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
2017-11-16 21:55:52 +08:00
Masayuki Igawa
ebe46989b0
Update README to use stestr instead of testr for unit tests
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
2017-10-11 18:21:47 +09:00
junboli
477fd02fb8 doc migration: update the doc link address
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
2017-09-06 17:25:11 +08:00
Jenkins
c7a403debd Merge "Doc: fix markups, capitalization and add 2 REVIEWING advices" 2017-07-22 01:47:46 +00:00
chenxing
e98720a22f Update the documention for doc migration
Change-Id: Ie6d322d1b9c93118af7c74986993010b9f4b76b2
2017-07-19 03:42:23 +00:00
Jordan Pittier
74a56aba03 Doc: fix markups, capitalization and add 2 REVIEWING advices
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
2017-07-11 20:26:32 +02:00
Hai Shi
6f52fc599a [DOC] Fix details of tox
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
2017-04-07 00:47:00 +00:00
zhufl
5eccdf45a3 Fix typo in README.rst
This is to fix a typo in README.rst

Change-Id: I31fbfc98994ca5137b1999f45beb94b345ae1b08
2017-03-16 10:08:18 +08:00
Jordan Pittier
d597b95a3f Revert "Docs: Add the remote tag to the badge image"
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
2017-03-14 09:24:48 +00:00
Matthew Treinish
a60fe389de Update README section on Python3 support
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
2017-03-03 15:57:42 +00:00
Jordan Pittier
27ca251dab Remove deprecated test runner wrappers (.sh files)
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
2017-02-22 20:21:43 +01:00
Jordan Pittier
63746daa93 Docs: Add the remote tag to the badge image
Latest docutils complains about images that are not in the same repo
unless they are properly marked as `:remote:`.

Change-Id: Ic305813473eabbe1ab43a78fc767e0d80b097a07
2016-12-09 17:16:51 +01:00
Flavio Percoco
3d2dac7709 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/03d435554251cadd770793c055cf592f\n'

Change-Id: I2982952d85bf9fc2f25cb37092c8568315c24685
2016-11-25 13:48:23 +01:00
Matthew Treinish
315aa21943
Fix wording for python3.4 section in the readme
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
2016-10-13 17:35:47 -04:00
Yushiro FURUKAWA
e4b18ad7c9 Add prefix "$" for command examples
This commit adds "$" for command examples as a prefix and aligns indent.

Change-Id: I7f2f2e4d8caa68e9e053b6af552911904f1aa8f8
2016-09-27 16:54:39 +09:00
Ken'ichi Ohmichi
7f5e1d70bc Add a release note link on README
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
2016-08-29 13:23:38 -07:00
Erickson Santos
7d274ed9b8 Fix README
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
2016-07-26 14:22:30 +00:00
Masayuki Igawa
afb1143147 Deprecate run_tests.sh
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
2016-07-23 00:52:15 +00:00
Matthew Treinish
dced423202
Fix minor details in README
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
2016-07-05 14:31:57 -04:00
Matthew Treinish
531b01c017
Update quickstart for revised temepst init setup
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
2016-07-05 11:25:26 -04:00
Matthew Treinish
ab77cbfb72
Cleanup tempest quickstart
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
2016-07-01 15:15:43 -04:00
Matthew Treinish
85c8e3e60d
Add basic tempest run instructions to the quickstart
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
2016-06-30 19:41:36 -04:00
Ken'ichi Ohmichi
dcf55a0cee Change "$>" to "$" as CLI prompt
The other places show "$" as command prompt.
So this patch changes different "$>" to "$" for consistent doc.

Change-Id: If8cf624bfabc96cda26ee0339f0eeec2aacafc2b
2016-06-01 19:57:14 -07:00
Ken'ichi Ohmichi
b824990749 Fix Tempest testing way on the doc
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
2016-06-01 18:12:13 -07:00
Ken'ichi Ohmichi
9883ff2777 Make README.rst consistent
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
2016-04-22 18:30:25 -07:00
Masayuki Igawa
b5d32937dd Add pypi download + version badges into README.rst
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
2016-03-25 12:46:43 +09:00
Matthew Treinish
55511d98f1
Add documentation for the library interface
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
2016-02-29 15:35:26 -05:00
Matthew Treinish
42d69512d9
Remove the ec2 api tests from tempest
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
2015-12-17 17:59:20 -05:00
OctopusZhang
03b8900d29 change some sentences to help understand
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
2015-11-13 09:38:28 +08:00
David Paterson
0bf52d497b Fix init command
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
2015-09-23 09:42:07 -04:00
Matthew Treinish
f45ba2e604
Cleanup tempest docs a bit
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
2015-09-02 11:06:44 -04:00
Jenkins
0a7a8e59ad Merge "Update the Tempest README for new run workflow" 2015-08-28 00:49:09 +00:00
Matthew Treinish
828734a120
Update the Tempest README for new run workflow
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
2015-08-24 10:25:54 -04:00
zhangfeng
c53e4e1286 Fix misspelling in the "README.rst"
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
2015-08-21 10:26:26 +00:00
Shuquan Huang
06c632b985 Fix the way to get tempest.conf in README.rst
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
2015-08-05 10:18:39 +00:00
Atsushi SAKAI
0a183b8c6a Fix two typos on tempest documentation
specifing => specifying
secion => section

Change-Id: Ie5c2ddb03586c780e4f338ba9dd2a8adbf824c6e
Closes-Bug: #1478941
2015-07-28 21:53:11 +09:00