Merge pull request #310 from pbs/OCTO-10853

OCTO-10853-dockerize tests

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @pbs/core-services

.github/workflows/create_github_release.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   call-unit-tests-workflow:
     name: Run unit tests
-    uses: pbs/pycaption/.github/workflows/main.yml@main
+    uses: pbs/pycaption/.github/workflows/unit_tests.yml@main
     secrets:
       SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
       SLACK_CHANNEL_ID: ${{ secrets.SLACK_CHANNEL_ID }}

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on: workflow_dispatch
 jobs:
   call-unit-tests-workflow:
     name: Run unit tests
-    uses: pbs/pycaption/.github/workflows/main.yml@main
+    uses: pbs/pycaption/.github/workflows/unit_tests.yml@main
     secrets:
       SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
       SLACK_CHANNEL_ID: ${{ secrets.SLACK_CHANNEL_ID }}

.github/workflows/release_test_pypi.yml

@@ -5,13 +5,13 @@ on: workflow_dispatch
 jobs:
   call-unit-tests-workflow:
     name: Run unit tests
-    uses: ./.github/workflows/main.yml
+    uses: ./.github/workflows/unit_tests.yml
     secrets:
       SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
       SLACK_CHANNEL_ID: ${{ secrets.SLACK_CHANNEL_ID }}
 
   build-n-publish:
-    name: Build and publish PyCaption to PyPI
+    name: Build and publish PyCaption to Test PyPI
     needs: call-unit-tests-workflow
     runs-on: ubuntu-latest
     steps:
@@ -32,8 +32,9 @@ jobs:
       run: python -m build
       timeout-minutes: 10
 
-    - name: Publish package on PyPI
+    - name: Publish package on Test PyPI
       run: python -m twine upload --verbose dist/*
       env:
         TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        TWINE_REPOSITORY:  "testpypi"

.github/workflows/main.yml → .github/workflows/unit_tests.yml

@@ -20,24 +20,29 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ["py37", "py38", "py39", "py310", "py311"]
 
     steps:
       - uses: actions/checkout@v2
 
-      - name: Setup python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install Tox
-        run: pip install tox==3
-      - name: Run Tox
+      - name: Run Test
         id: tests
-        # Run tox using the version of Python in `PATH`
-        run: tox -e py
+        run: |
+          ./run_tests.sh test_${{ matrix.python-version }} 
         continue-on-error: true
 
+      - name: Archive production artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-report-${{ matrix.python-version }}
+          path: junit.xml
+
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: code-coverage-report-${{ matrix.python-version }}
+          path: coverage.xml
+
       - name: Add context info to env
         run: |
           sudo apt-get install -y --no-install-recommends libxml-xpath-perl

README.rst

@@ -18,8 +18,8 @@ License
 This module is Copyright (c) 2012-2023 PBS.org and is available under the `Apache
 License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`__.
 
-.. |Build Status| image:: https://github.com/pbs/pycaption/actions/workflows/main.yml/badge.svg
-    :target: https://github.com/pbs/pycaption/actions/workflows/main.yml
+.. |Build Status| image:: https://github.com/pbs/pycaption/actions/workflows/unit_tests.yml/badge.svg
+    :target: https://github.com/pbs/pycaption/actions/workflows/unit_tests.yml
     :alt: Unit Tests
 
 .. |Pre-Commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white

docker-compose.yml

@@ -0,0 +1,62 @@
+version: '3.8'
+
+services:
+  test_py37:
+    image: python:3.7-slim-bullseye
+    command: sh -c "
+      cd pycaption;
+      pip install --upgrade pip;
+      pip install -r test_requirements.txt;
+      pip install -e .;
+      pytest -vvvv --color=yes --junit-xml=junit.xml --cov=pycaption --cov-report xml:coverage.xml;
+      "
+    volumes:
+      - .:/pycaption
+
+  test_py38:
+    image: python:3.8-slim-bullseye
+    command: sh -c "
+      cd pycaption;
+      pip install --upgrade pip;
+      pip install -r test_requirements.txt;
+      pip install -e .;
+      pytest -vvvv --color=yes --junit-xml=junit.xml --cov=pycaption --cov-report xml:coverage.xml;
+      "
+    volumes:
+      - .:/pycaption
+
+  test_py39:
+    image: python:3.9-slim-bullseye
+    command: sh -c "
+      cd pycaption;
+      pip install --upgrade pip;
+      pip install -r test_requirements.txt;
+      pip install -e .;
+      pytest -vvvv --color=yes --junit-xml=junit.xml --cov=pycaption --cov-report xml:coverage.xml;
+      "
+    volumes:
+      - .:/pycaption
+
+  test_py310:
+    image: python:3.10-slim-bullseye
+    command: sh -c "
+      cd pycaption;
+      pip install --upgrade pip;
+      pip install -r test_requirements.txt;
+      pip install -e .;
+      pytest -vvvv --color=yes --junit-xml=junit.xml --cov=pycaption --cov-report xml:coverage.xml;
+      "
+    volumes:
+      - .:/pycaption
+
+  test_py311:
+    image: python:3.11-slim-bullseye
+    command: sh -c "
+      cd pycaption;
+      pip install --upgrade pip;
+      pip install -r test_requirements.txt;
+      pip install -e .;
+      pytest -vvvv --color=yes --junit-xml=junit.xml --cov=pycaption --cov-report xml:coverage.xml;
+      "
+    volumes:
+      - .:/pycaption

run_tests.sh

@@ -0,0 +1,23 @@
+#!/bin/bash -eux
+
+DOCKER_CMD="docker-compose -p pycaption"
+
+SERVICE="test_py311"
+
+if [ "$@" ]; then
+  if [ "$1" == "test_py37" ] || [ "$1" == "test_py38" ]  || \
+  [ "$1" == "test_py39"  ] || [ "$1" == "test_py310" ] || [ "$1" == "test_py311" ]; then
+    SERVICE="$1"
+  fi
+fi
+
+$DOCKER_CMD build "$SERVICE"
+
+function cleanup {
+    echo "Cleaning up ..."
+    $DOCKER_CMD down && $DOCKER_CMD rm -fv
+}
+
+$DOCKER_CMD run --rm "$SERVICE"
+
+cleanup

test_requirements.txt

@@ -0,0 +1,6 @@
+pytest
+pytest-cov
+pytest-lazy-fixture
+beautifulsoup4>=4.8.1
+lxml>=4.9.1
+cssutils>=2.0.0

tests/test_dfxp.py

@@ -9,6 +9,7 @@
     UnitEnum, HorizontalAlignmentEnum, VerticalAlignmentEnum,
 )
 from tests.mixins import ReaderTestingMixIn
+from pytest_lazyfixture import lazy_fixture
 
 
 class TestDFXPReader(ReaderTestingMixIn):