Added a workflow to parallelise the E2E tests(#697)

* Added a workflow to parallelise the E2E tests. Updated E2E tests to create new table names for each run to avoid issue in parallelisation

* Modified parallel code coverage workflow to fail when e2e tests fail

* Fixed parallel coverage check pytest command

* Modified e2e tests to support parallel execution

* Added fallbacks for exit code 5 where we find no test for SEA

* Fixed coverage artifact for parallel test workflow

* Debugging coverage check merge

* Improved coverage report merge and removed the test_driver test for faster testing

* Debug commit for coverage merge

* Debugging coverage merge 2

* Debugging coverage merge 3

* Removed unnecessary debug statements from the parallel code coverage workflow

* Added unit test and common e2e tests

* Added null checks for coverage workflow

* Improved the null check for test list

* Improved the visibility for test list

* Added check for exit code 5

* Updated the workflowfor coverage check to use pytst -xdist to run the tests parallely

* Enforced the e2e tests should pass

* Changed name for workflow job

* Updated poetry

* Removed integration and previous code coverage workflow

* Added the integration workflow again

Author: msrathore-db

.github/workflows/coverage-check.yml renamed to .github/workflows/code-coverage.yml

@@ -6,7 +6,7 @@ permissions:
 on: [pull_request, workflow_dispatch]
 
 jobs:
-  coverage:
+  test-with-coverage:
     runs-on: ubuntu-latest
     environment: azure-prod
     env:
@@ -22,9 +22,9 @@ jobs:
       - name: Check out repository
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Needed for coverage comparison
+          fetch-depth: 0
           ref: ${{ github.event.pull_request.head.ref || github.ref_name }}
-          repository: ${{ github.event.pull_request.head.repo.full_name ||  github.repository }}
+          repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
       - name: Set up python
         id: setup-python
         uses: actions/setup-python@v5
@@ -61,14 +61,18 @@ jobs:
       - name: Install library
         run: poetry install --no-interaction --all-extras
       #----------------------------------------------
-      #              run all tests
+      #    run all tests with coverage
       #----------------------------------------------
-      - name: Run tests with coverage
-        continue-on-error: true
+      - name: Run all tests with coverage 
+        continue-on-error: false
         run: |
-          poetry run python -m pytest \
-            tests/unit tests/e2e \
-            --cov=src --cov-report=xml --cov-report=term -v
+          poetry run pytest tests/unit tests/e2e \
+            -n auto \
+            --cov=src \
+            --cov-report=xml \
+            --cov-report=term \
+            -v
+          
       #----------------------------------------------
       #         check for coverage override
       #----------------------------------------------
@@ -128,4 +132,5 @@ jobs:
             echo "Please ensure this override is justified and temporary"
           else
             echo "✅ Coverage checks enforced - minimum 85% required"
-          fi
+          fi
+

.github/workflows/integration.yml

@@ -55,4 +55,4 @@ jobs:
       #              run test suite
       #----------------------------------------------
       - name: Run e2e tests
-        run: poetry run python -m pytest tests/e2e
+        run: poetry run python -m pytest tests/e2e -n auto

poetry.lock

@@ -39,6 +39,7 @@ pylint = ">=2.12.0"
 black = "^22.3.0"
 pytest-dotenv = "^0.5.2"
 pytest-cov = "^4.0.0"
+pytest-xdist = "^3.0.0"
 numpy = [
     { version = ">=1.16.6", python = ">=3.8,<3.11" },
     { version = ">=1.23.4", python = ">=3.11" },

pyproject.toml

@@ -1,6 +1,7 @@
 import pytest
 from numpy import ndarray
 from typing import Sequence
+from uuid import uuid4
 
 from tests.e2e.test_driver import PySQLPytestTestCase
 
@@ -10,12 +11,15 @@ class TestComplexTypes(PySQLPytestTestCase):
     def table_fixture(self, connection_details):
         self.arguments = connection_details.copy()
         """A pytest fixture that creates a table with a complex type, inserts a record, yields, and then drops the table"""
+         
+        table_name = f"pysql_test_complex_types_table_{str(uuid4()).replace('-', '_')}"
+        self.table_name = table_name
 
         with self.cursor() as cursor:
             # Create the table
             cursor.execute(
-                """
-                CREATE TABLE IF NOT EXISTS pysql_test_complex_types_table (
+                f"""
+                CREATE TABLE IF NOT EXISTS {table_name} (
                     array_col ARRAY<STRING>,
                     map_col MAP<STRING, INTEGER>,
                     struct_col STRUCT<field1: STRING, field2: INTEGER>,
@@ -27,8 +31,8 @@ def table_fixture(self, connection_details):
             )
             # Insert a record
             cursor.execute(
-                """
-                INSERT INTO pysql_test_complex_types_table
+                f"""
+                INSERT INTO {table_name}
                 VALUES (
                     ARRAY('a', 'b', 'c'),
                     MAP('a', 1, 'b', 2, 'c', 3),
@@ -40,10 +44,10 @@ def table_fixture(self, connection_details):
                 """
             )
             try:
-                yield
+                yield table_name
             finally:
                 # Clean up the table after the test
-                cursor.execute("DELETE FROM pysql_test_complex_types_table")
+                cursor.execute(f"DROP TABLE IF EXISTS {table_name}")
 
     @pytest.mark.parametrize(
         "field,expected_type",
@@ -61,7 +65,7 @@ def test_read_complex_types_as_arrow(self, field, expected_type, table_fixture):
 
         with self.cursor() as cursor:
             result = cursor.execute(
-                "SELECT * FROM pysql_test_complex_types_table LIMIT 1"
+                f"SELECT * FROM {table_fixture} LIMIT 1"
             ).fetchone()
 
         assert isinstance(result[field], expected_type)
@@ -83,7 +87,7 @@ def test_read_complex_types_as_string(self, field, table_fixture):
             extra_params={"_use_arrow_native_complex_types": False}
         ) as cursor:
             result = cursor.execute(
-                "SELECT * FROM pysql_test_complex_types_table LIMIT 1"
+                f"SELECT * FROM {table_fixture} LIMIT 1"
             ).fetchone()
 
         assert isinstance(result[field], str)