Enable integration test debugging (#69)

- moved integration_testing to tests/integration/host
- moved gradle files to root so that commands can be run in the project
root
- moved unit_testing to test/unit
- can debug via pycharm or vscode
- generate a pytest report after each run
- logs show up in the console and the test report
- add ability to use pytest filters to select tests
- add ability to filter out test configurations with cluster sizes that
do not match an existing cluster

Author: congoamz

Diff for: .github/workflows/integration_tests.yml

@@ -45,7 +45,6 @@ jobs:
           echo "TEMP_AWS_SESSION_TOKEN=${creds[2]}" >> $GITHUB_ENV
 
       - name: 'Run Integration Tests'
-        working-directory: ${{ github.workspace }}/integration_testing
         run: |
           ./gradlew --no-parallel --no-daemon test-all-environments --info
         env:
@@ -54,3 +53,11 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ env.TEMP_AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ env.TEMP_AWS_SECRET_ACCESS_KEY }}
           AWS_SESSION_TOKEN: ${{ env.TEMP_AWS_SESSION_TOKEN }}
+
+      - name: 'Archive results'
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: pytest-integration-report
+          path: ./tests/integration/container/reports
+          retention-days: 5

Diff for: .github/workflows/main.yml

@@ -45,4 +45,4 @@ jobs:
       - name: Run isort - dependency import sorting check
         run: poetry run isort --check-only .
       - name: Run unit tests
-        run: poetry run python -m pytest ./unit_testing -Werror
+        run: poetry run pytest ./tests/unit -Werror

Diff for: .gitignore

@@ -36,7 +36,7 @@ MANIFEST
 pip-log.txt
 pip-delete-this-directory.txt
 
-# Unit test / coverage reports
+# Testing / coverage reports
 htmlcov/
 .tox/
 .nox/
@@ -50,6 +50,8 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+tests/integration/container/reports
+tests/integration/host/bin
 
 # Translations
 *.mo
@@ -155,6 +157,5 @@ cython_debug/
 .idea/
 .vs/
 .gradle/
-
 **/.gradle
-integration_testing/bin
+

Diff for: .vscode/launch.json

@@ -0,0 +1,30 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Debug test file",
+      "type": "python",
+      "request": "launch",
+      "module": "pytest",
+      "args": [
+        "${file}"
+      ],
+      "justMyCode": false
+    },
+    {
+      "name": "Attach",
+      "type": "python",
+      "request": "attach",
+      "pathMappings": [
+        {
+          "localRoot": "${workspaceFolder}",
+          "remoteRoot": "/app"
+        }
+      ],
+      "connect": {
+        "host": "localhost",
+        "port": 5005
+      }
+    }
+  ]
+}

Diff for: .vscode/settings.json

@@ -3,7 +3,7 @@
     "python.linting.enabled": true,
     "python.linting.flake8Enabled": true,
     "python.testing.autoTestDiscoverOnSaveEnabled": true,
-    "python.testing.cwd": "${workspaceFolder}/unit_testing",
-    "python.testing.unittestEnabled": true,
-    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.cwd": "${workspaceFolder}/tests/unit"
 }

Diff for: aws_wrapper/__init__.py

@@ -12,8 +12,9 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-from logging import DEBUG, Formatter, Handler, StreamHandler, getLogger
+from logging import DEBUG, Handler, getLogger
 
+from .utils.utils import LogUtils
 from .wrapper import AwsWrapperConnection
 
 # PEP249 compliance
@@ -24,17 +25,7 @@
 
 
 def set_logger(name='aws_wrapper', level=DEBUG, format_string=None):
-    if format_string is None:
-        format_string = \
-            "%(asctime)s.%(msecs)03d %(name)-12s:%(funcName)s [%(levelname)-8s] - %(threadName)s - %(message)s"
-
-    handler = StreamHandler()
-    handler.setFormatter(Formatter(format_string))
-    handler.setLevel(level)
-
-    logger = getLogger(name)
-    logger.setLevel(level)
-    logger.addHandler(handler)
+    LogUtils.setup_logger(getLogger(name), level, format_string)
 
 
 class NullHandler(Handler):

Diff for: aws_wrapper/host_list_provider.py

@@ -38,7 +38,7 @@
 from aws_wrapper.utils.rds_url_type import RdsUrlType
 from aws_wrapper.utils.rdsutils import RdsUtils
 from aws_wrapper.utils.timeout import timeout
-from aws_wrapper.utils.utils import Utils
+from aws_wrapper.utils.utils import LogUtils
 
 logger = getLogger(__name__)
 
@@ -344,15 +344,15 @@ def refresh(self, connection: Optional[Connection] = None) -> Tuple[HostInfo, ..
         self._initialize()
         connection = connection if connection else self._host_list_provider_service.current_connection
         topology = self._get_topology(connection, False)
-        logger.debug(Utils.log_topology(topology.hosts))
+        logger.debug(LogUtils.log_topology(topology.hosts))
         self._hosts = topology.hosts
         return tuple(self._hosts)
 
     def force_refresh(self, connection: Optional[Connection] = None) -> Tuple[HostInfo, ...]:
         self._initialize()
         connection = connection if connection else self._host_list_provider_service.current_connection
         topology = self._get_topology(connection, True)
-        logger.debug(Utils.log_topology(topology.hosts))
+        logger.debug(LogUtils.log_topology(topology.hosts))
         self._hosts = topology.hosts
         return tuple(self._hosts)
 

Diff for: aws_wrapper/utils/utils.py

@@ -12,11 +12,29 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+import sys
+from logging import DEBUG, Formatter, Logger, StreamHandler
 from queue import Empty, Queue
 from typing import Optional
 
 
-class Utils:
+class LogUtils:
+    @staticmethod
+    def setup_logger(logger: Logger, level: int = DEBUG, format_string: Optional[str] = None):
+        for handler in logger.handlers:
+            if isinstance(handler, StreamHandler):
+                return
+
+        if format_string is None:
+            format_string = \
+                "%(asctime)s.%(msecs)03d %(name)-12s:%(funcName)s [%(levelname)-8s] - %(threadName)s - %(message)s"
+
+        handler = StreamHandler(stream=sys.stdout)
+        handler.setFormatter(Formatter(format_string))
+        handler.setLevel(level)
+
+        logger.setLevel(level)
+        logger.addHandler(handler)
 
     @staticmethod
     def log_topology(hosts: list, message_prefix: Optional[str] = None):
@@ -38,17 +56,6 @@ def log_topology(hosts: list, message_prefix: Optional[str] = None):
         return prefix + f"Topology: {{\n\t{msg}}}"
 
 
-class SubscribedMethodUtils:
-    # TODO: check for missing network methods
-    NETWORK_BOUND_METHODS = {
-        "Connection.commit",
-        "Connection.rollback",
-        "Cursor.callproc",
-        "Cursor.execute",
-        "Cursor.executemany"
-    }
-
-
 class QueueUtils:
     @staticmethod
     def get(q: Queue):

Diff for: aws_wrapper/writer_failover_handler.py

@@ -16,6 +16,7 @@
 
 from typing import TYPE_CHECKING
 
+from aws_wrapper import LogUtils
 from aws_wrapper.errors import AwsWrapperError
 
 if TYPE_CHECKING:
@@ -35,7 +36,6 @@
                                          WriterFailoverResult)
 from aws_wrapper.hostinfo import HostAvailability, HostInfo, HostRole
 from aws_wrapper.utils.messages import Messages
-from aws_wrapper.utils.utils import Utils
 
 logger = getLogger(__name__)
 
@@ -238,7 +238,7 @@ def refresh_topology_and_connect_to_new_writer(self, initial_writer_host: HostIn
 
                         if not self.is_same(writer_candidate, initial_writer_host):
                             # new writer available
-                            logger.debug(Utils.log_topology(self._current_topology, "[TaskB] "))
+                            logger.debug(LogUtils.log_topology(self._current_topology, "[TaskB] "))
 
                             if self.connect_to_writer(writer_candidate):
                                 return True