Add xtesting in upper-constraints.txt
[functest.git] / functest / tests / unit / core / test_testcase.py
index 5ff41cd..e11e5ff 100644 (file)
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 
-"""Define the classe required to fully cover testcase."""
+"""Define the class required to fully cover testcase."""
 
+from datetime import datetime
+import json
 import logging
+import os
 import unittest
 
+from functest.core import testcase
+
 import mock
+import requests
 
-from functest.core import testcase
 
 __author__ = "Cedric Ollivier <cedric.ollivier@orange.com>"
 
 
 class TestCaseTesting(unittest.TestCase):
-
     """The class testing TestCase."""
-    # pylint: disable=missing-docstring
 
-    logging.disable(logging.CRITICAL)
+    # pylint: disable=missing-docstring,too-many-public-methods
 
     _case_name = "base"
+    _project_name = "functest"
+    _published_result = "PASS"
+    _test_db_url = "http://testresults.opnfv.org/test/api/v1/results"
+    _headers = {'Content-Type': 'application/json'}
 
     def setUp(self):
-        self.test = testcase.TestCase(case_name=self._case_name)
-        self.test.project = "functest"
-        self.test.start_time = "1"
-        self.test.stop_time = "2"
-        self.test.criteria = "PASS"
+        self.test = testcase.TestCase(case_name=self._case_name,
+                                      project_name=self._project_name)
+        self.test.start_time = 1
+        self.test.stop_time = 2
+        self.test.result = 100
         self.test.details = {"Hello": "World"}
+        os.environ['TEST_DB_URL'] = TestCaseTesting._test_db_url
+        os.environ['INSTALLER_TYPE'] = "installer_type"
+        os.environ['DEPLOY_SCENARIO'] = "scenario"
+        os.environ['NODE_NAME'] = "node_name"
+        os.environ['BUILD_TAG'] = "foo-daily-master-bar"
 
     def test_run_unimplemented(self):
         self.assertEqual(self.test.run(),
                          testcase.TestCase.EX_RUN_ERROR)
 
-    @mock.patch('functest.utils.functest_utils.push_results_to_db',
-                return_value=False)
-    def _test_missing_attribute(self, mock_function=None):
+    def _test_pushdb_missing_attribute(self):
         self.assertEqual(self.test.push_to_db(),
                          testcase.TestCase.EX_PUSH_TO_DB_ERROR)
-        mock_function.assert_not_called()
 
-    def test_missing_project_name(self):
+    def test_pushdb_no_project_name(self):
         self.test.project_name = None
-        self._test_missing_attribute()
+        self._test_pushdb_missing_attribute()
 
-    def test_missing_case_name(self):
+    def test_pushdb_no_case_name(self):
         self.test.case_name = None
-        self._test_missing_attribute()
+        self._test_pushdb_missing_attribute()
 
-    def test_missing_criteria(self):
-        self.test.criteria = None
-        self._test_missing_attribute()
-
-    def test_missing_start_time(self):
+    def test_pushdb_no_start_time(self):
         self.test.start_time = None
-        self._test_missing_attribute()
+        self._test_pushdb_missing_attribute()
 
-    def test_missing_stop_time(self):
+    def test_pushdb_no_stop_time(self):
         self.test.stop_time = None
-        self._test_missing_attribute()
+        self._test_pushdb_missing_attribute()
 
-    @mock.patch('functest.utils.functest_utils.push_results_to_db',
-                return_value=True)
-    def test_missing_details(self, mock_function=None):
-        self.test.details = None
-        self.assertEqual(self.test.push_to_db(),
-                         testcase.TestCase.EX_OK)
-        mock_function.assert_called_once_with(
-            self.test.project, self._case_name, self.test.start_time,
-            self.test.stop_time, self.test.criteria, self.test.details)
-
-    @mock.patch('functest.utils.functest_utils.push_results_to_db',
-                return_value=False)
-    def test_push_to_db_failed(self, mock_function=None):
+    def _test_pushdb_missing_env(self, var):
+        del os.environ[var]
         self.assertEqual(self.test.push_to_db(),
                          testcase.TestCase.EX_PUSH_TO_DB_ERROR)
+
+    def test_pushdb_no_db_url(self):
+        self._test_pushdb_missing_env('TEST_DB_URL')
+
+    def test_pushdb_no_installer_type(self):
+        self._test_pushdb_missing_env('INSTALLER_TYPE')
+
+    def test_pushdb_no_deploy_scenario(self):
+        self._test_pushdb_missing_env('DEPLOY_SCENARIO')
+
+    def test_pushdb_no_node_name(self):
+        self._test_pushdb_missing_env('NODE_NAME')
+
+    def test_pushdb_no_build_tag(self):
+        self._test_pushdb_missing_env('BUILD_TAG')
+
+    @mock.patch('requests.post')
+    def test_pushdb_bad_start_time(self, mock_function=None):
+        self.test.start_time = "1"
+        self.assertEqual(
+            self.test.push_to_db(),
+            testcase.TestCase.EX_PUSH_TO_DB_ERROR)
+        mock_function.assert_not_called()
+
+    @mock.patch('requests.post')
+    def test_pushdb_bad_end_time(self, mock_function=None):
+        self.test.stop_time = "2"
+        self.assertEqual(
+            self.test.push_to_db(),
+            testcase.TestCase.EX_PUSH_TO_DB_ERROR)
+        mock_function.assert_not_called()
+
+    def _get_data(self):
+        return {
+            "build_tag": os.environ['BUILD_TAG'],
+            "case_name": self._case_name,
+            "criteria": 'PASS' if self.test.is_successful(
+                ) == self.test.EX_OK else 'FAIL',
+            "details": self.test.details,
+            "installer": os.environ['INSTALLER_TYPE'],
+            "pod_name": os.environ['NODE_NAME'],
+            "project_name": self.test.project_name,
+            "scenario": os.environ['DEPLOY_SCENARIO'],
+            "start_date": datetime.fromtimestamp(
+                self.test.start_time).strftime('%Y-%m-%d %H:%M:%S'),
+            "stop_date": datetime.fromtimestamp(
+                self.test.stop_time).strftime('%Y-%m-%d %H:%M:%S'),
+            "version": "master"}
+
+    @mock.patch('requests.post')
+    def _test_pushdb_version(self, mock_function=None, **kwargs):
+        payload = self._get_data()
+        payload["version"] = kwargs.get("version", "unknown")
+        self.assertEqual(self.test.push_to_db(), testcase.TestCase.EX_OK)
         mock_function.assert_called_once_with(
-            self.test.project, self._case_name, self.test.start_time,
-            self.test.stop_time, self.test.criteria, self.test.details)
+            os.environ['TEST_DB_URL'],
+            data=json.dumps(payload, sort_keys=True),
+            headers=self._headers)
 
-    @mock.patch('functest.utils.functest_utils.push_results_to_db',
-                return_value=True)
-    def test_push_to_db(self, mock_function=None):
-        self.assertEqual(self.test.push_to_db(),
-                         testcase.TestCase.EX_OK)
+    def test_pushdb_daily_job(self):
+        self._test_pushdb_version(version="master")
+
+    def test_pushdb_weekly_job(self):
+        os.environ['BUILD_TAG'] = 'foo-weekly-master-bar'
+        self._test_pushdb_version(version="master")
+
+    def test_pushdb_random_build_tag(self):
+        os.environ['BUILD_TAG'] = 'whatever'
+        self._test_pushdb_version(version="unknown")
+
+    @mock.patch('requests.post', return_value=mock.Mock(
+        raise_for_status=mock.Mock(
+            side_effect=requests.exceptions.HTTPError)))
+    def test_pushdb_http_errors(self, mock_function=None):
+        self.assertEqual(
+            self.test.push_to_db(),
+            testcase.TestCase.EX_PUSH_TO_DB_ERROR)
         mock_function.assert_called_once_with(
-            self.test.project, self._case_name, self.test.start_time,
-            self.test.stop_time, self.test.criteria, self.test.details)
+            os.environ['TEST_DB_URL'],
+            data=json.dumps(self._get_data(), sort_keys=True),
+            headers=self._headers)
 
     def test_check_criteria_missing(self):
         self.test.criteria = None
-        self.assertEqual(self.test.check_criteria(),
+        self.assertEqual(self.test.is_successful(),
+                         testcase.TestCase.EX_TESTCASE_FAILED)
+
+    def test_check_result_missing(self):
+        self.test.result = None
+        self.assertEqual(self.test.is_successful(),
+                         testcase.TestCase.EX_TESTCASE_FAILED)
+
+    def test_check_result_failed(self):
+        # Backward compatibility
+        # It must be removed as soon as TestCase subclasses
+        # stop setting result = 'PASS' or 'FAIL'.
+        self.test.result = 'FAIL'
+        self.assertEqual(self.test.is_successful(),
                          testcase.TestCase.EX_TESTCASE_FAILED)
 
-    def test_check_criteria_failed(self):
-        self.test.criteria = 'FAILED'
-        self.assertEqual(self.test.check_criteria(),
+    def test_check_result_pass(self):
+        # Backward compatibility
+        # It must be removed as soon as TestCase subclasses
+        # stop setting result = 'PASS' or 'FAIL'.
+        self.test.result = 'PASS'
+        self.assertEqual(self.test.is_successful(),
+                         testcase.TestCase.EX_OK)
+
+    def test_check_result_lt(self):
+        self.test.result = 50
+        self.assertEqual(self.test.is_successful(),
                          testcase.TestCase.EX_TESTCASE_FAILED)
 
-    def test_check_criteria_pass(self):
-        self.test.criteria = 'PASS'
-        self.assertEqual(self.test.check_criteria(),
+    def test_check_result_eq(self):
+        self.test.result = 100
+        self.assertEqual(self.test.is_successful(),
+                         testcase.TestCase.EX_OK)
+
+    def test_check_result_gt(self):
+        self.test.criteria = 50
+        self.test.result = 100
+        self.assertEqual(self.test.is_successful(),
                          testcase.TestCase.EX_OK)
 
+    def test_check_result_zero(self):
+        self.test.criteria = 0
+        self.test.result = 0
+        self.assertEqual(self.test.is_successful(),
+                         testcase.TestCase.EX_TESTCASE_FAILED)
+
+    def test_get_duration_start_ko(self):
+        self.test.start_time = None
+        self.assertEqual(self.test.get_duration(), "XX:XX")
+        self.test.start_time = 0
+        self.assertEqual(self.test.get_duration(), "XX:XX")
+
+    def test_get_duration_end_ko(self):
+        self.test.stop_time = None
+        self.assertEqual(self.test.get_duration(), "XX:XX")
+        self.test.stop_time = 0
+        self.assertEqual(self.test.get_duration(), "XX:XX")
+
+    def test_get_invalid_duration(self):
+        self.test.start_time = 2
+        self.test.stop_time = 1
+        self.assertEqual(self.test.get_duration(), "XX:XX")
+
+    def test_get_zero_duration(self):
+        self.test.start_time = 2
+        self.test.stop_time = 2
+        self.assertEqual(self.test.get_duration(), "00:00")
+
+    def test_get_duration(self):
+        self.test.start_time = 1
+        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("<functest.core.testcase.TestCase object at",
+                      str(self.test))
+
+    def test_str_case_name_ko(self):
+        self.test.case_name = None
+        self.assertIn("<functest.core.testcase.TestCase object at",
+                      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)
+
+    def test_clean(self):
+        self.assertEqual(self.test.clean(), None)
+
 
 if __name__ == "__main__":
+    logging.disable(logging.CRITICAL)
     unittest.main(verbosity=2)