Document Process and Tips for Running Tests when Maintaining them

[lukehesluke]

• How to run (1). All of Test Suite (2). Individual tests
• How to use the config (e.g. NODE_APP_INSTANCE=dev)
• How to run Test Suite with a local copy of OpenActive.Server.NET

Here's how I personally run Test Suite, which may be helpful:

• Run OpenActive.Server.NET
  • (cd Examples/BookingSystem.AspNetCore.IdentityServer && dotnet run)
  • (cd Examples/BookingSystem.AspNetCore && dotnet run)
• Run Broker
  • NODE_APP_INSTANCE=dev npm run start-broker
• Run individual test
  • NODE_APP_INSTANCE=dev npm run start-tests -- packages/openactive-integration-tests/<path to test file>.js

And then, for quicker feedback, you can run tests in controlled mode, which removes the lengthy process of ingesting and sorting random opportunities by the Broker. To do this:

• in OpenActive.Server.NET, change OpportunityCount to 1 in FakeBookingSystem.cs (I believe there's an ev var for that)
• Run the tests with: NODE_APP_INSTANCE=dev NODE_CONFIG='{"integrationTests": {"useRandomOpportunities": false}}' npm run start-tests -- packages/openactive-integration-tests/<path to test file>.js

[lukehesluke]

There's a lot of aspects to this issue (before the description was edited to its newer more focused goal):

• How FlowStages work: Already covered here: Document how Test Suite FlowStages work, including the philosophy behind them #557
• How to write a new test, Explanation of Features, : Already covered here: Document how to add a new test to test suite for new contributors #561
• How to run, alongside Ref Impl: I think this is still lacking, but will double check