Implement TestCase __str__()

It's designed to be called by run_tests.py when printing the results of
test cases and when generating the global report.

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

3 files changed, 50 insertions, 3 deletions

diff --git a/functest/ci/run_tests.py b/functest/ci/run_tests.py
index ae002c2e..1396644f 100755
--- a/functest/ci/run_tests.py
+++ b/functest/ci/run_tests.py
@@ -155,6 +155,7 @@ def run_test(test, tier_name, testcases=None):
                     test_case.push_to_db()
                 result = test_case.is_successful()
             duration = test_case.get_duration()
+            logger.info("\n%s\n", test_case)
         except ImportError:
             logger.exception("Cannot import module {}".format(
                 run_dict['module']))
@@ -167,8 +168,6 @@ def run_test(test, tier_name, testcases=None):
     if test.needs_clean() and GlobalVariables.CLEAN_FLAG:
         cleanup()
 
-    logger.info("Test execution time: %s", duration)
-
     if result != testcase.TestCase.EX_OK:
         logger.error("The test case '%s' failed. " % test_name)
         GlobalVariables.OVERALL_RESULT = Result.EX_ERROR
diff --git a/functest/core/testcase.py b/functest/core/testcase.py
index 62465542..b220a587 100644
--- a/functest/core/testcase.py
+++ b/functest/core/testcase.py
@@ -43,6 +43,21 @@ class TestCase(object):
         self.start_time = ""
         self.stop_time = ""
 
+    def __str__(self):
+        try:
+            assert self.project_name
+            assert self.case_name
+            result = 'PASS' if(self.is_successful(
+                ) == TestCase.EX_OK) else 'FAIL'
+            return ('| {0:<23} | {1:<13} | {2:<10} | {3:<13} |'
+                    '\n{4:-<26}{4:-<16}{4:-<13}{4:-<16}{4}'.format(
+                        self.case_name, self.project_name,
+                        self.get_duration(), result, '+'))
+        except AssertionError:
+            self.__logger.error("We cannot print invalid objects")
+            return '| {0:^68} |\n{1:-<26}{1:-<16}{1:-<13}{1:-<16}{1}'.format(
+                'INVALID OBJECT', '+')
+
     def get_duration(self):
         """Return the duration of the test case.
 
@@ -57,7 +72,7 @@ class TestCase(object):
                 return "XX:XX"
             return "{0[0]:02.0f}:{0[1]:02.0f}".format(divmod(
                 self.stop_time - self.start_time, 60))
-        except Exception:
+        except Exception:  # pylint: disable=broad-except
             self.__logger.error("Please run test before getting the duration")
             return "XX:XX"
 
diff --git a/functest/tests/unit/core/test_testcase.py b/functest/tests/unit/core/test_testcase.py
index 17329ea3..b25ce226 100644
--- a/functest/tests/unit/core/test_testcase.py
+++ b/functest/tests/unit/core/test_testcase.py
@@ -189,6 +189,39 @@ class TestCaseTesting(unittest.TestCase):
         self.test.stop_time = 180
         self.assertEqual(self.test.get_duration(), "02:59")
 
+    def test_str_project_name_ko(self):
+        self.test.project_name = None
+        self.assertIn("INVALID OBJECT", str(self.test))
+
+    def test_str_case_name_ko(self):
+        self.test.case_name = None
+        self.assertIn("INVALID OBJECT", str(self.test))
+
+    def test_str_pass(self):
+        duration = '01:01'
+        with mock.patch.object(self.test, 'get_duration',
+                               return_value=duration), \
+                mock.patch.object(self.test, 'is_successful',
+                                  return_value=testcase.TestCase.EX_OK):
+            message = str(self.test)
+        self.assertIn(self._project_name, message)
+        self.assertIn(self._case_name, message)
+        self.assertIn(duration, message)
+        self.assertIn('PASS', message)
+
+    def test_str_fail(self):
+        duration = '00:59'
+        with mock.patch.object(self.test, 'get_duration',
+                               return_value=duration), \
+                mock.patch.object(
+                    self.test, 'is_successful',
+                    return_value=testcase.TestCase.EX_TESTCASE_FAILED):
+            message = str(self.test)
+        self.assertIn(self._project_name, message)
+        self.assertIn(self._case_name, message)
+        self.assertIn(duration, message)
+        self.assertIn('FAIL', message)
+
 
 if __name__ == "__main__":
     unittest.main(verbosity=2)