Merge pull request #377 from tnierman/osd-28775

OSD-28775 - Add basic instructions to include test objects for new investigations

Author: openshift-merge-bot[bot]

README.md

@@ -69,6 +69,7 @@ To add a new alert investigation:
 
 - 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)
+- Add test objects or scripts used to recreate the alert symptoms to the `pkg/investigations/$INVESTIGATION_NAME/testing/` directory for future use. Be sure to clearly document the testing procedure under the `Testing` section of the investigation-specific README.md file
 
 ### Integrations
 

hack/bootstrap-investigation.sh

@@ -42,15 +42,30 @@ ls "${INVESTIGATION_DIR}"
 touch "${INVESTIGATION_DIR}/${INVESTIGATION_NAME}.go"
 touch "${INVESTIGATION_DIR}/metadata.yaml"
 touch "${INVESTIGATION_DIR}/README.md"
+mkdir "${INVESTIGATION_DIR}/testing/"
 
 # Create README.md file
 cat <<EOF > "${INVESTIGATION_DIR}/README.md"
 # ${INVESTIGATION_NAME} Investigation
 
 ${INVESTIGATION_DESCRIPTION}
 
+## Testing
+
+Refer to the [testing README](./testing/README.md) for instructions on testing this investigation
+
+EOF
+
+# Create testing/README.md file
+cat <<EOF > "${INVESTIGATION_DIR}/testing/README.md"
+# Testing ${INVESTIGATION_NAME} Investigation
+
+TODO:
+- Add a test script or test objects to this `testing/` directory for future maintainers to use
+- Edit this README file and add detailed instructions on how to use the script/objects to recreate the conditions for the investigation. Be sure to include any assumptions or prerequisites about the environment (disable hive syncsetting, etc)
 EOF
 
+
 # Create metadata.yaml file
 cat <<EOF > "${INVESTIGATION_DIR}/metadata.yaml"
 name: ${INVESTIGATION_NAME}