This is a Crank Cog for Goldcast, providing steps and assertions for you to validate the state and behavior of your Goldcast instance.
Ensure you have the crank CLI and docker installed and running locally,
then run the following. You'll be prompted to enter your Goldcast
credentials once the Cog is successfully installed.
$ crank cog:install stackmoxie/goldcast
Note: You can always re-authenticate later.
You will be asked for the following authentication details on installation. To avoid prompts in a CI/CD context, you can provide the same details as environment variables.
| Field | Install-Time Environment Variable | Description |
|---|---|---|
| token | CRANK_STACKMOXIE_GOLDCAST__TOKEN |
Personal Access Token |
# Re-authenticate by running this
$ crank cog:auth stackmoxie/goldcast
Once installed, the following steps will be available for use in any of your Scenario files.
| Name (ID) | Expression | Expected Data |
|---|---|---|
| Check a field on a Goldcast Event ( EventFieldEqualsStep) |
the (?<field>[a-zA-Z0-9_-]+) field on goldcast event (?<eventId>[a-zA-Z0-9_-]+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain|match|not match) ?(?<expectation>.+)? |
- eventId: The event ID - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectation: Expected field value |
| Check a field on a Goldcast Event Member ( EventMemberFieldEqualsStep) |
the (?<field>[a-zA-Z0-9_-]+) field on goldcast event member (?<memberId>[a-zA-Z0-9_-]+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain|match|not match) ?(?<expectation>.+)? |
- memberId: The member's ID - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectation: Expected field value |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to add or update tests as appropriate.
- Install node.js (v12.x+ recommended)
- Clone this repository.
- Install dependencies via
npm install - Run
npm startto validate the Cog works locally (ctrl+cto kill it) - Run
crank cog:install --source=local --local-start-command="npm start"to register your local instance of this Cog. You may need to append a--forceflag or runcrank cog:uninstall stackmoxie/goldcastif you've already installed the distributed version of this Cog.
Modify code in src/steps and validate your changes by running
crank cog:step stackmoxie/goldcast and selecting your step.
To add new steps, create new step classes in src/steps. Use existing steps as
a starting point for your new step(s). Note that you will need to run
crank registry:rebuild in order for your new steps to be recognized.
Always add tests for your steps in the test/steps folder. Use existing tests
as a guide.
Modify the ClientWrapper class at src/client/client-wrapper.ts.
- If you need to add or modify authentication details, see the
expectedAuthFieldsstatic property. - If you need to expose additional logic from the wrapped API client, add a new public method to the wrapper class or mixins, which can then be called in any step.
- It's also possible to swap out the wrapped API client completely. You should only have to modify code within this class or mixins to achieve that.
Note that you will need to run crank registry:rebuild in order for any
changes to authentication fields to be reflected. Afterward, you can
re-authenticate this Cog by running crank cog:auth stackmoxie/goldcast
Tests can be found in the test directory and run like this: npm test.
Ensure your code meets standards by running npm run lint.