diff --git a/testing/internal/e2e/boundary/credential.go b/testing/internal/e2e/boundary/credential.go index 535e3250b..d52e2cbb9 100644 --- a/testing/internal/e2e/boundary/credential.go +++ b/testing/internal/e2e/boundary/credential.go @@ -19,7 +19,7 @@ import ( // Returns the id of the new credential store func CreateNewCredentialStoreStaticApi(t testing.TB, ctx context.Context, client *api.Client, projectId string) string { csClient := credentialstores.NewClient(client) - newCredentialStoreResult, err := csClient.Create(ctx, "static", projectId, credentialstores.WithName("e2e Credential Store")) + newCredentialStoreResult, err := csClient.Create(ctx, "static", projectId) require.NoError(t, err) newCredentialStoreId := newCredentialStoreResult.Item.Id t.Logf("Created Credential Store: %s", newCredentialStoreId) diff --git a/testing/internal/e2e/tests/base/paginate_credential_store_test.go b/testing/internal/e2e/tests/base/paginate_credential_store_test.go new file mode 100644 index 000000000..1cdf788b1 --- /dev/null +++ b/testing/internal/e2e/tests/base/paginate_credential_store_test.go @@ -0,0 +1,189 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: BUSL-1.1 + +package base_test + +import ( + "context" + "encoding/json" + "slices" + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/google/go-cmp/cmp/cmpopts" + "github.com/hashicorp/boundary/api/credentialstores" + "github.com/hashicorp/boundary/api/scopes" + "github.com/hashicorp/boundary/testing/internal/e2e" + "github.com/hashicorp/boundary/testing/internal/e2e/boundary" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +// TestCliPaginateCredentialStores asserts that the CLI automatically paginates to retrieve +// all credential stores in a single invocation. +func TestCliPaginateCredentialStores(t *testing.T) { + e2e.MaybeSkipTest(t) + c, err := loadTestConfig() + require.NoError(t, err) + + ctx := context.Background() + boundary.AuthenticateAdminCli(t, ctx) + newOrgId := boundary.CreateNewOrgCli(t, ctx) + t.Cleanup(func() { + ctx := context.Background() + boundary.AuthenticateAdminCli(t, ctx) + output := e2e.RunCommand(ctx, "boundary", e2e.WithArgs("scopes", "delete", "-id", newOrgId)) + require.NoError(t, output.Err, string(output.Stderr)) + }) + newProjectId := boundary.CreateNewProjectCli(t, ctx, newOrgId) + + // Create enough stores to overflow a single page. + // Use the API to make creation faster. + var storeIds []string + client, err := boundary.NewApiClient() + require.NoError(t, err) + for i := 0; i < c.MaxPageSize+1; i++ { + storeIds = append(storeIds, boundary.CreateNewCredentialStoreStaticApi(t, ctx, client, newProjectId)) + } + + output := e2e.RunCommand(ctx, "boundary", + e2e.WithArgs( + "credential-stores", "list", + "-scope-id", newProjectId, + "-format=json", + ), + ) + require.NoError(t, output.Err, string(output.Stderr)) + + var initialStores credentialstores.CredentialStoreListResult + err = json.Unmarshal(output.Stdout, &initialStores) + require.NoError(t, err) + + var returnedIds []string + for _, store := range initialStores.Items { + returnedIds = append(returnedIds, store.Id) + } + + require.Len(t, initialStores.Items, c.MaxPageSize+1) + assert.Empty(t, cmp.Diff(returnedIds, storeIds, cmpopts.SortSlices(func(i, j string) bool { return i < j }))) + assert.Empty(t, initialStores.ResponseType) + assert.Empty(t, initialStores.RemovedIds) + assert.Empty(t, initialStores.ListToken) + + // Create a new store and destroy one of the other stores + newStoreId := boundary.CreateNewCredentialStoreStaticCli(t, ctx, newProjectId) + output = e2e.RunCommand(ctx, "boundary", + e2e.WithArgs( + "credential-stores", "delete", + "-id", initialStores.Items[0].Id, + ), + ) + require.NoError(t, output.Err, string(output.Stderr)) + + // List again, should have the new store but not the deleted store + output = e2e.RunCommand(ctx, "boundary", + e2e.WithArgs( + "credential-stores", "list", + "-scope-id", newProjectId, + "-format=json", + ), + ) + require.NoError(t, output.Err, string(output.Stderr)) + + var newStores credentialstores.CredentialStoreListResult + err = json.Unmarshal(output.Stdout, &newStores) + require.NoError(t, err) + + require.Len(t, newStores.Items, c.MaxPageSize+1) + // The first item should be the most recently created, which + // should be our new store + firstItem := newStores.Items[0] + assert.Equal(t, newStoreId, firstItem.Id) + assert.Empty(t, newStores.ResponseType) + assert.Empty(t, newStores.RemovedIds) + assert.Empty(t, newStores.ListToken) + // Ensure the deleted store isn't returned + for _, store := range newStores.Items { + assert.NotEqual(t, store.Id, initialStores.Items[0].Id) + } +} + +// TestApiPaginateCredentialStores asserts that the API automatically paginates to retrieve +// all credential stores in a single invocation. +func TestApiPaginateCredentialStores(t *testing.T) { + e2e.MaybeSkipTest(t) + c, err := loadTestConfig() + require.NoError(t, err) + + client, err := boundary.NewApiClient() + require.NoError(t, err) + ctx := context.Background() + sClient := scopes.NewClient(client) + cClient := credentialstores.NewClient(client) + newOrgId := boundary.CreateNewOrgApi(t, ctx, client) + t.Cleanup(func() { + ctx := context.Background() + _, err := sClient.Delete(ctx, newOrgId) + require.NoError(t, err) + }) + newProjectId := boundary.CreateNewProjectApi(t, ctx, client, newOrgId) + + // Create enough stores to overflow a single page. + var storeIds []string + for i := 0; i < c.MaxPageSize+1; i++ { + storeIds = append(storeIds, boundary.CreateNewCredentialStoreStaticApi(t, ctx, client, newProjectId)) + } + + initialStores, err := cClient.List(ctx, newProjectId) + require.NoError(t, err) + + var returnedIds []string + for _, store := range initialStores.Items { + returnedIds = append(returnedIds, store.Id) + } + + require.Len(t, initialStores.Items, c.MaxPageSize+1) + assert.Empty(t, cmp.Diff(returnedIds, storeIds, cmpopts.SortSlices(func(i, j string) bool { return i < j }))) + assert.Equal(t, "complete", initialStores.ResponseType) + assert.Empty(t, initialStores.RemovedIds) + assert.NotEmpty(t, initialStores.ListToken) + mapItems, ok := initialStores.GetResponse().Map["items"] + require.True(t, ok) + mapSliceItems, ok := mapItems.([]any) + require.True(t, ok) + assert.Len(t, mapSliceItems, c.MaxPageSize+1) + + // Create a new store and destroy one of the other stores + newStoreId := boundary.CreateNewCredentialStoreStaticApi(t, ctx, client, newProjectId) + _, err = cClient.Delete(ctx, initialStores.Items[0].Id) + require.NoError(t, err) + + // List again, should have the new and deleted store + newStores, err := cClient.List(ctx, newProjectId, credentialstores.WithListToken(initialStores.ListToken)) + require.NoError(t, err) + + // Note that this will likely contain all the stores, + // since they were created very shortly before the listing, + // and we add a 30 second buffer to the lower bound of update + // times when listing. + require.GreaterOrEqual(t, len(newStores.Items), 1) + // The first item should be the most recently created, which + // should be our new store + firstItem := newStores.Items[0] + assert.Equal(t, newStoreId, firstItem.Id) + assert.Equal(t, "complete", newStores.ResponseType) + // Note that the removed IDs may contain entries from other tests, + // so just check that there is at least 1 entry and that our entry + // is somewhere in the list. + require.GreaterOrEqual(t, len(newStores.RemovedIds), 1) + assert.True(t, slices.ContainsFunc(newStores.RemovedIds, func(storeId string) bool { + return storeId == initialStores.Items[0].Id + })) + assert.NotEmpty(t, newStores.ListToken) + // Check that the response map contains all entries + mapItems, ok = newStores.GetResponse().Map["items"] + require.True(t, ok) + mapSliceItems, ok = mapItems.([]any) + require.True(t, ok) + assert.GreaterOrEqual(t, len(mapSliceItems), 1) +}