get codeql and code coverage working #193
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved. | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: Lint and Test | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - "pull-request/[0-9]+" | |
| tags: | |
| - 'v*' | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} | |
| permissions: | |
| contents: read # Required for checking out code | |
| actions: write # Required for uploading test artifacts | |
| pull-requests: write # Required for coverage report comments | |
| env: | |
| # Go cache settings (specific to this workflow) | |
| GOPATH: /home/runner/go | |
| GOCACHE: /home/runner/.cache/go-build | |
| jobs: | |
| prepare-environment: | |
| uses: ./.github/workflows/prepare-environment.yml | |
| simple-lint: | |
| runs-on: linux-amd64-cpu4 | |
| timeout-minutes: 30 | |
| needs: prepare-environment | |
| strategy: | |
| matrix: | |
| include: | |
| - component: protos | |
| make_command: 'make protos-lint' | |
| step_name: 'Run protos lint' | |
| - component: license-headers | |
| make_command: 'make license-headers-lint' | |
| step_name: 'Run license headers check' | |
| - component: gomod | |
| make_command: 'make gomod-lint' | |
| step_name: 'Run gomod lint' | |
| - component: log-collector | |
| make_command: 'make -C nvsentinel-log-collector lint-log-collector' | |
| step_name: 'Run lint' | |
| replace_imports: 'false' | |
| - component: file-server-cleanup | |
| make_command: 'make -C nvsentinel-log-collector lint-file-server-cleanup' | |
| step_name: 'Run lint' | |
| replace_imports: 'false' | |
| - component: kubernetes-distro | |
| make_command: 'make kubernetes-distro-lint' | |
| step_name: 'Run lint' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup build environment | |
| uses: ./.github/actions/setup-build-env | |
| with: | |
| go-version: ${{ needs.prepare-environment.outputs.go_version }} | |
| python-version: ${{ needs.prepare-environment.outputs.python_version }} | |
| poetry-version: ${{ needs.prepare-environment.outputs.poetry_version }} | |
| golangci-lint-version: ${{ needs.prepare-environment.outputs.golangci_lint_version }} | |
| protobuf-version: ${{ needs.prepare-environment.outputs.protobuf_version }} | |
| protoc-gen-go-version: ${{ needs.prepare-environment.outputs.protoc_gen_go_version }} | |
| protoc-gen-go-grpc-version: ${{ needs.prepare-environment.outputs.protoc_gen_go_grpc_version }} | |
| shellcheck-version: ${{ needs.prepare-environment.outputs.shellcheck_version }} | |
| - name: ${{ matrix.step_name }} | |
| run: ${{ matrix.make_command }} | |
| health-monitors-lint-test: | |
| runs-on: linux-amd64-cpu4 | |
| timeout-minutes: 30 | |
| needs: prepare-environment | |
| strategy: | |
| matrix: | |
| include: | |
| - component: syslog-health-monitor | |
| - component: csp-health-monitor | |
| - component: gpu-health-monitor | |
| install_dcgm: 'true' | |
| python_required: 'true' | |
| replace_imports: 'false' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup build environment | |
| uses: ./.github/actions/setup-build-env | |
| with: | |
| go-version: ${{ needs.prepare-environment.outputs.go_version }} | |
| python-version: ${{ needs.prepare-environment.outputs.python_version }} | |
| poetry-version: ${{ needs.prepare-environment.outputs.poetry_version }} | |
| golangci-lint-version: ${{ needs.prepare-environment.outputs.golangci_lint_version }} | |
| protobuf-version: ${{ needs.prepare-environment.outputs.protobuf_version }} | |
| protoc-gen-go-version: ${{ needs.prepare-environment.outputs.protoc_gen_go_version }} | |
| protoc-gen-go-grpc-version: ${{ needs.prepare-environment.outputs.protoc_gen_go_grpc_version }} | |
| shellcheck-version: ${{ needs.prepare-environment.outputs.shellcheck_version }} | |
| install-dcgm: ${{ matrix.install_dcgm || 'false' }} | |
| - name: Run lint and test | |
| run: make -C health-monitors/${{ matrix.component }} lint-test | |
| - name: Upload artifacts | |
| uses: ./.github/actions/upload-test-artifacts | |
| with: | |
| component-name: ${{ matrix.component }} | |
| file-paths: | | |
| health-monitors/${{ matrix.component }}/coverage.xml | |
| health-monitors/${{ matrix.component }}/coverage.txt | |
| health-monitors/${{ matrix.component }}/report.xml | |
| modules-lint-test: | |
| runs-on: linux-amd64-cpu4 | |
| timeout-minutes: 30 | |
| needs: prepare-environment | |
| strategy: | |
| matrix: | |
| component: | |
| - platform-connectors | |
| - store-client-sdk | |
| - statemanager | |
| - health-events-analyzer | |
| - fault-quarantine-module | |
| - labeler-module | |
| - node-drainer-module | |
| - fault-remediation-module | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup build environment | |
| uses: ./.github/actions/setup-build-env | |
| with: | |
| go-version: ${{ needs.prepare-environment.outputs.go_version }} | |
| python-version: ${{ needs.prepare-environment.outputs.python_version }} | |
| poetry-version: ${{ needs.prepare-environment.outputs.poetry_version }} | |
| golangci-lint-version: ${{ needs.prepare-environment.outputs.golangci_lint_version }} | |
| protobuf-version: ${{ needs.prepare-environment.outputs.protobuf_version }} | |
| protoc-gen-go-version: ${{ needs.prepare-environment.outputs.protoc_gen_go_version }} | |
| protoc-gen-go-grpc-version: ${{ needs.prepare-environment.outputs.protoc_gen_go_grpc_version }} | |
| shellcheck-version: ${{ needs.prepare-environment.outputs.shellcheck_version }} | |
| - name: Run lint and test | |
| run: make -C ${{ matrix.component }} lint-test | |
| - name: Upload artifacts | |
| uses: ./.github/actions/upload-test-artifacts | |
| with: | |
| component-name: ${{ matrix.component }} | |
| file-paths: | | |
| ${{ matrix.component }}/coverage.xml | |
| ${{ matrix.component }}/coverage.txt | |
| ${{ matrix.component }}/report.xml | |
| consolidated-coverage-report: | |
| if: github.event_name == 'pull_request' || startsWith(github.ref, 'refs/heads/pull-request/') | |
| runs-on: linux-amd64-cpu4 | |
| timeout-minutes: 15 | |
| needs: [health-monitors-lint-test, modules-lint-test] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 'stable' | |
| - name: Download all coverage artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: "*-results" | |
| path: coverage-artifacts | |
| merge-multiple: true | |
| - name: Consolidate coverage files | |
| run: | | |
| set -e | |
| echo "Consolidating coverage files from all components..." | |
| mkdir -p consolidated-coverage | |
| # Initialize consolidated coverage with mode line | |
| echo "mode: set" > consolidated-coverage/coverage.txt | |
| # Find all coverage.txt files and merge them properly | |
| find coverage-artifacts -name "coverage.txt" -type f | while read -r file; do | |
| echo "Processing: $file" | |
| # Validate file exists and is not empty | |
| if [[ ! -f "$file" || ! -s "$file" ]]; then | |
| echo "Warning: Skipping empty or missing file: $file" | |
| continue | |
| fi | |
| # Validate coverage file format | |
| if ! head -n 1 "$file" | grep -q "^mode:"; then | |
| echo "Warning: Skipping file with invalid format (no mode line): $file" | |
| continue | |
| fi | |
| # Extract coverage data (skip mode line) and validate each line | |
| tail -n +2 "$file" | while IFS= read -r line; do | |
| # Skip empty lines | |
| [[ -z "$line" ]] && continue | |
| # Validate coverage line format: file.go:start.col,end.col numStmts count | |
| if [[ "$line" =~ ^[^:]+:[0-9]+\.[0-9]+,[0-9]+\.[0-9]+[[:space:]]+[0-9]+[[:space:]]+[0-9]+$ ]]; then | |
| echo "$line" >> consolidated-coverage/coverage.txt | |
| else | |
| echo "Warning: Skipping malformed coverage line: $line" | |
| fi | |
| done | |
| done | |
| echo "Consolidated coverage file created:" | |
| ls -la consolidated-coverage/ | |
| echo "Total coverage lines: $(wc -l < consolidated-coverage/coverage.txt)" | |
| echo "First 10 lines:" | |
| head -n 10 consolidated-coverage/coverage.txt | |
| # Final validation of consolidated file | |
| if ! go tool cover -func=consolidated-coverage/coverage.txt >/dev/null 2>&1; then | |
| echo "❌ ERROR: Consolidated coverage file failed validation" | |
| echo "Showing first 20 lines for debugging:" | |
| head -n 20 consolidated-coverage/coverage.txt | |
| exit 1 | |
| fi | |
| echo "✅ Coverage consolidation completed successfully" | |
| - name: Upload consolidated coverage | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: consolidated-code-coverage | |
| path: consolidated-coverage/coverage.txt | |
| retention-days: 30 | |
| - name: Extract PR number from branch name | |
| id: pr-number | |
| run: | | |
| if [[ "${{ github.ref }}" =~ pull-request/([0-9]+) ]]; then | |
| echo "pr_number=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT | |
| else | |
| echo "pr_number=" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Install go-coverage-report CLI tool | |
| run: go install github.com/fgrosse/go-coverage-report/cmd/[email protected] | |
| - name: Get changed files | |
| uses: tj-actions/changed-files@aa08304bd477b800d468db44fe10f6c61f7f7b11 | |
| id: changed-files | |
| with: | |
| write_output_files: true | |
| json: true | |
| files: "**.go" | |
| files_ignore: "vendor/**" | |
| output_dir: .github/outputs | |
| - name: Generate Coverage Report with Fixed PR Number | |
| run: | | |
| set -e # Exit on error | |
| # Current coverage is already uploaded in this workflow | |
| echo "Downloading current coverage..." | |
| if ! gh run download "${{ github.run_id }}" --name=consolidated-code-coverage --dir=/tmp/current-coverage; then | |
| echo "❌ Failed to download current coverage artifacts" | |
| exit 1 | |
| fi | |
| if [[ ! -f /tmp/current-coverage/coverage.txt ]]; then | |
| echo "❌ Current coverage file not found" | |
| exit 1 | |
| fi | |
| mv /tmp/current-coverage/coverage.txt .github/outputs/new-coverage.txt | |
| # Download baseline coverage from main (failure here is acceptable) | |
| echo "Downloading baseline coverage..." | |
| LAST_SUCCESSFUL_RUN=$(gh run list --status=success --branch=main --workflow=lint-test.yml --event=push --json=databaseId --limit=1 -q '.[] | .databaseId') | |
| if [[ -n "$LAST_SUCCESSFUL_RUN" ]]; then | |
| echo "Found baseline run: $LAST_SUCCESSFUL_RUN" | |
| if gh run download "$LAST_SUCCESSFUL_RUN" --name=consolidated-code-coverage --dir=/tmp/baseline-coverage 2>/dev/null; then | |
| if [[ -f /tmp/baseline-coverage/coverage.txt ]]; then | |
| echo "✅ Baseline coverage found" | |
| mv /tmp/baseline-coverage/coverage.txt .github/outputs/old-coverage.txt | |
| else | |
| echo "⚠️ Baseline coverage file not found in artifact" | |
| touch .github/outputs/old-coverage.txt # Create empty file | |
| fi | |
| else | |
| echo "⚠️ Failed to download baseline coverage (creating empty baseline)" | |
| touch .github/outputs/old-coverage.txt # Create empty file | |
| fi | |
| else | |
| echo "⚠️ No successful baseline run found (creating empty baseline)" | |
| touch .github/outputs/old-coverage.txt # Create empty file | |
| fi | |
| # Generate the report using fgrosse's CLI tool (same format!) | |
| echo "Generating coverage report..." | |
| if ! go-coverage-report -root=github.com/NVIDIA/nvsentinel \ | |
| .github/outputs/old-coverage.txt \ | |
| .github/outputs/new-coverage.txt \ | |
| .github/outputs/all_modified_files.json > coverage-report.md 2> coverage-report.err; then | |
| echo "❌ Failed to generate coverage report" | |
| echo "Coverage report output:" | |
| cat coverage-report.md || echo "No output file" | |
| echo "Coverage report error output:" | |
| cat coverage-report.err || echo "No error output" | |
| exit 1 | |
| fi | |
| if [[ ! -f coverage-report.md || ! -s coverage-report.md ]]; then | |
| echo "❌ Coverage report is empty or missing" | |
| exit 1 | |
| fi | |
| echo "✅ Coverage report generated successfully" | |
| # Post comment using our correct PR number | |
| if [[ -n "${{ steps.pr-number.outputs.pr_number }}" ]]; then | |
| echo "Posting coverage comment to PR #${{ steps.pr-number.outputs.pr_number }}..." | |
| # Check for existing coverage comment | |
| EXISTING_COMMENT=$(gh api "repos/${{ github.repository }}/issues/${{ steps.pr-number.outputs.pr_number }}/comments" \ | |
| --jq '.[] | select(.user.login=="github-actions[bot]" and (.body | test("Coverage Report|Coverage Δ"))) | .id' \ | |
| | head -1 2>/dev/null || echo "") | |
| if [[ -n "$EXISTING_COMMENT" ]]; then | |
| echo "Updating existing comment $EXISTING_COMMENT..." | |
| if ! gh api "repos/${{ github.repository }}/issues/${{ steps.pr-number.outputs.pr_number }}/comments/$EXISTING_COMMENT" \ | |
| --method PATCH --input coverage-report.md; then | |
| echo "❌ Failed to update existing coverage comment" | |
| exit 1 | |
| fi | |
| else | |
| echo "Creating new comment..." | |
| if ! gh pr comment "${{ steps.pr-number.outputs.pr_number }}" --body-file=coverage-report.md; then | |
| echo "❌ Failed to create coverage comment" | |
| exit 1 | |
| fi | |
| fi | |
| echo "✅ Coverage comment posted successfully" | |
| else | |
| echo "⚠️ No PR number found, skipping comment" | |
| fi | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| consolidated-coverage-baseline: | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| runs-on: linux-amd64-cpu4 | |
| timeout-minutes: 15 | |
| needs: [health-monitors-lint-test, modules-lint-test] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download all coverage artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| pattern: "*-results" | |
| path: coverage-artifacts | |
| merge-multiple: true | |
| - name: Consolidate coverage files | |
| run: | | |
| set -e | |
| echo "Consolidating coverage files from all components for baseline..." | |
| mkdir -p consolidated-coverage | |
| # Initialize consolidated coverage with mode line | |
| echo "mode: set" > consolidated-coverage/coverage.txt | |
| # Find all coverage.txt files and merge them properly | |
| find coverage-artifacts -name "coverage.txt" -type f | while read -r file; do | |
| echo "Processing: $file" | |
| # Validate file exists and is not empty | |
| if [[ ! -f "$file" || ! -s "$file" ]]; then | |
| echo "Warning: Skipping empty or missing file: $file" | |
| continue | |
| fi | |
| # Validate coverage file format | |
| if ! head -n 1 "$file" | grep -q "^mode:"; then | |
| echo "Warning: Skipping file with invalid format (no mode line): $file" | |
| continue | |
| fi | |
| # Extract coverage data (skip mode line) and validate each line | |
| tail -n +2 "$file" | while IFS= read -r line; do | |
| # Skip empty lines | |
| [[ -z "$line" ]] && continue | |
| # Validate coverage line format: file.go:start.col,end.col numStmts count | |
| if [[ "$line" =~ ^[^:]+:[0-9]+\.[0-9]+,[0-9]+\.[0-9]+[[:space:]]+[0-9]+[[:space:]]+[0-9]+$ ]]; then | |
| echo "$line" >> consolidated-coverage/coverage.txt | |
| else | |
| echo "Warning: Skipping malformed coverage line: $line" | |
| fi | |
| done | |
| done | |
| echo "Baseline coverage file created:" | |
| ls -la consolidated-coverage/ | |
| echo "Total coverage lines: $(wc -l < consolidated-coverage/coverage.txt)" | |
| # Final validation of consolidated file | |
| if ! go tool cover -func=consolidated-coverage/coverage.txt >/dev/null 2>&1; then | |
| echo "❌ ERROR: Consolidated coverage file failed validation" | |
| echo "Showing first 20 lines for debugging:" | |
| head -n 20 consolidated-coverage/coverage.txt | |
| exit 1 | |
| fi | |
| echo "✅ Coverage consolidation completed successfully" | |
| - name: Upload consolidated coverage baseline | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: consolidated-code-coverage | |
| path: consolidated-coverage/coverage.txt | |
| retention-days: 90 # Keep baseline longer | |