Merge pull request #384 from RaphaelBut/fix-generate

Simplify local testing steps

Author: openshift-merge-bot[bot]

README.md

@@ -76,7 +76,6 @@ To add a new alert investigation:
 > **Note:** When writing an investiation, you can use them right away.
 They are initialized for you and passed to the investigation via investigation.Resources.
 
-
 * [AWS](https://github.com/aws/aws-sdk-go) -- Logging into the cluster, retreiving instance info and AWS CloudTrail events.
     - See `pkg/aws`
 * [PagerDuty](https://github.com/PagerDuty/go-pagerduty) -- Retrieving alert info, esclating or silencing incidents, and adding notes.
@@ -90,24 +89,28 @@ They are initialized for you and passed to the investigation via investigation.R
 
 ## Testing locally
 
-### Pre-requirements
-- an existing cluster
-- an existing PagerDuty incident for the cluster and alert type that is being tested
-
-To quickly create an incident for a cluster_id, you can run `./test/generate_incident.sh <alertname> <clusterid>`.
-Example usage:`./test/generate_incident.sh ClusterHasGoneMissing 2b94brrrrrrrrrrrrrrrrrrhkaj`.
-
-### Running cadctl for an incident ID
-1) Export the required ENV variables, see [required ENV variables](#required-env-variables).
-2) Create a payload file containing the incident ID
-  ```bash
-  export INCIDENT_ID=
-  echo '{"__pd_metadata":{"incident":{"id":"'${INCIDENT_ID}'"}}}' > ./payload
-  ```
-3) Run `cadctl` using the payload file
-  ```bash
-  ./bin/cadctl investigate --payload-path payload
-  ```
+Requires an existing cluster.
+
+1. Create a test incident and payload file for your cluster
+
+   ```bash
+   ./test/generate_incident.sh <alertname> <clusterid>
+   ```
+
+2. Export the required env variables from vault
+
+   > **Note:** For information on the envs see [required env variables](#required-env-variables).
+
+   ```
+   source test/set_stage_env.sh
+   ```
+
+3. `make build`
+4. Run `cadctl` with the payload file created by `test/generate_incident.sh`
+
+   ```bash
+   ./bin/cadctl investigate --payload-path payload
+   ```
 
 ### Logging levels
 

test/generate_incident.sh

@@ -1,15 +1,6 @@
 #!/bin/bash
 set -e
 
-# Check if pd_token variable is set
-if [ -z "$pd_token" ]; then
-  echo "Warning: pd_token is not set. For more information, see https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTUx-authentication."
-  echo "The pd_token is needed to automatically retrieve the incident after creating it."
-  echo "You can still search in the service directory for the created incident, but setting the pd_token ENV in the future will facilitate getting the created incident id."
-  echo
-  echo
-fi
-
 # Define the mapping of alert names to titles
 # Add more mappings as needed: for the standard service, we should not need to go by title but by the `alertname` field instead.
 declare -A alert_mapping=(
@@ -25,7 +16,7 @@ print_help() {
     for alert_name in "${!alert_mapping[@]}"; do
         echo -n "$alert_name, "
     done
-    echo 
+    echo
 }
 # Check if the correct number of arguments is provided
 if [ "$#" -ne 2 ]; then
@@ -49,9 +40,9 @@ alert_title="${alert_mapping[$alert_name]}"
 # Load testing routing key and test service url from vault
 export VAULT_ADDR="https://vault.devshift.net"
 export VAULT_TOKEN="$(vault login -method=oidc -token-only)"
-for v in $(vault kv get  -format=json osd-sre/configuration-anomaly-detection/cad-testing | jq -r ".data.data|to_entries|map(\"\(.key)=\(.value|tostring)\")|.[]"); do export $v; done	
+for v in $(vault kv get  -format=json osd-sre/configuration-anomaly-detection/cad-testing | jq -r ".data.data|to_entries|map(\"\(.key)=\(.value|tostring)\")|.[]"); do export $v; done
 unset VAULT_ADDR VAULT_TOKEN
-echo 
+echo
 
 dedup_key=$(uuidgen)
 
@@ -82,20 +73,14 @@ if [[ $response != *"Event processed"* ]]; then
 fi
 echo
 
-# Point to the service directory if we can't auto retrieve the incident via the pd token
-if [ -z "$pd_token" ]; then
-  echo "Incident successfully created. See ${pd_test_service_url} to retrieve the incident ID."
-  exit 0
-fi
-
 # Pagerduty seems to need a short while to create the incident
 # Added this as we intermittently fail to get the incident id otherwise
 sleep 2
 
 INCIDENT_ID=$(curl --silent --request GET \
   --url "https://api.pagerduty.com/incidents?incident_key=${dedup_key}" \
   --header 'Accept: application/json' \
-  --header "Authorization: Token token=${pd_token}" \
+  --header "Authorization: Token token=${pd_test_token}" \
   --header 'Content-Type: application/json' | jq -r '.incidents[0].id')
 echo $INCIDENT_ID
 echo '{"__pd_metadata":{"incident":{"id":"'$INCIDENT_ID'"}}}' > ./payload