Add evaluation_failure_message to ruletypes (#4433)

* add: evaluation failure message to ruletypes

* add: unit tests for RuleType WithDefaultEvaluationFailureMessage method

* update: rename to short_failure_message

* update: default message

* update: unit test after msg formatting

* fix: migration file name

* update: service_test with new msg format

database/migrations/000105_ruletype_evaluation_failure_message.down.sql

@@ -0,0 +1,15 @@
+-- Copyright 2024 Stacklok, Inc
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--      http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+ALTER TABLE rule_type DROP COLUMN short_failure_message;

database/migrations/000105_ruletype_evaluation_failure_message.up.sql

@@ -0,0 +1,17 @@
+-- Copyright 2024 Stacklok, Inc
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--      http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+-- Adds a `short_failure_message` column to the `rule_type` table. The failure message
+-- is displayed to the user when a rule evaluation fails.
+ALTER TABLE rule_type ADD COLUMN short_failure_message TEXT NOT NULL DEFAULT '';

database/query/rule_types.sql

@@ -8,7 +8,8 @@ INSERT INTO rule_type (
     severity_value,
     subscription_id,
     display_name,
-    release_phase
+    release_phase,
+    short_failure_message
 ) VALUES (
     $1,
     $2,
@@ -18,7 +19,8 @@ INSERT INTO rule_type (
     sqlc.arg(severity_value),
     sqlc.narg(subscription_id),
     sqlc.arg(display_name),
-    sqlc.arg(release_phase)
+    sqlc.arg(release_phase),
+    sqlc.arg(short_failure_message)
 ) RETURNING *;
 
 -- name: ListRuleTypesByProject :many
@@ -35,7 +37,7 @@ DELETE FROM rule_type WHERE id = $1;
 
 -- name: UpdateRuleType :one
 UPDATE rule_type
-    SET description = $2, definition = sqlc.arg(definition)::jsonb, severity_value = sqlc.arg(severity_value), display_name = sqlc.arg(display_name), release_phase = sqlc.arg(release_phase)
+    SET description = $2, definition = sqlc.arg(definition)::jsonb, severity_value = sqlc.arg(severity_value), display_name = sqlc.arg(display_name), release_phase = sqlc.arg(release_phase), short_failure_message = sqlc.arg(short_failure_message)
     WHERE id = $1
     RETURNING *;
 

internal/ruletypes/service.go

@@ -144,17 +144,18 @@ func (_ *ruleTypeService) CreateRuleType(
 		return nil, err
 	}
 
-	ruleType = ruleType.WithDefaultDisplayName()
+	ruleType = ruleType.WithDefaultDisplayName().WithDefaultShortFailureMessage()
 	newDBRecord, err := qtx.CreateRuleType(ctx, db.CreateRuleTypeParams{
-		Name:           ruleTypeName,
-		DisplayName:    ruleType.GetDisplayName(),
-		ProjectID:      projectID,
-		Description:    ruleType.GetDescription(),
-		Definition:     serializedRule,
-		Guidance:       ruleType.GetGuidance(),
-		SeverityValue:  *severity,
-		SubscriptionID: uuid.NullUUID{UUID: subscriptionID, Valid: subscriptionID != uuid.Nil},
-		ReleasePhase:   *releasePhase,
+		Name:                ruleTypeName,
+		DisplayName:         ruleType.GetDisplayName(),
+		ShortFailureMessage: ruleType.GetShortFailureMessage(),
+		ProjectID:           projectID,
+		Description:         ruleType.GetDescription(),
+		Definition:          serializedRule,
+		Guidance:            ruleType.GetGuidance(),
+		SeverityValue:       *severity,
+		SubscriptionID:      uuid.NullUUID{UUID: subscriptionID, Valid: subscriptionID != uuid.Nil},
+		ReleasePhase:        *releasePhase,
 	})
 	if err != nil {
 		return nil, fmt.Errorf("failed to create rule type: %w", err)
@@ -225,14 +226,15 @@ func (_ *ruleTypeService) UpdateRuleType(
 		return nil, err
 	}
 
-	ruleType = ruleType.WithDefaultDisplayName()
+	ruleType = ruleType.WithDefaultDisplayName().WithDefaultShortFailureMessage()
 	updatedRuleType, err := qtx.UpdateRuleType(ctx, db.UpdateRuleTypeParams{
-		ID:            oldRuleType.ID,
-		Description:   ruleType.GetDescription(),
-		Definition:    serializedRule,
-		SeverityValue: *severity,
-		DisplayName:   ruleType.GetDisplayName(),
-		ReleasePhase:  *releasePhase,
+		ID:                  oldRuleType.ID,
+		Description:         ruleType.GetDescription(),
+		Definition:          serializedRule,
+		SeverityValue:       *severity,
+		DisplayName:         ruleType.GetDisplayName(),
+		ShortFailureMessage: ruleType.GetShortFailureMessage(),
+		ReleasePhase:        *releasePhase,
 	})
 	if err != nil {
 		return nil, fmt.Errorf("failed to update rule type: %w", err)