Page Comparison

The Ed-Fi ODS / API includes several collections of Postman tests that can be executed against a Test Harness included in the ODS / API source code.

The following instructions assume that the Ed-Fi ODS / API has been successfully set up and is running in a local environment per the instructions in the Getting Started documentation. This documentation takes you through running two options for running postman test collections:

Table of Contents

maxLevel	2
minLevel	2

Running Postman Test Collections via PowerShell

Install NVM, for windows systems you could use nvm for Windows
As outlined in the Getting Started Guide from a PowerShell prompt run Initialize-PowershellForDevelopment.ps1 script followed by initdev -usePlugins and finally Invoke-PostmanIntegrationTests
Test results are presented as the tests run

Info

To capture the execution output of the Postman tests into a log file for full review (since the console window buffer may not be large enough to review the entire results of the test), you can do the following:

Create a script (e.g. run-postman-tests-core.ps1) in the Ed-Fi-ODS-Implementation folder with the following content:
Code Block
.\Initialize-PowershellForDevelopment.ps1 Invoke-PostmanIntegrationTests
Create a second script (e.g. run-postman-tests.ps1) in the Ed-Fi-ODS-Implementation folder with the following content:
Code Block
Start-Process powershell.exe .\run-postman-tests-core.ps1 -RedirectStandardOutput .\tests.log

This will capture the stdout from the process and write it to the specified log file instead. The shell window that is opened won't show any activity during the test run, so you'll just need to wait until it finishes.

Running Postman Test Collections via Postman

Install and launch Postman.
Run the EdFi.Ods.Api.IntegrationTestHarness project from the ODS solution. This will create the Postman Environment file required for the tests to run.
1. Run the EdFi.Ods.Api.IntegrationTestHarness project. Test Harness will create test API clients in the EdFi_Admin_Test database, create a Postman environment file and run a test API instance for the Postman tests to interact with.
2. After the test harness is running, import the generated environment file located at ~Ed-Fi-ODS-Implementation\logistics\scripts\modules
3. Ensure the environment is selected on the to right corner of Postman window.
Locate (or download) the Ed-Fi ODS Integration Test Suite collections from the Ed-Fi-ODS GitHub repository. See the reference section on the right for GitHub link.
Import one or more of the collections into Postman using the Import function located in the upper left corner of the Postman window.
Run the tests using the Collection Runner.
Monitor test execution and review the test results.