test(e2e): Add test to paginate users (#4195)
* test(e2e): Use API call to decrease runtime * test(e2e): Add test to paginate users
This commit is contained in:
Michael Li authored and 
Johan Brandhorst-Satzkorn committed
1 parent
8d50a0913f
commit
d9cf0be0bc
4 files changed
+191
-3
No files matched your search
@@ -71,7 +71,7 @@ func TestCliPaginateCredentialStores(t *testing.T) {
|
||||
assert.Empty(t, initialStores.ListToken)
|
||||
|
||||
// Create a new store and destroy one of the other stores
|
||||
newStoreId := boundary.CreateNewCredentialStoreStaticCli(t, ctx, newProjectId)
|
||||
newStoreId := boundary.CreateNewCredentialStoreStaticApi(t, ctx, client, newProjectId)
|
||||
output = e2e.RunCommand(ctx, "boundary",
|
||||
e2e.WithArgs(
|
||||
"credential-stores", "delete",
|
||||
|
||||
@@ -72,7 +72,7 @@ func TestCliPaginateHostSets(t *testing.T) {
|
||||
assert.Empty(t, initialHostSets.ListToken)
|
||||
|
||||
// Create a new host set and destroy one of the other host sets
|
||||
newHostSetId := boundary.CreateNewHostSetCli(t, ctx, newHostCatalogId)
|
||||
newHostSetId := boundary.CreateNewHostSetApi(t, ctx, client, newHostCatalogId)
|
||||
output = e2e.RunCommand(ctx, "boundary",
|
||||
e2e.WithArgs(
|
||||
"host-sets", "delete",
|
||||
|
||||
@@ -72,7 +72,7 @@ func TestCliPaginateHosts(t *testing.T) {
|
||||
assert.Empty(t, initialHosts.ListToken)
|
||||
|
||||
// Create a new host and destroy one of the other hosts
|
||||
newHostId := boundary.CreateNewHostCli(t, ctx, newHostCatalogId, c.TargetAddress)
|
||||
newHostId := boundary.CreateNewHostApi(t, ctx, client, newHostCatalogId, c.TargetAddress)
|
||||
output = e2e.RunCommand(ctx, "boundary",
|
||||
e2e.WithArgs(
|
||||
"hosts", "delete",
|
||||
|
||||
@@ -0,0 +1,188 @@
|
||||
// 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/scopes"
|
||||
"github.com/hashicorp/boundary/api/users"
|
||||
"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"
|
||||
)
|
||||
|
||||
// TestCliPaginateUsers asserts that the CLI automatically paginates to retrieve
|
||||
// all users in a single invocation.
|
||||
func TestCliPaginateUsers(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))
|
||||
})
|
||||
|
||||
// Create enough users to overflow a single page.
|
||||
client, err := boundary.NewApiClient()
|
||||
require.NoError(t, err)
|
||||
var userIds []string
|
||||
for i := 0; i < c.MaxPageSize+1; i++ {
|
||||
userIds = append(userIds, boundary.CreateNewUserApi(t, ctx, client, newOrgId))
|
||||
}
|
||||
|
||||
// List users
|
||||
output := e2e.RunCommand(ctx, "boundary",
|
||||
e2e.WithArgs(
|
||||
"users", "list",
|
||||
"-scope-id", newOrgId,
|
||||
"-format=json",
|
||||
),
|
||||
)
|
||||
require.NoError(t, output.Err, string(output.Stderr))
|
||||
|
||||
var initialUsers users.UserListResult
|
||||
err = json.Unmarshal(output.Stdout, &initialUsers)
|
||||
require.NoError(t, err)
|
||||
|
||||
var returnedIds []string
|
||||
for _, user := range initialUsers.Items {
|
||||
returnedIds = append(returnedIds, user.Id)
|
||||
}
|
||||
|
||||
require.Len(t, initialUsers.Items, c.MaxPageSize+1)
|
||||
assert.Empty(t, cmp.Diff(returnedIds, userIds, cmpopts.SortSlices(func(i, j string) bool { return i < j })))
|
||||
assert.Empty(t, initialUsers.ResponseType)
|
||||
assert.Empty(t, initialUsers.RemovedIds)
|
||||
assert.Empty(t, initialUsers.ListToken)
|
||||
|
||||
// Create a new user and destroy one of the other users
|
||||
newUserId := boundary.CreateNewUserApi(t, ctx, client, newOrgId)
|
||||
output = e2e.RunCommand(ctx, "boundary",
|
||||
e2e.WithArgs(
|
||||
"users", "delete",
|
||||
"-id", initialUsers.Items[0].Id,
|
||||
),
|
||||
)
|
||||
require.NoError(t, output.Err, string(output.Stderr))
|
||||
|
||||
// List again, should have the new user but not the deleted user
|
||||
output = e2e.RunCommand(ctx, "boundary",
|
||||
e2e.WithArgs(
|
||||
"users", "list",
|
||||
"-scope-id", newOrgId,
|
||||
"-format=json",
|
||||
),
|
||||
)
|
||||
require.NoError(t, output.Err, string(output.Stderr))
|
||||
|
||||
var newUsers users.UserListResult
|
||||
err = json.Unmarshal(output.Stdout, &newUsers)
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Len(t, newUsers.Items, c.MaxPageSize+1)
|
||||
// The first item should be the most recently created, which
|
||||
// should be our new user
|
||||
firstItem := newUsers.Items[0]
|
||||
assert.Equal(t, newUserId, firstItem.Id)
|
||||
assert.Empty(t, newUsers.ResponseType)
|
||||
assert.Empty(t, newUsers.RemovedIds)
|
||||
assert.Empty(t, newUsers.ListToken)
|
||||
// Ensure the deleted user isn't returned
|
||||
for _, user := range newUsers.Items {
|
||||
assert.NotEqual(t, user.Id, initialUsers.Items[0].Id)
|
||||
}
|
||||
}
|
||||
|
||||
// TestApiPaginateUsers asserts that the API automatically paginates to retrieve
|
||||
// all users in a single invocation.
|
||||
func TestApiPaginateUsers(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)
|
||||
uClient := users.NewClient(client)
|
||||
newOrgId := boundary.CreateNewOrgApi(t, ctx, client)
|
||||
t.Cleanup(func() {
|
||||
ctx := context.Background()
|
||||
_, err := sClient.Delete(ctx, newOrgId)
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
||||
// Create enough users to overflow a single page.
|
||||
var userIds []string
|
||||
for i := 0; i < c.MaxPageSize+1; i++ {
|
||||
userIds = append(userIds, boundary.CreateNewUserApi(t, ctx, client, newOrgId))
|
||||
}
|
||||
|
||||
// List users
|
||||
initialUsers, err := uClient.List(ctx, newOrgId)
|
||||
require.NoError(t, err)
|
||||
|
||||
var returnedIds []string
|
||||
for _, user := range initialUsers.Items {
|
||||
returnedIds = append(returnedIds, user.Id)
|
||||
}
|
||||
|
||||
require.Len(t, initialUsers.Items, c.MaxPageSize+1)
|
||||
assert.Empty(t, cmp.Diff(returnedIds, userIds, cmpopts.SortSlices(func(i, j string) bool { return i < j })))
|
||||
assert.Equal(t, "complete", initialUsers.ResponseType)
|
||||
assert.Empty(t, initialUsers.RemovedIds)
|
||||
assert.NotEmpty(t, initialUsers.ListToken)
|
||||
mapItems, ok := initialUsers.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 user and destroy one of the other users
|
||||
newUserId := boundary.CreateNewUserApi(t, ctx, client, newOrgId)
|
||||
_, err = uClient.Delete(ctx, initialUsers.Items[0].Id)
|
||||
require.NoError(t, err)
|
||||
|
||||
// List again, should have the new and deleted user
|
||||
newUsers, err := uClient.List(ctx, newOrgId, users.WithListToken(initialUsers.ListToken))
|
||||
require.NoError(t, err)
|
||||
|
||||
// Note that this will likely contain all the users,
|
||||
// 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(newUsers.Items), 1)
|
||||
// The first item should be the most recently created, which
|
||||
// should be our new user
|
||||
firstItem := newUsers.Items[0]
|
||||
assert.Equal(t, newUserId, firstItem.Id)
|
||||
assert.Equal(t, "complete", newUsers.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(newUsers.RemovedIds), 1)
|
||||
assert.True(t, slices.ContainsFunc(newUsers.RemovedIds, func(userId string) bool {
|
||||
return userId == initialUsers.Items[0].Id
|
||||
}))
|
||||
assert.NotEmpty(t, newUsers.ListToken)
|
||||
// Check that the response map contains all entries
|
||||
mapItems, ok = newUsers.GetResponse().Map["items"]
|
||||
require.True(t, ok)
|
||||
mapSliceItems, ok = mapItems.([]any)
|
||||
require.True(t, ok)
|
||||
assert.GreaterOrEqual(t, len(mapSliceItems), 1)
|
||||
}
|
||||
Reference in new issue
Block a user