From 1e939528d50ab0b4fe67d7471aa24921b5f1ec7f Mon Sep 17 00:00:00 2001
From: Oded Ben-Ozer <obenozer@wayfair.com>
Date: Sun, 6 Aug 2023 13:13:39 +0200
Subject: [PATCH] Document each test case

Signed-off-by: Oded Ben-Ozer <obenozer@wayfair.com>
---
 connector/oidc/oidc_test.go | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/connector/oidc/oidc_test.go b/connector/oidc/oidc_test.go
index 2f19d9674f0..459e2ca2c52 100644
--- a/connector/oidc/oidc_test.go
+++ b/connector/oidc/oidc_test.go
@@ -298,7 +298,7 @@ func TestHandleCallback(t *testing.T) {
 			expectGroups:       []string{"group1", "gh::acme::pipeline-one", "tfe-acme-foobar", "bk-emailvalue"},
 			expectedEmailField: "emailvalue",
 			claimConcatenations: []ClaimConcatenation{
-				{
+				{ // The basic functionality, should create "gh::acme::pipeline-one".
 					ClaimList: []string{
 						"organization",
 						"pipeline",
@@ -306,7 +306,7 @@ func TestHandleCallback(t *testing.T) {
 					Delimiter: "::",
 					Prefix:    "gh",
 				},
-				{
+				{ // Non existing claims, should not generate any any new group claim.
 					ClaimList: []string{
 						"non-existing1",
 						"non-existing2",
@@ -314,7 +314,9 @@ func TestHandleCallback(t *testing.T) {
 					Delimiter: "::",
 					Prefix:    "tfe",
 				},
-				{
+				{ // In this case the delimiter character("-") should be removed removed from "claim-with-delimiter" claim to ensure the resulting
+					// claim structure is in full control of the Dex operator and not the person creating a new pipeline.
+					// Should create "tfe-acme-foobar" and not "tfe-acme-foo-bar".
 					ClaimList: []string{
 						"organization",
 						"claim-with-delimiter",
@@ -322,7 +324,7 @@ func TestHandleCallback(t *testing.T) {
 					Delimiter: "-",
 					Prefix:    "tfe",
 				},
-				{
+				{ // Ignore non string claims (like arrays), this should result in "bk-emailvalue".
 					ClaimList: []string{
 						"non-string-claim",
 						"non-string-claim2",