doc(e2e): Update typo in comments

pull/2559/head
Michael Li 3 years ago
parent 6bd168b2a3
commit 1cc2b0b820

@ -13,7 +13,7 @@ import (
"github.com/stretchr/testify/require"
)
// CreateNewAccountApi creates a new account using the go api.
// CreateNewAccountApi creates a new account using the Go api.
// Returns the id of the new account as well as the password that was generated
func CreateNewAccountApi(t testing.TB, ctx context.Context, client *api.Client, loginName string) (accountId string, password string) {
c, err := loadConfig()

@ -11,7 +11,7 @@ import (
"github.com/stretchr/testify/require"
)
// CreateNewCredentialStoreStaticApi creates a new static credential store using the go api.
// CreateNewCredentialStoreStaticApi creates a new static credential store using the Go api.
// 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)

@ -13,7 +13,7 @@ import (
"github.com/stretchr/testify/require"
)
// CreateNewHostCatalogApi creates a new host catalog in boundary using the go api.
// CreateNewHostCatalogApi creates a new host catalog in boundary using the Go api.
// Returns the id of the new host catalog.
func CreateNewHostCatalogApi(t testing.TB, ctx context.Context, client *api.Client, projectId string) string {
hcClient := hostcatalogs.NewClient(client)
@ -25,7 +25,7 @@ func CreateNewHostCatalogApi(t testing.TB, ctx context.Context, client *api.Clie
return newHostCatalogId
}
// CreateNewHostSetApi creates a new host set in boundary using the go api.
// CreateNewHostSetApi creates a new host set in boundary using the Go api.
// Returns the id of the new host set.
func CreateNewHostSetApi(t testing.TB, ctx context.Context, client *api.Client, hostCatalogId string) string {
hsClient := hostsets.NewClient(client)
@ -37,7 +37,7 @@ func CreateNewHostSetApi(t testing.TB, ctx context.Context, client *api.Client,
return newHostSetId
}
// CreateNewHostApi creates a new host in boundary using the go api
// CreateNewHostApi creates a new host in boundary using the Go api
// Returns the id of the new host.
func CreateNewHostApi(t testing.TB, ctx context.Context, client *api.Client, hostCatalogId string, address string) string {
hClient := hosts.NewClient(client)
@ -52,7 +52,7 @@ func CreateNewHostApi(t testing.TB, ctx context.Context, client *api.Client, hos
return newHostId
}
// AddHostToHostSetApi adds a host to a host set using the go api
// AddHostToHostSetApi adds a host to a host set using the Go api
func AddHostToHostSetApi(t testing.TB, ctx context.Context, client *api.Client, hostSetId string, hostId string) {
hsClient := hostsets.NewClient(client)
_, err := hsClient.AddHosts(ctx, hostSetId, 0, []string{hostId}, hostsets.WithAutomaticVersioning(true))

@ -11,7 +11,7 @@ import (
"github.com/stretchr/testify/require"
)
// CreateNewOrgApi creates a new organization in boundary using the go api.
// CreateNewOrgApi creates a new organization in boundary using the Go api.
// Returns the id of the new org.
func CreateNewOrgApi(t testing.TB, ctx context.Context, client *api.Client) string {
scopeClient := scopes.NewClient(client)
@ -28,7 +28,7 @@ func CreateNewOrgApi(t testing.TB, ctx context.Context, client *api.Client) stri
return newOrgId
}
// CreateNewProjectApi creates a new project in boundary using the go api. The project will be created
// CreateNewProjectApi creates a new project in boundary using the Go api. The project will be created
// under the provided org id.
// Returns the id of the new project.
func CreateNewProjectApi(t testing.TB, ctx context.Context, client *api.Client, orgId string) string {

@ -12,7 +12,7 @@ import (
"github.com/stretchr/testify/require"
)
// CreateNewTargetApi creates a new target in boundary using the go api.
// CreateNewTargetApi creates a new target in boundary using the Go api.
// Returns the id of the new target.
func CreateNewTargetApi(t testing.TB, ctx context.Context, client *api.Client, projectId string, defaultPort string) string {
tClient := targets.NewClient(client)
@ -29,7 +29,7 @@ func CreateNewTargetApi(t testing.TB, ctx context.Context, client *api.Client, p
return newTargetId
}
// AddHostSourceToTargetApi adds a host source (host set or host) to a target using the go api
// AddHostSourceToTargetApi adds a host source (host set or host) to a target using the Go api
func AddHostSourceToTargetApi(t testing.TB, ctx context.Context, client *api.Client, targetId string, hostSourceId string) {
tClient := targets.NewClient(client)
_, err := tClient.AddHostSources(ctx, targetId, 0,

@ -11,7 +11,7 @@ import (
"github.com/stretchr/testify/require"
)
// CreateNewUserCli creates a new user using the go api.
// CreateNewUserCli creates a new user using the Go api.
// Returns the id of the new user
func CreateNewUserApi(t testing.TB, ctx context.Context, client *api.Client, scopeId string) string {
uClient := users.NewClient(client)

@ -178,9 +178,9 @@ func TestCreateVaultCredentialStoreCli(t *testing.T) {
t.Log("Successfully connected to target")
}
// TestCreateVaultCredentialStoreApi uses the boundary go api along with the vault cli to
// add secrets management for a target. The test sets up vault as a credential stores and creates
// a set of credentials in vault that is attached to a target.
// TestCreateVaultCredentialStoreApi uses the Go api along with the vault cli to add secrets
// management for a target. The test sets up vault as a credential stores and creates a set of
// credentials in vault that is attached to a target.
func TestCreateVaultCredentialStoreApi(t *testing.T) {
e2e.MaybeSkipTest(t)
c, err := loadConfig()

@ -250,9 +250,9 @@ func TestCreateAwsDynamicHostCatalogCli(t *testing.T) {
require.True(t, hostIpInList, fmt.Sprintf("Connected host (%s) is not in expected list (%s)", hostIp, targetIps1))
}
// TestCreateAwsDynamicHostCatalogApi uses the boundary go api to create a host catalog with the AWS
// plugin. The test sets up an AWS dynamic host catalog, creates a host set, and sets up a target to
// the host set.
// TestCreateAwsDynamicHostCatalogApi uses the Go api to create a host catalog with the AWS plugin.
// The test sets up an AWS dynamic host catalog, creates a host set, and sets up a target to the
// host set.
func TestCreateAwsDynamicHostCatalogApi(t *testing.T) {
e2e.MaybeSkipTest(t)
c, err := loadConfig()

@ -84,7 +84,7 @@ func TestConnectTargetWithSshCli(t *testing.T) {
t.Log("Successfully connected to target")
}
// TestCreateTargetWithStaticCredentialStoreApi uses the boundary go api to create a credential using
// TestCreateTargetWithStaticCredentialStoreApi uses the Go api to create a credential using
// boundary's built-in credential store. The test then attaches that credential to a target.
func TestCreateTargetWithStaticCredentialStoreApi(t *testing.T) {
e2e.MaybeSkipTest(t)

@ -50,7 +50,7 @@ func TestConnectTargetCli(t *testing.T) {
t.Log("Successfully connected to target")
}
// TestCreateTargetApi uses the boundary go api to create a number of supporting objects
// TestCreateTargetApi uses the Go api to create a number of supporting objects
// to connect to a target. This test does not connect to the target due to the complexity
// when not using the cli.
func TestCreateTargetApi(t *testing.T) {

@ -174,7 +174,7 @@ func TestSessionCancelUserCli(t *testing.T) {
t.Log("Successfully cancelled session")
}
// TestCreateUserApi uses the go api to create a new user and add some grants to the user
// TestCreateUserApi uses the Go api to create a new user and add some grants to the user
func TestCreateUserApi(t *testing.T) {
e2e.MaybeSkipTest(t)
c, err := loadConfig()

Loading…
Cancel
Save