Testing Draco Integration Workflows

.github/actions/check-coverage/action.yml

@@ -27,7 +27,6 @@ runs:
       shell: bash
       run: lcov
         --capture --rc lcov_branch_coverage=1
-        --include '${{ github.workspace }}/*'
         --directory '${{ inputs.binary-dir }}'
         --output-file '${{ inputs.binary-dir }}/coverage.info' |
         tee '${{ inputs.binary-dir }}/lcov_out.txt'

.github/workflows/add-to-project-internal.yml

@@ -0,0 +1,13 @@
+name: Internal Add Issue or PR to Project
+
+on:
+  issues:
+    types: [opened]
+  pull_request_target:
+    types: [opened, ready_for_review, converted_to_draft]
+
+jobs:
+  add-to-project:
+    name: Add issue or pull request to project
+    uses: cFS/workflows/.github/workflows/add-to-project-reusable-internal.yml@dev
+    secrets: inherit

.github/workflows/build-osal-documentation-internal.yml

@@ -0,0 +1,67 @@
+name: "Internal Build OSAL Documentation (API Guide)"
+
+on:
+  push:
+  pull_request:
+
+jobs:
+
+  #Check for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action.
+  check-for-duplicates:
+    runs-on: cfs-self-hosted
+    # Map a step output to a job output
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: synced-actions/skip-duplicate-actions@master
+        with:
+          concurrent_skipping: 'same_content'
+          skip_after_successful_duplicate: 'true'
+          do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]'
+
+  build-osal-apiguide:
+    #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests.
+    needs: check-for-duplicates
+    if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }}
+    runs-on: cfs-self-hosted
+    container:
+      image: aetd-dockerlab.gsfc.nasa.gov/gsfc-cfs/github-actions-ci-cd/cfsbuildenv-doxygen
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout submodule
+        uses: actions/checkout@v4
+
+      - name: Set up for build
+        run: |
+          cp Makefile.sample Makefile
+          make prep
+
+      - name: Build OSAL API Guide
+        run: |
+          make osal-apiguide 2>&1 > make_osal-apiguide_stdout.txt | tee make_osal-apiguide_stderr.txt
+          mv build/docs/osal-apiguide-warnings.log osal-apiguide-warnings.log
+
+      - name: Archive Osal Guide Build Logs
+        uses: actions/upload-artifact@v3
+        with:
+          name: OSAL Guide Artifacts
+          path: |
+            make_osal-apiguide_stdout.txt
+            make_osal-apiguide_stderr.txt
+            osal-apiguide-warnings.log
+
+      - name: Error Check
+        run: |
+          if [[ -s make_osal-apiguide_stderr.txt ]]; then
+            cat make_osal-apiguide_stderr.txt
+            exit -1
+          fi
+
+      - name: Warning Check
+        run: |
+          if [[ -s osal-apiguide-warnings.log ]]; then
+            cat osal-apiguide-warnings.log
+            exit -1
+          fi

.github/workflows/codesonar-internal.yml

@@ -0,0 +1,15 @@
+name: Internal CodeSonar
+
+on:
+  schedule:
+    - cron: "0 0 * * 1"  # Runs every Monday at 12:00 AM UTC
+  workflow_dispatch:
+
+jobs:
+  codesonar:
+    name: Run Codesonar
+    uses: cFS/workflows/.github/workflows/codesonar-reusable-internal.yml@dev
+    with:
+      component-path: cFS # Causes reusable workflow to not checkout bundle
+      setup: cp Makefile.sample Makefile
+    secrets: inherit

.github/workflows/format-check-internal.yml

@@ -0,0 +1,11 @@
+name: Internal Format Check
+
+# Run on all push and pull requests
+on:
+  push:
+  pull_request:
+
+jobs:
+  format-check:
+    name: Run format check
+    uses: cFS/workflows/.github/workflows/format-check-reusable-internal.yml@dev

.github/workflows/mcdc-internal.yml

@@ -0,0 +1,239 @@
+name: Internal MCDC Analysis
+
+on:
+  push:
+  pull_request_target:
+
+# Force bash to apply pipefail option so pipeline failures aren't masked
+defaults:
+  run:
+    shell: bash
+
+env:
+  SIMULATION: native
+  TESTS_RAN: false
+
+jobs:
+  # Checks for duplicate actions. Skips push actions if there is a matching or
+  # duplicate pull-request action.
+  checks-for-duplicates:
+    runs-on: cfs-self-hosted
+    # Map a step output to a job output
+    outputs:
+      should_skip: ${{ steps.skip_check.outputs.should_skip }}
+    steps:
+      - id: skip_check
+        uses: synced-actions/skip-duplicate-actions@master
+        with:
+          concurrent_skipping: 'same_content'
+          skip_after_successful_duplicate: 'true'
+          do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]'
+
+  mcdc:
+    needs: checks-for-duplicates
+    if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' || contains(github.ref, 'dev') }}
+    name: Build and Run MCDC
+    runs-on: cfs-self-hosted
+    container:
+      image: aetd-dockerlab.gsfc.nasa.gov/gsfc-cfs/github-actions-ci-cd/cfsbuildenv-mcdc
+
+    steps:
+      - name: Checkout MCDC Script
+        uses: actions/checkout@v4
+        with:
+          repository: cFS/workflows
+          path: workflows
+
+      - name: Checkout OSAL
+        uses: actions/checkout@v4
+        with:
+          path: source
+
+      - name: Modify osal to include coverage flags
+        run: |
+          sed -i 's/target_compile_options.*)/target_compile_options(ut_coverage_compile INTERFACE -pg -O0 -fprofile-arcs -ftest-coverage -fcondition-coverage -fprofile-abs-path)/' source/src/bsp/generic-linux/CMakeLists.txt
+          sed -i 's/set(UT_COVERAGE_COMPILE_FLAGS.*)/set(UT_COVERAGE_COMPILE_FLAGS -pg --coverage -O0 -fcondition-coverage -fprofile-abs-path)/' source/src/bsp/generic-linux/build_options.cmake
+          sed -i 's/set(UT_COVERAGE_LINK_FLAGS.*)/set(UT_COVERAGE_LINK_FLAGS -pg --coverage -O0 -fcondition-coverage -fprofile-abs-path)/' source/src/bsp/generic-linux/build_options.cmake
+
+      - name: Set up build
+        run: cmake
+          -DCMAKE_BUILD_TYPE=Debug
+          -DENABLE_UNIT_TESTS=TRUE
+          -DOSAL_OMIT_DEPRECATED=FALSE
+          -DOSAL_VALIDATE_API=FALSE
+          -DOSAL_INSTALL_LIBRARIES=FALSE
+          -DOSAL_CONFIG_DEBUG_PERMISSIVE_MODE=TRUE
+          -DOSAL_SYSTEM_BSPTYPE=generic-linux
+          -DCMAKE_PREFIX_PATH=/usr/lib/cmake
+          -DCMAKE_INSTALL_PREFIX=/usr
+          -S source
+          -B build
+
+      - name: Build OSAL
+        working-directory: build
+        run: make VERBOSE=1
+
+      - name: Execute Tests
+        working-directory: build
+        run: |
+          echo "BASE_DIR=build/unit-test-coverage" >> $GITHUB_ENV
+          (ctest --output-on-failure -j4 2>&1 || true) | tee ../test_results.txt
+          echo "TESTS_RAN=true" >> $GITHUB_ENV
+
+      - name: Grab test modules
+        if: ${{ env.TESTS_RAN == 'true' }}
+        run: |
+          echo "MODULES=$(grep -oP 'Test\s+#\d+: \K[\w\-\_]+(?= )' test_results.txt | tr '\n' ' ' | sed 's/ $//')" >> $GITHUB_ENV
+          grep -oP 'Test #\d+: \K[\w\-\_]+' test_results.txt | tr '\n' ' ' | sed 's/ $//' >> modules.txt
+
+      - name: Run mcdc analysis
+        if: ${{ env.TESTS_RAN == 'true' }}
+        run: bash workflows/.github/scripts/mcdc-analyze.sh
+
+      - name: Save PR number
+        if: github.event_name == 'pull_request_target' && always()
+        env:
+          PR_NUMBER: ${{ github.event.number }}
+        run: echo $PR_NUMBER > pr_number
+
+      - name: Archive unit test results
+        # Upload if success or failure which supports skipping, unlike always()
+        if: ${{ env.TESTS_RAN == 'true' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: Unit test results
+          path: |
+            test_results.txt
+
+      - name: Archive mcdc results
+        # Upload if success or failure which supports skipping, unlike always()
+        if: ${{ env.TESTS_RAN == 'true' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: MCDC results
+          path: |
+            **/*.gcov.json.gz
+            mcdc_results.txt
+            pr_number
+            modules.txt
+
+  comment-mcdc:
+    needs: mcdc
+    if: github.event_name == 'pull_request_target' && always()
+    name: Comment MCDC Comparision on PR
+    runs-on: cfs-self-hosted
+
+    steps:
+      - name: Checkout MCDC Script
+        uses: actions/checkout@v4
+        with:
+          repository: cFS/workflows
+          path: workflows
+
+      - name: Download latest main branch artifact
+        uses: synced-actions/action-download-artifact@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          workflow: mcdc-internal.yml
+          search_artifacts: true
+          branch: dev
+          name: MCDC results
+          path: main-branch-results
+
+      - uses: actions/download-artifact@v3
+        with:
+          name: MCDC results
+
+      - name: Compare main and PR artifacts
+        run: |
+          bash workflows/.github/scripts/mcdc-compare.sh main-branch-results/mcdc_results.txt mcdc_results.txt main-branch-results/modules.txt
+
+      - name: Comment comparison to pull request
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('fs');
+            const path = require('path');
+            // Adjust the path based on where you see mcdc_results.txt after running the 'ls' command
+            const mcdcResultsFilePath = path.join(process.env.GITHUB_WORKSPACE, 'mcdc_comment.txt');
+            const uncoveredFilePath = path.join(process.env.GITHUB_WORKSPACE, 'uncovered.json');
+
+            // Debugging: Check if the file exists at the adjusted path
+            if (!fs.existsSync(mcdcResultsFilePath)) {
+              console.log('mcdc_comment.txt file not found at path: ' + mcdcResultsFilePath);
+              return;
+            }
+
+            if (!fs.existsSync(uncoveredFilePath)) {
+              console.log('uncovered.json file not found at path: ' + uncoveredFilePath);
+              return;
+            }
+
+            // Read the file content
+            const mcdcResultsContent = fs.readFileSync(mcdcResultsFilePath, 'utf-8').trim();
+            const uncoveredContent = fs.readFileSync(uncoveredFilePath, 'utf-8').trim();
+
+            // If the file is empty, don't comment
+            if (mcdcResultsContent === '') {
+              console.log('mcdc_comment.txt is empty, no comment will be posted.');
+              return;
+            }
+
+            const mcdcResults = `MC/DC Results:
+            <pre><code class="language-plaintext">${mcdcResultsContent}
+            </code></pre>
+            <details>
+            <summary>Click to view uncovered branches (uncovered.json)</summary>
+            <br>
+            <pre><code class="language-json">${uncoveredContent}
+            </code></pre>
+            </details>`;
+
+            // Ensure the correct path to the pr_number file after unzipping
+            const prNumberPath = path.join(process.env.GITHUB_WORKSPACE, 'pr_number');
+            if (!fs.existsSync(prNumberPath)) {
+              console.log('pr_number file not found at path: ' + prNumberPath);
+              return;
+            }
+
+            const prNumber = Number(fs.readFileSync(prNumberPath));
+            const comments = await github.paginate(
+              github.rest.issues.listComments,
+              {
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+              }
+            );
+
+            comments.reverse();
+            const previousComment = comments.find(comment =>
+              comment.user.login === 'github-actions[bot]'
+            );
+
+            if (previousComment) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: previousComment.id,
+                body: mcdcResults,
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: prNumber,
+                body: mcdcResults,
+              });
+            }
+
+      - name: Archive mcdc comparison
+        # Upload if success or failure which supports skipping, unlike always()
+        if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: MCDC main branch comparison
+          path: |
+            mcdc_comment.txt
+            mcdc_compare.txt