|
| 1 | +package stackit_test |
| 2 | + |
| 3 | +import ( |
| 4 | + _ "embed" |
| 5 | + "fmt" |
| 6 | + "os" |
| 7 | + "path" |
| 8 | + "regexp" |
| 9 | + "runtime" |
| 10 | + "testing" |
| 11 | + |
| 12 | + "github.com/hashicorp/terraform-plugin-testing/config" |
| 13 | + "github.com/hashicorp/terraform-plugin-testing/helper/acctest" |
| 14 | + "github.com/hashicorp/terraform-plugin-testing/helper/resource" |
| 15 | + "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/testutil" |
| 16 | +) |
| 17 | + |
| 18 | +//go:embed testdata/provider-credentials.tf |
| 19 | +var providerCredentialConfig string |
| 20 | + |
| 21 | +//go:embed testdata/provider-invalid-attribute.tf |
| 22 | +var providerInvalidAttribute string |
| 23 | + |
| 24 | +//go:embed testdata/provider-all-attributes.tf |
| 25 | +var providerValidAttributes string |
| 26 | + |
| 27 | +var testConfigProviderCredentials = config.Variables{ |
| 28 | + "project_id": config.StringVariable(testutil.ProjectId), |
| 29 | + "name": config.StringVariable(fmt.Sprintf("tf-acc-prov%s", acctest.RandStringFromCharSet(3, acctest.CharSetAlphaNum))), |
| 30 | +} |
| 31 | + |
| 32 | +// Helper function to obtain the home directory on different systems. |
| 33 | +// Based on os.UserHomeDir(). |
| 34 | +func getHomeEnvVariableName() string { |
| 35 | + env := "HOME" |
| 36 | + switch runtime.GOOS { |
| 37 | + case "windows": |
| 38 | + env = "USERPROFILE" |
| 39 | + case "plan9": |
| 40 | + env = "home" |
| 41 | + } |
| 42 | + return env |
| 43 | +} |
| 44 | + |
| 45 | +// create temporary home and initialize the credentials file as well |
| 46 | +func createTemporaryHome(createValidCredentialsFile bool, t *testing.T) string { |
| 47 | + // create a temporary file |
| 48 | + tempHome, err := os.MkdirTemp("", "tempHome") |
| 49 | + if err != nil { |
| 50 | + t.Fatalf("Failed to create temporary home directory: %v", err) |
| 51 | + } |
| 52 | + |
| 53 | + // create credentials file in temp directory |
| 54 | + stackitFolder := path.Join(tempHome, ".stackit") |
| 55 | + if err := os.Mkdir(stackitFolder, 0o750); err != nil { |
| 56 | + t.Fatalf("Failed to create stackit folder: %v", err) |
| 57 | + } |
| 58 | + |
| 59 | + filePath := path.Join(stackitFolder, "credentials.json") |
| 60 | + file, err := os.Create(filePath) |
| 61 | + if err != nil { |
| 62 | + t.Fatalf("Failed to create credentials file: %v", err) |
| 63 | + } |
| 64 | + defer func() { |
| 65 | + if err := file.Close(); err != nil { |
| 66 | + t.Fatalf("Error while closing the file: %v", err) |
| 67 | + } |
| 68 | + }() |
| 69 | + |
| 70 | + // Define content, default = invalid token |
| 71 | + token := "foo_token" |
| 72 | + if createValidCredentialsFile { |
| 73 | + token = testutil.GetTestProjectServiceAccountToken("") |
| 74 | + } |
| 75 | + content := fmt.Sprintf(` |
| 76 | + { |
| 77 | + "STACKIT_SERVICE_ACCOUNT_TOKEN": "%s" |
| 78 | + }`, token) |
| 79 | + |
| 80 | + if _, err = file.WriteString(content); err != nil { |
| 81 | + t.Fatalf("Error writing to file: %v", err) |
| 82 | + } |
| 83 | + |
| 84 | + return tempHome |
| 85 | +} |
| 86 | + |
| 87 | +// Function to overwrite the home folder |
| 88 | +func setTemporaryHome(tempHomePath string) { |
| 89 | + env := getHomeEnvVariableName() |
| 90 | + if err := os.Setenv(env, tempHomePath); err != nil { |
| 91 | + fmt.Printf("Error setting temporary home directory %v", err) |
| 92 | + } |
| 93 | +} |
| 94 | + |
| 95 | +// cleanup the temporary home and reset the environment variable |
| 96 | +func cleanupTemporaryHome(tempHomePath string, t *testing.T) { |
| 97 | + if err := os.RemoveAll(tempHomePath); err != nil { |
| 98 | + t.Fatalf("Error cleaning up temporary folder: %v", err) |
| 99 | + } |
| 100 | + originalHomeDir, err := os.UserHomeDir() |
| 101 | + if err != nil { |
| 102 | + t.Fatalf("Failed to restore home directory back to normal: %v", err) |
| 103 | + } |
| 104 | + // revert back to original home folder |
| 105 | + env := getHomeEnvVariableName() |
| 106 | + if err := os.Setenv(env, originalHomeDir); err != nil { |
| 107 | + fmt.Printf("Error resetting temporary home directory %v", err) |
| 108 | + } |
| 109 | +} |
| 110 | + |
| 111 | +func getServiceAccountToken() (string, error) { |
| 112 | + token, set := os.LookupEnv("TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_TOKEN") |
| 113 | + if !set || token == "" { |
| 114 | + return "", fmt.Errorf("Token not set, please set TF_ACC_TEST_PROJECT_SERVICE_ACCOUNT_TOKEN to a valid token to perform tests") |
| 115 | + } |
| 116 | + return token, nil |
| 117 | +} |
| 118 | + |
| 119 | +func TestAccEnvVarTokenValid(t *testing.T) { |
| 120 | + // Check if acceptance tests should be run |
| 121 | + if v := os.Getenv(resource.EnvTfAcc); v == "" { |
| 122 | + t.Skipf( |
| 123 | + "Acceptance tests skipped unless env '%s' set", |
| 124 | + resource.EnvTfAcc) |
| 125 | + return |
| 126 | + } |
| 127 | + |
| 128 | + token, err := getServiceAccountToken() |
| 129 | + if err != nil { |
| 130 | + t.Fatalf("Can't get token: %v", err) |
| 131 | + } |
| 132 | + |
| 133 | + t.Setenv("STACKIT_CREDENTIALS_PATH", "") |
| 134 | + t.Setenv("STACKIT_SERVICE_ACCOUNT_TOKEN", token) |
| 135 | + tempHomeFolder := createTemporaryHome(false, t) |
| 136 | + defer cleanupTemporaryHome(tempHomeFolder, t) |
| 137 | + resource.Test(t, resource.TestCase{ |
| 138 | + ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories, |
| 139 | + Steps: []resource.TestStep{ |
| 140 | + { |
| 141 | + PreConfig: func() { setTemporaryHome(tempHomeFolder) }, |
| 142 | + ConfigVariables: testConfigProviderCredentials, |
| 143 | + Config: providerCredentialConfig, |
| 144 | + }, |
| 145 | + }, |
| 146 | + }) |
| 147 | +} |
| 148 | + |
| 149 | +func TestAccEnvVarTokenInvalid(t *testing.T) { |
| 150 | + t.Setenv("STACKIT_CREDENTIALS_PATH", "") |
| 151 | + t.Setenv("STACKIT_SERVICE_ACCOUNT_TOKEN", "foo") |
| 152 | + tempHomeFolder := createTemporaryHome(false, t) |
| 153 | + defer cleanupTemporaryHome(tempHomeFolder, t) |
| 154 | + resource.Test(t, resource.TestCase{ |
| 155 | + ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories, |
| 156 | + Steps: []resource.TestStep{ |
| 157 | + { |
| 158 | + PreConfig: func() { setTemporaryHome(tempHomeFolder) }, |
| 159 | + ConfigVariables: testConfigProviderCredentials, |
| 160 | + Config: providerCredentialConfig, |
| 161 | + ExpectError: regexp.MustCompile(`undefined response type, status code 401`), |
| 162 | + }, |
| 163 | + }, |
| 164 | + }) |
| 165 | +} |
| 166 | + |
| 167 | +func TestAccCredentialsFileValid(t *testing.T) { |
| 168 | + t.Setenv("STACKIT_CREDENTIALS_PATH", "") |
| 169 | + t.Setenv("STACKIT_SERVICE_ACCOUNT_TOKEN", "") |
| 170 | + tempHomeFolder := createTemporaryHome(true, t) |
| 171 | + defer cleanupTemporaryHome(tempHomeFolder, t) |
| 172 | + resource.Test(t, resource.TestCase{ |
| 173 | + ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories, |
| 174 | + Steps: []resource.TestStep{ |
| 175 | + { |
| 176 | + PreConfig: func() { setTemporaryHome(tempHomeFolder) }, |
| 177 | + ConfigVariables: testConfigProviderCredentials, |
| 178 | + Config: providerCredentialConfig, |
| 179 | + }, |
| 180 | + }, |
| 181 | + }) |
| 182 | +} |
| 183 | + |
| 184 | +func TestAccCredentialsFileInvalid(t *testing.T) { |
| 185 | + t.Setenv("STACKIT_CREDENTIALS_PATH", "") |
| 186 | + t.Setenv("STACKIT_SERVICE_ACCOUNT_TOKEN", "") |
| 187 | + tempHomeFolder := createTemporaryHome(false, t) |
| 188 | + defer cleanupTemporaryHome(tempHomeFolder, t) |
| 189 | + resource.Test(t, resource.TestCase{ |
| 190 | + ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories, |
| 191 | + Steps: []resource.TestStep{ |
| 192 | + { |
| 193 | + PreConfig: func() { setTemporaryHome(tempHomeFolder) }, |
| 194 | + ConfigVariables: testConfigProviderCredentials, |
| 195 | + Config: providerCredentialConfig, |
| 196 | + ExpectError: regexp.MustCompile(`Jwt is not in(\r\n|\r|\n)the form of Header.Payload.Signature`), |
| 197 | + }, |
| 198 | + }, |
| 199 | + }) |
| 200 | +} |
| 201 | + |
| 202 | +func TestAccProviderConfigureValidValues(t *testing.T) { |
| 203 | + // Check if acceptance tests should be run |
| 204 | + if v := os.Getenv(resource.EnvTfAcc); v == "" { |
| 205 | + t.Skipf( |
| 206 | + "Acceptance tests skipped unless env '%s' set", |
| 207 | + resource.EnvTfAcc) |
| 208 | + return |
| 209 | + } |
| 210 | + // use service account token for these tests |
| 211 | + token, err := getServiceAccountToken() |
| 212 | + if err != nil { |
| 213 | + t.Fatalf("Can't get token: %v", err) |
| 214 | + } |
| 215 | + |
| 216 | + t.Setenv("STACKIT_CREDENTIALS_PATH", "") |
| 217 | + t.Setenv("STACKIT_SERVICE_ACCOUNT_TOKEN", token) |
| 218 | + tempHomeFolder := createTemporaryHome(true, t) |
| 219 | + defer cleanupTemporaryHome(tempHomeFolder, t) |
| 220 | + resource.Test(t, resource.TestCase{ |
| 221 | + ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories, |
| 222 | + Steps: []resource.TestStep{ |
| 223 | + { // valid provider attributes |
| 224 | + ConfigVariables: testConfigProviderCredentials, |
| 225 | + Config: providerValidAttributes, |
| 226 | + }, |
| 227 | + }, |
| 228 | + }) |
| 229 | +} |
| 230 | + |
| 231 | +func TestAccProviderConfigureAnInvalidValue(t *testing.T) { |
| 232 | + // Check if acceptance tests should be run |
| 233 | + if v := os.Getenv(resource.EnvTfAcc); v == "" { |
| 234 | + t.Skipf( |
| 235 | + "Acceptance tests skipped unless env '%s' set", |
| 236 | + resource.EnvTfAcc) |
| 237 | + return |
| 238 | + } |
| 239 | + // use service account token for these tests |
| 240 | + token, err := getServiceAccountToken() |
| 241 | + if err != nil { |
| 242 | + t.Fatalf("Can't get token: %v", err) |
| 243 | + } |
| 244 | + |
| 245 | + t.Setenv("STACKIT_CREDENTIALS_PATH", "") |
| 246 | + t.Setenv("STACKIT_SERVICE_ACCOUNT_TOKEN", token) |
| 247 | + tempHomeFolder := createTemporaryHome(true, t) |
| 248 | + defer cleanupTemporaryHome(tempHomeFolder, t) |
| 249 | + resource.Test(t, resource.TestCase{ |
| 250 | + ProtoV6ProviderFactories: testutil.TestAccProtoV6ProviderFactories, |
| 251 | + Steps: []resource.TestStep{ |
| 252 | + { // invalid test attribute should throw an error |
| 253 | + ConfigVariables: testConfigProviderCredentials, |
| 254 | + Config: providerInvalidAttribute, |
| 255 | + ExpectError: regexp.MustCompile(`An argument named "test" is not expected here\.`), |
| 256 | + }, |
| 257 | + }, |
| 258 | + }) |
| 259 | +} |
0 commit comments