Merge pull request #779 from seleniumbase/db-overhaul

mdmintz · web-flow · commit 224e0197da5b · 2021-01-09T20:48:05.000-05:00
Renovate the MySQL DB system
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,11 +1,11 @@
 regex>=2020.11.13
-tqdm>=4.55.1
+tqdm>=4.55.2
 livereload==2.6.3;python_version>="3.6"
 Markdown==3.3.3
 readme-renderer==28.0
 pymdown-extensions==8.1
 mkdocs==1.1.2
-mkdocs-material==6.2.3
+mkdocs-material==6.2.4
 mkdocs-simple-hooks==0.1.2
 mkdocs-material-extensions==1.0.1
 mkdocs-minify-plugin==0.3.0
diff --git a/requirements.txt b/requirements.txt
@@ -41,7 +41,7 @@ pytest-rerunfailures==8.0;python_version<"3.5"
 pytest-rerunfailures==9.1.1;python_version>="3.5"
 pytest-xdist==1.34.0;python_version<"3.5"
 pytest-xdist==2.2.0;python_version>="3.5"
-parameterized==0.7.5
+parameterized==0.8.1
 soupsieve==1.9.6;python_version<"3.5"
 soupsieve==2.0.1;python_version>="3.5" and python_version<"3.6"
 soupsieve==2.1;python_version>="3.6"
@@ -66,7 +66,7 @@ pathlib2==2.3.5;python_version<"3.5"
 importlib-metadata==2.0.0;python_version<"3.6"
 virtualenv>=20.2.2
 pymysql==0.10.1;python_version<"3.6"
-pymysql==1.0.1;python_version>="3.6"
+pymysql==1.0.2;python_version>="3.6"
 coverage==5.3.1
 brython==3.9.1
 pyotp==2.4.1
@@ -76,7 +76,7 @@ toml==0.10.2
 Pillow==6.2.2;python_version<"3.5"
 Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"
 Pillow==8.1.0;python_version>="3.6"
-rich==9.6.2;python_version>="3.6" and python_version<"4.0"
+rich==9.7.0;python_version>="3.6" and python_version<"4.0"
 zipp==1.2.0;python_version<"3.6"
 zipp==3.4.0;python_version>="3.6"
 flake8==3.7.9;python_version<"3.5"
diff --git a/seleniumbase/__version__.py b/seleniumbase/__version__.py
@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.51.13"
+__version__ = "1.51.14"
diff --git a/seleniumbase/fixtures/base_case.py b/seleniumbase/fixtures/base_case.py
@@ -75,6 +75,7 @@ def __init__(self, *args, **kwargs):
         self.__last_page_screenshot_png = None
         self.__last_page_url = None
         self.__last_page_source = None
+        self.__skip_reason = None
         self.__added_pytest_html_extra = None
         self.__deferred_assert_count = 0
         self.__deferred_assert_failures = []
@@ -3283,9 +3284,13 @@ def set_time_limit(self, time_limit):
 
     def skip(self, reason=""):
         """ Mark the test as Skipped. """
-        if self.dashboard:
+        if self.dashboard or (self.is_pytest and self.with_db_reporting):
             test_id = self.__get_test_id_2()
             sb_config._results[test_id] = "Skipped"
+            self.__skip_reason = reason
+        elif reason and not self.is_pytest:
+            # Only needed for nosetest db reporting
+            self._nose_skip_reason = reason
         self.skipTest(reason)
 
     ############
@@ -6368,7 +6373,8 @@ def setUp(self, masterqa_mode=False):
                     self._testMethodName)
                 data_payload.env = application.split('.')[0]
                 data_payload.start_time = application.split('.')[1]
-                data_payload.state = constants.State.NOTRUN
+                data_payload.state = constants.State.UNTESTED
+                self.__skip_reason = None
                 self.testcase_manager.insert_testcase_data(data_payload)
                 self.case_start_time = int(time.time() * 1000)
             if self.headless:
@@ -6559,6 +6565,21 @@ def __set_last_page_source(self):
             except Exception:
                 self.__last_page_source = None
 
+    def __get_exception_info(self):
+        exc_message = None
+        if sys.version_info[0] >= 3 and hasattr(self, '_outcome') and (
+                hasattr(self._outcome, 'errors') and self._outcome.errors):
+            try:
+                exc_message = self._outcome.errors[0][1][1]
+            except Exception:
+                exc_message = "(Unknown Exception)"
+        else:
+            try:
+                exc_message = sys.last_value
+            except Exception:
+                exc_message = "(Unknown Exception)"
+        return str(exc_message)
+
     def __insert_test_result(self, state, err):
         from seleniumbase.core.testcase_manager import TestcaseDataPayload
         data_payload = TestcaseDataPayload()
@@ -6577,7 +6598,15 @@ def __insert_test_result(self, state, err):
             elif "Error: " in tb_string:
                 data_payload.message = tb_string.split("Error: ")[-1]
             else:
-                data_payload.message = "Unknown Error: See Stacktrace"
+                data_payload.message = self.__get_exception_info()
+        else:
+            test_id = self.__get_test_id_2()
+            if self.is_pytest and test_id in sb_config._results.keys() and (
+                    sb_config._results[test_id] == "Skipped"):
+                if self.__skip_reason:
+                    data_payload.message = "Skipped:   " + self.__skip_reason
+                else:
+                    data_payload.message = "Skipped:   (no reason given)"
         self.testcase_manager.update_testcase_data(data_payload)
 
     def __add_pytest_html_extra(self):
@@ -7023,9 +7052,16 @@ def tearDown(self):
                     self.display = None
             if self.with_db_reporting:
                 if has_exception:
-                    self.__insert_test_result(constants.State.ERROR, True)
+                    self.__insert_test_result(constants.State.FAILED, True)
                 else:
-                    self.__insert_test_result(constants.State.PASS, False)
+                    test_id = self.__get_test_id_2()
+                    if test_id in sb_config._results.keys() and (
+                            sb_config._results[test_id] == "Skipped"):
+                        self.__insert_test_result(
+                            constants.State.SKIPPED, False)
+                    else:
+                        self.__insert_test_result(
+                            constants.State.PASSED, False)
                 runtime = int(time.time() * 1000) - self.execution_start_time
                 self.testcase_manager.update_execution_data(
                     self.execution_guid, runtime)
diff --git a/seleniumbase/fixtures/constants.py b/seleniumbase/fixtures/constants.py
@@ -268,10 +268,10 @@ class Browser:
 
 
 class State:
-    NOTRUN = "NotRun"
+    PASSED = "Passed"
+    FAILED = "Failed"
+    SKIPPED = "Skipped"
+    UNTESTED = "Untested"
     ERROR = "Error"
-    FAILURE = "Fail"
-    PASS = "Pass"
-    SKIP = "Skip"
     BLOCKED = "Blocked"
     DEPRECATED = "Deprecated"
diff --git a/seleniumbase/fixtures/errors.py b/seleniumbase/fixtures/errors.py
@@ -1,8 +1,12 @@
 """
-SeleniumBase MySQL plugin-related exceptions.
+SeleniumBase MySQL-related exceptions.
+
+This feature is DEPRECATED!
+Use self.skip() for skipping tests!
+
 Raising one of these in a test will cause the
 test-state to be logged appropriately in the DB
-for tests that use the SeleniumBase MySQL plugin.
+for tests that use the SeleniumBase MySQL option.
 """
 
 
diff --git a/seleniumbase/plugins/db_reporting_plugin.py b/seleniumbase/plugins/db_reporting_plugin.py
@@ -30,6 +30,8 @@ def __init__(self):
         self.application = None
         self.testcase_manager = None
         self.error_handled = False
+        self._result_set = False
+        self._test = None
 
     def options(self, parser, env):
         super(DBReporting, self).options(parser, env=env)
@@ -77,61 +79,85 @@ def startTest(self, test):
         application = ApplicationManager.generate_application_string(test)
         data_payload.env = application.split('.')[0]
         data_payload.start_time = application.split('.')[1]
-        data_payload.state = constants.State.NOTRUN
+        data_payload.state = constants.State.UNTESTED
         self.testcase_manager.insert_testcase_data(data_payload)
         self.case_start_time = int(time.time() * 1000)
         # Make the testcase guid available to other plugins
         test.testcase_guid = self.testcase_guid
+        self._test = test
+        self._test._nose_skip_reason = None
 
     def finalize(self, result):
-        """ At the end of the run, we want to
-        update the DB row with the execution time. """
+        """ At the end of the test run, we want to
+            update the DB row with the total execution time. """
         runtime = int(time.time() * 1000) - self.execution_start_time
-        self.testcase_manager.update_execution_data(self.execution_guid,
-                                                    runtime)
+        self.testcase_manager.update_execution_data(
+            self.execution_guid, runtime)
+
+    def afterTest(self, test):
+        if not self._result_set:
+            err = None
+            try:
+                err = self._test._nose_skip_reason
+                if err:
+                    err = "Skipped:   " + str(err)
+                    err = (err, err)
+            except Exception:
+                pass
+            if not err:
+                err = "Skipped:   (no reason given)"
+                err = (err, err)
+            self.__insert_test_result(constants.State.SKIPPED, self._test, err)
 
     def addSuccess(self, test, capt):
         """
-        After test completion, we want to record testcase run information.
+        After each test success, record testcase run information.
         """
-        self.__insert_test_result(constants.State.PASS, test)
+        self.__insert_test_result(constants.State.PASSED, test)
+        self._result_set = True
+
+    def addFailure(self, test, err, capt=None, tbinfo=None):
+        """
+        After each test failure, record testcase run information.
+        """
+        self.__insert_test_result(constants.State.FAILED, test, err)
+        self._result_set = True
 
     def addError(self, test, err, capt=None):
         """
-        After a test error, we want to record testcase run information.
+        After each test error, record testcase run information.
+        (Test errors should be treated the same as test failures.)
         """
-        self.__insert_test_result(constants.State.ERROR, test, err)
+        self.__insert_test_result(constants.State.FAILED, test, err)
+        self._result_set = True
 
     def handleError(self, test, err, capt=None):
         """
-        After a test error, we want to record testcase run information.
+        After each test error, record testcase run information.
         "Error" also encompasses any states other than Pass or Fail, so we
         check for those first.
         """
         if err[0] == errors.BlockedTest:
             self.__insert_test_result(constants.State.BLOCKED, test, err)
+            self._result_set = True
             self.error_handled = True
             raise SkipTest(err[1])
             return True
 
         elif err[0] == errors.DeprecatedTest:
             self.__insert_test_result(constants.State.DEPRECATED, test, err)
+            self._result_set = True
             self.error_handled = True
             raise SkipTest(err[1])
             return True
 
         elif err[0] == errors.SkipTest:
-            self.__insert_test_result(constants.State.SKIP, test, err)
+            self.__insert_test_result(constants.State.SKIPPED, test, err)
+            self._result_set = True
             self.error_handled = True
             raise SkipTest(err[1])
             return True
 
-    def addFailure(self, test, err, capt=None, tbinfo=None):
-        """
-        After a test failure, we want to record testcase run information.
-        """
-        self.__insert_test_result(constants.State.FAILURE, test, err)
-
     def __insert_test_result(self, state, test, err=None):
         data_payload = TestcaseDataPayload()
         data_payload.runtime = int(time.time() * 1000) - self.case_start_time
diff --git a/setup.py b/setup.py
@@ -49,7 +49,7 @@
         print("\n*** Installing twine: *** (Required for PyPI uploads)\n")
         os.system("python -m pip install --upgrade 'twine>=1.15.0'")
         print("\n*** Installing tqdm: *** (Required for PyPI uploads)\n")
-        os.system("python -m pip install --upgrade 'tqdm>=4.55.1'")
+        os.system("python -m pip install --upgrade 'tqdm>=4.55.2'")
         print("\n*** Publishing The Release to PyPI: ***\n")
         os.system('python -m twine upload dist/*')  # Requires ~/.pypirc Keys
         print("\n*** The Release was PUBLISHED SUCCESSFULLY to PyPI! :) ***\n")
@@ -145,7 +145,7 @@
         'pytest-rerunfailures==9.1.1;python_version>="3.5"',
         'pytest-xdist==1.34.0;python_version<"3.5"',
         'pytest-xdist==2.2.0;python_version>="3.5"',
-        'parameterized==0.7.5',
+        'parameterized==0.8.1',
         'soupsieve==1.9.6;python_version<"3.5"',
         'soupsieve==2.0.1;python_version>="3.5" and python_version<"3.6"',
         'soupsieve==2.1;python_version>="3.6"',
@@ -170,7 +170,7 @@
         'importlib-metadata==2.0.0;python_version<"3.6"',  # Sync "virtualenv"
         'virtualenv>=20.2.2',  # Sync with importlib-metadata and pathlib2
         'pymysql==0.10.1;python_version<"3.6"',
-        'pymysql==1.0.1;python_version>="3.6"',
+        'pymysql==1.0.2;python_version>="3.6"',
         'coverage==5.3.1',
         'brython==3.9.1',
         'pyotp==2.4.1',
@@ -180,7 +180,7 @@
         'Pillow==6.2.2;python_version<"3.5"',
         'Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"',
         'Pillow==8.1.0;python_version>="3.6"',
-        'rich==9.6.2;python_version>="3.6" and python_version<"4.0"',
+        'rich==9.7.0;python_version>="3.6" and python_version<"4.0"',
         'zipp==1.2.0;python_version<"3.6"',
         'zipp==3.4.0;python_version>="3.6"',
         'flake8==3.7.9;python_version<"3.5"',

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# seleniumbase package`
`2`		`-__version__ = "1.51.13"`
	`2`	`+__version__ = "1.51.14"`