add check for account number set in signup response (codeready-toolchain#1196)

* add check for account number set in
---------

Co-authored-by: Devtools <devtools@redhat.com>

Author: mfrancisc

go.mod

@@ -1,8 +1,8 @@
 module github.com/codeready-toolchain/toolchain-e2e
 
 require (
-	github.com/codeready-toolchain/api v0.0.0-20250605152105-383ffe6cac27
-	github.com/codeready-toolchain/toolchain-common v0.0.0-20250506093954-2b65ad3a2e12
+	github.com/codeready-toolchain/api v0.0.0-20250909075145-ca043a618f0f
+	github.com/codeready-toolchain/toolchain-common v0.0.0-20250910131836-b410cd4ca53d
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc
 	github.com/fatih/color v1.18.0
 	github.com/ghodss/yaml v1.0.0

go.sum

@@ -30,10 +30,10 @@ github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDk
 github.com/cloudflare/circl v1.1.0/go.mod h1:prBCrKB9DV4poKZY1l9zBXg2QJY7mvgRvtMxxK7fi4I=
 github.com/cloudflare/circl v1.6.1 h1:zqIqSPIndyBh1bjLVVDHMPpVKqp8Su/V+6MeDzzQBQ0=
 github.com/cloudflare/circl v1.6.1/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs=
-github.com/codeready-toolchain/api v0.0.0-20250605152105-383ffe6cac27 h1:g1ivSPPHTC96RHp8S/gRmqODWgoHyivq+/d5kSI0pEs=
-github.com/codeready-toolchain/api v0.0.0-20250605152105-383ffe6cac27/go.mod h1:20258od6i5+jP406Z76YaI2ow/vc7URwsDU2bokpkRE=
-github.com/codeready-toolchain/toolchain-common v0.0.0-20250506093954-2b65ad3a2e12 h1:w54sojJJ8PsHZzK1mC+/EUBrQ9F2sC/k7JUVc8LSqK4=
-github.com/codeready-toolchain/toolchain-common v0.0.0-20250506093954-2b65ad3a2e12/go.mod h1:TrMvD0sP69wI6Rouzfs7OsOUSj4CGn/ZiIdiDBAFQjk=
+github.com/codeready-toolchain/api v0.0.0-20250909075145-ca043a618f0f h1:IZ3Wq4iC0765HP369U3+08NFb0rK/NJCKfRjj8OdPVo=
+github.com/codeready-toolchain/api v0.0.0-20250909075145-ca043a618f0f/go.mod h1:20258od6i5+jP406Z76YaI2ow/vc7URwsDU2bokpkRE=
+github.com/codeready-toolchain/toolchain-common v0.0.0-20250910131836-b410cd4ca53d h1:wu30udLhwynhfb5w+G+fKjsQfn0hW18llOjh0ZYh62c=
+github.com/codeready-toolchain/toolchain-common v0.0.0-20250910131836-b410cd4ca53d/go.mod h1:nQ2naidFtgGv+BofbwsiZWvQLdQ2O9ICR2uxf67oYmA=
 github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

test/e2e/parallel/registration_service_test.go

@@ -468,6 +468,32 @@ func TestSignupOK(t *testing.T) {
 		// Re-activate the usersignup by calling the signup endpoint with the same token/user again
 		signupUser(token, emailAddress, identity.Username, identity)
 	})
+
+	t.Run("test get signup returns expected response", func(t *testing.T) {
+		// Get valid generated token for e2e tests.
+		emailAddress := uuid.Must(uuid.NewV4()).String() + "@acme.com"
+		identity, token, err := authsupport.NewToken(authsupport.WithEmail(emailAddress), commonauth.WithUserIDClaim("123"), commonauth.WithAccountIDClaim("456"), commonauth.WithAccountNumberClaim("789"))
+		require.NoError(t, err)
+
+		// Signup a new user
+		userSignup := signupUser(token, emailAddress, identity.Username, identity)
+
+		t.Logf("Signed up new user %+v", userSignup)
+
+		// call GET /signup and verify expected response body fields are there
+		now := time.Now()
+		NewGetSignupClient(t, await, identity.Username, token).Invoke(signupIsProvisioned,
+			signupHasExpectedDates(now, now.Add(time.Hour*24*30)),
+			signupHasExpectedClaims(map[string]string{
+				"name":          userSignup.Name,
+				"username":      userSignup.Spec.IdentityClaims.PreferredUsername,
+				"givenName":     userSignup.Spec.IdentityClaims.GivenName,
+				"familyName":    userSignup.Spec.IdentityClaims.FamilyName,
+				"userID":        "123",
+				"accountID":     "456",
+				"accountNumber": "789",
+			}))
+	})
 }
 
 func TestUserSignupFoundWhenNamedWithEncodedUsername(t *testing.T) {
@@ -1005,6 +1031,16 @@ func signupHasExpectedDates(startDate, endDate time.Time) func(c *GetSignupClien
 	}
 }
 
+func signupHasExpectedClaims(claims map[string]string) func(c *GetSignupClient) {
+	return func(c *GetSignupClient) {
+		for expectedClaim, expectedClaimValue := range claims {
+			actualClaimValue, claimFound := c.responseBody[expectedClaim]
+			require.True(c.t, claimFound, "unable to find expected claim [%s]. Claims found %v", expectedClaim, claims)
+			require.Equal(c.t, expectedClaimValue, actualClaimValue, "expected claim value [%s] doesn't match actual claim value [%s]", expectedClaimValue, actualClaimValue)
+		}
+	}
+}
+
 func signupIsProvisioned(client *GetSignupClient) {
 	hostAwait := client.await.Host()
 	memberAwait := client.await.Member1()

test/e2e/usersignup_test.go

@@ -356,6 +356,7 @@ func (s *userSignupIntegrationTest) TestGetSignupEndpointUpdatesIdentityClaims()
 		IdentityID(id).
 		UserID("000999").
 		AccountID("111999").
+		AccountNumber("4242").
 		EnsureMUR().
 		RequireConditions(wait.ConditionSet(wait.Default(), wait.ApprovedAutomatically())...).
 		Execute(s.T())
@@ -376,6 +377,7 @@ func (s *userSignupIntegrationTest) TestGetSignupEndpointUpdatesIdentityClaims()
 	claims = append(claims, commonauth.WithGivenNameClaim("Jane"))
 	claims = append(claims, commonauth.WithFamilyNameClaim("Turner"))
 	claims = append(claims, commonauth.WithCompanyClaim("Acme"))
+	claims = append(claims, commonauth.WithAccountNumberClaim("2222"))
 
 	token, err := authsupport.NewTokenFromIdentity(userIdentity, claims...)
 	require.NoError(s.T(), err)
@@ -394,6 +396,7 @@ func (s *userSignupIntegrationTest) TestGetSignupEndpointUpdatesIdentityClaims()
 	require.Equal(s.T(), "Jane", userSignup.Spec.IdentityClaims.GivenName)
 	require.Equal(s.T(), "Turner", userSignup.Spec.IdentityClaims.FamilyName)
 	require.Equal(s.T(), "Acme", userSignup.Spec.IdentityClaims.Company)
+	require.Equal(s.T(), "2222", userSignup.Spec.IdentityClaims.AccountNumber)
 }
 
 // TestUserResourcesCreatedWhenOriginalSubIsSet tests the case where:

testsupport/signup_request.go

@@ -53,6 +53,7 @@ type SignupRequest struct {
 	originalSub          string
 	userID               string
 	accountID            string
+	accountNumber        string
 	cleanupDisabled      bool
 	noSpace              bool
 	activationCode       string
@@ -115,6 +116,11 @@ func (r *SignupRequest) AccountID(accountID string) *SignupRequest {
 	return r
 }
 
+func (r *SignupRequest) AccountNumber(accountNumber string) *SignupRequest {
+	r.accountNumber = accountNumber
+	return r
+}
+
 // EnsureMUR will ensure that a MasterUserRecord is created.  It is necessary to call this function in order for
 // the Execute function to return a non-nil value for its second return parameter.
 func (r *SignupRequest) EnsureMUR() *SignupRequest {
@@ -232,6 +238,9 @@ func (r *SignupRequest) Execute(t *testing.T) *SignupResult {
 	if r.accountID != "" {
 		claims = append(claims, commonauth.WithAccountIDClaim(r.accountID))
 	}
+	if r.accountNumber != "" {
+		claims = append(claims, commonauth.WithAccountNumberClaim(r.accountNumber))
+	}
 	r.token, err = authsupport.NewTokenFromIdentity(userIdentity, claims...)
 	require.NoError(t, err)