Update test.yml

Author: MDUYN

.github/workflows/test.yml

@@ -16,16 +16,25 @@ jobs:
   linting:
     runs-on: ubuntu-latest
     steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
+      #----------------------------------------------
+      #        load pip cache if cache exists
+      #----------------------------------------------
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip
           restore-keys: ${{ runner.os }}-pip
+      #----------------------------------------------
+      #          install and run linters
+      #----------------------------------------------
       - run: python -m pip install black flake8 isort
-      - run: flake8 ./investing_algorithm_framework
-
+      - run: |
+          flake8 ./investing_algorithm_framework
   test:
     needs: linting
     strategy:
@@ -35,35 +44,67 @@ jobs:
         python-version: [ "3.8", "3.9", "3.10", "3.11" ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        id: setup-python
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+      #----------------------------------------------
+      #  -----  install distutils if needed  -----
+      #----------------------------------------------
       - name: Install distutils on Ubuntu
         if: matrix.os == 'ubuntu-latest'
         run: |
           sudo add-apt-repository ppa:deadsnakes/ppa
           sudo apt-get update
           sudo apt install python${{ matrix.python-version }}-distutils
+      #----------------------------------------------
+      #  -----  install & configure poetry  -----
+      #----------------------------------------------
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
           virtualenvs-create: true
           virtualenvs-in-project: true
+      #----------------------------------------------
+      #       load cached venv if cache exists
+      #----------------------------------------------
       - name: Load cached venv
         id: cached-poetry-dependencies
         uses: actions/cache@v3
         with:
           path: .venv
           key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-      - name: Install all dependencies, including indicators
+      #----------------------------------------------
+      # install dependencies if cache does not exist
+      #----------------------------------------------
+      - name: Install dependencies
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
         run: |
-          poetry install --no-interaction --all-extras
-      - name: Confirm indicators dependencies installed
+          poetry install --no-interaction --no-root
+      #----------------------------------------------
+      # install your root project, if required
+      #----------------------------------------------
+      - name: Install library
         run: |
-          source .venv/bin/activate
-          poetry show | grep -E 'numpy|scipy|tulipy'
+          poetry install --no-interaction --extras indicators
+      #----------------------------------------------
+      #    add matrix specifics and run test suite
+      #----------------------------------------------
       - name: Run tests
         run: |
-          poetry run coverage run -m unittest discover -s tests
+          source .venv/bin/activate
+          coverage run -m unittest discover -s tests
+#      #----------------------------------------------
+#      #             upload coverage stats
+#      #----------------------------------------------
+#      - name: Upload coverage
+#        uses: codecov/codecov-action@v3
+#        with:
+#          file: ./coverage.xml
+#          fail_ci_if_error: true