Documentation ¶
Index ¶
- Constants
- Variables
- func AddAttrChecks(targetName string, checks []resource.TestCheckFunc, ...) []resource.TestCheckFunc
- func AddAttrSetChecks(targetName string, checks []resource.TestCheckFunc, attrNames ...string) []resource.TestCheckFunc
- func AddNoAttrSetChecks(targetName string, checks []resource.TestCheckFunc, attrNames ...string) []resource.TestCheckFunc
- func CheckDestroyCluster(s *terraform.State) error
- func CheckDestroyFederatedDatabaseInstance(s *terraform.State) error
- func CheckDestroyNetworkPeering(s *terraform.State) error
- func CheckDestroyOrgInvitation(s *terraform.State) error
- func CheckDestroyProject(s *terraform.State) error
- func CheckDestroyProjectGov(s *terraform.State) error
- func CheckDestroySearchIndex(state *terraform.State) error
- func CheckDestroyStreamInstance(state *terraform.State) error
- func CheckDestroyTeam(s *terraform.State) error
- func ClusterNameExecution(tb testing.TB) (projectID, clusterName string)
- func ConfigClusterGlobal(orgID, projectName, clusterName string) string
- func ConfigDatabaseUserBasic(projectID, username, roleName, keyLabel, valueLabel string) string
- func ConfigDatabaseUserWithAWSIAMType(projectID, username, roleName, keyLabel, valueLabel string) string
- func ConfigDatabaseUserWithLDAPAuthType(projectID, username, roleName, keyLabel, valueLabel string) string
- func ConfigDatabaseUserWithLabels(projectID, username, roleName string, labels []admin.ComponentLabel) string
- func ConfigDatabaseUserWithRoles(projectID, username, password string, rolesArr []*admin.DatabaseUserRole) string
- func ConfigDatabaseUserWithScopes(projectID, username, password, roleName string, scopesArr []*admin.UserScope) string
- func ConfigDatabaseUserWithX509Type(projectID, username, x509Type, roleName, keyLabel, valueLabel string) string
- func ConfigGovProvider() string
- func ConfigProjectWithSettings(projectName, orgID, projectOwnerID string, value bool) string
- func ConfigServerlessInstance(projectID, name string, ignoreConnectionStrings bool, autoIndexing *bool, ...) string
- func Conn() *matlas.Client
- func ConnV2() *admin.APIClient
- func ConnV2UsingGov() *admin.APIClient
- func ConnV2UsingProxy(proxyPort *int) *admin.APIClient
- func DebugPlan() plancheck.PlanCheck
- func ExistingClusterUsed() bool
- func ExternalProviders(versionAtlasProvider string) map[string]resource.ExternalProvider
- func ExternalProvidersOnlyAWS() map[string]resource.ExternalProvider
- func ExternalProvidersWithAWS(versionAtlasProvider string) map[string]resource.ExternalProvider
- func FormatToHCLLifecycleIgnore(keys ...string) string
- func FormatToHCLMap(m map[string]string, indent, varName string) string
- func GetProjectTeamsIDsWithPos(pos int) string
- func ImportStateClusterIDFunc(resourceName string) resource.ImportStateIdFunc
- func ImportStateProjectIDFunc(resourceName string) resource.ImportStateIdFunc
- func InCI() bool
- func InUnitTest() bool
- func IntGreatThan(value int) resource.CheckResourceAttrWithFunc
- func JSONEquals(expected string) resource.CheckResourceAttrWithFunc
- func MatchesExpression(expr string) resource.CheckResourceAttrWithFunc
- func PreCheck(tb testing.TB)
- func PreCheckAtlasUsername(tb testing.TB)
- func PreCheckAwsEnv(tb testing.TB)
- func PreCheckAwsEnvBasic(tb testing.TB)
- func PreCheckAwsEnvPrivateLinkEndpointService(tb testing.TB)
- func PreCheckBasic(tb testing.TB)
- func PreCheckBasicOwnerID(tb testing.TB)
- func PreCheckCert(tb testing.TB)
- func PreCheckCloudProviderAccessAzure(tb testing.TB)
- func PreCheckDataLakePipelineRun(tb testing.TB)
- func PreCheckDataLakePipelineRuns(tb testing.TB)
- func PreCheckEncryptionAtRestEnvAzure(tb testing.TB)
- func PreCheckFederatedSettings(tb testing.TB)
- func PreCheckFederatedSettingsIdentityProvider(tb testing.TB)
- func PreCheckGPCEnv(tb testing.TB)
- func PreCheckGovBasic(tb testing.TB)
- func PreCheckLDAP(tb testing.TB)
- func PreCheckLDAPCert(tb testing.TB)
- func PreCheckPeeringEnvAWS(tb testing.TB)
- func PreCheckPeeringEnvAzure(tb testing.TB)
- func PreCheckPeeringEnvGCP(tb testing.TB)
- func PreCheckPreviewFlag(tb testing.TB)
- func PreCheckPrivateEndpoint(tb testing.TB)
- func PreCheckProjectTeamsIDsWithMinCount(tb testing.TB, minTeamsCount int)
- func PreCheckRegularCredsAreEmpty(tb testing.TB)
- func PreCheckS3Bucket(tb testing.TB)
- func PreCheckSTSAssumeRole(tb testing.TB)
- func ProjectID(tb testing.TB, name string) string
- func ProjectIDExecution(tb testing.TB) string
- func RandomClusterName() string
- func RandomEmail() string
- func RandomIAMRole() string
- func RandomIAMUser() string
- func RandomIP(a, b, c byte) string
- func RandomLDAPName() string
- func RandomName() string
- func RandomProjectName() string
- func RandomS3BucketName() string
- func SetupSharedResources() func()
- func SkipInUnitTest(tb testing.TB)
- func SkipTestForCI(tb testing.TB)
- func StreamInstanceConfig(projectID, instanceName, region, cloudProvider string) string
- func StreamInstanceWithStreamConfigConfig(projectID, instanceName, region, cloudProvider, configTier string) string
- func TestAccProviderV6FactoriesWithProxy(proxyPort *int) map[string]func() (tfprotov6.ProviderServer, error)
- type ClusterInfo
- type ClusterRequest
Constants ¶
const AwsProviderVersion = "5.1.0"
const (
// Provider name for single configuration testing
ProviderNameMongoDBAtlas = "mongodbatlas"
)
Variables ¶
var ( ClusterTagsMap1 = map[string]string{ "key": "key 1", "value": "value 1", } ClusterTagsMap2 = map[string]string{ "key": "key 2", "value": "value 2", } ClusterTagsMap3 = map[string]string{ "key": "key 3", "value": "value 3", } )
var MongoDBClient *config.MongoDBClient
MongoDBClient is used to configure client required for Framework-based acceptance tests.
var TestAccProviderV6Factories map[string]func() (tfprotov6.ProviderServer, error)
TestAccProviderV6Factories is used in all tests for ProtoV6ProviderFactories.
Functions ¶
func AddAttrChecks ¶ added in v1.15.3
func AddAttrChecks(targetName string, checks []resource.TestCheckFunc, mapChecks map[string]string) []resource.TestCheckFunc
func AddAttrSetChecks ¶ added in v1.15.3
func AddAttrSetChecks(targetName string, checks []resource.TestCheckFunc, attrNames ...string) []resource.TestCheckFunc
func AddNoAttrSetChecks ¶ added in v1.16.0
func AddNoAttrSetChecks(targetName string, checks []resource.TestCheckFunc, attrNames ...string) []resource.TestCheckFunc
func CheckDestroyCluster ¶ added in v1.15.2
func CheckDestroyProject ¶
func CheckDestroyProjectGov ¶ added in v1.16.1
func CheckDestroySearchIndex ¶
func CheckDestroyTeam ¶
func ClusterNameExecution ¶ added in v1.16.0
ClusterNameExecution returns the name of a created cluster for the execution of the tests in the resource package. This function relies on using an execution project and returns its id. When `MONGODB_ATLAS_CLUSTER_NAME` and `MONGODB_ATLAS_PROJECT_ID` are defined it will be used instead of creating resources. This is useful for local execution but not intended for CI executions.
func ConfigClusterGlobal ¶
func ConfigDatabaseUserBasic ¶
func ConfigDatabaseUserWithLabels ¶
func ConfigDatabaseUserWithLabels(projectID, username, roleName string, labels []admin.ComponentLabel) string
func ConfigDatabaseUserWithRoles ¶
func ConfigDatabaseUserWithRoles(projectID, username, password string, rolesArr []*admin.DatabaseUserRole) string
func ConfigGovProvider ¶ added in v1.16.1
func ConfigGovProvider() string
ConfigGovProvider creates provider using MONGODB_ATLAS_GOV_* env vars.
Remember to use PreCheckGovBasic when using this.
func ConfigProjectWithSettings ¶ added in v1.15.0
func ConfigServerlessInstance ¶ added in v1.16.0
func ConnV2UsingGov ¶ added in v1.16.1
func ConnV2UsingProxy ¶ added in v1.15.3
func ExistingClusterUsed ¶ added in v1.15.2
func ExistingClusterUsed() bool
func ExternalProviders ¶ added in v1.15.0
func ExternalProviders(versionAtlasProvider string) map[string]resource.ExternalProvider
func ExternalProvidersOnlyAWS ¶ added in v1.15.0
func ExternalProvidersOnlyAWS() map[string]resource.ExternalProvider
func ExternalProvidersWithAWS ¶ added in v1.15.0
func ExternalProvidersWithAWS(versionAtlasProvider string) map[string]resource.ExternalProvider
func FormatToHCLLifecycleIgnore ¶ added in v1.16.0
func FormatToHCLMap ¶ added in v1.16.0
func GetProjectTeamsIDsWithPos ¶ added in v1.15.2
func ImportStateClusterIDFunc ¶
func ImportStateClusterIDFunc(resourceName string) resource.ImportStateIdFunc
func ImportStateProjectIDFunc ¶
func ImportStateProjectIDFunc(resourceName string) resource.ImportStateIdFunc
func InUnitTest ¶ added in v1.15.2
func InUnitTest() bool
func IntGreatThan ¶
func IntGreatThan(value int) resource.CheckResourceAttrWithFunc
func JSONEquals ¶
func JSONEquals(expected string) resource.CheckResourceAttrWithFunc
func MatchesExpression ¶
func MatchesExpression(expr string) resource.CheckResourceAttrWithFunc
func PreCheck ¶
PreCheck checks common Atlas environment variables and MONGODB_ATLAS_PROJECT_ID. Deprecated: it should not be used as MONGODB_ATLAS_PROJECT_ID is not intended to be used in CI. Use PreCheckBasic instead.
func PreCheckAtlasUsername ¶
func PreCheckAwsEnv ¶
func PreCheckAwsEnvBasic ¶ added in v1.16.0
func PreCheckAwsEnvPrivateLinkEndpointService ¶ added in v1.16.1
func PreCheckBasic ¶
func PreCheckBasicOwnerID ¶
func PreCheckCert ¶ added in v1.15.1
func PreCheckFederatedSettingsIdentityProvider ¶ added in v1.16.1
func PreCheckGPCEnv ¶
func PreCheckGovBasic ¶ added in v1.16.0
func PreCheckLDAP ¶
func PreCheckLDAPCert ¶ added in v1.15.2
func PreCheckPeeringEnvAWS ¶
func PreCheckPeeringEnvAzure ¶
func PreCheckPeeringEnvGCP ¶
func PreCheckPreviewFlag ¶ added in v1.15.2
PreCheckPreviewFlag is used for resources not yet in GA
func PreCheckPrivateEndpoint ¶ added in v1.15.2
func PreCheckProjectTeamsIDsWithMinCount ¶ added in v1.15.2
func PreCheckS3Bucket ¶ added in v1.15.0
func PreCheckSTSAssumeRole ¶
func ProjectID ¶ added in v1.15.3
ProjectID returns the id for a project name. When `MONGODB_ATLAS_PROJECT_ID` is defined, it is used instead of creating a project. This is useful for local execution but not intended for CI executions.
func ProjectIDExecution ¶ added in v1.15.2
ProjectIDExecution returns a project id created for the execution of the tests in the resource package. Even if a GH test group is run, every resource/package will create its own project, not a shared project for all the test group. When `MONGODB_ATLAS_PROJECT_ID` is defined, it is used instead of creating a project. This is useful for local execution but not intended for CI executions.
func RandomClusterName ¶ added in v1.15.2
func RandomClusterName() string
func RandomEmail ¶ added in v1.15.2
func RandomEmail() string
func RandomIAMRole ¶ added in v1.15.2
func RandomIAMRole() string
func RandomIAMUser ¶ added in v1.15.2
func RandomIAMUser() string
func RandomLDAPName ¶ added in v1.15.2
func RandomLDAPName() string
func RandomName ¶ added in v1.15.2
func RandomName() string
func RandomProjectName ¶ added in v1.15.2
func RandomProjectName() string
func RandomS3BucketName ¶ added in v1.16.0
func RandomS3BucketName() string
func SetupSharedResources ¶ added in v1.15.2
func SetupSharedResources() func()
SetupSharedResources must be called from TestMain test package in order to use ProjectIDExecution. It returns the cleanup function that must be called at the end of TestMain.
func SkipInUnitTest ¶ added in v1.15.2
SkipInUnitTest allows skipping a test entirely when TF_ACC=1 is not defined. This can be useful for acceptance tests that define logic prior to resource.Test/resource.ParallelTest functions as this code would always be run.
func SkipTestForCI ¶
SkipTestForCI is added to tests that cannot run as part of CI, e.g. in Github actions.
func StreamInstanceConfig ¶
func StreamInstanceWithStreamConfigConfig ¶ added in v1.15.2
func TestAccProviderV6FactoriesWithProxy ¶ added in v1.15.3
func TestAccProviderV6FactoriesWithProxy(proxyPort *int) map[string]func() (tfprotov6.ProviderServer, error)
Types ¶
type ClusterInfo ¶
type ClusterInfo struct { ProjectIDStr string ProjectID string ClusterName string ClusterNameStr string ClusterTerraformStr string }
func GetClusterInfo ¶
func GetClusterInfo(tb testing.TB, req *ClusterRequest) ClusterInfo
GetClusterInfo is used to obtain a project and cluster configuration resource. When `MONGODB_ATLAS_CLUSTER_NAME` and `MONGODB_ATLAS_PROJECT_ID` are defined, creation of resources is avoided. This is useful for local execution but not intended for CI executions. Clusters will be created in project ProjectIDExecution.