When Tempest is used in customer site, often we are required to
provide a testcase list including testcase names and descriptions.
Now no this kind of doc is available, so we can add descriptions
with the format of doc string for every testcase, so later we
can generata such a testcase description list.

There are hundreds of testcases missing descriptions, so we can
add them gradually, and limit the modified files in one patch
for the convenience of reviewing.

Change-Id: I20744e4957fbd5b039fdd52ac530f11ac6d72319
partially-implements: blueprint testcase-description

Chipping away at the referenced bug, this commit introduces a
class-level variable on BaseV2ComputeTest that triggers
setup_credentials to create a default network, and sets it for several
classes where the problem has been observed. The class variable is so we
can whack-a-mole with one line instead of four whenever this problem
pops up.

Change-Id: Ia34fe3b41261de02918713c2a948e6c56554bf6f
Partial-Bug: #1844568

As of the 12.0.0 Liberty release, the Nova libvirt driver
no longer honors a user-supplied device name, so better not
pass device when calling compute.base.attach_volume.
https://developer.openstack.org/api-ref/compute/#attach-a-volume-to-an-instance

NOTE: We still keep passing device in test_attach_detach_volume,
because it will ssh to vm to check the device name, in that case,
CONF.compute.volume_device_name must be set the equal value as
the libvirt auto-assigned one. Whether to remove that check
is out of the range of this patch.

Change-Id: I4483836abedab2550731fef5b2625282d7a2298d

services and extension decorators are based on CONF and needed by
Tempest only, so moving them to tempest.common.
Since a few plugnis use them today, use debtcollector to avoid
breaking all dependencies.

Change-Id: Ibd52153d00b8e60fb8c89e38d94e358ddc787251

The moved test classes inherit from an admin test class, and it
would be nice to exist under admin path like the other test classes.

NOTE: These test classes are not used from the other projects which
      include Defcore. It is not necessary to take care of this move.

Change-Id: I28b1acbb5b139614bd4f6a272410a4e4f1f989f7

This function waits for a volume resource to reach a given status.
The function is a common function for volume, snapshot and backup
resources.

Change-Id: I070a9f84b8b199df22765391482f7d69a5414db3

So many modules are using test.idempotent_id and this is for
switching to decorators.idempotent_id on compute.servers.

Change-Id: I6a7f8633b4808469dd92f2ac668674fba0bdb0ca
Related-Bug: #1616913

This changes the test_delete_server_while_in_attached_volume test
to re-use common volume create/attach methods in the base compute
API test class.

Note that this changes the volumes client used to create, get and
delete the volume. The test was previously using the proxy volumes
extension from the compute API which is now deprecated.

Change-Id: Ief13602a6764c3259a827d6d2a4c40436f04667a

shelve server logic has been duplicated many place and
also needed by more tests.

It better to make that a utils function and used from there.

Change-Id: I391f0bb92da1ddc76efcf026e8dea536edfd3706

Currently compute servers_client returns Response by
removing top key from Response.
For example-
 return service_client.ResponseBody(resp, body['server'])

As service clients are in direction to move to Tempest-lib, all
service clients should return Response without any truncation.
One good example is Resource pagination links which are lost with current
way of return value. Resource pagination links are present in parallel
(not inside) to top key of Response.

This patch makes compute servers_client to return
complete Response body.

Change-Id: I6a7b5c6144cafcb8f0780db01bf67999a4229389
Implements: blueprint method-return-value-and-move-service-clients-to-lib