chore: slightly tweak implementation details

Signed-off-by: Hidde Beydals <[email protected]>

Author: hiddeco

internal/controller/promotions/promotions.go

@@ -479,8 +479,6 @@ func (r *reconciler) promote(
 		}
 	}
 
-	creator := parseActorAnnotation(&promo)
-
 	promoCtx := directives.PromotionContext{
 		UIBaseURL:             r.cfg.APIServerBaseURL,
 		WorkDir:               filepath.Join(os.TempDir(), "promotion-"+string(workingPromo.UID)),
@@ -493,7 +491,7 @@ func (r *reconciler) promote(
 		StepExecutionMetadata: promo.Status.StepExecutionMetadata,
 		State:                 directives.State(workingPromo.Status.GetState()),
 		Vars:                  workingPromo.Spec.Vars,
-		Creator:               creator,
+		Actor:                 parseCreateActorAnnotation(&promo),
 	}
 	if err := os.Mkdir(promoCtx.WorkDir, 0o700); err == nil {
 		// If we're working with a fresh directory, we should start the promotion
@@ -650,13 +648,18 @@ func (r *reconciler) terminatePromotion(
 	return nil
 }
 
-func parseActorAnnotation(promo *kargoapi.Promotion) string {
-	creator := "N/A"
-	actorAnnotation, ok := promo.ObjectMeta.Annotations[kargoapi.AnnotationKeyCreateActor]
-	if ok {
-		substrings := strings.Split(actorAnnotation, ":")
-		if len(substrings) == 2 {
-			creator = substrings[1]
+// parseCreateActorAnnotation extracts the v1alpha1.AnnotationKeyCreateActor
+// value from the Promotion's annotations and returns it. If the value contains
+// a colon, it is split and the second part is returned. Otherwise, the entire
+// value or an empty string is returned.
+func parseCreateActorAnnotation(promo *kargoapi.Promotion) string {
+	var creator string
+	if v, ok := promo.Annotations[kargoapi.AnnotationKeyCreateActor]; ok {
+		if v != kargoapi.EventActorUnknown {
+			creator = v
+		}
+		if parts := strings.Split(v, ":"); len(parts) == 2 {
+			creator = parts[1]
 		}
 	}
 	return creator

internal/controller/promotions/promotions_test.go

@@ -3,6 +3,7 @@ package promotions
 import (
 	"context"
 	"errors"
+	"fmt"
 	"testing"
 	"time"
 
@@ -335,60 +336,6 @@ func TestReconcile(t *testing.T) {
 	}
 }
 
-func Test_parseActorAnnotation(t *testing.T) {
-	tests := []struct {
-		name            string
-		promo           *kargoapi.Promotion
-		expectedCreator string
-	}{
-		{
-			name: "basic case",
-			promo: &kargoapi.Promotion{
-				ObjectMeta: metav1.ObjectMeta{
-					Name:      "fake-promo",
-					Namespace: "fake-namespace",
-					Annotations: map[string]string{
-						kargoapi.AnnotationKeyCreateActor: "email:fake-actor",
-					},
-				},
-			},
-			expectedCreator: "fake-actor",
-		},
-		{
-
-			name: "no annotation",
-			promo: &kargoapi.Promotion{
-				ObjectMeta: metav1.ObjectMeta{
-					Name:      "fake-promo",
-					Namespace: "fake-namespace",
-				},
-			},
-			expectedCreator: "N/A",
-		},
-		{
-			name: "invalid",
-			promo: &kargoapi.Promotion{
-				ObjectMeta: metav1.ObjectMeta{
-					Name:      "fake-promo",
-					Namespace: "fake-namespace",
-					Annotations: map[string]string{
-						kargoapi.AnnotationKeyCreateActor: "abc123",
-					},
-				},
-			},
-			expectedCreator: "N/A",
-		},
-	}
-
-	for _, tc := range tests {
-
-		t.Run(tc.name, func(t *testing.T) {
-			result := parseActorAnnotation(tc.promo)
-			require.Equal(t, tc.expectedCreator, result)
-		})
-	}
-}
-
 func Test_reconciler_terminatePromotion(t *testing.T) {
 	scheme := k8sruntime.NewScheme()
 	require.NoError(t, kargoapi.SchemeBuilder.AddToScheme(scheme))
@@ -516,6 +463,74 @@ func Test_reconciler_terminatePromotion(t *testing.T) {
 	}
 }
 
+func Test_parseCreateActorAnnotation(t *testing.T) {
+	tests := []struct {
+		name            string
+		promo *kargoapi.Promotion
+		want  string
+	}{
+		{
+			name: "basic case",
+			promo: &kargoapi.Promotion{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "fake-promo",
+					Namespace: "fake-namespace",
+					Annotations: map[string]string{
+						kargoapi.AnnotationKeyCreateActor: fmt.Sprintf(
+							"%s%s", kargoapi.EventActorEmailPrefix, "fake-actor",
+						),
+					},
+				},
+			},
+			want: "fake-actor",
+		},
+		{
+			name: "single element",
+			promo: &kargoapi.Promotion{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "fake-promo",
+					Namespace: "fake-namespace",
+					Annotations: map[string]string{
+						kargoapi.AnnotationKeyCreateActor: kargoapi.EventActorAdmin,
+					},
+				},
+			},
+			want: kargoapi.EventActorAdmin,
+		},
+		{
+			name: "unknown actor",
+			promo: &kargoapi.Promotion{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "fake-promo",
+					Namespace: "fake-namespace",
+					Annotations: map[string]string{
+						kargoapi.AnnotationKeyCreateActor: kargoapi.EventActorUnknown,
+					},
+				},
+			},
+			want: "",
+		},
+		{
+
+			name: "no annotation",
+			promo: &kargoapi.Promotion{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:      "fake-promo",
+					Namespace: "fake-namespace",
+				},
+			},
+			want: "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := parseCreateActorAnnotation(tt.promo)
+			require.Equal(t, tt.want, result)
+		})
+	}
+}
+
 // nolint: unparam
 func newPromo(namespace, name, stage string,
 	phase kargoapi.PromotionPhase,

internal/directives/promotions.go

@@ -81,8 +81,8 @@ type PromotionContext struct {
 	Vars []kargoapi.PromotionVariable
 	// Secrets is a map of secrets that can be used by the PromotionSteps.
 	Secrets map[string]map[string]string
-	// Creator is the name of the actor triggering the Promotion.
-	Creator string
+	// Actor is the name of the actor triggering the Promotion.
+	Actor string
 }
 
 // PromotionStep describes a single step in a user-defined promotion process.
@@ -196,7 +196,11 @@ func (s *PromotionStep) BuildEnv(
 			"project":   promoCtx.Project,
 			"promotion": promoCtx.Promotion,
 			"stage":     promoCtx.Stage,
-			"creator":   promoCtx.Creator,
+			"meta": map[string]any{
+				"promotion": map[string]any{
+					"actor": promoCtx.Actor,
+				},
+			},
 		},
 	}
 

internal/directives/promotions_test.go

@@ -207,19 +207,19 @@ func TestPromotionStep_GetConfig(t *testing.T) {
 				Project:   "fake-project",
 				Stage:     "fake-stage",
 				Promotion: "fake-promotion",
-				Creator:   "fake-creator",
+				Actor:     "fake-creator",
 			},
 			rawCfg: []byte(`{
 				"project": "${{ ctx.project }}",
 				"stage": "${{ ctx.stage }}",
 				"promotion": "${{ ctx.promotion }}",
-				"creator": "${{ ctx.creator }}"
+				"actor": "${{ ctx.meta.promotion.actor }}"
 			}`),
 			expectedCfg: Config{
 				"project":   "fake-project",
 				"stage":     "fake-stage",
 				"promotion": "fake-promotion",
-				"creator":   "fake-creator",
+				"actor":     "fake-creator",
 			},
 		},
 		{