[CERT-210] - CI GitHub Actions: Lint + Automated tests

[josephcampos-gap]

This pull request introduces several improvements to our GitHub Actions workflows and Bruno test suite. The main updates include adding a comprehensive guide for testing GitHub Actions locally, creating a new QA Scenarios workflow, and enhancing consistency and maintainability in Bruno test files. Additionally, there are important adjustments to workflow triggers and permissions.

Key changes:

GitHub Actions Workflows

• New QA Scenarios Workflow:
  • Introduced .github/workflows/qa-scenarios.yml to automate running QA scenarios on pull requests and pushes, aggregate results, upload artifacts, and comment summaries on PRs. It supports manual dispatch with environment and detail options.
• Bruno Lint Workflow Improvements:
  • Updated workflow file paths and triggers to match the new project structure (bruno/ subdirectory), and changed permissions to allow PR commenting. The workflow now explicitly supplies the GitHub token for comment steps. [1] [2]
• Local Testing Documentation:
  • Added .github/TESTING_ACTIONS_LOCALLY.md, a detailed guide on using act to test workflows locally, troubleshoot common issues, and validate the Bruno lint workflow.

Bruno Test Suite Consistency

• Parameterization of Test Data:
  • Replaced hardcoded IDs and values in several .bru files (e.g., Staff and Grade associations) with placeholder variables (e.g., [ENTER_SCHOOL_ID]) to improve reusability and clarity. [1] [2] [3] [4] [5] [6] [7]
• Minor Documentation and Assertion Updates:
  • Fixed table formatting in folder.bru and simplified a descriptor encoding script in a Student Program association test. [1] [2]

These changes collectively improve workflow automation, developer experience, and the maintainability of our test suite.

[github-actions]

Bruno Lint Report

Files Scanned: 278
Problems: 0 (Errors: 0, Warnings: 0)
✅ No blocking errors.

Triggered by workflow: lint-bruno.yml

[github-actions]

QA Scenarios Summary

Status: PASS
Entities Processed: 1
Assertions: Passed 19, Failed 0, Total 19

Entity	Passed	Failed	Total
BellSchedules	19	0	19

[stephenfuqua]

@josephcampos-gap I did not take a close look... but very happy to see you adding these files! Thank you for applying this good engineering practice.

The Ed-Fi Alliance has developed some requirements for safe use of Actions; please read https://docs.ed-fi.org/community/sdlc/continuous-integration/guidelines-for-use-of-github-actions

@jpardogrowthaccelerationpartners or @DavidJGapCR can be good resources for you in updating these workflows to match our requirements.

[stephenfuqua]

Please add a workflow for running the Ed-Fi actions scanner.

Example: https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-Data-Standard/blob/v6.0.0/.github/workflows/on-pullrequest-security.yml

[github-actions]

QA Scenarios Summary

Status: FAIL
Entities Processed: 1
Assertions: Passed 18, Failed 1, Total 19

Entity	Passed	Failed	Total
BellSchedules	18	1	19

[github-actions]

Bruno Lint Report

Files Scanned: 334
Problems: 0 (Errors: 0, Warnings: 0)
✅ No blocking errors.

Triggered by workflow: lint-bruno.yml

[github-actions]

QA Scenarios Summary

Status: PASS
Entities Processed: 1
Assertions: Passed 19, Failed 0, Total 19

Entity	Passed	Failed	Total
BellSchedules	19	0	19

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[github-actions]

Bruno Lint Report

Files Scanned: 334
Problems: 0 (Errors: 0, Warnings: 0)
✅ No blocking errors.

Triggered by workflow: lint-bruno.yml

[github-actions]

QA Scenarios Summary

Status: PASS
Entities Processed: 1
Assertions: Passed 19, Failed 0, Total 19

Entity	Passed	Failed	Total
BellSchedules	19	0	19