Merge pull request #360 from MateSaary/main

OSD-28248: Investigation bootstrap make target

Author: openshift-merge-bot[bot]

Makefile

@@ -83,6 +83,11 @@ test-interceptor-e2e: check-go121-install check-jq-install check-vault-install b
 	@echo "Running e2e tests for interceptor..."
 	cd interceptor && ./test/e2e.sh
 
+##@ Boilerplate:
+.PHONY: boilerplate
+bootstrap-investigation: ## Bootstrap a new boilerplate investigation
+	@cd hack && ./bootstrap-investigation.sh
+
 ##@ Template-updater:
 .PHONY: template-updater
 template-updater: build-template-updater lint-template-updater ## Run all targets for template-updater

README.md

@@ -43,30 +43,31 @@ CAD consists of:
 
 1) [PagerDuty Webhooks](https://support.pagerduty.com/docs/webhooks) are used to trigger Configuration-Anomaly-Detection when a [PagerDuty incident](https://support.pagerduty.com/docs/incidents) is created
 2) The webhook routes to a [Tekton EventListener](https://tekton.dev/docs/triggers/eventlisteners/)
-3) Received webhooks are filtered by a [Tekton Interceptor](https://tekton.dev/docs/triggers/interceptors/) that uses the payload to evaluate whether the alert has an implemented handler function in `cadctl` or not. If there is no handler implemented, the alert is directly forwarded to a human SRE. 
+3) Received webhooks are filtered by a [Tekton Interceptor](https://tekton.dev/docs/triggers/interceptors/) that uses the payload to evaluate whether the alert has an implemented handler function in `cadctl` or not. If there is no handler implemented, the alert is directly forwarded to a human SRE.
 4) If `cadctl` implements a handler for the received payload/alert, a [Tekton PipelineRun](https://tekton.dev/docs/pipelines/pipelineruns/) is started.
-5) The pipeline runs `cadctl` which determines the handler function by itself based on the payload. 
+5) The pipeline runs `cadctl` which determines the handler function by itself based on the payload.
 
 ![CAD Overview](./images/cad_overview/cad_architecture_dark.png#gh-dark-mode-only)
 ![CAD Overview](./images/cad_overview/cad_architecture_light.png#gh-light-mode-only)
 
-## Contributing 
+## Contributing
 
 ### Building
 
-For build targets, see `make help`. 
+For build targets, see `make help`.
 
 ### Adding a new investigation
 
 CAD investigations are triggered by PagerDuty webhooks. Currently, CAD supports the following two formats of webhooks:
--  WebhookV3 
+-  WebhookV3
 -  EventOrchestrationWebhook
 
-The required investigation is identified by CAD based on the incident and its payload. 
+The required investigation is identified by CAD based on the incident and its payload.
 As PagerDuty itself does not provide finer granularity for webhooks than service-based, CAD filters out the alerts it should investigate. For more information, please refer to https://support.pagerduty.com/docs/webhooks.
 
 To add a new alert investigation:
-- Create a mapping for the alert in `registry.go` and write a corresponding CAD investigation (e.g. `Investigate()` in `chgm.go`).
+
+- run `make bootstrap-investigation` to generate boilerplate code in `pkg/investigations` (This creates the corresponding folder & .go file, and also appends the investigation to the `availableInvestigations` interface in `registry.go`.).
 - investigation.Resources contain initialized clients for the clusters aws environment, ocm and more. See [Integrations](#integrations)
 
 ### Integrations
@@ -86,14 +87,13 @@ They are initialized for you and passed to the investigation via investigation.R
 * [k8sclient](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/client) -- Interact with clusters kube-api
     - Requires RBAC definitions for your investigation to be added to `metadata.yaml`
 
-
 ## 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>`. 
+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

hack/bootstrap-investigation.sh

@@ -0,0 +1,119 @@
+#!/usr/bin/env bash
+
+set -e
+
+read -p "Enter the new investigation (package) name: " INVESTIGATION_NAME
+if [[ "${INVESTIGATION_NAME}" == "" ]] ; then
+	echo "Investigation name cannot be empty."
+	exit 1
+elif [[ "${INVESTIGATION_NAME}" =~ [^a-zA-Z0-9_] ]] ; then
+	echo "Investigation name must be alphanumeric."
+	exit 1
+fi
+
+read -p "Enter new investigation description: " INVESTIGATION_DESCRIPTION
+if [[ "${INVESTIGATION_DESCRIPTION}" == "" ]] ; then
+	INVESTIGATION_DESCRIPTION="TODO"
+fi
+
+read -p "Should Investigate Alert (y/n): " INVESTIGATE_ALERT_BOOL
+if [[ "${INVESTIGATE_ALERT_BOOL}" == "y" ]] ; then
+	read -p "Investigation alert string: " INVESTIGATION_ALERT_STRING
+	INVESTIGATION_ALERT="strings.Contains(alert, \"${INVESTIGATION_ALERT_STRING}\")"
+elif [[ "${INVESTIGATE_ALERT_BOOL}" == "n" ]] ; then
+	INVESTIGATION_ALERT="false"
+else
+	echo "Invalid input. Please enter 'y' or 'n'."
+	exit 1
+fi
+
+INVESTIGATION_NAME=$(echo "${INVESTIGATION_NAME}" | tr '[:upper:]' '[:lower:]')
+
+INVESTIGATION_DIR="../pkg/investigations/${INVESTIGATION_NAME}"
+
+if [ -d "${INVESTIGATION_DIR}" ]; then
+    echo "Investigation of name ${INVESTIGATION_NAME} already exists."
+    exit 1
+fi
+
+mkdir -p "${INVESTIGATION_DIR}"
+ls "${INVESTIGATION_DIR}"
+
+touch "${INVESTIGATION_DIR}/${INVESTIGATION_NAME}.go"
+touch "${INVESTIGATION_DIR}/metadata.yaml"
+touch "${INVESTIGATION_DIR}/README.md"
+
+# Create README.md file
+cat <<EOF > "${INVESTIGATION_DIR}/README.md"
+# ${INVESTIGATION_NAME} Investigation
+
+${INVESTIGATION_DESCRIPTION}
+
+EOF
+
+# Create metadata.yaml file
+cat <<EOF > "${INVESTIGATION_DIR}/metadata.yaml"
+name: ${INVESTIGATION_NAME}
+rbac:
+  roles: []
+  clusterRoleRules: []
+customerDataAccess: false
+
+EOF
+
+# Create boilerplate investigation file
+cat <<EOF > "${INVESTIGATION_DIR}/${INVESTIGATION_NAME}.go"
+// Package ${INVESTIGATION_NAME} contains...TODO
+package ${INVESTIGATION_NAME}
+
+import (
+	"strings"
+
+	"github.com/openshift/configuration-anomaly-detection/pkg/investigations/investigation"
+	"github.com/openshift/configuration-anomaly-detection/pkg/logging"
+	"github.com/openshift/configuration-anomaly-detection/pkg/notewriter"
+)
+
+type Investigation struct{}
+
+func (c *Investigation) Run(r *investigation.Resources) (investigation.InvestigationResult, error) {
+	result := investigation.InvestigationResult{}
+
+	// Initialize PagerDuty note writer
+	notes := notewriter.New(r.Name, logging.RawLogger)
+
+	// TODO: Implement investigation logic here
+
+	return result, r.PdClient.EscalateIncidentWithNote(notes.String())
+}
+
+func (c *Investigation) Name() string {
+	return "${INVESTIGATION_NAME}"
+}
+
+func (c *Investigation) Description() string {
+	return "${INVESTIGATION_DESCRIPTION}"
+}
+
+func (c *Investigation) ShouldInvestigateAlert(alert string) bool {
+	return ${INVESTIGATION_ALERT}
+}
+
+func (c *Investigation) IsExperimental() bool {
+	// TODO: Update to false when graduating to production.
+	return true
+}
+
+EOF
+
+echo "${INVESTIGATION_NAME} created in ${INVESTIGATION_DIR}"
+echo "metadata.yaml file created in ${INVESTIGATION_DIR}"
+
+# Update registry.go to contain new investigation
+if ! grep -q "${INVESTIGATION_NAME}" ../pkg/investigations/registry.go && ! grep -q "${INVESTIGATION_NAME}" ../pkg/investigations/registry.go; then
+	sed -i "/import (/a \\\t\"github.com/openshift/configuration-anomaly-detection/pkg/investigations/${INVESTIGATION_NAME}\"" ../pkg/investigations/registry.go
+    sed -i "/var availableInvestigations = \[/a \\\t&${INVESTIGATION_NAME}.Investigation{}," ../pkg/investigations/registry.go
+    echo "${INVESTIGATION_NAME} added to registry.go"
+else
+    echo "${INVESTIGATION_NAME} already exists in registry.go"
+fi