runscope-sanity-runner
v1.0.3
Published
This command helps to runscope modules parallely and collect those result in google sheets
Downloads
329
Readme
Runscope Sanity trigger
Usage
$ npm install -g runscope-sanity-runner
$ trigger COMMAND
running command...
$ trigger (--version)
runscope-sanity-runner/1.0.3 linux-x64 node-v16.20.2
$ trigger --help [COMMAND]
USAGE
$ trigger COMMAND
...
Commands
trigger sanity
This command helps users to trigger runscope tests and send slack messages.
USAGE
$ trigger sanity -c <value>
FLAGS
-c, --config=<value> (required) Path to config file
DESCRIPTION
This command helps users to trigger runscope tests and send slack messages.
EXAMPLES
$ trigger sanity --config="./config.json"
See code: src/commands/sanity/index.ts
Config File
The following is a sample for config file
{
"slackDetails": {
"apiToken": "xoxb-*******-*********-********",
"channel": "**********"
},
"runscopeDetails": {
"envName": "*****",
"envUid": "******-****-****-****-**********",
"triggerUids": ["********-****-****-****-************"],
"webhookUrl": "********"
},
"shareReportToFollowingUsers": ["[email protected]"],
"googleCredentialsPath": "credentials.json"
}
Before using the CLI command, you need to set up a configuration file. Here's an explanation of each field in the configuration file:
- slackDetails: Contains details required for interacting with Slack.
- apiToken: Your Slack API token.
- channel: The Slack channel where notifications will be sent.
- runscopeDetails: Contains details required for integrating with Runscope.
- envName: The name of the environment.
- envUid: The UID of the environment.
- triggerUids: An array of trigger UIDs.
- webhookUrl: The URL for the webhook.
- shareReportToFollowingUsers: An array of email addresses to which reports will be shared.
- googleCredentialsPath: The file path to your Google credentials JSON file.
- threadMessagePrefix: (optional) The prefix message to be added in thread message
Retrieving Configuration Details
Here's how you can retrieve each detail required for the configuration file:
Slack API Token: Generate a Slack API token by following the official Slack API documentation. Ensure the token has appropriate permissions for sending messages to the specified channel.
Runscope Details: Obtain Runscope environment details (name, UID, trigger UIDs) from your Runscope account settings or API documentation.
- Environment name and Uuid:
- Trigger Uid: You can copy trigger uid from setting for each module
- Webhook URL
Share Report Recipients: Specify the email addresses of users to whom reports should be shared.
Google Credentials Path: Obtain Google credentials JSON file from the Google Cloud Platform Console or by following the Google API documentation.