Unit tests + coverage reports, type checking, pre-commit, and requested fixes

.gitattributes

@@ -6,3 +6,5 @@
 *.py text eol=lf
 *.rst text eol=lf
 *.sh text eol=lf
+*.cpp text eol=lf
+*.hpp text eol=lf

.github/workflows/mkdocs-deploy.yml

@@ -8,8 +8,8 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.x
       - name: Install python action for doc extraction

.github/workflows/pre-commit-hooks.yml

@@ -0,0 +1,17 @@
+name: Pre-commit
+
+on:
+  push:
+  pull_request:
+    types: opened
+
+jobs:
+  check-source-files:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - run: python3 -m pip install pre-commit
+      - run: pre-commit run --all-files

.github/workflows/publish-pypi.yml

@@ -0,0 +1,51 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    branches: [master]
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      # use fetch --all for setuptools_scm to work
+      with:
+        fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: python -m pip install --upgrade pip twine
+    - name: Build wheel
+      run: python -m pip wheel -w dist --no-deps .
+    - name: Check distribution
+      run: twine check dist/*
+    - name: Publish package (to TestPyPI)
+      if: github.event_name == 'workflow_dispatch' && github.repository == 'cpp-linter/cpp-linter-action'
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_TOKEN }}
+      run: twine upload --repository testpypi dist/*
+    - name: Publish package (to PyPI)
+      if: github.event_name != 'workflow_dispatch' && github.repository == 'cpp-linter/cpp-linter-action'
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: twine upload dist/*

.github/workflows/run-dev-tests.yml

@@ -0,0 +1,113 @@
+name: "Check python code"
+
+on:
+  push:
+    paths:
+      - "**.py"
+      - pyproject.toml
+      - pre-commit-config.yaml
+      - ".github/workflows/run-dev-tests.yml"
+  pull_request:
+    types: opened
+    paths:
+      - "**.py"
+      - "**requirements*.txt"
+      - pyproject.toml
+      - pre-commit-config.yaml
+      - ".github/workflows/run-dev-tests.yml"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Build wheel
+        run: python3 -m pip wheel --no-deps -w dist .
+      - name: Upload wheel as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: cpp-linter-action_wheel
+          path: ${{ github.workspace }}/dist/*.whl
+
+  test:
+    needs: [build]
+    strategy:
+      fail-fast: false
+      matrix:
+        py: ['3.7', '3.8', '3.9', '3.10']
+        os: ['windows-latest', ubuntu-latest]
+        version: ['13', '12', '11', '10', '9', '8', '7']
+        include:
+          - tools_dir: 'N/A'
+          - os: 'windows-latest'
+            version: '10'
+            tools_dir: temp
+          - os: 'windows-latest'
+            version: '10'
+            tools_dir: temp
+          - os: 'windows-latest'
+            version: '11'
+            tools_dir: temp
+          - os: 'windows-latest'
+            version: '12'
+            tools_dir: temp
+          - os: 'ubuntu-latest'
+            version: '13'
+            tools_dir: temp
+          # - version: '14'
+          #   tools_dir: temp
+          - version: '7'
+            tools_dir: temp
+          - version: '8'
+            tools_dir: temp
+          - version: '9'
+            tools_dir: temp
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.py }}
+
+      - name: download wheel artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: cpp-linter-action_wheel
+          path: dist
+
+      - name: Install workflow deps
+        # using a wildcard as filename on Windows requires a bash shell
+        shell: bash
+        run: python3 -m pip install pytest coverage[toml] dist/*.whl
+
+      - name: Install clang-tools
+        if: matrix.tools_dir == 'temp'
+        run: |
+          python -m pip install clang-tools
+          clang-tools --install ${{ matrix.version }}  --directory ${{ runner.temp }}/clang-tools
+
+      - name: Collect Coverage (native clang install)
+        if: matrix.tools_dir == 'N/A'
+        env:
+          CLANG_VERSION: ${{ matrix.version }}
+        run: coverage run -m pytest
+
+      - name: Collect Coverage (non-native clang install)
+        if: matrix.tools_dir == 'temp'
+        env:
+          CLANG_VERSION: ${{ runner.temp }}/clang-tools
+        run: coverage run -m pytest
+
+      - run: coverage report && coverage xml
+
+      - uses: codecov/codecov-action@v3
+        if: matrix.os == 'ubuntu-latest' && matrix.version == '12' && matrix.py == '3.10'
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)

.github/workflows/run-test.yml

@@ -23,12 +23,13 @@ jobs:
           git push origin latest
 
   test-action:
+    needs: [add-tag]
     runs-on: ubuntu-latest
     steps:
     - uses: convictional/[email protected]
       with:
         owner: cpp-linter
-        repo: test-cpp-linter-action 
+        repo: test-cpp-linter-action
         github_token: ${{ secrets.PAT_TOKEN }}
         workflow_file_name: cpp-lint-action.yml
         ref: master
@@ -38,12 +39,13 @@ jobs:
         trigger_workflow: true
         wait_workflow: true
   test-package:
+    needs: [add-tag]
     runs-on: ubuntu-latest
     steps:
     - uses: convictional/[email protected]
       with:
         owner: cpp-linter
-        repo: test-cpp-linter-action 
+        repo: test-cpp-linter-action
         github_token: ${{ secrets.PAT_TOKEN }}
         workflow_file_name: cpp-lint-package.yml
         ref: master

.gitignore

@@ -58,6 +58,8 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+tests/*/test*.json
+tests/**/*.c
 
 # Translations
 *.mo

.gitpod.yml

@@ -1,2 +1,2 @@
 tasks:
-  - init: pip install -r requirements.txt
+  - init: pip install -r requirements.txt

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-docstring-first
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-toml
+      - id: requirements-txt-fixer
+  - repo: https://github.com/python/black
+    rev: '22.6.0'
+    hooks:
+      - id: black
+        args: ["--diff"]
+  - repo: https://github.com/pycqa/pylint
+    rev: v2.14.5
+    hooks:
+      - id: pylint
+        name: pylint (action code)
+        types: [python]
+        exclude: "^(docs/|tests/|setup.py$)"
+        additional_dependencies: [pyyaml, requests]
+  - repo: local
+    # this is a "local" hook to run mypy (see https://pre-commit.com/#repository-local-hooks)
+    # because the mypy project doesn't seem to be compatible with pre-commit hooks
+    hooks:
+      - id: mypy
+        name: mypy
+        description: type checking with mypy tool
+        language: python
+        types: [python]
+        entry: mypy
+        exclude: "^(docs/|setup.py$)"
+        additional_dependencies: [mypy, types-pyyaml, types-requests, rich, requests, pytest, pyyaml, '.']