From 42bcb55faf0181d66380d58341a3be975480c8b7 Mon Sep 17 00:00:00 2001 From: zhufl Date: Mon, 17 Sep 2018 16:06:30 +0800 Subject: [PATCH] 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 --- HACKING.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index 5b9c0f1836..e767b253fe 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -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 example of this would be:: - class TestVolumeBootPattern(manager.ScenarioTest): - """ - This test case attempts to reproduce the following steps: + class TestServerBasicOps(manager.ScenarioTest): - * Create in Cinder some bootable volume importing a Glance image - * Boot an instance from the bootable volume - * Write content to the volume - * Delete an instance and Boot a new instance from the volume - * Check written content in the instance - * Create a volume snapshot while the instance is running - * Boot an additional instance from the new snapshot based volume - * Check written content in the instance booted from snapshot + """The test suite for server basic operations + + This smoke test case follows this basic set of operations: + * Create a keypair for use in launching an instance + * Create a security group to control network access in instance + * Add simple permissive rules to the security group + * Launch an instance + * Perform ssh to instance + * Verify metadata service + * Verify metadata on config_drive + * Terminate the instance """ Test Identification with Idempotent ID