Remove few refercences left to tempest-lib
A few places in docs / comments still refer to tempest-lib. Cleaning those up. Change-Id: I6a15a6e7e58a49a39b3955c60e16d0c196ec154c
This commit is contained in:
parent
b0c99df35b
commit
1370bafda0
@ -16,7 +16,7 @@ Tempest Specific Commandments
|
|||||||
- [T107] Check that a service tag isn't in the module path
|
- [T107] Check that a service tag isn't in the module path
|
||||||
- [T108] Check no hyphen at the end of rand_name() argument
|
- [T108] Check no hyphen at the end of rand_name() argument
|
||||||
- [T109] Cannot use testtools.skip decorator; instead use
|
- [T109] Cannot use testtools.skip decorator; instead use
|
||||||
decorators.skip_because from tempest-lib
|
decorators.skip_because from tempest.lib
|
||||||
- [T110] Check that service client names of GET should be consistent
|
- [T110] Check that service client names of GET should be consistent
|
||||||
- [T111] Check that service client names of DELETE should be consistent
|
- [T111] Check that service client names of DELETE should be consistent
|
||||||
- [T112] Check that tempest.lib should not import local tempest code
|
- [T112] Check that tempest.lib should not import local tempest code
|
||||||
@ -333,9 +333,9 @@ format of the metadata looks like::
|
|||||||
# The created server should be in the detailed list of all servers
|
# The created server should be in the detailed list of all servers
|
||||||
...
|
...
|
||||||
|
|
||||||
Tempest-lib includes a ``check-uuid`` tool that will test for the existence
|
Tempest.lib includes a ``check-uuid`` tool that will test for the existence
|
||||||
and uniqueness of idempotent_id metadata for every test. If you have
|
and uniqueness of idempotent_id metadata for every test. If you have
|
||||||
tempest-lib installed you run the tool against Tempest by calling from the
|
tempest installed you run the tool against Tempest by calling from the
|
||||||
tempest repo::
|
tempest repo::
|
||||||
|
|
||||||
check-uuid
|
check-uuid
|
||||||
|
@ -7,15 +7,14 @@ Tempest provides a stable library interface that provides external tools or
|
|||||||
test suites an interface for reusing pieces of tempest code. Any public
|
test suites an interface for reusing pieces of tempest code. Any public
|
||||||
interface that lives in tempest/lib in the tempest repo is treated as a stable
|
interface that lives in tempest/lib in the tempest repo is treated as a stable
|
||||||
public interface and it should be safe to external consume that. Every effort
|
public interface and it should be safe to external consume that. Every effort
|
||||||
goes into maintaining backwards compatibility with any change. Just as with
|
goes into maintaining backwards compatibility with any change.
|
||||||
tempest-lib the library is self contained and doesn't have any dependency on
|
The library is self contained and doesn't have any dependency on
|
||||||
other tempest internals outside of lib. (including no usage of tempest
|
other tempest internals outside of lib (including no usage of tempest
|
||||||
configuration)
|
configuration).
|
||||||
|
|
||||||
Stability
|
Stability
|
||||||
---------
|
---------
|
||||||
Just as tempest-lib before it any code that lives in tempest/lib will be treated
|
Any code that lives in tempest/lib will be treated as a stable interface.
|
||||||
as a stable interface, nothing has changed in regards to interface stability.
|
|
||||||
This means that any public interface under the tempest/lib directory is
|
This means that any public interface under the tempest/lib directory is
|
||||||
expected to be a stable interface suitable for public consumption. However, for
|
expected to be a stable interface suitable for public consumption. However, for
|
||||||
any interfaces outside of tempest/lib in the tempest tree (unless otherwise
|
any interfaces outside of tempest/lib in the tempest tree (unless otherwise
|
||||||
|
@ -11,13 +11,13 @@ Creating a plugin
|
|||||||
=================
|
=================
|
||||||
|
|
||||||
Creating a plugin is fairly straightforward and doesn't require much additional
|
Creating a plugin is fairly straightforward and doesn't require much additional
|
||||||
effort on top of creating a test suite using tempest-lib. One thing to note with
|
effort on top of creating a test suite using tempest.lib. One thing to note with
|
||||||
doing this is that the interfaces exposed by tempest are not considered stable
|
doing this is that the interfaces exposed by tempest are not considered stable
|
||||||
(with the exception of configuration variables which ever effort goes into
|
(with the exception of configuration variables which ever effort goes into
|
||||||
ensuring backwards compatibility). You should not need to import anything from
|
ensuring backwards compatibility). You should not need to import anything from
|
||||||
tempest itself except where explicitly noted. If there is an interface from
|
tempest itself except where explicitly noted. If there is an interface from
|
||||||
tempest that you need to rely on in your plugin it likely needs to be migrated
|
tempest that you need to rely on in your plugin it likely needs to be migrated
|
||||||
to tempest-lib. In that situation, file a bug, push a migration patch, etc. to
|
to tempest.lib. In that situation, file a bug, push a migration patch, etc. to
|
||||||
expedite providing the interface in a reliable manner.
|
expedite providing the interface in a reliable manner.
|
||||||
|
|
||||||
Plugin Cookiecutter
|
Plugin Cookiecutter
|
||||||
@ -102,11 +102,6 @@ you would do something like the following::
|
|||||||
Then you need to ensure you locally define all of the methods in the abstract
|
Then you need to ensure you locally define all of the methods in the abstract
|
||||||
class, you can refer to the api doc below for a reference of what that entails.
|
class, you can refer to the api doc below for a reference of what that entails.
|
||||||
|
|
||||||
Also, note eventually this abstract class will likely live in tempest-lib, when
|
|
||||||
that migration occurs a deprecation shim will be added to tempest so as to not
|
|
||||||
break any existing plugins. But, when that occurs migrating to using tempest-lib
|
|
||||||
as the source for the abstract class will be prudent.
|
|
||||||
|
|
||||||
Abstract Plugin Class
|
Abstract Plugin Class
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ CONF = config.CONF
|
|||||||
|
|
||||||
"""This module provides factories of credential and credential providers
|
"""This module provides factories of credential and credential providers
|
||||||
|
|
||||||
Credentials providers and clients are (going to be) part of tempest-lib,
|
Credentials providers and clients are (going to be) part of tempest.lib,
|
||||||
and so they may not hold any dependency to tempest configuration.
|
and so they may not hold any dependency to tempest configuration.
|
||||||
|
|
||||||
Methods in this module collect the relevant configuration details and pass
|
Methods in this module collect the relevant configuration details and pass
|
||||||
|
@ -1147,7 +1147,7 @@ baremetal_group = cfg.OptGroup(name='baremetal',
|
|||||||
'shelve, snapshot, and suspend')
|
'shelve, snapshot, and suspend')
|
||||||
|
|
||||||
|
|
||||||
# NOTE(deva): Ironic tests have been ported to tempest-lib. New config options
|
# NOTE(deva): Ironic tests have been ported to tempest.lib. New config options
|
||||||
# should be added to ironic/ironic_tempest_plugin/config.py.
|
# should be added to ironic/ironic_tempest_plugin/config.py.
|
||||||
# However, these options need to remain here for testing stable
|
# However, these options need to remain here for testing stable
|
||||||
# branches until Liberty release reaches EOL.
|
# branches until Liberty release reaches EOL.
|
||||||
|
@ -116,7 +116,7 @@ class ServerUnreachable(TempestException):
|
|||||||
|
|
||||||
|
|
||||||
# NOTE(andreaf) This exception is added here to facilitate the migration
|
# NOTE(andreaf) This exception is added here to facilitate the migration
|
||||||
# of get_network_from_name and preprov_creds to tempest-lib, and it should
|
# of get_network_from_name and preprov_creds to tempest.lib, and it should
|
||||||
# be migrated along with them
|
# be migrated along with them
|
||||||
class InvalidTestResource(TempestException):
|
class InvalidTestResource(TempestException):
|
||||||
message = "%(name) is not a valid %(type), or the name is ambiguous"
|
message = "%(name) is not a valid %(type), or the name is ambiguous"
|
||||||
|
@ -141,7 +141,7 @@ def no_testtools_skip_decorator(logical_line):
|
|||||||
"""
|
"""
|
||||||
if TESTTOOLS_SKIP_DECORATOR.match(logical_line):
|
if TESTTOOLS_SKIP_DECORATOR.match(logical_line):
|
||||||
yield (0, "T109: Cannot use testtools.skip decorator; instead use "
|
yield (0, "T109: Cannot use testtools.skip decorator; instead use "
|
||||||
"decorators.skip_because from tempest-lib")
|
"decorators.skip_because from tempest.lib")
|
||||||
|
|
||||||
|
|
||||||
def _common_service_clients_check(logical_line, physical_line, filename,
|
def _common_service_clients_check(logical_line, physical_line, filename,
|
||||||
|
Loading…
Reference in New Issue
Block a user