CHAOSPLT-751: Add a slackUserEmail field to spec.reporting (#983)

* Added slack email field to reporting

* made slack channel optional

* revised logic of buildSlackMessage

* small logic change to email parsing

* added another error check

* added test cases

Author: JadenR07

api/v1beta1/disruption_types.go

@@ -124,25 +124,40 @@ type Reporting struct {
 	// It's expected to follow slack naming conventions https://api.slack.com/methods/conversations.create#naming or slack channel ID format
 	// +kubebuilder:validation:MaxLength=80
 	// +kubebuilder:validation:Pattern=(^[a-z0-9-_]+$)|(^C[A-Z0-9]+$)
-	// +kubebuilder:validation:Required
-	SlackChannel string `json:"slackChannel,omitempty" chaos_validate:"required"`
+	SlackChannel string `json:"slackChannel,omitempty"`
 	// Purpose determines contextual informations about the disruption
 	// a brief context to determines disruption goal
 	// +kubebuilder:validation:MinLength=10
-	// +kubebuilder:validation:Required
 	Purpose string `json:"purpose,omitempty"`
 	// MinNotificationType is the minimal notification type we want to receive informations for
 	// In order of importance it's Info, Success, Warning, Error
 	// Default level is considered Success, meaning all info will be ignored
 	MinNotificationType eventtypes.NotificationType `json:"minNotificationType,omitempty"`
+	// SlackUserEmail is the email of the user to send reporting information to
+	// +kubebuilder:validation:MaxLength=320
+	SlackUserEmail string `json:"slackUserEmail,omitempty" chaos_validate:"email"`
 }
 
 func (r *Reporting) Explain() string {
-	return fmt.Sprintf("While the disruption is ongoing, it will send slack messages for every event of severity %s or higher, "+
-		"to the slack channel with the ID (not name) %s, mentioning the purpose \"%s\"",
-		r.MinNotificationType,
-		r.SlackChannel,
-		r.Purpose)
+	parts := []string{"While the disruption is ongoing, it will send Slack messages"}
+
+	if r.MinNotificationType != "" {
+		parts = append(parts, fmt.Sprintf("for every event of severity %s or higher", r.MinNotificationType))
+	}
+
+	if r.SlackChannel != "" {
+		parts = append(parts, fmt.Sprintf("to the Slack channel with the ID (not name) %s", r.SlackChannel))
+	}
+
+	if r.SlackUserEmail != "" {
+		parts = append(parts, fmt.Sprintf("and user %s", r.SlackUserEmail))
+	}
+
+	if r.Purpose != "" {
+		parts = append(parts, fmt.Sprintf("mentioning the purpose \"%s\"", r.Purpose))
+	}
+
+	return strings.Join(parts, ", ") + "."
 }
 
 // EmbeddedChaosAPI includes the library so it can be statically exported to chaosli

chart/templates/generated/chaos.datadoghq.com_disruptioncrons.yaml

@@ -535,6 +535,10 @@ spec:
                           maxLength: 80
                           pattern: (^[a-z0-9-_]+$)|(^C[A-Z0-9]+$)
                           type: string
+                        slackUserEmail:
+                          description: SlackUserEmail is the email of the user to send reporting information to
+                          maxLength: 320
+                          type: string
                       type: object
                     selector:
                       additionalProperties:
@@ -654,6 +658,10 @@ spec:
                       maxLength: 80
                       pattern: (^[a-z0-9-_]+$)|(^C[A-Z0-9]+$)
                       type: string
+                    slackUserEmail:
+                      description: SlackUserEmail is the email of the user to send reporting information to
+                      maxLength: 320
+                      type: string
                   type: object
                 schedule:
                   description: The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

chart/templates/generated/chaos.datadoghq.com_disruptionrollouts.yaml

@@ -536,6 +536,10 @@ spec:
                           maxLength: 80
                           pattern: (^[a-z0-9-_]+$)|(^C[A-Z0-9]+$)
                           type: string
+                        slackUserEmail:
+                          description: SlackUserEmail is the email of the user to send reporting information to
+                          maxLength: 320
+                          type: string
                       type: object
                     selector:
                       additionalProperties:

chart/templates/generated/chaos.datadoghq.com_disruptions.yaml

@@ -526,6 +526,10 @@ spec:
                       maxLength: 80
                       pattern: (^[a-z0-9-_]+$)|(^C[A-Z0-9]+$)
                       type: string
+                    slackUserEmail:
+                      description: SlackUserEmail is the email of the user to send reporting information to
+                      maxLength: 320
+                      type: string
                   type: object
                 selector:
                   additionalProperties:

eventnotifier/slack/slack.go

@@ -41,7 +41,7 @@ type slackMessage struct {
 	BodyText    string
 	BodyBlock   slack.SectionBlock
 	InfoBlocks  []*slack.TextBlockObject
-	UserInfo    authv1.UserInfo
+	UserEmail   string
 }
 
 type NotifierSlackConfig struct {
@@ -180,16 +180,16 @@ func (n *Notifier) notifyForDisruptionCron(disruptionCron *v1beta1.DisruptionCro
 }
 
 func (n *Notifier) sendMessageToUserChannel(slackMsg slackMessage, logger *zap.SugaredLogger) error {
-	emailAddr, err := mail.ParseAddress(slackMsg.UserInfo.Username)
+	emailAddr, err := mail.ParseAddress(slackMsg.UserEmail)
 	if err != nil {
-		logger.Infow("username could not be parsed as an email address", "err", err, "username", slackMsg.UserInfo.Username)
+		logger.Infow("username could not be parsed as an email address", "err", err, "username", slackMsg.UserEmail)
 
 		return nil
 	}
 
 	p1, err := n.client.GetUserByEmail(emailAddr.Address)
 	if err != nil {
-		logger.Warnw("user not found", "userAddress", emailAddr.Address, "error", err)
+		logger.Warnw("user not found", "userAddress", slackMsg.UserEmail, "error", err)
 
 		return nil
 	}
@@ -199,8 +199,8 @@ func (n *Notifier) sendMessageToUserChannel(slackMsg slackMessage, logger *zap.S
 
 func (n *Notifier) sendMessageToChannel(slackChannel string, slackMsg slackMessage) error {
 	userName := infoNotAvailable
-	if slackMsg.UserInfo.Username != "" {
-		userName = slackMsg.UserInfo.Username
+	if slackMsg.UserEmail != "" {
+		userName = slackMsg.UserEmail
 	}
 
 	_, _, err := n.client.PostMessage(slackChannel,
@@ -228,28 +228,45 @@ func (n *Notifier) buildSlackMessage(obj client.Object, event corev1.Event, noti
 	infoBlocks := n.buildSlackBlocks(obj, notifType, reporting)
 
 	var (
-		userInfo authv1.UserInfo
-		err      error
+		userEmail string
+		userInfo  authv1.UserInfo
+		err       error
 	)
 
 	switch d := obj.(type) {
 	case *v1beta1.Disruption:
+		if nil != d.Spec.Reporting && d.Spec.Reporting.SlackUserEmail != "" {
+			userEmail = d.Spec.Reporting.SlackUserEmail
+		}
+
 		userInfo, err = d.UserInfo()
 	case *v1beta1.DisruptionCron:
+		if nil != d.Spec.Reporting && d.Spec.Reporting.SlackUserEmail != "" {
+			userEmail = d.Spec.Reporting.SlackUserEmail
+		}
+
 		userInfo, err = d.UserInfo()
 	}
 
 	if err != nil {
 		logger.Warnw("unable to retrieve user info", "error", err)
 	}
 
+	// initiates the fallback mechanism incase SlackUserEmail is empty or an invalid input
+	_, err = mail.ParseAddress(userEmail)
+	if err != nil {
+		logger.Infow("the slack user email is not a valid email address, fall back to userInfo", "err", err, "username", userEmail)
+
+		userEmail = userInfo.Username // falls back to userInfo username
+	}
+
 	return slackMessage{
 		HeaderText:  headerText,
 		HeaderBlock: *headerBlock,
 		BodyText:    bodyText,
 		BodyBlock:   *bodyBlock,
 		InfoBlocks:  infoBlocks,
-		UserInfo:    userInfo,
+		UserEmail:   userEmail,
 		UserName:    fmt.Sprintf("%s Status Bot", obj.GetObjectKind().GroupVersionKind().Kind),
 	}
 }