[PATCH] fetch cc test reporter tool as gist submodule (#82)

# Patch Notes

## Impacted GHI

 - [x] Closes #79

---

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit


- **New Features**
- Introduced a flexible cleanup command and a standardized build
configuration for enhanced automation.
  - Added a new submodule for the fetch-test-reporter functionality.

- **Build & CI Improvements**
- Streamlined job execution with dynamic environment settings and
refined workflow conditions for more reliable deployments.
  - Simplified Python version specifications in CI workflows.
- Enhanced the Makefile with new targets for building, testing, and
cleaning.
  - Updated the CodeQL analysis workflow to include submodule support.
- Added parameters for improved submodule handling in various CI
workflows.

- **Dependency Updates**
- Updated and added dependencies to leverage modern tooling and improve
performance and security.

- **Documentation**
  - Corrected typographical errors to enhance clarity.
  - Expanded module-level documentation for improved usability.

- **Tests**
- Enhanced testing scripts with improved error handling, validation
checks, and streamlined reporting.
- Introduced new scripts for checking copyright lines and spelling
errors.
  - Added new functions to improve the robustness of testing scripts.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: reactive-firewall

.appveyor.yml

@@ -9,21 +9,26 @@ image:
 - Visual Studio 2022
 - Visual Studio 2019
 clone_depth: 50
-init:
+install:
+  - cmd: >-
+      choco install make || VER>NUL
+  - cmd: >-
+      choco install git || VER>NUL
+  - cmd: >-
+      choco install python --pre || VER>NUL
+
+      choco upgrade python --pre || VER>NUL
+  - cmd: >-
+      python -m pip install flake8 || VER>NUL
+
+      python -m pip install coverage || VER>NUL
+  - cmd: >-
+      choco install codecov || VER>NUL
+before_build:
 - cmd: >-
-    choco install make || VER>NUL
+    git submodule sync || VER>NUL
 
-    choco install git || VER>NUL
-
-    choco install python --pre || VER>NUL
-
-    choco upgrade python --pre || VER>NUL
-
-    python -m pip install flake8 || VER>NUL
-
-    python -m pip install coverage || VER>NUL
-
-    choco install codecov || VER>NUL
+    git submodule update --init || VER>NUL
 
     dir
 build_script:

.circleci/config.yml

@@ -1,117 +1,130 @@
-version: 2
+---
+version: 2.1
+commands:
+  cleanup:
+    steps:
+      - run:
+          shell: /bin/bash
+          name: "Cleanup"
+          command: |
+            make clean
+          when: always
+  reposync:
+    steps:
+      - run:
+          shell: /bin/bash
+          name: "Fetch"
+          command: |
+            git fetch --all ;
+          when: always
+      - run:
+          shell: /bin/bash
+          name: "Sync Submodules"
+          command: |
+            git submodule sync ;
+          when: on_success
+      - run:
+          shell: /bin/bash
+          name: "Update Submodules"
+          command: |
+            git submodule update --init ;
+          when: on_success
+
+parameters:
+  python-version:
+    type: string
+    default: "3.12"
+
 jobs:
   build:
     docker:
-      - image: cimg/python:3.7
-      - image: cimg/python:3.8
-      - image: cimg/python:3.9
-      - image: cimg/python:3.10
-      - image: cimg/python:3.11
-      - image: cimg/python:3.12
+      - image: cimg/python:<< pipeline.parameters.python-version >>
+    resource_class: medium
     environment:
       CI: cicleci
       DEBIAN_FRONTEND: noninteractive
       LANG: en_US.UTF-8
-      LC_CTYPE: en_EN.UTF-8
+      LC_CTYPE: en_US.UTF-8
       SHELL: /bin/bash
     working_directory: ~/python-repo
     steps:
       - checkout
-      - run:
-          name: "fetch and pull"
-          command: |
-            git fetch && git pull --all || true
+      - reposync
       - run:
           shell: /bin/bash
           name: "install depends attempt"
           command: |
-            python3 -m pip install --user -r ./requirements.txt || true
+            python3 -m pip install --user -r ./requirements.txt || : ;
           when: on_success
       - run:
           shell: /bin/bash
-          name: "install test extras attempt"
+          name: "install test depends attempt"
           command: |
-            python3 -m pip install --user -r ./test-requirements.txt || true
+            python3 -m pip install --upgrade --user -r ./test-requirements.txt || : ;
+          when: on_success
       - save_cache:
           key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
           paths:
             - ~/python-repo
 
   test:
     docker:
-      - image: cimg/python:3.7
-      - image: cimg/python:3.8
-      - image: cimg/python:3.9
-      - image: cimg/python:3.10
-      - image: cimg/python:3.11
-      - image: cimg/python:3.12
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     parallelism: 2
+    resource_class: medium
     environment:
       CI: cicleci
       DEBIAN_FRONTEND: noninteractive
       LANG: en_US.UTF-8
-      LC_CTYPE: en_EN.UTF-8
+      LC_CTYPE: en_US.UTF-8
       SHELL: /bin/bash
     working_directory: ~/python-repo
     steps:
       - restore_cache:
           key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
       - run:
           shell: /bin/bash
-          name: "clean up for test"
+          name: "Installing deps for test"
           command: |
-            make clean
-          when: always
+            python3 -m pip install --upgrade --user -r ./test-requirements.txt || : ;
+          when: on_success
+      - cleanup
       - run:
           shell: /bin/bash
           name: "Unit Tests"
           command: |
             make test
           when: on_success
-      - run:
-          shell: /bin/bash
-          name: "clean up from test"
-          command: |
-            make clean
-          when: always
-      - run:
-          shell: /bin/bash
-          name: "clean up from FAIL"
-          command: |
-            make clean
-          when: on_fail
+      - cleanup
 
   pytest:
     docker:
-      - image: cimg/python:3.7
-      - image: cimg/python:3.8
-      - image: cimg/python:3.9
-      - image: cimg/python:3.10
-      - image: cimg/python:3.11
-      - image: cimg/python:3.12
+      - image: cimg/python:<< pipeline.parameters.python-version >>
     parallelism: 2
+    resource_class: medium
     environment:
       CI: cicleci
       DEBIAN_FRONTEND: noninteractive
       LANG: en_US.UTF-8
-      LC_CTYPE: en_EN.UTF-8
+      LC_CTYPE: en_US.UTF-8
       SHELL: /bin/bash
     working_directory: ~/python-repo
     steps:
       - restore_cache:
           key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
       - run:
           shell: /bin/bash
-          name: "setup up for pytest"
+          name: "set up depends"
           command: |
-            python3 -m pip install --upgrade --user -r ./test-requirements.txt || true
+            python3 -m pip install --upgrade --user -r ./requirements.txt || : ;
           when: on_success
       - run:
           shell: /bin/bash
-          name: "clean up for pytest"
+          name: "install test-reqs attempt"
           command: |
-            make clean
-          when: always
+            python3 -m pip install --upgrade --user -r ./test-requirements.txt || : ;
+          when: on_success
+      - cleanup
       - run:
           shell: /bin/bash
           name: "pytest Unit Tests"
@@ -124,55 +137,41 @@ jobs:
       - store_artifacts:
           path: test-reports
           when: on_success
-      - run:
-          shell: /bin/bash
-          name: "clean up from pytest"
-          command: |
-            make clean
-          when: always
-      - run:
-          shell: /bin/bash
-          name: "clean up from FAIL"
-          command: |
-            make clean
-          when: on_fail
+      - cleanup
 
   lint:
     docker:
-      - image: cimg/python:3.11
+      - image: cimg/python:<< pipeline.parameters.python-version >>
+    resource_class: medium
     environment:
       CI: cicleci
       DEBIAN_FRONTEND: noninteractive
       LANG: en_US.UTF-8
       SHELL: /bin/bash
-      LC_CTYPE: en_EN.UTF-8
+      LC_CTYPE: en_US.UTF-8
     working_directory: ~/python-repo
     steps:
       - restore_cache:
           key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
       - run:
-          name: "install linters extras attempt"
+          name: "install reqs attempt"
           command: |
-            python3 -m pip install --upgrade --user -r ./test-requirements.txt || true
+            python3 -m pip install --user -r ./requirements.txt || : ;
       - run:
-          shell: /bin/bash
-          name: "clean up for test"
+          name: "install test-reqs attempt"
           command: |
-            make clean
+            python3 -m pip install --user -r ./test-requirements.txt || : ;
+      - cleanup
       - run:
           shell: /bin/bash
           name: "check code style and spelling"
           command: |
-            make test-style || python3 -m flake8 --ignore=W191,W391,E117 --max-line-length=100 --verbose --count --config=.flake8.ini --max-complexity=10
-      - run:
-          shell: /bin/bash
-          name: "clean up when done"
-          command: |
-            make clean
+            make test-style || python3 -m flake8 --verbose --count --config=.flake8.ini
+      - cleanup
 
 workflows:
   version: 2
-  workflow:
+  test-matrix:
     jobs:
       - build
       - test:
@@ -184,3 +183,4 @@ workflows:
       - pytest:
           requires:
             - build
+            - test

.codecov.yml

@@ -39,6 +39,10 @@ coverage:
 github_checks:
   annotations: true
 flags:
+  pythonrepo:
+    paths:
+      - "pythonrepo/"
   tests:
     paths:
-      - tests
+      - "tests/"
+      - "!pythonrepo/"

.coveragerc

@@ -1,24 +1,56 @@
 [run]
+concurrency = multiprocessing
 parallel = True
+sigterm = True
+# enable if you want to consider branches in coverage
+# branch = True
 
 [report]
-include = pythonrepo*,tests*
+include = pythonrepo/*
 # Regexes for lines to exclude from consideration
 exclude_lines =
     # Have to re-enable the standard pragma
     pragma: no cover
+    pass
+    except ImportError
+    except ModuleNotFoundError
     except Exception
-    except BaseException:
+    except BaseException
+    except UnicodeDecodeError
     # Don't complain if tests don't hit defensive assertion code:
     raise AssertionError
     raise NotImplementedError
     raise ImportError
+    raise ModuleNotFoundError
     except unittest.SkipTest
-    except IOError
-    except OSError
-
+    except ..Error
     # Don't complain if non-runnable code isn't run:
-    if __name__ in '__main__':
+    if __name__ .. .__main__.:
+    if __name__ in u'__main__':
+    if __name__ in u"__main__":
+    os.abort()
+    exit
 
 ignore_errors = True
 
+partial_branches =
+    # Have to re-enable the standard pragma rules
+    pragma: no branch
+    skipcq: PYL-
+    finally:
+    @
+    except unittest.SkipTest
+    self.skipTest
+    self.fail
+    # Don't complain if non-runnable code isn't run:
+    if __name__ in u'__main__':
+    if __name__ in u"__main__":
+    if __name__ in '__main__':
+    if __sys_path__ not in sys.path:
+    # don't complain about sys.modules
+    sys.modules
+    not in sys.modules:
+    if context.__name__ is None:
+    if 'os' not in sys.modules:
+    if 'os.path' not in sys.modules:
+    if 'argparse' not in sys.modules:

.flake8.ini

@@ -1,13 +1,14 @@
 [flake8]
-select = C,E,F,W,B,B950
+select = C,D,E,F,W,B,B950
 # Ignore specific warnings and errors according to CEP-8 style
-extend-ignore =
-    W191,  # Indentation contains tabs
-    W391,  # Blank line at end of file
-    E117,  # Over-indented
-    D208,  # Docstring is over-indented
-    D203,  # 1 blank line required before class docstring - CEP-7
-    D212,  # Multi-line docstring summary should start at the first line - CEP-7
+extend-ignore = E117,D203,D208,D212,W191,W391
+# CEP-8 Custom Exceptions:
+#    W191,  # Indentation contains tabs
+#    W391,  # Blank line at end of file
+#    E117,  # Over-indented
+#    D208,  # Docstring is over-indented
+#    D203,  # 1 blank line required before class docstring - CEP-7
+#    D212,  # Multi-line docstring summary should start at the first line - CEP-7
 # Ignore long lines as specified in CEP-8
 max-line-length = 100
 extend-exclude =