Define create_snapshot() and clean() in TestCase

They replace the former calls in run_tests which are not suitable for all
test cases. Now any test case can define how to clean its resources.

If the snapshot cannot be created, the test case is considered as
failed. Only a message is printed if any failure during cleaning.

It also defines a new class called OSGCTestCase useful for test cases
which don't clean their OpenStack resources.
All test cases located in opnfv_tests/openstack inherit from it to
keep the global behavior unchanged.

It also deletes exit instructions in openstack_clean and
openstack_snapshot, removes clean flags in testcases.yaml and updates
the related utils.

All Docs are modified as well.

JIRA: FUNCTEST-438

Change-Id: I8938e6255708012380389763a24059ace4ce45d8
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

2 files changed, 8 insertions, 7 deletions

diff --git a/functest/utils/openstack_clean.py b/functest/utils/openstack_clean.py
index 29106d9ed..cdd918521 100755
--- a/functest/utils/openstack_clean.py
+++ b/functest/utils/openstack_clean.py
@@ -22,9 +22,9 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 #
 
-import time
-
 import logging
+import sys
+import time
 import yaml
 
 import functest.utils.openstack_utils as os_utils
@@ -392,7 +392,7 @@ def main():
     except Exception:
         logger.info("The file %s does not exist. The OpenStack snapshot must"
                     " be created first. Aborting cleanup." % OS_SNAPSHOT_FILE)
-        exit(0)
+        return 0
 
     default_images = snapshot_yaml.get('images')
     default_instances = snapshot_yaml.get('instances')
@@ -407,7 +407,7 @@ def main():
     if not os_utils.check_credentials():
         logger.error("Please source the openrc credentials and run "
                      "the script again.")
-        exit(-1)
+        return -1
 
     remove_instances(nova_client, default_instances)
     separator()
@@ -429,4 +429,4 @@ def main():
 
 if __name__ == '__main__':
     logging.basicConfig()
-    main()
+    sys.exit(main())
diff --git a/functest/utils/openstack_snapshot.py b/functest/utils/openstack_snapshot.py
index 952fb7bbb..8f1d3b9b2 100755
--- a/functest/utils/openstack_snapshot.py
+++ b/functest/utils/openstack_snapshot.py
@@ -22,6 +22,7 @@
 
 import logging
 import yaml
+import sys
 
 import functest.utils.openstack_utils as os_utils
 from functest.utils.constants import CONST
@@ -139,7 +140,7 @@ def main():
     if not os_utils.check_credentials():
         logger.error("Please source the openrc credentials and run the" +
                      "script again.")
-        exit(-1)
+        return -1
 
     snapshot = {}
     snapshot.update(get_instances(nova_client))
@@ -163,4 +164,4 @@ def main():
 
 if __name__ == '__main__':
     logging.basicConfig()
-    main()
+    sys.exit(main())