Merge pull request #420 from rollbar/merge-pr419

Replace unittest2 with unittest
rollbar · Feb 24, 2023 · c3b6510 · c3b6510
2 parents b901726 + ebe4d3d
commit c3b6510
Show file tree

Hide file tree

Showing 28 changed files with 258 additions and 345 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/UPGRADE_FROM_RATCHET.md b/UPGRADE_FROM_RATCHET.md
diff --git a/default.nix b/default.nix
diff --git a/rollbar/test/__init__.py b/rollbar/test/__init__.py
@@ -1,13 +1,33 @@
-import unittest2
+import unittest
+import sys
 
 
 SNOWMAN = b'\xe2\x98\x83'
 SNOWMAN_UNICODE = SNOWMAN.decode('utf8')
 
 
-class BaseTest(unittest2.TestCase):
+class BaseTest(unittest.TestCase):
     pass
 
 
+class SkipAsyncTestLoader(unittest.TestLoader):
+    """
+    Python 2 does not have the async keyword, so when tests are run under python 2.7 the loader
+    will fail with a syntaxerror. This loader class does the following:
+    - try to load as normal
+    - if loading fails because of a syntax error in python < 3.4, skip the file.
+    """
+    def _get_module_from_name(self, name):
+        try:
+            return super(SkipAsyncTestLoader, self)._get_module_from_name(name)
+        except SyntaxError as e:
+            if sys.version_info < (3, 5):
+                return None
+            else:
+                raise
+
+
 def discover():
-    return unittest2.defaultTestLoader.discover(__name__)
+    loader = SkipAsyncTestLoader()
+    suite = loader.discover(__name__)
+    return suite
diff --git a/rollbar/test/asgi_tests/__init__.py b/rollbar/test/asgi_tests/__init__.py
@@ -1,9 +1,9 @@
 import sys
-import unittest2
+import unittest
 
 
 def _load_tests(loader, tests, pattern):
-    return unittest2.TestSuite()
+    return unittest.TestSuite()
 
 
 if sys.version_info < (3, 5):

diff --git a/rollbar/test/asgi_tests/test_integration.py b/rollbar/test/asgi_tests/test_integration.py
@@ -1,6 +1,12 @@
+import unittest
+import sys
+
 from rollbar.test import BaseTest
 
+ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 5)
+
 
+@unittest.skipUnless(ALLOWED_PYTHON_VERSION, 'ASGI implementation requires Python3.5+')
 class IntegrationTest(BaseTest):
     def test_should_integrate_if__integrate_defined(self):
         from rollbar.contrib.asgi.integration import IntegrationBase

diff --git a/rollbar/test/asgi_tests/test_middleware.py b/rollbar/test/asgi_tests/test_middleware.py
@@ -7,7 +7,7 @@
 except ImportError:
     import mock
 
-import unittest2
+import unittest
 
 import rollbar
 from rollbar.lib._async import AsyncMock
@@ -17,7 +17,7 @@
 ASYNC_REPORT_ENABLED = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(ALLOWED_PYTHON_VERSION, 'ASGI implementation requires Python3.5+')
+@unittest.skipUnless(ALLOWED_PYTHON_VERSION, 'ASGI implementation requires Python3.5+')
 class ReporterMiddlewareTest(BaseTest):
     default_settings = copy.deepcopy(rollbar.SETTINGS)
 
@@ -62,7 +62,7 @@ def test_should_add_framework_name_to_payload(self, mock_send_payload, *mocks):
 
         self.assertIn('asgi', payload['data']['framework'])
 
-    @unittest2.skipUnless(ASYNC_REPORT_ENABLED, 'Requires Python 3.6+')
+    @unittest.skipUnless(ASYNC_REPORT_ENABLED, 'Requires Python 3.6+')
     @mock.patch('rollbar.lib._async.report_exc_info', new_callable=AsyncMock)
     @mock.patch('rollbar.report_exc_info')
     def test_should_use_async_report_exc_info_if_default_handler(
@@ -81,7 +81,7 @@ def test_should_use_async_report_exc_info_if_default_handler(
         self.assertTrue(async_report_exc_info.called)
         self.assertFalse(sync_report_exc_info.called)
 
-    @unittest2.skipUnless(ASYNC_REPORT_ENABLED, 'Requires Python 3.6+')
+    @unittest.skipUnless(ASYNC_REPORT_ENABLED, 'Requires Python 3.6+')
     @mock.patch('rollbar.lib._async.report_exc_info', new_callable=AsyncMock)
     @mock.patch('rollbar.report_exc_info')
     def test_should_use_async_report_exc_info_if_any_async_handler(
@@ -100,7 +100,7 @@ def test_should_use_async_report_exc_info_if_any_async_handler(
         self.assertTrue(async_report_exc_info.called)
         self.assertFalse(sync_report_exc_info.called)
 
-    @unittest2.skipUnless(ASYNC_REPORT_ENABLED, 'Requires Python 3.6+')
+    @unittest.skipUnless(ASYNC_REPORT_ENABLED, 'Requires Python 3.6+')
     @mock.patch('logging.Logger.warning')
     @mock.patch('rollbar.lib._async.report_exc_info', new_callable=AsyncMock)
     @mock.patch('rollbar.report_exc_info')

diff --git a/rollbar/test/asgi_tests/test_spec.py b/rollbar/test/asgi_tests/test_spec.py
@@ -1,14 +1,14 @@
 import inspect
 import sys
 
-import unittest2
+import unittest
 
 from rollbar.test import BaseTest
 
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 5)
 
 
-@unittest2.skipUnless(ALLOWED_PYTHON_VERSION, 'ASGI implementation requires Python3.5+')
+@unittest.skipUnless(ALLOWED_PYTHON_VERSION, 'ASGI implementation requires Python3.5+')
 class ASGISpecTest(BaseTest):
     def test_asgi_v3_middleware_is_single_callable_coroutine(self):
         from rollbar.contrib.asgi import ReporterMiddleware

diff --git a/rollbar/test/async_tests/__init__.py b/rollbar/test/async_tests/__init__.py
@@ -1,9 +1,9 @@
 import sys
-import unittest2
+import unittest
 
 
 def _load_tests(loader, tests, pattern):
-    return unittest2.TestSuite()
+    return unittest.TestSuite()
 
 
 if sys.version_info < (3, 6):

diff --git a/rollbar/test/async_tests/test_async.py b/rollbar/test/async_tests/test_async.py
@@ -6,7 +6,7 @@
 except ImportError:
     import mock
 
-import unittest2
+import unittest
 
 import rollbar
 from rollbar.lib._async import AsyncMock
@@ -15,7 +15,7 @@
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(ALLOWED_PYTHON_VERSION, 'Async support requires Python3.6+')
+@unittest.skipUnless(ALLOWED_PYTHON_VERSION, 'Async support requires Python3.6+')
 class AsyncLibTest(BaseTest):
     default_settings = copy.deepcopy(rollbar.SETTINGS)
 

diff --git a/rollbar/test/fastapi_tests/__init__.py b/rollbar/test/fastapi_tests/__init__.py
@@ -1,9 +1,9 @@
 import sys
-import unittest2
+import unittest
 
 
 def _load_tests(loader, tests, pattern):
-    return unittest2.TestSuite()
+    return unittest.TestSuite()
 
 
 if sys.version_info < (3, 6):

diff --git a/rollbar/test/fastapi_tests/test_logger.py b/rollbar/test/fastapi_tests/test_logger.py
@@ -13,15 +13,15 @@
 except ImportError:
     FASTAPI_INSTALLED = False
 
-import unittest2
+import unittest
 
 import rollbar
 from rollbar.test import BaseTest
 
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     FASTAPI_INSTALLED and ALLOWED_PYTHON_VERSION,
     'FastAPI LoggerMiddleware requires Python3.6+',
 )

diff --git a/rollbar/test/fastapi_tests/test_middleware.py b/rollbar/test/fastapi_tests/test_middleware.py
@@ -14,7 +14,7 @@
 except ImportError:
     FASTAPI_INSTALLED = False
 
-import unittest2
+import unittest
 
 import rollbar
 from rollbar.lib._async import AsyncMock
@@ -23,7 +23,7 @@
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     FASTAPI_INSTALLED and ALLOWED_PYTHON_VERSION, 'FastAPI requires Python3.6+'
 )
 class ReporterMiddlewareTest(BaseTest):
@@ -258,7 +258,7 @@ async def root():
             'Failed to report asynchronously. Trying to report synchronously.'
         )
 
-    @unittest2.skipUnless(
+    @unittest.skipUnless(
         sys.version_info >= (3, 6), 'Global request access requires Python 3.6+'
     )
     @mock.patch('rollbar.contrib.starlette.middleware.store_current_request')
@@ -305,7 +305,7 @@ async def read_root():
         scope = store_current_request.call_args[0][0]
         self.assertDictContainsSubset(expected_scope, scope)
 
-    @unittest2.skipUnless(
+    @unittest.skipUnless(
         sys.version_info >= (3, 6), 'Global request access is supported in Python 3.6+'
     )
     def test_should_return_current_request(self):

diff --git a/rollbar/test/fastapi_tests/test_routing.py b/rollbar/test/fastapi_tests/test_routing.py
@@ -17,7 +17,7 @@
     FASTAPI_INSTALLED = False
     ALLOWED_FASTAPI_VERSION = False
 
-import unittest2
+import unittest
 
 import rollbar
 from rollbar.lib._async import AsyncMock
@@ -27,7 +27,7 @@
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     FASTAPI_INSTALLED and ALLOWED_PYTHON_VERSION, 'FastAPI requires Python3.6+'
 )
 class LoggingRouteUnsupportedFastAPIVersionTest(BaseTest):
@@ -64,10 +64,10 @@ def test_should_disable_loading_route_handler_if_fastapi_is_too_old(self):
         fastapi.__version__ = fastapi_version
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     FASTAPI_INSTALLED and ALLOWED_PYTHON_VERSION, 'FastAPI requires Python3.6+'
 )
-@unittest2.skipUnless(ALLOWED_FASTAPI_VERSION, 'FastAPI v0.41.0+ is required')
+@unittest.skipUnless(ALLOWED_FASTAPI_VERSION, 'FastAPI v0.41.0+ is required')
 class LoggingRouteTest(BaseTest):
     default_settings = copy.deepcopy(rollbar.SETTINGS)
 
@@ -686,7 +686,7 @@ def test_should_warn_if_middleware_in_use(self):
                     ' This can cause in duplicate occurrences.'
                 )
 
-    @unittest2.skipUnless(
+    @unittest.skipUnless(
         sys.version_info >= (3, 6), 'Global request access requires Python 3.6+'
     )
     @mock.patch('rollbar.contrib.fastapi.routing.store_current_request')
@@ -733,7 +733,7 @@ async def read_root():
         scope = store_current_request.call_args[0][0]
         self.assertDictContainsSubset(expected_scope, scope)
 
-    @unittest2.skipUnless(
+    @unittest.skipUnless(
         sys.version_info >= (3, 6), 'Global request access is supported in Python 3.6+'
     )
     def test_should_return_current_request(self):

diff --git a/rollbar/test/fastapi_tests/test_utils.py b/rollbar/test/fastapi_tests/test_utils.py
@@ -7,14 +7,14 @@
 except ImportError:
     FASTAPI_INSTALLED = False
 
-import unittest2
+import unittest
 
 from rollbar.test import BaseTest
 
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     FASTAPI_INSTALLED and ALLOWED_PYTHON_VERSION, 'FastAPI requires Python3.6+'
 )
 class UtilsMiddlewareTest(BaseTest):
@@ -66,7 +66,7 @@ def test_should_return_empty_list_if_rollbar_middlewares_not_installed(self):
         self.assertListEqual(middlewares, [])
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     FASTAPI_INSTALLED and ALLOWED_PYTHON_VERSION, 'FastAPI requires Python3.6+'
 )
 class UtilsBareRoutingTest(BaseTest):

diff --git a/rollbar/test/starlette_tests/__init__.py b/rollbar/test/starlette_tests/__init__.py
@@ -1,9 +1,9 @@
 import sys
-import unittest2
+import unittest
 
 
 def _load_tests(loader, tests, pattern):
-    return unittest2.TestSuite()
+    return unittest.TestSuite()
 
 
 if sys.version_info < (3, 6):

diff --git a/rollbar/test/starlette_tests/test_logger.py b/rollbar/test/starlette_tests/test_logger.py
@@ -13,15 +13,15 @@
 except ImportError:
     STARLETTE_INSTALLED = False
 
-import unittest2
+import unittest
 
 import rollbar
 from rollbar.test import BaseTest
 
 ALLOWED_PYTHON_VERSION = sys.version_info >= (3, 6)
 
 
-@unittest2.skipUnless(
+@unittest.skipUnless(
     STARLETTE_INSTALLED and ALLOWED_PYTHON_VERSION,
     'Starlette LoggerMiddleware requires Python3.6+',
 )