First-time Setup

If this is your first time testing, or working with Heroku, first read through the Postman workspace setup wiki and follow through all of the steps to make a new collection for your Heroku tests. This will save you lots of time and headache down the road!

Postman Config

To send post requests for the pipeline to process, we use a program called Postman. You can use either the Postman program found here, or create an account and use the browser version here.

1. Make sure you set up a new collection for storing your Heroku testing post requests.
2. Set up a template Heroku post request to duplicate for test cases.
3. Create a new test case post request by following the steps in the linked wiki. Save a copy of your template to make a new post request that you can work in without changing your template.

Following the above steps will save you time that you would otherwise spend configuring each new post request you make, or having to revert your template because you changed it to test something and overwrote the default input that actually works!

This workflow lets you save and share your test inputs with the team and make GitHub issues with. Keeping your test cases intact as their own requests is crucial for helping the team, so once you have a hand of Postman whatever system you want to use just make sure you keep everything tracked and saved.

Testing with Heroku is super simple, no other steps required. Happy hunting!

Debugging

There is an option in the current main.py that looks for a defined "debug" value in the postman request. As of 7/18/23, this means you need to go into the postman request and define a variable as debug, and set a value to "yes" or "no".