Issue 1288: Adding CodeQL and Ruff as additional workflow items

.github/workflows/codeql.yml

@@ -0,0 +1,97 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# For more information see:
+#     https://nasa.github.io/scrub/
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  pull_request:
+    branches: [develop]
+  schedule:
+    # default branch on sundays at 5a
+    - cron: '0 5 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # CodeQL supports ['cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby']
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+        language: ['python']
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        config-file: ./.github/workflows/codeql/codeql-config.yml
+        languages: ${{ matrix.language }}
+        # queries: security-and-quality, security-extended
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+
+    - name: Post-Process Output
+      run: |
+        python3 -m pip install nasa-scrub
+
+        results_dir=`realpath ${{ github.workspace }}/../results`
+        sarif_files=`find $results_dir -name '*.sarif'`
+
+        for sarif_file in $sarif_files
+        do
+          output_file="$results_dir/$(basename $sarif_file .sarif).scrub"
+
+          python3 -m scrub.tools.parsers.translate_results $sarif_file $output_file ${{ github.workspace }} scrub
+        done
+
+        python3 -m scrub.tools.parsers.csv_parser $results_dir
+
+        echo "RESULTS_DIR=$results_dir" >> $GITHUB_ENV
+
+
+    - name: Upload CodeQL Artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: codeql-artifacts
+        path: ${{ env.RESULTS_DIR }}
+        if-no-files-found: error
+        overwrite: true
+        retention-days: 15

.github/workflows/codeql/codeql-config.yml

@@ -0,0 +1,5 @@
+name: "CodeQL config"
+queries:
+  - name: Run custom queries
+  - uses: security-extended
+  - uses: security-and-quality

.github/workflows/python-publish.yml

@@ -1,61 +1,51 @@
-# This workflows will upload a Python Package 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
-
-name: Upload Python Package
+name: Publish Package to TestPyPi
 
 on:
   release:
     types: [ published ]
 
 jobs:
-
   build:
     runs-on: ubuntu-latest
+
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
+
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
-    - name: Upgrade tooling
+        python-version: "3.11"
+
+    - name: Install pypa/build
       run: |
         python3 -m pip install --upgrade pip
-        pip3 install --upgrade build setuptools setuptools_scm[toml] twine wheel
+        pip3 install --upgrade build --user
+
     - name: Build package
-      run: |
-        python3 -m build --wheel
-        python3 setup.py sdist --format=zip
-    - name: Verify package
-      run: |
-        twine check dist/*
-    - name: Store package
+      run: python3 -m build
+
+    - name: Store packages
       uses: actions/upload-artifact@v4
       with:
-        name: python-package-distribution
-        path: |
-          dist/*.whl
-          dist/*.zip
-        if-no-files-found: error
+        name: python-package-distributions
+        path: dist/
 
   release:
     runs-on: ubuntu-latest
     needs: build
     environment:
       name: release
     permissions:
-      id-token: write  # mandatory for trusted publishing
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
     steps:
     - name: Retrieve package
       uses: actions/download-artifact@v4
       with:
-        name: python-package-distribution
+        name: python-package-distributions
         path: dist/
-    - name: Publish package (PyPi)
+
+    - name: Publish package to TestPyPi
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
-        print-hash: true
-        repository-url: https://pypi.org/p/exotic/  # for testing sub https://test.pypi.org/legacy/
+        repository-url: https://test.pypi.org/legacy/

.github/workflows/ruff.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to disable certain Ruff checks in the
+# "Analyze" configuration block below.
+#
+# For more information see:
+#     https://nasa-ammos.github.io/slim/docs/guides/software-lifecycle/application-starter-kits/python-starter-kit/
+#
+# ******** NOTE ********
+# Ruff is a Python-based linter that works to evaluate Python code.
+#
+name: "Ruff"
+
+on:
+  pull_request:
+    branches: [develop]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Upgrade tooling
+      run: |
+        python3 -m pip install --upgrade pip
+        pip3 install --upgrade build importlib_metadata setuptools setuptools_scm wheel
+        pip3 install ruff
+
+    - name: Install dependencies
+      run: |
+        pip3 install -r requirements.txt
+        pip3 install -e .
+
+    - name: Prepare PYTHONPATH
+      run: |
+        src_paths=`find ${PWD} -type f -maxdepth 3 -mindepth 2 -name "*.py" -exec dirname {} + | uniq`
+        pythonpathplus=""
+        for p in $src_paths
+        do
+            pythonpathplus="${pythonpathplus:+:${pythonpathplus}}:$p"
+        done
+        echo "PYTHONPATH=${PYTHONPATH:+:${PYTHONPATH}}${pythonpathplus}:." >> $GITHUB_ENV
+
+    - name: Analyze
+      # Refer to https://docs.astral.sh/ruff/configuration/#command-line-interface
+      # to add extra rules or a configuration file.
+      run: ruff check --output-file ruff_report.txt . || true
+      continue-on-error: true
+
+    - name: Upload Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ruff_report
+        path: ruff_report.txt
+        if-no-files-found: error
+        overwrite: true
+        retention-days: 15

exotic/version.py

@@ -1 +1 @@
-__version__ = '4.1.0'
+__version__ = '4.1.1'