chore: add slack messaging capability to the self-test.sh script

See docs/self-test/roberta/README.md for details

Author: starpit

deploy/self-test/roberta/1gpu/once.yaml

@@ -55,6 +55,26 @@ spec:
           #  value: "-V"
           - name: VARIANTS
             value: roberta-1gpu
+          - name: SLACK_TEAMID
+            valueFrom:
+              secretKeyRef:
+                name: codeflare-self-test-slack
+                key: TEAMID
+          - name: SLACK_CHANNELID
+            valueFrom:
+              secretKeyRef:
+                name: codeflare-self-test-slack
+                key: CHANNELID
+          - name: SLACK_TOKEN
+            valueFrom:
+              secretKeyRef:
+                name: codeflare-self-test-slack
+                key: TOKEN
+          - name: SLACK_USERNAME
+            valueFrom:
+              secretKeyRef:
+                name: codeflare-self-test-slack
+                key: USERNAME
           - name: ML_CODEFLARE_ROBERTA_GITHUB_USER
             valueFrom:
               secretKeyRef:

deploy/self-test/roberta/1gpu/periodic.yaml

@@ -59,6 +59,26 @@ spec:
               #  value: "-V"
               - name: VARIANTS
                 value: roberta-1gpu
+              - name: SLACK_TEAMID
+                valueFrom:
+                  secretKeyRef:
+                    name: codeflare-self-test-slack
+                    key: TEAMID
+              - name: SLACK_CHANNELID
+                valueFrom:
+                  secretKeyRef:
+                    name: codeflare-self-test-slack
+                    key: CHANNELID
+              - name: SLACK_TOKEN
+                valueFrom:
+                  secretKeyRef:
+                    name: codeflare-self-test-slack
+                    key: TOKEN
+              - name: SLACK_USERNAME
+                valueFrom:
+                  secretKeyRef:
+                    name: codeflare-self-test-slack
+                    key: USERNAME
               - name: ML_CODEFLARE_ROBERTA_GITHUB_USER
                 valueFrom:
                   secretKeyRef:

deploy/self-test/self-test.sh

@@ -17,10 +17,38 @@ else
 fi
 echo "Using these variants: $variants"
 
+function cleanup {
+    STATUS=$?
+
+    TEAMID=$SLACK_TEAMID
+    CHANNELID=$SLACK_CHANNELID
+    TOKEN=$SLACK_TOKEN
+    USERNAME=${SLACK_USERNAME-"Self-test Bot"}
+
+    if [ -n "$TEAMID" ] && [ -n "$CHANNELID" ] && [ -n "$TOKEN" ]; then
+        if [ "$STATUS" = "0" ]; then
+            ICON=":green_heart:"
+            TEXT="$(date)\nSuccessful run\nVariants: $variants"
+        else
+            ICON=":red-siren:"
+            TEXT="$(date)\nFailed run\nVariants: $variants"
+            # TODO, add tee'd logs of failing run
+        fi
+
+
+        curl -X POST \
+             --data-urlencode "payload={\"channel\": \"#$CHANNEL\", \"username\": \"$USERNAME\", \"text\": \"$TEXT\", \"icon_emoji\": \"$ICON\"}" \
+             https://hooks.slack.com/services/$TEAMID/$CHANNELID/$TOKEN
+    fi
+}
+
+trap "cleanup" EXIT
+
 for variant in $variants; do
     # for profile in ./tests/kind/profiles/*; do
     for profile in $variant/keep-it-simple; do
         echo "================== $profile =================="
+        # TODO tee logs so that we can send them to slack
         ./tests/kind/run.sh -i $profile
     done
 done

docs/self-test/roberta/README.md

@@ -34,11 +34,34 @@ export GITHUB_TOKEN=mygithubtoken
 ```
 
 ```shell
-kubectl create secret github \
+kubectl create secret generic github \
     --from-literal=GITHUB_USER=$(echo -n $GITHUB_USER | base64) \
     --from-literal=GITHUB_TOKEN=$(echo -n $GITHUB_TOKEN | base64)
 ```
 
+## Create a `slack` secret, if desired
+
+If you wish to post to a Slack channel, create a Kubernetes secret named `codeflare-self-test-slack` with the following data fields:
+
+```shell
+export SLACK_TEAMID=myteamid
+```
+
+```shell
+export SLACK_CHANNELID=mychannelid
+```
+
+```shell
+export SLACK_TOKEN=mytoken
+```
+
+```shell
+kubectl create secret generic codeflare-self-test-slack \
+    --from-literal=TEAMID=$(echo -n SLACK_TEAMID | base64) \
+    --from-literal=CHANNELID=$(echo -n SLACK_CHANNELID | base64) \
+    --from-literal=TOKEN=$(echo -n SLACK_TOKEN | base64)
+```
+
 ### Deploy the automation
 
 ```shell