Commit Graph

18 Commits

Author SHA1 Message Date
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
deepak_mourya
e495cd257d trivial: Fix typos in the documentation page
This patchset fixes typos (capitalization mistakes,
grammar mistakes) found in the documentation pages.

Change-Id: If500aeab1af7dd8b56d63cbc481ee501216df161
2018-07-18 08:39:27 +00:00
zhufl
e9241b5d89 Fix a missing preposition in plugin doc
In "While there are no hard and fast rules for the structure a plugin"
a preposition is missing between "structure" and "a plugin", this is
to fix it.

Change-Id: Ib22f614dece35d2ed79fa660027e50840e77d7bb
2017-12-06 15:41:08 +08:00
Andrea Frittoli
bf142fc3d8 Make test.py and clients.py as stable for plugins
test.py and clients.py now only depend on stable
interfaces and can be marked stable for plugins.

Previous patches added unit tests and docstrings
for most methods.

Change-Id: I22cb1a7744d2310f9b70769e136803a607217ceb
2017-10-23 17:51:32 +02:00
Andrea Frittoli
17347f0eff Mark credentials_factory stable for plugins
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
2017-08-08 22:26:07 +01:00
Matthew Treinish
e8ab5f9b08
Add tempest test writing guide
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
2017-04-03 11:53:35 -04:00
Yushiro FURUKAWA
836361de95 Add 'code-block' and revise tab
This commit inserts '.. code-block::' and revises tab to 4 spaces.

Change-Id: Ic36444f101cc8a560c1cfa67dffdf64956c2bb99
2016-09-30 23:35:31 +09:00
Hironori Shiina
91049ad85d Fix a few grammatical errors in docs
This patch fixes a few grammatical errors in documentation.

Change-Id: I5aa92537165aa452649f71e94d6d569011b78fa4
2016-09-28 17:28:49 +09:00
Andrea Frittoli (andreaf)
e07579c603 Migrate service_clients to tempest.lib
Migrate the service_clients module to tempest.lib.services.clients.
Migrate related unit tests as well.

The clients module atm imports plugin.py from Tempest which is not
allowed via hacking to avoid cirtular dependencies.
If there is no way around this, I will have to remove the self
registration of the service clients from plugins, and ask the
plugins to do the registration themselves - which is a pity. Ideas?

Change-Id: I40e3478f69af62a7cdc14fa65ed21dcfbbe10e72
2016-08-05 16:23:26 +01:00
Kiall Mac Innes
9e6f974110 Document tempest APIs which plugins may use
Plugin authors can have a hard time determining which APIs are acceptable
to use, and which are not. We should provide an explicit list on the
plugin interface doc page.

Change-Id: I475a8ccc568077a4824fda0ddc20606a0ffabbc7
2016-05-23 16:20:55 +01:00
Andrea Frittoli (andreaf)
1370bafda0 Remove few refercences left to tempest-lib
A few places in docs / comments still refer to tempest-lib.
Cleaning those up.

Change-Id: I6a15a6e7e58a49a39b3955c60e16d0c196ec154c
2016-04-29 20:30:34 +00:00
Matthew Treinish
00686f2fda
Add note a section to lib doc about where to put plugins
This commit adds a subsection to the creating a plugin section in the
plugin doc that tries to strongly advocate creating a separate python
package for tempest plugins for various reasons. This will hopefully
steer potential plugin authors towards doing this.

Change-Id: Id3c06381c0d8e79f59e50486a3c10b12bb977c51
2016-03-11 18:15:07 -05:00
Yuiko Takada
ccb2bbf465 Add installation procedure of cookiecutter to doc
Currently, in Usage, there is no installation procedure of cookiecutter.
This patch set adds installation procedure of cookiecutter to README.rst

Change-Id: Ief3a1fdab945c1df834b219fadadf8d2b5d824a4
2015-11-17 10:12:12 +09:00
Marc Koderer
66210aa05f Add plugin cookiecutter in documentation
Since we have a official cookiecutter project we should
rely on it in the documentation. All titles are moved a bit
since only the usage of the cookiecutter and the entry point
is needed to create a working test project. All other information
is just additional and not mandatory for plugin creation.

Change-Id: Ia04d2ea747f19d7b1d272bd7664ff05f61c7c88c
2015-10-26 10:52:32 +01:00
YAMAMOTO Takashi
cb2ac6eeb8 plugin.rst: Fix a typo in an example code fragment
Change-Id: Ib003702533397a2f0f3efc68f75662cad2208301
2015-10-19 15:54:42 +09:00
Matthew Treinish
9392a83fdc
Add plugin docs section on configuration options
This commit adds a subsubsection to the plugin interface docs to
elaborate a bit on how to deal with configuration options. Previously,
how to use them in a plugin was implied, but nothing was explicitly
stated. This corrects that to make it clear on how to deal with
configuration.

Change-Id: Id3afc9657c5419cfba61acb3c84ccfea104d1b20
2015-08-24 10:33:47 -04:00
Matthew Treinish
3a851dc08b
Add plugin interface documentation
This commit starts the docs section on creating and using tempest
plugins. It describes how to create a plugin class, an entrypoint, and
a recommended dir structure. As well notes how to use tempest and
tempest-lib in creating a plugin. It'll likely be expanded in the
future as the plugin interface evolves.

Partially Implements bp external-plugin-interface

Change-Id: If2e0c47d0a719d869a3301ddbca07495c81cc498
2015-08-04 12:31:59 -04:00