Verify htcli has been installed using the below command:
htcli--help
Getting Started:
1. Generate a CLI auth token
Go to your accounts page
Click to create a new CLI token
Copy the newly generated CLI token to use in the test configuration file in the next step
2. Create a Test Configuration File
Available Configurations:
.htTestConf.js
constrequestTypes= { HTTP:'HTTP', GRAPHQL:'GRAPHQL', KAFKA:'KAFKA', GRPC:'GRPC', AMQP:'AMQP',};module.exports= { htBackendBaseUrl:"",// URL of HyperTest server (Required) htCliRefreshToken:"",// Auth token for the CLI (Required) serviceIdentifier:"",// UUID for the service (Required) requestTypesToTest: [requestTypes.HTTP],// What kind of requests to include in the test httpCandidateUrl:"",// HTTP URL of App under test (Optional)// graphqlCandidateUrl: "", // GraphQL URL of App under test (Optional) appStartCommand:"",// Command to start the app (Required) appStartCommandArgs: ["<Argument 1>","<Argument 2>"],// App start command arguments (Required) appWorkingDirectory: __dirname,// Working directory for the app (default: current working dir) (Optional) appStartTimeoutSec:30,// Timeout in seconds for the start command (default: 10) (Optional) showAppLogs:true,// Whether to show app logs (default: false) (Optional) shouldReportHeaderDiffs:false,// Whether to report differences in headers (default: false) (Optional) testBatchSize:50,// Number of concurrent test requests (default: 50) (Optional)//testRequestsLimit": 10, // Number requests to test (Optional)//httpReqFiltersArr: [], // "<GET /users>", "<ANY REGEX:^/payments>" (Optional) htExtraHeaders: { // Object containing additional headers for HyperTest server requests (Optional)// authorization: 'Bearer xyz' },// exitCodeSetter({ testResult }) {// console.log('==test results==')// console.log(testResult)// return 0;//},// initialTimestamp: "", // Initial timestamp in ISO format (Optional)// finalTimestamp: "", // Final timestamp in ISO format (Optional) // cliServerHost: "", // HT CLI server Host to be Used by Clients(server ignores this) (default: localhost) (Optional)
// sdkServerHost: "", // HT SDK server Host to be Used by Clients(server ignores this) (default: localhost) (Optional)
};