To better understand how to use Prancer, read the different sections below. They detail the high level workflows of Prancer.

Developing tests

Working with Prancer itself is a straightforward activity and needs only a few steps:

  1. Create a Prancer project directory in your web application's project directory
  2. Configure the connectors for each required providers
  3. Create containers with snapshot configuration files in them
  4. Create test files
  5. Run the tests

Some of these steps are more involved than others but the general workflow is straightforward and simple to understand to keep the learning curve as simple as possible.

Running tests

Running a test and gathering results was kept to the most simple steps possible so that integration into an existing continuous improvement/continuous deployment pipeline stays as simple as possible. The last thing you want is to use a tool that is cumbersome:

  1. Checkout your web application project
  2. Go to the Prancer project directory
  3. Run the tool and act on return code
  4. Save the outputs as artifacts for later viewing

Integrating with a CI/CD pipeline can be as simple as running a simple BaSH script in a folder with an if statement around it to catch potential failures. With the files written to disk, you can then dig into the results as you want by parsing the simple JSON files.

The validation workflow

Each time the tool is ran, the test suite is executed in a sequential way:

  1. Configuration files are read (Project configuration, Connector configuration, Snapshot configuration, Tests)
  2. Providers are communicated with, snapshots are built and then saved to the database
  3. Tests are ran againsts the snapshots
  4. Reports are produced

High-Level process