Skip to content

Ed-Fi-Alliance-OSS/certification-testing

Repository files navigation

Ed-Fi Certification Testing

Bruno Test scripts for the Ed-Fi Certification process.

The goal of this Certification Automation suite is to streamline operations for the Ed-Fi Alliance, speed up development and certification times for our partners, and allowing our partners to perform more self-servicing of their own testing needs.

Background

In 2024-2025, the Alliance tested an approach to move from manual validation with SQL scripts to using the API itself for validation. This approach sought to bring in as much automation as possible, leveraging API testing platforms to heavy lifting.

Version 1 of the release used Postman as the platform of choice, which is available as a legacy release option.

Our latest Version 2 release utilizes Bruno, which brings additional features including Git friendly code structure, API client (not platform) focus, and a CLI runnner to execute tests in a headless fashion.

SIS Certification User Manual

If you are a SIS vendor tester using the Bruno app (GUI), please refer to the end-user manual:

This manual provides version-agnostic setup, .env credentials, environment selection, and step-by-step scenario execution guidance.

Testing GitHub Actions Locally

For contributors who want to validate workflows (e.g., Bruno lint) without pushing to GitHub, see:

The guide covers installing act, running specific workflows, handling artifacts, and common troubleshooting tips.

Automated Scenario Runner

For advanced, automated execution of Bruno scenarios (intended for contributors and CI, not required for SIS vendor testers), see:

This guide explains the run-scenarios.cjs script, configuration, outputs, and flags for batch runs.

Scenario Generation Spec (AI‑Gen)

For teams working with automated generation of SIS certification scenarios, see the project specification:

This document defines folder structure conventions, entity configuration requirements, descriptor encoding (sentinel pattern), assertion strategy (REQUIRED vs OPTIONAL/CONDITIONAL), logging rules, and naming standards used by the AI‑driven scenario generation.

Bruno Collection Guide (Developer‑Focused)

For engineers working directly with the Bruno collections, scripting, and advanced patterns, see:

This guide covers Developer Mode, external libraries, script lifecycle, assertions, reporting/automation, and contribution patterns.

Legal Information

Copyright (c) 2024 Ed-Fi Alliance, LLC and contributors.

Licensed under the Apache License, Version 2.0 (the "License").

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.

About

Testing scripts for the certification process

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 9

Languages