Updates describe CLI command to add support for Group of Users

Signed-off-by: PuneetPunamiya <[email protected]>

Author: PuneetPunamiya

pkg/cli/cmd/describe/describe.go

@@ -24,7 +24,7 @@ var taskTemplate = `📦 Name:            {{ .ApprovalTask.Name }}
 
 👥 Approvers
 {{- range .ApprovalTask.Spec.Approvers }}
-   * {{ .Name }}
+   * {{ .Name }}{{if eq .Type "Group"}} (Group){{end}}
 {{- end }}
 
 
@@ -33,10 +33,17 @@ var taskTemplate = `📦 Name:            {{ .ApprovalTask.Name }}
 👨‍💻 ApproverResponse
 
 Name	ApproverResponse	Message
-{{- range .ApprovalTask.Status.ApproversResponse }}
-{{ .Name }}	{{response .Response }}	{{message .Message }}
-{{- end }}
-{{- end }}
+{{- range .ApprovalTask.Status.ApproversResponse}}
+{{- if eq .Type "User"}}
+{{.Name}}	{{response .Response}}	{{message .Message}}
+{{- else if eq .Type "Group"}}
+{{- $groupName := .Name}}
+{{- range .GroupMembers}}
+{{$groupName}}: {{.Name}}	{{response .Response}}	{{message .Message}}
+{{- end}}
+{{- end}}
+{{- end}}
+{{- end}}
 
 🌡️  Status
 
@@ -49,7 +56,23 @@ var (
 )
 
 func pendingApprovals(at *v1alpha1.ApprovalTask) int {
-	return at.Spec.NumberOfApprovalsRequired - len(at.Status.ApproversResponse)
+	// Count unique users who have responded (approved or rejected)
+	respondedUsers := make(map[string]bool)
+
+	for _, approver := range at.Status.ApproversResponse {
+		if approver.Type == "User" {
+			respondedUsers[approver.Name] = true
+		} else if approver.Type == "Group" {
+			// Count individual group members who have responded
+			for _, member := range approver.GroupMembers {
+				if member.Response == "approved" || member.Response == "rejected" {
+					respondedUsers[member.Name] = true
+				}
+			}
+		}
+	}
+
+	return at.Spec.NumberOfApprovalsRequired - len(respondedUsers)
 }
 
 func pipelineRunRef(at *v1alpha1.ApprovalTask) string {
@@ -124,7 +147,7 @@ func Command(p cli.Params) *cobra.Command {
 				ApprovalTask: at,
 			}
 
-			w := tabwriter.NewWriter(cmd.OutOrStdout(), 0, 5, 3, ' ', tabwriter.TabIndent)
+			w := tabwriter.NewWriter(cmd.OutOrStdout(), 0, 8, 5, ' ', tabwriter.TabIndent)
 			t := template.Must(template.New("Describe ApprovalTask").Funcs(funcMap).Parse(taskTemplate))
 
 			if err != nil {

pkg/cli/cmd/describe/describe_test.go

@@ -28,10 +28,12 @@ func TestDescribeApprovalTask(t *testing.T) {
 					{
 						Name:  "tekton",
 						Input: "reject",
+						Type:  "User",
 					},
 					{
 						Name:  "cli",
 						Input: "pending",
+						Type:  "User",
 					},
 				},
 				NumberOfApprovalsRequired: 2,
@@ -44,6 +46,7 @@ func TestDescribeApprovalTask(t *testing.T) {
 				ApproversResponse: []v1alpha1.ApproverState{
 					{
 						Name:     "tekton",
+						Type:     "User",
 						Response: "rejected",
 					},
 				},
@@ -99,6 +102,174 @@ func TestDescribeApprovalTaskNotFound(t *testing.T) {
 	}
 }
 
+func TestDescribeApprovalTaskWithGroups(t *testing.T) {
+	approvaltasks := []*v1alpha1.ApprovalTask{
+		{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "at-group",
+				Namespace: "foo",
+			},
+			Spec: v1alpha1.ApprovalTaskSpec{
+				Approvers: []v1alpha1.ApproverDetails{
+					{
+						Name:  "admin-group",
+						Input: "approve",
+						Type:  "Group",
+					},
+					{
+						Name:  "dev-team",
+						Input: "reject",
+						Type:  "Group",
+					},
+					{
+						Name:  "alice",
+						Input: "pending",
+						Type:  "User",
+					},
+				},
+				NumberOfApprovalsRequired: 3,
+			},
+			Status: v1alpha1.ApprovalTaskStatus{
+				Approvers: []string{
+					"admin-group",
+					"dev-team",
+					"alice",
+				},
+				ApproversResponse: []v1alpha1.ApproverState{
+					{
+						Name:     "admin-group",
+						Type:     "Group",
+						Response: "approved",
+						GroupMembers: []v1alpha1.GroupMemberState{
+							{
+								Name:     "bob",
+								Response: "approved",
+								Message:  "LGTM",
+							},
+							{
+								Name:     "charlie",
+								Response: "approved",
+							},
+						},
+					},
+					{
+						Name:     "dev-team",
+						Type:     "Group",
+						Response: "rejected",
+						GroupMembers: []v1alpha1.GroupMemberState{
+							{
+								Name:     "david",
+								Response: "rejected",
+								Message:  "Needs more testing",
+							},
+						},
+					},
+				},
+				State: "approved",
+			},
+		},
+	}
+
+	ns := []*corev1.Namespace{
+		{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: "namespace",
+			},
+		},
+	}
+
+	dc, err := testDynamic.Client(
+		cb.UnstructuredV1alpha1(approvaltasks[0], "v1alpha1"),
+	)
+	if err != nil {
+		t.Errorf("unable to create dynamic client: %v", err)
+	}
+
+	c := command(t, approvaltasks, ns, dc)
+	args := []string{"at-group", "-n", "foo"}
+
+	output, err := test.ExecuteCommand(c, args...)
+	golden.Assert(t, output, strings.ReplaceAll(fmt.Sprintf("%s.golden", t.Name()), "/", "-"))
+}
+
+// Test individual functions for group functionality
+func TestPendingApprovalsWithGroups(t *testing.T) {
+	tests := []struct {
+		name     string
+		at       *v1alpha1.ApprovalTask
+		expected int
+	}{
+		{
+			name: "group with multiple members responded",
+			at: &v1alpha1.ApprovalTask{
+				Spec: v1alpha1.ApprovalTaskSpec{
+					NumberOfApprovalsRequired: 3,
+				},
+				Status: v1alpha1.ApprovalTaskStatus{
+					ApproversResponse: []v1alpha1.ApproverState{
+						{
+							Name: "admin-group",
+							Type: "Group",
+							GroupMembers: []v1alpha1.GroupMemberState{
+								{Name: "alice", Response: "approved"},
+								{Name: "bob", Response: "rejected"},
+							},
+						},
+					},
+				},
+			},
+			expected: 1, // 3 required - 2 responded = 1 pending
+		},
+		{
+			name: "mixed user and group responses",
+			at: &v1alpha1.ApprovalTask{
+				Spec: v1alpha1.ApprovalTaskSpec{
+					NumberOfApprovalsRequired: 4,
+				},
+				Status: v1alpha1.ApprovalTaskStatus{
+					ApproversResponse: []v1alpha1.ApproverState{
+						{
+							Name:     "direct-user",
+							Type:     "User",
+							Response: "approved",
+						},
+						{
+							Name: "dev-team",
+							Type: "Group",
+							GroupMembers: []v1alpha1.GroupMemberState{
+								{Name: "charlie", Response: "approved"},
+								{Name: "david", Response: "approved"},
+							},
+						},
+					},
+				},
+			},
+			expected: 1, // 4 required - 3 responded = 1 pending
+		},
+		{
+			name: "no responses",
+			at: &v1alpha1.ApprovalTask{
+				Spec: v1alpha1.ApprovalTaskSpec{
+					NumberOfApprovalsRequired: 2,
+				},
+				Status: v1alpha1.ApprovalTaskStatus{
+					ApproversResponse: []v1alpha1.ApproverState{},
+				},
+			},
+			expected: 2, // 2 required - 0 responded = 2 pending
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := pendingApprovals(tt.at)
+			if result != tt.expected {
+				t.Errorf("pendingApprovals() = %d, expected %d", result, tt.expected)
+			}
+		})
+	}
+}
+
 func command(t *testing.T, approvaltasks []*v1alpha1.ApprovalTask, ns []*corev1.Namespace, dc dynamic.Interface) *cobra.Command {
 	cs, _ := test.SeedTestData(t, test.Data{Approvaltasks: approvaltasks, Namespaces: ns})
 	p := &test.Params{ApprovalTask: cs.ApprovalTask, Kube: cs.Kube, Dynamic: dc}

pkg/cli/cmd/describe/testdata/TestDescribeApprovalTask.golden

@@ -7,10 +7,10 @@
 
 👨‍💻 ApproverResponse
 
-Name     ApproverResponse   Message
-tekton   ❌                  ---
+Name       ApproverResponse     Message
+tekton     ❌                    ---
 
 🌡️  Status
 
-NumberOfApprovalsRequired   PendingApprovals   STATUS
-2                           1                  Rejected
+NumberOfApprovalsRequired     PendingApprovals     STATUS
+2                             1                    Rejected

pkg/cli/cmd/describe/testdata/TestDescribeApprovalTaskWithGroups.golden

@@ -0,0 +1,19 @@
+📦 Name:            at-group
+🗂  Namespace:       foo
+
+👥 Approvers
+   * admin-group (Group)
+   * dev-team (Group)
+   * alice
+
+👨‍💻 ApproverResponse
+
+Name                     ApproverResponse     Message
+admin-group: bob         ✅                    LGTM
+admin-group: charlie     ✅                    ---
+dev-team: david          ❌                    Needs more testing
+
+🌡️  Status
+
+NumberOfApprovalsRequired     PendingApprovals     STATUS
+3                             0                    Approved

test/cli/describe/testdata/TestApprovalTaskDescribeCommand.golden

@@ -9,5 +9,5 @@
 
 🌡️  Status
 
-NumberOfApprovalsRequired   PendingApprovals   STATUS
-2                           2                  Pending
+NumberOfApprovalsRequired     PendingApprovals     STATUS
+2                             2                    Pending