Fix docstring example in HACKING

I61ec91ba4a17c6797f1c626c9b09e4fdb381c357 moves scenario
docstring under the relevant test method, but the reference
to that docstring kept unchanged in HACKING.rst. Besides,
this is no longer a good example of "class level docstring",
so we just pick another one for the example.

Change-Id: I313da5627d283ec4771907d83c485db103fa2702
This commit is contained in:
zhufl 2018-09-17 16:06:30 +08:00
parent 3674fb1382
commit 42bcb55faf

View File

@ -349,18 +349,19 @@ is required. If there is more than one test case in the class individual
docstrings for the workflow in each test methods can be used instead. A good docstrings for the workflow in each test methods can be used instead. A good
example of this would be:: example of this would be::
class TestVolumeBootPattern(manager.ScenarioTest): class TestServerBasicOps(manager.ScenarioTest):
"""
This test case attempts to reproduce the following steps:
* Create in Cinder some bootable volume importing a Glance image """The test suite for server basic operations
* Boot an instance from the bootable volume
* Write content to the volume This smoke test case follows this basic set of operations:
* Delete an instance and Boot a new instance from the volume * Create a keypair for use in launching an instance
* Check written content in the instance * Create a security group to control network access in instance
* Create a volume snapshot while the instance is running * Add simple permissive rules to the security group
* Boot an additional instance from the new snapshot based volume * Launch an instance
* Check written content in the instance booted from snapshot * Perform ssh to instance
* Verify metadata service
* Verify metadata on config_drive
* Terminate the instance
""" """
Test Identification with Idempotent ID Test Identification with Idempotent ID