Fix [H405] pep rule in heat_integrationtests
Implements bp docstring-improvements
Change-Id: I7aebbdafef121c3414e6a0260452c1353af62e88
diff --git a/common/clients.py b/common/clients.py
index daba708..9718d03 100644
--- a/common/clients.py
+++ b/common/clients.py
@@ -23,7 +23,8 @@
class ClientManager(object):
- """
+ """Provides access to the official python clients for calling various APIs.
+
Manager that provides access to the official python clients for
calling various OpenStack APIs.
"""
diff --git a/common/exceptions.py b/common/exceptions.py
index 5132850..b092fd0 100644
--- a/common/exceptions.py
+++ b/common/exceptions.py
@@ -12,8 +12,7 @@
class IntegrationException(Exception):
- """
- Base Tempest Exception
+ """Base Tempest Exception.
To correctly use this class, inherit from it and define
a 'message' property. That message will get printf'd
diff --git a/common/remote_client.py b/common/remote_client.py
index c8c4f95..201b10f 100644
--- a/common/remote_client.py
+++ b/common/remote_client.py
@@ -88,8 +88,7 @@
return (time.time() - self.timeout) > start_time
def exec_command(self, cmd):
- """
- Execute the specified command on the server.
+ """Execute the specified command on the server.
Note that this method is reading whole command outputs to memory, thus
shouldn't be used for large outputs.
@@ -170,8 +169,9 @@
return self.ssh_client.exec_command(cmd)
def validate_authentication(self):
- """Validate ssh connection and authentication
- This method raises an Exception when the validation fails.
+ """Validate ssh connection and authentication.
+
+ This method raises an Exception when the validation fails.
"""
self.ssh_client.test_connection_auth()
diff --git a/common/test.py b/common/test.py
index 4f3d923..8d8fa15 100644
--- a/common/test.py
+++ b/common/test.py
@@ -35,7 +35,8 @@
def call_until_true(duration, sleep_for, func, *args, **kwargs):
- """
+ """Call the function until it returns True or the duration elapsed.
+
Call the given function until it returns True (and return True) or
until the specified duration (in seconds) elapses (and return
False).
@@ -281,8 +282,7 @@
def _wait_for_stack_status(self, stack_identifier, status,
failure_pattern=None,
success_on_not_found=False):
- """
- Waits for a Stack to reach a given status.
+ """Waits for a Stack to reach a given status.
Note this compares the full $action_$status, e.g
CREATE_COMPLETE, not just COMPLETE which is exposed