Merge pull request #138 from Thiyagu55/python-test-workflows

Python test workflows

Author: kapv89

.github/workflows/integration-tests.yaml

@@ -10,6 +10,7 @@ on:
     paths-ignore:
       - php/sqlcommenter-php/packages/sqlcommenter-laravel/**
       - php/sqlcommenter-php/samples/sqlcommenter-laravel/**
+
 jobs:
   integrationtests:
     runs-on: ubuntu-latest

.github/workflows/python-tests.yaml

@@ -0,0 +1,60 @@
+name: Python Packages Test
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - python/sqlcommenter-python/**
+  pull_request:
+    paths:
+      - python/sqlcommenter-python/**
+
+jobs:
+  unittests:
+    env:
+      # We use these variables to convert between tox and GHA version literals
+      py36: 3.6
+      py37: 3.7
+      py38: 3.8
+      py39: 3.9
+      RUN_MATRIX_COMBINATION: ${{ matrix.python-version }}-${{ matrix.package }}-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
+      matrix:
+        python-version: [ py36, py37, py38, py39 ]
+        os: [ ubuntu-20.04 ]
+    steps:
+      - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ env[matrix.python-version] }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ env[matrix.python-version] }}
+      - name: Install tox
+        run: pip install -U tox-factor
+      - name: run tox
+        run: tox -e '${{ matrix.python-version }}-{django21,django22,django30,django31,django32,psycopg2,flask,generic,sqlalchemy}'
+        working-directory: ./python/sqlcommenter-python
+
+  lint:
+      strategy:
+        fail-fast: false
+        matrix:
+          tox-environment: [ "lint" ]
+      name: ${{ matrix.tox-environment }}
+      runs-on: ubuntu-20.04
+      steps:
+        - name: Checkout Contrib Repo @ SHA - ${{ github.sha }}
+          uses: actions/checkout@v2
+        - name: Set up Python 3.9
+          uses: actions/setup-python@v2
+          with:
+            python-version: 3.9
+        - name: Install tox
+          run: pip install -U tox
+        - name: run tox
+          run: tox -e flake8
+          working-directory: ./python/sqlcommenter-python
+

.github/workflows/unit-tests.yaml

@@ -1,17 +1,26 @@
 name: Unit Tests
+
 on:
   push:
     branches:
       - master
     paths-ignore:
       - php/sqlcommenter-php/packages/sqlcommenter-laravel/**
       - php/sqlcommenter-php/samples/sqlcommenter-laravel/**
+      - python/sqlcommenter-python/**
   pull_request:
     paths-ignore:
       - php/sqlcommenter-php/packages/sqlcommenter-laravel/**
       - php/sqlcommenter-php/samples/sqlcommenter-laravel/**
+      - python/sqlcommenter-python/**
+
 jobs:
   unittests:
     runs-on: ubuntu-latest
     steps:
       - run: 'echo "No build required" '
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo "No build required" '

python/sqlcommenter-python/google/cloud/sqlcommenter/django/middleware.py

@@ -19,7 +19,6 @@
 
 import django
 from django.db import connections
-
 from django.db.backends.utils import CursorDebugWrapper
 from google.cloud.sqlcommenter import add_sql_comment
 from google.cloud.sqlcommenter.opencensus import get_opencensus_values

python/sqlcommenter-python/tests/django/tests.py

@@ -17,9 +17,11 @@
 import django
 from django.db import connection, connections
 from django.http import HttpRequest
-from django.test import TestCase, override_settings, modify_settings
+from django.test import TestCase, modify_settings, override_settings
 from django.urls import resolve, reverse
-from google.cloud.sqlcommenter.django.middleware import SqlCommenter, QueryWrapper
+from google.cloud.sqlcommenter.django.middleware import (
+    QueryWrapper, SqlCommenter,
+)
 
 from ..compat import mock
 from ..opencensus_mock import mock_opencensus_tracer
@@ -30,6 +32,8 @@
 # Adding the middleware twice in modify_settings
 # doesn't work. The middleware is only used once
 # if used in modify_settings
+
+
 class TestMiddleware:
     def __init__(self, get_response):
         self.get_response = get_response
@@ -38,10 +42,12 @@ def __call__(self, request):
         with connection.execute_wrapper(QueryWrapper(request)):
             return self.get_response(request)
 
+
 # Query log only active if DEBUG=True.
 @override_settings(DEBUG=True)
 class Tests(TestCase):
     databases = '__all__'
+
     @staticmethod
     def get_request(path):
         request = HttpRequest()

python/sqlcommenter-python/tests/fastapi/app.py

@@ -2,10 +2,11 @@
 
 from fastapi import FastAPI, status
 from fastapi.responses import JSONResponse
+from google.cloud.sqlcommenter.fastapi import (
+    SQLCommenterMiddleware, get_fastapi_info,
+)
 from starlette.exceptions import HTTPException as StarletteHTTPException
 
-from google.cloud.sqlcommenter.fastapi import SQLCommenterMiddleware, get_fastapi_info
-
 app = FastAPI(title="SQLCommenter")
 
 app.add_middleware(SQLCommenterMiddleware)

python/sqlcommenter-python/tests/fastapi/tests.py

@@ -18,9 +18,8 @@
 
 import fastapi
 import pytest
-from starlette.testclient import TestClient
-
 from google.cloud.sqlcommenter.fastapi import get_fastapi_info
+from starlette.testclient import TestClient
 
 from .app import app
 

python/sqlcommenter-python/tests/generic/test_add_sql_comment.py

@@ -27,10 +27,10 @@ def test_end_comment_escaping(self):
         self.assertEqual("Select 1 /*a='%%2A/abc'*/", add_sql_comment("Select 1", a='*/abc'))
 
     def test_bytes(self):
-        self.assertIn("Select 1 /*a='%%2A/abc'*/", add_sql_comment("Select 1",a=b'*/abc'))
+        self.assertIn("Select 1 /*a='%%2A/abc'*/", add_sql_comment("Select 1", a=b'*/abc'))
 
     def test_url_quoting(self):
-        self.assertIn("Select 1 /*foo='bar%%2Cbaz'*/", add_sql_comment("Select 1",foo='bar,baz'))
+        self.assertIn("Select 1 /*foo='bar%%2Cbaz'*/", add_sql_comment("Select 1", foo='bar,baz'))
 
     def test_sql_with_semicolon(self):
-        self.assertIn("Select 1 /*foo='bar%%2Cbaz'*/;", add_sql_comment("Select 1;",foo='bar,baz'))
+        self.assertIn("Select 1 /*foo='bar%%2Cbaz'*/;", add_sql_comment("Select 1;", foo='bar,baz'))