From eb927958bd416606027601af49684315a4432e5b Mon Sep 17 00:00:00 2001 From: Paul Tyng Date: Sat, 10 Apr 2021 15:52:23 -0400 Subject: [PATCH 001/644] Add null to tobool docs --- website/docs/language/functions/tobool.html.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/language/functions/tobool.html.md b/website/docs/language/functions/tobool.html.md index 4ff160929ba9..88dbb19f322d 100644 --- a/website/docs/language/functions/tobool.html.md +++ b/website/docs/language/functions/tobool.html.md @@ -14,7 +14,7 @@ Explicit type conversions are rarely necessary in Terraform because it will convert types automatically where required. Use the explicit type conversion functions only to normalize types returned in module outputs. -Only boolean values and the exact strings `"true"` and `"false"` can be +Only boolean values, `null`, and the exact strings `"true"` and `"false"` can be converted to boolean. All other values will produce an error. ## Examples @@ -24,6 +24,8 @@ converted to boolean. All other values will produce an error. true > tobool("true") true +> tobool(null) +null > tobool("no") Error: Invalid function argument From b3fe8713e819f8b8a3212c5086d91f077cd67e43 Mon Sep 17 00:00:00 2001 From: Paul Tyng Date: Sat, 10 Apr 2021 15:54:51 -0400 Subject: [PATCH 002/644] Add null to tonumber docs --- website/docs/language/functions/tonumber.html.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/language/functions/tonumber.html.md b/website/docs/language/functions/tonumber.html.md index 1b7e0236b50a..3d5801255869 100644 --- a/website/docs/language/functions/tonumber.html.md +++ b/website/docs/language/functions/tonumber.html.md @@ -14,7 +14,7 @@ Explicit type conversions are rarely necessary in Terraform because it will convert types automatically where required. Use the explicit type conversion functions only to normalize types returned in module outputs. -Only numbers and strings containing decimal representations of numbers can be +Only numbers, `null`, and strings containing decimal representations of numbers can be converted to number. All other values will produce an error. ## Examples @@ -24,6 +24,8 @@ converted to number. All other values will produce an error. 1 > tonumber("1") 1 +> tonumber(null) +null > tonumber("no") Error: Invalid function argument From b8a0929a5d607f1dc8ebc5ca8ed4a29450e4bcee Mon Sep 17 00:00:00 2001 From: Paul Tyng Date: Sat, 10 Apr 2021 15:55:29 -0400 Subject: [PATCH 003/644] Add null to tostring docs --- website/docs/language/functions/tostring.html.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/language/functions/tostring.html.md b/website/docs/language/functions/tostring.html.md index 667b3619a063..bbe11acfdf7f 100644 --- a/website/docs/language/functions/tostring.html.md +++ b/website/docs/language/functions/tostring.html.md @@ -14,7 +14,7 @@ Explicit type conversions are rarely necessary in Terraform because it will convert types automatically where required. Use the explicit type conversion functions only to normalize types returned in module outputs. -Only the primitive types (string, number, and bool) can be converted to string. +Only the primitive types (string, number, and bool) and `null` can be converted to string. All other values will produce an error. ## Examples @@ -26,6 +26,8 @@ hello 1 > tostring(true) true +> tostring(null) +null > tostring([]) Error: Invalid function argument From c6de87354ae664879237cf11411a22393ac0cef6 Mon Sep 17 00:00:00 2001 From: Yves Peter Date: Tue, 13 Apr 2021 10:26:32 +0200 Subject: [PATCH 004/644] document that destroy provisioners don't run with create_before_destroy --- website/docs/language/meta-arguments/lifecycle.html.md | 4 ++++ website/docs/language/resources/provisioners/syntax.html.md | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/website/docs/language/meta-arguments/lifecycle.html.md b/website/docs/language/meta-arguments/lifecycle.html.md index 6671ff3b31e5..afa726cee081 100644 --- a/website/docs/language/meta-arguments/lifecycle.html.md +++ b/website/docs/language/meta-arguments/lifecycle.html.md @@ -45,6 +45,10 @@ The following arguments can be used within a `lifecycle` block: such features, so you must understand the constraints for each resource type before using `create_before_destroy` with it. + Destroy provisioners of this resource will not run if `create_before_destroy` + is used. This limitation may be addressed in the future, see + [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) for details. + * `prevent_destroy` (bool) - This meta-argument, when set to `true`, will cause Terraform to reject with an error any plan that would destroy the infrastructure object associated with the resource, as long as the argument diff --git a/website/docs/language/resources/provisioners/syntax.html.md b/website/docs/language/resources/provisioners/syntax.html.md index 3a8eb95eb290..171f3fe13cdb 100644 --- a/website/docs/language/resources/provisioners/syntax.html.md +++ b/website/docs/language/resources/provisioners/syntax.html.md @@ -237,6 +237,11 @@ fail, Terraform will error and rerun the provisioners again on the next `terraform apply`. Due to this behavior, care should be taken for destroy provisioners to be safe to run multiple times. +Destroy provisioners will not run if the lifecycle Meta-Argument +[`create_before_destroy`](/docs/language/meta-arguments/lifecycle.html) is used +in the resource. This limitation may be addressed in the future, see +[GitHub issue](https://github.com/hashicorp/terraform/issues/13549) for details. + Destroy-time provisioners can only run if they remain in the configuration at the time a resource is destroyed. If a resource block with a destroy-time provisioner is removed entirely from the configuration, its provisioner From a303a03f2f07a8e4937e876139ca61c1b433cc06 Mon Sep 17 00:00:00 2001 From: Chad Bailey Date: Sun, 2 May 2021 17:14:10 -0500 Subject: [PATCH 005/644] Added clarity: remote-exec connection requirement This is a secondary change to PR #28578 Details: According to the [Provisioner Connection](https://www.terraform.io/docs/language/resources/provisioners/connection.html) page, provisioners require the connection block. This change of behavior is shown prominently within a note on the [Provisioner Connection](https://www.terraform.io/docs/language/resources/provisioners/connection.html) page: > Note: In Terraform 0.11 and earlier, providers could set default values for some connection settings, so that connection blocks could sometimes be omitted. This feature was removed in 0.12 in order to make Terraform's behavior more predictable. However, this behavioral change is omitted from the [remote-exec provisioner](https://www.terraform.io/docs/language/resources/provisioners/remote-exec.html) page which is where a user will be if they are attempting to follow the prior behavior when this was permissible in versions prior to 0.12. This change prompts the user of that change and directs to the connection page. --- .../resources/provisioners/remote-exec.html.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/website/docs/language/resources/provisioners/remote-exec.html.md b/website/docs/language/resources/provisioners/remote-exec.html.md index 312728300bf5..19e771989de8 100644 --- a/website/docs/language/resources/provisioners/remote-exec.html.md +++ b/website/docs/language/resources/provisioners/remote-exec.html.md @@ -12,7 +12,8 @@ The `remote-exec` provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc. To invoke a local process, see the `local-exec` [provisioner](/docs/language/resources/provisioners/local-exec.html) instead. The `remote-exec` -provisioner supports both `ssh` and `winrm` type [connections](/docs/language/resources/provisioners/connection.html). +provisioner requires a [connection](/docs/language/resources/provisioners/connection.html) +and supports both `ssh` and `winrm`. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see @@ -24,6 +25,15 @@ common situations there are better alternatives. For more information, see resource "aws_instance" "web" { # ... + # Establishes connection to be used by all + # generic remote provisioners (i.e. file/remote-exec) + connection { + type = "ssh" + user = "root" + password = var.root_password + host = self.public_ip + } + provisioner "remote-exec" { inline = [ "puppet apply", From d29cdccb5bc0e34665092c5dc3a832f0ca9226bf Mon Sep 17 00:00:00 2001 From: Ben Moskovitz Date: Wed, 30 Jun 2021 16:39:31 +1200 Subject: [PATCH 006/644] Add a note to the docs on the S3 backend around permissions needed for encrypted state storage --- website/docs/language/settings/backends/s3.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.html.md index 678cb24b7b43..c6dac3b993c2 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.html.md @@ -190,7 +190,7 @@ The following configuration is optional: * `encrypt` - (Optional) Enable [server side encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) of the state file. * `endpoint` - (Optional) Custom endpoint for the AWS S3 API. This can also be sourced from the `AWS_S3_ENDPOINT` environment variable. * `force_path_style` - (Optional) Enable path-style S3 URLs (`https:///` instead of `https://.`). -* `kms_key_id` - (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. +* `kms_key_id` - (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. Note that if this value is specified, Terraform will need `kms:Encrypt`, `kms:Decrypt` and `kms:GenerateDataKey` permissions on this KMS key. * `sse_customer_key` - (Optional) The key to use for encrypting state with [Server-Side Encryption with Customer-Provided Keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). This is the base64-encoded value of the key, which must decode to 256 bits. This can also be sourced from the `AWS_SSE_CUSTOMER_KEY` environment variable, which is recommended due to the sensitivity of the value. Setting it inside a terraform file will cause it to be persisted to disk in `terraform.tfstate`. * `workspace_key_prefix` - (Optional) Prefix applied to the state path inside the bucket. This is only relevant when using a non-default workspace. Defaults to `env:`. From 21228e19df4a0ea6da669f2813b7aa887d5714ba Mon Sep 17 00:00:00 2001 From: Ben Moskovitz Date: Wed, 30 Jun 2021 16:55:00 +1200 Subject: [PATCH 007/644] Fix broken links as pointed out by CI See: https://app.circleci.com/pipelines/github/hashicorp/terraform/6853/workflows/cc37def1-6bf5-4f6c-89b1-10dfcc65ea5e/jobs/44887 --- website/docs/language/settings/backends/s3.html.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.html.md index c6dac3b993c2..e2b93beddc74 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.html.md @@ -18,7 +18,7 @@ the `dynamodb_table` field to an existing DynamoDB table name. A single DynamoDB table can be used to lock multiple remote state files. Terraform generates key names that include the values of the `bucket` and `key` variables. ~> **Warning!** It is highly recommended that you enable -[Bucket Versioning](http://docs.aws.amazon.com/AmazonS3/latest/UG/enable-bucket-versioning.html) +[Bucket Versioning](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html) on the S3 bucket to allow for state recovery in the case of accidental deletions and human error. ## Example Configuration @@ -73,7 +73,7 @@ attached to users/groups/roles (like the example above) or resource policies attached to bucket objects (which look similar but also require a `Principal` to indicate which entity has those permissions). For more details, see Amazon's documentation about -[S3 access control](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html). +[S3 access control](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). ### DynamoDB Table Permissions @@ -186,12 +186,12 @@ The following configuration is required: The following configuration is optional: -* `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to be applied to the state file. -* `encrypt` - (Optional) Enable [server side encryption](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) of the state file. +* `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl) to be applied to the state file. +* `encrypt` - (Optional) Enable [server side encryption](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingServerSideEncryption.html) of the state file. * `endpoint` - (Optional) Custom endpoint for the AWS S3 API. This can also be sourced from the `AWS_S3_ENDPOINT` environment variable. * `force_path_style` - (Optional) Enable path-style S3 URLs (`https:///` instead of `https://.`). * `kms_key_id` - (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. Note that if this value is specified, Terraform will need `kms:Encrypt`, `kms:Decrypt` and `kms:GenerateDataKey` permissions on this KMS key. -* `sse_customer_key` - (Optional) The key to use for encrypting state with [Server-Side Encryption with Customer-Provided Keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). This is the base64-encoded value of the key, which must decode to 256 bits. This can also be sourced from the `AWS_SSE_CUSTOMER_KEY` environment variable, which is recommended due to the sensitivity of the value. Setting it inside a terraform file will cause it to be persisted to disk in `terraform.tfstate`. +* `sse_customer_key` - (Optional) The key to use for encrypting state with [Server-Side Encryption with Customer-Provided Keys (SSE-C)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html). This is the base64-encoded value of the key, which must decode to 256 bits. This can also be sourced from the `AWS_SSE_CUSTOMER_KEY` environment variable, which is recommended due to the sensitivity of the value. Setting it inside a terraform file will cause it to be persisted to disk in `terraform.tfstate`. * `workspace_key_prefix` - (Optional) Prefix applied to the state path inside the bucket. This is only relevant when using a non-default workspace. Defaults to `env:`. ### DynamoDB State Locking @@ -245,7 +245,7 @@ Your administrative AWS account will contain at least the following items: * Optionally, one or more [IAM groups](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html) to differentiate between different groups of users that have different levels of access to the other AWS accounts. -* An [S3 bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html) +* An [S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) that will contain the Terraform state files for each workspace. * A [DynamoDB table](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.TablesItemsAttributes) that will be used for locking to prevent concurrent operations on a single From dea645797ae26d08032f03611b9c055dd3800a41 Mon Sep 17 00:00:00 2001 From: magodo Date: Sat, 24 Jul 2021 11:34:58 +0800 Subject: [PATCH 008/644] `terraform add -out` append to existing config --- internal/command/views/add.go | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/internal/command/views/add.go b/internal/command/views/add.go index 4b1c96d700ff..d181e19090ea 100644 --- a/internal/command/views/add.go +++ b/internal/command/views/add.go @@ -74,7 +74,14 @@ func (v *addHuman) Resource(addr addrs.AbsResourceInstance, schema *configschema } else { // The Println call above adds this final newline automatically; we add it manually here. formatted = append(formatted, '\n') - return os.WriteFile(v.outPath, formatted, 0600) + + f, err := os.OpenFile(v.outPath, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600) + if err != nil { + return err + } + defer f.Close() + _, err = f.Write(formatted) + return err } } From 67afee693b226bedd583608f56f03d4fd5bfc87a Mon Sep 17 00:00:00 2001 From: magodo Date: Sat, 24 Jul 2021 12:03:32 +0800 Subject: [PATCH 009/644] target resource in module check only when `-out` points to a module --- internal/command/add.go | 53 +++++++++++++++++++++++++++++------------ 1 file changed, 38 insertions(+), 15 deletions(-) diff --git a/internal/command/add.go b/internal/command/add.go index bb989e31e5a0..343851426f65 100644 --- a/internal/command/add.go +++ b/internal/command/add.go @@ -3,6 +3,7 @@ package command import ( "fmt" "os" + "path/filepath" "strings" "github.com/hashicorp/hcl/v2" @@ -33,6 +34,43 @@ func (c *AddCommand) Run(rawArgs []string) int { return 1 } + // In case the output configuration path is specified, we should ensure the + // target resource address doesn't exist in the module tree indicated by + // the existing configuration files. + if args.OutPath != "" { + // Ensure the directory to the path exists and is accessible. + outDir := filepath.Dir(args.OutPath) + if _, err := os.Stat(outDir); os.IsNotExist(err) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "The out path doesn't exist or is not accessible", + err.Error(), + )) + view.Diagnostics(diags) + return 1 + } + + config, loadDiags := c.loadConfig(outDir) + diags = diags.Append(loadDiags) + if diags.HasErrors() { + view.Diagnostics(diags) + return 1 + } + + if config != nil && config.Module != nil { + if rs, ok := config.Module.ManagedResources[args.Addr.ContainingResource().Config().String()]; ok { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Resource already in configuration", + Detail: fmt.Sprintf("The resource %s is already in this configuration at %s. Resource names must be unique per type in each module.", args.Addr, rs.DeclRange), + Subject: &rs.DeclRange, + }) + c.View.Diagnostics(diags) + return 1 + } + } + } + // Check for user-supplied plugin path var err error if c.pluginPath, err = c.loadPluginPath(); err != nil { @@ -119,21 +157,6 @@ func (c *AddCommand) Run(rawArgs []string) int { } } - if module == nil { - // It's fine if the module doesn't actually exist; we don't need to check if the resource exists. - } else { - if rs, ok := module.ManagedResources[args.Addr.ContainingResource().Config().String()]; ok { - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Resource already in configuration", - Detail: fmt.Sprintf("The resource %s is already in this configuration at %s. Resource names must be unique per type in each module.", args.Addr, rs.DeclRange), - Subject: &rs.DeclRange, - }) - c.View.Diagnostics(diags) - return 1 - } - } - // Get the schemas from the context schemas := ctx.Schemas() From 90e6a3dffb922b4b6f195ad6304c9fe387b4dcc0 Mon Sep 17 00:00:00 2001 From: magodo Date: Mon, 26 Jul 2021 11:25:47 +0800 Subject: [PATCH 010/644] modify test case --- internal/command/add_test.go | 67 +++++++++++++++++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/internal/command/add_test.go b/internal/command/add_test.go index 18661d1cc46a..96b0d349be92 100644 --- a/internal/command/add_test.go +++ b/internal/command/add_test.go @@ -103,6 +103,45 @@ func TestAdd_basic(t *testing.T) { } }) + t.Run("basic to existing file", func(t *testing.T) { + view, done := testView(t) + c := &AddCommand{ + Meta: Meta{ + testingOverrides: overrides, + View: view, + }, + } + outPath := "add.tf" + args := []string{fmt.Sprintf("-out=%s", outPath), "test_instance.new"} + c.Run(args) + args = []string{fmt.Sprintf("-out=%s", outPath), "test_instance.new2"} + code := c.Run(args) + output := done(t) + if code != 0 { + fmt.Println(output.Stderr()) + t.Fatalf("wrong exit status. Got %d, want 0", code) + } + expected := `resource "test_instance" "new" { + value = null # REQUIRED string +} +resource "test_instance" "new2" { + value = null # REQUIRED string +} +` + result, err := os.ReadFile(outPath) + if err != nil { + t.Fatalf("error reading result file %s: %s", outPath, err.Error()) + } + // While the entire directory will get removed once the whole test suite + // is done, we remove this lest it gets in the way of another (not yet + // written) test. + os.Remove(outPath) + + if !cmp.Equal(expected, string(result)) { + t.Fatalf("wrong output:\n%s", cmp.Diff(expected, string(result))) + } + }) + t.Run("optionals", func(t *testing.T) { view, done := testView(t) c := &AddCommand{ @@ -164,7 +203,8 @@ func TestAdd_basic(t *testing.T) { View: view, }, } - args := []string{"test_instance.exists"} + outPath := "add.tf" + args := []string{fmt.Sprintf("-out=%s", outPath), "test_instance.exists"} code := c.Run(args) if code != 1 { t.Fatalf("wrong exit status. Got %d, want 0", code) @@ -176,6 +216,31 @@ func TestAdd_basic(t *testing.T) { } }) + t.Run("output existing resource to stdout", func(t *testing.T) { + view, done := testView(t) + c := &AddCommand{ + Meta: Meta{ + testingOverrides: overrides, + View: view, + }, + } + args := []string{"test_instance.exists"} + code := c.Run(args) + output := done(t) + if code != 0 { + fmt.Println(output.Stderr()) + t.Fatalf("wrong exit status. Got %d, want 0", code) + } + expected := `resource "test_instance" "exists" { + value = null # REQUIRED string +} +` + + if !cmp.Equal(output.Stdout(), expected) { + t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) + } + }) + t.Run("provider not in configuration", func(t *testing.T) { view, done := testView(t) c := &AddCommand{ From 9d5f1752c851cc15da18098a8dc2eff0dc42cf5a Mon Sep 17 00:00:00 2001 From: Alex Khaerov Date: Tue, 3 Aug 2021 14:21:48 +0800 Subject: [PATCH 011/644] oss backend: flattern assume_role block --- internal/backend/remote-state/oss/backend.go | 123 +++++++----------- .../language/settings/backends/oss.html.md | 15 +-- 2 files changed, 54 insertions(+), 84 deletions(-) diff --git a/internal/backend/remote-state/oss/backend.go b/internal/backend/remote-state/oss/backend.go index de08af37d68f..5a2b2880ce61 100644 --- a/internal/backend/remote-state/oss/backend.go +++ b/internal/backend/remote-state/oss/backend.go @@ -146,8 +146,6 @@ func New() backend.Backend { return nil, nil }, }, - - "assume_role": assumeRoleSchema(), "shared_credentials_file": { Type: schema.TypeString, Optional: true, @@ -160,60 +158,48 @@ func New() backend.Backend { Description: "This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable.", DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_PROFILE", ""), }, - }, - } - - result := &Backend{Backend: s} - result.Backend.ConfigureFunc = result.configure - return result -} - -func assumeRoleSchema() *schema.Schema { - return &schema.Schema{ - Type: schema.TypeSet, - Optional: true, - MaxItems: 1, - Elem: &schema.Resource{ - Schema: map[string]*schema.Schema{ - "role_arn": { - Type: schema.TypeString, - Required: true, - Description: "The ARN of a RAM role to assume prior to making API calls.", - DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), - }, - "session_name": { - Type: schema.TypeString, - Optional: true, - Description: "The session name to use when assuming the role.", - DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), - }, - "policy": { - Type: schema.TypeString, - Optional: true, - Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", - }, - "session_expiration": { - Type: schema.TypeInt, - Optional: true, - Description: "The time after which the established session for assuming role expires.", - ValidateFunc: func(v interface{}, k string) ([]string, []error) { - min := 900 - max := 3600 - value, ok := v.(int) - if !ok { - return nil, []error{fmt.Errorf("expected type of %s to be int", k)} - } + "assume_role_role_arn": { + Type: schema.TypeString, + Required: true, + Description: "The ARN of a RAM role to assume prior to making API calls.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), + }, + "assume_role_session_name": { + Type: schema.TypeString, + Optional: true, + Description: "The session name to use when assuming the role.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), + }, + "assume_role_policy": { + Type: schema.TypeString, + Optional: true, + Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", + }, + "assume_role_session_expiration": { + Type: schema.TypeInt, + Optional: true, + Description: "The time after which the established session for assuming role expires.", + ValidateFunc: func(v interface{}, k string) ([]string, []error) { + min := 900 + max := 3600 + value, ok := v.(int) + if !ok { + return nil, []error{fmt.Errorf("expected type of %s to be int", k)} + } - if value < min || value > max { - return nil, []error{fmt.Errorf("expected %s to be in the range (%d - %d), got %d", k, min, max, v)} - } + if value < min || value > max { + return nil, []error{fmt.Errorf("expected %s to be in the range (%d - %d), got %d", k, min, max, v)} + } - return nil, nil - }, + return nil, nil }, }, }, } + + result := &Backend{Backend: s} + result.Backend.ConfigureFunc = result.configure + return result } type Backend struct { @@ -274,31 +260,22 @@ func (b *Backend) configure(ctx context.Context) error { sessionExpiration = (int)(expiredSeconds.(float64)) } - if v, ok := d.GetOk("assume_role"); ok { - for _, v := range v.(*schema.Set).List() { - assumeRole := v.(map[string]interface{}) - if assumeRole["role_arn"].(string) != "" { - roleArn = assumeRole["role_arn"].(string) - } - if assumeRole["session_name"].(string) != "" { - sessionName = assumeRole["session_name"].(string) - } - if sessionName == "" { - sessionName = "terraform" - } - policy = assumeRole["policy"].(string) - sessionExpiration = assumeRole["session_expiration"].(int) - if sessionExpiration == 0 { - if v := os.Getenv("ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION"); v != "" { - if expiredSeconds, err := strconv.Atoi(v); err == nil { - sessionExpiration = expiredSeconds - } - } - if sessionExpiration == 0 { - sessionExpiration = 3600 - } + roleArn = d.Get("assume_role_role_arn").(string) + sessionName = d.Get("assume_role_session_name").(string) + if sessionName == "" { + sessionName = "terraform" + } + policy = d.Get("assume_role_policy").(string) + sessionExpiration = d.Get("assume_role_session_expiration").(int) + if sessionExpiration == 0 { + if v := os.Getenv("ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION"); v != "" { + if expiredSeconds, err := strconv.Atoi(v); err == nil { + sessionExpiration = expiredSeconds } } + if sessionExpiration == 0 { + sessionExpiration = 3600 + } } if accessKey == "" { diff --git a/website/docs/language/settings/backends/oss.html.md b/website/docs/language/settings/backends/oss.html.md index 6acc16af1c82..515095ceb533 100644 --- a/website/docs/language/settings/backends/oss.html.md +++ b/website/docs/language/settings/backends/oss.html.md @@ -95,18 +95,11 @@ The following configuration options or environment variables are supported: to be applied to the state file. * `shared_credentials_file` - (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the `ALICLOUD_SHARED_CREDENTIALS_FILE` environment variable. If this is not set and a profile is specified, `~/.aliyun/config.json` will be used. * `profile` - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable. - * `assume_role` - (Optional, Available in 0.12.6+) If provided with a role ARN, will attempt to assume this role using the supplied credentials. - -The nested `assume_role` block supports the following: - -* `role_arn` - (Required) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports environment variable `ALICLOUD_ASSUME_ROLE_ARN`. +* `assume_role_role_arn` - (Optional, Available in 0.12.6+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports environment variable `ALICLOUD_ASSUME_ROLE_ARN`. Terraform executes configuration on account with provided credentials. - -* `policy` - (Optional) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary +* `assume_role_policy` - (Optional, Available in 0.12.6+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions which exceed those of the role that is being assumed. - -* `session_name` - (Optional) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. - -* `session_expiration` - (Optional) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud use own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. +* `assume_role_session_name` - (Optional, Available in 0.12.6+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. +* `assume_role_session_expiration` - (Optional, Available in 0.12.6+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud use own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. -> **Note:** If you want to store state in the custom OSS endpoint, you can specify a environment variable `OSS_ENDPOINT`, like "oss-cn-beijing-internal.aliyuncs.com" From 3f876d14d8fa3e85ff6c7155a5381d5983028c44 Mon Sep 17 00:00:00 2001 From: Li Kexian Date: Mon, 23 Aug 2021 09:46:35 +0800 Subject: [PATCH 012/644] fixed tencentcloud tag --- go.mod | 9 +++++---- go.sum | 18 ++++++++++++------ 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/go.mod b/go.mod index 889cea2d5b9e..89e274d7f7c3 100644 --- a/go.mod +++ b/go.mod @@ -56,7 +56,7 @@ require ( github.com/golang/mock v1.5.0 github.com/golang/protobuf v1.4.3 github.com/google/go-cmp v0.5.5 - github.com/google/go-querystring v1.0.0 // indirect + github.com/google/go-querystring v1.1.0 // indirect github.com/google/gofuzz v1.0.0 // indirect github.com/google/uuid v1.2.0 github.com/googleapis/gax-go/v2 v2.0.5 // indirect @@ -123,7 +123,7 @@ require ( github.com/mitchellh/reflectwalk v1.0.1 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.1 // indirect - github.com/mozillazg/go-httpheader v0.2.1 // indirect + github.com/mozillazg/go-httpheader v0.3.0 // indirect github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect github.com/oklog/run v1.0.0 // indirect github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db @@ -135,8 +135,9 @@ require ( github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a // indirect github.com/spf13/afero v1.2.2 github.com/spf13/pflag v1.0.3 // indirect - github.com/tencentcloud/tencentcloud-sdk-go v0.0.0-20190816164403-f8fa457a3c72 - github.com/tencentyun/cos-go-sdk-v5 v0.0.0-20190808065407-f07404cefc8c + github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.232 + github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag v1.0.233 + github.com/tencentyun/cos-go-sdk-v5 v0.7.29 github.com/tombuildsstuff/giovanni v0.15.1 github.com/ulikunitz/xz v0.5.8 // indirect github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect diff --git a/go.sum b/go.sum index a1c2fd9b4d2f..9b2e43bafe4c 100644 --- a/go.sum +++ b/go.sum @@ -273,8 +273,9 @@ github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk= github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck= +github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8= +github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU= github.com/google/gofuzz v0.0.0-20161122191042-44d81051d367/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI= github.com/google/gofuzz v0.0.0-20170612174753-24818f796faf/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI= github.com/google/gofuzz v1.0.0 h1:A8PeW59pxE9IoFRqBp37U+mSNaQoZ46F1f0f863XSXw= @@ -528,8 +529,9 @@ github.com/modern-go/reflect2 v0.0.0-20180320133207-05fbef0ca5da/go.mod h1:bx2lN github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/modern-go/reflect2 v1.0.1 h1:9f412s+6RmYXLWZSEzVVgPGK7C2PphHj5RJrvfx9AWI= github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= -github.com/mozillazg/go-httpheader v0.2.1 h1:geV7TrjbL8KXSyvghnFm+NyTux/hxwueTSrwhe88TQQ= github.com/mozillazg/go-httpheader v0.2.1/go.mod h1:jJ8xECTlalr6ValeXYdOF8fFUISeBAdw6E61aqQma60= +github.com/mozillazg/go-httpheader v0.3.0 h1:3brX5z8HTH+0RrNA1362Rc3HsaxyWEKtGY45YrhuINM= +github.com/mozillazg/go-httpheader v0.3.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK08bt6gKSReGMqtdA= github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw= @@ -609,10 +611,14 @@ github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81P github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/tencentcloud/tencentcloud-sdk-go v0.0.0-20190816164403-f8fa457a3c72 h1:mvzGHRiR9bQd5L9eS24nD6CmzSiHbQAQJx66UwMO9LQ= -github.com/tencentcloud/tencentcloud-sdk-go v0.0.0-20190816164403-f8fa457a3c72/go.mod h1:0PfYow01SHPMhKY31xa+EFz2RStxIqj6JFAJS+IkCi4= -github.com/tencentyun/cos-go-sdk-v5 v0.0.0-20190808065407-f07404cefc8c h1:iRD1CqtWUjgEVEmjwTMbP1DMzz1HRytOsgx/rlw/vNs= -github.com/tencentyun/cos-go-sdk-v5 v0.0.0-20190808065407-f07404cefc8c/go.mod h1:wk2XFUg6egk4tSDNZtXeKfe2G6690UVyt163PuUxBZk= +github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.194/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y= +github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.232 h1:kwsWbh4rEw42ZDe9/812ebhbwNZxlQyZ2sTmxBOKhN4= +github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.232/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y= +github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/kms v1.0.194/go.mod h1:yrBKWhChnDqNz1xuXdSbWXG56XawEq0G5j1lg4VwBD4= +github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag v1.0.233 h1:5Tbi+jyZ2MojC6GK8V6hchwtnkP2IuENUTqSisbYOlA= +github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag v1.0.233/go.mod h1:sX14+NSvMjOhNFaMtP2aDy6Bss8PyFXij21gpY6+DAs= +github.com/tencentyun/cos-go-sdk-v5 v0.7.29 h1:uwRBzc70Wgtc5iQQCowqecfRT0OpCXUOZzodZHOOEDs= +github.com/tencentyun/cos-go-sdk-v5 v0.7.29/go.mod h1:4E4+bQ2gBVJcgEC9Cufwylio4mXOct2iu05WjgEBx1o= github.com/tmc/grpc-websocket-proxy v0.0.0-20200427203606-3cfed13b9966 h1:j6JEOq5QWFker+d7mFQYOhjTZonQ7YkLTHm56dbn+yM= github.com/tmc/grpc-websocket-proxy v0.0.0-20200427203606-3cfed13b9966/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= github.com/tombuildsstuff/giovanni v0.15.1 h1:CVRaLOJ7C/eercCrKIsarfJ4SZoGMdBL9Q2deFDUXco= From 49b31d005a7e068bf67a03d14ec6cde69ee5ad15 Mon Sep 17 00:00:00 2001 From: Krzysztof Madej Date: Tue, 24 Aug 2021 02:05:43 +0200 Subject: [PATCH 013/644] Added required paramter `resource_group_name` for MSI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Without `resource_group_name` I had > │ Error: Either an Access Key / SAS Token or the Resource Group for the Storage Account must be specified - or Azure AD Authentication must be enabled --- website/docs/language/settings/backends/azurerm.html.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index d5796a348474..36e95a2f8162 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -35,6 +35,7 @@ When authenticating using Managed Service Identity (MSI): ```hcl terraform { backend "azurerm" { + resource_group_name = "StorageAccount-ResourceGroup" storage_account_name = "abcd1234" container_name = "tfstate" key = "prod.terraform.tfstate" @@ -125,6 +126,7 @@ When authenticating using Managed Service Identity (MSI): data "terraform_remote_state" "foo" { backend = "azurerm" config = { + resource_group_name = "StorageAccount-ResourceGroup" storage_account_name = "terraform123abc" container_name = "terraform-state" key = "prod.terraform.tfstate" @@ -215,6 +217,8 @@ The following configuration options are supported: When authenticating using the Managed Service Identity (MSI) - the following fields are also supported: +* `resource_group_name` - (Required) The Name of the Resource Group in which the Storage Account exists. + * `subscription_id` - (Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the `ARM_SUBSCRIPTION_ID` environment variable. * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. From 6562466c32a8750d7a71a6cc6232e6b5a28fe13a Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 27 Aug 2021 10:43:51 -0700 Subject: [PATCH 014/644] Be explicit that community PR review is currently paused --- .github/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 76f33c66de34..3080a1d3bea8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,6 +4,10 @@ This repository contains only Terraform core, which includes the command line in --- +**Note:** Due to current low staffing on the Terraform Core team at HashiCorp, **we are not routinely reviewing and merging community-submitted pull requests**. We do hope to begin processing them again soon once we're back up to full staffing again, but for the moment we need to ask for patience. Thanks! + +--- + **All communication on GitHub, the community forum, and other HashiCorp-provided communication channels is subject to [the HashiCorp community guidelines](https://www.hashicorp.com/community-guidelines).** This document provides guidance on Terraform contribution recommended practices. It covers what we're looking for in order to help set some expectations and help you get the most out of participation in this project. From b1d56076a4880455cbd90a3b4460eecb97f75316 Mon Sep 17 00:00:00 2001 From: Topher Ayrhart Date: Mon, 30 Aug 2021 08:59:50 -0500 Subject: [PATCH 015/644] generated -> generate MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In the last paragraph, the word "generated" is in the wrong tense for the sentence. The correct word is "generate" (unless I misunderstand the sentence 🙂). --- website/docs/language/expressions/for.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/expressions/for.html.md b/website/docs/language/expressions/for.html.md index ec17059d5572..b106c3f4be64 100644 --- a/website/docs/language/expressions/for.html.md +++ b/website/docs/language/expressions/for.html.md @@ -205,6 +205,6 @@ individual resource arguments that expect complex values. Some resource types also define _nested block types_, which typically represent separate objects that belong to the containing resource in some way. You can't -dynamically generated nested blocks using `for` expressions, but you _can_ +dynamically generate nested blocks using `for` expressions, but you _can_ generate nested blocks for a resource dynamically using [`dynamic` blocks](dynamic-blocks.html). From 7ca6be82854bae12b4bece168ac44dfb2d745e2d Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 30 Aug 2021 13:35:47 -0400 Subject: [PATCH 016/644] correctly verify planned nested object values The validation for nested object types with computed attributes was using the incorrect function call. --- internal/plans/objchange/plan_valid.go | 2 +- internal/plans/objchange/plan_valid_test.go | 213 ++++++++++++++++++++ 2 files changed, 214 insertions(+), 1 deletion(-) diff --git a/internal/plans/objchange/plan_valid.go b/internal/plans/objchange/plan_valid.go index 3555e02ed590..e26979e84b9b 100644 --- a/internal/plans/objchange/plan_valid.go +++ b/internal/plans/objchange/plan_valid.go @@ -424,7 +424,7 @@ func assertPlannedObjectValid(schema *configschema.Object, prior, config, planne if !prior.IsNull() && prior.HasIndex(idx).True() { priorEV = prior.Index(idx) } - moreErrs := assertPlannedObjectValid(schema, priorEV, configEV, plannedEV, path) + moreErrs := assertPlannedAttrsValid(schema.Attributes, priorEV, configEV, plannedEV, path) errs = append(errs, moreErrs...) } for it := config.ElementIterator(); it.Next(); { diff --git a/internal/plans/objchange/plan_valid_test.go b/internal/plans/objchange/plan_valid_test.go index a7166fe7b550..783e7e15fca8 100644 --- a/internal/plans/objchange/plan_valid_test.go +++ b/internal/plans/objchange/plan_valid_test.go @@ -1222,8 +1222,221 @@ func TestAssertPlanValid(t *testing.T) { }), []string{`.bloop: planned value cty.ListVal([]cty.Value{cty.ObjectVal(map[string]cty.Value{"blop":cty.StringVal("ok")})}) for a non-computed attribute`}, }, + "computed in nested objects": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + // When an object has dynamic attrs, the map may be + // handled as an object. + "map_as_obj": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + "list": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + "set": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSet, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + "single": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSingle, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.DynamicPseudoType, + Computed: true, + }, + }, + }, + }, + }, + }, + cty.NullVal(cty.Object(map[string]cty.Type{ + "map": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "map_as_obj": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.DynamicPseudoType, + })), + "list": cty.List(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "set": cty.Set(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "single": cty.Object(map[string]cty.Type{ + "name": cty.String, + }), + })), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "map_as_obj": cty.ObjectVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.DynamicPseudoType), + }), + }), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "single": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "map_as_obj": cty.ObjectVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("computed"), + }), + }), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "single": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + nil, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + errs := AssertPlanValid(test.Schema, test.Prior, test.Config, test.Planned) + + wantErrs := make(map[string]struct{}) + gotErrs := make(map[string]struct{}) + for _, err := range errs { + gotErrs[tfdiags.FormatError(err)] = struct{}{} + } + for _, msg := range test.WantErrs { + wantErrs[msg] = struct{}{} + } + + t.Logf( + "\nprior: %sconfig: %splanned: %s", + dump.Value(test.Planned), + dump.Value(test.Config), + dump.Value(test.Planned), + ) + for msg := range wantErrs { + if _, ok := gotErrs[msg]; !ok { + t.Errorf("missing expected error: %s", msg) + } + } + for msg := range gotErrs { + if _, ok := wantErrs[msg]; !ok { + t.Errorf("unexpected extra error: %s", msg) + } + } + }) } +} +func TestAssertPlanValidTEST(t *testing.T) { + tests := map[string]struct { + Schema *configschema.Block + Prior cty.Value + Config cty.Value + Planned cty.Value + WantErrs []string + }{ + "computed in map": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "items": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + Optional: true, + }, + }, + }, + Required: true, + }, + }, + }, + cty.NullVal(cty.Object(map[string]cty.Type{ + "items": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + })), + cty.ObjectVal(map[string]cty.Value{ + "items": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + //"name": cty.StringVal("computed"), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "items": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("computed"), + }), + }), + }), + nil, + }, + } for name, test := range tests { t.Run(name, func(t *testing.T) { errs := AssertPlanValid(test.Schema, test.Prior, test.Config, test.Planned) From 903797084a361680f4c00f4b9439e7b7454f220a Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 30 Aug 2021 13:53:49 -0400 Subject: [PATCH 017/644] objects vs maps in nested object types When using NestedMap objects, unify the codepath for both maps and objects as they may be interchangeable. --- internal/plans/objchange/plan_valid.go | 97 ++++++++------------- internal/plans/objchange/plan_valid_test.go | 2 +- 2 files changed, 37 insertions(+), 62 deletions(-) diff --git a/internal/plans/objchange/plan_valid.go b/internal/plans/objchange/plan_valid.go index e26979e84b9b..5bcfe8dd580d 100644 --- a/internal/plans/objchange/plan_valid.go +++ b/internal/plans/objchange/plan_valid.go @@ -368,71 +368,46 @@ func assertPlannedObjectValid(schema *configschema.Object, prior, config, planne case configschema.NestingMap: // A NestingMap might either be a map or an object, depending on - // whether there are dynamically-typed attributes inside, but - // that's decided statically and so all values will have the same - // kind. - if planned.Type().IsObjectType() { - plannedAtys := planned.Type().AttributeTypes() - configAtys := config.Type().AttributeTypes() - for k := range plannedAtys { - if _, ok := configAtys[k]; !ok { - errs = append(errs, path.NewErrorf("block key %q from plan is not present in config", k)) - continue - } - path := append(path, cty.GetAttrStep{Name: k}) + // whether there are dynamically-typed attributes inside, so we will + // break these down to maps to handle them both in the same manner. + plannedVals := map[string]cty.Value{} + configVals := map[string]cty.Value{} + priorVals := map[string]cty.Value{} + + if !planned.IsNull() { + plannedVals = planned.AsValueMap() + } + if !config.IsNull() { + configVals = config.AsValueMap() + } + if !prior.IsNull() { + priorVals = prior.AsValueMap() + } - plannedEV := planned.GetAttr(k) - if !plannedEV.IsKnown() { - errs = append(errs, path.NewErrorf("element representing nested block must not be unknown itself; set nested attribute values to unknown instead")) - continue - } - configEV := config.GetAttr(k) - priorEV := cty.NullVal(schema.ImpliedType()) - if !prior.IsNull() && prior.Type().HasAttribute(k) { - priorEV = prior.GetAttr(k) - } - moreErrs := assertPlannedAttrsValid(schema.Attributes, priorEV, configEV, plannedEV, path) - errs = append(errs, moreErrs...) - } - for k := range configAtys { - if _, ok := plannedAtys[k]; !ok { - errs = append(errs, path.NewErrorf("block key %q from config is not present in plan", k)) - continue - } + for k, plannedEV := range plannedVals { + configEV, ok := configVals[k] + if !ok { + errs = append(errs, path.NewErrorf("block key %q from plan is not present in config", k)) + continue } - } else { - plannedL := planned.LengthInt() - configL := config.LengthInt() - if plannedL != configL { - errs = append(errs, path.NewErrorf("block count in plan (%d) disagrees with count in config (%d)", plannedL, configL)) - return errs + path := append(path, cty.GetAttrStep{Name: k}) + + if !plannedEV.IsKnown() { + errs = append(errs, path.NewErrorf("element representing nested block must not be unknown itself; set nested attribute values to unknown instead")) + continue } - for it := planned.ElementIterator(); it.Next(); { - idx, plannedEV := it.Element() - path := append(path, cty.IndexStep{Key: idx}) - if !plannedEV.IsKnown() { - errs = append(errs, path.NewErrorf("element representing nested block must not be unknown itself; set nested attribute values to unknown instead")) - continue - } - k := idx.AsString() - if !config.HasIndex(idx).True() { - errs = append(errs, path.NewErrorf("block key %q from plan is not present in config", k)) - continue - } - configEV := config.Index(idx) - priorEV := cty.NullVal(schema.ImpliedType()) - if !prior.IsNull() && prior.HasIndex(idx).True() { - priorEV = prior.Index(idx) - } - moreErrs := assertPlannedAttrsValid(schema.Attributes, priorEV, configEV, plannedEV, path) - errs = append(errs, moreErrs...) + + priorEV, ok := priorVals[k] + if !ok { + priorEV = cty.NullVal(schema.ImpliedType()) } - for it := config.ElementIterator(); it.Next(); { - idx, _ := it.Element() - if !planned.HasIndex(idx).True() { - errs = append(errs, path.NewErrorf("block key %q from config is not present in plan", idx.AsString())) - continue - } + moreErrs := assertPlannedAttrsValid(schema.Attributes, priorEV, configEV, plannedEV, path) + errs = append(errs, moreErrs...) + } + for k := range configVals { + if _, ok := plannedVals[k]; !ok { + errs = append(errs, path.NewErrorf("block key %q from config is not present in plan", k)) + continue } } diff --git a/internal/plans/objchange/plan_valid_test.go b/internal/plans/objchange/plan_valid_test.go index 783e7e15fca8..28150002b8c7 100644 --- a/internal/plans/objchange/plan_valid_test.go +++ b/internal/plans/objchange/plan_valid_test.go @@ -1307,7 +1307,7 @@ func TestAssertPlanValid(t *testing.T) { "name": cty.NullVal(cty.String), }), }), - "map_as_obj": cty.ObjectVal(map[string]cty.Value{ + "map_as_obj": cty.MapVal(map[string]cty.Value{ "one": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.DynamicPseudoType), }), From ea68d79ea20b23e0bd3627f1e8609733093e4155 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 30 Aug 2021 14:12:47 -0400 Subject: [PATCH 018/644] nested object values can be computed While blocks were not allowed to be computed by the provider, nested objects can be. Remove the errors regarding blocks and verify unknown values are valid. --- internal/plans/objchange/plan_valid.go | 51 ++++------ internal/plans/objchange/plan_valid_test.go | 101 +++++++++++++++++++- 2 files changed, 119 insertions(+), 33 deletions(-) diff --git a/internal/plans/objchange/plan_valid.go b/internal/plans/objchange/plan_valid.go index 5bcfe8dd580d..2706a6c52e60 100644 --- a/internal/plans/objchange/plan_valid.go +++ b/internal/plans/objchange/plan_valid.go @@ -39,11 +39,11 @@ func AssertPlanValid(schema *configschema.Block, priorState, config, plannedStat func assertPlanValid(schema *configschema.Block, priorState, config, plannedState cty.Value, path cty.Path) []error { var errs []error if plannedState.IsNull() && !config.IsNull() { - errs = append(errs, path.NewErrorf("planned for absense but config wants existence")) + errs = append(errs, path.NewErrorf("planned for absence but config wants existence")) return errs } if config.IsNull() && !plannedState.IsNull() { - errs = append(errs, path.NewErrorf("planned for existence but config wants absense")) + errs = append(errs, path.NewErrorf("planned for existence but config wants absence")) return errs } if plannedState.IsNull() { @@ -286,6 +286,11 @@ func assertPlannedValueValid(attrS *configschema.Attribute, priorV, configV, pla } return errs } + } else { + if attrS.Computed { + errs = append(errs, path.NewErrorf("configuration present for computed attribute")) + return errs + } } // If this attribute has a NestedType, validate the nested object @@ -317,11 +322,11 @@ func assertPlannedObjectValid(schema *configschema.Object, prior, config, planne var errs []error if planned.IsNull() && !config.IsNull() { - errs = append(errs, path.NewErrorf("planned for absense but config wants existence")) + errs = append(errs, path.NewErrorf("planned for absence but config wants existence")) return errs } if config.IsNull() && !planned.IsNull() { - errs = append(errs, path.NewErrorf("planned for existence but config wants absense")) + errs = append(errs, path.NewErrorf("planned for existence but config wants absence")) return errs } if planned.IsNull() { @@ -349,10 +354,6 @@ func assertPlannedObjectValid(schema *configschema.Object, prior, config, planne for it := planned.ElementIterator(); it.Next(); { idx, plannedEV := it.Element() path := append(path, cty.IndexStep{Key: idx}) - if !plannedEV.IsKnown() { - errs = append(errs, path.NewErrorf("element representing nested block must not be unknown itself; set nested attribute values to unknown instead")) - continue - } if !config.HasIndex(idx).True() { continue // should never happen since we checked the lengths above } @@ -387,16 +388,11 @@ func assertPlannedObjectValid(schema *configschema.Object, prior, config, planne for k, plannedEV := range plannedVals { configEV, ok := configVals[k] if !ok { - errs = append(errs, path.NewErrorf("block key %q from plan is not present in config", k)) + errs = append(errs, path.NewErrorf("map key %q from plan is not present in config", k)) continue } path := append(path, cty.GetAttrStep{Name: k}) - if !plannedEV.IsKnown() { - errs = append(errs, path.NewErrorf("element representing nested block must not be unknown itself; set nested attribute values to unknown instead")) - continue - } - priorEV, ok := priorVals[k] if !ok { priorEV = cty.NullVal(schema.ImpliedType()) @@ -406,31 +402,22 @@ func assertPlannedObjectValid(schema *configschema.Object, prior, config, planne } for k := range configVals { if _, ok := plannedVals[k]; !ok { - errs = append(errs, path.NewErrorf("block key %q from config is not present in plan", k)) + errs = append(errs, path.NewErrorf("map key %q from config is not present in plan", k)) continue } } case configschema.NestingSet: + plannedL := planned.LengthInt() + configL := config.LengthInt() + if plannedL != configL { + errs = append(errs, path.NewErrorf("count in plan (%d) disagrees with count in config (%d)", plannedL, configL)) + return errs + } // Because set elements have no identifier with which to correlate - // them, we can't robustly validate the plan for a nested block + // them, we can't robustly validate the plan for a nested object // backed by a set, and so unfortunately we need to just trust the - // provider to do the right thing. :( - // - // (In principle we could correlate elements by matching the - // subset of attributes explicitly set in config, except for the - // special diff suppression rule which allows for there to be a - // planned value that is constructed by mixing part of a prior - // value with part of a config value, creating an entirely new - // element that is not present in either prior nor config.) - for it := planned.ElementIterator(); it.Next(); { - idx, plannedEV := it.Element() - path := append(path, cty.IndexStep{Key: idx}) - if !plannedEV.IsKnown() { - errs = append(errs, path.NewErrorf("element representing nested block must not be unknown itself; set nested attribute values to unknown instead")) - continue - } - } + // provider to do the right thing. } return errs diff --git a/internal/plans/objchange/plan_valid_test.go b/internal/plans/objchange/plan_valid_test.go index 28150002b8c7..dedb3958b010 100644 --- a/internal/plans/objchange/plan_valid_test.go +++ b/internal/plans/objchange/plan_valid_test.go @@ -1222,7 +1222,7 @@ func TestAssertPlanValid(t *testing.T) { }), []string{`.bloop: planned value cty.ListVal([]cty.Value{cty.ObjectVal(map[string]cty.Value{"blop":cty.StringVal("ok")})}) for a non-computed attribute`}, }, - "computed in nested objects": { + "computed within nested objects": { &configschema.Block{ Attributes: map[string]*configschema.Attribute{ "map": { @@ -1353,6 +1353,105 @@ func TestAssertPlanValid(t *testing.T) { }), nil, }, + "computed nested objects": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + }, + }, + }, + Computed: true, + }, + "list": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + }, + }, + }, + Computed: true, + }, + "set": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSet, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + }, + }, + }, + Computed: true, + }, + "single": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSingle, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.DynamicPseudoType, + }, + }, + }, + Computed: true, + }, + }, + }, + cty.NullVal(cty.Object(map[string]cty.Type{ + "map": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "list": cty.List(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "set": cty.Set(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "single": cty.Object(map[string]cty.Type{ + "name": cty.String, + }), + })), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.NullVal(cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.String, + }))), + "list": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "name": cty.String, + }))), + "set": cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{ + "name": cty.String, + }))), + "single": cty.NullVal(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.UnknownVal(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + }), + "list": cty.ListVal([]cty.Value{ + cty.UnknownVal(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + }), + "set": cty.SetVal([]cty.Value{ + cty.UnknownVal(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + }), + "single": cty.UnknownVal(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + }), + nil, + }, } for name, test := range tests { From 22b36d1f4c6c6695ca54af33cda2bc602d714db8 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 20 Aug 2021 16:08:12 -0700 Subject: [PATCH 019/644] Field for the previous address of each resource instance in the plan In order to expose the effect of any relevant "moved" statements we dealt with prior to creating the plan, we'll record with each ResourceInstanceChange both is current address and the address it was tracked at for the previous run. To save consumers of these objects from having to special-case the situation where there _was_ no previous run (e.g. because this is a Create change), we'll just pretend the previous run address was the same as the current address in that case, the same as for an update without any renaming in effect. This includes a breaking change to the plan file format, but one that doesn't require a version number increment because there is no ambiguity between the two formats and so mismatched parsers will already fail with an error message. As of this commit we've just added the new field but not yet populated it with any useful information: it always just matches Addr. A future commit will wire this up to the result of applying the moves so that we can populate it correctly. We also don't yet expose this new information anywhere in the UI layer. --- internal/plans/changes.go | 20 + internal/plans/changes_src.go | 20 + .../plans/internal/planproto/planfile.pb.go | 362 ++++++------------ .../plans/internal/planproto/planfile.proto | 44 +-- internal/plans/planfile/tfplan.go | 98 ++--- internal/plans/planfile/tfplan_test.go | 17 +- .../node_resource_abstract_instance.go | 24 +- 7 files changed, 241 insertions(+), 344 deletions(-) diff --git a/internal/plans/changes.go b/internal/plans/changes.go index bcab96ed6dbe..ba06244cb92c 100644 --- a/internal/plans/changes.go +++ b/internal/plans/changes.go @@ -147,6 +147,19 @@ type ResourceInstanceChange struct { // will apply to. Addr addrs.AbsResourceInstance + // PrevRunAddr is the absolute address that this resource instance had at + // the conclusion of a previous run. + // + // This will typically be the same as Addr, but can be different if the + // previous resource instance was subject to a "moved" block that we + // handled in the process of creating this plan. + // + // For the initial creation of a resource instance there isn't really any + // meaningful "previous run address", but PrevRunAddr will still be set + // equal to Addr in that case in order to simplify logic elsewhere which + // aims to detect and react to the movement of instances between addresses. + PrevRunAddr addrs.AbsResourceInstance + // DeposedKey is the identifier for a deposed object associated with the // given instance, or states.NotDeposed if this change applies to the // current object. @@ -203,8 +216,15 @@ func (rc *ResourceInstanceChange) Encode(ty cty.Type) (*ResourceInstanceChangeSr if err != nil { return nil, err } + prevRunAddr := rc.PrevRunAddr + if prevRunAddr.Resource.Resource.Type == "" { + // Suggests an old caller that hasn't been properly updated to + // populate this yet. + prevRunAddr = rc.Addr + } return &ResourceInstanceChangeSrc{ Addr: rc.Addr, + PrevRunAddr: prevRunAddr, DeposedKey: rc.DeposedKey, ProviderAddr: rc.ProviderAddr, ChangeSrc: *cs, diff --git a/internal/plans/changes_src.go b/internal/plans/changes_src.go index b254f176002a..69330a21d897 100644 --- a/internal/plans/changes_src.go +++ b/internal/plans/changes_src.go @@ -16,6 +16,19 @@ type ResourceInstanceChangeSrc struct { // will apply to. Addr addrs.AbsResourceInstance + // PrevRunAddr is the absolute address that this resource instance had at + // the conclusion of a previous run. + // + // This will typically be the same as Addr, but can be different if the + // previous resource instance was subject to a "moved" block that we + // handled in the process of creating this plan. + // + // For the initial creation of a resource instance there isn't really any + // meaningful "previous run address", but PrevRunAddr will still be set + // equal to Addr in that case in order to simplify logic elsewhere which + // aims to detect and react to the movement of instances between addresses. + PrevRunAddr addrs.AbsResourceInstance + // DeposedKey is the identifier for a deposed object associated with the // given instance, or states.NotDeposed if this change applies to the // current object. @@ -66,8 +79,15 @@ func (rcs *ResourceInstanceChangeSrc) Decode(ty cty.Type) (*ResourceInstanceChan if err != nil { return nil, err } + prevRunAddr := rcs.PrevRunAddr + if prevRunAddr.Resource.Resource.Type == "" { + // Suggests an old caller that hasn't been properly updated to + // populate this yet. + prevRunAddr = rcs.Addr + } return &ResourceInstanceChange{ Addr: rcs.Addr, + PrevRunAddr: prevRunAddr, DeposedKey: rcs.DeposedKey, ProviderAddr: rcs.ProviderAddr, Change: *change, diff --git a/internal/plans/internal/planproto/planfile.pb.go b/internal/plans/internal/planproto/planfile.pb.go index e5e6dc7aca48..9f541946c6d5 100644 --- a/internal/plans/internal/planproto/planfile.pb.go +++ b/internal/plans/internal/planproto/planfile.pb.go @@ -194,52 +194,6 @@ func (ResourceInstanceActionReason) EnumDescriptor() ([]byte, []int) { return file_planfile_proto_rawDescGZIP(), []int{2} } -type ResourceInstanceChange_ResourceMode int32 - -const ( - ResourceInstanceChange_managed ResourceInstanceChange_ResourceMode = 0 // for "resource" blocks in configuration - ResourceInstanceChange_data ResourceInstanceChange_ResourceMode = 1 // for "data" blocks in configuration -) - -// Enum value maps for ResourceInstanceChange_ResourceMode. -var ( - ResourceInstanceChange_ResourceMode_name = map[int32]string{ - 0: "managed", - 1: "data", - } - ResourceInstanceChange_ResourceMode_value = map[string]int32{ - "managed": 0, - "data": 1, - } -) - -func (x ResourceInstanceChange_ResourceMode) Enum() *ResourceInstanceChange_ResourceMode { - p := new(ResourceInstanceChange_ResourceMode) - *p = x - return p -} - -func (x ResourceInstanceChange_ResourceMode) String() string { - return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x)) -} - -func (ResourceInstanceChange_ResourceMode) Descriptor() protoreflect.EnumDescriptor { - return file_planfile_proto_enumTypes[3].Descriptor() -} - -func (ResourceInstanceChange_ResourceMode) Type() protoreflect.EnumType { - return &file_planfile_proto_enumTypes[3] -} - -func (x ResourceInstanceChange_ResourceMode) Number() protoreflect.EnumNumber { - return protoreflect.EnumNumber(x) -} - -// Deprecated: Use ResourceInstanceChange_ResourceMode.Descriptor instead. -func (ResourceInstanceChange_ResourceMode) EnumDescriptor() ([]byte, []int) { - return file_planfile_proto_rawDescGZIP(), []int{3, 0} -} - // Plan is the root message type for the tfplan file type Plan struct { state protoimpl.MessageState @@ -553,27 +507,16 @@ type ResourceInstanceChange struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - // module_path is an address to the module that defined this resource. - // module_path is omitted for resources in the root module. For descendent modules - // it is a string like module.foo.module.bar as would be seen at the beginning of a - // resource address. The format of this string is not yet frozen and so external - // callers should treat it as an opaque key for filtering purposes. - ModulePath string `protobuf:"bytes,1,opt,name=module_path,json=modulePath,proto3" json:"module_path,omitempty"` - // mode is the resource mode. - Mode ResourceInstanceChange_ResourceMode `protobuf:"varint,2,opt,name=mode,proto3,enum=tfplan.ResourceInstanceChange_ResourceMode" json:"mode,omitempty"` - // type is the resource type name, like "aws_instance". - Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"` - // name is the logical name of the resource as defined in configuration. - // For example, in aws_instance.foo this would be "foo". - Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` - // instance_key is either an integer index or a string key, depending on which iteration - // attributes ("count" or "for_each") are being used for this resource. If none - // are in use, this field is omitted. + // addr is a string representation of the resource instance address that + // this change will apply to. + Addr string `protobuf:"bytes,13,opt,name=addr,proto3" json:"addr,omitempty"` + // prev_run_addr is a string representation of the address at which + // this resource instance was tracked during the previous apply operation. // - // Types that are assignable to InstanceKey: - // *ResourceInstanceChange_Str - // *ResourceInstanceChange_Int - InstanceKey isResourceInstanceChange_InstanceKey `protobuf_oneof:"instance_key"` + // This is populated only if it would be different from addr due to + // Terraform having reacted to refactoring annotations in the configuration. + // If empty, the previous run address is the same as the current address. + PrevRunAddr string `protobuf:"bytes,14,opt,name=prev_run_addr,json=prevRunAddr,proto3" json:"prev_run_addr,omitempty"` // deposed_key, if set, indicates that this change applies to a deposed // object for the indicated instance with the given deposed key. If not // set, the change applies to the instance's current object. @@ -583,8 +526,7 @@ type ResourceInstanceChange struct { // apply it. Provider string `protobuf:"bytes,8,opt,name=provider,proto3" json:"provider,omitempty"` // Description of the proposed change. May use "create", "read", "update", - // "replace" and "delete" actions. "no-op" changes are not currently used here - // but consumers must accept and discard them to allow for future expansion. + // "replace", "delete" and "no-op" actions. Change *Change `protobuf:"bytes,9,opt,name=change,proto3" json:"change,omitempty"` // raw blob value provided by the provider as additional context for the // change. Must be considered an opaque value for any consumer other than @@ -633,55 +575,20 @@ func (*ResourceInstanceChange) Descriptor() ([]byte, []int) { return file_planfile_proto_rawDescGZIP(), []int{3} } -func (x *ResourceInstanceChange) GetModulePath() string { - if x != nil { - return x.ModulePath - } - return "" -} - -func (x *ResourceInstanceChange) GetMode() ResourceInstanceChange_ResourceMode { - if x != nil { - return x.Mode - } - return ResourceInstanceChange_managed -} - -func (x *ResourceInstanceChange) GetType() string { +func (x *ResourceInstanceChange) GetAddr() string { if x != nil { - return x.Type + return x.Addr } return "" } -func (x *ResourceInstanceChange) GetName() string { +func (x *ResourceInstanceChange) GetPrevRunAddr() string { if x != nil { - return x.Name + return x.PrevRunAddr } return "" } -func (m *ResourceInstanceChange) GetInstanceKey() isResourceInstanceChange_InstanceKey { - if m != nil { - return m.InstanceKey - } - return nil -} - -func (x *ResourceInstanceChange) GetStr() string { - if x, ok := x.GetInstanceKey().(*ResourceInstanceChange_Str); ok { - return x.Str - } - return "" -} - -func (x *ResourceInstanceChange) GetInt() int64 { - if x, ok := x.GetInstanceKey().(*ResourceInstanceChange_Int); ok { - return x.Int - } - return 0 -} - func (x *ResourceInstanceChange) GetDeposedKey() string { if x != nil { return x.DeposedKey @@ -724,22 +631,6 @@ func (x *ResourceInstanceChange) GetActionReason() ResourceInstanceActionReason return ResourceInstanceActionReason_NONE } -type isResourceInstanceChange_InstanceKey interface { - isResourceInstanceChange_InstanceKey() -} - -type ResourceInstanceChange_Str struct { - Str string `protobuf:"bytes,5,opt,name=str,proto3,oneof"` -} - -type ResourceInstanceChange_Int struct { - Int int64 `protobuf:"varint,6,opt,name=int,proto3,oneof"` -} - -func (*ResourceInstanceChange_Str) isResourceInstanceChange_InstanceKey() {} - -func (*ResourceInstanceChange_Int) isResourceInstanceChange_InstanceKey() {} - type OutputChange struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -1125,84 +1016,73 @@ var file_planfile_proto_rawDesc = []byte{ 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x13, 0x61, 0x66, 0x74, 0x65, 0x72, 0x53, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, - 0x68, 0x73, 0x22, 0x84, 0x04, 0x0a, 0x16, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, - 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x1f, 0x0a, - 0x0b, 0x6d, 0x6f, 0x64, 0x75, 0x6c, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x18, 0x01, 0x20, 0x01, - 0x28, 0x09, 0x52, 0x0a, 0x6d, 0x6f, 0x64, 0x75, 0x6c, 0x65, 0x50, 0x61, 0x74, 0x68, 0x12, 0x3f, - 0x0a, 0x04, 0x6d, 0x6f, 0x64, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x2b, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, - 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x73, - 0x6f, 0x75, 0x72, 0x63, 0x65, 0x4d, 0x6f, 0x64, 0x65, 0x52, 0x04, 0x6d, 0x6f, 0x64, 0x65, 0x12, - 0x12, 0x0a, 0x04, 0x74, 0x79, 0x70, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x74, - 0x79, 0x70, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x04, 0x20, 0x01, 0x28, - 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x12, 0x0a, 0x03, 0x73, 0x74, 0x72, 0x18, 0x05, - 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, 0x52, 0x03, 0x73, 0x74, 0x72, 0x12, 0x12, 0x0a, 0x03, 0x69, - 0x6e, 0x74, 0x18, 0x06, 0x20, 0x01, 0x28, 0x03, 0x48, 0x00, 0x52, 0x03, 0x69, 0x6e, 0x74, 0x12, - 0x1f, 0x0a, 0x0b, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x07, - 0x20, 0x01, 0x28, 0x09, 0x52, 0x0a, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x4b, 0x65, 0x79, - 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x08, 0x20, 0x01, - 0x28, 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x26, 0x0a, 0x06, - 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x09, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, + 0x68, 0x73, 0x22, 0xd3, 0x02, 0x0a, 0x16, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, + 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, + 0x04, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0d, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x61, 0x64, 0x64, + 0x72, 0x12, 0x22, 0x0a, 0x0d, 0x70, 0x72, 0x65, 0x76, 0x5f, 0x72, 0x75, 0x6e, 0x5f, 0x61, 0x64, + 0x64, 0x72, 0x18, 0x0e, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0b, 0x70, 0x72, 0x65, 0x76, 0x52, 0x75, + 0x6e, 0x41, 0x64, 0x64, 0x72, 0x12, 0x1f, 0x0a, 0x0b, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, + 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x07, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0a, 0x64, 0x65, 0x70, 0x6f, + 0x73, 0x65, 0x64, 0x4b, 0x65, 0x79, 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, + 0x65, 0x72, 0x18, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, + 0x65, 0x72, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x09, 0x20, 0x01, + 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, + 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, + 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x0a, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, + 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x10, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, + 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x18, 0x0b, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, + 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x12, 0x49, 0x0a, + 0x0d, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x72, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x18, 0x0c, + 0x20, 0x01, 0x28, 0x0e, 0x32, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, + 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, + 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x52, 0x0c, 0x61, 0x63, 0x74, 0x69, + 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x22, 0x68, 0x0a, 0x0c, 0x4f, 0x75, 0x74, 0x70, + 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, + 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, 0x06, + 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, - 0x61, 0x6e, 0x67, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, - 0x0a, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, - 0x0a, 0x10, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, - 0x63, 0x65, 0x18, 0x0b, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, - 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, - 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x12, 0x49, 0x0a, 0x0d, 0x61, 0x63, 0x74, 0x69, 0x6f, - 0x6e, 0x5f, 0x72, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x18, 0x0c, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x24, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, - 0x61, 0x73, 0x6f, 0x6e, 0x52, 0x0c, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, - 0x6f, 0x6e, 0x22, 0x25, 0x0a, 0x0c, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x4d, 0x6f, - 0x64, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x6d, 0x61, 0x6e, 0x61, 0x67, 0x65, 0x64, 0x10, 0x00, 0x12, - 0x08, 0x0a, 0x04, 0x64, 0x61, 0x74, 0x61, 0x10, 0x01, 0x42, 0x0e, 0x0a, 0x0c, 0x69, 0x6e, 0x73, - 0x74, 0x61, 0x6e, 0x63, 0x65, 0x5f, 0x6b, 0x65, 0x79, 0x22, 0x68, 0x0a, 0x0c, 0x4f, 0x75, 0x74, - 0x70, 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, - 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, - 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, - 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x1c, 0x0a, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, - 0x76, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x08, 0x52, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, - 0x69, 0x76, 0x65, 0x22, 0x28, 0x0a, 0x0c, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, - 0x6c, 0x75, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x18, 0x01, - 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x22, 0x1e, 0x0a, - 0x04, 0x48, 0x61, 0x73, 0x68, 0x12, 0x16, 0x0a, 0x06, 0x73, 0x68, 0x61, 0x32, 0x35, 0x36, 0x18, - 0x01, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x06, 0x73, 0x68, 0x61, 0x32, 0x35, 0x36, 0x22, 0xa5, 0x01, - 0x0a, 0x04, 0x50, 0x61, 0x74, 0x68, 0x12, 0x27, 0x0a, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x18, - 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, - 0x61, 0x74, 0x68, 0x2e, 0x53, 0x74, 0x65, 0x70, 0x52, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x1a, - 0x74, 0x0a, 0x04, 0x53, 0x74, 0x65, 0x70, 0x12, 0x27, 0x0a, 0x0e, 0x61, 0x74, 0x74, 0x72, 0x69, - 0x62, 0x75, 0x74, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x48, - 0x00, 0x52, 0x0d, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x4e, 0x61, 0x6d, 0x65, - 0x12, 0x37, 0x0a, 0x0b, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x5f, 0x6b, 0x65, 0x79, 0x18, - 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, - 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x48, 0x00, 0x52, 0x0a, 0x65, - 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x4b, 0x65, 0x79, 0x42, 0x0a, 0x0a, 0x08, 0x73, 0x65, 0x6c, - 0x65, 0x63, 0x74, 0x6f, 0x72, 0x2a, 0x31, 0x0a, 0x04, 0x4d, 0x6f, 0x64, 0x65, 0x12, 0x0a, 0x0a, - 0x06, 0x4e, 0x4f, 0x52, 0x4d, 0x41, 0x4c, 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x44, 0x45, 0x53, - 0x54, 0x52, 0x4f, 0x59, 0x10, 0x01, 0x12, 0x10, 0x0a, 0x0c, 0x52, 0x45, 0x46, 0x52, 0x45, 0x53, - 0x48, 0x5f, 0x4f, 0x4e, 0x4c, 0x59, 0x10, 0x02, 0x2a, 0x70, 0x0a, 0x06, 0x41, 0x63, 0x74, 0x69, - 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4f, 0x50, 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, - 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x01, 0x12, 0x08, 0x0a, 0x04, 0x52, 0x45, 0x41, 0x44, - 0x10, 0x02, 0x12, 0x0a, 0x0a, 0x06, 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x12, 0x0a, - 0x0a, 0x06, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x05, 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, - 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, - 0x10, 0x06, 0x12, 0x16, 0x0a, 0x12, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, - 0x4e, 0x5f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x07, 0x2a, 0x80, 0x01, 0x0a, 0x1c, 0x52, - 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, - 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, - 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, 0x1b, 0x0a, 0x17, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, - 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x54, 0x41, 0x49, 0x4e, 0x54, 0x45, 0x44, - 0x10, 0x01, 0x12, 0x16, 0x0a, 0x12, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, - 0x5f, 0x52, 0x45, 0x51, 0x55, 0x45, 0x53, 0x54, 0x10, 0x02, 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, - 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, - 0x4e, 0x4e, 0x4f, 0x54, 0x5f, 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x42, 0x42, 0x5a, - 0x40, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, - 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, - 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, - 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, - 0x6f, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x61, 0x6e, 0x67, 0x65, 0x12, 0x1c, 0x0a, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, + 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x08, 0x52, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, + 0x76, 0x65, 0x22, 0x28, 0x0a, 0x0c, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, + 0x75, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x0c, 0x52, 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x22, 0x1e, 0x0a, 0x04, + 0x48, 0x61, 0x73, 0x68, 0x12, 0x16, 0x0a, 0x06, 0x73, 0x68, 0x61, 0x32, 0x35, 0x36, 0x18, 0x01, + 0x20, 0x01, 0x28, 0x0c, 0x52, 0x06, 0x73, 0x68, 0x61, 0x32, 0x35, 0x36, 0x22, 0xa5, 0x01, 0x0a, + 0x04, 0x50, 0x61, 0x74, 0x68, 0x12, 0x27, 0x0a, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x18, 0x01, + 0x20, 0x03, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, + 0x74, 0x68, 0x2e, 0x53, 0x74, 0x65, 0x70, 0x52, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x1a, 0x74, + 0x0a, 0x04, 0x53, 0x74, 0x65, 0x70, 0x12, 0x27, 0x0a, 0x0e, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, + 0x75, 0x74, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, + 0x52, 0x0d, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, + 0x37, 0x0a, 0x0b, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x02, + 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, + 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x48, 0x00, 0x52, 0x0a, 0x65, 0x6c, + 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x4b, 0x65, 0x79, 0x42, 0x0a, 0x0a, 0x08, 0x73, 0x65, 0x6c, 0x65, + 0x63, 0x74, 0x6f, 0x72, 0x2a, 0x31, 0x0a, 0x04, 0x4d, 0x6f, 0x64, 0x65, 0x12, 0x0a, 0x0a, 0x06, + 0x4e, 0x4f, 0x52, 0x4d, 0x41, 0x4c, 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x44, 0x45, 0x53, 0x54, + 0x52, 0x4f, 0x59, 0x10, 0x01, 0x12, 0x10, 0x0a, 0x0c, 0x52, 0x45, 0x46, 0x52, 0x45, 0x53, 0x48, + 0x5f, 0x4f, 0x4e, 0x4c, 0x59, 0x10, 0x02, 0x2a, 0x70, 0x0a, 0x06, 0x41, 0x63, 0x74, 0x69, 0x6f, + 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4f, 0x50, 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, 0x43, + 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x01, 0x12, 0x08, 0x0a, 0x04, 0x52, 0x45, 0x41, 0x44, 0x10, + 0x02, 0x12, 0x0a, 0x0a, 0x06, 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x12, 0x0a, 0x0a, + 0x06, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x05, 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, 0x4c, + 0x45, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, + 0x06, 0x12, 0x16, 0x0a, 0x12, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, + 0x5f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x07, 0x2a, 0x80, 0x01, 0x0a, 0x1c, 0x52, 0x65, + 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, + 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, + 0x4e, 0x45, 0x10, 0x00, 0x12, 0x1b, 0x0a, 0x17, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, + 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x54, 0x41, 0x49, 0x4e, 0x54, 0x45, 0x44, 0x10, + 0x01, 0x12, 0x16, 0x0a, 0x12, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, 0x5f, + 0x52, 0x45, 0x51, 0x55, 0x45, 0x53, 0x54, 0x10, 0x02, 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, 0x50, + 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, 0x4e, + 0x4e, 0x4f, 0x54, 0x5f, 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x42, 0x42, 0x5a, 0x40, + 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, + 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, + 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, 0x6e, + 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, 0x6f, + 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( @@ -1217,51 +1097,49 @@ func file_planfile_proto_rawDescGZIP() []byte { return file_planfile_proto_rawDescData } -var file_planfile_proto_enumTypes = make([]protoimpl.EnumInfo, 4) +var file_planfile_proto_enumTypes = make([]protoimpl.EnumInfo, 3) var file_planfile_proto_msgTypes = make([]protoimpl.MessageInfo, 11) var file_planfile_proto_goTypes = []interface{}{ - (Mode)(0), // 0: tfplan.Mode - (Action)(0), // 1: tfplan.Action - (ResourceInstanceActionReason)(0), // 2: tfplan.ResourceInstanceActionReason - (ResourceInstanceChange_ResourceMode)(0), // 3: tfplan.ResourceInstanceChange.ResourceMode - (*Plan)(nil), // 4: tfplan.Plan - (*Backend)(nil), // 5: tfplan.Backend - (*Change)(nil), // 6: tfplan.Change - (*ResourceInstanceChange)(nil), // 7: tfplan.ResourceInstanceChange - (*OutputChange)(nil), // 8: tfplan.OutputChange - (*DynamicValue)(nil), // 9: tfplan.DynamicValue - (*Hash)(nil), // 10: tfplan.Hash - (*Path)(nil), // 11: tfplan.Path - nil, // 12: tfplan.Plan.VariablesEntry - nil, // 13: tfplan.Plan.ProviderHashesEntry - (*Path_Step)(nil), // 14: tfplan.Path.Step + (Mode)(0), // 0: tfplan.Mode + (Action)(0), // 1: tfplan.Action + (ResourceInstanceActionReason)(0), // 2: tfplan.ResourceInstanceActionReason + (*Plan)(nil), // 3: tfplan.Plan + (*Backend)(nil), // 4: tfplan.Backend + (*Change)(nil), // 5: tfplan.Change + (*ResourceInstanceChange)(nil), // 6: tfplan.ResourceInstanceChange + (*OutputChange)(nil), // 7: tfplan.OutputChange + (*DynamicValue)(nil), // 8: tfplan.DynamicValue + (*Hash)(nil), // 9: tfplan.Hash + (*Path)(nil), // 10: tfplan.Path + nil, // 11: tfplan.Plan.VariablesEntry + nil, // 12: tfplan.Plan.ProviderHashesEntry + (*Path_Step)(nil), // 13: tfplan.Path.Step } var file_planfile_proto_depIdxs = []int32{ 0, // 0: tfplan.Plan.ui_mode:type_name -> tfplan.Mode - 12, // 1: tfplan.Plan.variables:type_name -> tfplan.Plan.VariablesEntry - 7, // 2: tfplan.Plan.resource_changes:type_name -> tfplan.ResourceInstanceChange - 8, // 3: tfplan.Plan.output_changes:type_name -> tfplan.OutputChange - 13, // 4: tfplan.Plan.provider_hashes:type_name -> tfplan.Plan.ProviderHashesEntry - 5, // 5: tfplan.Plan.backend:type_name -> tfplan.Backend - 9, // 6: tfplan.Backend.config:type_name -> tfplan.DynamicValue + 11, // 1: tfplan.Plan.variables:type_name -> tfplan.Plan.VariablesEntry + 6, // 2: tfplan.Plan.resource_changes:type_name -> tfplan.ResourceInstanceChange + 7, // 3: tfplan.Plan.output_changes:type_name -> tfplan.OutputChange + 12, // 4: tfplan.Plan.provider_hashes:type_name -> tfplan.Plan.ProviderHashesEntry + 4, // 5: tfplan.Plan.backend:type_name -> tfplan.Backend + 8, // 6: tfplan.Backend.config:type_name -> tfplan.DynamicValue 1, // 7: tfplan.Change.action:type_name -> tfplan.Action - 9, // 8: tfplan.Change.values:type_name -> tfplan.DynamicValue - 11, // 9: tfplan.Change.before_sensitive_paths:type_name -> tfplan.Path - 11, // 10: tfplan.Change.after_sensitive_paths:type_name -> tfplan.Path - 3, // 11: tfplan.ResourceInstanceChange.mode:type_name -> tfplan.ResourceInstanceChange.ResourceMode - 6, // 12: tfplan.ResourceInstanceChange.change:type_name -> tfplan.Change - 11, // 13: tfplan.ResourceInstanceChange.required_replace:type_name -> tfplan.Path - 2, // 14: tfplan.ResourceInstanceChange.action_reason:type_name -> tfplan.ResourceInstanceActionReason - 6, // 15: tfplan.OutputChange.change:type_name -> tfplan.Change - 14, // 16: tfplan.Path.steps:type_name -> tfplan.Path.Step - 9, // 17: tfplan.Plan.VariablesEntry.value:type_name -> tfplan.DynamicValue - 10, // 18: tfplan.Plan.ProviderHashesEntry.value:type_name -> tfplan.Hash - 9, // 19: tfplan.Path.Step.element_key:type_name -> tfplan.DynamicValue - 20, // [20:20] is the sub-list for method output_type - 20, // [20:20] is the sub-list for method input_type - 20, // [20:20] is the sub-list for extension type_name - 20, // [20:20] is the sub-list for extension extendee - 0, // [0:20] is the sub-list for field type_name + 8, // 8: tfplan.Change.values:type_name -> tfplan.DynamicValue + 10, // 9: tfplan.Change.before_sensitive_paths:type_name -> tfplan.Path + 10, // 10: tfplan.Change.after_sensitive_paths:type_name -> tfplan.Path + 5, // 11: tfplan.ResourceInstanceChange.change:type_name -> tfplan.Change + 10, // 12: tfplan.ResourceInstanceChange.required_replace:type_name -> tfplan.Path + 2, // 13: tfplan.ResourceInstanceChange.action_reason:type_name -> tfplan.ResourceInstanceActionReason + 5, // 14: tfplan.OutputChange.change:type_name -> tfplan.Change + 13, // 15: tfplan.Path.steps:type_name -> tfplan.Path.Step + 8, // 16: tfplan.Plan.VariablesEntry.value:type_name -> tfplan.DynamicValue + 9, // 17: tfplan.Plan.ProviderHashesEntry.value:type_name -> tfplan.Hash + 8, // 18: tfplan.Path.Step.element_key:type_name -> tfplan.DynamicValue + 19, // [19:19] is the sub-list for method output_type + 19, // [19:19] is the sub-list for method input_type + 19, // [19:19] is the sub-list for extension type_name + 19, // [19:19] is the sub-list for extension extendee + 0, // [0:19] is the sub-list for field type_name } func init() { file_planfile_proto_init() } @@ -1379,10 +1257,6 @@ func file_planfile_proto_init() { } } } - file_planfile_proto_msgTypes[3].OneofWrappers = []interface{}{ - (*ResourceInstanceChange_Str)(nil), - (*ResourceInstanceChange_Int)(nil), - } file_planfile_proto_msgTypes[10].OneofWrappers = []interface{}{ (*Path_Step_AttributeName)(nil), (*Path_Step_ElementKey)(nil), @@ -1392,7 +1266,7 @@ func file_planfile_proto_init() { File: protoimpl.DescBuilder{ GoPackagePath: reflect.TypeOf(x{}).PkgPath(), RawDescriptor: file_planfile_proto_rawDesc, - NumEnums: 4, + NumEnums: 3, NumMessages: 11, NumExtensions: 0, NumServices: 0, diff --git a/internal/plans/internal/planproto/planfile.proto b/internal/plans/internal/planproto/planfile.proto index bd673e50da32..6ec4ae402441 100644 --- a/internal/plans/internal/planproto/planfile.proto +++ b/internal/plans/internal/planproto/planfile.proto @@ -129,34 +129,23 @@ enum ResourceInstanceActionReason { } message ResourceInstanceChange { - // module_path is an address to the module that defined this resource. - // module_path is omitted for resources in the root module. For descendent modules - // it is a string like module.foo.module.bar as would be seen at the beginning of a - // resource address. The format of this string is not yet frozen and so external - // callers should treat it as an opaque key for filtering purposes. - string module_path = 1; - - // mode is the resource mode. - ResourceMode mode = 2; - enum ResourceMode { - managed = 0; // for "resource" blocks in configuration - data = 1; // for "data" blocks in configuration - } - - // type is the resource type name, like "aws_instance". - string type = 3; + // addr is a string representation of the resource instance address that + // this change will apply to. + string addr = 13; - // name is the logical name of the resource as defined in configuration. - // For example, in aws_instance.foo this would be "foo". - string name = 4; + // prev_run_addr is a string representation of the address at which + // this resource instance was tracked during the previous apply operation. + // + // This is populated only if it would be different from addr due to + // Terraform having reacted to refactoring annotations in the configuration. + // If empty, the previous run address is the same as the current address. + string prev_run_addr = 14; - // instance_key is either an integer index or a string key, depending on which iteration - // attributes ("count" or "for_each") are being used for this resource. If none - // are in use, this field is omitted. - oneof instance_key { - string str = 5; - int64 int = 6; - }; + // NOTE: Earlier versions of this format had fields 1 through 6 describing + // various indivdual parts of "addr". We're now using our standard compact + // string representation to capture the same information. We don't support + // preserving plan files from one Terraform version to the next, so we + // no longer declare nor accept those fields. // deposed_key, if set, indicates that this change applies to a deposed // object for the indicated instance with the given deposed key. If not @@ -169,8 +158,7 @@ message ResourceInstanceChange { string provider = 8; // Description of the proposed change. May use "create", "read", "update", - // "replace" and "delete" actions. "no-op" changes are not currently used here - // but consumers must accept and discard them to allow for future expansion. + // "replace", "delete" and "no-op" actions. Change change = 9; // raw blob value provided by the provider as additional context for the diff --git a/internal/plans/planfile/tfplan.go b/internal/plans/planfile/tfplan.go index 735a33ae12c0..7572020b6c41 100644 --- a/internal/plans/planfile/tfplan.go +++ b/internal/plans/planfile/tfplan.go @@ -12,7 +12,6 @@ import ( "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/internal/planproto" "github.com/hashicorp/terraform/internal/states" - "github.com/hashicorp/terraform/internal/tfdiags" "github.com/hashicorp/terraform/version" "github.com/zclconf/go-cty/cty" ) @@ -157,12 +156,23 @@ func resourceChangeFromTfplan(rawChange *planproto.ResourceInstanceChange) (*pla ret := &plans.ResourceInstanceChangeSrc{} - moduleAddr := addrs.RootModuleInstance - if rawChange.ModulePath != "" { - var diags tfdiags.Diagnostics - moduleAddr, diags = addrs.ParseModuleInstanceStr(rawChange.ModulePath) + if rawChange.Addr == "" { + // If "Addr" isn't populated then seems likely that this is a plan + // file created by an earlier version of Terraform, which had the + // same information spread over various other fields: + // ModulePath, Mode, Name, Type, and InstanceKey. + return nil, fmt.Errorf("no instance address for resource instance change; perhaps this plan was created by a different version of Terraform?") + } + + instAddr, diags := addrs.ParseAbsResourceInstanceStr(rawChange.Addr) + if diags.HasErrors() { + return nil, fmt.Errorf("invalid resource instance address %q: %w", rawChange.Addr, diags.Err()) + } + prevRunAddr := instAddr + if rawChange.PrevRunAddr != "" { + prevRunAddr, diags = addrs.ParseAbsResourceInstanceStr(rawChange.PrevRunAddr) if diags.HasErrors() { - return nil, diags.Err() + return nil, fmt.Errorf("invalid resource instance previous run address %q: %w", rawChange.PrevRunAddr, diags.Err()) } } @@ -172,37 +182,8 @@ func resourceChangeFromTfplan(rawChange *planproto.ResourceInstanceChange) (*pla } ret.ProviderAddr = providerAddr - var mode addrs.ResourceMode - switch rawChange.Mode { - case planproto.ResourceInstanceChange_managed: - mode = addrs.ManagedResourceMode - case planproto.ResourceInstanceChange_data: - mode = addrs.DataResourceMode - default: - return nil, fmt.Errorf("resource has invalid mode %s", rawChange.Mode) - } - - typeName := rawChange.Type - name := rawChange.Name - - resAddr := addrs.Resource{ - Mode: mode, - Type: typeName, - Name: name, - } - - var instKey addrs.InstanceKey - switch rawTk := rawChange.InstanceKey.(type) { - case nil: - case *planproto.ResourceInstanceChange_Int: - instKey = addrs.IntKey(rawTk.Int) - case *planproto.ResourceInstanceChange_Str: - instKey = addrs.StringKey(rawTk.Str) - default: - return nil, fmt.Errorf("instance of %s has invalid key type %T", resAddr.Absolute(moduleAddr), rawChange.InstanceKey) - } - - ret.Addr = resAddr.Instance(instKey).Absolute(moduleAddr) + ret.Addr = instAddr + ret.PrevRunAddr = prevRunAddr if rawChange.DeposedKey != "" { if len(rawChange.DeposedKey) != 8 { @@ -454,35 +435,20 @@ func writeTfplan(plan *plans.Plan, w io.Writer) error { func resourceChangeToTfplan(change *plans.ResourceInstanceChangeSrc) (*planproto.ResourceInstanceChange, error) { ret := &planproto.ResourceInstanceChange{} - ret.ModulePath = change.Addr.Module.String() - - relAddr := change.Addr.Resource - - switch relAddr.Resource.Mode { - case addrs.ManagedResourceMode: - ret.Mode = planproto.ResourceInstanceChange_managed - case addrs.DataResourceMode: - ret.Mode = planproto.ResourceInstanceChange_data - default: - return nil, fmt.Errorf("resource %s has unsupported mode %s", relAddr, relAddr.Resource.Mode) + if change.PrevRunAddr.Resource.Resource.Type == "" { + // Suggests that an old caller wasn't yet updated to populate this + // properly. All code that generates plans should populate this field, + // even if it's just to write in the same value as in change.Addr. + change.PrevRunAddr = change.Addr } - ret.Type = relAddr.Resource.Type - ret.Name = relAddr.Resource.Name - - switch tk := relAddr.Key.(type) { - case nil: - // Nothing to do, then. - case addrs.IntKey: - ret.InstanceKey = &planproto.ResourceInstanceChange_Int{ - Int: int64(tk), - } - case addrs.StringKey: - ret.InstanceKey = &planproto.ResourceInstanceChange_Str{ - Str: string(tk), - } - default: - return nil, fmt.Errorf("resource %s has unsupported instance key type %T", relAddr, relAddr.Key) + ret.Addr = change.Addr.String() + ret.PrevRunAddr = change.PrevRunAddr.String() + if ret.PrevRunAddr == ret.Addr { + // In the on-disk format we leave PrevRunAddr unpopulated in the common + // case where it's the same as Addr, and then fill it back in again on + // read. + ret.PrevRunAddr = "" } ret.DeposedKey = string(change.DeposedKey) @@ -500,7 +466,7 @@ func resourceChangeToTfplan(change *plans.ResourceInstanceChangeSrc) (*planproto valChange, err := changeToTfplan(&change.ChangeSrc) if err != nil { - return nil, fmt.Errorf("failed to serialize resource %s change: %s", relAddr, err) + return nil, fmt.Errorf("failed to serialize resource %s change: %s", change.Addr, err) } ret.Change = valChange @@ -514,7 +480,7 @@ func resourceChangeToTfplan(change *plans.ResourceInstanceChangeSrc) (*planproto case plans.ResourceInstanceReplaceByRequest: ret.ActionReason = planproto.ResourceInstanceActionReason_REPLACE_BY_REQUEST default: - return nil, fmt.Errorf("resource %s has unsupported action reason %s", relAddr, change.ActionReason) + return nil, fmt.Errorf("resource %s has unsupported action reason %s", change.Addr, change.ActionReason) } if len(change.Private) > 0 { diff --git a/internal/plans/planfile/tfplan_test.go b/internal/plans/planfile/tfplan_test.go index cc90874f0729..b6c69657e4d3 100644 --- a/internal/plans/planfile/tfplan_test.go +++ b/internal/plans/planfile/tfplan_test.go @@ -57,6 +57,11 @@ func TestTFPlanRoundTrip(t *testing.T) { Type: "test_thing", Name: "woot", }.Instance(addrs.IntKey(0)).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), ProviderAddr: addrs.AbsProviderConfig{ Provider: addrs.NewDefaultProvider("test"), Module: addrs.RootModule, @@ -93,7 +98,12 @@ func TestTFPlanRoundTrip(t *testing.T) { Mode: addrs.ManagedResourceMode, Type: "test_thing", Name: "woot", - }.Instance(addrs.IntKey(0)).Absolute(addrs.RootModuleInstance), + }.Instance(addrs.IntKey(1)).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.IntKey(1)).Absolute(addrs.RootModuleInstance), DeposedKey: "foodface", ProviderAddr: addrs.AbsProviderConfig{ Provider: addrs.NewDefaultProvider("test"), @@ -214,6 +224,11 @@ func TestTFPlanRoundTripDestroy(t *testing.T) { Type: "test_thing", Name: "woot", }.Instance(addrs.IntKey(0)).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.IntKey(0)).Absolute(addrs.RootModuleInstance), ProviderAddr: addrs.AbsProviderConfig{ Provider: addrs.NewDefaultProvider("test"), Module: addrs.RootModule, diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index d2279f88f3c7..7735897ce46a 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -392,8 +392,9 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState // that we checked something and concluded no changes were needed // vs. that something being entirely excluded e.g. due to -target. noop := &plans.ResourceInstanceChange{ - Addr: absAddr, - DeposedKey: deposedKey, + Addr: absAddr, + PrevRunAddr: absAddr, // TODO-PrevRunAddr: If this instance was moved/renamed in this run, record its old address + DeposedKey: deposedKey, Change: plans.Change{ Action: plans.NoOp, Before: cty.NullVal(cty.DynamicPseudoType), @@ -419,8 +420,9 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState // Plan is always the same for a destroy. We don't need the provider's // help for this one. plan := &plans.ResourceInstanceChange{ - Addr: absAddr, - DeposedKey: deposedKey, + Addr: absAddr, + PrevRunAddr: absAddr, // TODO-PrevRunAddr: If this instance was moved/renamed in this run, record its old address + DeposedKey: deposedKey, Change: plans.Change{ Action: plans.Delete, Before: currentState.Value, @@ -444,7 +446,7 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState return plan, diags } -// writeChange saves a planned change for an instance object into the set of +// writeChange saves a planned change for an instance object into the set of // global planned changes. func (n *NodeAbstractResourceInstance) writeChange(ctx EvalContext, change *plans.ResourceInstanceChange, deposedKey states.DeposedKey) error { changes := ctx.Changes() @@ -469,6 +471,16 @@ func (n *NodeAbstractResourceInstance) writeChange(ctx EvalContext, change *plan // Should never happen, and indicates a bug in the caller. panic("inconsistent address and/or deposed key in writeChange") } + if change.PrevRunAddr.Resource.Resource.Type == "" { + // Should never happen, and indicates a bug in the caller. + // (The change.Encode function actually has its own fixup to just + // quietly make this match change.Addr in the incorrect case, but we + // intentionally panic here in order to catch incorrect callers where + // the stack trace will hopefully be actually useful. The tolerance + // at the next layer down is mainly to accommodate sloppy input in + // older tests.) + panic("unpopulated ResourceInstanceChange.PrevRunAddr in writeChange") + } ri := n.Addr.Resource schema, _ := providerSchema.SchemaForResourceAddr(ri.Resource) @@ -1054,6 +1066,7 @@ func (n *NodeAbstractResourceInstance) plan( // Update our return plan plan = &plans.ResourceInstanceChange{ Addr: n.Addr, + PrevRunAddr: n.Addr, // TODO-PrevRunAddr: If this instance was moved/renamed in this run, record its old address Private: plannedPrivate, ProviderAddr: n.ResolvedProvider, Change: plans.Change{ @@ -1515,6 +1528,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt // value containing unknowns from PlanDataResourceObject. plannedChange := &plans.ResourceInstanceChange{ Addr: n.Addr, + PrevRunAddr: n.Addr, // data resources are not refactorable ProviderAddr: n.ResolvedProvider, Change: plans.Change{ Action: plans.Read, From 4faac6ee43872d9f7c413a176152f1b76a77eec6 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 23 Aug 2021 17:43:41 -0700 Subject: [PATCH 020/644] core: Record move result information in the plan Here we wire through the "move results" into the graph walk data structures so that all of the the nodes which produce plans.ResourceInstanceChange values can capture the "PrevRunAddr" for each resource instance. This doesn't actually quite work yet, because the logic in Context.Plan isn't actually correct and so the updated state from refactoring.ApplyMoves isn't actually visible as the "previous run state". For that reason, the context test in this commit is currently skipped, with the intent of re-enabling it once the updated state is properly propagating into the plan graph walk and thus we can actually react to the result of the move while choosing actions for those addresses. --- internal/refactoring/move_execute.go | 12 +++ internal/terraform/context.go | 55 ++++++++++---- internal/terraform/context_import.go | 2 +- internal/terraform/context_plan2_test.go | 74 +++++++++++++++++++ internal/terraform/context_validate_test.go | 2 +- internal/terraform/eval_context.go | 11 +++ internal/terraform/eval_context_builtin.go | 6 ++ internal/terraform/eval_context_mock.go | 9 +++ internal/terraform/graph_walk_context.go | 13 ++-- .../node_resource_abstract_instance.go | 25 ++++++- 10 files changed, 185 insertions(+), 24 deletions(-) diff --git a/internal/refactoring/move_execute.go b/internal/refactoring/move_execute.go index 800810981db7..178a336af0b7 100644 --- a/internal/refactoring/move_execute.go +++ b/internal/refactoring/move_execute.go @@ -2,9 +2,11 @@ package refactoring import ( "fmt" + "log" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/dag" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/states" ) @@ -53,6 +55,13 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] } } + if startNodes.Len() == 0 { + log.Println("[TRACE] refactoring.ApplyMoves: No 'moved' statements to consider in this configuration") + return results + } + + log.Printf("[TRACE] refactoring.ApplyMoves: Processing 'moved' statements in the configuration\n%s", logging.Indent(g.String())) + g.ReverseDepthFirstWalk(startNodes, func(v dag.Vertex, depth int) error { stmt := v.(*MoveStatement) @@ -69,6 +78,7 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] // For a module endpoint we just try the module address // directly. if newAddr, matches := modAddr.MoveDestination(stmt.From, stmt.To); matches { + log.Printf("[TRACE] refactoring.ApplyMoves: %s has moved to %s", modAddr, newAddr) // We need to visit all of the resource instances in the // module and record them individually as results. for _, rs := range ms.Resources { @@ -94,6 +104,7 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] for _, rs := range ms.Resources { rAddr := rs.Addr if newAddr, matches := rAddr.MoveDestination(stmt.From, stmt.To); matches { + log.Printf("[TRACE] refactoring.ApplyMoves: resource %s has moved to %s", rAddr, newAddr) for key := range rs.Instances { oldInst := rAddr.Instance(key) newInst := newAddr.Instance(key) @@ -110,6 +121,7 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] for key := range rs.Instances { iAddr := rAddr.Instance(key) if newAddr, matches := iAddr.MoveDestination(stmt.From, stmt.To); matches { + log.Printf("[TRACE] refactoring.ApplyMoves: resource instance %s has moved to %s", iAddr, newAddr) result := MoveResult{From: iAddr, To: newAddr} results[iAddr.UniqueKey()] = result results[newAddr.UniqueKey()] = result diff --git a/internal/terraform/context.go b/internal/terraform/context.go index 0a092c33b01c..4e96fd25e750 100644 --- a/internal/terraform/context.go +++ b/internal/terraform/context.go @@ -129,6 +129,20 @@ type Context struct { refreshState *states.State prevRunState *states.State + // NOTE: If you're considering adding something new here, consider first + // whether it'd work to add it to type graphWalkOpts instead, possibly by + // adding new arguments to one of the exported operation methods, to scope + // it only to a particular operation rather than having it survive from one + // operation to the next as global mutable state. + // + // Historically we used fields here as a bit of a dumping ground for + // data that needed to ambiently pass between methods of Context, but + // that has tended to cause surprising misbehavior when data from one + // walk inadvertently bleeds into another walk against the same context. + // Perhaps one day we'll move changes, state, refreshState, and prevRunState + // to graphWalkOpts too. Ideally there shouldn't be anything in here which + // changes after NewContext returns. + hooks []Hook components contextComponentFactory schemas *Schemas @@ -491,7 +505,7 @@ func (c *Context) Eval(path addrs.ModuleInstance) (*lang.Scope, tfdiags.Diagnost diags = diags.Append(graphDiags) if !diags.HasErrors() { var walkDiags tfdiags.Diagnostics - walker, walkDiags = c.walk(graph, walkEval) + walker, walkDiags = c.walk(graph, walkEval, &graphWalkOpts{}) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) } @@ -500,7 +514,7 @@ func (c *Context) Eval(path addrs.ModuleInstance) (*lang.Scope, tfdiags.Diagnost // If we skipped walking the graph (due to errors) then we'll just // use a placeholder graph walker here, which'll refer to the // unmodified state. - walker = c.graphWalker(walkEval) + walker = c.graphWalker(walkEval, &graphWalkOpts{}) } // This is a bit weird since we don't normally evaluate outside of @@ -545,7 +559,7 @@ func (c *Context) Apply() (*states.State, tfdiags.Diagnostics) { } // Walk the graph - walker, walkDiags := c.walk(graph, operation) + walker, walkDiags := c.walk(graph, operation, &graphWalkOpts{}) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) @@ -656,7 +670,7 @@ The -target option is not for routine use, and is provided only for exceptional func (c *Context) plan() (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics - moveStmts, _ := c.prePlanFindAndApplyMoves() + moveStmts, moveResults := c.prePlanFindAndApplyMoves() graph, graphDiags := c.Graph(GraphTypePlan, nil) diags = diags.Append(graphDiags) @@ -665,7 +679,9 @@ func (c *Context) plan() (*plans.Plan, tfdiags.Diagnostics) { } // Do the walk - walker, walkDiags := c.walk(graph, walkPlan) + walker, walkDiags := c.walk(graph, walkPlan, &graphWalkOpts{ + MoveResults: moveResults, + }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { @@ -700,7 +716,7 @@ func (c *Context) destroyPlan() (*plans.Plan, tfdiags.Diagnostics) { } c.changes = plans.NewChanges() - moveStmts, _ := c.prePlanFindAndApplyMoves() + moveStmts, moveResults := c.prePlanFindAndApplyMoves() // A destroy plan starts by running Refresh to read any pending data // sources, and remove missing managed resources. This is required because @@ -734,7 +750,9 @@ func (c *Context) destroyPlan() (*plans.Plan, tfdiags.Diagnostics) { } // Do the walk - walker, walkDiags := c.walk(graph, walkPlanDestroy) + walker, walkDiags := c.walk(graph, walkPlanDestroy, &graphWalkOpts{ + MoveResults: moveResults, + }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { @@ -764,7 +782,7 @@ func (c *Context) destroyPlan() (*plans.Plan, tfdiags.Diagnostics) { func (c *Context) refreshOnlyPlan() (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics - moveStmts, _ := c.prePlanFindAndApplyMoves() + moveStmts, moveResults := c.prePlanFindAndApplyMoves() graph, graphDiags := c.Graph(GraphTypePlanRefreshOnly, nil) diags = diags.Append(graphDiags) @@ -773,7 +791,9 @@ func (c *Context) refreshOnlyPlan() (*plans.Plan, tfdiags.Diagnostics) { } // Do the walk - walker, walkDiags := c.walk(graph, walkPlan) + walker, walkDiags := c.walk(graph, walkPlan, &graphWalkOpts{ + MoveResults: moveResults, + }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { @@ -918,7 +938,7 @@ func (c *Context) Validate() tfdiags.Diagnostics { } // Walk - walker, walkDiags := c.walk(graph, walkValidate) + walker, walkDiags := c.walk(graph, walkValidate, &graphWalkOpts{}) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { @@ -991,10 +1011,18 @@ func (c *Context) releaseRun() { c.runContext = nil } -func (c *Context) walk(graph *Graph, operation walkOperation) (*ContextGraphWalker, tfdiags.Diagnostics) { +// graphWalkOpts is an assortment of options and inputs we need when +// constructing a graph walker. +type graphWalkOpts struct { + // MoveResults is a table of the results of applying move statements prior + // to a plan walk. Irrelevant and totally ignored for non-plan walks. + MoveResults map[addrs.UniqueKey]refactoring.MoveResult +} + +func (c *Context) walk(graph *Graph, operation walkOperation, opts *graphWalkOpts) (*ContextGraphWalker, tfdiags.Diagnostics) { log.Printf("[DEBUG] Starting graph walk: %s", operation.String()) - walker := c.graphWalker(operation) + walker := c.graphWalker(operation, opts) // Watch for a stop so we can call the provider Stop() API. watchStop, watchWait := c.watchStop(walker) @@ -1009,7 +1037,7 @@ func (c *Context) walk(graph *Graph, operation walkOperation) (*ContextGraphWalk return walker, diags } -func (c *Context) graphWalker(operation walkOperation) *ContextGraphWalker { +func (c *Context) graphWalker(operation walkOperation, opts *graphWalkOpts) *ContextGraphWalker { var state *states.SyncState var refreshState *states.SyncState var prevRunState *states.SyncState @@ -1040,6 +1068,7 @@ func (c *Context) graphWalker(operation walkOperation) *ContextGraphWalker { PrevRunState: prevRunState, Changes: c.changes.SyncWrapper(), InstanceExpander: instances.NewExpander(), + MoveResults: opts.MoveResults, Operation: operation, StopContext: c.runContext, RootVariableValues: c.variables, diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index 32ac6e0d36b1..ccee059d7799 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -60,7 +60,7 @@ func (c *Context) Import(opts *ImportOpts) (*states.State, tfdiags.Diagnostics) } // Walk it - _, walkDiags := c.walk(graph, walkImport) + _, walkDiags := c.walk(graph, walkImport, &graphWalkOpts{}) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { return c.state, diags diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 048495cad645..a5242ad89967 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -730,6 +730,80 @@ provider "test" { } } +func TestContext2Plan_movedResourceBasic(t *testing.T) { + t.Skip("Context.Plan doesn't properly propagate moves into the prior state yet") + + addrA := mustResourceInstanceAddr("test_object.a") + addrB := mustResourceInstanceAddr("test_object.b") + m := testModuleInline(t, map[string]string{ + "main.tf": ` + resource "test_object" "b" { + } + + moved { + from = test_object.a + to = test_object.b + } + + terraform { + experiments = [config_driven_move] + } + `, + }) + + state := states.BuildState(func(s *states.SyncState) { + // The prior state tracks test_object.a, which we should treat as + // test_object.b because of the "moved" block in the config. + s.SetResourceInstanceCurrent(addrA, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + + p := simpleMockProvider() + ctx := testContext2(t, &ContextOpts{ + Config: m, + State: state, + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + ForceReplace: []addrs.AbsResourceInstance{ + addrA, + }, + }) + + plan, diags := ctx.Plan() + if diags.HasErrors() { + t.Fatalf("unexpected errors\n%s", diags.Err().Error()) + } + + t.Run(addrA.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrA) + if instPlan != nil { + t.Fatalf("unexpected plan for %s; should've moved to %s", addrA, addrB) + } + }) + t.Run(addrB.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrB) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrB) + } + + if got, want := instPlan.Addr, addrB; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrA; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.NoOp; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) +} + func TestContext2Plan_refreshOnlyMode(t *testing.T) { addr := mustResourceInstanceAddr("test_object.a") diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index cae189482c38..be3acb7c501a 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -1305,7 +1305,7 @@ func TestContext2Validate_PlanGraphBuilder(t *testing.T) { t.Fatalf("errors from PlanGraphBuilder: %s", diags.Err()) } defer c.acquireRun("validate-test")() - walker, diags := c.walk(graph, walkValidate) + walker, diags := c.walk(graph, walkValidate, &graphWalkOpts{}) if diags.HasErrors() { t.Fatal(diags.Err()) } diff --git a/internal/terraform/eval_context.go b/internal/terraform/eval_context.go index 0a711f87323c..2cee1b0711d9 100644 --- a/internal/terraform/eval_context.go +++ b/internal/terraform/eval_context.go @@ -9,6 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" + "github.com/hashicorp/terraform/internal/refactoring" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" @@ -165,6 +166,16 @@ type EvalContext interface { // EvalContext objects for a given configuration. InstanceExpander() *instances.Expander + // MoveResults returns a map describing the results of handling any + // resource instance move statements prior to the graph walk, so that + // the graph walk can then record that information appropriately in other + // artifacts produced by the graph walk. + // + // This data structure is created prior to the graph walk and read-only + // thereafter, so callers must not modify the returned map or any other + // objects accessible through it. + MoveResults() map[addrs.UniqueKey]refactoring.MoveResult + // WithPath returns a copy of the context with the internal path set to the // path argument. WithPath(path addrs.ModuleInstance) EvalContext diff --git a/internal/terraform/eval_context_builtin.go b/internal/terraform/eval_context_builtin.go index 4e956b8dee9e..1b971fd6b19c 100644 --- a/internal/terraform/eval_context_builtin.go +++ b/internal/terraform/eval_context_builtin.go @@ -10,6 +10,7 @@ import ( "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" + "github.com/hashicorp/terraform/internal/refactoring" "github.com/hashicorp/terraform/version" "github.com/hashicorp/terraform/internal/states" @@ -74,6 +75,7 @@ type BuiltinEvalContext struct { RefreshStateValue *states.SyncState PrevRunStateValue *states.SyncState InstanceExpanderValue *instances.Expander + MoveResultsValue map[addrs.UniqueKey]refactoring.MoveResult } // BuiltinEvalContext implements EvalContext @@ -367,3 +369,7 @@ func (ctx *BuiltinEvalContext) PrevRunState() *states.SyncState { func (ctx *BuiltinEvalContext) InstanceExpander() *instances.Expander { return ctx.InstanceExpanderValue } + +func (ctx *BuiltinEvalContext) MoveResults() map[addrs.UniqueKey]refactoring.MoveResult { + return ctx.MoveResultsValue +} diff --git a/internal/terraform/eval_context_mock.go b/internal/terraform/eval_context_mock.go index 7d2e64c6ac12..0e4fd32d6903 100644 --- a/internal/terraform/eval_context_mock.go +++ b/internal/terraform/eval_context_mock.go @@ -10,6 +10,7 @@ import ( "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" + "github.com/hashicorp/terraform/internal/refactoring" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" @@ -128,6 +129,9 @@ type MockEvalContext struct { PrevRunStateCalled bool PrevRunStateState *states.SyncState + MoveResultsCalled bool + MoveResultsResults map[addrs.UniqueKey]refactoring.MoveResult + InstanceExpanderCalled bool InstanceExpanderExpander *instances.Expander } @@ -347,6 +351,11 @@ func (c *MockEvalContext) PrevRunState() *states.SyncState { return c.PrevRunStateState } +func (c *MockEvalContext) MoveResults() map[addrs.UniqueKey]refactoring.MoveResult { + c.MoveResultsCalled = true + return c.MoveResultsResults +} + func (c *MockEvalContext) InstanceExpander() *instances.Expander { c.InstanceExpanderCalled = true return c.InstanceExpanderExpander diff --git a/internal/terraform/graph_walk_context.go b/internal/terraform/graph_walk_context.go index 4c16d44c71dd..fcda4fa73442 100644 --- a/internal/terraform/graph_walk_context.go +++ b/internal/terraform/graph_walk_context.go @@ -12,6 +12,7 @@ import ( "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" + "github.com/hashicorp/terraform/internal/refactoring" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -23,11 +24,12 @@ type ContextGraphWalker struct { // Configurable values Context *Context - State *states.SyncState // Used for safe concurrent access to state - RefreshState *states.SyncState // Used for safe concurrent access to state - PrevRunState *states.SyncState // Used for safe concurrent access to state - Changes *plans.ChangesSync // Used for safe concurrent writes to changes - InstanceExpander *instances.Expander // Tracks our gradual expansion of module and resource instances + State *states.SyncState // Used for safe concurrent access to state + RefreshState *states.SyncState // Used for safe concurrent access to state + PrevRunState *states.SyncState // Used for safe concurrent access to state + Changes *plans.ChangesSync // Used for safe concurrent writes to changes + InstanceExpander *instances.Expander // Tracks our gradual expansion of module and resource instances + MoveResults map[addrs.UniqueKey]refactoring.MoveResult // Read-only record of earlier processing of move statements Operation walkOperation StopContext context.Context RootVariableValues InputValues @@ -88,6 +90,7 @@ func (w *ContextGraphWalker) EvalContext() EvalContext { InstanceExpanderValue: w.InstanceExpander, Components: w.Context.components, Schemas: w.Context.schemas, + MoveResultsValue: w.MoveResults, ProviderCache: w.providerCache, ProviderInputConfig: w.Context.providerInputConfig, ProviderLock: &w.providerLock, diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index 7735897ce46a..89275809bbb5 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -393,7 +393,7 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState // vs. that something being entirely excluded e.g. due to -target. noop := &plans.ResourceInstanceChange{ Addr: absAddr, - PrevRunAddr: absAddr, // TODO-PrevRunAddr: If this instance was moved/renamed in this run, record its old address + PrevRunAddr: n.prevRunAddr(ctx), DeposedKey: deposedKey, Change: plans.Change{ Action: plans.NoOp, @@ -421,7 +421,7 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState // help for this one. plan := &plans.ResourceInstanceChange{ Addr: absAddr, - PrevRunAddr: absAddr, // TODO-PrevRunAddr: If this instance was moved/renamed in this run, record its old address + PrevRunAddr: n.prevRunAddr(ctx), DeposedKey: deposedKey, Change: plans.Change{ Action: plans.Delete, @@ -1066,7 +1066,7 @@ func (n *NodeAbstractResourceInstance) plan( // Update our return plan plan = &plans.ResourceInstanceChange{ Addr: n.Addr, - PrevRunAddr: n.Addr, // TODO-PrevRunAddr: If this instance was moved/renamed in this run, record its old address + PrevRunAddr: n.prevRunAddr(ctx), Private: plannedPrivate, ProviderAddr: n.ResolvedProvider, Change: plans.Change{ @@ -1528,7 +1528,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt // value containing unknowns from PlanDataResourceObject. plannedChange := &plans.ResourceInstanceChange{ Addr: n.Addr, - PrevRunAddr: n.Addr, // data resources are not refactorable + PrevRunAddr: n.prevRunAddr(ctx), ProviderAddr: n.ResolvedProvider, Change: plans.Change{ Action: plans.Read, @@ -2267,3 +2267,20 @@ func (n *NodeAbstractResourceInstance) apply( return nil, diags } } + +func (n *NodeAbstractResourceInstance) prevRunAddr(ctx EvalContext) addrs.AbsResourceInstance { + return resourceInstancePrevRunAddr(ctx, n.Addr) +} + +func resourceInstancePrevRunAddr(ctx EvalContext, currentAddr addrs.AbsResourceInstance) addrs.AbsResourceInstance { + table := ctx.MoveResults() + + result, ok := table[currentAddr.UniqueKey()] + if !ok { + // If there's no entry in the table then we'll assume it didn't move + // at all, and so its previous address is the same as the current one. + return currentAddr + } + + return result.From +} From 89b05050ec0d1cae275fb9a3072e85364ba37a22 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 24 Aug 2021 12:06:38 -0700 Subject: [PATCH 021/644] core: Functional-style API for terraform.Context Previously terraform.Context was built in an unfortunate way where all of the data was provided up front in terraform.NewContext and then mutated directly by subsequent operations. That made the data flow hard to follow, commonly leading to bugs, and also meant that we were forced to take various actions too early in terraform.NewContext, rather than waiting until a more appropriate time during an operation. This (enormous) commit changes terraform.Context so that its fields are broadly just unchanging data about the execution context (current workspace name, available plugins, etc) whereas the main data Terraform works with arrives via individual method arguments and is returned in return values. Specifically, this means that terraform.Context no longer "has-a" config, state, and "planned changes", instead holding on to those only temporarily during an operation. The caller is responsible for propagating the outcome of one step into the next step so that the data flow between operations is actually visible. However, since that's a change to the main entry points in the "terraform" package, this commit also touches every file in the codebase which interacted with those APIs. Most of the noise here is in updating tests to take the same actions using the new API style, but this also affects the main-code callers in the backends and in the command package. My goal here was to refactor without changing observable behavior, but in practice there are a couple externally-visible behavior variations here that seemed okay in service of the broader goal: - The "terraform graph" command is no longer hooked directly into the core graph builders, because that's no longer part of the public API. However, I did include a couple new Context functions whose contract is to produce a UI-oriented graph, and _for now_ those continue to return the physical graph we use for those operations. There's no exported API for generating the "validate" and "eval" graphs, because neither is particularly interesting in its own right, and so "terraform graph" no longer supports those graph types. - terraform.NewContext no longer has the responsibility for collecting all of the provider schemas up front. Instead, we wait until we need them. However, that means that some of our error messages now have a slightly different shape due to unwinding through a differently-shaped call stack. As of this commit we also end up reloading the schemas multiple times in some cases, which is functionally acceptable but likely represents a performance regression. I intend to rework this to use caching, but I'm saving that for a later commit because this one is big enough already. The proximal reason for this change is to resolve the chicken/egg problem whereby there was previously no single point where we could apply "moved" statements to the previous run state before creating a plan. With this change in place, we can now do that as part of Context.Plan, prior to forking the input state into the three separate state artifacts we use during planning. However, this is at least the third project in a row where the previous API design led to piling more functionality into terraform.NewContext and then working around the incorrect order of operations that produces, so I intend that by paying the cost/risk of this large diff now we can in turn reduce the cost/risk of future projects that relate to our main workflow actions. --- internal/backend/backend.go | 60 +- internal/backend/local/backend.go | 2 +- internal/backend/local/backend_apply.go | 45 +- internal/backend/local/backend_local.go | 146 +- internal/backend/local/backend_local_test.go | 93 +- internal/backend/local/backend_plan.go | 18 +- internal/backend/local/backend_plan_test.go | 2 +- internal/backend/local/backend_refresh.go | 14 +- internal/backend/local/backend_test.go | 6 +- .../backend/local/testdata/invalid/invalid.tf | 6 + internal/backend/remote/backend.go | 2 + internal/backend/remote/backend_context.go | 32 +- .../backend/remote/backend_context_test.go | 2 +- internal/command/add.go | 14 +- internal/command/console.go | 13 +- internal/command/graph.go | 88 +- internal/command/import.go | 11 +- internal/command/import_test.go | 2 +- internal/command/meta.go | 1 - internal/command/plan_test.go | 2 +- internal/command/providers_schema.go | 10 +- internal/command/show.go | 11 +- internal/command/state_show.go | 8 +- internal/command/test.go | 64 +- internal/command/validate.go | 24 +- internal/repl/session_test.go | 8 +- internal/states/sync.go | 10 + internal/terraform/context.go | 851 +----- internal/terraform/context_apply.go | 142 + internal/terraform/context_apply2_test.go | 87 +- internal/terraform/context_apply_test.go | 2631 +++++++---------- internal/terraform/context_eval.go | 104 + internal/terraform/context_eval_test.go | 4 +- internal/terraform/context_fixtures_test.go | 1 - internal/terraform/context_graph_type.go | 30 - internal/terraform/context_import.go | 43 +- internal/terraform/context_import_test.go | 133 +- internal/terraform/context_input.go | 48 +- internal/terraform/context_input_test.go | 110 +- internal/terraform/context_plan.go | 435 +++ internal/terraform/context_plan2_test.go | 132 +- internal/terraform/context_plan_test.go | 660 ++--- internal/terraform/context_refresh.go | 37 + internal/terraform/context_refresh_test.go | 169 +- internal/terraform/context_test.go | 62 +- internal/terraform/context_validate.go | 88 + internal/terraform/context_validate_test.go | 312 +- internal/terraform/context_walk.go | 122 + internal/terraform/graph.go | 12 +- .../terraform/graph_builder_apply_test.go | 4 +- internal/terraform/graph_walk_context.go | 9 +- internal/terraform/graphtype_string.go | 29 - internal/terraform/node_provider.go | 3 + .../node_resource_abstract_instance.go | 1 + internal/terraform/variables.go | 13 + 55 files changed, 3289 insertions(+), 3677 deletions(-) create mode 100644 internal/backend/local/testdata/invalid/invalid.tf create mode 100644 internal/terraform/context_apply.go create mode 100644 internal/terraform/context_eval.go delete mode 100644 internal/terraform/context_graph_type.go create mode 100644 internal/terraform/context_plan.go create mode 100644 internal/terraform/context_refresh.go create mode 100644 internal/terraform/context_validate.go create mode 100644 internal/terraform/context_walk.go delete mode 100644 internal/terraform/graphtype_string.go diff --git a/internal/backend/backend.go b/internal/backend/backend.go index db4370ce1919..caac42cc6731 100644 --- a/internal/backend/backend.go +++ b/internal/backend/backend.go @@ -141,9 +141,63 @@ type Enhanced interface { // configurations, variables, and more. Not all backends may support this // so we separate it out into its own optional interface. type Local interface { - // Context returns a runnable terraform Context. The operation parameter - // doesn't need a Type set but it needs other options set such as Module. - Context(*Operation) (*terraform.Context, statemgr.Full, tfdiags.Diagnostics) + // LocalRun uses information in the Operation to prepare a set of objects + // needed to start running that operation. + // + // The operation doesn't need a Type set, but it needs various other + // options set. This is a rather odd API that tries to treat all + // operations as the same when they really aren't; see the local and remote + // backend's implementations of this to understand what this actually + // does, because this operation has no well-defined contract aside from + // "whatever it already does". + LocalRun(*Operation) (*LocalRun, statemgr.Full, tfdiags.Diagnostics) +} + +// LocalRun represents the assortment of objects that we can collect or +// calculate from an Operation object, which we can then use for local +// operations. +// +// The operation methods on terraform.Context (Plan, Apply, Import, etc) each +// generate new artifacts which supersede parts of the LocalRun object that +// started the operation, so callers should be careful to use those subsequent +// artifacts instead of the fields of LocalRun where appropriate. The LocalRun +// data intentionally doesn't update as a result of calling methods on Context, +// in order to make data flow explicit. +// +// This type is a weird architectural wart resulting from the overly-general +// way our backend API models operations, whereby we behave as if all +// Terraform operations have the same inputs and outputs even though they +// are actually all rather different. The exact meaning of the fields in +// this type therefore vary depending on which OperationType was passed to +// Local.Context in order to create an object of this type. +type LocalRun struct { + // Core is an already-initialized Terraform Core context, ready to be + // used to run operations such as Plan and Apply. + Core *terraform.Context + + // Config is the configuration we're working with, which typically comes + // from either config files directly on local disk (when we're creating + // a plan, or similar) or from a snapshot embedded in a plan file + // (when we're applying a saved plan). + Config *configs.Config + + // InputState is the state that should be used for whatever is the first + // method call to a context created with CoreOpts. When creating a plan + // this will be the previous run state, but when applying a saved plan + // this will be the prior state recorded in that plan. + InputState *states.State + + // PlanOpts are options to pass to a Plan or Plan-like operation. + // + // This is nil when we're applying a saved plan, because the plan itself + // contains enough information about its options to apply it. + PlanOpts *terraform.PlanOpts + + // Plan is a plan loaded from a saved plan file, if our operation is to + // apply that saved plan. + // + // This is nil when we're not applying a saved plan. + Plan *plans.Plan } // An operation represents an operation for Terraform to execute. diff --git a/internal/backend/local/backend.go b/internal/backend/local/backend.go index a19c1bc1b92f..f5d07b20f039 100644 --- a/internal/backend/local/backend.go +++ b/internal/backend/local/backend.go @@ -284,7 +284,7 @@ func (b *Local) Operation(ctx context.Context, op *backend.Operation) (*backend. f = b.opApply default: return nil, fmt.Errorf( - "Unsupported operation type: %s\n\n"+ + "unsupported operation type: %s\n\n"+ "This is a bug in Terraform and should be reported. The local backend\n"+ "is built-in to Terraform and should always support all operations.", op.Type) diff --git a/internal/backend/local/backend_apply.go b/internal/backend/local/backend_apply.go index 7d68006bef65..5b143a74f46d 100644 --- a/internal/backend/local/backend_apply.go +++ b/internal/backend/local/backend_apply.go @@ -5,7 +5,6 @@ import ( "fmt" "log" - "github.com/hashicorp/errwrap" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/plans" @@ -23,7 +22,7 @@ func (b *Local) opApply( runningOp *backend.RunningOperation) { log.Printf("[INFO] backend/local: starting Apply operation") - var diags tfdiags.Diagnostics + var diags, moreDiags tfdiags.Diagnostics // If we have a nil module at this point, then set it to an empty tree // to avoid any potential crashes. @@ -43,7 +42,7 @@ func (b *Local) opApply( op.Hooks = append(op.Hooks, stateHook) // Get our context - tfCtx, _, opState, contextDiags := b.context(op) + lr, _, opState, contextDiags := b.localRun(op) diags = diags.Append(contextDiags) if contextDiags.HasErrors() { op.ReportResult(runningOp, diags) @@ -59,15 +58,26 @@ func (b *Local) opApply( } }() - runningOp.State = tfCtx.State() + // We'll start off with our result being the input state, and replace it + // with the result state only if we eventually complete the apply + // operation. + runningOp.State = lr.InputState + var plan *plans.Plan // If we weren't given a plan, then we refresh/plan if op.PlanFile == nil { // Perform the plan log.Printf("[INFO] backend/local: apply calling Plan") - plan, planDiags := tfCtx.Plan() - diags = diags.Append(planDiags) - if planDiags.HasErrors() { + plan, moreDiags = lr.Core.Plan(lr.Config, lr.InputState, lr.PlanOpts) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + op.ReportResult(runningOp, diags) + return + } + + schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { op.ReportResult(runningOp, diags) return } @@ -75,7 +85,7 @@ func (b *Local) opApply( trivialPlan := !plan.CanApply() hasUI := op.UIOut != nil && op.UIIn != nil mustConfirm := hasUI && !op.AutoApprove && !trivialPlan - op.View.Plan(plan, tfCtx.Schemas()) + op.View.Plan(plan, schemas) if mustConfirm { var desc, query string @@ -119,7 +129,7 @@ func (b *Local) opApply( Description: desc, }) if err != nil { - diags = diags.Append(errwrap.Wrapf("Error asking for approval: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error asking for approval: %w", err)) op.ReportResult(runningOp, diags) return } @@ -130,16 +140,7 @@ func (b *Local) opApply( } } } else { - plan, err := op.PlanFile.ReadPlan() - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid plan file", - fmt.Sprintf("Failed to read plan from plan file: %s.", err), - )) - op.ReportResult(runningOp, diags) - return - } + plan = lr.Plan for _, change := range plan.Changes.Resources { if change.Action != plans.NoOp { op.View.PlannedChange(change) @@ -157,12 +158,10 @@ func (b *Local) opApply( go func() { defer close(doneCh) log.Printf("[INFO] backend/local: apply calling Apply") - _, applyDiags = tfCtx.Apply() - // we always want the state, even if apply failed - applyState = tfCtx.State() + applyState, applyDiags = lr.Core.Apply(plan, lr.Config) }() - if b.opWait(doneCh, stopCtx, cancelCtx, tfCtx, opState, op.View) { + if b.opWait(doneCh, stopCtx, cancelCtx, lr.Core, opState, op.View) { return } diags = diags.Append(applyDiags) diff --git a/internal/backend/local/backend_local.go b/internal/backend/local/backend_local.go index 0ad9f1fd5719..0ba6e66fc681 100644 --- a/internal/backend/local/backend_local.go +++ b/internal/backend/local/backend_local.go @@ -6,7 +6,6 @@ import ( "log" "sort" - "github.com/hashicorp/errwrap" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configload" @@ -18,25 +17,29 @@ import ( ) // backend.Local implementation. -func (b *Local) Context(op *backend.Operation) (*terraform.Context, statemgr.Full, tfdiags.Diagnostics) { +func (b *Local) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Full, tfdiags.Diagnostics) { // Make sure the type is invalid. We use this as a way to know not - // to ask for input/validate. + // to ask for input/validate. We're modifying this through a pointer, + // so we're mutating an object that belongs to the caller here, which + // seems bad but we're preserving it for now until we have time to + // properly design this API, vs. just preserving whatever it currently + // happens to do. op.Type = backend.OperationTypeInvalid op.StateLocker = op.StateLocker.WithContext(context.Background()) - ctx, _, stateMgr, diags := b.context(op) - return ctx, stateMgr, diags + lr, _, stateMgr, diags := b.localRun(op) + return lr, stateMgr, diags } -func (b *Local) context(op *backend.Operation) (*terraform.Context, *configload.Snapshot, statemgr.Full, tfdiags.Diagnostics) { +func (b *Local) localRun(op *backend.Operation) (*backend.LocalRun, *configload.Snapshot, statemgr.Full, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // Get the latest state. log.Printf("[TRACE] backend/local: requesting state manager for workspace %q", op.Workspace) s, err := b.StateMgr(op.Workspace) if err != nil { - diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading state: %w", err)) return nil, nil, nil, diags } log.Printf("[TRACE] backend/local: requesting state lock for workspace %q", op.Workspace) @@ -54,35 +57,20 @@ func (b *Local) context(op *backend.Operation) (*terraform.Context, *configload. log.Printf("[TRACE] backend/local: reading remote state for workspace %q", op.Workspace) if err := s.RefreshState(); err != nil { - diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading state: %w", err)) return nil, nil, nil, diags } + ret := &backend.LocalRun{} + // Initialize our context options - var opts terraform.ContextOpts + var coreOpts terraform.ContextOpts if v := b.ContextOpts; v != nil { - opts = *v + coreOpts = *v } + coreOpts.UIInput = op.UIIn + coreOpts.Hooks = op.Hooks - // Copy set options from the operation - opts.PlanMode = op.PlanMode - opts.Targets = op.Targets - opts.ForceReplace = op.ForceReplace - opts.UIInput = op.UIIn - opts.Hooks = op.Hooks - - opts.SkipRefresh = op.Type != backend.OperationTypeRefresh && !op.PlanRefresh - if opts.SkipRefresh { - log.Printf("[DEBUG] backend/local: skipping refresh of managed resources") - } - - // Load the latest state. If we enter contextFromPlanFile below then the - // state snapshot in the plan file must match this, or else it'll return - // error diagnostics. - log.Printf("[TRACE] backend/local: retrieving local state snapshot for workspace %q", op.Workspace) - opts.State = s.State() - - var tfCtx *terraform.Context var ctxDiags tfdiags.Diagnostics var configSnap *configload.Snapshot if op.PlanFile != nil { @@ -94,8 +82,8 @@ func (b *Local) context(op *backend.Operation) (*terraform.Context, *configload. m := sm.StateSnapshotMeta() stateMeta = &m } - log.Printf("[TRACE] backend/local: building context from plan file") - tfCtx, configSnap, ctxDiags = b.contextFromPlanFile(op.PlanFile, opts, stateMeta) + log.Printf("[TRACE] backend/local: populating backend.LocalRun from plan file") + ret, configSnap, ctxDiags = b.localRunForPlanFile(op.PlanFile, ret, &coreOpts, stateMeta) if ctxDiags.HasErrors() { diags = diags.Append(ctxDiags) return nil, nil, nil, diags @@ -105,14 +93,13 @@ func (b *Local) context(op *backend.Operation) (*terraform.Context, *configload. // available if we need to generate diagnostic message snippets. op.ConfigLoader.ImportSourcesFromSnapshot(configSnap) } else { - log.Printf("[TRACE] backend/local: building context for current working directory") - tfCtx, configSnap, ctxDiags = b.contextDirect(op, opts) + log.Printf("[TRACE] backend/local: populating backend.LocalRun for current working directory") + ret, configSnap, ctxDiags = b.localRunDirect(op, ret, &coreOpts, s) } diags = diags.Append(ctxDiags) if diags.HasErrors() { return nil, nil, nil, diags } - log.Printf("[TRACE] backend/local: finished building terraform.Context") // If we have an operation, then we automatically do the input/validate // here since every option requires this. @@ -122,7 +109,7 @@ func (b *Local) context(op *backend.Operation) (*terraform.Context, *configload. mode := terraform.InputModeProvider log.Printf("[TRACE] backend/local: requesting interactive input, if necessary") - inputDiags := tfCtx.Input(mode) + inputDiags := ret.Core.Input(ret.Config, mode) diags = diags.Append(inputDiags) if inputDiags.HasErrors() { return nil, nil, nil, diags @@ -132,15 +119,15 @@ func (b *Local) context(op *backend.Operation) (*terraform.Context, *configload. // If validation is enabled, validate if b.OpValidation { log.Printf("[TRACE] backend/local: running validation operation") - validateDiags := tfCtx.Validate() + validateDiags := ret.Core.Validate(ret.Config) diags = diags.Append(validateDiags) } } - return tfCtx, configSnap, s, diags + return ret, configSnap, s, diags } -func (b *Local) contextDirect(op *backend.Operation, opts terraform.ContextOpts) (*terraform.Context, *configload.Snapshot, tfdiags.Diagnostics) { +func (b *Local) localRunDirect(op *backend.Operation, run *backend.LocalRun, coreOpts *terraform.ContextOpts, s statemgr.Full) (*backend.LocalRun, *configload.Snapshot, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // Load the configuration using the caller-provided configuration loader. @@ -149,7 +136,7 @@ func (b *Local) contextDirect(op *backend.Operation, opts terraform.ContextOpts) if configDiags.HasErrors() { return nil, nil, diags } - opts.Config = config + run.Config = config var rawVariables map[string]backend.UnparsedVariableValue if op.AllowUnsetVariables { @@ -163,7 +150,7 @@ func (b *Local) contextDirect(op *backend.Operation, opts terraform.ContextOpts) // values through interactive prompts. // TODO: Need to route the operation context through into here, so that // the interactive prompts can be sensitive to its timeouts/etc. - rawVariables = b.interactiveCollectVariables(context.TODO(), op.Variables, config.Module.Variables, opts.UIInput) + rawVariables = b.interactiveCollectVariables(context.TODO(), op.Variables, config.Module.Variables, op.UIIn) } variables, varDiags := backend.ParseVariableValues(rawVariables, config.Module.Variables) @@ -171,14 +158,30 @@ func (b *Local) contextDirect(op *backend.Operation, opts terraform.ContextOpts) if diags.HasErrors() { return nil, nil, diags } - opts.Variables = variables - tfCtx, ctxDiags := terraform.NewContext(&opts) - diags = diags.Append(ctxDiags) - return tfCtx, configSnap, diags + planOpts := &terraform.PlanOpts{ + Mode: op.PlanMode, + Targets: op.Targets, + ForceReplace: op.ForceReplace, + SetVariables: variables, + SkipRefresh: op.Type != backend.OperationTypeRefresh && !op.PlanRefresh, + } + run.PlanOpts = planOpts + + // For a "direct" local run, the input state is the most recently stored + // snapshot, from the previous run. + run.InputState = s.State() + + tfCtx, moreDiags := terraform.NewContext(coreOpts) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, nil, diags + } + run.Core = tfCtx + return run, configSnap, diags } -func (b *Local) contextFromPlanFile(pf *planfile.Reader, opts terraform.ContextOpts, currentStateMeta *statemgr.SnapshotMeta) (*terraform.Context, *configload.Snapshot, tfdiags.Diagnostics) { +func (b *Local) localRunForPlanFile(pf *planfile.Reader, run *backend.LocalRun, coreOpts *terraform.ContextOpts, currentStateMeta *statemgr.SnapshotMeta) (*backend.LocalRun, *configload.Snapshot, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics const errSummary = "Invalid plan file" @@ -201,7 +204,7 @@ func (b *Local) contextFromPlanFile(pf *planfile.Reader, opts terraform.ContextO if configDiags.HasErrors() { return nil, snap, diags } - opts.Config = config + run.Config = config // A plan file also contains a snapshot of the prior state the changes // are intended to apply to. @@ -230,11 +233,10 @@ func (b *Local) contextFromPlanFile(pf *planfile.Reader, opts terraform.ContextO } } } - // The caller already wrote the "current state" here, but we're overriding - // it here with the prior state. These two should actually be identical in - // normal use, particularly if we validated the state meta above, but - // we do this here anyway to ensure consistent behavior. - opts.State = priorStateFile.State + // When we're applying a saved plan, the input state is the "prior state" + // recorded in the plan, which incorporates the result of all of the + // refreshing we did while building the plan. + run.InputState = priorStateFile.State plan, err := pf.ReadPlan() if err != nil { @@ -245,33 +247,23 @@ func (b *Local) contextFromPlanFile(pf *planfile.Reader, opts terraform.ContextO )) return nil, snap, diags } - - variables := terraform.InputValues{} - for name, dyVal := range plan.VariableValues { - val, err := dyVal.Decode(cty.DynamicPseudoType) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - errSummary, - fmt.Sprintf("Invalid value for variable %q recorded in plan file: %s.", name, err), - )) - continue - } - - variables[name] = &terraform.InputValue{ - Value: val, - SourceType: terraform.ValueFromPlan, - } + // When we're applying a saved plan, we populate Plan instead of PlanOpts, + // because a plan object incorporates the subset of data from PlanOps that + // we need to apply the plan. + run.Plan = plan + + // When we're applying a saved plan, our context must verify that all of + // the providers it ends up using are identical to those which created + // the plan. + coreOpts.ProviderSHA256s = plan.ProviderSHA256s + + tfCtx, moreDiags := terraform.NewContext(coreOpts) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, nil, diags } - opts.Variables = variables - opts.Changes = plan.Changes - opts.Targets = plan.TargetAddrs - opts.ForceReplace = plan.ForceReplaceAddrs - opts.ProviderSHA256s = plan.ProviderSHA256s - - tfCtx, ctxDiags := terraform.NewContext(&opts) - diags = diags.Append(ctxDiags) - return tfCtx, snap, diags + run.Core = tfCtx + return run, snap, diags } // interactiveCollectVariables attempts to complete the given existing diff --git a/internal/backend/local/backend_local_test.go b/internal/backend/local/backend_local_test.go index f9db2d6b51be..67314d730c5c 100644 --- a/internal/backend/local/backend_local_test.go +++ b/internal/backend/local/backend_local_test.go @@ -1,6 +1,7 @@ package local import ( + "fmt" "os" "path/filepath" "testing" @@ -10,16 +11,19 @@ import ( "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/configs/configload" + "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/statefile" + "github.com/hashicorp/terraform/internal/states/statemgr" "github.com/hashicorp/terraform/internal/terminal" + "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" ) -func TestLocalContext(t *testing.T) { +func TestLocalRun(t *testing.T) { configDir := "./testdata/empty" b, cleanup := TestLocal(t) defer cleanup() @@ -38,20 +42,24 @@ func TestLocalContext(t *testing.T) { StateLocker: stateLocker, } - _, _, diags := b.Context(op) + _, _, diags := b.LocalRun(op) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err().Error()) } - // Context() retains a lock on success + // LocalRun() retains a lock on success assertBackendStateLocked(t, b) } -func TestLocalContext_error(t *testing.T) { - configDir := "./testdata/apply" +func TestLocalRun_error(t *testing.T) { + configDir := "./testdata/invalid" b, cleanup := TestLocal(t) defer cleanup() + // This backend will return an error when asked to RefreshState, which + // should then cause LocalRun to return with the state unlocked. + b.Backend = backendWithStateStorageThatFailsRefresh{} + _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) defer configCleanup() @@ -66,16 +74,16 @@ func TestLocalContext_error(t *testing.T) { StateLocker: stateLocker, } - _, _, diags := b.Context(op) + _, _, diags := b.LocalRun(op) if !diags.HasErrors() { t.Fatal("unexpected success") } - // Context() unlocks the state on failure + // LocalRun() unlocks the state on failure assertBackendStateUnlocked(t, b) } -func TestLocalContext_stalePlan(t *testing.T) { +func TestLocalRun_stalePlan(t *testing.T) { configDir := "./testdata/apply" b, cleanup := TestLocal(t) defer cleanup() @@ -147,11 +155,76 @@ func TestLocalContext_stalePlan(t *testing.T) { StateLocker: stateLocker, } - _, _, diags := b.Context(op) + _, _, diags := b.LocalRun(op) if !diags.HasErrors() { t.Fatal("unexpected success") } - // Context() unlocks the state on failure + // LocalRun() unlocks the state on failure assertBackendStateUnlocked(t, b) } + +type backendWithStateStorageThatFailsRefresh struct { +} + +var _ backend.Backend = backendWithStateStorageThatFailsRefresh{} + +func (b backendWithStateStorageThatFailsRefresh) StateMgr(workspace string) (statemgr.Full, error) { + return &stateStorageThatFailsRefresh{}, nil +} + +func (b backendWithStateStorageThatFailsRefresh) ConfigSchema() *configschema.Block { + return &configschema.Block{} +} + +func (b backendWithStateStorageThatFailsRefresh) PrepareConfig(in cty.Value) (cty.Value, tfdiags.Diagnostics) { + return in, nil +} + +func (b backendWithStateStorageThatFailsRefresh) Configure(cty.Value) tfdiags.Diagnostics { + return nil +} + +func (b backendWithStateStorageThatFailsRefresh) DeleteWorkspace(name string) error { + return fmt.Errorf("unimplemented") +} + +func (b backendWithStateStorageThatFailsRefresh) Workspaces() ([]string, error) { + return []string{"default"}, nil +} + +type stateStorageThatFailsRefresh struct { + locked bool +} + +func (s *stateStorageThatFailsRefresh) Lock(info *statemgr.LockInfo) (string, error) { + if s.locked { + return "", fmt.Errorf("already locked") + } + s.locked = true + return "locked", nil +} + +func (s *stateStorageThatFailsRefresh) Unlock(id string) error { + if !s.locked { + return fmt.Errorf("not locked") + } + s.locked = false + return nil +} + +func (s *stateStorageThatFailsRefresh) State() *states.State { + return nil +} + +func (s *stateStorageThatFailsRefresh) WriteState(*states.State) error { + return fmt.Errorf("unimplemented") +} + +func (s *stateStorageThatFailsRefresh) RefreshState() error { + return fmt.Errorf("intentionally failing for testing purposes") +} + +func (s *stateStorageThatFailsRefresh) PersistState() error { + return fmt.Errorf("unimplemented") +} diff --git a/internal/backend/local/backend_plan.go b/internal/backend/local/backend_plan.go index 507d2ec98666..e25ab3ef6415 100644 --- a/internal/backend/local/backend_plan.go +++ b/internal/backend/local/backend_plan.go @@ -54,7 +54,7 @@ func (b *Local) opPlan( } // Get our context - tfCtx, configSnap, opState, ctxDiags := b.context(op) + lr, configSnap, opState, ctxDiags := b.localRun(op) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { op.ReportResult(runningOp, diags) @@ -70,7 +70,9 @@ func (b *Local) opPlan( } }() - runningOp.State = tfCtx.State() + // Since planning doesn't immediately change the persisted state, the + // resulting state is always just the input state. + runningOp.State = lr.InputState // Perform the plan in a goroutine so we can be interrupted var plan *plans.Plan @@ -79,10 +81,10 @@ func (b *Local) opPlan( go func() { defer close(doneCh) log.Printf("[INFO] backend/local: plan calling Plan") - plan, planDiags = tfCtx.Plan() + plan, planDiags = lr.Core.Plan(lr.Config, lr.InputState, lr.PlanOpts) }() - if b.opWait(doneCh, stopCtx, cancelCtx, tfCtx, opState, op.View) { + if b.opWait(doneCh, stopCtx, cancelCtx, lr.Core, opState, op.View) { // If we get in here then the operation was cancelled, which is always // considered to be a failure. log.Printf("[INFO] backend/local: plan operation was force-cancelled by interrupt") @@ -144,7 +146,13 @@ func (b *Local) opPlan( } // Render the plan - op.View.Plan(plan, tfCtx.Schemas()) + schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + op.ReportResult(runningOp, diags) + return + } + op.View.Plan(plan, schemas) // If we've accumulated any warnings along the way then we'll show them // here just before we show the summary and next steps. If we encountered diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 0b823b253171..5866048f9f0a 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -136,7 +136,7 @@ func TestLocal_plan_context_error(t *testing.T) { // the backend should be unlocked after a run assertBackendStateUnlocked(t, b) - if got, want := done(t).Stderr(), "Error: Could not load plugin"; !strings.Contains(got, want) { + if got, want := done(t).Stderr(), "Error: Failed to load plugin schemas"; !strings.Contains(got, want) { t.Fatalf("unexpected error output:\n%s\nwant: %s", got, want) } } diff --git a/internal/backend/local/backend_refresh.go b/internal/backend/local/backend_refresh.go index fa6424702f66..988a8b8f3759 100644 --- a/internal/backend/local/backend_refresh.go +++ b/internal/backend/local/backend_refresh.go @@ -6,7 +6,6 @@ import ( "log" "os" - "github.com/hashicorp/errwrap" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/statemgr" @@ -45,7 +44,7 @@ func (b *Local) opRefresh( op.PlanRefresh = true // Get our context - tfCtx, _, opState, contextDiags := b.context(op) + lr, _, opState, contextDiags := b.localRun(op) diags = diags.Append(contextDiags) if contextDiags.HasErrors() { op.ReportResult(runningOp, diags) @@ -62,8 +61,9 @@ func (b *Local) opRefresh( } }() - // Set our state - runningOp.State = opState.State() + // If we succeed then we'll overwrite this with the resulting state below, + // but otherwise the resulting state is just the input state. + runningOp.State = lr.InputState if !runningOp.State.HasResources() { diags = diags.Append(tfdiags.Sourceless( tfdiags.Warning, @@ -78,11 +78,11 @@ func (b *Local) opRefresh( doneCh := make(chan struct{}) go func() { defer close(doneCh) - newState, refreshDiags = tfCtx.Refresh() + newState, refreshDiags = lr.Core.Refresh(lr.Config, lr.InputState, lr.PlanOpts) log.Printf("[INFO] backend/local: refresh calling Refresh") }() - if b.opWait(doneCh, stopCtx, cancelCtx, tfCtx, opState, op.View) { + if b.opWait(doneCh, stopCtx, cancelCtx, lr.Core, opState, op.View) { return } @@ -96,7 +96,7 @@ func (b *Local) opRefresh( err := statemgr.WriteAndPersist(opState, newState) if err != nil { - diags = diags.Append(errwrap.Wrapf("Failed to write state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("failed to write state: %w", err)) op.ReportResult(runningOp, diags) return } diff --git a/internal/backend/local/backend_test.go b/internal/backend/local/backend_test.go index 4e9642660a39..d39890fa2384 100644 --- a/internal/backend/local/backend_test.go +++ b/internal/backend/local/backend_test.go @@ -178,9 +178,9 @@ type testDelegateBackend struct { deleteErr bool } -var errTestDelegateState = errors.New("State called") -var errTestDelegateStates = errors.New("States called") -var errTestDelegateDeleteState = errors.New("Delete called") +var errTestDelegateState = errors.New("state called") +var errTestDelegateStates = errors.New("states called") +var errTestDelegateDeleteState = errors.New("delete called") func (b *testDelegateBackend) StateMgr(name string) (statemgr.Full, error) { if b.stateErr { diff --git a/internal/backend/local/testdata/invalid/invalid.tf b/internal/backend/local/testdata/invalid/invalid.tf new file mode 100644 index 000000000000..7f2d0723d3b0 --- /dev/null +++ b/internal/backend/local/testdata/invalid/invalid.tf @@ -0,0 +1,6 @@ +# This configuration is intended to be loadable (valid syntax, etc) but to +# fail terraform.Context.Validate. + +locals { + a = local.nonexist +} diff --git a/internal/backend/remote/backend.go b/internal/backend/remote/backend.go index 97b27b4a6e4a..5e11872391be 100644 --- a/internal/backend/remote/backend.go +++ b/internal/backend/remote/backend.go @@ -91,6 +91,8 @@ type Remote struct { } var _ backend.Backend = (*Remote)(nil) +var _ backend.Enhanced = (*Remote)(nil) +var _ backend.Local = (*Remote)(nil) // New creates a new initialized remote backend. func New(services *disco.Disco) *Remote { diff --git a/internal/backend/remote/backend_context.go b/internal/backend/remote/backend_context.go index b622f3f7872c..5d50d11d432e 100644 --- a/internal/backend/remote/backend_context.go +++ b/internal/backend/remote/backend_context.go @@ -6,7 +6,6 @@ import ( "log" "strings" - "github.com/hashicorp/errwrap" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hclsyntax" @@ -18,9 +17,15 @@ import ( "github.com/zclconf/go-cty/cty" ) -// Context implements backend.Enhanced. -func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Full, tfdiags.Diagnostics) { +// Context implements backend.Local. +func (b *Remote) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Full, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics + ret := &backend.LocalRun{ + PlanOpts: &terraform.PlanOpts{ + Mode: op.PlanMode, + Targets: op.Targets, + }, + } op.StateLocker = op.StateLocker.WithContext(context.Background()) @@ -31,7 +36,7 @@ func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Fu log.Printf("[TRACE] backend/remote: requesting state manager for workspace %q", remoteWorkspaceName) stateMgr, err := b.StateMgr(op.Workspace) if err != nil { - diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading state: %w", err)) return nil, nil, diags } @@ -50,7 +55,7 @@ func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Fu log.Printf("[TRACE] backend/remote: reading remote state for workspace %q", remoteWorkspaceName) if err := stateMgr.RefreshState(); err != nil { - diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading state: %w", err)) return nil, nil, diags } @@ -61,15 +66,13 @@ func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Fu } // Copy set options from the operation - opts.PlanMode = op.PlanMode - opts.Targets = op.Targets opts.UIInput = op.UIIn // Load the latest state. If we enter contextFromPlanFile below then the // state snapshot in the plan file must match this, or else it'll return // error diagnostics. log.Printf("[TRACE] backend/remote: retrieving remote state snapshot for workspace %q", remoteWorkspaceName) - opts.State = stateMgr.State() + ret.InputState = stateMgr.State() log.Printf("[TRACE] backend/remote: loading configuration for the current working directory") config, configDiags := op.ConfigLoader.LoadConfig(op.ConfigDir) @@ -77,21 +80,21 @@ func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Fu if configDiags.HasErrors() { return nil, nil, diags } - opts.Config = config + ret.Config = config // The underlying API expects us to use the opaque workspace id to request // variables, so we'll need to look that up using our organization name // and workspace name. remoteWorkspaceID, err := b.getRemoteWorkspaceID(context.Background(), op.Workspace) if err != nil { - diags = diags.Append(errwrap.Wrapf("Error finding remote workspace: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error finding remote workspace: %w", err)) return nil, nil, diags } log.Printf("[TRACE] backend/remote: retrieving variables from workspace %s/%s (%s)", remoteWorkspaceName, b.organization, remoteWorkspaceID) tfeVariables, err := b.client.Variables.List(context.Background(), remoteWorkspaceID, tfe.VariableListOptions{}) if err != nil && err != tfe.ErrResourceNotFound { - diags = diags.Append(errwrap.Wrapf("Error loading variables: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading variables: %w", err)) return nil, nil, diags } @@ -100,7 +103,7 @@ func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Fu // more lax about them, stubbing out any unset ones as unknown. // This gives us enough information to produce a consistent context, // but not enough information to run a real operation (plan, apply, etc) - opts.Variables = stubAllVariables(op.Variables, config.Module.Variables) + ret.PlanOpts.SetVariables = stubAllVariables(op.Variables, config.Module.Variables) } else { if tfeVariables != nil { if op.Variables == nil { @@ -121,16 +124,17 @@ func (b *Remote) Context(op *backend.Operation) (*terraform.Context, statemgr.Fu if diags.HasErrors() { return nil, nil, diags } - opts.Variables = variables + ret.PlanOpts.SetVariables = variables } } tfCtx, ctxDiags := terraform.NewContext(&opts) diags = diags.Append(ctxDiags) + ret.Core = tfCtx log.Printf("[TRACE] backend/remote: finished building terraform.Context") - return tfCtx, stateMgr, diags + return ret, stateMgr, diags } func (b *Remote) getRemoteWorkspaceName(localWorkspaceName string) string { diff --git a/internal/backend/remote/backend_context_test.go b/internal/backend/remote/backend_context_test.go index c0470493f5c3..819f583ec844 100644 --- a/internal/backend/remote/backend_context_test.go +++ b/internal/backend/remote/backend_context_test.go @@ -204,7 +204,7 @@ func TestRemoteContextWithVars(t *testing.T) { } b.client.Variables.Create(context.TODO(), workspaceID, *v) - _, _, diags := b.Context(op) + _, _, diags := b.LocalRun(op) if test.WantError != "" { if !diags.HasErrors() { diff --git a/internal/command/add.go b/internal/command/add.go index 4e23d8144847..c1326815705f 100644 --- a/internal/command/add.go +++ b/internal/command/add.go @@ -99,7 +99,7 @@ func (c *AddCommand) Run(rawArgs []string) int { } // Get the context - ctx, _, ctxDiags := local.Context(opReq) + lr, _, ctxDiags := local.LocalRun(opReq) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { view.Diagnostics(diags) @@ -118,10 +118,10 @@ func (c *AddCommand) Run(rawArgs []string) int { // already exist in the config. var module *configs.Module if args.Addr.Module.IsRoot() { - module = ctx.Config().Module + module = lr.Config.Module } else { // This is weird, but users can potentially specify non-existant module names - cfg := ctx.Config().Root.Descendent(args.Addr.Module.Module()) + cfg := lr.Config.Root.Descendent(args.Addr.Module.Module()) if cfg != nil { module = cfg.Module } @@ -143,7 +143,12 @@ func (c *AddCommand) Run(rawArgs []string) int { } // Get the schemas from the context - schemas := ctx.Schemas() + schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + view.Diagnostics(diags) + return 1 + } // Determine the correct provider config address. The provider-related // variables may get updated below @@ -154,7 +159,6 @@ func (c *AddCommand) Run(rawArgs []string) int { // If we are getting the values from state, get the AbsProviderConfig // directly from state as well. var resource *states.Resource - var moreDiags tfdiags.Diagnostics if args.FromState { resource, moreDiags = c.getResource(b, args.Addr.ContainingResource()) if moreDiags.HasErrors() { diff --git a/internal/command/console.go b/internal/command/console.go index 9423f0e32207..3195988683b0 100644 --- a/internal/command/console.go +++ b/internal/command/console.go @@ -9,6 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/helper/wrappedstreams" "github.com/hashicorp/terraform/internal/repl" + "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/mitchellh/cli" @@ -95,7 +96,7 @@ func (c *ConsoleCommand) Run(args []string) int { } // Get the context - ctx, _, ctxDiags := local.Context(opReq) + lr, _, ctxDiags := local.LocalRun(opReq) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { c.showDiagnostics(diags) @@ -116,10 +117,18 @@ func (c *ConsoleCommand) Run(args []string) int { ErrorWriter: wrappedstreams.Stderr(), } + evalOpts := &terraform.EvalOpts{} + if lr.PlanOpts != nil { + // the LocalRun type is built primarily to support the main operations, + // so the variable values end up in the "PlanOpts" even though we're + // not actually making a plan. + evalOpts.SetVariables = lr.PlanOpts.SetVariables + } + // Before we can evaluate expressions, we must compute and populate any // derived values (input variables, local values, output values) // that are not stored in the persistent state. - scope, scopeDiags := ctx.Eval(addrs.RootModuleInstance) + scope, scopeDiags := lr.Core.Eval(lr.Config, lr.InputState, addrs.RootModuleInstance, evalOpts) diags = diags.Append(scopeDiags) if scope == nil { // scope is nil if there are errors so bad that we can't even build a scope. diff --git a/internal/command/graph.go b/internal/command/graph.go index 04a0ab46ccd4..87880a855732 100644 --- a/internal/command/graph.go +++ b/internal/command/graph.go @@ -4,12 +4,12 @@ import ( "fmt" "strings" - "github.com/hashicorp/terraform/internal/plans/planfile" - "github.com/hashicorp/terraform/internal/tfdiags" - "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/dag" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/plans/planfile" "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" ) // GraphCommand is a Command implementation that takes a Terraform @@ -103,35 +103,64 @@ func (c *GraphCommand) Run(args []string) int { } // Get the context - ctx, _, ctxDiags := local.Context(opReq) + lr, _, ctxDiags := local.LocalRun(opReq) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { c.showDiagnostics(diags) return 1 } - // Determine the graph type - graphType := terraform.GraphTypePlan - if planFile != nil { - graphType = terraform.GraphTypeApply + if graphTypeStr == "" { + switch { + case lr.Plan != nil: + graphTypeStr = "apply" + default: + graphTypeStr = "plan" + } } - if graphTypeStr != "" { - v, ok := terraform.GraphTypeMap[graphTypeStr] - if !ok { - c.Ui.Error(fmt.Sprintf("Invalid graph type requested: %s", graphTypeStr)) - return 1 + var g *terraform.Graph + var graphDiags tfdiags.Diagnostics + switch graphTypeStr { + case "plan": + g, graphDiags = lr.Core.PlanGraphForUI(lr.Config, lr.InputState, plans.NormalMode) + case "plan-refresh-only": + g, graphDiags = lr.Core.PlanGraphForUI(lr.Config, lr.InputState, plans.RefreshOnlyMode) + case "plan-destroy": + g, graphDiags = lr.Core.PlanGraphForUI(lr.Config, lr.InputState, plans.DestroyMode) + case "apply": + plan := lr.Plan + + // Historically "terraform graph" would allow the nonsensical request to + // render an apply graph without a plan, so we continue to support that + // here, though perhaps one day this should be an error. + if lr.Plan == nil { + plan = &plans.Plan{ + Changes: plans.NewChanges(), + UIMode: plans.NormalMode, + PriorState: lr.InputState, + PrevRunState: lr.InputState, + } } - graphType = v + g, graphDiags = lr.Core.ApplyGraphForUI(plan, lr.Config) + case "eval", "validate": + // Terraform v0.12 through v1.0 supported both of these, but the + // graph variants for "eval" and "validate" are purely implementation + // details and don't reveal anything (user-model-wise) that you can't + // see in the plan graph. + graphDiags = graphDiags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Graph type no longer available", + fmt.Sprintf("The graph type %q is no longer available. Use -type=plan instead to get a similar result.", graphTypeStr), + )) + default: + graphDiags = graphDiags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Unsupported graph type", + `The -type=... argument must be either "plan", "plan-refresh-only", "plan-destroy", or "apply".`, + )) } - - // Skip validation during graph generation - we want to see the graph even if - // it is invalid for some reason. - g, graphDiags := ctx.Graph(graphType, &terraform.ContextGraphOpts{ - Verbose: verbose, - Validate: false, - }) diags = diags.Append(graphDiags) if graphDiags.HasErrors() { c.showDiagnostics(diags) @@ -165,19 +194,13 @@ func (c *GraphCommand) Help() string { helpText := ` Usage: terraform [global options] graph [options] - Outputs the visual execution graph of Terraform resources according to - either the current configuration or an execution plan. + Produces a representation of the dependency graph between different + objects in the current configuration and state. - The graph is outputted in DOT format. The typical program that can + The graph is presented in the DOT language. The typical program that can read this format is GraphViz, but many web services are also available to read this format. - The -type flag can be used to control the type of graph shown. Terraform - creates different graphs for different operations. See the options below - for the list of types supported. The default type is "plan" if a - configuration is given, and "apply" if a plan file is passed as an - argument. - Options: -plan=tfplan Render graph using the specified plan file instead of the @@ -186,8 +209,9 @@ Options: -draw-cycles Highlight any cycles in the graph with colored edges. This helps when diagnosing cycle errors. - -type=plan Type of graph to output. Can be: plan, plan-destroy, apply, - validate, input, refresh. + -type=plan Type of graph to output. Can be: plan, plan-refresh-only, + plan-destroy, or apply. By default Terraform chooses + "plan", or "apply" if you also set the -plan=... option. -module-depth=n (deprecated) In prior versions of Terraform, specified the depth of modules to show in the output. diff --git a/internal/command/import.go b/internal/command/import.go index ec118b498bf6..7fc61a2f0c9d 100644 --- a/internal/command/import.go +++ b/internal/command/import.go @@ -212,7 +212,7 @@ func (c *ImportCommand) Run(args []string) int { } // Get the context - ctx, state, ctxDiags := local.Context(opReq) + lr, state, ctxDiags := local.LocalRun(opReq) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { c.showDiagnostics(diags) @@ -230,13 +230,18 @@ func (c *ImportCommand) Run(args []string) int { // Perform the import. Note that as you can see it is possible for this // API to import more than one resource at once. For now, we only allow // one while we stabilize this feature. - newState, importDiags := ctx.Import(&terraform.ImportOpts{ + newState, importDiags := lr.Core.Import(lr.Config, lr.InputState, &terraform.ImportOpts{ Targets: []*terraform.ImportTarget{ - &terraform.ImportTarget{ + { Addr: addr, ID: args[1], }, }, + + // The LocalRun idea is designed around our primary operations, so + // the input variables end up represented as plan options even though + // this particular operation isn't really a plan. + SetVariables: lr.PlanOpts.SetVariables, }) diags = diags.Append(importDiags) if diags.HasErrors() { diff --git a/internal/command/import_test.go b/internal/command/import_test.go index 28470dfc5bb0..bb56751e72ee 100644 --- a/internal/command/import_test.go +++ b/internal/command/import_test.go @@ -331,7 +331,7 @@ func TestImport_initializationErrorShouldUnlock(t *testing.T) { } // specifically, it should fail due to a missing provider - msg := ui.ErrorWriter.String() + msg := strings.ReplaceAll(ui.ErrorWriter.String(), "\n", " ") if want := `unknown provider "registry.terraform.io/hashicorp/unknown"`; !strings.Contains(msg, want) { t.Errorf("incorrect message\nwant substring: %s\ngot:\n%s", want, msg) } diff --git a/internal/command/meta.go b/internal/command/meta.go index cc4ff3b1a2fb..70d317779429 100644 --- a/internal/command/meta.go +++ b/internal/command/meta.go @@ -444,7 +444,6 @@ func (m *Meta) contextOpts() (*terraform.ContextOpts, error) { var opts terraform.ContextOpts - opts.Targets = m.targets opts.UIInput = m.UIInput() opts.Parallelism = m.parallelism diff --git a/internal/command/plan_test.go b/internal/command/plan_test.go index 84bf5f6ae84f..5638a9abfd3f 100644 --- a/internal/command/plan_test.go +++ b/internal/command/plan_test.go @@ -1051,7 +1051,7 @@ func TestPlan_init_required(t *testing.T) { t.Fatalf("expected error, got success") } got := output.Stderr() - if !strings.Contains(got, `Error: Could not load plugin`) { + if !strings.Contains(got, `Please run "terraform init".`) { t.Fatal("wrong error message in output:", got) } } diff --git a/internal/command/providers_schema.go b/internal/command/providers_schema.go index e2be06ca04b7..372564f12217 100644 --- a/internal/command/providers_schema.go +++ b/internal/command/providers_schema.go @@ -89,14 +89,20 @@ func (c *ProvidersSchemaCommand) Run(args []string) int { } // Get the context - ctx, _, ctxDiags := local.Context(opReq) + lr, _, ctxDiags := local.LocalRun(opReq) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { c.showDiagnostics(diags) return 1 } - schemas := ctx.Schemas() + schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } + jsonSchemas, err := jsonprovider.Marshal(schemas) if err != nil { c.Ui.Error(fmt.Sprintf("Failed to marshal provider schemas to json: %s", err)) diff --git a/internal/command/show.go b/internal/command/show.go index 7504a1973469..9886768cad91 100644 --- a/internal/command/show.go +++ b/internal/command/show.go @@ -101,7 +101,7 @@ func (c *ShowCommand) Run(args []string) int { } // Get the context - ctx, _, ctxDiags := local.Context(opReq) + lr, _, ctxDiags := local.LocalRun(opReq) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { c.showDiagnostics(diags) @@ -109,7 +109,12 @@ func (c *ShowCommand) Run(args []string) int { } // Get the schemas from the context - schemas := ctx.Schemas() + schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } var planErr, stateErr error var plan *plans.Plan @@ -148,7 +153,7 @@ func (c *ShowCommand) Run(args []string) int { if plan != nil { if jsonOutput { - config := ctx.Config() + config := lr.Config jsonPlan, err := jsonplan.Marshal(config, plan, stateFile, schemas) if err != nil { diff --git a/internal/command/state_show.go b/internal/command/state_show.go index 073548a09927..e95eca70fe66 100644 --- a/internal/command/state_show.go +++ b/internal/command/state_show.go @@ -82,14 +82,18 @@ func (c *StateShowCommand) Run(args []string) int { } // Get the context (required to get the schemas) - ctx, _, ctxDiags := local.Context(opReq) + lr, _, ctxDiags := local.LocalRun(opReq) if ctxDiags.HasErrors() { c.showDiagnostics(ctxDiags) return 1 } // Get the schemas from the context - schemas := ctx.Schemas() + schemas, diags := lr.Core.Schemas(lr.Config, lr.InputState) + if diags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } // Get the state env, err := c.Workspace() diff --git a/internal/command/test.go b/internal/command/test.go index 9c786f7050a0..eff291179a2c 100644 --- a/internal/command/test.go +++ b/internal/command/test.go @@ -495,7 +495,16 @@ func (c *TestCommand) testSuiteProviders(suiteDirs testCommandSuiteDirs, testPro return ret, diags } -func (c *TestCommand) testSuiteContext(suiteDirs testCommandSuiteDirs, providerFactories map[addrs.Provider]providers.Factory, state *states.State, plan *plans.Plan, destroy bool) (*terraform.Context, tfdiags.Diagnostics) { +type testSuiteRunContext struct { + Core *terraform.Context + + PlanMode plans.Mode + Config *configs.Config + InputState *states.State + Changes *plans.Changes +} + +func (c *TestCommand) testSuiteContext(suiteDirs testCommandSuiteDirs, providerFactories map[addrs.Provider]providers.Factory, state *states.State, plan *plans.Plan, destroy bool) (*testSuiteRunContext, tfdiags.Diagnostics) { var changes *plans.Changes if plan != nil { changes = plan.Changes @@ -506,8 +515,7 @@ func (c *TestCommand) testSuiteContext(suiteDirs testCommandSuiteDirs, providerF planMode = plans.DestroyMode } - return terraform.NewContext(&terraform.ContextOpts{ - Config: suiteDirs.Config, + tfCtx, diags := terraform.NewContext(&terraform.ContextOpts{ Providers: providerFactories, // We just use the provisioners from the main Meta here, because @@ -519,73 +527,83 @@ func (c *TestCommand) testSuiteContext(suiteDirs testCommandSuiteDirs, providerF Meta: &terraform.ContextMeta{ Env: "test_" + suiteDirs.SuiteName, }, - - State: state, - Changes: changes, - PlanMode: planMode, }) + if diags.HasErrors() { + return nil, diags + } + return &testSuiteRunContext{ + Core: tfCtx, + + PlanMode: planMode, + Config: suiteDirs.Config, + InputState: state, + Changes: changes, + }, diags } func (c *TestCommand) testSuitePlan(ctx context.Context, suiteDirs testCommandSuiteDirs, providerFactories map[addrs.Provider]providers.Factory) (*plans.Plan, tfdiags.Diagnostics) { log.Printf("[TRACE] terraform test: create plan for suite %q", suiteDirs.SuiteName) - tfCtx, diags := c.testSuiteContext(suiteDirs, providerFactories, nil, nil, false) + runCtx, diags := c.testSuiteContext(suiteDirs, providerFactories, nil, nil, false) if diags.HasErrors() { return nil, diags } - // We'll also validate as part of planning, since the "terraform plan" - // command would typically do that and so inconsistencies we detect only - // during planning typically produce error messages saying that they are - // a bug in Terraform. - // (It's safe to use the same context for both validate and plan, because - // validate doesn't generate any new sticky content inside the context - // as plan and apply both do.) - moreDiags := tfCtx.Validate() + // We'll also validate as part of planning, to ensure that the test + // configuration would pass "terraform validate". This is actually + // largely redundant with the runCtx.Core.Plan call below, but was + // included here originally because Plan did _originally_ assume that + // an earlier Validate had already passed, but now does its own + // validation work as (mostly) a superset of validate. + moreDiags := runCtx.Core.Validate(runCtx.Config) diags = diags.Append(moreDiags) if diags.HasErrors() { return nil, diags } - plan, moreDiags := tfCtx.Plan() + plan, moreDiags := runCtx.Core.Plan( + runCtx.Config, runCtx.InputState, &terraform.PlanOpts{Mode: runCtx.PlanMode}, + ) diags = diags.Append(moreDiags) return plan, diags } func (c *TestCommand) testSuiteApply(ctx context.Context, plan *plans.Plan, suiteDirs testCommandSuiteDirs, providerFactories map[addrs.Provider]providers.Factory) (*states.State, tfdiags.Diagnostics) { log.Printf("[TRACE] terraform test: apply plan for suite %q", suiteDirs.SuiteName) - tfCtx, diags := c.testSuiteContext(suiteDirs, providerFactories, nil, plan, false) + runCtx, diags := c.testSuiteContext(suiteDirs, providerFactories, nil, plan, false) if diags.HasErrors() { // To make things easier on the caller, we'll return a valid empty // state even in this case. return states.NewState(), diags } - state, moreDiags := tfCtx.Apply() + state, moreDiags := runCtx.Core.Apply(plan, runCtx.Config) diags = diags.Append(moreDiags) return state, diags } func (c *TestCommand) testSuiteDestroy(ctx context.Context, state *states.State, suiteDirs testCommandSuiteDirs, providerFactories map[addrs.Provider]providers.Factory) (*states.State, tfdiags.Diagnostics) { log.Printf("[TRACE] terraform test: plan to destroy any existing objects for suite %q", suiteDirs.SuiteName) - tfCtx, diags := c.testSuiteContext(suiteDirs, providerFactories, state, nil, true) + runCtx, diags := c.testSuiteContext(suiteDirs, providerFactories, state, nil, true) if diags.HasErrors() { return state, diags } - plan, moreDiags := tfCtx.Plan() + plan, moreDiags := runCtx.Core.Plan( + runCtx.Config, runCtx.InputState, &terraform.PlanOpts{Mode: runCtx.PlanMode}, + ) diags = diags.Append(moreDiags) if diags.HasErrors() { return state, diags } log.Printf("[TRACE] terraform test: apply the plan to destroy any existing objects for suite %q", suiteDirs.SuiteName) - tfCtx, moreDiags = c.testSuiteContext(suiteDirs, providerFactories, state, plan, true) + runCtx, moreDiags = c.testSuiteContext(suiteDirs, providerFactories, state, plan, true) diags = diags.Append(moreDiags) if diags.HasErrors() { return state, diags } - state, moreDiags = tfCtx.Apply() + state, moreDiags = runCtx.Core.Apply(plan, runCtx.Config) diags = diags.Append(moreDiags) return state, diags } diff --git a/internal/command/validate.go b/internal/command/validate.go index 7801ffd718ee..110fcec8c32e 100644 --- a/internal/command/validate.go +++ b/internal/command/validate.go @@ -5,8 +5,6 @@ import ( "path/filepath" "strings" - "github.com/zclconf/go-cty/cty" - "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/terraform" @@ -73,31 +71,11 @@ func (c *ValidateCommand) validate(dir string) tfdiags.Diagnostics { return diags } - // "validate" is to check if the given module is valid regardless of - // input values, current state, etc. Therefore we populate all of the - // input values with unknown values of the expected type, allowing us - // to perform a type check without assuming any particular values. - varValues := make(terraform.InputValues) - for name, variable := range cfg.Module.Variables { - ty := variable.Type - if ty == cty.NilType { - // Can't predict the type at all, so we'll just mark it as - // cty.DynamicVal (unknown value of cty.DynamicPseudoType). - ty = cty.DynamicPseudoType - } - varValues[name] = &terraform.InputValue{ - Value: cty.UnknownVal(ty), - SourceType: terraform.ValueFromCLIArg, - } - } - opts, err := c.contextOpts() if err != nil { diags = diags.Append(err) return diags } - opts.Config = cfg - opts.Variables = varValues tfCtx, ctxDiags := terraform.NewContext(opts) diags = diags.Append(ctxDiags) @@ -105,7 +83,7 @@ func (c *ValidateCommand) validate(dir string) tfdiags.Diagnostics { return diags } - validateDiags := tfCtx.Validate() + validateDiags := tfCtx.Validate(cfg) diags = diags.Append(validateDiags) return diags } diff --git a/internal/repl/session_test.go b/internal/repl/session_test.go index 9eb73f5e5f85..7110324e1ecc 100644 --- a/internal/repl/session_test.go +++ b/internal/repl/session_test.go @@ -204,17 +204,19 @@ func testSession(t *testing.T, test testSessionTest) { // Build the TF context ctx, diags := terraform.NewContext(&terraform.ContextOpts{ - State: test.State, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): providers.FactoryFixed(p), }, - Config: config, }) if diags.HasErrors() { t.Fatalf("failed to create context: %s", diags.Err()) } - scope, diags := ctx.Eval(addrs.RootModuleInstance) + state := test.State + if state == nil { + state = states.NewState() + } + scope, diags := ctx.Eval(config, state, addrs.RootModuleInstance, &terraform.EvalOpts{}) if diags.HasErrors() { t.Fatalf("failed to create scope: %s", diags.Err()) } diff --git a/internal/states/sync.go b/internal/states/sync.go index 286eae965593..c70714f9df49 100644 --- a/internal/states/sync.go +++ b/internal/states/sync.go @@ -533,6 +533,16 @@ func (s *SyncState) Unlock() { s.lock.Unlock() } +// Close extracts the underlying state from inside this wrapper, making the +// wrapper invalid for any future operations. +func (s *SyncState) Close() *State { + s.lock.Lock() + ret := s.state + s.state = nil // make sure future operations can't still modify it + s.lock.Unlock() + return ret +} + // maybePruneModule will remove a module from the state altogether if it is // empty, unless it's the root module which must always be present. // diff --git a/internal/terraform/context.go b/internal/terraform/context.go index 4e96fd25e750..abb20528a448 100644 --- a/internal/terraform/context.go +++ b/internal/terraform/context.go @@ -10,12 +10,8 @@ import ( "github.com/apparentlymart/go-versions/versions" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" - "github.com/hashicorp/terraform/internal/instances" - "github.com/hashicorp/terraform/internal/lang" - "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" - "github.com/hashicorp/terraform/internal/refactoring" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" @@ -41,16 +37,7 @@ const ( // ContextOpts are the user-configurable options to create a context with // NewContext. type ContextOpts struct { - Config *configs.Config - Changes *plans.Changes - State *states.State - Targets []addrs.Targetable - ForceReplace []addrs.AbsResourceInstance - Variables InputValues Meta *ContextMeta - PlanMode plans.Mode - SkipRefresh bool - Hooks []Hook Parallelism int Providers map[addrs.Provider]providers.Factory @@ -96,58 +83,18 @@ type ContextMeta struct { // perform operations on infrastructure. This structure is built using // NewContext. type Context struct { - config *configs.Config - changes *plans.Changes - skipRefresh bool - targets []addrs.Targetable - forceReplace []addrs.AbsResourceInstance - variables InputValues - meta *ContextMeta - planMode plans.Mode - - // state, refreshState, and prevRunState simultaneously track three - // different incarnations of the Terraform state: - // - // "state" is always the most "up-to-date". During planning it represents - // our best approximation of the planned new state, and during applying - // it represents the results of all of the actions we've taken so far. - // - // "refreshState" is populated and relevant only during planning, where we - // update it to reflect a provider's sense of the current state of the - // remote object each resource instance is bound to but don't include - // any changes implied by the configuration. - // - // "prevRunState" is similar to refreshState except that it doesn't even - // include the result of the provider's refresh step, and instead reflects - // the state as we found it prior to any changes, although it does reflect - // the result of running the provider's schema upgrade actions so that the - // resource instance objects will all conform to the _current_ resource - // type schemas if planning is successful, so that in that case it will - // be meaningful to compare prevRunState to refreshState to detect changes - // made outside of Terraform. - state *states.State - refreshState *states.State - prevRunState *states.State + // meta captures some misc. information about the working directory where + // we're taking these actions, and thus which should remain steady between + // operations. + meta *ContextMeta - // NOTE: If you're considering adding something new here, consider first - // whether it'd work to add it to type graphWalkOpts instead, possibly by - // adding new arguments to one of the exported operation methods, to scope - // it only to a particular operation rather than having it survive from one - // operation to the next as global mutable state. - // - // Historically we used fields here as a bit of a dumping ground for - // data that needed to ambiently pass between methods of Context, but - // that has tended to cause surprising misbehavior when data from one - // walk inadvertently bleeds into another walk against the same context. - // Perhaps one day we'll move changes, state, refreshState, and prevRunState - // to graphWalkOpts too. Ideally there shouldn't be anything in here which - // changes after NewContext returns. + components contextComponentFactory + dependencyLocks *depsfile.Locks + providersInDevelopment map[addrs.Provider]struct{} - hooks []Hook - components contextComponentFactory - schemas *Schemas - sh *stopHook - uiInput UIInput + hooks []Hook + sh *stopHook + uiInput UIInput l sync.Mutex // Lock acquired during any task parallelSem Semaphore @@ -168,14 +115,9 @@ type Context struct { // If the returned diagnostics contains errors then the resulting context is // invalid and must not be used. func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + log.Printf("[TRACE] terraform.NewContext: starting") - diags := CheckCoreVersionRequirements(opts.Config) - // If version constraints are not met then we'll bail early since otherwise - // we're likely to just see a bunch of other errors related to - // incompatibilities, which could be overwhelming for the user. - if diags.HasErrors() { - return nil, diags - } // Copy all the hooks and add our stop hook. We don't append directly // to the Config so that we're not modifying that in-place. @@ -184,11 +126,6 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { copy(hooks, opts.Hooks) hooks[len(opts.Hooks)] = sh - state := opts.State - if state == nil { - state = states.NewState() - } - // Determine parallelism, default to 10. We do this both to limit // CPU pressure but also to have an extra guard against rate throttling // from providers. @@ -207,55 +144,47 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { par = 10 } - // Set up the variables in the following sequence: - // 0 - Take default values from the configuration - // 1 - Take values from TF_VAR_x environment variables - // 2 - Take values specified in -var flags, overriding values - // set by environment variables if necessary. This includes - // values taken from -var-file in addition. - var variables InputValues - if opts.Config != nil { - // Default variables from the configuration seed our map. - variables = DefaultVariableValues(opts.Config.Module.Variables) - } - // Variables provided by the caller (from CLI, environment, etc) can - // override the defaults. - variables = variables.Override(opts.Variables) - components := &basicComponentFactory{ providers: opts.Providers, provisioners: opts.Provisioners, } - log.Printf("[TRACE] terraform.NewContext: loading provider schemas") - schemas, err := LoadSchemas(opts.Config, opts.State, components) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Could not load plugin", - fmt.Sprintf(errPluginInit, err), - )) - return nil, diags - } + log.Printf("[TRACE] terraform.NewContext: complete") - changes := opts.Changes - if changes == nil { - changes = plans.NewChanges() - } + return &Context{ + hooks: hooks, + meta: opts.Meta, + uiInput: opts.UIInput, - config := opts.Config - if config == nil { - config = configs.NewEmptyConfig() - } + components: components, + dependencyLocks: opts.LockedDependencies, + providersInDevelopment: opts.ProvidersInDevelopment, + + parallelSem: NewSemaphore(par), + providerInputConfig: make(map[string]map[string]cty.Value), + providerSHA256s: opts.ProviderSHA256s, + sh: sh, + }, diags +} + +func (c *Context) Schemas(config *configs.Config, state *states.State) (*Schemas, tfdiags.Diagnostics) { + // TODO: This method gets called multiple times on the same context with + // the same inputs by different parts of Terraform that all need the + // schemas, and it's typically quite expensive because it has to spin up + // plugins to gather their schemas, so it'd be good to have some caching + // here to remember plugin schemas we already loaded since the plugin + // selections can't change during the life of a *Context object. + + var diags tfdiags.Diagnostics // If we have a configuration and a set of locked dependencies, verify that // the provider requirements from the configuration can be satisfied by the // locked dependencies. - if opts.LockedDependencies != nil { + if c.dependencyLocks != nil && config != nil { reqs, providerDiags := config.ProviderRequirements() diags = diags.Append(providerDiags) - locked := opts.LockedDependencies.AllProviders() + locked := c.dependencyLocks.AllProviders() unmetReqs := make(getproviders.Requirements) for provider, versionConstraints := range reqs { // Builtin providers are not listed in the locks file @@ -263,7 +192,7 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { continue } // Development providers must be excluded from this check - if _, ok := opts.ProvidersInDevelopment[provider]; ok { + if _, ok := c.providersInDevelopment[provider]; ok { continue } // If the required provider doesn't exist in the lock, or the @@ -292,81 +221,16 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { } } - switch opts.PlanMode { - case plans.NormalMode, plans.DestroyMode: - // OK - case plans.RefreshOnlyMode: - if opts.SkipRefresh { - // The CLI layer (and other similar callers) should prevent this - // combination of options. - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Incompatible plan options", - "Cannot skip refreshing in refresh-only mode. This is a bug in Terraform.", - )) - return nil, diags - } - default: - // The CLI layer (and other similar callers) should not try to - // create a context for a mode that Terraform Core doesn't support. - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Unsupported plan mode", - fmt.Sprintf("Terraform Core doesn't know how to handle plan mode %s. This is a bug in Terraform.", opts.PlanMode), - )) - return nil, diags - } - if len(opts.ForceReplace) > 0 && opts.PlanMode != plans.NormalMode { - // The other modes don't generate no-op or update actions that we might - // upgrade to be "replace", so doesn't make sense to combine those. + ret, err := LoadSchemas(config, state, c.components) + if err != nil { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Unsupported plan mode", - fmt.Sprintf("Forcing resource instance replacement (with -replace=...) is allowed only in normal planning mode."), + "Failed to load plugin schemas", + fmt.Sprintf("Error while loading schemas for plugin components: %s.", err), )) return nil, diags } - - log.Printf("[TRACE] terraform.NewContext: complete") - - // By the time we get here, we should have values defined for all of - // the root module variables, even if some of them are "unknown". It's the - // caller's responsibility to have already handled the decoding of these - // from the various ways the CLI allows them to be set and to produce - // user-friendly error messages if they are not all present, and so - // the error message from checkInputVariables should never be seen and - // includes language asking the user to report a bug. - if config != nil { - varDiags := checkInputVariables(config.Module.Variables, variables) - diags = diags.Append(varDiags) - } - - return &Context{ - components: components, - schemas: schemas, - planMode: opts.PlanMode, - changes: changes, - hooks: hooks, - meta: opts.Meta, - config: config, - state: state, - refreshState: state.DeepCopy(), - prevRunState: state.DeepCopy(), - skipRefresh: opts.SkipRefresh, - targets: opts.Targets, - forceReplace: opts.ForceReplace, - uiInput: opts.UIInput, - variables: variables, - - parallelSem: NewSemaphore(par), - providerInputConfig: make(map[string]map[string]cty.Value), - providerSHA256s: opts.ProviderSHA256s, - sh: sh, - }, diags -} - -func (c *Context) Schemas() *Schemas { - return c.schemas + return ret, diags } type ContextGraphOpts struct { @@ -377,510 +241,6 @@ type ContextGraphOpts struct { Verbose bool } -// Graph returns the graph used for the given operation type. -// -// The most extensive or complex graph type is GraphTypePlan. -func (c *Context) Graph(typ GraphType, opts *ContextGraphOpts) (*Graph, tfdiags.Diagnostics) { - if opts == nil { - opts = &ContextGraphOpts{Validate: true} - } - - log.Printf("[INFO] terraform: building graph: %s", typ) - switch typ { - case GraphTypeApply: - return (&ApplyGraphBuilder{ - Config: c.config, - Changes: c.changes, - State: c.state, - Components: c.components, - Schemas: c.schemas, - Targets: c.targets, - ForceReplace: c.forceReplace, - Validate: opts.Validate, - }).Build(addrs.RootModuleInstance) - - case GraphTypeValidate: - // The validate graph is just a slightly modified plan graph: an empty - // state is substituted in for Validate. - return ValidateGraphBuilder(&PlanGraphBuilder{ - Config: c.config, - Components: c.components, - Schemas: c.schemas, - Targets: c.targets, - Validate: opts.Validate, - State: states.NewState(), - }).Build(addrs.RootModuleInstance) - - case GraphTypePlan: - // Create the plan graph builder - return (&PlanGraphBuilder{ - Config: c.config, - State: c.state, - Components: c.components, - Schemas: c.schemas, - Targets: c.targets, - ForceReplace: c.forceReplace, - Validate: opts.Validate, - skipRefresh: c.skipRefresh, - }).Build(addrs.RootModuleInstance) - - case GraphTypePlanDestroy: - return (&DestroyPlanGraphBuilder{ - Config: c.config, - State: c.state, - Components: c.components, - Schemas: c.schemas, - Targets: c.targets, - Validate: opts.Validate, - skipRefresh: c.skipRefresh, - }).Build(addrs.RootModuleInstance) - - case GraphTypePlanRefreshOnly: - // Create the plan graph builder, with skipPlanChanges set to - // activate the "refresh only" mode. - return (&PlanGraphBuilder{ - Config: c.config, - State: c.state, - Components: c.components, - Schemas: c.schemas, - Targets: c.targets, - Validate: opts.Validate, - skipRefresh: c.skipRefresh, - skipPlanChanges: true, // this activates "refresh only" mode. - }).Build(addrs.RootModuleInstance) - - case GraphTypeEval: - return (&EvalGraphBuilder{ - Config: c.config, - State: c.state, - Components: c.components, - Schemas: c.schemas, - }).Build(addrs.RootModuleInstance) - - default: - // Should never happen, because the above is exhaustive for all graph types. - panic(fmt.Errorf("unsupported graph type %s", typ)) - } -} - -// State returns a copy of the current state associated with this context. -// -// This cannot safely be called in parallel with any other Context function. -func (c *Context) State() *states.State { - return c.state.DeepCopy() -} - -// Eval produces a scope in which expressions can be evaluated for -// the given module path. -// -// This method must first evaluate any ephemeral values (input variables, local -// values, and output values) in the configuration. These ephemeral values are -// not included in the persisted state, so they must be re-computed using other -// values in the state before they can be properly evaluated. The updated -// values are retained in the main state associated with the receiving context. -// -// This function takes no action against remote APIs but it does need access -// to all provider and provisioner instances in order to obtain their schemas -// for type checking. -// -// The result is an evaluation scope that can be used to resolve references -// against the root module. If the returned diagnostics contains errors then -// the returned scope may be nil. If it is not nil then it may still be used -// to attempt expression evaluation or other analysis, but some expressions -// may not behave as expected. -func (c *Context) Eval(path addrs.ModuleInstance) (*lang.Scope, tfdiags.Diagnostics) { - // This is intended for external callers such as the "terraform console" - // command. Internally, we create an evaluator in c.walk before walking - // the graph, and create scopes in ContextGraphWalker. - - var diags tfdiags.Diagnostics - defer c.acquireRun("eval")() - - // Start with a copy of state so that we don't affect any instances - // that other methods may have already returned. - c.state = c.state.DeepCopy() - var walker *ContextGraphWalker - - graph, graphDiags := c.Graph(GraphTypeEval, nil) - diags = diags.Append(graphDiags) - if !diags.HasErrors() { - var walkDiags tfdiags.Diagnostics - walker, walkDiags = c.walk(graph, walkEval, &graphWalkOpts{}) - diags = diags.Append(walker.NonFatalDiagnostics) - diags = diags.Append(walkDiags) - } - - if walker == nil { - // If we skipped walking the graph (due to errors) then we'll just - // use a placeholder graph walker here, which'll refer to the - // unmodified state. - walker = c.graphWalker(walkEval, &graphWalkOpts{}) - } - - // This is a bit weird since we don't normally evaluate outside of - // the context of a walk, but we'll "re-enter" our desired path here - // just to get hold of an EvalContext for it. GraphContextBuiltin - // caches its contexts, so we should get hold of the context that was - // previously used for evaluation here, unless we skipped walking. - evalCtx := walker.EnterPath(path) - return evalCtx.EvaluationScope(nil, EvalDataForNoInstanceKey), diags -} - -// Apply applies the changes represented by this context and returns -// the resulting state. -// -// Even in the case an error is returned, the state may be returned and will -// potentially be partially updated. In addition to returning the resulting -// state, this context is updated with the latest state. -// -// If the state is required after an error, the caller should call -// Context.State, rather than rely on the return value. -// -// TODO: Apply and Refresh should either always return a state, or rely on the -// State() method. Currently the helper/resource testing framework relies -// on the absence of a returned state to determine if Destroy can be -// called, so that will need to be refactored before this can be changed. -func (c *Context) Apply() (*states.State, tfdiags.Diagnostics) { - defer c.acquireRun("apply")() - - // Copy our own state - c.state = c.state.DeepCopy() - - // Build the graph. - graph, diags := c.Graph(GraphTypeApply, nil) - if diags.HasErrors() { - return nil, diags - } - - // Determine the operation - operation := walkApply - if c.planMode == plans.DestroyMode { - operation = walkDestroy - } - - // Walk the graph - walker, walkDiags := c.walk(graph, operation, &graphWalkOpts{}) - diags = diags.Append(walker.NonFatalDiagnostics) - diags = diags.Append(walkDiags) - - if c.planMode == plans.DestroyMode && !diags.HasErrors() { - // If we know we were trying to destroy objects anyway, and we - // completed without any errors, then we'll also prune out any - // leftover empty resource husks (left after all of the instances - // of a resource with "count" or "for_each" are destroyed) to - // help ensure we end up with an _actually_ empty state, assuming - // we weren't destroying with -target here. - // - // (This doesn't actually take into account -target, but that should - // be okay because it doesn't throw away anything we can't recompute - // on a subsequent "terraform plan" run, if the resources are still - // present in the configuration. However, this _will_ cause "count = 0" - // resources to read as unknown during the next refresh walk, which - // may cause some additional churn if used in a data resource or - // provider block, until we remove refreshing as a separate walk and - // just do it as part of the plan walk.) - c.state.PruneResourceHusks() - } - - if len(c.targets) > 0 { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Warning, - "Applied changes may be incomplete", - `The plan was created with the -target option in effect, so some changes requested in the configuration may have been ignored and the output values may not be fully updated. Run the following command to verify that no other changes are pending: - terraform plan - -Note that the -target option is not suitable for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, - )) - } - - // This isn't technically needed, but don't leave an old refreshed state - // around in case we re-use the context in internal tests. - c.refreshState = c.state.DeepCopy() - - return c.state, diags -} - -// Plan generates an execution plan for the given context, and returns the -// refreshed state. -// -// The execution plan encapsulates the context and can be stored -// in order to reinstantiate a context later for Apply. -// -// Plan also updates the diff of this context to be the diff generated -// by the plan, so Apply can be called after. -func (c *Context) Plan() (*plans.Plan, tfdiags.Diagnostics) { - defer c.acquireRun("plan")() - c.changes = plans.NewChanges() - var diags tfdiags.Diagnostics - - if len(c.targets) > 0 { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Warning, - "Resource targeting is in effect", - `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. - -The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, - )) - } - - var plan *plans.Plan - var planDiags tfdiags.Diagnostics - switch c.planMode { - case plans.NormalMode: - plan, planDiags = c.plan() - case plans.DestroyMode: - plan, planDiags = c.destroyPlan() - case plans.RefreshOnlyMode: - plan, planDiags = c.refreshOnlyPlan() - default: - panic(fmt.Sprintf("unsupported plan mode %s", c.planMode)) - } - diags = diags.Append(planDiags) - if diags.HasErrors() { - return nil, diags - } - - // convert the variables into the format expected for the plan - varVals := make(map[string]plans.DynamicValue, len(c.variables)) - for k, iv := range c.variables { - // We use cty.DynamicPseudoType here so that we'll save both the - // value _and_ its dynamic type in the plan, so we can recover - // exactly the same value later. - dv, err := plans.NewDynamicValue(iv.Value, cty.DynamicPseudoType) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Failed to prepare variable value for plan", - fmt.Sprintf("The value for variable %q could not be serialized to store in the plan: %s.", k, err), - )) - continue - } - varVals[k] = dv - } - - // insert the run-specific data from the context into the plan; variables, - // targets and provider SHAs. - plan.VariableValues = varVals - plan.TargetAddrs = c.targets - plan.ProviderSHA256s = c.providerSHA256s - - return plan, diags -} - -func (c *Context) plan() (*plans.Plan, tfdiags.Diagnostics) { - var diags tfdiags.Diagnostics - - moveStmts, moveResults := c.prePlanFindAndApplyMoves() - - graph, graphDiags := c.Graph(GraphTypePlan, nil) - diags = diags.Append(graphDiags) - if graphDiags.HasErrors() { - return nil, diags - } - - // Do the walk - walker, walkDiags := c.walk(graph, walkPlan, &graphWalkOpts{ - MoveResults: moveResults, - }) - diags = diags.Append(walker.NonFatalDiagnostics) - diags = diags.Append(walkDiags) - if walkDiags.HasErrors() { - return nil, diags - } - plan := &plans.Plan{ - UIMode: plans.NormalMode, - Changes: c.changes, - ForceReplaceAddrs: c.forceReplace, - PrevRunState: c.prevRunState.DeepCopy(), - } - - c.refreshState.SyncWrapper().RemovePlannedResourceInstanceObjects() - - refreshedState := c.refreshState.DeepCopy() - plan.PriorState = refreshedState - - // replace the working state with the updated state, so that immediate calls - // to Apply work as expected. - c.state = refreshedState - - // TODO: Record the move results in the plan - diags = diags.Append(c.postPlanValidateMoves(moveStmts, walker.InstanceExpander.AllInstances())) - - return plan, diags -} - -func (c *Context) destroyPlan() (*plans.Plan, tfdiags.Diagnostics) { - var diags tfdiags.Diagnostics - destroyPlan := &plans.Plan{ - PriorState: c.state.DeepCopy(), - } - c.changes = plans.NewChanges() - - moveStmts, moveResults := c.prePlanFindAndApplyMoves() - - // A destroy plan starts by running Refresh to read any pending data - // sources, and remove missing managed resources. This is required because - // a "destroy plan" is only creating delete changes, and is essentially a - // local operation. - // - // NOTE: if skipRefresh _is_ set then we'll rely on the destroy-plan walk - // below to upgrade the prevRunState and priorState both to the latest - // resource type schemas, so NodePlanDestroyableResourceInstance.Execute - // must coordinate with this by taking that action only when c.skipRefresh - // _is_ set. This coupling between the two is unfortunate but necessary - // to work within our current structure. - if !c.skipRefresh { - refreshPlan, refreshDiags := c.plan() - diags = diags.Append(refreshDiags) - if diags.HasErrors() { - return nil, diags - } - - // insert the refreshed state into the destroy plan result, and discard - // the changes recorded from the refresh. - destroyPlan.PriorState = refreshPlan.PriorState.DeepCopy() - destroyPlan.PrevRunState = refreshPlan.PrevRunState.DeepCopy() - c.changes = plans.NewChanges() - } - - graph, graphDiags := c.Graph(GraphTypePlanDestroy, nil) - diags = diags.Append(graphDiags) - if graphDiags.HasErrors() { - return nil, diags - } - - // Do the walk - walker, walkDiags := c.walk(graph, walkPlanDestroy, &graphWalkOpts{ - MoveResults: moveResults, - }) - diags = diags.Append(walker.NonFatalDiagnostics) - diags = diags.Append(walkDiags) - if walkDiags.HasErrors() { - return nil, diags - } - - if c.skipRefresh { - // If we didn't do refreshing then both the previous run state and - // the prior state are the result of upgrading the previous run state, - // which we should've upgraded as part of the plan-destroy walk - // in NodePlanDestroyableResourceInstance.Execute, so they'll have the - // current schema but neither will reflect any out-of-band changes in - // the remote system. - destroyPlan.PrevRunState = c.prevRunState.DeepCopy() - destroyPlan.PriorState = c.prevRunState.DeepCopy() - } - - destroyPlan.UIMode = plans.DestroyMode - destroyPlan.Changes = c.changes - - // TODO: Record the move results in the plan - diags = diags.Append(c.postPlanValidateMoves(moveStmts, walker.InstanceExpander.AllInstances())) - - return destroyPlan, diags -} - -func (c *Context) refreshOnlyPlan() (*plans.Plan, tfdiags.Diagnostics) { - var diags tfdiags.Diagnostics - - moveStmts, moveResults := c.prePlanFindAndApplyMoves() - - graph, graphDiags := c.Graph(GraphTypePlanRefreshOnly, nil) - diags = diags.Append(graphDiags) - if graphDiags.HasErrors() { - return nil, diags - } - - // Do the walk - walker, walkDiags := c.walk(graph, walkPlan, &graphWalkOpts{ - MoveResults: moveResults, - }) - diags = diags.Append(walker.NonFatalDiagnostics) - diags = diags.Append(walkDiags) - if walkDiags.HasErrors() { - return nil, diags - } - plan := &plans.Plan{ - UIMode: plans.RefreshOnlyMode, - Changes: c.changes, - PrevRunState: c.prevRunState.DeepCopy(), - } - - // If the graph builder and graph nodes correctly obeyed our directive - // to refresh only, the set of resource changes should always be empty. - // We'll safety-check that here so we can return a clear message about it, - // rather than probably just generating confusing output at the UI layer. - if len(plan.Changes.Resources) != 0 { - // Some extra context in the logs in case the user reports this message - // as a bug, as a starting point for debugging. - for _, rc := range plan.Changes.Resources { - if depKey := rc.DeposedKey; depKey == states.NotDeposed { - log.Printf("[DEBUG] Refresh-only plan includes %s change for %s", rc.Action, rc.Addr) - } else { - log.Printf("[DEBUG] Refresh-only plan includes %s change for %s deposed object %s", rc.Action, rc.Addr, depKey) - } - } - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid refresh-only plan", - "Terraform generated planned resource changes in a refresh-only plan. This is a bug in Terraform.", - )) - } - - c.refreshState.SyncWrapper().RemovePlannedResourceInstanceObjects() - - refreshedState := c.refreshState - plan.PriorState = refreshedState.DeepCopy() - - // replace the working state with the updated state, so that immediate calls - // to Apply work as expected. DeepCopy because such an apply should not - // mutate - c.state = refreshedState - - // TODO: Record the move results in the plan - diags = diags.Append(c.postPlanValidateMoves(moveStmts, walker.InstanceExpander.AllInstances())) - - return plan, diags -} - -func (c *Context) prePlanFindAndApplyMoves() ([]refactoring.MoveStatement, map[addrs.UniqueKey]refactoring.MoveResult) { - moveStmts := refactoring.FindMoveStatements(c.config) - moveResults := refactoring.ApplyMoves(moveStmts, c.prevRunState) - if len(c.targets) > 0 { - for _, result := range moveResults { - matchesTarget := false - for _, targetAddr := range c.targets { - if targetAddr.TargetContains(result.From) { - matchesTarget = true - break - } - } - if !matchesTarget { - // TODO: Return an error stating that a targeted plan is - // only valid if it includes this address that was moved. - } - } - } - return moveStmts, moveResults -} - -func (c *Context) postPlanValidateMoves(stmts []refactoring.MoveStatement, allInsts instances.Set) tfdiags.Diagnostics { - return refactoring.ValidateMoves(stmts, c.config, allInsts) -} - -// Refresh goes through all the resources in the state and refreshes them -// to their latest state. This is done by executing a plan, and retaining the -// state while discarding the change set. -// -// In the case of an error, there is no state returned. -func (c *Context) Refresh() (*states.State, tfdiags.Diagnostics) { - p, diags := c.Plan() - if diags.HasErrors() { - return nil, diags - } - - return p.PriorState, diags -} - // Stop stops the running task. // // Stop will block until the task completes. @@ -911,63 +271,6 @@ func (c *Context) Stop() { log.Printf("[WARN] terraform: stop complete") } -// Validate performs semantic validation of the configuration, and returning -// any warnings or errors. -// -// Syntax and structural checks are performed by the configuration loader, -// and so are not repeated here. -func (c *Context) Validate() tfdiags.Diagnostics { - defer c.acquireRun("validate")() - - var diags tfdiags.Diagnostics - - // If we have errors at this point then we probably won't be able to - // construct a graph without producing redundant errors, so we'll halt early. - if diags.HasErrors() { - return diags - } - - // Build the graph so we can walk it and run Validate on nodes. - // We also validate the graph generated here, but this graph doesn't - // necessarily match the graph that Plan will generate, so we'll validate the - // graph again later after Planning. - graph, graphDiags := c.Graph(GraphTypeValidate, nil) - diags = diags.Append(graphDiags) - if graphDiags.HasErrors() { - return diags - } - - // Walk - walker, walkDiags := c.walk(graph, walkValidate, &graphWalkOpts{}) - diags = diags.Append(walker.NonFatalDiagnostics) - diags = diags.Append(walkDiags) - if walkDiags.HasErrors() { - return diags - } - - return diags -} - -// Config returns the configuration tree associated with this context. -func (c *Context) Config() *configs.Config { - return c.config -} - -// Variables will return the mapping of variables that were defined -// for this Context. If Input was called, this mapping may be different -// than what was given. -func (c *Context) Variables() InputValues { - return c.variables -} - -// SetVariable sets a variable after a context has already been built. -func (c *Context) SetVariable(k string, v cty.Value) { - c.variables[k] = &InputValue{ - Value: v, - SourceType: ValueFromCaller, - } -} - func (c *Context) acquireRun(phase string) func() { // With the run lock held, grab the context lock to make changes // to the run context. @@ -1011,70 +314,6 @@ func (c *Context) releaseRun() { c.runContext = nil } -// graphWalkOpts is an assortment of options and inputs we need when -// constructing a graph walker. -type graphWalkOpts struct { - // MoveResults is a table of the results of applying move statements prior - // to a plan walk. Irrelevant and totally ignored for non-plan walks. - MoveResults map[addrs.UniqueKey]refactoring.MoveResult -} - -func (c *Context) walk(graph *Graph, operation walkOperation, opts *graphWalkOpts) (*ContextGraphWalker, tfdiags.Diagnostics) { - log.Printf("[DEBUG] Starting graph walk: %s", operation.String()) - - walker := c.graphWalker(operation, opts) - - // Watch for a stop so we can call the provider Stop() API. - watchStop, watchWait := c.watchStop(walker) - - // Walk the real graph, this will block until it completes - diags := graph.Walk(walker) - - // Close the channel so the watcher stops, and wait for it to return. - close(watchStop) - <-watchWait - - return walker, diags -} - -func (c *Context) graphWalker(operation walkOperation, opts *graphWalkOpts) *ContextGraphWalker { - var state *states.SyncState - var refreshState *states.SyncState - var prevRunState *states.SyncState - - switch operation { - case walkValidate: - // validate should not use any state - state = states.NewState().SyncWrapper() - - // validate currently uses the plan graph, so we have to populate the - // refreshState and the prevRunState. - refreshState = states.NewState().SyncWrapper() - prevRunState = states.NewState().SyncWrapper() - - case walkPlan, walkPlanDestroy: - state = c.state.SyncWrapper() - refreshState = c.refreshState.SyncWrapper() - prevRunState = c.prevRunState.SyncWrapper() - - default: - state = c.state.SyncWrapper() - } - - return &ContextGraphWalker{ - Context: c, - State: state, - RefreshState: refreshState, - PrevRunState: prevRunState, - Changes: c.changes.SyncWrapper(), - InstanceExpander: instances.NewExpander(), - MoveResults: opts.MoveResults, - Operation: operation, - StopContext: c.runContext, - RootVariableValues: c.variables, - } -} - // watchStop immediately returns a `stop` and a `wait` chan after dispatching // the watchStop goroutine. This will watch the runContext for cancellation and // stop the providers accordingly. When the watch is no longer needed, the diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go new file mode 100644 index 000000000000..4ba7e8dc0eb9 --- /dev/null +++ b/internal/terraform/context_apply.go @@ -0,0 +1,142 @@ +package terraform + +import ( + "fmt" + "log" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/zclconf/go-cty/cty" +) + +// Apply performs the actions described by the given Plan object and returns +// the resulting updated state. +// +// The given configuration *must* be the same configuration that was passed +// earlier to Context.Plan in order to create this plan. +// +// Even if the returned diagnostics contains errors, Apply always returns the +// resulting state which is likely to have been partially-updated. +func (c *Context) Apply(plan *plans.Plan, config *configs.Config) (*states.State, tfdiags.Diagnostics) { + defer c.acquireRun("apply")() + var diags tfdiags.Diagnostics + + schemas, moreDiags := c.Schemas(config, plan.PriorState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, diags + } + + log.Printf("[DEBUG] Building and walking apply graph for %s plan", plan.UIMode) + + graph, operation, moreDiags := c.applyGraph(plan, config, schemas, true) + if moreDiags.HasErrors() { + return nil, diags + } + + variables := InputValues{} + for name, dyVal := range plan.VariableValues { + val, err := dyVal.Decode(cty.DynamicPseudoType) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid variable value in plan", + fmt.Sprintf("Invalid value for variable %q recorded in plan file: %s.", name, err), + )) + continue + } + + variables[name] = &InputValue{ + Value: val, + SourceType: ValueFromPlan, + } + } + + workingState := plan.PriorState.DeepCopy() + walker, walkDiags := c.walk(graph, operation, &graphWalkOpts{ + Config: config, + Schemas: schemas, + InputState: workingState, + Changes: plan.Changes, + RootVariableValues: variables, + }) + diags = diags.Append(walker.NonFatalDiagnostics) + diags = diags.Append(walkDiags) + + newState := walker.State.Close() + if plan.UIMode == plans.DestroyMode && !diags.HasErrors() { + // NOTE: This is a vestigial violation of the rule that we mustn't + // use plan.UIMode to affect apply-time behavior. + // We ideally ought to just call newState.PruneResourceHusks + // unconditionally here, but we historically didn't and haven't yet + // verified that it'd be safe to do so. + newState.PruneResourceHusks() + } + + if len(plan.TargetAddrs) > 0 { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Warning, + "Applied changes may be incomplete", + `The plan was created with the -target option in effect, so some changes requested in the configuration may have been ignored and the output values may not be fully updated. Run the following command to verify that no other changes are pending: + terraform plan + +Note that the -target option is not suitable for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, + )) + } + + return newState, diags +} + +func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, schemas *Schemas, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { + graph, diags := (&ApplyGraphBuilder{ + Config: config, + Changes: plan.Changes, + State: plan.PriorState, + Components: c.components, + Schemas: schemas, + Targets: plan.TargetAddrs, + ForceReplace: plan.ForceReplaceAddrs, + Validate: validate, + }).Build(addrs.RootModuleInstance) + + operation := walkApply + if plan.UIMode == plans.DestroyMode { + // NOTE: This is a vestigial violation of the rule that we mustn't + // use plan.UIMode to affect apply-time behavior. It's a design error + // if anything downstream switches behavior when operation is set + // to walkDestroy, but we've not yet fully audited that. + // TODO: Audit that and remove walkDestroy as an operation mode. + operation = walkDestroy + } + + return graph, operation, diags +} + +// ApplyGraphForUI is a last vestage of graphs in the public interface of +// Context (as opposed to graphs as an implementation detail) intended only for +// use by the "terraform graph" command when asked to render an apply-time +// graph. +// +// The result of this is intended only for rendering ot the user as a dot +// graph, and so may change in future in order to make the result more useful +// in that context, even if drifts away from the physical graph that Terraform +// Core currently uses as an implementation detail of planning. +func (c *Context) ApplyGraphForUI(plan *plans.Plan, config *configs.Config) (*Graph, tfdiags.Diagnostics) { + // For now though, this really is just the internal graph, confusing + // implementation details and all. + + var diags tfdiags.Diagnostics + + schemas, moreDiags := c.Schemas(config, plan.PriorState) + diags = diags.Append(moreDiags) + if diags.HasErrors() { + return nil, diags + } + + graph, _, moreDiags := c.applyGraph(plan, config, schemas, false) + diags = diags.Append(moreDiags) + return graph, diags +} diff --git a/internal/terraform/context_apply2_test.go b/internal/terraform/context_apply2_test.go index 68159595951d..82a48e2d7e56 100644 --- a/internal/terraform/context_apply2_test.go +++ b/internal/terraform/context_apply2_test.go @@ -47,21 +47,20 @@ func TestContext2Apply_createBeforeDestroy_deposedKeyPreApply(t *testing.T) { hook := new(MockHook) ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{hook}, + Hooks: []Hook{hook}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -145,28 +144,27 @@ output "data" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: ps, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.Err()) } // now destroy the whole thing ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: ps, - PlanMode: plans.DestroyMode, }) - _, diags = ctx.Plan() + plan, diags = ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -177,7 +175,7 @@ output "data" { return resp } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -231,18 +229,15 @@ resource "test_instance" "a" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - _, diags := ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -322,17 +317,13 @@ resource "aws_instance" "bin" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) bar := plan.PriorState.ResourceInstance(barAddr) if len(bar.Current.Dependencies) == 0 || !bar.Current.Dependencies[0].Equal(fooAddr.ContainingResource().Config()) { @@ -354,7 +345,7 @@ resource "aws_instance" "bin" { t.Fatalf("baz should depend on bam after refresh, but got %s", baz.Current.Dependencies) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -430,19 +421,15 @@ resource "test_resource" "b" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -475,18 +462,15 @@ output "out" { p := simpleMockProvider() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -496,10 +480,8 @@ output "out" { t.Fatalf("Expected 1 sensitive mark for test_object.a, got %#v\n", obj.Current.AttrSensitivePaths) } - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) // make sure the same marks are compared in the next plan as well for _, c := range plan.Changes.Resources { @@ -543,27 +525,20 @@ resource "test_object" "y" { p := simpleMockProvider() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - _, diags = ctx.Apply() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + state, diags := ctx.Apply(plan, m) + assertNoErrors(t, diags) // FINAL PLAN: - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) // make sure the same marks are compared in the next plan as well for _, c := range plan.Changes.Resources { diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 4eb4f62490b3..9d155e73e865 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -38,17 +38,15 @@ func TestContext2Apply_basic(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -78,13 +76,12 @@ func TestContext2Apply_unstable(t *testing.T) { p := testProvider("test") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected error during Plan: %s", diags.Err()) } @@ -104,7 +101,7 @@ func TestContext2Apply_unstable(t *testing.T) { t.Fatalf("Attribute 'random' has known value %#v; should be unknown in plan", rd.After.GetAttr("random")) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("unexpected error during Apply: %s", diags.Err()) } @@ -135,17 +132,15 @@ func TestContext2Apply_escape(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -165,17 +160,15 @@ func TestContext2Apply_resourceCountOneList(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoDiagnostics(t, diags) got := strings.TrimSpace(state.String()) @@ -195,17 +188,15 @@ func TestContext2Apply_resourceCountZeroList(t *testing.T) { p := testProvider("null") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -250,17 +241,15 @@ func TestContext2Apply_resourceDependsOnModule(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -324,18 +313,15 @@ func TestContext2Apply_resourceDependsOnModuleStateOnly(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) if !reflect.DeepEqual(order, []string{"child", "parent"}) { @@ -354,17 +340,15 @@ func TestContext2Apply_resourceDependsOnModuleDestroy(t *testing.T) { var globalState *states.State { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -397,19 +381,17 @@ func TestContext2Apply_resourceDependsOnModuleDestroy(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: globalState, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, globalState, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -452,17 +434,15 @@ func TestContext2Apply_resourceDependsOnModuleGrandchild(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -505,17 +485,15 @@ func TestContext2Apply_resourceDependsOnModuleInModule(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -534,17 +512,15 @@ func TestContext2Apply_mapVarBetweenModules(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -574,17 +550,15 @@ func TestContext2Apply_refCount(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -607,17 +581,15 @@ func TestContext2Apply_providerAlias(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -643,16 +615,16 @@ func TestContext2Apply_providerAliasConfigure(t *testing.T) { p2.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("another"): testProviderFuncFixed(p2), }, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } // Configure to record calls AFTER Plan above @@ -668,7 +640,7 @@ func TestContext2Apply_providerAliasConfigure(t *testing.T) { return } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -695,17 +667,15 @@ func TestContext2Apply_providerWarning(t *testing.T) { return } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -732,17 +702,15 @@ func TestContext2Apply_emptyModule(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -771,20 +739,19 @@ func TestContext2Apply_createBeforeDestroy(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -852,20 +819,19 @@ func TestContext2Apply_createBeforeDestroyUpdate(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -910,20 +876,19 @@ func TestContext2Apply_createBeforeDestroy_dependsNonCBD(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -974,21 +939,20 @@ func TestContext2Apply_createBeforeDestroy_hook(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -1052,20 +1016,19 @@ func TestContext2Apply_createBeforeDestroy_deposedCount(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -1113,20 +1076,19 @@ func TestContext2Apply_createBeforeDestroy_deposedOnly(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -1154,22 +1116,22 @@ func TestContext2Apply_destroyComputed(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("plan failed") } else { - t.Logf("plan:\n\n%s", legacyDiffComparisonString(p.Changes)) + t.Logf("plan:\n\n%s", legacyDiffComparisonString(plan.Changes)) } - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("apply failed") } @@ -1222,20 +1184,18 @@ func testContext2Apply_destroyDependsOn(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, Parallelism: 1, // To check ordering }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -1276,7 +1236,7 @@ func TestContext2Apply_destroyDependsOnStateOnly(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"bar"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "aws_instance", @@ -1318,20 +1278,18 @@ func testContext2Apply_destroyDependsOnStateOnly(t *testing.T, state *states.Sta } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, Parallelism: 1, // To check ordering }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -1372,7 +1330,7 @@ func TestContext2Apply_destroyDependsOnStateOnlyModule(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"bar"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "aws_instance", @@ -1415,20 +1373,18 @@ func testContext2Apply_destroyDependsOnStateOnlyModule(t *testing.T, state *stat } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, Parallelism: 1, // To check ordering }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -1450,19 +1406,19 @@ func TestContext2Apply_dataBasic(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) actual := strings.TrimSpace(state.String()) @@ -1495,22 +1451,22 @@ func TestContext2Apply_destroyData(t *testing.T) { hook := &testHook{} ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, - Hooks: []Hook{hook}, + Hooks: []Hook{hook}, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - newState, diags := ctx.Apply() + newState, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -1563,21 +1519,21 @@ func TestContext2Apply_destroySkipsCBD(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -1597,19 +1553,17 @@ func TestContext2Apply_destroyModuleVarProviderConfig(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - _, diags := ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -1650,20 +1604,20 @@ func TestContext2Apply_destroyCrossProviders(t *testing.T) { addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p_aws), } - ctx := getContextForApply_destroyCrossProviders(t, m, providers) + ctx, m, state := getContextForApply_destroyCrossProviders(t, m, providers) - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("plan failed") - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("apply failed") } } -func getContextForApply_destroyCrossProviders(t *testing.T, m *configs.Config, providerFactories map[addrs.Provider]providers.Factory) *Context { +func getContextForApply_destroyCrossProviders(t *testing.T, m *configs.Config, providerFactories map[addrs.Provider]providers.Factory) (*Context, *configs.Config, *states.State) { state := states.NewState() root := state.EnsureModule(addrs.RootModuleInstance) root.SetResourceInstanceCurrent( @@ -1685,13 +1639,10 @@ func getContextForApply_destroyCrossProviders(t *testing.T, m *configs.Config, p ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: providerFactories, - State: state, - PlanMode: plans.DestroyMode, }) - return ctx + return ctx, m, state } func TestContext2Apply_minimal(t *testing.T) { @@ -1700,17 +1651,15 @@ func TestContext2Apply_minimal(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -1728,7 +1677,6 @@ func TestContext2Apply_cancel(t *testing.T) { m := testModule(t, "apply-cancel") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -1750,15 +1698,14 @@ func TestContext2Apply_cancel(t *testing.T) { } p.PlanResourceChangeFn = testDiffFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) // Start the Apply in a goroutine var applyDiags tfdiags.Diagnostics stateCh := make(chan *states.State) go func() { - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) applyDiags = diags stateCh <- state @@ -1792,7 +1739,6 @@ func TestContext2Apply_cancelBlock(t *testing.T) { m := testModule(t, "apply-cancel-block") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -1814,15 +1760,14 @@ func TestContext2Apply_cancelBlock(t *testing.T) { return testApplyFn(req) } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) // Start the Apply in a goroutine var applyDiags tfdiags.Diagnostics stateCh := make(chan *states.State) go func() { - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) applyDiags = diags stateCh <- state @@ -1891,7 +1836,6 @@ func TestContext2Apply_cancelProvisioner(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -1913,15 +1857,14 @@ func TestContext2Apply_cancelProvisioner(t *testing.T) { return nil } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) // Start the Apply in a goroutine var applyDiags tfdiags.Diagnostics stateCh := make(chan *states.State) go func() { - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) applyDiags = diags stateCh <- state @@ -1998,24 +1941,22 @@ func TestContext2Apply_compute(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - ctx.variables = InputValues{ - "value": &InputValue{ - Value: cty.NumberIntVal(1), - SourceType: ValueFromCaller, + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + SetVariables: InputValues{ + "value": &InputValue{ + Value: cty.NumberIntVal(1), + SourceType: ValueFromCaller, + }, }, - } - - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2060,19 +2001,15 @@ func TestContext2Apply_countDecrease(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("plan failed") - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) actual := strings.TrimSpace(s.String()) @@ -2114,18 +2051,15 @@ func TestContext2Apply_countDecreaseToOneX(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2166,24 +2100,22 @@ func TestContext2Apply_countDecreaseToOneCorrupted(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } else { - got := strings.TrimSpace(legacyPlanComparisonString(ctx.State(), p.Changes)) + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) + { + got := strings.TrimSpace(legacyPlanComparisonString(state, plan.Changes)) want := strings.TrimSpace(testTerraformApplyCountDecToOneCorruptedPlanStr) if got != want { t.Fatalf("wrong plan result\ngot:\n%s\nwant:\n%s", got, want) } } - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2211,16 +2143,14 @@ func TestContext2Apply_countTainted(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) { - plan, diags := ctx.Plan() - assertNoErrors(t, diags) got := strings.TrimSpace(legacyDiffComparisonString(plan.Changes)) want := strings.TrimSpace(` DESTROY/CREATE: aws_instance.foo[0] @@ -2237,7 +2167,7 @@ CREATE: aws_instance.foo[1] } } - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) got := strings.TrimSpace(s.String()) @@ -2264,17 +2194,15 @@ func TestContext2Apply_countVariable(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2292,17 +2220,15 @@ func TestContext2Apply_countVariableRef(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2334,20 +2260,17 @@ func TestContext2Apply_provisionerInterpCount(t *testing.T) { "local-exec": testProvisionerFuncFixed(pr), } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, Provisioners: provisioners, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatalf("plan failed unexpectedly: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) // We'll marshal and unmarshal the plan here, to ensure that we have // a clean new context as would be created if we separately ran // terraform plan -out=tfplan && terraform apply tfplan - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatal(err) } @@ -2359,7 +2282,7 @@ func TestContext2Apply_provisionerInterpCount(t *testing.T) { } // Applying the plan should now succeed - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply failed unexpectedly: %s", diags.Err()) } @@ -2376,22 +2299,22 @@ func TestContext2Apply_foreachVariable(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("hello"), }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2409,17 +2332,15 @@ func TestContext2Apply_moduleBasic(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2490,19 +2411,17 @@ func TestContext2Apply_moduleDestroyOrder(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2542,17 +2461,15 @@ func TestContext2Apply_moduleInheritAlias(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2591,14 +2508,13 @@ func TestContext2Apply_orphanResource(t *testing.T) { // Step 1: create the resources and instances m := testModule(t, "apply-orphan-resource") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) // At this point both resources should be recorded in the state, along @@ -2627,15 +2543,13 @@ func TestContext2Apply_orphanResource(t *testing.T) { // Step 2: update with an empty config, to destroy everything m = testModule(t, "empty") ctx = testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags = ctx.Plan() + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) // The state should now be _totally_ empty, with just an empty root module @@ -2679,18 +2593,15 @@ func TestContext2Apply_moduleOrphanInheritAlias(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2729,18 +2640,15 @@ func TestContext2Apply_moduleOrphanProvider(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -2772,18 +2680,15 @@ func TestContext2Apply_moduleOrphanGrandchildProvider(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -2809,17 +2714,15 @@ func TestContext2Apply_moduleGrandchildProvider(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -2844,18 +2747,16 @@ func TestContext2Apply_moduleOnlyProvider(t *testing.T) { pTest.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("test"): testProviderFuncFixed(pTest), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2873,17 +2774,15 @@ func TestContext2Apply_moduleProviderAlias(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2900,10 +2799,13 @@ func TestContext2Apply_moduleProviderAliasTargets(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.ConfigResource{ Module: addrs.RootModule, @@ -2915,12 +2817,9 @@ func TestContext2Apply_moduleProviderAliasTargets(t *testing.T) { }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -2950,19 +2849,17 @@ func TestContext2Apply_moduleProviderCloseNested(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -2989,18 +2886,15 @@ func TestContext2Apply_moduleVarRefExisting(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3017,45 +2911,43 @@ func TestContext2Apply_moduleVarResourceCount(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.DestroyMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(2), SourceType: ValueFromCaller, }, }, - PlanMode: plans.DestroyMode, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - if _, diags := ctx.Apply(); diags.HasErrors() { - t.Fatalf("apply errors: %s", diags.Err()) - } + state, diags := ctx.Apply(plan, m) + assertNoErrors(t, diags) ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(5), SourceType: ValueFromCaller, }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -3067,17 +2959,15 @@ func TestContext2Apply_moduleBool(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3097,20 +2987,20 @@ func TestContext2Apply_moduleTarget(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("B", addrs.NoKey), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3150,18 +3040,16 @@ func TestContext2Apply_multiProvider(t *testing.T) { pDO.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("do"): testProviderFuncFixed(pDO), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3216,21 +3104,17 @@ func TestContext2Apply_multiProviderDestroy(t *testing.T) { // First, create the instances { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("vault"): testProviderFuncFixed(p2), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("errors during create plan: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() - if diags.HasErrors() { - t.Fatalf("errors during create apply: %s", diags.Err()) - } + s, diags := ctx.Apply(plan, m) + assertNoErrors(t, diags) state = s } @@ -3267,23 +3151,19 @@ func TestContext2Apply_multiProviderDestroy(t *testing.T) { p2.ApplyResourceChangeFn = applyFn ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("vault"): testProviderFuncFixed(p2), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("errors during destroy plan: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - s, diags := ctx.Apply() - if diags.HasErrors() { - t.Fatalf("errors during destroy apply: %s", diags.Err()) - } + s, diags := ctx.Apply(plan, m) + assertNoErrors(t, diags) if !checked { t.Fatal("should be checked") @@ -3337,18 +3217,16 @@ func TestContext2Apply_multiProviderDestroyChild(t *testing.T) { // First, create the instances { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("vault"): testProviderFuncFixed(p2), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3388,20 +3266,18 @@ func TestContext2Apply_multiProviderDestroyChild(t *testing.T) { p2.ApplyResourceChangeFn = applyFn ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("vault"): testProviderFuncFixed(p2), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3425,23 +3301,23 @@ func TestContext2Apply_multiVar(t *testing.T) { // First, apply with a count of 3 ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(3), SourceType: ValueFromCaller, }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3457,24 +3333,23 @@ func TestContext2Apply_multiVar(t *testing.T) { // Apply again, reduce the count to 1 { ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(1), SourceType: ValueFromCaller, }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3563,22 +3438,21 @@ func TestContext2Apply_multiVarComprehensive(t *testing.T) { // First, apply with a count of 3 ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(3), SourceType: ValueFromCaller, }, }, }) - - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatalf("errors during plan") - } + assertNoErrors(t, diags) checkConfig := func(key string, want cty.Value) { configsLock.Lock() @@ -3675,7 +3549,7 @@ func TestContext2Apply_multiVarComprehensive(t *testing.T) { })) t.Run("apply", func(t *testing.T) { - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("error during apply: %s", diags.Err()) } @@ -3710,17 +3584,15 @@ func TestContext2Apply_multiVarOrder(t *testing.T) { // First, apply with a count of 3 ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3743,17 +3615,15 @@ func TestContext2Apply_multiVarOrderInterp(t *testing.T) { // First, apply with a count of 3 ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3779,25 +3649,25 @@ func TestContext2Apply_multiVarCountDec(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + log.Print("\n========\nStep 1 Plan\n========") + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(2), SourceType: ValueFromCaller, }, }, }) - - log.Print("\n========\nStep 1 Plan\n========") - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + assertNoErrors(t, diags) log.Print("\n========\nStep 1 Apply\n========") - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3843,29 +3713,27 @@ func TestContext2Apply_multiVarCountDec(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - State: s, - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + log.Print("\n========\nStep 2 Plan\n========") + plan, diags := ctx.Plan(m, s, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "num": &InputValue{ Value: cty.NumberIntVal(1), SourceType: ValueFromCaller, }, }, }) - - log.Print("\n========\nStep 2 Plan\n========") - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + assertNoErrors(t, diags) t.Logf("Step 2 plan:\n%s", legacyDiffComparisonString(plan.Changes)) log.Print("\n========\nStep 2 Apply\n========") - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -3897,18 +3765,16 @@ func TestContext2Apply_multiVarMissingState(t *testing.T) { // First, apply with a count of 3 ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan failed: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - // Before the relevant bug was fixed, Tdiagsaform would panic during apply. - if _, diags := ctx.Apply(); diags.HasErrors() { + // Before the relevant bug was fixed, Terraform would panic during apply. + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply failed: %s", diags.Err()) } @@ -3926,18 +3792,15 @@ func TestContext2Apply_outputOrphan(t *testing.T) { root.SetOutputValue("bar", cty.StringVal("baz"), false) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3957,18 +3820,15 @@ func TestContext2Apply_outputOrphanModule(t *testing.T) { state := states.NewState() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -3982,18 +3842,23 @@ func TestContext2Apply_outputOrphanModule(t *testing.T) { // now apply with no module in the config, which should remove the // remaining output ctx = testContext2(t, &ContextOpts{ - Config: configs.NewEmptyConfig(), Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state.DeepCopy(), }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + emptyConfig := configs.NewEmptyConfig() + + // NOTE: While updating this test to pass the state in as a Plan argument, + // rather than into the testContext2 call above, it previously said + // State: state.DeepCopy(), which is a little weird since we just + // created "s" above as the result of the previous apply, but I've preserved + // it to avoid changing the flow of this test in case that's important + // for some reason. + plan, diags = ctx.Plan(emptyConfig, state.DeepCopy(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, emptyConfig) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -4013,7 +3878,6 @@ func TestContext2Apply_providerComputedVar(t *testing.T) { pTest.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("test"): testProviderFuncFixed(pTest), @@ -4029,11 +3893,10 @@ func TestContext2Apply_providerComputedVar(t *testing.T) { return } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -4053,17 +3916,15 @@ func TestContext2Apply_providerConfigureDisabled(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -4089,7 +3950,6 @@ func TestContext2Apply_provisionerModule(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4098,11 +3958,10 @@ func TestContext2Apply_provisionerModule(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -4137,27 +3996,27 @@ func TestContext2Apply_Provisioner_compute(t *testing.T) { } h := new(MockHook) ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "value": &InputValue{ Value: cty.NumberIntVal(1), SourceType: ValueFromCaller, }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -4196,7 +4055,6 @@ func TestContext2Apply_provisionerCreateFail(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4205,11 +4063,10 @@ func TestContext2Apply_provisionerCreateFail(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags == nil { t.Fatal("should error") } @@ -4233,7 +4090,6 @@ func TestContext2Apply_provisionerCreateFailNoId(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4242,11 +4098,10 @@ func TestContext2Apply_provisionerCreateFailNoId(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags == nil { t.Fatal("should error") } @@ -4270,7 +4125,6 @@ func TestContext2Apply_provisionerFail(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4279,11 +4133,10 @@ func TestContext2Apply_provisionerFail(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags == nil { t.Fatal("should error") } @@ -4318,22 +4171,19 @@ func TestContext2Apply_provisionerFail_createBeforeDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should error") } @@ -4360,11 +4210,9 @@ func TestContext2Apply_error_createBeforeDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) (resp providers.ApplyResourceChangeResponse) { resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("placeholder error from ApplyFn")) @@ -4372,12 +4220,11 @@ func TestContext2Apply_error_createBeforeDestroy(t *testing.T) { } p.PlanResourceChangeFn = testDiffFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should have error") } if got, want := diags.Err().Error(), "placeholder error from ApplyFn"; got != want { @@ -4409,11 +4256,9 @@ func TestContext2Apply_errorDestroy_createBeforeDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) (resp providers.ApplyResourceChangeResponse) { // Fail the destroy! @@ -4427,12 +4272,11 @@ func TestContext2Apply_errorDestroy_createBeforeDestroy(t *testing.T) { } p.PlanResourceChangeFn = testDiffFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should have error") } @@ -4472,14 +4316,7 @@ func TestContext2Apply_multiDepose_createBeforeDestroy(t *testing.T) { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: ps, - State: state, - Variables: InputValues{ - "require_new": &InputValue{ - Value: cty.StringVal("yes"), - }, - }, }) createdInstanceId := "bar" // Create works @@ -4504,14 +4341,20 @@ func TestContext2Apply_multiDepose_createBeforeDestroy(t *testing.T) { } } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "require_new": &InputValue{ + Value: cty.StringVal("yes"), + }, + }, + }) + assertNoErrors(t, diags) // Destroy is broken, so even though CBD successfully replaces the instance, // we'll have to save the Deposed instance to destroy later - state, diags := ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should have error") } @@ -4525,24 +4368,23 @@ aws_instance.web: (1 deposed) createdInstanceId = "baz" ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: ps, - State: state, - Variables: InputValues{ + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "require_new": &InputValue{ Value: cty.StringVal("baz"), }, }, }) - - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + assertNoErrors(t, diags) // We're replacing the primary instance once again. Destroy is _still_ // broken, so the Deposed list gets longer - state, diags = ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should have error") } @@ -4592,22 +4434,21 @@ aws_instance.web: (1 deposed) createdInstanceId = "qux" ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: ps, - State: state, - Variables: InputValues{ + }) + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "require_new": &InputValue{ Value: cty.StringVal("qux"), }, }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) // Expect error because 1/2 of Deposed destroys failed - if diags == nil { + if !diags.HasErrors() { t.Fatal("should have error") } @@ -4628,19 +4469,18 @@ aws_instance.web: (1 deposed) createdInstanceId = "quux" ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: ps, - State: state, - Variables: InputValues{ + }) + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "require_new": &InputValue{ Value: cty.StringVal("quux"), }, }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - state, diags = ctx.Apply() + assertNoErrors(t, diags) + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal("should not have error:", diags.Err()) } @@ -4669,7 +4509,6 @@ func TestContext2Apply_provisionerFailContinue(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4678,11 +4517,10 @@ func TestContext2Apply_provisionerFailContinue(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -4715,8 +4553,7 @@ func TestContext2Apply_provisionerFailContinueHook(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4725,11 +4562,10 @@ func TestContext2Apply_provisionerFailContinueHook(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -4767,9 +4603,6 @@ func TestContext2Apply_provisionerDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, - PlanMode: plans.DestroyMode, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4778,11 +4611,12 @@ func TestContext2Apply_provisionerDestroy(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -4818,9 +4652,6 @@ func TestContext2Apply_provisionerDestroyFail(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, - PlanMode: plans.DestroyMode, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4829,11 +4660,12 @@ func TestContext2Apply_provisionerDestroyFail(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags == nil { t.Fatal("should error") } @@ -4886,9 +4718,6 @@ func TestContext2Apply_provisionerDestroyFailContinue(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, - PlanMode: plans.DestroyMode, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4897,11 +4726,12 @@ func TestContext2Apply_provisionerDestroyFailContinue(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -4955,9 +4785,6 @@ func TestContext2Apply_provisionerDestroyFailContinueFail(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, - PlanMode: plans.DestroyMode, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -4966,11 +4793,12 @@ func TestContext2Apply_provisionerDestroyFailContinueFail(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags == nil { t.Fatal("apply succeeded; wanted error from second provisioner") } @@ -5023,15 +4851,17 @@ func TestContext2Apply_provisionerDestroyTainted(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "input": &InputValue{ Value: cty.MapVal(map[string]cty.Value{ "a": cty.StringVal("b"), @@ -5040,12 +4870,9 @@ func TestContext2Apply_provisionerDestroyTainted(t *testing.T) { }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5085,7 +4912,6 @@ func TestContext2Apply_provisionerResourceRef(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5094,11 +4920,10 @@ func TestContext2Apply_provisionerResourceRef(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5131,7 +4956,6 @@ func TestContext2Apply_provisionerSelfRef(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5140,11 +4964,10 @@ func TestContext2Apply_provisionerSelfRef(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5184,7 +5007,6 @@ func TestContext2Apply_provisionerMultiSelfRef(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5193,11 +5015,10 @@ func TestContext2Apply_provisionerMultiSelfRef(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5244,7 +5065,6 @@ func TestContext2Apply_provisionerMultiSelfRefSingle(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5253,11 +5073,10 @@ func TestContext2Apply_provisionerMultiSelfRefSingle(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5298,7 +5117,6 @@ func TestContext2Apply_provisionerExplicitSelfRef(t *testing.T) { var state *states.State { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5307,12 +5125,12 @@ func TestContext2Apply_provisionerExplicitSelfRef(t *testing.T) { }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5325,9 +5143,6 @@ func TestContext2Apply_provisionerExplicitSelfRef(t *testing.T) { { ctx := testContext2(t, &ContextOpts{ - Config: m, - PlanMode: plans.DestroyMode, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5336,12 +5151,14 @@ func TestContext2Apply_provisionerExplicitSelfRef(t *testing.T) { }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5366,7 +5183,6 @@ func TestContext2Apply_provisionerForEachSelfRef(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5375,11 +5191,10 @@ func TestContext2Apply_provisionerForEachSelfRef(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - _, diags := ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5393,7 +5208,6 @@ func TestContext2Apply_Provisioner_Diff(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -5402,12 +5216,10 @@ func TestContext2Apply_Provisioner_Diff(t *testing.T) { }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("plan failed") - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("apply failed") @@ -5441,22 +5253,18 @@ func TestContext2Apply_Provisioner_Diff(t *testing.T) { // Re-create context with state ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("plan failed") - } + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state2, diags := ctx.Apply() + state2, diags := ctx.Apply(plan, m) if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("apply failed") @@ -5489,11 +5297,9 @@ func TestContext2Apply_outputDiffVars(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.PlanResourceChangeFn = testDiffFn @@ -5524,14 +5330,11 @@ func TestContext2Apply_outputDiffVars(t *testing.T) { // return d, nil //} - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("plan failed") - } - if _, diags := ctx.Apply(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("apply failed") - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) + + _, diags = ctx.Apply(plan, m) + assertNoErrors(t, diags) } func TestContext2Apply_destroyX(t *testing.T) { @@ -5540,19 +5343,17 @@ func TestContext2Apply_destroyX(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5560,20 +5361,18 @@ func TestContext2Apply_destroyX(t *testing.T) { // Next, plan and apply a destroy operation h.Active = true ctx = testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5599,19 +5398,17 @@ func TestContext2Apply_destroyOrder(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5621,20 +5418,18 @@ func TestContext2Apply_destroyOrder(t *testing.T) { // Next, plan and apply a destroy h.Active = true ctx = testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5661,19 +5456,17 @@ func TestContext2Apply_destroyModulePrefix(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5686,20 +5479,18 @@ func TestContext2Apply_destroyModulePrefix(t *testing.T) { // Next, plan and apply a destroy operation and reset the hook h = new(MockHook) ctx = testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5727,19 +5518,16 @@ func TestContext2Apply_destroyNestedModule(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5768,19 +5556,16 @@ func TestContext2Apply_destroyDeeplyNestedModule(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -5800,21 +5585,20 @@ func TestContext2Apply_destroyModuleWithAttrsReferencingResource(t *testing.T) { var state *states.State { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("plan diags: %s", diags.Err()) } else { - t.Logf("Step 1 plan: %s", legacyDiffComparisonString(p.Changes)) + t.Logf("Step 1 plan: %s", legacyDiffComparisonString(plan.Changes)) } - var diags tfdiags.Diagnostics - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errs: %s", diags.Err()) } @@ -5827,24 +5611,23 @@ func TestContext2Apply_destroyModuleWithAttrsReferencingResource(t *testing.T) { { ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - Config: m, - State: state, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("destroy plan err: %s", diags.Err()) } t.Logf("Step 2 plan: %s", legacyDiffComparisonString(plan.Changes)) - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -5858,7 +5641,7 @@ func TestContext2Apply_destroyModuleWithAttrsReferencingResource(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("destroy apply err: %s", diags.Err()) } @@ -5878,21 +5661,18 @@ func TestContext2Apply_destroyWithModuleVariableAndCount(t *testing.T) { p.PlanResourceChangeFn = testDiffFn var state *states.State - var diags tfdiags.Diagnostics { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply err: %s", diags.Err()) } @@ -5903,22 +5683,21 @@ func TestContext2Apply_destroyWithModuleVariableAndCount(t *testing.T) { { ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - Config: m, - State: state, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("destroy plan err: %s", diags.Err()) } - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -5933,7 +5712,7 @@ func TestContext2Apply_destroyWithModuleVariableAndCount(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("destroy apply err: %s", diags.Err()) } @@ -5954,21 +5733,18 @@ func TestContext2Apply_destroyTargetWithModuleVariableAndCount(t *testing.T) { p.PlanResourceChangeFn = testDiffFn var state *states.State - var diags tfdiags.Diagnostics { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply err: %s", diags.Err()) } @@ -5976,18 +5752,17 @@ func TestContext2Apply_destroyTargetWithModuleVariableAndCount(t *testing.T) { { ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child", addrs.NoKey), }, }) - - _, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("plan err: %s", diags) } @@ -6003,7 +5778,7 @@ func TestContext2Apply_destroyTargetWithModuleVariableAndCount(t *testing.T) { } // Destroy, targeting the module explicitly - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("destroy apply err: %s", diags) } @@ -6032,21 +5807,18 @@ func TestContext2Apply_destroyWithModuleVariableAndCountNested(t *testing.T) { p.PlanResourceChangeFn = testDiffFn var state *states.State - var diags tfdiags.Diagnostics { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply err: %s", diags.Err()) } @@ -6057,22 +5829,21 @@ func TestContext2Apply_destroyWithModuleVariableAndCountNested(t *testing.T) { { ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - Config: m, - State: state, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("destroy plan err: %s", diags.Err()) } - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -6087,7 +5858,7 @@ func TestContext2Apply_destroyWithModuleVariableAndCountNested(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("destroy apply err: %s", diags.Err()) } @@ -6118,18 +5889,16 @@ func TestContext2Apply_destroyOutputs(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) @@ -6137,19 +5906,17 @@ func TestContext2Apply_destroyOutputs(t *testing.T) { // Next, plan and apply a destroy operation ctx = testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6161,18 +5928,16 @@ func TestContext2Apply_destroyOutputs(t *testing.T) { // destroying again should produce no errors ctx = testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - State: state, - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatal(diags.Err()) } } @@ -6191,20 +5956,17 @@ func TestContext2Apply_destroyOrphan(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.PlanResourceChangeFn = testDiffFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6233,22 +5995,20 @@ func TestContext2Apply_destroyTaintedProvisioner(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6270,7 +6030,6 @@ func TestContext2Apply_error(t *testing.T) { m := testModule(t, "apply-error") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -6288,11 +6047,10 @@ func TestContext2Apply_error(t *testing.T) { } p.PlanResourceChangeFn = testDiffFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags == nil { t.Fatal("should have error") } @@ -6334,35 +6092,33 @@ func TestContext2Apply_errorDestroy(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, - State: states.BuildState(func(ss *states.SyncState) { - ss.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_thing", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"id":"baz"}`), - }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("test"), - Module: addrs.RootModule, - }, - ) - }), Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + state := states.BuildState(func(ss *states.SyncState) { + ss.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"baz"}`), + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ) + }) + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should have error") } @@ -6410,17 +6166,15 @@ func TestContext2Apply_errorCreateInvalidNew(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags == nil { t.Fatal("should have error") } @@ -6470,35 +6224,33 @@ func TestContext2Apply_errorUpdateNullNew(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, - State: states.BuildState(func(ss *states.SyncState) { - ss.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "aws_instance", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"value":"old"}`), - }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("aws"), - Module: addrs.RootModule, - }, - ) - }), Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + state := states.BuildState(func(ss *states.SyncState) { + ss.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "aws_instance", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"value":"old"}`), + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("aws"), + Module: addrs.RootModule, + }, + ) + }) + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() - if diags == nil { + state, diags = ctx.Apply(plan, m) + if !diags.HasErrors() { t.Fatal("should have error") } if got, want := len(diags), 1; got != want { @@ -6545,11 +6297,9 @@ func TestContext2Apply_errorPartial(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) (resp providers.ApplyResourceChangeResponse) { @@ -6563,11 +6313,10 @@ func TestContext2Apply_errorPartial(t *testing.T) { } p.PlanResourceChangeFn = testDiffFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags == nil { t.Fatal("should have error") } @@ -6590,18 +6339,16 @@ func TestContext2Apply_hook(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -6634,19 +6381,16 @@ func TestContext2Apply_hookOrphan(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -6665,7 +6409,6 @@ func TestContext2Apply_idAttr(t *testing.T) { m := testModule(t, "apply-idattr") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -6674,11 +6417,10 @@ func TestContext2Apply_idAttr(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -6704,17 +6446,15 @@ func TestContext2Apply_outputBasic(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6732,17 +6472,15 @@ func TestContext2Apply_outputAdd(t *testing.T) { p1.ApplyResourceChangeFn = testApplyFn p1.PlanResourceChangeFn = testDiffFn ctx1 := testContext2(t, &ContextOpts{ - Config: m1, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p1), }, }) - if _, diags := ctx1.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan1, diags := ctx1.Plan(m1, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state1, diags := ctx1.Apply() + state1, diags := ctx1.Apply(plan1, m1) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6752,19 +6490,15 @@ func TestContext2Apply_outputAdd(t *testing.T) { p2.ApplyResourceChangeFn = testApplyFn p2.PlanResourceChangeFn = testDiffFn ctx2 := testContext2(t, &ContextOpts{ - Config: m2, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p2), }, - - State: state1, }) - if _, diags := ctx2.Plan(); diags.HasErrors() { - t.Fatalf("diags: %s", diags.Err()) - } + plan2, diags := ctx1.Plan(m2, state1, DefaultPlanOpts) + assertNoErrors(t, diags) - state2, diags := ctx2.Apply() + state2, diags := ctx2.Apply(plan2, m2) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6782,17 +6516,15 @@ func TestContext2Apply_outputList(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6810,17 +6542,15 @@ func TestContext2Apply_outputMulti(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6838,17 +6568,15 @@ func TestContext2Apply_outputMultiIndex(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6892,20 +6620,19 @@ func TestContext2Apply_taintX(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf("plan: %s", legacyDiffComparisonString(p.Changes)) + t.Logf("plan: %s", legacyDiffComparisonString(plan.Changes)) } - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -6948,20 +6675,19 @@ func TestContext2Apply_taintDep(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf("plan: %s", legacyDiffComparisonString(p.Changes)) + t.Logf("plan: %s", legacyDiffComparisonString(plan.Changes)) } - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7000,20 +6726,19 @@ func TestContext2Apply_taintDepRequiresNew(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf("plan: %s", legacyDiffComparisonString(p.Changes)) + t.Logf("plan: %s", legacyDiffComparisonString(plan.Changes)) } - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7031,22 +6756,22 @@ func TestContext2Apply_targeted(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7071,22 +6796,22 @@ func TestContext2Apply_targetedCount(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7113,22 +6838,22 @@ func TestContext2Apply_targetedCountIndex(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.IntKey(1), ), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7169,28 +6894,26 @@ func TestContext2Apply_targetedDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, + }) + + if diags := ctx.Validate(m); diags.HasErrors() { + t.Fatalf("validate errors: %s", diags.Err()) + } + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "a", ), }, - PlanMode: plans.DestroyMode, }) + assertNoErrors(t, diags) - if diags := ctx.Validate(); diags.HasErrors() { - t.Fatalf("validate errors: %s", diags.Err()) - } - - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7248,24 +6971,22 @@ func TestContext2Apply_targetedDestroyCountDeps(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, - PlanMode: plans.DestroyMode, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7316,24 +7037,22 @@ func TestContext2Apply_targetedDestroyModule(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child", addrs.NoKey).Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, - PlanMode: plans.DestroyMode, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7401,11 +7120,13 @@ func TestContext2Apply_targetedDestroyCountIndex(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.IntKey(2), @@ -7414,14 +7135,10 @@ func TestContext2Apply_targetedDestroyCountIndex(t *testing.T) { addrs.ManagedResourceMode, "aws_instance", "bar", addrs.IntKey(1), ), }, - PlanMode: plans.DestroyMode, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7448,20 +7165,20 @@ func TestContext2Apply_targetedModule(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child", addrs.NoKey), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7497,24 +7214,26 @@ func TestContext2Apply_targetedModuleDep(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, }) - - if p, diags := ctx.Plan(); diags.HasErrors() { + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf("Diff: %s", legacyDiffComparisonString(p.Changes)) + t.Logf("Diff: %s", legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7553,21 +7272,20 @@ func TestContext2Apply_targetedModuleUnrelatedOutputs(t *testing.T) { _ = state.EnsureModule(addrs.RootModuleInstance.Child("child2", addrs.NoKey)) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child2", addrs.NoKey), }, - State: state, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7600,22 +7318,22 @@ func TestContext2Apply_targetedModuleResource(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child", addrs.NoKey).Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -7653,23 +7371,22 @@ func TestContext2Apply_targetedResourceOrphanModule(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } } @@ -7700,17 +7417,15 @@ func TestContext2Apply_unknownAttribute(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if !diags.HasErrors() { t.Error("should error, because attribute 'unknown' is still unknown after apply") } @@ -7727,13 +7442,12 @@ func TestContext2Apply_unknownAttributeInterpolate(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags == nil { + if _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts); diags == nil { t.Fatal("should error") } } @@ -7741,7 +7455,15 @@ func TestContext2Apply_unknownAttributeInterpolate(t *testing.T) { func TestContext2Apply_vars(t *testing.T) { fixture := contextFixtureApplyVars(t) opts := fixture.ContextOpts() - opts.Variables = InputValues{ + ctx := testContext2(t, opts) + m := fixture.Config + + diags := ctx.Validate(m) + if len(diags) != 0 { + t.Fatalf("bad: %s", diags.ErrWithWarnings()) + } + + variables := InputValues{ "foo": &InputValue{ Value: cty.StringVal("us-east-1"), SourceType: ValueFromCaller, @@ -7768,18 +7490,14 @@ func TestContext2Apply_vars(t *testing.T) { SourceType: ValueFromCaller, }, } - ctx := testContext2(t, opts) - - diags := ctx.Validate() - if len(diags) != 0 { - t.Fatalf("bad: %s", diags.ErrWithWarnings()) - } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: variables, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -7794,7 +7512,15 @@ func TestContext2Apply_vars(t *testing.T) { func TestContext2Apply_varsEnv(t *testing.T) { fixture := contextFixtureApplyVarsEnv(t) opts := fixture.ContextOpts() - opts.Variables = InputValues{ + ctx := testContext2(t, opts) + m := fixture.Config + + diags := ctx.Validate(m) + if len(diags) != 0 { + t.Fatalf("bad: %s", diags.ErrWithWarnings()) + } + + variables := InputValues{ "string": &InputValue{ Value: cty.StringVal("baz"), SourceType: ValueFromEnvVar, @@ -7815,18 +7541,14 @@ func TestContext2Apply_varsEnv(t *testing.T) { SourceType: ValueFromEnvVar, }, } - ctx := testContext2(t, opts) - - diags := ctx.Validate() - if len(diags) != 0 { - t.Fatalf("bad: %s", diags.ErrWithWarnings()) - } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: variables, + }) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -7872,7 +7594,7 @@ func TestContext2Apply_createBefore_depends(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"baz","instance":"bar"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "aws_instance", @@ -7889,23 +7611,22 @@ func TestContext2Apply_createBefore_depends(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("plan failed") } else { - t.Logf("plan:\n%s", legacyDiffComparisonString(p.Changes)) + t.Logf("plan:\n%s", legacyDiffComparisonString(plan.Changes)) } h.Active = true - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("apply failed") @@ -8001,7 +7722,7 @@ func TestContext2Apply_singleDestroy(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"baz","instance":"bar"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "aws_instance", @@ -8018,20 +7739,17 @@ func TestContext2Apply_singleDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) h.Active = true - _, diags := ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -8060,19 +7778,18 @@ func TestContext2Apply_issue7824(t *testing.T) { // Apply cleanly step 0 ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("template"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } // Write / Read plan to simulate running it through a Plan file - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -8087,7 +7804,7 @@ func TestContext2Apply_issue7824(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8115,19 +7832,19 @@ func TestContext2Apply_issue5254(t *testing.T) { }) // Apply cleanly step 0 + m := testModule(t, "issue-5254/step-0") ctx := testContext2(t, &ContextOpts{ - Config: testModule(t, "issue-5254/step-0"), Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("template"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8136,20 +7853,18 @@ func TestContext2Apply_issue5254(t *testing.T) { // Application success. Now make the modification and store a plan ctx = testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("template"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } // Write / Read plan to simulate running it through a Plan file - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -8163,7 +7878,7 @@ func TestContext2Apply_issue5254(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8208,25 +7923,25 @@ func TestContext2Apply_targetedWithTaintedInState(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "iambeingadded", ), }, - State: state, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } // Write / Read plan to simulate running it through a Plan file - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -8240,7 +7955,7 @@ func TestContext2Apply_targetedWithTaintedInState(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8275,19 +7990,19 @@ func TestContext2Apply_ignoreChangesCreate(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -8353,7 +8068,7 @@ func TestContext2Apply_ignoreChangesWithDep(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"eip-abc123","instance":"i-abc123"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "aws_instance", @@ -8371,7 +8086,7 @@ func TestContext2Apply_ignoreChangesWithDep(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"eip-bcd234","instance":"i-bcd234"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "aws_instance", @@ -8385,17 +8100,15 @@ func TestContext2Apply_ignoreChangesWithDep(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state.DeepCopy(), }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state.DeepCopy(), DefaultPlanOpts) assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) actual := strings.TrimSpace(s.String()) @@ -8418,20 +8131,20 @@ func TestContext2Apply_ignoreChangesAll(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("plan failed") } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) mod := state.RootModule() @@ -8460,21 +8173,18 @@ func TestContext2Apply_destroyNestedModuleWithAttrsReferencingResource(t *testin p.PlanResourceChangeFn = testDiffFn var state *states.State - var diags tfdiags.Diagnostics { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) // First plan and apply a create operation - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply err: %s", diags.Err()) } @@ -8482,20 +8192,19 @@ func TestContext2Apply_destroyNestedModuleWithAttrsReferencingResource(t *testin { ctx := testContext2(t, &ContextOpts{ - PlanMode: plans.DestroyMode, - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("destroy plan err: %s", diags.Err()) } - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -8509,7 +8218,7 @@ func TestContext2Apply_destroyNestedModuleWithAttrsReferencingResource(t *testin t.Fatalf("err: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("destroy apply err: %s", diags.Err()) } @@ -8541,7 +8250,6 @@ resource "null_instance" "depends" { `}) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, @@ -8568,10 +8276,10 @@ resource "null_instance" "depends" { } } - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) root := state.Module(addrs.RootModuleInstance) @@ -8595,7 +8303,7 @@ resource "null_instance" "depends" { } // run another plan to make sure the data source doesn't show as a change - plan, diags := ctx.Plan() + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) for _, c := range plan.Changes.Resources { @@ -8629,14 +8337,12 @@ resource "null_instance" "depends" { } ctx = testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - plan, diags = ctx.Plan() + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) expectedChanges := map[string]plans.Action{ @@ -8658,18 +8364,16 @@ func TestContext2Apply_terraformWorkspace(t *testing.T) { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Meta: &ContextMeta{Env: "foo"}, - Config: m, + Meta: &ContextMeta{Env: "foo"}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -8687,17 +8391,15 @@ func TestContext2Apply_multiRef(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8714,20 +8416,20 @@ func TestContext2Apply_targetedModuleRecursive(t *testing.T) { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child", addrs.NoKey), }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8756,15 +8458,13 @@ module.child.subchild: func TestContext2Apply_localVal(t *testing.T) { m := testModule(t, "apply-local-val") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{}, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("error during plan: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("error during apply: %s", diags.Err()) } @@ -8800,19 +8500,17 @@ func TestContext2Apply_destroyWithLocals(t *testing.T) { root.SetOutputValue("name", cty.StringVal("test-bar"), false) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - s, diags := ctx.Apply() + s, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("error during apply: %s", diags.Err()) } @@ -8841,35 +8539,31 @@ func TestContext2Apply_providerWithLocals(t *testing.T) { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("err: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8900,16 +8594,13 @@ func TestContext2Apply_destroyWithProviders(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) // test that we can't destroy if the provider is missing - if _, diags := ctx.Plan(); diags == nil { + if _, diags := ctx.Plan(m, state, &PlanOpts{Mode: plans.DestroyMode}); diags == nil { t.Fatal("expected plan error, provider.aws.baz doesn't exist") } @@ -8917,18 +8608,17 @@ func TestContext2Apply_destroyWithProviders(t *testing.T) { state.Modules["module.mod.module.removed"].Resources["aws_instance.child"].ProviderConfig = mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"].bar`) ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatal(diags.Err()) - } - state, diags := ctx.Apply() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) + + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("error during apply: %s", diags.Err()) } @@ -9009,14 +8699,12 @@ func TestContext2Apply_providersFromState(t *testing.T) { } { t.Run(tc.name, func(t *testing.T) { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: tc.state, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, tc.state, DefaultPlanOpts) if tc.err { if diags == nil { t.Fatal("expected error") @@ -9028,7 +8716,7 @@ func TestContext2Apply_providersFromState(t *testing.T) { t.Fatal(diags.Err()) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -9061,12 +8749,10 @@ func TestContext2Apply_plannedInterpolatedCount(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("plan failed: %s", diags.Err()) } @@ -9074,7 +8760,7 @@ func TestContext2Apply_plannedInterpolatedCount(t *testing.T) { // We'll marshal and unmarshal the plan here, to ensure that we have // a clean new context as would be created if we separately ran // terraform plan -out=tfplan && terraform apply tfplan - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -9086,7 +8772,7 @@ func TestContext2Apply_plannedInterpolatedCount(t *testing.T) { } // Applying the plan should now succeed - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply failed: %s", diags.Err()) } @@ -9122,13 +8808,12 @@ func TestContext2Apply_plannedDestroyInterpolatedCount(t *testing.T) { root.SetOutputValue("out", cty.ListVal([]cty.Value{cty.StringVal("foo"), cty.StringVal("foo")}), false) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: providers, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("plan failed: %s", diags.Err()) } @@ -9136,7 +8821,7 @@ func TestContext2Apply_plannedDestroyInterpolatedCount(t *testing.T) { // We'll marshal and unmarshal the plan here, to ensure that we have // a clean new context as would be created if we separately ran // terraform plan -out=tfplan && terraform apply tfplan - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatalf("failed to round-trip through planfile: %s", err) } @@ -9148,7 +8833,7 @@ func TestContext2Apply_plannedDestroyInterpolatedCount(t *testing.T) { } // Applying the plan should now succeed - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply failed: %s", diags.Err()) } @@ -9187,22 +8872,22 @@ func TestContext2Apply_scaleInMultivarRef(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, - State: state, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "instance_count": { Value: cty.NumberIntVal(0), SourceType: ValueFromCaller, }, }, }) - - _, diags := ctx.Plan() assertNoErrors(t, diags) // Applying the plan should now succeed - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) } @@ -9235,17 +8920,15 @@ func TestContext2Apply_inconsistentWithPlan(t *testing.T) { } } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - _, diags := ctx.Apply() + _, diags = ctx.Apply(plan, m) if !diags.HasErrors() { t.Fatalf("apply succeeded; want error") } @@ -9284,34 +8967,33 @@ func TestContext2Apply_issue19908(t *testing.T) { } } ctx := testContext2(t, &ContextOpts{ - Config: m, - State: states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - AttrsJSON: []byte(`{"baz":"old"}`), - Status: states.ObjectReady, - }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("test"), - Module: addrs.RootModule, - }, - ) - }), Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"baz":"old"}`), + Status: states.ObjectReady, + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ) + }) + + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if !diags.HasErrors() { t.Fatalf("apply succeeded; want error") } @@ -9356,18 +9038,17 @@ func TestContext2Apply_invalidIndexRef(t *testing.T) { m := testModule(t, "apply-invalid-index") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected validation failure: %s", diags.Err()) } wantErr := `The given key does not identify an element in this collection value` - _, diags = c.Plan() + _, diags = c.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("plan succeeded; want error") @@ -9471,6 +9152,12 @@ func TestContext2Apply_moduleReplaceCycle(t *testing.T) { aAction = plans.CreateThenDelete } + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + changes := &plans.Changes{ Resources: []*plans.ResourceInstanceChangeSrc{ { @@ -9508,17 +9195,15 @@ func TestContext2Apply_moduleReplaceCycle(t *testing.T) { }, } - ctx := testContext2(t, &ContextOpts{ - Config: m, - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), - }, - State: state, - Changes: changes, - }) + plan := &plans.Plan{ + UIMode: plans.NormalMode, + Changes: changes, + PriorState: state.DeepCopy(), + PrevRunState: state.DeepCopy(), + } t.Run(mode, func(t *testing.T) { - _, diags := ctx.Apply() + _, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -9569,7 +9254,7 @@ func TestContext2Apply_destroyDataCycle(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"a"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.DataResourceMode, Type: "null_data_source", @@ -9606,13 +9291,12 @@ func TestContext2Apply_destroyDataCycle(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) diags.HasErrors() if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) @@ -9621,7 +9305,7 @@ func TestContext2Apply_destroyDataCycle(t *testing.T) { // We'll marshal and unmarshal the plan here, to ensure that we have // a clean new context as would be created if we separately ran // terraform plan -out=tfplan && terraform apply tfplan - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatal(err) } @@ -9644,7 +9328,7 @@ func TestContext2Apply_destroyDataCycle(t *testing.T) { return resp } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -9743,19 +9427,17 @@ func TestContext2Apply_taintedDestroyFailure(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, - State: state, Hooks: []Hook{&testHook{}}, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) diags.HasErrors() if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if !diags.HasErrors() { t.Fatal("expected error") } @@ -9857,19 +9539,18 @@ func TestContext2Apply_plannedConnectionRefs(t *testing.T) { hook := &testHook{} ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, Provisioners: provisioners, Hooks: []Hook{hook}, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) diags.HasErrors() if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -9892,7 +9573,7 @@ func TestContext2Apply_cbdCycle(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"a","require_new":"old","foo":"b"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_instance", @@ -9900,7 +9581,7 @@ func TestContext2Apply_cbdCycle(t *testing.T) { }, Module: addrs.RootModule, }, - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_instance", @@ -9925,7 +9606,7 @@ func TestContext2Apply_cbdCycle(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"b","require_new":"old","foo":"c"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_instance", @@ -9962,13 +9643,11 @@ func TestContext2Apply_cbdCycle(t *testing.T) { hook := &testHook{} ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: Providers, - State: state, Hooks: []Hook{hook}, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) diags.HasErrors() if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) @@ -9977,7 +9656,7 @@ func TestContext2Apply_cbdCycle(t *testing.T) { // We'll marshal and unmarshal the plan here, to ensure that we have // a clean new context as would be created if we separately ran // terraform plan -out=tfplan && terraform apply tfplan - ctxOpts, err := contextOptsForPlanViaFile(snap, plan) + ctxOpts, m, plan, err := contextOptsForPlanViaFile(snap, plan) if err != nil { t.Fatal(err) } @@ -9987,7 +9666,7 @@ func TestContext2Apply_cbdCycle(t *testing.T) { t.Fatalf("failed to create context for plan: %s", diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -10026,16 +9705,15 @@ func TestContext2Apply_ProviderMeta_apply_set(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) if !p.ApplyResourceChangeCalled { @@ -10107,16 +9785,15 @@ func TestContext2Apply_ProviderMeta_apply_unset(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) if !p.ApplyResourceChangeCalled { @@ -10157,13 +9834,12 @@ func TestContext2Apply_ProviderMeta_plan_set(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) if !p.PlanResourceChangeCalled { @@ -10225,13 +9901,12 @@ func TestContext2Apply_ProviderMeta_plan_unset(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) if !p.PlanResourceChangeCalled { @@ -10256,13 +9931,12 @@ func TestContext2Apply_ProviderMeta_plan_setNoSchema(t *testing.T) { p := testProvider("test") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("plan supposed to error, has no errors") } @@ -10305,13 +9979,12 @@ func TestContext2Apply_ProviderMeta_plan_setInvalid(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("plan supposed to error, has no errors") } @@ -10368,19 +10041,18 @@ func TestContext2Apply_ProviderMeta_refresh_set(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) - _, diags = ctx.Refresh() + _, diags = ctx.Refresh(m, state, DefaultPlanOpts) assertNoErrors(t, diags) if !p.ReadResourceCalled { @@ -10438,30 +10110,27 @@ func TestContext2Apply_ProviderMeta_refresh_setNoSchema(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) // drop the schema before refresh, to test that it errors schema.ProviderMeta = nil p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: ctx.State(), }) - _, diags = ctx.Refresh() + _, diags = ctx.Refresh(m, state, DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("refresh supposed to error, has no errors") } @@ -10506,16 +10175,15 @@ func TestContext2Apply_ProviderMeta_refresh_setInvalid(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) // change the schema before refresh, to test that it errors @@ -10529,14 +10197,12 @@ func TestContext2Apply_ProviderMeta_refresh_setInvalid(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: ctx.State(), }) - _, diags = ctx.Refresh() + _, diags = ctx.Refresh(m, state, DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("refresh supposed to error, has no errors") } @@ -10583,7 +10249,6 @@ func TestContext2Apply_ProviderMeta_refreshdata_set(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, @@ -10616,13 +10281,13 @@ func TestContext2Apply_ProviderMeta_refreshdata_set(t *testing.T) { } } - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) - _, diags = ctx.Refresh() + _, diags = ctx.Refresh(m, state, DefaultPlanOpts) assertNoErrors(t, diags) if !p.ReadDataSourceCalled { @@ -10678,7 +10343,6 @@ func TestContext2Apply_ProviderMeta_refreshdata_unset(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, @@ -10708,10 +10372,10 @@ func TestContext2Apply_ProviderMeta_refreshdata_unset(t *testing.T) { } } - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) if !p.ReadDataSourceCalled { @@ -10736,7 +10400,6 @@ func TestContext2Apply_ProviderMeta_refreshdata_setNoSchema(t *testing.T) { p := testProvider("test") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, @@ -10748,7 +10411,7 @@ func TestContext2Apply_ProviderMeta_refreshdata_setNoSchema(t *testing.T) { }), } - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("refresh supposed to error, has no errors") } @@ -10791,7 +10454,6 @@ func TestContext2Apply_ProviderMeta_refreshdata_setInvalid(t *testing.T) { } p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, @@ -10803,7 +10465,7 @@ func TestContext2Apply_ProviderMeta_refreshdata_setInvalid(t *testing.T) { }), } - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("refresh supposed to error, has no errors") } @@ -10868,18 +10530,17 @@ output "out" { p.PlanResourceChangeFn = testDiffFn p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -10928,18 +10589,17 @@ resource "aws_instance" "cbd" { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -11001,23 +10661,22 @@ func TestContext2Apply_moduleDependsOn(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - _, diags = ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - plan, diags := ctx.Plan() + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -11059,36 +10718,35 @@ output "c" { p := testProvider("test") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - _, diags = ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.DestroyMode, }) - _, diags = ctx.Plan() + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -11127,37 +10785,35 @@ output "myoutput" { p := testProvider("test") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.DestroyMode, - State: state, }) - _, diags = ctx.Plan() + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -11274,25 +10930,25 @@ locals { // reduce the count to 1 ctx := testContext2(t, &ContextOpts{ - Variables: InputValues{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "ct": &InputValue{ Value: cty.NumberIntVal(1), SourceType: ValueFromCaller, }, }, - Config: m, - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), - }, - State: state, }) - - _, diags := ctx.Plan() if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { log.Fatal(diags.ErrWithWarnings()) } @@ -11305,25 +10961,25 @@ locals { // reduce the count to 0 ctx = testContext2(t, &ContextOpts{ - Variables: InputValues{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "ct": &InputValue{ Value: cty.NumberIntVal(0), SourceType: ValueFromCaller, }, }, - Config: m, - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), - }, - State: state, }) - - _, diags = ctx.Plan() if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -11449,38 +11105,33 @@ output "output" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(testP), addrs.NewDefaultProvider("null"): testProviderFuncFixed(nullP), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(testP), addrs.NewDefaultProvider("null"): testProviderFuncFixed(nullP), }, - - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("destroy plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("destroy apply errors: %s", diags.Err()) } } @@ -11548,37 +11199,32 @@ output "outputs" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } destroy := func() { ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - - State: state, - PlanMode: plans.DestroyMode, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("destroy plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("destroy apply errors: %s", diags.Err()) } @@ -11621,49 +11267,48 @@ resource "test_resource" "a" { proposed["id"] = cty.UnknownVal(cty.String) return providers.PlanResourceChangeResponse{ PlannedState: cty.ObjectVal(proposed), - RequiresReplace: []cty.Path{cty.Path{cty.GetAttrStep{Name: "value"}}}, + RequiresReplace: []cty.Path{{cty.GetAttrStep{Name: "value"}}}, } } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "v": &InputValue{ Value: cty.StringVal("A"), }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "v": &InputValue{ Value: cty.StringVal("B"), }, }, - State: state, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -11690,44 +11335,43 @@ resource "test_instance" "b" { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "v": &InputValue{ Value: cty.StringVal("A"), }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "v": &InputValue{ Value: cty.StringVal("B"), }, }, - State: state, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -11752,44 +11396,43 @@ resource "test_resource" "c" { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "ct": &InputValue{ Value: cty.NumberIntVal(1), }, }, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "ct": &InputValue{ Value: cty.NumberIntVal(0), }, }, - State: state, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -11853,58 +11496,52 @@ resource "test_resource" "foo" { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } // Run a second apply with no changes ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } // Now change the variable value for sensitive_var ctx = testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags = ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "sensitive_var": &InputValue{ Value: cty.StringVal("bar"), }, }, - State: state, }) + assertNoErrors(t, diags) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } - - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -11931,13 +11568,12 @@ resource "test_resource" "foo" { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("plan errors: %s", diags.Err()) } @@ -11959,7 +11595,7 @@ resource "test_resource" "foo" { fooChangeSrc := plan.Changes.ResourceInstance(addr) verifySensitiveValue(fooChangeSrc.AfterValMarks) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -11995,13 +11631,12 @@ resource "test_resource" "baz" { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("plan errors: %s", diags.Err()) } @@ -12030,7 +11665,7 @@ resource "test_resource" "baz" { bazChangeSrc := plan.Changes.ResourceInstance(bazAddr) verifySensitiveValue(bazChangeSrc.AfterValMarks) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -12059,36 +11694,36 @@ resource "test_resource" "foo" { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"id":"foo", "value":"hello"}`), - // No AttrSensitivePaths present - }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("test"), - Module: addrs.RootModule, - }, - ) - }), }) - _, diags := ctx.Plan() + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"foo", "value":"hello"}`), + // No AttrSensitivePaths present + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ) + }) + + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) addr := mustResourceInstanceAddr("test_resource.foo") - state, diags := ctx.Apply() + state, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) fooState := state.ResourceInstance(addr) @@ -12119,22 +11754,32 @@ resource "test_resource" "foo" { }) ctx2 := testContext2(t, &ContextOpts{ - Config: m2, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags = ctx2.Plan() + // NOTE: Prior to our refactoring to make the state an explicit argument + // of Plan, as opposed to hidden state inside Context, this test was + // calling ctx.Apply instead of ctx2.Apply and thus using the previous + // plan instead of this new plan. "Fixing" it to use the new plan seems + // to break the test, so we've preserved that oddity here by saving the + // old plan as oldPlan and essentially discarding the new plan entirely, + // but this seems rather suspicious and we should ideally figure out what + // this test was originally intending to do and make it do that. + oldPlan := plan + _, diags = ctx2.Plan(m2, state, DefaultPlanOpts) assertNoErrors(t, diags) - - stateWithoutSensitive, diags := ctx.Apply() + stateWithoutSensitive, diags := ctx.Apply(oldPlan, m) assertNoErrors(t, diags) fooState2 := stateWithoutSensitive.ResourceInstance(addr) if len(fooState2.Current.AttrSensitivePaths) > 0 { - t.Fatalf("wrong number of sensitive paths, expected 0, got, %v", len(fooState2.Current.AttrSensitivePaths)) + t.Fatalf( + "wrong number of sensitive paths, expected 0, got, %v\n%s", + len(fooState2.Current.AttrSensitivePaths), + spew.Sdump(fooState2.Current.AttrSensitivePaths), + ) } } @@ -12157,8 +11802,11 @@ output "out" { } `}) - ctx := testContext2(t, &ContextOpts{ - Variables: InputValues{ + ctx := testContext2(t, &ContextOpts{}) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "in": &InputValue{ Value: cty.MapVal(map[string]cty.Value{ "required": cty.StringVal("boop"), @@ -12166,15 +11814,12 @@ output "out" { SourceType: ValueFromCaller, }, }, - Config: m, }) - - _, diags := ctx.Plan() if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -12213,31 +11858,30 @@ func TestContext2Apply_provisionerSensitive(t *testing.T) { h := new(MockHook) ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "password": &InputValue{ Value: cty.StringVal("secret"), SourceType: ValueFromCaller, }, }, }) - - if _, diags := ctx.Plan(); diags.HasErrors() { - logDiagnostics(t, diags) - t.Fatal("plan failed") - } + assertNoErrors(t, diags) // "restart" provisioner pr.CloseCalled = false - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { logDiagnostics(t, diags) t.Fatal("apply failed") @@ -12284,17 +11928,15 @@ resource "test_resource" "foo" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } @@ -12332,17 +11974,16 @@ resource "test_instance" "a" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -12374,19 +12015,19 @@ func TestContext2Apply_dataSensitive(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - if p, diags := ctx.Plan(); diags.HasErrors() { + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { - t.Logf(legacyDiffComparisonString(p.Changes)) + t.Logf(legacyDiffComparisonString(plan.Changes)) } - state, diags := ctx.Apply() + state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) addr := mustResourceInstanceAddr("data.null_data_source.testing") @@ -12429,19 +12070,17 @@ func TestContext2Apply_errorRestorePrivateData(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } - state, _ = ctx.Apply() + state, _ = ctx.Apply(plan, m) if string(state.ResourceInstance(addr).Current.Private) != "private" { t.Fatal("missing private data in state") } @@ -12476,19 +12115,17 @@ func TestContext2Apply_errorRestoreStatus(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } - state, diags = ctx.Apply() + state, diags = ctx.Apply(plan, m) errString := diags.ErrWithWarnings().Error() if !strings.Contains(errString, "oops") || !strings.Contains(errString, "warned") { @@ -12540,18 +12177,17 @@ resource "test_object" "a" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) errString := diags.ErrWithWarnings().Error() if !strings.Contains(errString, "oops") || !strings.Contains(errString, "warned") { t.Fatalf("error missing expected info: %q", errString) @@ -12577,18 +12213,17 @@ resource "test_object" "a" { p.ApplyResourceChangeResponse = &providers.ApplyResourceChangeResponse{} ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } - _, diags = ctx.Apply() + _, diags = ctx.Apply(plan, m) if !diags.HasErrors() { t.Fatal("expected and error") } diff --git a/internal/terraform/context_eval.go b/internal/terraform/context_eval.go new file mode 100644 index 000000000000..8be9b9367846 --- /dev/null +++ b/internal/terraform/context_eval.go @@ -0,0 +1,104 @@ +package terraform + +import ( + "log" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/lang" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +type EvalOpts struct { + SetVariables InputValues +} + +// Eval produces a scope in which expressions can be evaluated for +// the given module path. +// +// This method must first evaluate any ephemeral values (input variables, local +// values, and output values) in the configuration. These ephemeral values are +// not included in the persisted state, so they must be re-computed using other +// values in the state before they can be properly evaluated. The updated +// values are retained in the main state associated with the receiving context. +// +// This function takes no action against remote APIs but it does need access +// to all provider and provisioner instances in order to obtain their schemas +// for type checking. +// +// The result is an evaluation scope that can be used to resolve references +// against the root module. If the returned diagnostics contains errors then +// the returned scope may be nil. If it is not nil then it may still be used +// to attempt expression evaluation or other analysis, but some expressions +// may not behave as expected. +func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr addrs.ModuleInstance, opts *EvalOpts) (*lang.Scope, tfdiags.Diagnostics) { + // This is intended for external callers such as the "terraform console" + // command. Internally, we create an evaluator in c.walk before walking + // the graph, and create scopes in ContextGraphWalker. + + var diags tfdiags.Diagnostics + defer c.acquireRun("eval")() + + schemas, moreDiags := c.Schemas(config, state) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, diags + } + + // Start with a copy of state so that we don't affect the instance that + // the caller is holding. + state = state.DeepCopy() + var walker *ContextGraphWalker + + variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) + + // By the time we get here, we should have values defined for all of + // the root module variables, even if some of them are "unknown". It's the + // caller's responsibility to have already handled the decoding of these + // from the various ways the CLI allows them to be set and to produce + // user-friendly error messages if they are not all present, and so + // the error message from checkInputVariables should never be seen and + // includes language asking the user to report a bug. + varDiags := checkInputVariables(config.Module.Variables, variables) + diags = diags.Append(varDiags) + + log.Printf("[DEBUG] Building and walking 'eval' graph") + + graph, moreDiags := (&EvalGraphBuilder{ + Config: config, + State: state, + Components: c.components, + Schemas: schemas, + }).Build(addrs.RootModuleInstance) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, diags + } + + walkOpts := &graphWalkOpts{ + InputState: state, + Config: config, + Schemas: schemas, + RootVariableValues: variables, + } + + walker, moreDiags = c.walk(graph, walkEval, walkOpts) + diags = diags.Append(moreDiags) + if walker != nil { + diags = diags.Append(walker.NonFatalDiagnostics) + } else { + // If we skipped walking the graph (due to errors) then we'll just + // use a placeholder graph walker here, which'll refer to the + // unmodified state. + walker = c.graphWalker(walkEval, walkOpts) + } + + // This is a bit weird since we don't normally evaluate outside of + // the context of a walk, but we'll "re-enter" our desired path here + // just to get hold of an EvalContext for it. ContextGraphWalker + // caches its contexts, so we should get hold of the context that was + // previously used for evaluation here, unless we skipped walking. + evalCtx := walker.EnterPath(moduleAddr) + return evalCtx.EvaluationScope(nil, EvalDataForNoInstanceKey), diags +} diff --git a/internal/terraform/context_eval_test.go b/internal/terraform/context_eval_test.go index 0fbd20e33bfd..dff6879833e7 100644 --- a/internal/terraform/context_eval_test.go +++ b/internal/terraform/context_eval_test.go @@ -7,6 +7,7 @@ import ( "github.com/hashicorp/hcl/v2/hclsyntax" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/providers" + "github.com/hashicorp/terraform/internal/states" "github.com/zclconf/go-cty/cty" ) @@ -48,13 +49,12 @@ func TestContextEval(t *testing.T) { m := testModule(t, "eval-context-basic") p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - scope, diags := ctx.Eval(addrs.RootModuleInstance) + scope, diags := ctx.Eval(m, states.NewState(), addrs.RootModuleInstance, &EvalOpts{}) if diags.HasErrors() { t.Fatalf("Eval errors: %s", diags.Err()) } diff --git a/internal/terraform/context_fixtures_test.go b/internal/terraform/context_fixtures_test.go index 4853f4a4226d..2e9e9c27511d 100644 --- a/internal/terraform/context_fixtures_test.go +++ b/internal/terraform/context_fixtures_test.go @@ -25,7 +25,6 @@ type contextTestFixture struct { // _shallow_ modifications to the options as needed. func (f *contextTestFixture) ContextOpts() *ContextOpts { return &ContextOpts{ - Config: f.Config, Providers: f.Providers, Provisioners: f.Provisioners, } diff --git a/internal/terraform/context_graph_type.go b/internal/terraform/context_graph_type.go deleted file mode 100644 index 658779e6ae39..000000000000 --- a/internal/terraform/context_graph_type.go +++ /dev/null @@ -1,30 +0,0 @@ -package terraform - -//go:generate go run golang.org/x/tools/cmd/stringer -type=GraphType context_graph_type.go - -// GraphType is an enum of the type of graph to create with a Context. -// The values of the constants may change so they shouldn't be depended on; -// always use the constant name. -type GraphType byte - -const ( - GraphTypeInvalid GraphType = iota - GraphTypePlan - GraphTypePlanDestroy - GraphTypePlanRefreshOnly - GraphTypeApply - GraphTypeValidate - GraphTypeEval // only visits in-memory elements such as variables, locals, and outputs. -) - -// GraphTypeMap is a mapping of human-readable string to GraphType. This -// is useful to use as the mechanism for human input for configurable -// graph types. -var GraphTypeMap = map[string]GraphType{ - "apply": GraphTypeApply, - "plan": GraphTypePlan, - "plan-destroy": GraphTypePlanDestroy, - "plan-refresh-only": GraphTypePlanRefreshOnly, - "validate": GraphTypeValidate, - "eval": GraphTypeEval, -} diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index ccee059d7799..48a5858a3df1 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -1,7 +1,10 @@ package terraform import ( + "log" + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -10,6 +13,10 @@ import ( type ImportOpts struct { // Targets are the targets to import Targets []*ImportTarget + + // SetVariables are the variables set outside of the configuration, + // such as on the command line, in variables files, etc. + SetVariables InputValues } // ImportTarget is a single resource to import. @@ -35,36 +42,52 @@ type ImportTarget struct { // Further, this operation also gracefully handles partial state. If during // an import there is a failure, all previously imported resources remain // imported. -func (c *Context) Import(opts *ImportOpts) (*states.State, tfdiags.Diagnostics) { +func (c *Context) Import(config *configs.Config, prevRunState *states.State, opts *ImportOpts) (*states.State, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // Hold a lock since we can modify our own state here defer c.acquireRun("import")() - // Copy our own state - c.state = c.state.DeepCopy() + schemas, moreDiags := c.Schemas(config, prevRunState) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, diags + } + + // Don't modify our caller's state + state := prevRunState.DeepCopy() + + log.Printf("[DEBUG] Building and walking import graph") // Initialize our graph builder builder := &ImportGraphBuilder{ ImportTargets: opts.Targets, - Config: c.config, + Config: config, Components: c.components, - Schemas: c.schemas, + Schemas: schemas, } - // Build the graph! + // Build the graph graph, graphDiags := builder.Build(addrs.RootModuleInstance) diags = diags.Append(graphDiags) if graphDiags.HasErrors() { - return c.state, diags + return state, diags } + variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) + // Walk it - _, walkDiags := c.walk(graph, walkImport, &graphWalkOpts{}) + walker, walkDiags := c.walk(graph, walkImport, &graphWalkOpts{ + Config: config, + Schemas: schemas, + InputState: state, + RootVariableValues: variables, + }) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { - return c.state, diags + return state, diags } - return c.state, diags + newState := walker.State.Close() + return newState, diags } diff --git a/internal/terraform/context_import_test.go b/internal/terraform/context_import_test.go index 5a645c7e5150..605010d17569 100644 --- a/internal/terraform/context_import_test.go +++ b/internal/terraform/context_import_test.go @@ -16,7 +16,6 @@ func TestContextImport_basic(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-provider") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -33,9 +32,9 @@ func TestContextImport_basic(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -49,7 +48,7 @@ func TestContextImport_basic(t *testing.T) { actual := strings.TrimSpace(state.String()) expected := strings.TrimSpace(testImportStr) if actual != expected { - t.Fatalf("bad: \n%s", actual) + t.Fatalf("wrong final state\ngot:\n%s\nwant:\n%s", actual, expected) } } @@ -57,7 +56,6 @@ func TestContextImport_countIndex(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-provider") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -74,9 +72,9 @@ func TestContextImport_countIndex(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.IntKey(0), ), @@ -99,30 +97,29 @@ func TestContextImport_collision(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-provider") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) - State: states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "aws_instance", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - AttrsFlat: map[string]string{ - "id": "bar", - }, - Status: states.ObjectReady, + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "aws_instance", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + AttrsFlat: map[string]string{ + "id": "bar", }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("aws"), - Module: addrs.RootModule, - }, - ) - }), + Status: states.ObjectReady, + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("aws"), + Module: addrs.RootModule, + }, + ) }) p.ImportResourceStateResponse = &providers.ImportResourceStateResponse{ @@ -136,9 +133,9 @@ func TestContextImport_collision(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, state, &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -175,15 +172,14 @@ func TestContextImport_missingType(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -227,15 +223,14 @@ func TestContextImport_moduleProvider(t *testing.T) { m := testModule(t, "import-provider") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -263,7 +258,6 @@ func TestContextImport_providerModule(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-module") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -289,9 +283,9 @@ func TestContextImport_providerModule(t *testing.T) { return } - _, diags := ctx.Import(&ImportOpts{ + _, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.Child("child", addrs.NoKey).ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -329,16 +323,9 @@ func TestContextImport_providerConfig(t *testing.T) { p := testProvider("aws") m := testModule(t, test.module) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "foo": &InputValue{ - Value: cty.StringVal("bar"), - SourceType: ValueFromCaller, - }, - }, }) p.ImportResourceStateResponse = &providers.ImportResourceStateResponse{ @@ -352,15 +339,21 @@ func TestContextImport_providerConfig(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), ID: "bar", }, }, + SetVariables: InputValues{ + "foo": &InputValue{ + Value: cty.StringVal("bar"), + SourceType: ValueFromCaller, + }, + }, }) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) @@ -389,7 +382,6 @@ func TestContextImport_providerConfigResources(t *testing.T) { pTest := testProvider("test") m := testModule(t, "import-provider-resources") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("test"): testProviderFuncFixed(pTest), @@ -407,9 +399,9 @@ func TestContextImport_providerConfigResources(t *testing.T) { }, } - _, diags := ctx.Import(&ImportOpts{ + _, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -429,7 +421,6 @@ func TestContextImport_refresh(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-provider") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -455,9 +446,9 @@ func TestContextImport_refresh(t *testing.T) { }), } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -480,7 +471,6 @@ func TestContextImport_refreshNil(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-provider") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -503,9 +493,9 @@ func TestContextImport_refreshNil(t *testing.T) { } } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -528,7 +518,6 @@ func TestContextImport_module(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-module") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -545,9 +534,9 @@ func TestContextImport_module(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.Child("child", addrs.IntKey(0)).ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -570,7 +559,6 @@ func TestContextImport_moduleDepth2(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-module") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -587,9 +575,9 @@ func TestContextImport_moduleDepth2(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.Child("child", addrs.IntKey(0)).Child("nested", addrs.NoKey).ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -612,7 +600,6 @@ func TestContextImport_moduleDiff(t *testing.T) { p := testProvider("aws") m := testModule(t, "import-module") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -629,9 +616,9 @@ func TestContextImport_moduleDiff(t *testing.T) { }, } - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.Child("child", addrs.IntKey(0)).ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -692,15 +679,14 @@ func TestContextImport_multiState(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -767,15 +753,14 @@ func TestContextImport_multiStateSame(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.NoKey, ), @@ -866,15 +851,14 @@ resource "test_resource" "unused" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - state, diags := ctx.Import(&ImportOpts{ + state, diags := ctx.Import(m, states.NewState(), &ImportOpts{ Targets: []*ImportTarget{ - &ImportTarget{ + { Addr: addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "test_resource", "test", addrs.NoKey, ), @@ -888,6 +872,9 @@ resource "test_resource" "unused" { ri := state.ResourceInstance(mustResourceInstanceAddr("test_resource.test")) expected := `{"id":"test"}` + if ri == nil || ri.Current == nil { + t.Fatal("no state is recorded for resource instance test_resource.test") + } if string(ri.Current.AttrsJSON) != expected { t.Fatalf("expected %q, got %q\n", expected, ri.Current.AttrsJSON) } diff --git a/internal/terraform/context_input.go b/internal/terraform/context_input.go index 1a94e94bb016..153546d2868b 100644 --- a/internal/terraform/context_input.go +++ b/internal/terraform/context_input.go @@ -17,9 +17,21 @@ import ( // Input asks for input to fill unset required arguments in provider // configurations. // -// This modifies the configuration in-place, so asking for Input twice -// may result in different UI output showing different current values. -func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { +// Unlike the other better-behaved operation methods, this one actually +// modifies some internal state inside the receving context so that the +// captured values will be implicitly available to a subsequent call to Plan, +// or to some other operation entry point. Hopefully a future iteration of +// this will change design to make that data flow more explicit. +// +// Because Input saves the results inside the Context object, asking for +// input twice on the same Context is invalid and will lead to undefined +// behavior. +// +// Once you've called Input with a particular config, it's invalid to call +// any other Context method with a different config, because the aforementioned +// modified internal state won't match. Again, this is an architectural wart +// that we'll hopefully resolve in future. +func (c *Context) Input(config *configs.Config, mode InputMode) tfdiags.Diagnostics { // This function used to be responsible for more than it is now, so its // interface is more general than its current functionality requires. // It now exists only to handle interactive prompts for provider @@ -33,6 +45,12 @@ func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { var diags tfdiags.Diagnostics defer c.acquireRun("input")() + schemas, moreDiags := c.Schemas(config, nil) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return diags + } + if c.uiInput == nil { log.Printf("[TRACE] Context.Input: uiInput is nil, so skipping") return diags @@ -44,17 +62,15 @@ func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { log.Printf("[TRACE] Context.Input: Prompting for provider arguments") // We prompt for input only for provider configurations defined in - // the root module. At the time of writing that is an arbitrary - // restriction, but we have future plans to support "count" and - // "for_each" on modules that will then prevent us from supporting - // input for child module configurations anyway (since we'd need to - // dynamic-expand first), and provider configurations in child modules - // are not recommended since v0.11 anyway, so this restriction allows - // us to keep this relatively simple without significant hardship. + // the root module. Provider configurations in other modules are a + // legacy thing we no longer recommend, and even if they weren't we + // can't practically prompt for their inputs here because we've not + // yet done "expansion" and so we don't know whether the modules are + // using count or for_each. pcs := make(map[string]*configs.Provider) pas := make(map[string]addrs.LocalProviderConfig) - for _, pc := range c.config.Module.ProviderConfigs { + for _, pc := range config.Module.ProviderConfigs { addr := pc.Addr() pcs[addr.String()] = pc pas[addr.String()] = addr @@ -63,7 +79,7 @@ func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { // We also need to detect _implied_ provider configs from resources. // These won't have *configs.Provider objects, but they will still // exist in the map and we'll just treat them as empty below. - for _, rc := range c.config.Module.ManagedResources { + for _, rc := range config.Module.ManagedResources { pa := rc.ProviderConfigAddr() if pa.Alias != "" { continue // alias configurations cannot be implied @@ -74,7 +90,7 @@ func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { log.Printf("[TRACE] Context.Input: Provider %s implied by resource block at %s", pa, rc.DeclRange) } } - for _, rc := range c.config.Module.DataResources { + for _, rc := range config.Module.DataResources { pa := rc.ProviderConfigAddr() if pa.Alias != "" { continue // alias configurations cannot be implied @@ -96,8 +112,8 @@ func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { UIInput: c.uiInput, } - providerFqn := c.config.Module.ProviderForLocalConfig(pa) - schema := c.schemas.ProviderConfig(providerFqn) + providerFqn := config.Module.ProviderForLocalConfig(pa) + schema := schemas.ProviderConfig(providerFqn) if schema == nil { // Could either be an incorrect config or just an incomplete // mock in tests. We'll let a later pass decide, and just @@ -160,7 +176,7 @@ func (c *Context) Input(mode InputMode) tfdiags.Diagnostics { absConfigAddr := addrs.AbsProviderConfig{ Provider: providerFqn, Alias: pa.Alias, - Module: c.Config().Path, + Module: config.Path, } c.providerInputConfig[absConfigAddr.String()] = vals diff --git a/internal/terraform/context_input_test.go b/internal/terraform/context_input_test.go index 92aaaccb13f3..819856a6c7d6 100644 --- a/internal/terraform/context_input_test.go +++ b/internal/terraform/context_input_test.go @@ -10,6 +10,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/states" ) @@ -46,7 +47,6 @@ func TestContext2Input_provider(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -59,7 +59,7 @@ func TestContext2Input_provider(t *testing.T) { return } - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } @@ -70,11 +70,10 @@ func TestContext2Input_provider(t *testing.T) { t.Errorf("wrong description\ngot: %q\nwant: %q", got, want) } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -117,7 +116,6 @@ func TestContext2Input_providerMulti(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -127,13 +125,12 @@ func TestContext2Input_providerMulti(t *testing.T) { var actual []interface{} var lock sync.Mutex - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) p.ConfigureProviderFn = func(req providers.ConfigureProviderRequest) (resp providers.ConfigureProviderResponse) { lock.Lock() @@ -141,7 +138,7 @@ func TestContext2Input_providerMulti(t *testing.T) { actual = append(actual, req.Config.GetAttr("foo").AsString()) return } - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -155,13 +152,12 @@ func TestContext2Input_providerOnce(t *testing.T) { m := testModule(t, "input-provider-once") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } } @@ -195,7 +191,6 @@ func TestContext2Input_providerId(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -212,15 +207,14 @@ func TestContext2Input_providerId(t *testing.T) { "provider.aws.foo": "bar", } - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -255,16 +249,9 @@ func TestContext2Input_providerOnly(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "foo": &InputValue{ - Value: cty.StringVal("us-west-2"), - SourceType: ValueFromCaller, - }, - }, UIInput: input, }) @@ -278,15 +265,30 @@ func TestContext2Input_providerOnly(t *testing.T) { return } - if err := ctx.Input(InputModeProvider); err != nil { + if err := ctx.Input(m, InputModeProvider); err != nil { t.Fatalf("err: %s", err) } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + // NOTE: This is a stale test case from an older version of Terraform + // where Input was responsible for prompting for both input variables _and_ + // provider configuration arguments, where it was trying to test the case + // where we were turning off the mode of prompting for input variables. + // That's now always disabled, and so this is essentially the same as the + // normal Input test, but we're preserving it until we have time to review + // and make sure this isn't inadvertently providing unique test coverage + // other than what it set out to test. + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "foo": &InputValue{ + Value: cty.StringVal("us-west-2"), + SourceType: ValueFromCaller, + }, + }, + }) + assertNoErrors(t, diags) - state, err := ctx.Apply() + state, err := ctx.Apply(plan, m) if err != nil { t.Fatalf("err: %s", err) } @@ -307,16 +309,9 @@ func TestContext2Input_providerVars(t *testing.T) { m := testModule(t, "input-provider-with-vars") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "foo": &InputValue{ - Value: cty.StringVal("bar"), - SourceType: ValueFromCaller, - }, - }, UIInput: input, }) @@ -329,15 +324,22 @@ func TestContext2Input_providerVars(t *testing.T) { actual = req.Config.GetAttr("foo").AsString() return } - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } - if _, diags := ctx.Plan(); diags.HasErrors() { - t.Fatalf("plan errors: %s", diags.Err()) - } + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "foo": &InputValue{ + Value: cty.StringVal("bar"), + SourceType: ValueFromCaller, + }, + }, + }) + assertNoErrors(t, diags) - if _, diags := ctx.Apply(); diags.HasErrors() { + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } @@ -351,14 +353,13 @@ func TestContext2Input_providerVarsModuleInherit(t *testing.T) { m := testModule(t, "input-provider-with-vars-and-module") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, UIInput: input, }) - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } } @@ -369,14 +370,13 @@ func TestContext2Input_submoduleTriggersInvalidCount(t *testing.T) { m := testModule(t, "input-submodule-count") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, UIInput: input, }) - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } } @@ -427,23 +427,25 @@ func TestContext2Input_dataSourceRequiresRefresh(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, - State: state, UIInput: input, }) - if diags := ctx.Input(InputModeStd); diags.HasErrors() { + if diags := ctx.Input(m, InputModeStd); diags.HasErrors() { t.Fatalf("input errors: %s", diags.Err()) } - // ensure that plan works after Refresh - if _, diags := ctx.Refresh(); diags.HasErrors() { + // ensure that plan works after Refresh. This is a legacy test that + // doesn't really make sense anymore, because Refresh is really just + // a wrapper around plan anyway, but we're keeping it until we get a + // chance to review and check whether it's giving us any additional + // test coverage aside from what it's specifically intending to test. + if _, diags := ctx.Refresh(m, state, DefaultPlanOpts); diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } - if _, diags := ctx.Plan(); diags.HasErrors() { + if _, diags := ctx.Plan(m, state, DefaultPlanOpts); diags.HasErrors() { t.Fatalf("plan errors: %s", diags.Err()) } } diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go new file mode 100644 index 000000000000..be5d30e61376 --- /dev/null +++ b/internal/terraform/context_plan.go @@ -0,0 +1,435 @@ +package terraform + +import ( + "fmt" + "log" + + "github.com/zclconf/go-cty/cty" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/instances" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/refactoring" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +// PlanOpts are the various options that affect the details of how Terraform +// will build a plan. +type PlanOpts struct { + Mode plans.Mode + SkipRefresh bool + SetVariables InputValues + Targets []addrs.Targetable + ForceReplace []addrs.AbsResourceInstance +} + +// Plan generates an execution plan for the given context, and returns the +// refreshed state. +// +// The execution plan encapsulates the context and can be stored +// in order to reinstantiate a context later for Apply. +// +// Plan also updates the diff of this context to be the diff generated +// by the plan, so Apply can be called after. +func (c *Context) Plan(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { + defer c.acquireRun("plan")() + var diags tfdiags.Diagnostics + + // Save the downstream functions from needing to deal with these broken situations. + // No real callers should rely on these, but we have a bunch of old and + // sloppy tests that don't always populate arguments properly. + if config == nil { + config = configs.NewEmptyConfig() + } + if prevRunState == nil { + prevRunState = states.NewState() + } + if opts == nil { + opts = &PlanOpts{ + Mode: plans.NormalMode, + } + } + + moreDiags := CheckCoreVersionRequirements(config) + diags = diags.Append(moreDiags) + // If version constraints are not met then we'll bail early since otherwise + // we're likely to just see a bunch of other errors related to + // incompatibilities, which could be overwhelming for the user. + if diags.HasErrors() { + return nil, diags + } + + switch opts.Mode { + case plans.NormalMode, plans.DestroyMode: + // OK + case plans.RefreshOnlyMode: + if opts.SkipRefresh { + // The CLI layer (and other similar callers) should prevent this + // combination of options. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Incompatible plan options", + "Cannot skip refreshing in refresh-only mode. This is a bug in Terraform.", + )) + return nil, diags + } + default: + // The CLI layer (and other similar callers) should not try to + // create a context for a mode that Terraform Core doesn't support. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Unsupported plan mode", + fmt.Sprintf("Terraform Core doesn't know how to handle plan mode %s. This is a bug in Terraform.", opts.Mode), + )) + return nil, diags + } + if len(opts.ForceReplace) > 0 && opts.Mode != plans.NormalMode { + // The other modes don't generate no-op or update actions that we might + // upgrade to be "replace", so doesn't make sense to combine those. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Unsupported plan mode", + "Forcing resource instance replacement (with -replace=...) is allowed only in normal planning mode.", + )) + return nil, diags + } + + variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) + + // By the time we get here, we should have values defined for all of + // the root module variables, even if some of them are "unknown". It's the + // caller's responsibility to have already handled the decoding of these + // from the various ways the CLI allows them to be set and to produce + // user-friendly error messages if they are not all present, and so + // the error message from checkInputVariables should never be seen and + // includes language asking the user to report a bug. + varDiags := checkInputVariables(config.Module.Variables, variables) + diags = diags.Append(varDiags) + + if len(opts.Targets) > 0 { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Warning, + "Resource targeting is in effect", + `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. + +The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, + )) + } + + var plan *plans.Plan + var planDiags tfdiags.Diagnostics + switch opts.Mode { + case plans.NormalMode: + plan, planDiags = c.plan(config, prevRunState, variables, opts) + case plans.DestroyMode: + plan, planDiags = c.destroyPlan(config, prevRunState, variables, opts) + case plans.RefreshOnlyMode: + plan, planDiags = c.refreshOnlyPlan(config, prevRunState, variables, opts) + default: + panic(fmt.Sprintf("unsupported plan mode %s", opts.Mode)) + } + diags = diags.Append(planDiags) + if diags.HasErrors() { + return nil, diags + } + + // convert the variables into the format expected for the plan + varVals := make(map[string]plans.DynamicValue, len(variables)) + for k, iv := range variables { + // We use cty.DynamicPseudoType here so that we'll save both the + // value _and_ its dynamic type in the plan, so we can recover + // exactly the same value later. + dv, err := plans.NewDynamicValue(iv.Value, cty.DynamicPseudoType) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to prepare variable value for plan", + fmt.Sprintf("The value for variable %q could not be serialized to store in the plan: %s.", k, err), + )) + continue + } + varVals[k] = dv + } + + // insert the run-specific data from the context into the plan; variables, + // targets and provider SHAs. + if plan != nil { + plan.VariableValues = varVals + plan.TargetAddrs = opts.Targets + plan.ProviderSHA256s = c.providerSHA256s + } else if !diags.HasErrors() { + panic("nil plan but no errors") + } + + return plan, diags +} + +var DefaultPlanOpts = &PlanOpts{ + Mode: plans.NormalMode, +} + +func (c *Context) plan(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + if opts.Mode != plans.NormalMode { + panic(fmt.Sprintf("called Context.plan with %s", opts.Mode)) + } + + plan, walkDiags := c.planWalk(config, prevRunState, rootVariables, opts) + diags = diags.Append(walkDiags) + if diags.HasErrors() { + return nil, diags + } + + // The refreshed state ends up with some placeholder objects in it for + // objects pending creation. We only really care about those being in + // the working state, since that's what we're going to use when applying, + // so we'll prune them all here. + plan.PriorState.SyncWrapper().RemovePlannedResourceInstanceObjects() + + return plan, diags +} + +func (c *Context) refreshOnlyPlan(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + if opts.Mode != plans.RefreshOnlyMode { + panic(fmt.Sprintf("called Context.refreshOnlyPlan with %s", opts.Mode)) + } + + plan, walkDiags := c.planWalk(config, prevRunState, rootVariables, opts) + diags = diags.Append(walkDiags) + if diags.HasErrors() { + return nil, diags + } + + // If the graph builder and graph nodes correctly obeyed our directive + // to refresh only, the set of resource changes should always be empty. + // We'll safety-check that here so we can return a clear message about it, + // rather than probably just generating confusing output at the UI layer. + if len(plan.Changes.Resources) != 0 { + // Some extra context in the logs in case the user reports this message + // as a bug, as a starting point for debugging. + for _, rc := range plan.Changes.Resources { + if depKey := rc.DeposedKey; depKey == states.NotDeposed { + log.Printf("[DEBUG] Refresh-only plan includes %s change for %s", rc.Action, rc.Addr) + } else { + log.Printf("[DEBUG] Refresh-only plan includes %s change for %s deposed object %s", rc.Action, rc.Addr, depKey) + } + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid refresh-only plan", + "Terraform generated planned resource changes in a refresh-only plan. This is a bug in Terraform.", + )) + } + + // Prune out any placeholder objects we put in the state to represent + // objects that would need to be created. + plan.PriorState.SyncWrapper().RemovePlannedResourceInstanceObjects() + + return plan, diags +} + +func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + pendingPlan := &plans.Plan{} + + if opts.Mode != plans.DestroyMode { + panic(fmt.Sprintf("called Context.destroyPlan with %s", opts.Mode)) + } + + priorState := prevRunState + + // A destroy plan starts by running Refresh to read any pending data + // sources, and remove missing managed resources. This is required because + // a "destroy plan" is only creating delete changes, and is essentially a + // local operation. + // + // NOTE: if skipRefresh _is_ set then we'll rely on the destroy-plan walk + // below to upgrade the prevRunState and priorState both to the latest + // resource type schemas, so NodePlanDestroyableResourceInstance.Execute + // must coordinate with this by taking that action only when c.skipRefresh + // _is_ set. This coupling between the two is unfortunate but necessary + // to work within our current structure. + if !opts.SkipRefresh { + log.Printf("[TRACE] Context.destroyPlan: calling Context.plan to get the effect of refreshing the prior state") + normalOpts := *opts + normalOpts.Mode = plans.NormalMode + refreshPlan, refreshDiags := c.plan(config, prevRunState, rootVariables, &normalOpts) + diags = diags.Append(refreshDiags) + if diags.HasErrors() { + return nil, diags + } + + // insert the refreshed state into the destroy plan result, and ignore + // the changes recorded from the refresh. + pendingPlan.PriorState = refreshPlan.PriorState.DeepCopy() + pendingPlan.PrevRunState = refreshPlan.PrevRunState.DeepCopy() + log.Printf("[TRACE] Context.destroyPlan: now _really_ creating a destroy plan") + + // We'll use the refreshed state -- which is the "prior state" from + // the perspective of this "pending plan" -- as the starting state + // for our destroy-plan walk, so it can take into account if we + // detected during refreshing that anything was already deleted outside + // of Terraform. + priorState = pendingPlan.PriorState + } + + destroyPlan, walkDiags := c.planWalk(config, priorState, rootVariables, opts) + diags = diags.Append(walkDiags) + if walkDiags.HasErrors() { + return nil, diags + } + + if !opts.SkipRefresh { + // If we didn't skip refreshing then we want the previous run state + // prior state to be the one we originally fed into the c.plan call + // above, not the refreshed version we used for the destroy walk. + destroyPlan.PrevRunState = pendingPlan.PrevRunState + } + + return destroyPlan, diags +} + +func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState *states.State, targets []addrs.Targetable) ([]refactoring.MoveStatement, map[addrs.UniqueKey]refactoring.MoveResult) { + moveStmts := refactoring.FindMoveStatements(config) + moveResults := refactoring.ApplyMoves(moveStmts, prevRunState) + if len(targets) > 0 { + for _, result := range moveResults { + matchesTarget := false + for _, targetAddr := range targets { + if targetAddr.TargetContains(result.From) { + matchesTarget = true + break + } + } + if !matchesTarget { + // TODO: Return an error stating that a targeted plan is + // only valid if it includes this address that was moved. + } + } + } + return moveStmts, moveResults +} + +func (c *Context) postPlanValidateMoves(config *configs.Config, stmts []refactoring.MoveStatement, allInsts instances.Set) tfdiags.Diagnostics { + return refactoring.ValidateMoves(stmts, config, allInsts) +} + +func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + log.Printf("[DEBUG] Building and walking plan graph for %s", opts.Mode) + + schemas, moreDiags := c.Schemas(config, prevRunState) + diags = diags.Append(moreDiags) + if diags.HasErrors() { + return nil, diags + } + + prevRunState = prevRunState.DeepCopy() // don't modify the caller's object when we process the moves + moveStmts, moveResults := c.prePlanFindAndApplyMoves(config, prevRunState, opts.Targets) + + graph, walkOp, moreDiags := c.planGraph(config, prevRunState, opts, schemas, true) + diags = diags.Append(moreDiags) + if diags.HasErrors() { + return nil, diags + } + + // If we get here then we should definitely have a non-nil "graph", which + // we can now walk. + changes := plans.NewChanges() + walker, walkDiags := c.walk(graph, walkOp, &graphWalkOpts{ + Config: config, + Schemas: schemas, + InputState: prevRunState, + Changes: changes, + MoveResults: moveResults, + RootVariableValues: rootVariables, + }) + diags = diags.Append(walker.NonFatalDiagnostics) + diags = diags.Append(walkDiags) + diags = diags.Append(c.postPlanValidateMoves(config, moveStmts, walker.InstanceExpander.AllInstances())) + + plan := &plans.Plan{ + UIMode: opts.Mode, + Changes: changes, + PriorState: walker.RefreshState.Close(), + PrevRunState: walker.PrevRunState.Close(), + + // Other fields get populated by Context.Plan after we return + } + return plan, diags +} + +func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, opts *PlanOpts, schemas *Schemas, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { + switch mode := opts.Mode; mode { + case plans.NormalMode: + graph, diags := (&PlanGraphBuilder{ + Config: config, + State: prevRunState, + Components: c.components, + Schemas: schemas, + Targets: opts.Targets, + ForceReplace: opts.ForceReplace, + Validate: validate, + skipRefresh: opts.SkipRefresh, + }).Build(addrs.RootModuleInstance) + return graph, walkPlan, diags + case plans.RefreshOnlyMode: + graph, diags := (&PlanGraphBuilder{ + Config: config, + State: prevRunState, + Components: c.components, + Schemas: schemas, + Targets: opts.Targets, + Validate: validate, + skipRefresh: opts.SkipRefresh, + skipPlanChanges: true, // this activates "refresh only" mode. + }).Build(addrs.RootModuleInstance) + return graph, walkPlan, diags + case plans.DestroyMode: + graph, diags := (&DestroyPlanGraphBuilder{ + Config: config, + State: prevRunState, + Components: c.components, + Schemas: schemas, + Targets: opts.Targets, + Validate: validate, + skipRefresh: opts.SkipRefresh, + }).Build(addrs.RootModuleInstance) + return graph, walkPlanDestroy, diags + default: + // The above should cover all plans.Mode values + panic(fmt.Sprintf("unsupported plan mode %s", mode)) + } +} + +// PlanGraphForUI is a last vestage of graphs in the public interface of Context +// (as opposed to graphs as an implementation detail) intended only for use +// by the "terraform graph" command when asked to render a plan-time graph. +// +// The result of this is intended only for rendering ot the user as a dot +// graph, and so may change in future in order to make the result more useful +// in that context, even if drifts away from the physical graph that Terraform +// Core currently uses as an implementation detail of planning. +func (c *Context) PlanGraphForUI(config *configs.Config, prevRunState *states.State, mode plans.Mode) (*Graph, tfdiags.Diagnostics) { + // For now though, this really is just the internal graph, confusing + // implementation details and all. + + var diags tfdiags.Diagnostics + + opts := &PlanOpts{Mode: mode} + + schemas, moreDiags := c.Schemas(config, prevRunState) + diags = diags.Append(moreDiags) + if diags.HasErrors() { + return nil, diags + } + + graph, _, moreDiags := c.planGraph(config, prevRunState, opts, schemas, false) + diags = diags.Append(moreDiags) + return graph, diags +} diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index a5242ad89967..08796a3c1bf2 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -69,17 +69,13 @@ resource "test_object" "a" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) if !p.UpgradeResourceStateCalled { t.Errorf("Provider's UpgradeResourceState wasn't called; should've been") @@ -184,17 +180,13 @@ data "test_data_source" "foo" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) for _, res := range plan.Changes.Resources { if res.Action != plans.NoOp { @@ -231,17 +223,13 @@ output "out" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) change, err := plan.Changes.Outputs[0].Decode() if err != nil { @@ -300,16 +288,13 @@ resource "test_object" "a" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + assertNoErrors(t, diags) } func TestContext2Plan_dataReferencesResourceInModules(t *testing.T) { @@ -376,14 +361,12 @@ resource "test_resource" "b" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) oldMod := oldDataAddr.Module @@ -466,19 +449,16 @@ resource "test_object" "a" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.DestroyMode, - SkipRefresh: false, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + SkipRefresh: false, // the default + }) + assertNoErrors(t, diags) if !p.UpgradeResourceStateCalled { t.Errorf("Provider's UpgradeResourceState wasn't called; should've been") @@ -569,19 +549,16 @@ resource "test_object" "a" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.DestroyMode, - SkipRefresh: true, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + SkipRefresh: true, + }) + assertNoErrors(t, diags) if !p.UpgradeResourceStateCalled { t.Errorf("Provider's UpgradeResourceState wasn't called; should've been") @@ -665,17 +642,13 @@ output "result" { state := states.NewState() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) for _, res := range plan.Changes.Resources { if res.Action != plans.Create { @@ -716,18 +689,15 @@ provider "test" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.DestroyMode, }) - _, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.Err()) - } + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + assertNoErrors(t, diags) } func TestContext2Plan_movedResourceBasic(t *testing.T) { @@ -762,17 +732,17 @@ func TestContext2Plan_movedResourceBasic(t *testing.T) { p := simpleMockProvider() ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, ForceReplace: []addrs.AbsResourceInstance{ addrA, }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors\n%s", diags.Err().Error()) } @@ -873,15 +843,14 @@ func TestContext2Plan_refreshOnlyMode(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.RefreshOnlyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + }) if diags.HasErrors() { t.Fatalf("unexpected errors\n%s", diags.Err().Error()) } @@ -1010,15 +979,14 @@ func TestContext2Plan_refreshOnlyMode_deposed(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - PlanMode: plans.RefreshOnlyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + }) if diags.HasErrors() { t.Fatalf("unexpected errors\n%s", diags.Err().Error()) } @@ -1089,11 +1057,9 @@ output "root" { }`, }) - ctx := testContext2(t, &ContextOpts{ - Config: m, - }) + ctx := testContext2(t, &ContextOpts{}) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1189,17 +1155,13 @@ data "test_data_source" "foo" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() - if diags.HasErrors() { - t.Fatal(diags.ErrWithWarnings()) - } + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) for _, res := range plan.Changes.Resources { switch res.Addr.String() { @@ -1242,17 +1204,17 @@ func TestContext2Plan_forceReplace(t *testing.T) { p := simpleMockProvider() ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, ForceReplace: []addrs.AbsResourceInstance{ addrA, }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors\n%s", diags.Err().Error()) } @@ -1310,17 +1272,17 @@ func TestContext2Plan_forceReplaceIncompleteAddr(t *testing.T) { p := simpleMockProvider() ctx := testContext2(t, &ContextOpts{ - Config: m, - State: state, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, ForceReplace: []addrs.AbsResourceInstance{ addrBare, }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors\n%s", diags.Err().Error()) } diff --git a/internal/terraform/context_plan_test.go b/internal/terraform/context_plan_test.go index 8a5bc9e6f9af..475bcb661f13 100644 --- a/internal/terraform/context_plan_test.go +++ b/internal/terraform/context_plan_test.go @@ -30,7 +30,6 @@ func TestContext2Plan_basic(t *testing.T) { m := testModule(t, "plan-good") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -39,7 +38,7 @@ func TestContext2Plan_basic(t *testing.T) { }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -52,10 +51,6 @@ func TestContext2Plan_basic(t *testing.T) { t.Errorf("wrong ProviderSHA256s %#v; want %#v", plan.ProviderSHA256s, ctx.providerSHA256s) } - if !ctx.State().Empty() { - t.Fatalf("expected empty state, got %#v\n", ctx.State()) - } - schema := p.GetProviderSchemaResponse.ResourceTypes["aws_instance"].Block ty := schema.ImpliedType() for _, r := range plan.Changes.Resources { @@ -112,14 +107,12 @@ func TestContext2Plan_createBefore_deposed(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -132,8 +125,8 @@ func TestContext2Plan_createBefore_deposed(t *testing.T) { type = aws_instance Deposed ID 1 = foo`) - if ctx.State().String() != expectedState { - t.Fatalf("\nexpected: %q\ngot: %q\n", expectedState, ctx.State().String()) + if plan.PriorState.String() != expectedState { + t.Fatalf("\nexpected: %q\ngot: %q\n", expectedState, plan.PriorState.String()) } schema := p.GetProviderSchemaResponse.ResourceTypes["aws_instance"].Block @@ -205,19 +198,18 @@ func TestContext2Plan_createBefore_maintainRoot(t *testing.T) { m := testModule(t, "plan-cbd-maintain-root") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } - if !ctx.State().Empty() { - t.Fatal("expected empty state, got:", ctx.State()) + if !plan.PriorState.Empty() { + t.Fatal("expected empty prior state, got:", plan.PriorState) } if len(plan.Changes.Resources) != 4 { @@ -241,19 +233,18 @@ func TestContext2Plan_emptyDiff(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } - if !ctx.State().Empty() { - t.Fatal("expected empty state, got:", ctx.State()) + if !plan.PriorState.Empty() { + t.Fatal("expected empty state, got:", plan.PriorState) } if len(plan.Changes.Resources) != 2 { @@ -280,13 +271,12 @@ func TestContext2Plan_escapedVar(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -321,19 +311,18 @@ func TestContext2Plan_minimal(t *testing.T) { m := testModule(t, "plan-empty") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } - if !ctx.State().Empty() { - t.Fatal("expected empty state, got:", ctx.State()) + if !plan.PriorState.Empty() { + t.Fatal("expected empty state, got:", plan.PriorState) } if len(plan.Changes.Resources) != 2 { @@ -360,13 +349,12 @@ func TestContext2Plan_modules(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -419,13 +407,12 @@ func TestContext2Plan_moduleExpand(t *testing.T) { m := testModule(t, "plan-modules-expand") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -434,13 +421,13 @@ func TestContext2Plan_moduleExpand(t *testing.T) { ty := schema.ImpliedType() expected := map[string]struct{}{ - `aws_instance.foo["a"]`: struct{}{}, - `module.count_child[1].aws_instance.foo[0]`: struct{}{}, - `module.count_child[1].aws_instance.foo[1]`: struct{}{}, - `module.count_child[0].aws_instance.foo[0]`: struct{}{}, - `module.count_child[0].aws_instance.foo[1]`: struct{}{}, - `module.for_each_child["a"].aws_instance.foo[1]`: struct{}{}, - `module.for_each_child["a"].aws_instance.foo[0]`: struct{}{}, + `aws_instance.foo["a"]`: {}, + `module.count_child[1].aws_instance.foo[0]`: {}, + `module.count_child[1].aws_instance.foo[1]`: {}, + `module.count_child[0].aws_instance.foo[0]`: {}, + `module.count_child[0].aws_instance.foo[1]`: {}, + `module.for_each_child["a"].aws_instance.foo[1]`: {}, + `module.for_each_child["a"].aws_instance.foo[0]`: {}, } for _, res := range plan.Changes.Resources { @@ -480,13 +467,12 @@ func TestContext2Plan_moduleCycle(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -535,13 +521,12 @@ func TestContext2Plan_moduleDeadlock(t *testing.T) { p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, err := ctx.Plan() + plan, err := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if err != nil { t.Fatalf("err: %s", err) } @@ -580,13 +565,12 @@ func TestContext2Plan_moduleInput(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -635,13 +619,12 @@ func TestContext2Plan_moduleInputComputed(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -687,19 +670,20 @@ func TestContext2Plan_moduleInputFromVar(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("52"), SourceType: ValueFromCaller, }, }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -755,13 +739,12 @@ func TestContext2Plan_moduleMultiVar(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -830,14 +813,12 @@ func TestContext2Plan_moduleOrphans(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -880,8 +861,8 @@ module.child: ID = baz provider = provider["registry.terraform.io/hashicorp/aws"]` - if ctx.State().String() != expectedState { - t.Fatalf("\nexpected state: %q\n\ngot: %q", expectedState, ctx.State().String()) + if plan.PriorState.String() != expectedState { + t.Fatalf("\nexpected state: %q\n\ngot: %q", expectedState, plan.PriorState.String()) } } @@ -922,17 +903,15 @@ func TestContext2Plan_moduleOrphansWithProvisioner(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -985,8 +964,8 @@ module.parent.child2: provider = provider["registry.terraform.io/hashicorp/aws"] type = aws_instance` - if expectedState != ctx.State().String() { - t.Fatalf("\nexpect state:\n%s\n\ngot state:\n%s\n", expectedState, ctx.State().String()) + if expectedState != plan.PriorState.String() { + t.Fatalf("\nexpect state:\n%s\n\ngot state:\n%s\n", expectedState, plan.PriorState.String()) } } @@ -996,7 +975,6 @@ func TestContext2Plan_moduleProviderInherit(t *testing.T) { m := testModule(t, "plan-module-provider-inherit") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { l.Lock() @@ -1038,7 +1016,7 @@ func TestContext2Plan_moduleProviderInherit(t *testing.T) { }, }) - _, err := ctx.Plan() + _, err := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if err != nil { t.Fatalf("err: %s", err) } @@ -1058,7 +1036,6 @@ func TestContext2Plan_moduleProviderInheritDeep(t *testing.T) { m := testModule(t, "plan-module-provider-inherit-deep") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { l.Lock() @@ -1103,7 +1080,7 @@ func TestContext2Plan_moduleProviderInheritDeep(t *testing.T) { }, }) - _, err := ctx.Plan() + _, err := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if err != nil { t.Fatalf("err: %s", err) } @@ -1115,7 +1092,6 @@ func TestContext2Plan_moduleProviderDefaultsVar(t *testing.T) { m := testModule(t, "plan-module-provider-defaults-var") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { l.Lock() @@ -1157,15 +1133,17 @@ func TestContext2Plan_moduleProviderDefaultsVar(t *testing.T) { return p, nil }, }, - Variables: InputValues{ + }) + + _, err := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("root"), SourceType: ValueFromCaller, }, }, }) - - _, err := ctx.Plan() if err != nil { t.Fatalf("err: %s", err) } @@ -1199,13 +1177,12 @@ func TestContext2Plan_moduleProviderVar(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1242,13 +1219,12 @@ func TestContext2Plan_moduleVar(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1296,13 +1272,12 @@ func TestContext2Plan_moduleVarWrongTypeBasic(t *testing.T) { m := testModule(t, "plan-module-wrong-var-type") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("succeeded; want errors") } @@ -1312,13 +1287,12 @@ func TestContext2Plan_moduleVarWrongTypeNested(t *testing.T) { m := testModule(t, "plan-module-wrong-var-type-nested") p := testProvider("null") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("succeeded; want errors") } @@ -1328,13 +1302,12 @@ func TestContext2Plan_moduleVarWithDefaultValue(t *testing.T) { m := testModule(t, "plan-module-var-with-default-value") p := testProvider("null") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1345,13 +1318,12 @@ func TestContext2Plan_moduleVarComputed(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1407,14 +1379,12 @@ func TestContext2Plan_preventDestroy_bad(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, err := ctx.Plan() + plan, err := ctx.Plan(m, state, DefaultPlanOpts) expectedErr := "aws_instance.foo has lifecycle.prevent_destroy" if !strings.Contains(fmt.Sprintf("%s", err), expectedErr) { @@ -1442,14 +1412,12 @@ func TestContext2Plan_preventDestroy_good(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1483,14 +1451,12 @@ func TestContext2Plan_preventDestroy_countBad(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, err := ctx.Plan() + plan, err := ctx.Plan(m, state, DefaultPlanOpts) expectedErr := "aws_instance.foo[1] has lifecycle.prevent_destroy" if !strings.Contains(fmt.Sprintf("%s", err), expectedErr) { @@ -1535,14 +1501,12 @@ func TestContext2Plan_preventDestroy_countGood(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1580,14 +1544,12 @@ func TestContext2Plan_preventDestroy_countGoodNoChange(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1613,22 +1575,21 @@ func TestContext2Plan_preventDestroy_destroyPlan(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) expectedErr := "aws_instance.foo has lifecycle.prevent_destroy" if !strings.Contains(fmt.Sprintf("%s", diags.Err()), expectedErr) { if plan != nil { t.Logf(legacyDiffComparisonString(plan.Changes)) } - t.Fatalf("expected err would contain %q\nerr: %s", expectedErr, diags.Err()) + t.Fatalf("expected diagnostics would contain %q\nactual diags: %s", expectedErr, diags.Err()) } } @@ -1637,7 +1598,6 @@ func TestContext2Plan_provisionerCycle(t *testing.T) { p := testProvider("aws") pr := testProvisioner() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -1646,7 +1606,7 @@ func TestContext2Plan_provisionerCycle(t *testing.T) { }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("succeeded; want errors") } @@ -1657,13 +1617,12 @@ func TestContext2Plan_computed(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1730,13 +1689,12 @@ func TestContext2Plan_blockNestingGroup(t *testing.T) { } } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1800,13 +1758,12 @@ func TestContext2Plan_computedDataResource(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1866,16 +1823,15 @@ func TestContext2Plan_computedInFunction(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) assertNoErrors(t, diags) - _, diags = ctx.Plan() + _, diags = ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) if !p.ReadDataSourceCalled { @@ -1906,13 +1862,12 @@ func TestContext2Plan_computedDataCountResource(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1935,13 +1890,12 @@ func TestContext2Plan_localValueCount(t *testing.T) { m := testModule(t, "plan-local-value-count") p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2015,19 +1969,12 @@ func TestContext2Plan_dataResourceBecomesComputed(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Refresh() - if diags.HasErrors() { - t.Fatalf("unexpected errors during refresh: %s", diags.Err()) - } - - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors during plan: %s", diags.Err()) } @@ -2072,13 +2019,12 @@ func TestContext2Plan_computedList(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2136,13 +2082,12 @@ func TestContext2Plan_computedMultiIndex(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2191,13 +2136,12 @@ func TestContext2Plan_count(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2265,13 +2209,12 @@ func TestContext2Plan_countComputed(t *testing.T) { m := testModule(t, "plan-count-computed") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, err := ctx.Plan() + _, err := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if err == nil { t.Fatal("should error") } @@ -2282,13 +2225,12 @@ func TestContext2Plan_countComputedModule(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, err := ctx.Plan() + _, err := ctx.Plan(m, states.NewState(), DefaultPlanOpts) expectedErr := `The "count" value depends on resource attributes` if !strings.Contains(fmt.Sprintf("%s", err), expectedErr) { @@ -2302,13 +2244,12 @@ func TestContext2Plan_countModuleStatic(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2356,13 +2297,12 @@ func TestContext2Plan_countModuleStaticGrandchild(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2410,13 +2350,12 @@ func TestContext2Plan_countIndex(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2461,19 +2400,20 @@ func TestContext2Plan_countVar(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "instance_count": &InputValue{ Value: cty.StringVal("3"), SourceType: ValueFromCaller, }, }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2545,13 +2485,12 @@ func TestContext2Plan_countZero(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2586,13 +2525,12 @@ func TestContext2Plan_countOneIndex(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2665,14 +2603,12 @@ func TestContext2Plan_countDecreaseToOne(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2729,8 +2665,8 @@ aws_instance.foo.2: ID = bar provider = provider["registry.terraform.io/hashicorp/aws"]` - if ctx.State().String() != expectedState { - t.Fatalf("epected state:\n%q\n\ngot state:\n%q\n", expectedState, ctx.State().String()) + if plan.PriorState.String() != expectedState { + t.Fatalf("epected state:\n%q\n\ngot state:\n%q\n", expectedState, plan.PriorState.String()) } } @@ -2751,14 +2687,12 @@ func TestContext2Plan_countIncreaseFromNotSet(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2830,14 +2764,12 @@ func TestContext2Plan_countIncreaseFromOne(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2923,14 +2855,12 @@ func TestContext2Plan_countIncreaseFromOneCorrupted(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3049,14 +2979,12 @@ func TestContext2Plan_countIncreaseWithSplatReference(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3105,13 +3033,12 @@ func TestContext2Plan_forEach(t *testing.T) { m := testModule(t, "plan-for-each") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3140,19 +3067,20 @@ func TestContext2Plan_forEachUnknownValue(t *testing.T) { m := testModule(t, "plan-for-each-unknown-value") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": { Value: cty.UnknownVal(cty.String), SourceType: ValueFromCLIArg, }, }, }) - - _, diags := ctx.Plan() if !diags.HasErrors() { // Should get this error: // Invalid for_each argument: The "for_each" value depends on resource attributes that cannot be determined until apply... @@ -3190,15 +3118,14 @@ func TestContext2Plan_destroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3253,15 +3180,14 @@ func TestContext2Plan_moduleDestroy(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3316,15 +3242,14 @@ func TestContext2Plan_moduleDestroyCycle(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3378,15 +3303,14 @@ func TestContext2Plan_moduleDestroyMultivar(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3437,13 +3361,12 @@ func TestContext2Plan_pathVar(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -3493,14 +3416,12 @@ func TestContext2Plan_diffVar(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3553,14 +3474,13 @@ func TestContext2Plan_hook(t *testing.T) { h := new(MockHook) p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3580,13 +3500,12 @@ func TestContext2Plan_closeProvider(t *testing.T) { m := testModule(t, "plan-close-module-provider") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3612,14 +3531,12 @@ func TestContext2Plan_orphan(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3669,13 +3586,12 @@ func TestContext2Plan_shadowUuid(t *testing.T) { m := testModule(t, "plan-shadow-uuid") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3696,14 +3612,12 @@ func TestContext2Plan_state(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3768,7 +3682,7 @@ func TestContext2Plan_requiresReplace(t *testing.T) { Block: &configschema.Block{}, }, ResourceTypes: map[string]providers.Schema{ - "test_thing": providers.Schema{ + "test_thing": { Block: &configschema.Block{ Attributes: map[string]*configschema.Attribute{ "v": { @@ -3801,14 +3715,12 @@ func TestContext2Plan_requiresReplace(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3869,14 +3781,12 @@ func TestContext2Plan_taint(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3949,14 +3859,12 @@ func TestContext2Plan_taintIgnoreChanges(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4032,14 +3940,12 @@ func TestContext2Plan_taintDestroyInterpolatedCountRace(t *testing.T) { for i := 0; i < 100; i++ { ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state.DeepCopy(), }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state.DeepCopy(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4089,18 +3995,19 @@ func TestContext2Plan_targeted(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "foo", ), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4140,16 +4047,17 @@ func TestContext2Plan_targetedCrossModule(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("B", addrs.NoKey), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4204,16 +4112,17 @@ func TestContext2Plan_targetedModuleWithProvider(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child2", addrs.NoKey), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4260,20 +4169,19 @@ func TestContext2Plan_targetedOrphan(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "orphan", ), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4327,20 +4235,19 @@ func TestContext2Plan_targetedModuleOrphan(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - PlanMode: plans.DestroyMode, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child", addrs.NoKey).Resource( addrs.ManagedResourceMode, "aws_instance", "orphan", ), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4371,10 +4278,12 @@ func TestContext2Plan_targetedModuleUntargetedVariable(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ Targets: []addrs.Targetable{ addrs.RootModuleInstance.Resource( addrs.ManagedResourceMode, "aws_instance", "blue", @@ -4382,8 +4291,6 @@ func TestContext2Plan_targetedModuleUntargetedVariable(t *testing.T) { addrs.RootModuleInstance.Child("blue_mod", addrs.NoKey), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4427,18 +4334,18 @@ func TestContext2Plan_outputContainsTargetedResource(t *testing.T) { m := testModule(t, "plan-untargeted-resource-output") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("mod", addrs.NoKey).Resource( addrs.ManagedResourceMode, "aws_instance", "a", ), }, }) - - _, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("err: %s", diags) } @@ -4477,19 +4384,18 @@ func TestContext2Plan_targetedOverTen(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ Targets: []addrs.Targetable{ addrs.RootModuleInstance.ResourceInstance( addrs.ManagedResourceMode, "aws_instance", "foo", addrs.IntKey(1), ), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4519,19 +4425,21 @@ func TestContext2Plan_provider(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + opts := &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("bar"), SourceType: ValueFromCaller, }, }, - }) + } - if _, err := ctx.Plan(); err != nil { + if _, err := ctx.Plan(m, states.NewState(), opts); err != nil { t.Fatalf("err: %s", err) } @@ -4544,13 +4452,12 @@ func TestContext2Plan_varListErr(t *testing.T) { m := testModule(t, "plan-var-list-err") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, err := ctx.Plan() + _, err := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if err == nil { t.Fatal("should error") @@ -4574,20 +4481,20 @@ func TestContext2Plan_ignoreChanges(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("ami-1234abcd"), SourceType: ValueFromCaller, }, }, - State: state, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4633,11 +4540,14 @@ func TestContext2Plan_ignoreChangesWildcard(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("ami-1234abcd"), SourceType: ValueFromCaller, @@ -4647,10 +4557,7 @@ func TestContext2Plan_ignoreChangesWildcard(t *testing.T) { SourceType: ValueFromCaller, }, }, - State: state, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4700,14 +4607,12 @@ func TestContext2Plan_ignoreChangesInMap(t *testing.T) { m := testModule(t, "plan-ignore-changes-in-map") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: s, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, s, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4757,20 +4662,20 @@ func TestContext2Plan_ignoreChangesSensitive(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "foo": &InputValue{ Value: cty.StringVal("ami-1234abcd"), SourceType: ValueFromCaller, }, }, - State: state, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4827,13 +4732,12 @@ func TestContext2Plan_moduleMapLiteral(t *testing.T) { return testDiffFn(req) } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4870,13 +4774,12 @@ func TestContext2Plan_computedValueInMap(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -4926,13 +4829,12 @@ func TestContext2Plan_moduleVariableFromSplat(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5009,13 +4911,12 @@ func TestContext2Plan_createBeforeDestroy_depends_datasource(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5062,8 +4963,8 @@ func TestContext2Plan_createBeforeDestroy_depends_datasource(t *testing.T) { } wantAddrs := map[string]struct{}{ - "aws_instance.foo[0]": struct{}{}, - "aws_instance.foo[1]": struct{}{}, + "aws_instance.foo[0]": {}, + "aws_instance.foo[1]": {}, } if !cmp.Equal(seenAddrs, wantAddrs) { t.Errorf("incorrect addresses in changeset:\n%s", cmp.Diff(wantAddrs, seenAddrs)) @@ -5084,13 +4985,12 @@ func TestContext2Plan_listOrder(t *testing.T) { }, }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5153,14 +5053,12 @@ func TestContext2Plan_ignoreChangesWithFlatmaps(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5269,24 +5167,17 @@ func TestContext2Plan_resourceNestedCount(t *testing.T) { mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("validate errors: %s", diags.Err()) } - _, diags = ctx.Refresh() - if diags.HasErrors() { - t.Fatalf("refresh errors: %s", diags.Err()) - } - - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("plan errors: %s", diags.Err()) } @@ -5330,13 +5221,12 @@ func TestContext2Plan_computedAttrRefTypeMismatch(t *testing.T) { return } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("Succeeded; want type mismatch error for 'ami' argument") } @@ -5361,18 +5251,17 @@ func TestContext2Plan_selfRef(t *testing.T) { m := testModule(t, "plan-self-ref") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected validation failure: %s", diags.Err()) } - _, diags = c.Plan() + _, diags = c.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("plan succeeded; want error") } @@ -5398,18 +5287,17 @@ func TestContext2Plan_selfRefMulti(t *testing.T) { m := testModule(t, "plan-self-ref-multi") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected validation failure: %s", diags.Err()) } - _, diags = c.Plan() + _, diags = c.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("plan succeeded; want error") } @@ -5435,18 +5323,17 @@ func TestContext2Plan_selfRefMultiAll(t *testing.T) { m := testModule(t, "plan-self-ref-multi-all") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected validation failure: %s", diags.Err()) } - _, diags = c.Plan() + _, diags = c.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatalf("plan succeeded; want error") } @@ -5481,13 +5368,12 @@ output "out" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { // Should get this error: // Unsupported attribute: This object does not have an attribute named "missing" @@ -5528,13 +5414,12 @@ resource "aws_instance" "foo" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { // Should get this error: // Unsupported attribute: This object does not have an attribute named "missing" @@ -5575,13 +5460,12 @@ resource "aws_instance" "foo" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { // Should get this error: // Unsupported attribute: This object does not have an attribute named "missing" @@ -5599,13 +5483,12 @@ func TestContext2Plan_variableSensitivity(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5660,19 +5543,20 @@ func TestContext2Plan_variableSensitivityModule(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ "another_var": &InputValue{ Value: cty.StringVal("boop"), SourceType: ValueFromCaller, }, }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5768,13 +5652,12 @@ func TestContext2Plan_requiredModuleOutput(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5832,13 +5715,12 @@ func TestContext2Plan_requiredModuleObject(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5916,14 +5798,12 @@ resource "aws_instance" "foo" { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -5977,13 +5857,12 @@ output"out" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -6020,14 +5899,15 @@ resource "aws_instance" "foo" { targets = append(targets, target.Subject) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Targets: targets, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + Targets: targets, + }) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -6077,14 +5957,15 @@ resource "aws_instance" "foo" { targets := []addrs.Targetable{target.Subject} ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Targets: targets, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + Targets: targets, + }) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -6139,13 +6020,12 @@ resource "aws_instance" "foo" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -6195,14 +6075,12 @@ data "test_data_source" "foo" {} ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -6255,14 +6133,12 @@ resource "test_instance" "b" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) } @@ -6271,16 +6147,17 @@ func TestContext2Plan_targetedModuleInstance(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, + }) + + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("mod", addrs.IntKey(0)), }, }) - - plan, diags := ctx.Plan() if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -6329,13 +6206,12 @@ data "test_data_source" "d" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -6387,13 +6263,12 @@ data "test_data_source" "e" { `}) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) } @@ -6420,15 +6295,15 @@ resource "test_instance" "a" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, - SkipRefresh: true, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + SkipRefresh: true, + }) assertNoErrors(t, diags) if p.ReadResourceCalled { @@ -6482,13 +6357,12 @@ data "test_data_source" "b" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) // The change to data source a should not prevent data source b from being @@ -6524,12 +6398,11 @@ resource "test_instance" "a" { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -6594,13 +6467,11 @@ resource "test_instance" "a" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -6659,13 +6530,11 @@ resource "test_instance" "a" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -6706,7 +6575,6 @@ resource "test_instance" "a" { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), // We still need to be able to locate the provider to decode the @@ -6714,9 +6582,8 @@ resource "test_instance" "a" { // only used for an orphaned data source. addrs.NewProvider("registry.terraform.io", "local", "test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -6739,33 +6606,32 @@ resource "test_resource" "foo" { p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"id":"foo", "value":"hello", "sensitive_value":"hello"}`), - AttrSensitivePaths: []cty.PathValueMarks{ - {Path: cty.Path{cty.GetAttrStep{Name: "value"}}, Marks: cty.NewValueMarks(marks.Sensitive)}, - {Path: cty.Path{cty.GetAttrStep{Name: "sensitive_value"}}, Marks: cty.NewValueMarks(marks.Sensitive)}, - }, - }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("test"), - Module: addrs.RootModule, + }) + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"foo", "value":"hello", "sensitive_value":"hello"}`), + AttrSensitivePaths: []cty.PathValueMarks{ + {Path: cty.Path{cty.GetAttrStep{Name: "value"}}, Marks: cty.NewValueMarks(marks.Sensitive)}, + {Path: cty.Path{cty.GetAttrStep{Name: "sensitive_value"}}, Marks: cty.NewValueMarks(marks.Sensitive)}, }, - ) - }), + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ) }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -6782,13 +6648,12 @@ func TestContext2Plan_variableCustomValidationsSensitive(t *testing.T) { p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Plan() + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -6807,14 +6672,12 @@ output "planned" { `, }) - ctx := testContext2(t, &ContextOpts{ - Config: m, - State: states.BuildState(func(s *states.SyncState) { - r := s.Module(addrs.RootModuleInstance) - r.SetOutputValue("planned", cty.NullVal(cty.DynamicPseudoType), false) - }), + ctx := testContext2(t, &ContextOpts{}) + state := states.BuildState(func(s *states.SyncState) { + r := s.Module(addrs.RootModuleInstance) + r.SetOutputValue("planned", cty.NullVal(cty.DynamicPseudoType), false) }) - plan, diags := ctx.Plan() + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -6836,11 +6699,8 @@ output "planned" { `, }) - ctx := testContext2(t, &ContextOpts{ - Config: m, - State: states.NewState(), - }) - plan, diags := ctx.Plan() + ctx := testContext2(t, &ContextOpts{}) + plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) if diags.HasErrors() { t.Fatal(diags.Err()) } diff --git a/internal/terraform/context_refresh.go b/internal/terraform/context_refresh.go new file mode 100644 index 000000000000..cac5232b0d0f --- /dev/null +++ b/internal/terraform/context_refresh.go @@ -0,0 +1,37 @@ +package terraform + +import ( + "log" + + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +// Refresh is a vestigial operation that is equivalent to call to Plan and +// then taking the prior state of the resulting plan. +// +// We retain this only as a measure of semi-backward-compatibility for +// automation relying on the "terraform refresh" subcommand. The modern way +// to get this effect is to create and then apply a plan in the refresh-only +// mode. +func (c *Context) Refresh(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*states.State, tfdiags.Diagnostics) { + if opts == nil { + // This fallback is only here for tests, not for real code. + opts = &PlanOpts{ + Mode: plans.NormalMode, + } + } + if opts.Mode != plans.NormalMode { + panic("can only Refresh in the normal planning mode") + } + + log.Printf("[DEBUG] Refresh is really just plan now, so creating a %s plan", opts.Mode) + p, diags := c.Plan(config, prevRunState, opts) + if diags.HasErrors() { + return nil, diags + } + + return p.PriorState, diags +} diff --git a/internal/terraform/context_refresh_test.go b/internal/terraform/context_refresh_test.go index 7f58f1a0a04a..dd319254a6f2 100644 --- a/internal/terraform/context_refresh_test.go +++ b/internal/terraform/context_refresh_test.go @@ -14,6 +14,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/configs/hcl2shim" + "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/states" ) @@ -34,11 +35,9 @@ func TestContext2Refresh(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) schema := p.GetProviderSchemaResponse.ResourceTypes["aws_instance"].Block @@ -52,7 +51,7 @@ func TestContext2Refresh(t *testing.T) { NewState: readState, } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -123,17 +122,15 @@ func TestContext2Refresh_dynamicAttr(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: startingState, }) schema := p.GetProviderSchemaResponse.ResourceTypes["test_instance"].Block ty := schema.ImpliedType() - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, startingState, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -200,13 +197,12 @@ func TestContext2Refresh_dataComputedModuleVar(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -261,16 +257,9 @@ func TestContext2Refresh_targeted(t *testing.T) { m := testModule(t, "refresh-targeted") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - Targets: []addrs.Targetable{ - addrs.RootModuleInstance.Resource( - addrs.ManagedResourceMode, "aws_instance", "me", - ), - }, }) refreshedResources := make([]string, 0, 2) @@ -281,7 +270,14 @@ func TestContext2Refresh_targeted(t *testing.T) { } } - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + addrs.RootModuleInstance.Resource( + addrs.ManagedResourceMode, "aws_instance", "me", + ), + }, + }) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -339,16 +335,9 @@ func TestContext2Refresh_targetedCount(t *testing.T) { m := testModule(t, "refresh-targeted-count") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - Targets: []addrs.Targetable{ - addrs.RootModuleInstance.Resource( - addrs.ManagedResourceMode, "aws_instance", "me", - ), - }, }) refreshedResources := make([]string, 0, 2) @@ -359,7 +348,14 @@ func TestContext2Refresh_targetedCount(t *testing.T) { } } - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + addrs.RootModuleInstance.Resource( + addrs.ManagedResourceMode, "aws_instance", "me", + ), + }, + }) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -425,16 +421,9 @@ func TestContext2Refresh_targetedCountIndex(t *testing.T) { m := testModule(t, "refresh-targeted-count") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, - Targets: []addrs.Targetable{ - addrs.RootModuleInstance.ResourceInstance( - addrs.ManagedResourceMode, "aws_instance", "me", addrs.IntKey(0), - ), - }, }) refreshedResources := make([]string, 0, 2) @@ -445,7 +434,14 @@ func TestContext2Refresh_targetedCountIndex(t *testing.T) { } } - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + addrs.RootModuleInstance.ResourceInstance( + addrs.ManagedResourceMode, "aws_instance", "me", addrs.IntKey(0), + ), + }, + }) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -478,7 +474,6 @@ func TestContext2Refresh_moduleComputedVar(t *testing.T) { m := testModule(t, "refresh-module-computed-var") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -486,7 +481,7 @@ func TestContext2Refresh_moduleComputedVar(t *testing.T) { // This was failing (see GH-2188) at some point, so this test just // verifies that the failure goes away. - if _, diags := ctx.Refresh(); diags.HasErrors() { + if _, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}); diags.HasErrors() { t.Fatalf("refresh errs: %s", diags.Err()) } } @@ -500,18 +495,16 @@ func TestContext2Refresh_delete(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.web", `{"id":"foo"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ReadResourceResponse = &providers.ReadResourceResponse{ NewState: cty.NullVal(p.GetProviderSchemaResponse.ResourceTypes["aws_instance"].Block.ImpliedType()), } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -526,11 +519,9 @@ func TestContext2Refresh_ignoreUncreated(t *testing.T) { p := testProvider("aws") m := testModule(t, "refresh-basic") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: nil, }) p.ReadResourceResponse = &providers.ReadResourceResponse{ @@ -539,7 +530,7 @@ func TestContext2Refresh_ignoreUncreated(t *testing.T) { }), } - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -558,15 +549,13 @@ func TestContext2Refresh_hook(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.web", `{"id":"foo"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, - Hooks: []Hook{h}, + Hooks: []Hook{h}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - if _, diags := ctx.Refresh(); diags.HasErrors() { + if _, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}); diags.HasErrors() { t.Fatalf("refresh errs: %s", diags.Err()) } if !h.PreRefreshCalled { @@ -588,11 +577,9 @@ func TestContext2Refresh_modules(t *testing.T) { testSetResourceInstanceCurrent(child, "aws_instance.web", `{"id":"baz"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ReadResourceFn = func(req providers.ReadResourceRequest) providers.ReadResourceResponse { @@ -613,7 +600,7 @@ func TestContext2Refresh_modules(t *testing.T) { } } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -648,13 +635,12 @@ func TestContext2Refresh_moduleInputComputedOutput(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Refresh(); diags.HasErrors() { + if _, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}); diags.HasErrors() { t.Fatalf("refresh errs: %s", diags.Err()) } } @@ -663,13 +649,12 @@ func TestContext2Refresh_moduleVarModule(t *testing.T) { m := testModule(t, "refresh-module-var-module") p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - if _, diags := ctx.Refresh(); diags.HasErrors() { + if _, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}); diags.HasErrors() { t.Fatalf("refresh errs: %s", diags.Err()) } } @@ -679,7 +664,6 @@ func TestContext2Refresh_noState(t *testing.T) { p := testProvider("aws") m := testModule(t, "refresh-no-state") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -691,7 +675,7 @@ func TestContext2Refresh_noState(t *testing.T) { }), } - if _, diags := ctx.Refresh(); diags.HasErrors() { + if _, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}); diags.HasErrors() { t.Fatalf("refresh errs: %s", diags.Err()) } } @@ -726,14 +710,12 @@ func TestContext2Refresh_output(t *testing.T) { root.SetOutputValue("foo", cty.StringVal("foo"), false) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -776,14 +758,12 @@ func TestContext2Refresh_outputPartial(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.foo", `{}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -804,11 +784,9 @@ func TestContext2Refresh_stateBasic(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.web", `{"id":"bar"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) schema := p.GetProviderSchemaResponse.ResourceTypes["aws_instance"].Block @@ -825,7 +803,7 @@ func TestContext2Refresh_stateBasic(t *testing.T) { NewState: readStateVal, } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -879,10 +857,9 @@ func TestContext2Refresh_dataCount(t *testing.T) { Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Config: m, }) - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) @@ -912,11 +889,9 @@ func TestContext2Refresh_dataState(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, - State: state, }) var readStateVal cty.Value @@ -930,7 +905,7 @@ func TestContext2Refresh_dataState(t *testing.T) { } } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -978,11 +953,9 @@ func TestContext2Refresh_dataStateRefData(t *testing.T) { m := testModule(t, "refresh-data-ref-data") state := states.NewState() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, - State: state, }) p.ReadDataSourceFn = func(req providers.ReadDataSourceRequest) providers.ReadDataSourceResponse { @@ -995,7 +968,7 @@ func TestContext2Refresh_dataStateRefData(t *testing.T) { } } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -1016,11 +989,9 @@ func TestContext2Refresh_tainted(t *testing.T) { testSetResourceInstanceTainted(root, "aws_instance.web", `{"id":"bar"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ReadResourceFn = func(req providers.ReadResourceRequest) providers.ReadResourceResponse { // add the required id @@ -1032,7 +1003,7 @@ func TestContext2Refresh_tainted(t *testing.T) { } } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -1058,14 +1029,14 @@ func TestContext2Refresh_unknownProvider(t *testing.T) { root := state.EnsureModule(addrs.RootModuleInstance) testSetResourceInstanceCurrent(root, "aws_instance.web", `{"id":"foo"}`, `provider["registry.terraform.io/hashicorp/aws"]`) - _, diags := NewContext(&ContextOpts{ - Config: m, + c, diags := NewContext(&ContextOpts{ Providers: map[addrs.Provider]providers.Factory{}, - State: state, }) + assertNoDiagnostics(t, diags) + _, diags = c.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}) if !diags.HasErrors() { - t.Fatal("successfully created context; want error") + t.Fatal("successfully refreshed; want error") } if !regexp.MustCompile(`failed to instantiate provider ".+"`).MatchString(diags.Err().Error()) { @@ -1100,11 +1071,9 @@ func TestContext2Refresh_vars(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.web", `{"id":"foo"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) readStateVal, err := schema.CoerceValue(cty.ObjectVal(map[string]cty.Value{ @@ -1124,7 +1093,7 @@ func TestContext2Refresh_vars(t *testing.T) { } } - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("refresh errors: %s", diags.Err()) } @@ -1176,8 +1145,8 @@ func TestContext2Refresh_orphanModule(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"i-abc123"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{Module: addrs.Module{"module.child"}}, - addrs.ConfigResource{Module: addrs.Module{"module.child"}}, + {Module: addrs.Module{"module.child"}}, + {Module: addrs.Module{"module.child"}}, }, }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), @@ -1188,7 +1157,7 @@ func TestContext2Refresh_orphanModule(t *testing.T) { &states.ResourceInstanceObjectSrc{ Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"i-bcd23"}`), - Dependencies: []addrs.ConfigResource{addrs.ConfigResource{Module: addrs.Module{"module.grandchild"}}}, + Dependencies: []addrs.ConfigResource{{Module: addrs.Module{"module.grandchild"}}}, }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), ) @@ -1196,15 +1165,13 @@ func TestContext2Refresh_orphanModule(t *testing.T) { testSetResourceInstanceCurrent(grandchild, "aws_instance.baz", `{"id":"i-cde345"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) testCheckDeadlock(t, func() { - _, err := ctx.Refresh() + _, err := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if err != nil { t.Fatalf("err: %s", err.Err()) } @@ -1239,13 +1206,12 @@ func TestContext2Validate(t *testing.T) { m := testModule(t, "validate-good") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if len(diags) != 0 { t.Fatalf("unexpected error: %#v", diags.ErrWithWarnings()) } @@ -1260,11 +1226,9 @@ func TestContext2Refresh_updateProviderInState(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.bar", `{"id":"foo"}`, `provider["registry.terraform.io/hashicorp/aws"].baz`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) expected := strings.TrimSpace(` @@ -1272,7 +1236,7 @@ aws_instance.bar: ID = foo provider = provider["registry.terraform.io/hashicorp/aws"].foo`) - s, diags := ctx.Refresh() + s, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1329,14 +1293,12 @@ func TestContext2Refresh_schemaUpgradeFlatmap(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: s, }) - state, diags := ctx.Refresh() + state, diags := ctx.Refresh(m, s, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1413,14 +1375,12 @@ func TestContext2Refresh_schemaUpgradeJSON(t *testing.T) { }) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: s, }) - state, diags := ctx.Refresh() + state, diags := ctx.Refresh(m, s, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1471,13 +1431,12 @@ data "aws_data_source" "foo" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, states.NewState(), &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { // Should get this error: // Unsupported attribute: This object does not have an attribute named "missing" @@ -1520,14 +1479,12 @@ func TestContext2Refresh_dataResourceDependsOn(t *testing.T) { testSetResourceInstanceCurrent(root, "test_resource.a", `{"id":"a"}`, `provider["registry.terraform.io/hashicorp/test"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1566,14 +1523,12 @@ resource "aws_instance" "bar" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) - state, diags := ctx.Refresh() + state, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatalf("plan errors: %s", diags.Err()) } @@ -1614,14 +1569,12 @@ func TestContext2Refresh_dataSourceOrphan(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - State: state, }) - _, diags := ctx.Refresh() + _, diags := ctx.Refresh(m, state, &PlanOpts{Mode: plans.NormalMode}) if diags.HasErrors() { t.Fatal(diags.Err()) } diff --git a/internal/terraform/context_test.go b/internal/terraform/context_test.go index f7107922c716..47fd32f4bc15 100644 --- a/internal/terraform/context_test.go +++ b/internal/terraform/context_test.go @@ -109,9 +109,12 @@ func TestNewContextRequiredVersion(t *testing.T) { Required: constraint, }) } - _, diags := NewContext(&ContextOpts{ - Config: mod, - }) + c, diags := NewContext(&ContextOpts{}) + if diags.HasErrors() { + t.Fatalf("unexpected NewContext errors: %s", diags.Err()) + } + + diags = c.Validate(mod) if diags.HasErrors() != tc.Err { t.Fatalf("err: %s", diags.Err()) } @@ -262,9 +265,6 @@ Please run "terraform init".`, devProviders[provider] = struct{}{} } opts := &ContextOpts{ - Config: testModuleInline(t, map[string]string{ - "main.tf": tc.Config, - }), LockedDependencies: locks, ProvidersInDevelopment: devProviders, Providers: map[addrs.Provider]providers.Factory{ @@ -274,7 +274,16 @@ Please run "terraform init".`, }, } - ctx, diags := NewContext(opts) + m := testModuleInline(t, map[string]string{ + "main.tf": tc.Config, + }) + + c, diags := NewContext(opts) + if diags.HasErrors() { + t.Fatalf("unexpected NewContext error: %s", diags.Err()) + } + + diags = c.Validate(m) if tc.WantErr != "" { if len(diags) == 0 { t.Fatal("expected diags but none returned") @@ -286,9 +295,6 @@ Please run "terraform init".`, if len(diags) > 0 { t.Errorf("unexpected diags: %s", diags.Err()) } - if ctx == nil { - t.Error("ctx is nil") - } } }) } @@ -717,10 +723,10 @@ func testProviderSchema(name string) *providers.GetProviderSchemaResponse { // our context tests try to exercise lots of stuff at once and so having them // round-trip things through on-disk files is often an important part of // fully representing an old bug in a regression test. -func contextOptsForPlanViaFile(configSnap *configload.Snapshot, plan *plans.Plan) (*ContextOpts, error) { +func contextOptsForPlanViaFile(configSnap *configload.Snapshot, plan *plans.Plan) (*ContextOpts, *configs.Config, *plans.Plan, error) { dir, err := ioutil.TempDir("", "terraform-contextForPlanViaFile") if err != nil { - return nil, err + return nil, nil, nil, err } defer os.RemoveAll(dir) @@ -751,49 +757,27 @@ func contextOptsForPlanViaFile(configSnap *configload.Snapshot, plan *plans.Plan filename := filepath.Join(dir, "tfplan") err = planfile.Create(filename, configSnap, prevStateFile, stateFile, plan) if err != nil { - return nil, err + return nil, nil, nil, err } pr, err := planfile.Open(filename) if err != nil { - return nil, err + return nil, nil, nil, err } config, diags := pr.ReadConfig() if diags.HasErrors() { - return nil, diags.Err() - } - - stateFile, err = pr.ReadStateFile() - if err != nil { - return nil, err + return nil, nil, nil, diags.Err() } plan, err = pr.ReadPlan() if err != nil { - return nil, err - } - - vars := make(InputValues) - for name, vv := range plan.VariableValues { - val, err := vv.Decode(cty.DynamicPseudoType) - if err != nil { - return nil, fmt.Errorf("can't decode value for variable %q: %s", name, err) - } - vars[name] = &InputValue{ - Value: val, - SourceType: ValueFromPlan, - } + return nil, nil, nil, err } return &ContextOpts{ - Config: config, - State: stateFile.State, - Changes: plan.Changes, - Variables: vars, - Targets: plan.TargetAddrs, ProviderSHA256s: plan.ProviderSHA256s, - }, nil + }, config, plan, nil } // legacyPlanComparisonString produces a string representation of the changes diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go new file mode 100644 index 000000000000..bda38633ab16 --- /dev/null +++ b/internal/terraform/context_validate.go @@ -0,0 +1,88 @@ +package terraform + +import ( + "log" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/zclconf/go-cty/cty" +) + +// Validate performs semantic validation of a configuration, and returns +// any warnings or errors. +// +// Syntax and structural checks are performed by the configuration loader, +// and so are not repeated here. +// +// Validate considers only the configuration and so it won't catch any +// errors caused by current values in the state, or other external information +// such as root module input variables. However, the Plan function includes +// all of the same checks as Validate, in addition to the other work it does +// to consider the previous run state and the planning options. +func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { + defer c.acquireRun("validate")() + + var diags tfdiags.Diagnostics + + moreDiags := CheckCoreVersionRequirements(config) + diags = diags.Append(moreDiags) + // If version constraints are not met then we'll bail early since otherwise + // we're likely to just see a bunch of other errors related to + // incompatibilities, which could be overwhelming for the user. + if diags.HasErrors() { + return diags + } + + schemas, moreDiags := c.Schemas(config, nil) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return diags + } + + log.Printf("[DEBUG] Building and walking validate graph") + + graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ + Config: config, + Components: c.components, + Schemas: schemas, + Validate: true, + State: states.NewState(), + }).Build(addrs.RootModuleInstance) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return diags + } + + // Validate is to check if the given module is valid regardless of + // input values, current state, etc. Therefore we populate all of the + // input values with unknown values of the expected type, allowing us + // to perform a type check without assuming any particular values. + varValues := make(InputValues) + for name, variable := range config.Module.Variables { + ty := variable.Type + if ty == cty.NilType { + // Can't predict the type at all, so we'll just mark it as + // cty.DynamicVal (unknown value of cty.DynamicPseudoType). + ty = cty.DynamicPseudoType + } + varValues[name] = &InputValue{ + Value: cty.UnknownVal(ty), + SourceType: ValueFromUnknown, + } + } + + walker, walkDiags := c.walk(graph, walkValidate, &graphWalkOpts{ + Config: config, + Schemas: schemas, + RootVariableValues: varValues, + }) + diags = diags.Append(walker.NonFatalDiagnostics) + diags = diags.Append(walkDiags) + if walkDiags.HasErrors() { + return diags + } + + return diags +} diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index be3acb7c501a..b25bed35e9ee 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -10,7 +10,6 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" - "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" "github.com/hashicorp/terraform/internal/states" @@ -29,13 +28,12 @@ func TestContext2Validate_badCount(t *testing.T) { m := testModule(t, "validate-bad-count") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -53,13 +51,12 @@ func TestContext2Validate_badResource_reference(t *testing.T) { m := testModule(t, "validate-bad-resource-count") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -80,52 +77,33 @@ func TestContext2Validate_badVar(t *testing.T) { m := testModule(t, "validate-bad-var") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } } -func TestContext2Validate_varMapOverrideOld(t *testing.T) { - m := testModule(t, "validate-module-pc-vars") - p := testProvider("aws") - p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ - Provider: &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "foo": {Type: cty.String, Optional: true}, - }, - }, - ResourceTypes: map[string]*configschema.Block{ - "aws_instance": { - Attributes: map[string]*configschema.Attribute{}, - }, - }, - }) - - _, diags := NewContext(&ContextOpts{ - Config: m, - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), - }, - Variables: InputValues{}, - }) - if !diags.HasErrors() { - // Error should be: The input variable "provider_var" has not been assigned a value. - t.Fatalf("succeeded; want error") - } -} - func TestContext2Validate_varNoDefaultExplicitType(t *testing.T) { m := testModule(t, "validate-var-no-default-explicit-type") - _, diags := NewContext(&ContextOpts{ - Config: m, - }) + c, diags := NewContext(&ContextOpts{}) + if diags.HasErrors() { + t.Fatalf("unexpected NewContext errors: %s", diags.Err()) + } + + // NOTE: This test has grown idiosyncratic because originally Terraform + // would (optionally) check variables during validation, and then in + // Terraform v0.12 we switched to checking variables during NewContext, + // and now most recently we've switched to checking variables only during + // planning because root variables are a plan option. Therefore this has + // grown into a plan test rather than a validate test, but it lives on + // here in order to make it easier to navigate through that history in + // version control. + _, diags = c.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { // Error should be: The input variable "maybe_a_map" has not been assigned a value. t.Fatalf("succeeded; want error") @@ -166,7 +144,6 @@ func TestContext2Validate_computedVar(t *testing.T) { m := testModule(t, "validate-computed-var") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), addrs.NewDefaultProvider("test"): testProviderFuncFixed(pt), @@ -182,7 +159,7 @@ func TestContext2Validate_computedVar(t *testing.T) { return } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -217,13 +194,12 @@ func TestContext2Validate_computedInFunction(t *testing.T) { m := testModule(t, "validate-computed-in-function") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -256,13 +232,12 @@ func TestContext2Validate_countComputed(t *testing.T) { m := testModule(t, "validate-count-computed") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -281,13 +256,12 @@ func TestContext2Validate_countNegative(t *testing.T) { } m := testModule(t, "validate-count-negative") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -308,13 +282,12 @@ func TestContext2Validate_countVariable(t *testing.T) { } m := testModule(t, "apply-count-variable") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -334,12 +307,14 @@ func TestContext2Validate_countVariableNoDefault(t *testing.T) { }, }, } - _, diags := NewContext(&ContextOpts{ - Config: m, + c, diags := NewContext(&ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) + assertNoDiagnostics(t, diags) + + _, diags = c.Plan(m, nil, &PlanOpts{}) if !diags.HasErrors() { // Error should be: The input variable "foo" has not been assigned a value. t.Fatalf("succeeded; want error") @@ -361,13 +336,12 @@ func TestContext2Validate_moduleBadOutput(t *testing.T) { } m := testModule(t, "validate-bad-module-output") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -388,13 +362,12 @@ func TestContext2Validate_moduleGood(t *testing.T) { } m := testModule(t, "validate-good-module") c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -414,7 +387,6 @@ func TestContext2Validate_moduleBadResource(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -424,7 +396,7 @@ func TestContext2Validate_moduleBadResource(t *testing.T) { Diagnostics: tfdiags.Diagnostics{}.Append(fmt.Errorf("bad")), } - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -446,13 +418,12 @@ func TestContext2Validate_moduleDepsShouldNotCycle(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -481,16 +452,9 @@ func TestContext2Validate_moduleProviderVar(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "provider_var": &InputValue{ - Value: cty.StringVal("bar"), - SourceType: ValueFromCaller, - }, - }, }) p.ValidateProviderConfigFn = func(req providers.ValidateProviderConfigRequest) (resp providers.ValidateProviderConfigResponse) { @@ -500,7 +464,7 @@ func TestContext2Validate_moduleProviderVar(t *testing.T) { return } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -529,7 +493,6 @@ func TestContext2Validate_moduleProviderInheritUnused(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -542,7 +505,7 @@ func TestContext2Validate_moduleProviderInheritUnused(t *testing.T) { return } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -565,16 +528,10 @@ func TestContext2Validate_orphans(t *testing.T) { m := testModule(t, "validate-good") - state := states.NewState() - root := state.EnsureModule(addrs.RootModuleInstance) - testSetResourceInstanceCurrent(root, "aws_instance.web", `{"id":"bar"}`, `provider["registry.terraform.io/hashicorp/aws"]`) - c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ValidateResourceConfigFn = func(req providers.ValidateResourceConfigRequest) providers.ValidateResourceConfigResponse { @@ -587,7 +544,7 @@ func TestContext2Validate_orphans(t *testing.T) { } } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -614,7 +571,6 @@ func TestContext2Validate_providerConfig_bad(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -624,7 +580,7 @@ func TestContext2Validate_providerConfig_bad(t *testing.T) { Diagnostics: tfdiags.Diagnostics{}.Append(fmt.Errorf("bad")), } - diags := c.Validate() + diags := c.Validate(m) if len(diags) != 1 { t.Fatalf("wrong number of diagnostics %d; want %d", len(diags), 1) } @@ -654,7 +610,6 @@ func TestContext2Validate_providerConfig_skippedEmpty(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -664,7 +619,7 @@ func TestContext2Validate_providerConfig_skippedEmpty(t *testing.T) { Diagnostics: tfdiags.Diagnostics{}.Append(fmt.Errorf("should not be called")), } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -691,13 +646,12 @@ func TestContext2Validate_providerConfig_good(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -727,13 +681,12 @@ func TestContext2Validate_requiredProviderConfig(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -757,7 +710,6 @@ func TestContext2Validate_provisionerConfig_bad(t *testing.T) { pr := simpleMockProvisioner() c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -770,7 +722,7 @@ func TestContext2Validate_provisionerConfig_bad(t *testing.T) { Diagnostics: tfdiags.Diagnostics{}.Append(fmt.Errorf("bad")), } - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -794,7 +746,6 @@ func TestContext2Validate_badResourceConnection(t *testing.T) { pr := simpleMockProvisioner() c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -803,7 +754,7 @@ func TestContext2Validate_badResourceConnection(t *testing.T) { }, }) - diags := c.Validate() + diags := c.Validate(m) t.Log(diags.Err()) if !diags.HasErrors() { t.Fatalf("succeeded; want error") @@ -828,7 +779,6 @@ func TestContext2Validate_badProvisionerConnection(t *testing.T) { pr := simpleMockProvisioner() c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -837,7 +787,7 @@ func TestContext2Validate_badProvisionerConnection(t *testing.T) { }, }) - diags := c.Validate() + diags := c.Validate(m) t.Log(diags.Err()) if !diags.HasErrors() { t.Fatalf("succeeded; want error") @@ -878,7 +828,6 @@ func TestContext2Validate_provisionerConfig_good(t *testing.T) { } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -887,7 +836,7 @@ func TestContext2Validate_provisionerConfig_good(t *testing.T) { }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -907,12 +856,22 @@ func TestContext2Validate_requiredVar(t *testing.T) { }, }, } - _, diags := NewContext(&ContextOpts{ - Config: m, + c, diags := NewContext(&ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) + assertNoDiagnostics(t, diags) + + // NOTE: This test has grown idiosyncratic because originally Terraform + // would (optionally) check variables during validation, and then in + // Terraform v0.12 we switched to checking variables during NewContext, + // and now most recently we've switched to checking variables only during + // planning because root variables are a plan option. Therefore this has + // grown into a plan test rather than a validate test, but it lives on + // here in order to make it easier to navigate through that history in + // version control. + _, diags = c.Plan(m, states.NewState(), DefaultPlanOpts) if !diags.HasErrors() { // Error should be: The input variable "foo" has not been assigned a value. t.Fatalf("succeeded; want error") @@ -934,7 +893,6 @@ func TestContext2Validate_resourceConfig_bad(t *testing.T) { }, } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -944,7 +902,7 @@ func TestContext2Validate_resourceConfig_bad(t *testing.T) { Diagnostics: tfdiags.Diagnostics{}.Append(fmt.Errorf("bad")), } - diags := c.Validate() + diags := c.Validate(m) if !diags.HasErrors() { t.Fatalf("succeeded; want error") } @@ -965,13 +923,12 @@ func TestContext2Validate_resourceConfig_good(t *testing.T) { }, } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -993,16 +950,10 @@ func TestContext2Validate_tainted(t *testing.T) { } m := testModule(t, "validate-good") - state := states.NewState() - root := state.EnsureModule(addrs.RootModuleInstance) - testSetResourceInstanceTainted(root, "aws_instance.foo", `{"id":"bar"}`, `provider["registry.terraform.io/hashicorp/aws"]`) - c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - State: state, }) p.ValidateResourceConfigFn = func(req providers.ValidateResourceConfigRequest) providers.ValidateResourceConfigResponse { @@ -1015,7 +966,7 @@ func TestContext2Validate_tainted(t *testing.T) { } } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -1044,23 +995,15 @@ func TestContext2Validate_targetedDestroy(t *testing.T) { testSetResourceInstanceCurrent(root, "aws_instance.bar", `{"id":"i-abc123"}`, `provider["registry.terraform.io/hashicorp/aws"]`) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, Provisioners: map[string]provisioners.Factory{ "shell": testProvisionerFuncFixed(pr), }, - State: state, - Targets: []addrs.Targetable{ - addrs.RootModuleInstance.Resource( - addrs.ManagedResourceMode, "aws_instance", "foo", - ), - }, - PlanMode: plans.DestroyMode, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -1081,16 +1024,9 @@ func TestContext2Validate_varRefUnknown(t *testing.T) { }, } c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "foo": &InputValue{ - Value: cty.StringVal("bar"), - SourceType: ValueFromCaller, - }, - }, }) var value cty.Value @@ -1099,7 +1035,7 @@ func TestContext2Validate_varRefUnknown(t *testing.T) { return providers.ValidateResourceConfigResponse{} } - c.Validate() + c.Validate(m) // Input variables are always unknown during the validate walk, because // we're checking for validity of all possible input values. Validity @@ -1129,14 +1065,13 @@ func TestContext2Validate_interpolateVar(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("template"): testProviderFuncFixed(p), }, UIInput: input, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -1162,14 +1097,13 @@ func TestContext2Validate_interpolateComputedModuleVarDef(t *testing.T) { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, UIInput: input, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -1183,14 +1117,13 @@ func TestContext2Validate_interpolateMap(t *testing.T) { p := testProvider("template") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("template"): testProviderFuncFixed(p), }, UIInput: input, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -1235,19 +1168,12 @@ resource "aws_instance" "foo" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "bar": &InputValue{ - Value: cty.StringVal("boop"), - SourceType: ValueFromCaller, - }, - }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1265,47 +1191,26 @@ resource "aws_instance" "foo" { func TestContext2Validate_PlanGraphBuilder(t *testing.T) { fixture := contextFixtureApplyVars(t) opts := fixture.ContextOpts() - opts.Variables = InputValues{ - "foo": &InputValue{ - Value: cty.StringVal("us-east-1"), - SourceType: ValueFromCaller, - }, - "test_list": &InputValue{ - Value: cty.ListVal([]cty.Value{ - cty.StringVal("Hello"), - cty.StringVal("World"), - }), - SourceType: ValueFromCaller, - }, - "test_map": &InputValue{ - Value: cty.MapVal(map[string]cty.Value{ - "Hello": cty.StringVal("World"), - "Foo": cty.StringVal("Bar"), - "Baz": cty.StringVal("Foo"), - }), - SourceType: ValueFromCaller, - }, - "amis": &InputValue{ - Value: cty.MapVal(map[string]cty.Value{ - "us-east-1": cty.StringVal("override"), - }), - SourceType: ValueFromCaller, - }, - } c := testContext2(t, opts) - graph, diags := (&PlanGraphBuilder{ - Config: c.config, + state := states.NewState() + schemas, diags := c.Schemas(fixture.Config, state) + assertNoDiagnostics(t, diags) + + graph, diags := ValidateGraphBuilder(&PlanGraphBuilder{ + Config: fixture.Config, State: states.NewState(), Components: c.components, - Schemas: c.schemas, - Targets: c.targets, + Schemas: schemas, }).Build(addrs.RootModuleInstance) if diags.HasErrors() { t.Fatalf("errors from PlanGraphBuilder: %s", diags.Err()) } defer c.acquireRun("validate-test")() - walker, diags := c.walk(graph, walkValidate, &graphWalkOpts{}) + walker, diags := c.walk(graph, walkValidate, &graphWalkOpts{ + Config: fixture.Config, + Schemas: schemas, + }) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1326,13 +1231,12 @@ output "out" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1363,13 +1267,12 @@ resource "aws_instance" "foo" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1402,11 +1305,9 @@ output "root" { }`, }) - ctx := testContext2(t, &ContextOpts{ - Config: m, - }) + ctx := testContext2(t, &ContextOpts{}) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1424,13 +1325,12 @@ output "out" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1455,13 +1355,12 @@ output "out" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1486,13 +1385,12 @@ output "out" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1516,13 +1414,12 @@ resource "test_instance" "bar" { p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1549,13 +1446,12 @@ resource "test_instance" "bar" { p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1574,13 +1470,12 @@ func TestContext2Validate_variableCustomValidationsFail(t *testing.T) { p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1609,19 +1504,12 @@ variable "test" { p := testProvider("test") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, - Variables: InputValues{ - "test": &InputValue{ - Value: cty.UnknownVal(cty.String), - SourceType: ValueFromCLIArg, - }, - }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error\ngot: %s", diags.Err().Error()) } @@ -1677,13 +1565,12 @@ resource "aws_instance" "foo" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -1705,13 +1592,12 @@ resource "aws_instance" "foo" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1736,13 +1622,12 @@ resource "aws_instance" "foo" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1818,13 +1703,12 @@ output "out" { p := testProvider("aws") ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -1851,9 +1735,7 @@ output "out" { `, }) - diags := testContext2(t, &ContextOpts{ - Config: m, - }).Validate() + diags := testContext2(t, &ContextOpts{}).Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1891,9 +1773,7 @@ output "out" { `, }) - diags := testContext2(t, &ContextOpts{ - Config: m, - }).Validate() + diags := testContext2(t, &ContextOpts{}).Validate(m) if !diags.HasErrors() { t.Fatal("succeeded; want errors") } @@ -1937,12 +1817,11 @@ resource "test_instance" "a" { } ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.Err()) } @@ -1977,7 +1856,6 @@ func TestContext2Validate_sensitiveProvisionerConfig(t *testing.T) { pr := simpleMockProvisioner() c := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, @@ -1993,7 +1871,7 @@ func TestContext2Validate_sensitiveProvisionerConfig(t *testing.T) { return pr.ValidateProvisionerConfigResponse } - diags := c.Validate() + diags := c.Validate(m) if diags.HasErrors() { t.Fatalf("unexpected error: %s", diags.Err()) } @@ -2082,13 +1960,12 @@ resource "test_instance" "c" { `}) ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } @@ -2150,13 +2027,12 @@ resource "test_object" "t" { p := simpleMockProvider() ctx := testContext2(t, &ContextOpts{ - Config: m, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), }, }) - diags := ctx.Validate() + diags := ctx.Validate(m) if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } diff --git a/internal/terraform/context_walk.go b/internal/terraform/context_walk.go new file mode 100644 index 000000000000..b44a5910c5d5 --- /dev/null +++ b/internal/terraform/context_walk.go @@ -0,0 +1,122 @@ +package terraform + +import ( + "log" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/instances" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/refactoring" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +// graphWalkOpts captures some transient values we use (and possibly mutate) +// during a graph walk. +// +// The way these options get used unfortunately varies between the different +// walkOperation types. This is a historical design wart that dates back to +// us using the same graph structure for all operations; hopefully we'll +// make the necessary differences between the walk types more explicit someday. +type graphWalkOpts struct { + InputState *states.State + Changes *plans.Changes + Config *configs.Config + Schemas *Schemas + + RootVariableValues InputValues + MoveResults map[addrs.UniqueKey]refactoring.MoveResult +} + +func (c *Context) walk(graph *Graph, operation walkOperation, opts *graphWalkOpts) (*ContextGraphWalker, tfdiags.Diagnostics) { + log.Printf("[DEBUG] Starting graph walk: %s", operation.String()) + + walker := c.graphWalker(operation, opts) + + // Watch for a stop so we can call the provider Stop() API. + watchStop, watchWait := c.watchStop(walker) + + // Walk the real graph, this will block until it completes + diags := graph.Walk(walker) + + // Close the channel so the watcher stops, and wait for it to return. + close(watchStop) + <-watchWait + + return walker, diags +} + +func (c *Context) graphWalker(operation walkOperation, opts *graphWalkOpts) *ContextGraphWalker { + var state *states.SyncState + var refreshState *states.SyncState + var prevRunState *states.SyncState + + // NOTE: None of the SyncState objects must directly wrap opts.InputState, + // because we use those to mutate the state object and opts.InputState + // belongs to our caller and thus we must treat it as immutable. + // + // To account for that, most of our SyncState values created below end up + // wrapping a _deep copy_ of opts.InputState instead. + inputState := opts.InputState + if inputState == nil { + // Lots of callers use nil to represent the "empty" case where we've + // not run Apply yet, so we tolerate that. + inputState = states.NewState() + } + + switch operation { + case walkValidate: + // validate should not use any state + state = states.NewState().SyncWrapper() + + // validate currently uses the plan graph, so we have to populate the + // refreshState and the prevRunState. + refreshState = states.NewState().SyncWrapper() + prevRunState = states.NewState().SyncWrapper() + + case walkPlan, walkPlanDestroy: + state = inputState.DeepCopy().SyncWrapper() + refreshState = inputState.DeepCopy().SyncWrapper() + prevRunState = inputState.DeepCopy().SyncWrapper() + + default: + state = inputState.DeepCopy().SyncWrapper() + // Only plan-like walks use refreshState and prevRunState + } + + changes := opts.Changes + if changes == nil { + // Several of our non-plan walks end up sharing codepaths with the + // plan walk and thus expect to generate planned changes even though + // we don't care about them. To avoid those crashing, we'll just + // insert a placeholder changes object which'll get discarded + // afterwards. + changes = plans.NewChanges() + } + + if opts.Schemas == nil { + // Should never happen: caller must always set this one. + // (We catch this here, rather than later, to get a more intelligible + // stack trace when it _does_ panic.) + panic("Context.graphWalker call without Schemas") + } + if opts.Config == nil { + panic("Context.graphWalker call without Config") + } + + return &ContextGraphWalker{ + Context: c, + State: state, + Config: opts.Config, + Schemas: opts.Schemas, + RefreshState: refreshState, + PrevRunState: prevRunState, + Changes: changes.SyncWrapper(), + InstanceExpander: instances.NewExpander(), + MoveResults: opts.MoveResults, + Operation: operation, + StopContext: c.runContext, + RootVariableValues: opts.RootVariableValues, + } +} diff --git a/internal/terraform/graph.go b/internal/terraform/graph.go index 65a3c2003e6e..3d09f329b1c7 100644 --- a/internal/terraform/graph.go +++ b/internal/terraform/graph.go @@ -42,7 +42,17 @@ func (g *Graph) walk(walker GraphWalker) tfdiags.Diagnostics { log.Printf("[TRACE] vertex %q: starting visit (%T)", dag.VertexName(v), v) defer func() { - log.Printf("[TRACE] vertex %q: visit complete", dag.VertexName(v)) + if diags.HasErrors() { + for _, diag := range diags { + if diag.Severity() == tfdiags.Error { + desc := diag.Description() + log.Printf("[ERROR] vertex %q error: %s", dag.VertexName(v), desc.Summary) + } + } + log.Printf("[TRACE] vertex %q: visit complete, with errors", dag.VertexName(v)) + } else { + log.Printf("[TRACE] vertex %q: visit complete", dag.VertexName(v)) + } }() // vertexCtx is the context that we use when evaluating. This diff --git a/internal/terraform/graph_builder_apply_test.go b/internal/terraform/graph_builder_apply_test.go index 9dd66c539d43..b96149bac65d 100644 --- a/internal/terraform/graph_builder_apply_test.go +++ b/internal/terraform/graph_builder_apply_test.go @@ -522,7 +522,7 @@ func TestApplyGraphBuilder_updateFromOrphan(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"b_id","test_string":"a_id"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_object", @@ -626,7 +626,7 @@ func TestApplyGraphBuilder_updateFromCBDOrphan(t *testing.T) { Status: states.ObjectReady, AttrsJSON: []byte(`{"id":"b_id","test_string":"a_id"}`), Dependencies: []addrs.ConfigResource{ - addrs.ConfigResource{ + { Resource: addrs.Resource{ Mode: addrs.ManagedResourceMode, Type: "test_object", diff --git a/internal/terraform/graph_walk_context.go b/internal/terraform/graph_walk_context.go index fcda4fa73442..164a2ba2a58c 100644 --- a/internal/terraform/graph_walk_context.go +++ b/internal/terraform/graph_walk_context.go @@ -7,6 +7,7 @@ import ( "github.com/zclconf/go-cty/cty" "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/instances" "github.com/hashicorp/terraform/internal/plans" @@ -33,6 +34,8 @@ type ContextGraphWalker struct { Operation walkOperation StopContext context.Context RootVariableValues InputValues + Schemas *Schemas + Config *configs.Config // This is an output. Do not set this, nor read it while a graph walk // is in progress. @@ -74,11 +77,11 @@ func (w *ContextGraphWalker) EvalContext() EvalContext { // different modules. evaluator := &Evaluator{ Meta: w.Context.meta, - Config: w.Context.config, + Config: w.Config, Operation: w.Operation, State: w.State, Changes: w.Changes, - Schemas: w.Context.schemas, + Schemas: w.Schemas, VariableValues: w.variableValues, VariableValuesLock: &w.variableValuesLock, } @@ -89,7 +92,7 @@ func (w *ContextGraphWalker) EvalContext() EvalContext { InputValue: w.Context.uiInput, InstanceExpanderValue: w.InstanceExpander, Components: w.Context.components, - Schemas: w.Context.schemas, + Schemas: w.Schemas, MoveResultsValue: w.MoveResults, ProviderCache: w.providerCache, ProviderInputConfig: w.Context.providerInputConfig, diff --git a/internal/terraform/graphtype_string.go b/internal/terraform/graphtype_string.go deleted file mode 100644 index ac605ccab3a6..000000000000 --- a/internal/terraform/graphtype_string.go +++ /dev/null @@ -1,29 +0,0 @@ -// Code generated by "stringer -type=GraphType context_graph_type.go"; DO NOT EDIT. - -package terraform - -import "strconv" - -func _() { - // An "invalid array index" compiler error signifies that the constant values have changed. - // Re-run the stringer command to generate them again. - var x [1]struct{} - _ = x[GraphTypeInvalid-0] - _ = x[GraphTypePlan-1] - _ = x[GraphTypePlanDestroy-2] - _ = x[GraphTypePlanRefreshOnly-3] - _ = x[GraphTypeApply-4] - _ = x[GraphTypeValidate-5] - _ = x[GraphTypeEval-6] -} - -const _GraphType_name = "GraphTypeInvalidGraphTypePlanGraphTypePlanDestroyGraphTypePlanRefreshOnlyGraphTypeApplyGraphTypeValidateGraphTypeEval" - -var _GraphType_index = [...]uint8{0, 16, 29, 49, 73, 87, 104, 117} - -func (i GraphType) String() string { - if i >= GraphType(len(_GraphType_index)-1) { - return "GraphType(" + strconv.FormatInt(int64(i), 10) + ")" - } - return _GraphType_name[_GraphType_index[i]:_GraphType_index[i+1]] -} diff --git a/internal/terraform/node_provider.go b/internal/terraform/node_provider.go index fa4c47f32010..33cad198abf8 100644 --- a/internal/terraform/node_provider.go +++ b/internal/terraform/node_provider.go @@ -35,10 +35,13 @@ func (n *NodeApplyableProvider) Execute(ctx EvalContext, op walkOperation) (diag switch op { case walkValidate: + log.Printf("[TRACE] NodeApplyableProvider: validating configuration for %s", n.Addr) return diags.Append(n.ValidateProvider(ctx, provider)) case walkPlan, walkApply, walkDestroy: + log.Printf("[TRACE] NodeApplyableProvider: configuring %s", n.Addr) return diags.Append(n.ConfigureProvider(ctx, provider, false)) case walkImport: + log.Printf("[TRACE] NodeApplyableProvider: configuring %s (requiring that configuration is wholly known)", n.Addr) return diags.Append(n.ConfigureProvider(ctx, provider, true)) } return diags diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index 89275809bbb5..9f07068e3901 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -150,6 +150,7 @@ func (n *NodeAbstractResourceInstance) AttachResourceState(s *states.Resource) { log.Printf("[WARN] attaching nil state to %s", n.Addr) return } + log.Printf("[TRACE] NodeAbstractResourceInstance.AttachResourceState for %s", n.Addr) n.instanceState = s.Instance(n.Addr.Resource.Key) n.storedProviderConfig = s.ProviderConfig } diff --git a/internal/terraform/variables.go b/internal/terraform/variables.go index f8fd03af29d9..fca392802587 100644 --- a/internal/terraform/variables.go +++ b/internal/terraform/variables.go @@ -227,6 +227,19 @@ func (vv InputValues) Identical(other InputValues) bool { return true } +func mergeDefaultInputVariableValues(setVals InputValues, rootVarsConfig map[string]*configs.Variable) InputValues { + var variables InputValues + + // Default variables from the configuration seed our map. + variables = DefaultVariableValues(rootVarsConfig) + + // Variables provided by the caller (from CLI, environment, etc) can + // override the defaults. + variables = variables.Override(setVals) + + return variables +} + // checkInputVariables ensures that variable values supplied at the UI conform // to their corresponding declarations in configuration. // From 7803f69d42c7ccedc962da308a4d1e033cacb0dd Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 27 Aug 2021 16:52:14 -0700 Subject: [PATCH 022/644] core: Enable TestContext2Plan_movedResourceBasic This is the first test exercising the basic functionality of config-driven move. We previously had it skipped because Terraform's previous design of treating all three of the state artifacts as mutable attributes of terraform.Context meant that it was too late during planning to deal with the move operations, and thus this test was failing. Thanks to the previous commit, which changes the terraform.Context API such that we can defer creating the three state artifacts until we're already doing planning, this test now works and shows Terraform correctly handling a resource that was formerly called "a" and is now called "b", with a "moved" block recording that renaming. --- internal/terraform/context_plan2_test.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 08796a3c1bf2..53053fedadc1 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -701,8 +701,6 @@ provider "test" { } func TestContext2Plan_movedResourceBasic(t *testing.T) { - t.Skip("Context.Plan doesn't properly propagate moves into the prior state yet") - addrA := mustResourceInstanceAddr("test_object.a") addrB := mustResourceInstanceAddr("test_object.b") m := testModuleInline(t, map[string]string{ From 48859417faec8080ba058638c0dc074df205a625 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 30 Aug 2021 14:12:17 -0700 Subject: [PATCH 023/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c883b7a0fdbc..2d74909b05d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ UPGRADE NOTES: * Terraform on macOS now requires macOS 10.13 High Sierra or later; Older macOS versions are no longer supported. +* The `terraform graph` command no longer supports `-type=validate` and `-type=eval` options. The validate graph is always the same as the plan graph anyway, and the "eval" graph was just an implementation detail of the `terraform console` command. The default behavior of creating a plan graph should be a reasonable replacement for both of the removed graph modes. (Please note that `terraform graph` is not covered by the Terraform v1.0 compatibility promises, because its behavior inherently exposes Terraform Core implementation details, so we recommend it only for interactive debugging tasks and not for use in automation.) NEW FEATURES: From f195ce7fd42975d30d48b7d5758537690aea01b6 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 31 Aug 2021 11:17:32 -0400 Subject: [PATCH 024/644] remove temp test --- internal/plans/objchange/plan_valid_test.go | 82 --------------------- 1 file changed, 82 deletions(-) diff --git a/internal/plans/objchange/plan_valid_test.go b/internal/plans/objchange/plan_valid_test.go index dedb3958b010..834d1046356d 100644 --- a/internal/plans/objchange/plan_valid_test.go +++ b/internal/plans/objchange/plan_valid_test.go @@ -1486,85 +1486,3 @@ func TestAssertPlanValid(t *testing.T) { }) } } - -func TestAssertPlanValidTEST(t *testing.T) { - tests := map[string]struct { - Schema *configschema.Block - Prior cty.Value - Config cty.Value - Planned cty.Value - WantErrs []string - }{ - "computed in map": { - &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "items": { - NestedType: &configschema.Object{ - Nesting: configschema.NestingMap, - Attributes: map[string]*configschema.Attribute{ - "name": { - Type: cty.String, - Computed: true, - Optional: true, - }, - }, - }, - Required: true, - }, - }, - }, - cty.NullVal(cty.Object(map[string]cty.Type{ - "items": cty.Map(cty.Object(map[string]cty.Type{ - "name": cty.String, - })), - })), - cty.ObjectVal(map[string]cty.Value{ - "items": cty.MapVal(map[string]cty.Value{ - "one": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - //"name": cty.StringVal("computed"), - }), - }), - }), - cty.ObjectVal(map[string]cty.Value{ - "items": cty.MapVal(map[string]cty.Value{ - "one": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("computed"), - }), - }), - }), - nil, - }, - } - for name, test := range tests { - t.Run(name, func(t *testing.T) { - errs := AssertPlanValid(test.Schema, test.Prior, test.Config, test.Planned) - - wantErrs := make(map[string]struct{}) - gotErrs := make(map[string]struct{}) - for _, err := range errs { - gotErrs[tfdiags.FormatError(err)] = struct{}{} - } - for _, msg := range test.WantErrs { - wantErrs[msg] = struct{}{} - } - - t.Logf( - "\nprior: %sconfig: %splanned: %s", - dump.Value(test.Planned), - dump.Value(test.Config), - dump.Value(test.Planned), - ) - for msg := range wantErrs { - if _, ok := gotErrs[msg]; !ok { - t.Errorf("missing expected error: %s", msg) - } - } - for msg := range gotErrs { - if _, ok := wantErrs[msg]; !ok { - t.Errorf("unexpected extra error: %s", msg) - } - } - }) - } -} From 5eb7170f70e31d8a25e79ae11a19f6adeafa53b9 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 2 Dec 2020 11:57:29 -0500 Subject: [PATCH 025/644] add staticcheck to tools --- go.mod | 2 ++ go.sum | 2 ++ tools/tools.go | 1 + 3 files changed, 5 insertions(+) diff --git a/go.mod b/go.mod index 89e274d7f7c3..6cbca3b170df 100644 --- a/go.mod +++ b/go.mod @@ -14,6 +14,7 @@ require ( github.com/Azure/go-autorest/logger v0.2.1 // indirect github.com/Azure/go-autorest/tracing v0.6.0 // indirect github.com/Azure/go-ntlmssp v0.0.0-20200615164410-66371956d46c // indirect + github.com/BurntSushi/toml v0.3.1 // indirect github.com/ChrisTrenkamp/goxpath v0.0.0-20190607011252-c5096ec8773d // indirect github.com/Masterminds/goutils v1.1.0 // indirect github.com/Masterminds/semver v1.5.0 // indirect @@ -172,6 +173,7 @@ require ( gopkg.in/inf.v0 v0.9.0 // indirect gopkg.in/ini.v1 v1.42.0 // indirect gopkg.in/yaml.v2 v2.3.0 // indirect + honnef.co/go/tools v0.0.1-2020.1.4 k8s.io/api v0.0.0-20190620084959-7cf5895f2711 k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655 k8s.io/client-go v10.0.0+incompatible diff --git a/go.sum b/go.sum index 9b2e43bafe4c..b89a0b92cdb7 100644 --- a/go.sum +++ b/go.sum @@ -74,6 +74,7 @@ github.com/Azure/go-autorest/tracing v0.6.0/go.mod h1:+vhtPC754Xsa23ID7GlGsrdKBp github.com/Azure/go-ntlmssp v0.0.0-20180810175552-4a21cbd618b4/go.mod h1:chxPXzSsl7ZWRAuOIE23GDNzjWuZquvFlgA8xmpunjU= github.com/Azure/go-ntlmssp v0.0.0-20200615164410-66371956d46c h1:/IBSNwUN8+eKzUzbJPqhK839ygXJ82sde8x3ogr6R28= github.com/Azure/go-ntlmssp v0.0.0-20200615164410-66371956d46c/go.mod h1:chxPXzSsl7ZWRAuOIE23GDNzjWuZquvFlgA8xmpunjU= +github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/ChrisTrenkamp/goxpath v0.0.0-20170922090931-c385f95c6022/go.mod h1:nuWgzSkT5PnyOd+272uUmV0dnAnAn42Mk7PiQC5VzN4= @@ -1061,6 +1062,7 @@ honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWh honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= +honnef.co/go/tools v0.0.1-2020.1.4 h1:UoveltGrhghAA7ePc+e+QYDHXrBps2PqFZiHkGR/xK8= honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= k8s.io/api v0.0.0-20190620084959-7cf5895f2711 h1:BblVYz/wE5WtBsD/Gvu54KyBUTJMflolzc5I2DTvh50= k8s.io/api v0.0.0-20190620084959-7cf5895f2711/go.mod h1:TBhBqb1AWbBQbW3XRusr7n7E4v2+5ZY8r8sAMnyFC5A= diff --git a/tools/tools.go b/tools/tools.go index e5e1255bab06..712cd6717c56 100644 --- a/tools/tools.go +++ b/tools/tools.go @@ -10,4 +10,5 @@ import ( _ "golang.org/x/tools/cmd/cover" _ "golang.org/x/tools/cmd/stringer" _ "google.golang.org/grpc/cmd/protoc-gen-go-grpc" + _ "honnef.co/go/tools/cmd/staticcheck" ) From 110d4820336f8363f6d2077aeaf6170dc7d25303 Mon Sep 17 00:00:00 2001 From: Peter Mescalchin Date: Wed, 1 Sep 2021 13:59:08 +1000 Subject: [PATCH 026/644] Update S3 backend documentation - DynamoDB uses Partition keys, not primary keys --- website/docs/language/settings/backends/s3.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.html.md index 73f668e9468f..f6b9b9b69e0d 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.html.md @@ -200,7 +200,7 @@ The following configuration is optional: The following configuration is optional: * `dynamodb_endpoint` - (Optional) Custom endpoint for the AWS DynamoDB API. This can also be sourced from the `AWS_DYNAMODB_ENDPOINT` environment variable. -* `dynamodb_table` - (Optional) Name of DynamoDB Table to use for state locking and consistency. The table must have a primary key named `LockID` with type of `string`. If not configured, state locking will be disabled. +* `dynamodb_table` - (Optional) Name of DynamoDB Table to use for state locking and consistency. The table must have a partition key named `LockID` with type of `String`. If not configured, state locking will be disabled. ## Multi-account AWS Architecture From f238e9395ab1e1cb7f311943c3a2506c3909d284 Mon Sep 17 00:00:00 2001 From: Peter Mescalchin Date: Wed, 1 Sep 2021 14:02:28 +1000 Subject: [PATCH 027/644] Quality of life: updated all AWS document links to https:// --- website/docs/language/settings/backends/s3.html.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.html.md index f6b9b9b69e0d..e043701f445b 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.html.md @@ -240,15 +240,15 @@ gain access to the (usually more privileged) administrative infrastructure. Your administrative AWS account will contain at least the following items: -* One or more [IAM user](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) +* One or more [IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html) for system administrators that will log in to maintain infrastructure in the other accounts. -* Optionally, one or more [IAM groups](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html) +* Optionally, one or more [IAM groups](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html) to differentiate between different groups of users that have different levels of access to the other AWS accounts. * An [S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) that will contain the Terraform state files for each workspace. -* A [DynamoDB table](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.TablesItemsAttributes) +* A [DynamoDB table](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.TablesItemsAttributes) that will be used for locking to prevent concurrent operations on a single workspace. @@ -266,7 +266,7 @@ administrative account described above. Your environment accounts will eventually contain your own product-specific infrastructure. Along with this it must contain one or more -[IAM roles](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) +[IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that grant sufficient access for Terraform to perform the desired management tasks. @@ -274,7 +274,7 @@ tasks. Each Administrator will run Terraform using credentials for their IAM user in the administrative account. -[IAM Role Delegation](http://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) +[IAM Role Delegation](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) is used to grant these users access to the roles created in each environment account. @@ -369,7 +369,7 @@ tend to require. When running Terraform in an automation tool running on an Amazon EC2 instance, consider running this instance in the administrative account and using an -[instance profile](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) +[instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) in place of the various administrator IAM users suggested above. An IAM instance profile can also be granted cross-account delegation access via an IAM policy, giving this instance the access it needs to run Terraform. From a3fb07d00818513c902bffd41ea0e740d9c8b768 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 2 Dec 2020 12:02:33 -0500 Subject: [PATCH 028/644] add staticcheck make target cleanup the old fmtcheck script while we're in here --- Makefile | 5 ++++- scripts/gofmtcheck.sh | 8 ++++---- scripts/staticcheck.sh | 16 ++++++++++++++++ 3 files changed, 24 insertions(+), 5 deletions(-) create mode 100755 scripts/staticcheck.sh diff --git a/Makefile b/Makefile index ede1c5cd6441..16e2abaa5b2c 100644 --- a/Makefile +++ b/Makefile @@ -20,6 +20,9 @@ protobuf: fmtcheck: @sh -c "'$(CURDIR)/scripts/gofmtcheck.sh'" +staticcheck: + @sh -c "'$(CURDIR)/scripts/staticcheck.sh'" + website: ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO))) echo "$(WEBSITE_REPO) not found in your GOPATH (necessary for layouts and assets), get-ting..." @@ -46,4 +49,4 @@ endif # under parallel conditions. .NOTPARALLEL: -.PHONY: fmtcheck generate protobuf website website-test +.PHONY: fmtcheck generate protobuf website website-test staticcheck diff --git a/scripts/gofmtcheck.sh b/scripts/gofmtcheck.sh index 9a341da94204..00b81a8befde 100755 --- a/scripts/gofmtcheck.sh +++ b/scripts/gofmtcheck.sh @@ -1,12 +1,12 @@ #!/usr/bin/env bash -# Check gofmt -echo "==> Checking that code complies with gofmt requirements..." -gofmt_files=$(gofmt -l `find . -name '*.go' | grep -v vendor`) +# Check go fmt +echo "==> Checking that code complies with go fmt requirements..." +gofmt_files=$(go fmt ./...) if [[ -n ${gofmt_files} ]]; then echo 'gofmt needs running on the following files:' echo "${gofmt_files}" - echo "You can use the command: \`gofmt -w .\` to reformat code." + echo "You can use the command: \`go fmt\` to reformat code." exit 1 fi diff --git a/scripts/staticcheck.sh b/scripts/staticcheck.sh new file mode 100755 index 000000000000..66c47092f9f9 --- /dev/null +++ b/scripts/staticcheck.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash + +echo "==> Checking that code complies with static analysis requirements..." +# Skip legacy code which is frozen, and can be removed once we can refactor the +# remote backends to no longer require it. +skip="internal/legacy|backend/remote-state/" + +# Skip generated code for protobufs. +skip=$skip"|internal/planproto|internal/tfplugin5|internal/tfplugin6" + +packages=$(go list ./... | egrep -v ${skip}) + +# We are skipping style-related checks, since terraform intentionally breaks +# some of these. The goal here is to find issues that reduce code clarity, or +# may result in bugs. +staticcheck -checks 'all,-ST*' ${packages} From 34325d5b66a8eb4eda5e435c967061c6c7fbfbc4 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 2 Dec 2020 12:16:14 -0500 Subject: [PATCH 029/644] add staticcheck to circleci --- .circleci/config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 85ec770d7708..0113ae17c3f4 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -26,7 +26,8 @@ jobs: steps: - checkout - run: go mod verify - - run: make fmtcheck generate + - run: go install honnef.co/go/tools/cmd/staticcheck + - run: make fmtcheck generate staticcheck - run: name: verify no code was generated command: | From 863963e7a6af7a1125c45df523c62d1d92db52e0 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 31 Aug 2021 17:33:26 -0400 Subject: [PATCH 030/644] de-linting --- internal/addrs/resource.go | 4 -- internal/backend/remote/backend.go | 18 +-------- internal/backend/remote/backend_apply_test.go | 2 +- internal/command/apply.go | 3 +- internal/command/apply_test.go | 2 + internal/command/format/diff.go | 4 +- internal/command/jsonplan/values.go | 25 ------------ internal/command/login.go | 8 +--- internal/command/meta.go | 39 ------------------- internal/command/meta_backend.go | 3 +- internal/command/refresh.go | 3 +- internal/command/state_meta.go | 2 +- internal/command/state_mv_test.go | 6 --- internal/command/views/add.go | 4 +- internal/command/views/json/output_test.go | 3 ++ internal/command/views/output.go | 4 -- internal/communicator/ssh/communicator.go | 3 +- internal/configs/provider_requirements.go | 3 +- internal/dag/marshal.go | 4 +- internal/terraform/context_plan.go | 1 + internal/terraform/graph_test.go | 14 ------- internal/terraform/resource_provider.go | 16 -------- .../terraform/resource_provider_mock_test.go | 27 ------------- tools/protobuf-compile/protobuf-compile.go | 4 +- 24 files changed, 24 insertions(+), 178 deletions(-) delete mode 100644 internal/terraform/resource_provider.go diff --git a/internal/addrs/resource.go b/internal/addrs/resource.go index a26f941c9412..2c69d2f70517 100644 --- a/internal/addrs/resource.go +++ b/internal/addrs/resource.go @@ -194,14 +194,10 @@ func (r AbsResource) absMoveableSigil() { // AbsResource is moveable } -type absResourceKey string - func (r AbsResource) UniqueKey() UniqueKey { return absResourceInstanceKey(r.String()) } -func (rk absResourceKey) uniqueKeySigil() {} - // AbsResourceInstance is an absolute address for a resource instance under a // given module path. type AbsResourceInstance struct { diff --git a/internal/backend/remote/backend.go b/internal/backend/remote/backend.go index 5e11872391be..b4aa115a798b 100644 --- a/internal/backend/remote/backend.go +++ b/internal/backend/remote/backend.go @@ -888,7 +888,7 @@ func (b *Remote) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.D // If the workspace has remote operations disabled, the remote Terraform // version is effectively meaningless, so we'll skip version verification. - if workspace.Operations == false { + if !workspace.Operations { return nil } @@ -963,22 +963,6 @@ func (b *Remote) IsLocalOperations() bool { return b.forceLocal } -// Colorize returns the Colorize structure that can be used for colorizing -// output. This is guaranteed to always return a non-nil value and so useful -// as a helper to wrap any potentially colored strings. -// -// TODO SvH: Rename this back to Colorize as soon as we can pass -no-color. -func (b *Remote) cliColorize() *colorstring.Colorize { - if b.CLIColor != nil { - return b.CLIColor - } - - return &colorstring.Colorize{ - Colors: colorstring.DefaultColors, - Disable: true, - } -} - func generalError(msg string, err error) error { var diags tfdiags.Diagnostics diff --git a/internal/backend/remote/backend_apply_test.go b/internal/backend/remote/backend_apply_test.go index 8ba2aa271ca7..d54914559717 100644 --- a/internal/backend/remote/backend_apply_test.go +++ b/internal/backend/remote/backend_apply_test.go @@ -1594,7 +1594,7 @@ func TestRemote_applyVersionCheck(t *testing.T) { } // RUN: prepare the apply operation and run it - op, configCleanup, done := testOperationApply(t, "./testdata/apply") + op, configCleanup, _ := testOperationApply(t, "./testdata/apply") defer configCleanup() streams, done := terminal.StreamsForTesting(t) diff --git a/internal/command/apply.go b/internal/command/apply.go index d3fd56066e69..9d481c06b8e1 100644 --- a/internal/command/apply.go +++ b/internal/command/apply.go @@ -45,8 +45,7 @@ func (c *ApplyCommand) Run(rawArgs []string) int { // Instantiate the view, even if there are flag errors, so that we render // diagnostics according to the desired view - var view views.Apply - view = views.NewApply(args.ViewType, c.Destroy, c.View) + view := views.NewApply(args.ViewType, c.Destroy, c.View) if diags.HasErrors() { view.Diagnostics(diags) diff --git a/internal/command/apply_test.go b/internal/command/apply_test.go index c5cc6400fea7..750c6b6bf336 100644 --- a/internal/command/apply_test.go +++ b/internal/command/apply_test.go @@ -1779,6 +1779,7 @@ func TestApply_terraformEnvNonDefault(t *testing.T) { }, } if code := newCmd.Run([]string{"test"}); code != 0 { + t.Fatal("error creating workspace") } } @@ -1792,6 +1793,7 @@ func TestApply_terraformEnvNonDefault(t *testing.T) { }, } if code := selCmd.Run(args); code != 0 { + t.Fatal("error switching workspace") } } diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index 258c979a5ab7..982b95980bf5 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -70,7 +70,7 @@ func ResourceChange( buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be [bold][red]destroyed", dispAddr))) if change.DeposedKey != states.NotDeposed { // Some extra context about this unusual situation. - buf.WriteString(color.Color(fmt.Sprint("\n # (left over from a partially-failed replacement of this instance)"))) + buf.WriteString(color.Color("\n # (left over from a partially-failed replacement of this instance)")) } default: // should never happen, since the above is exhaustive @@ -755,8 +755,6 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( p.buf.WriteString(" -> (known after apply)") } } - - return } func (p *blockBodyDiffPrinter) writeNestedBlockDiffs(name string, blockS *configschema.NestedBlock, old, new cty.Value, blankBefore bool, indent int, path cty.Path) int { diff --git a/internal/command/jsonplan/values.go b/internal/command/jsonplan/values.go index d79703215fbf..5716aa67e855 100644 --- a/internal/command/jsonplan/values.go +++ b/internal/command/jsonplan/values.go @@ -274,28 +274,3 @@ func marshalPlanModules( return ret, nil } - -// marshalSensitiveValues returns a map of sensitive attributes, with the value -// set to true. It returns nil if the value is nil or if there are no sensitive -// vals. -func marshalSensitiveValues(value cty.Value) map[string]bool { - if value.RawEquals(cty.NilVal) || value.IsNull() { - return nil - } - - ret := make(map[string]bool) - - it := value.ElementIterator() - for it.Next() { - k, v := it.Element() - s := jsonstate.SensitiveAsBool(v) - if !s.RawEquals(cty.False) { - ret[k.AsString()] = true - } - } - - if len(ret) == 0 { - return nil - } - return ret -} diff --git a/internal/command/login.go b/internal/command/login.go index 7233ffd096c2..4ede60ddb5c8 100644 --- a/internal/command/login.go +++ b/internal/command/login.go @@ -311,13 +311,9 @@ func (c *LoginCommand) outputDefaultTFELoginSuccess(dispHostname string) { } func (c *LoginCommand) outputDefaultTFCLoginSuccess() { - c.Ui.Output( - fmt.Sprintf( - c.Colorize().Color(strings.TrimSpace(` + c.Ui.Output(c.Colorize().Color(strings.TrimSpace(` [green][bold]Success![reset] [bold]Logged in to Terraform Cloud[reset] -`)), - ) + "\n", - ) +` + "\n"))) } func (c *LoginCommand) logMOTDError(err error) { diff --git a/internal/command/meta.go b/internal/command/meta.go index 70d317779429..072cfad419ef 100644 --- a/internal/command/meta.go +++ b/internal/command/meta.go @@ -15,8 +15,6 @@ import ( "time" plugin "github.com/hashicorp/go-plugin" - "github.com/hashicorp/hcl/v2" - "github.com/hashicorp/hcl/v2/hclsyntax" "github.com/hashicorp/terraform-svchost/disco" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" @@ -554,43 +552,6 @@ func (m *Meta) extendedFlagSet(n string) *flag.FlagSet { return f } -// parseTargetFlags must be called for any commands supporting -target -// arguments. This method attempts to parse each -target flag into an -// addrs.Target, storing in the Meta.targets slice. -// -// If any flags cannot be parsed, we rewrap the first error diagnostic with a -// custom title to clarify the source of the error. The normal approach of -// directly returning the diags from HCL or the addrs package results in -// confusing incorrect "source" results when presented. -func (m *Meta) parseTargetFlags() tfdiags.Diagnostics { - var diags tfdiags.Diagnostics - m.targets = nil - for _, tf := range m.targetFlags { - traversal, syntaxDiags := hclsyntax.ParseTraversalAbs([]byte(tf), "", hcl.Pos{Line: 1, Column: 1}) - if syntaxDiags.HasErrors() { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - fmt.Sprintf("Invalid target %q", tf), - syntaxDiags[0].Detail, - )) - continue - } - - target, targetDiags := addrs.ParseTarget(traversal) - if targetDiags.HasErrors() { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - fmt.Sprintf("Invalid target %q", tf), - targetDiags[0].Description().Detail, - )) - continue - } - - m.targets = append(m.targets, target.Subject) - } - return diags -} - // process will process any -no-color entries out of the arguments. This // will potentially modify the args in-place. It will return the resulting // slice, and update the Meta and Ui. diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index ab7375107495..71ebfbe26224 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -12,7 +12,6 @@ import ( "strconv" "strings" - "github.com/hashicorp/errwrap" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hcldec" "github.com/hashicorp/terraform/internal/backend" @@ -244,7 +243,7 @@ func (m *Meta) BackendForPlan(settings plans.Backend) (backend.Enhanced, tfdiags schema := b.ConfigSchema() configVal, err := settings.Config.Decode(schema.ImpliedType()) if err != nil { - diags = diags.Append(errwrap.Wrapf("saved backend configuration is invalid: {{err}}", err)) + diags = diags.Append(fmt.Errorf("saved backend configuration is invalid: %w", err)) return nil, diags } diff --git a/internal/command/refresh.go b/internal/command/refresh.go index 75cfc3458ea7..1bb5d3933c75 100644 --- a/internal/command/refresh.go +++ b/internal/command/refresh.go @@ -26,8 +26,7 @@ func (c *RefreshCommand) Run(rawArgs []string) int { // Instantiate the view, even if there are flag errors, so that we render // diagnostics according to the desired view - var view views.Refresh - view = views.NewRefresh(args.ViewType, c.View) + view := views.NewRefresh(args.ViewType, c.View) if diags.HasErrors() { view.Diagnostics(diags) diff --git a/internal/command/state_meta.go b/internal/command/state_meta.go index 7fd7ce1bf0c8..fa04245a6c37 100644 --- a/internal/command/state_meta.go +++ b/internal/command/state_meta.go @@ -121,7 +121,7 @@ func (c *StateMeta) lookupResourceInstanceAddr(state *states.State, allowMissing } } - if found == false && !allowMissing { + if !found && !allowMissing { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Unknown module", diff --git a/internal/command/state_mv_test.go b/internal/command/state_mv_test.go index f9beefd1d719..1106879f4048 100644 --- a/internal/command/state_mv_test.go +++ b/internal/command/state_mv_test.go @@ -9,17 +9,11 @@ import ( "github.com/google/go-cmp/cmp" "github.com/mitchellh/cli" - "github.com/mitchellh/colorstring" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/states" ) -var disabledColorize = &colorstring.Colorize{ - Colors: colorstring.DefaultColors, - Disable: true, -} - func TestStateMv(t *testing.T) { state := states.BuildState(func(s *states.SyncState) { s.SetResourceInstanceCurrent( diff --git a/internal/command/views/add.go b/internal/command/views/add.go index 233ae7f6e4e4..5330bf35ca2a 100644 --- a/internal/command/views/add.go +++ b/internal/command/views/add.go @@ -256,7 +256,7 @@ func (v *addHuman) writeConfigNestedBlock(buf *strings.Builder, name string, sch } func (v *addHuman) writeConfigNestedTypeAttribute(buf *strings.Builder, name string, schema *configschema.Attribute, indent int) error { - if schema.Required == false && v.optional == false { + if !schema.Required && !v.optional { return nil } @@ -521,7 +521,6 @@ func writeAttrTypeConstraint(buf *strings.Builder, schema *configschema.Attribut } else { buf.WriteString(fmt.Sprintf("%s\n", schema.Type.FriendlyName())) } - return } func writeBlockTypeConstraint(buf *strings.Builder, schema *configschema.NestedBlock) { @@ -530,7 +529,6 @@ func writeBlockTypeConstraint(buf *strings.Builder, schema *configschema.NestedB } else { buf.WriteString(" # OPTIONAL block\n") } - return } // copied from command/format/diff diff --git a/internal/command/views/json/output_test.go b/internal/command/views/json/output_test.go index f2c220f86c1f..e3e9495b8cf9 100644 --- a/internal/command/views/json/output_test.go +++ b/internal/command/views/json/output_test.go @@ -74,6 +74,9 @@ func TestOutputsFromMap(t *testing.T) { func TestOutputsFromChanges(t *testing.T) { root := addrs.RootModuleInstance num, err := plans.NewDynamicValue(cty.NumberIntVal(1234), cty.Number) + if err != nil { + t.Fatalf("unexpected error creating dynamic value: %v", err) + } str, err := plans.NewDynamicValue(cty.StringVal("1234"), cty.String) if err != nil { t.Fatalf("unexpected error creating dynamic value: %v", err) diff --git a/internal/command/views/output.go b/internal/command/views/output.go index 98686c66494b..6545aaceec9b 100644 --- a/internal/command/views/output.go +++ b/internal/command/views/output.go @@ -105,10 +105,6 @@ func (v *OutputHuman) Diagnostics(diags tfdiags.Diagnostics) { // type of an output value is not important. type OutputRaw struct { view *View - - // Unit tests may set rawPrint to capture the output from the Output - // method, which would normally go to stdout directly. - rawPrint func(string) } var _ Output = (*OutputRaw)(nil) diff --git a/internal/communicator/ssh/communicator.go b/internal/communicator/ssh/communicator.go index 4de6a9040856..6dff03367cc6 100644 --- a/internal/communicator/ssh/communicator.go +++ b/internal/communicator/ssh/communicator.go @@ -19,7 +19,6 @@ import ( "time" "github.com/apparentlymart/go-shquot/shquot" - "github.com/hashicorp/errwrap" "github.com/hashicorp/terraform/internal/communicator/remote" "github.com/hashicorp/terraform/internal/provisioners" "github.com/zclconf/go-cty/cty" @@ -192,7 +191,7 @@ func (c *Communicator) Connect(o provisioners.UIOutput) (err error) { log.Printf("[DEBUG] Connection established. Handshaking for user %v", c.connInfo.User) sshConn, sshChan, req, err := ssh.NewClientConn(c.conn, hostAndPort, c.config.config) if err != nil { - err = errwrap.Wrapf(fmt.Sprintf("SSH authentication failed (%s@%s): {{err}}", c.connInfo.User, hostAndPort), err) + err = fmt.Errorf("SSH authentication failed (%s@%s): %w", c.connInfo.User, hostAndPort, err) // While in theory this should be a fatal error, some hosts may start // the ssh service before it is properly configured, or before user diff --git a/internal/configs/provider_requirements.go b/internal/configs/provider_requirements.go index 6774fbba40ff..c982c1a37cd8 100644 --- a/internal/configs/provider_requirements.go +++ b/internal/configs/provider_requirements.go @@ -86,6 +86,7 @@ func decodeRequiredProvidersBlock(block *hcl.Block) (*RequiredProviders, hcl.Dia continue } + LOOP: for _, kv := range kvs { key, keyDiags := kv.Key.Value(nil) if keyDiags.HasErrors() { @@ -213,7 +214,7 @@ func decodeRequiredProvidersBlock(block *hcl.Block) (*RequiredProviders, hcl.Dia Detail: `required_providers objects can only contain "version", "source" and "configuration_aliases" attributes. To configure a provider, use a "provider" block.`, Subject: kv.Key.Range().Ptr(), }) - break + break LOOP } } diff --git a/internal/dag/marshal.go b/internal/dag/marshal.go index 0ba52152fbf2..a78032ad3607 100644 --- a/internal/dag/marshal.go +++ b/internal/dag/marshal.go @@ -160,7 +160,9 @@ func marshalVertexID(v Vertex) string { case reflect.Chan, reflect.Func, reflect.Map, reflect.Ptr, reflect.Slice, reflect.UnsafePointer: return strconv.Itoa(int(val.Pointer())) case reflect.Interface: - return strconv.Itoa(int(val.InterfaceData()[1])) + // A vertex shouldn't contain another layer of interface, but handle + // this just in case. + return fmt.Sprintf("%#v", val.Interface()) } if v, ok := v.(Hashable); ok { diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index be5d30e61376..7499e57d882b 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -306,6 +306,7 @@ func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState break } } + //lint:ignore SA9003 TODO if !matchesTarget { // TODO: Return an error stating that a targeted plan is // only valid if it includes this address that was moved. diff --git a/internal/terraform/graph_test.go b/internal/terraform/graph_test.go index 6676aa8467f9..5e163a021353 100644 --- a/internal/terraform/graph_test.go +++ b/internal/terraform/graph_test.go @@ -6,20 +6,6 @@ import ( "github.com/hashicorp/terraform/internal/dag" ) -// testGraphContains is an assertion helper that tests that a node is -// contained in the graph. -func testGraphContains(t *testing.T, g *Graph, name string) { - for _, v := range g.Vertices() { - if dag.VertexName(v) == name { - return - } - } - - t.Fatalf( - "Expected %q in:\n\n%s", - name, g.String()) -} - // testGraphnotContains is an assertion helper that tests that a node is // NOT contained in the graph. func testGraphNotContains(t *testing.T, g *Graph, name string) { diff --git a/internal/terraform/resource_provider.go b/internal/terraform/resource_provider.go deleted file mode 100644 index d4bdfcb68abe..000000000000 --- a/internal/terraform/resource_provider.go +++ /dev/null @@ -1,16 +0,0 @@ -package terraform - -const errPluginInit = ` -Plugins are external binaries that Terraform uses to access and manipulate -resources. The configuration provided requires plugins which can't be located, -don't satisfy the version constraints, or are otherwise incompatible. - -Terraform automatically discovers provider requirements from your -configuration, including providers used in child modules. To see the -requirements and constraints, run "terraform providers". - -%s - -Plugin reinitialization required. Please address the above error(s) and run -"terraform init". -` diff --git a/internal/terraform/resource_provider_mock_test.go b/internal/terraform/resource_provider_mock_test.go index a077ba09d8f6..6592b0a96011 100644 --- a/internal/terraform/resource_provider_mock_test.go +++ b/internal/terraform/resource_provider_mock_test.go @@ -46,33 +46,6 @@ func mockProviderWithResourceTypeSchema(name string, schema *configschema.Block) } } -// mockProviderWithProviderSchema is a test helper to create a mock provider -// from an existing ProviderSchema. -func mockProviderWithProviderSchema(providerSchema ProviderSchema) *MockProvider { - p := &MockProvider{ - GetProviderSchemaResponse: &providers.GetProviderSchemaResponse{ - Provider: providers.Schema{ - Block: providerSchema.Provider, - }, - ResourceTypes: map[string]providers.Schema{}, - DataSources: map[string]providers.Schema{}, - }, - } - - for name, schema := range providerSchema.ResourceTypes { - p.GetProviderSchemaResponse.ResourceTypes[name] = providers.Schema{ - Block: schema, - Version: int64(providerSchema.ResourceTypeSchemaVersions[name]), - } - } - - for name, schema := range providerSchema.DataSources { - p.GetProviderSchemaResponse.DataSources[name] = providers.Schema{Block: schema} - } - - return p -} - // getProviderSchemaResponseFromProviderSchema is a test helper to convert a // ProviderSchema to a GetProviderSchemaResponse for use when building a mock provider. func getProviderSchemaResponseFromProviderSchema(providerSchema *ProviderSchema) *providers.GetProviderSchemaResponse { diff --git a/tools/protobuf-compile/protobuf-compile.go b/tools/protobuf-compile/protobuf-compile.go index 19cca308a295..b1efe07890a3 100644 --- a/tools/protobuf-compile/protobuf-compile.go +++ b/tools/protobuf-compile/protobuf-compile.go @@ -80,7 +80,7 @@ func main() { if err != nil { log.Fatal(err) } - protocGenGoGrpcExec, err := buildProtocGenGoGrpc(workDir) + _, err = buildProtocGenGoGrpc(workDir) if err != nil { log.Fatal(err) } @@ -93,7 +93,7 @@ func main() { if err != nil { log.Fatal(err) } - protocGenGoGrpcExec, err = filepath.Abs(protocGenGoExec) + protocGenGoGrpcExec, err := filepath.Abs(protocGenGoExec) if err != nil { log.Fatal(err) } From b60f201eeda9006d4b53142c95744d924d27ae4a Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 1 Sep 2021 11:17:13 -0400 Subject: [PATCH 031/644] json-output: Release format version 1.0 --- internal/command/jsonplan/plan.go | 2 +- internal/command/jsonprovider/provider.go | 2 +- internal/command/jsonstate/state.go | 2 +- .../testdata/providers-schema/basic/output.json | 2 +- .../testdata/providers-schema/empty/output.json | 4 ++-- .../providers-schema/required/output.json | 2 +- .../testdata/show-json-sensitive/output.json | 4 ++-- .../testdata/show-json-state/basic/output.json | 2 +- .../testdata/show-json-state/empty/output.json | 4 ++-- .../show-json-state/modules/output.json | 2 +- .../sensitive-variables/output.json | 2 +- .../testdata/show-json/basic-create/output.json | 4 ++-- .../testdata/show-json/basic-delete/output.json | 4 ++-- .../testdata/show-json/basic-update/output.json | 4 ++-- .../testdata/show-json/drift/output.json | 4 ++-- .../show-json/module-depends-on/output.json | 2 +- .../testdata/show-json/modules/output.json | 4 ++-- .../show-json/multi-resource-update/output.json | 4 ++-- .../show-json/nested-modules/output.json | 2 +- .../provider-version-no-config/output.json | 4 ++-- .../show-json/provider-version/output.json | 4 ++-- .../show-json/requires-replace/output.json | 4 ++-- .../show-json/sensitive-values/output.json | 4 ++-- .../incorrectmodulename/output.json | 2 +- .../validate-invalid/interpolation/output.json | 2 +- .../missing_defined_var/output.json | 2 +- .../validate-invalid/missing_quote/output.json | 2 +- .../validate-invalid/missing_var/output.json | 2 +- .../multiple_modules/output.json | 2 +- .../multiple_providers/output.json | 2 +- .../multiple_resources/output.json | 2 +- .../testdata/validate-invalid/output.json | 2 +- .../validate-invalid/outputs/output.json | 2 +- .../command/testdata/validate-valid/output.json | 2 +- internal/command/views/validate.go | 2 +- .../docs/cli/commands/providers/schema.html.md | 15 +++++++++++++-- website/docs/cli/commands/validate.html.md | 17 ++++++++++++----- website/docs/internals/json-format.html.md | 15 +++++++++++++-- 38 files changed, 86 insertions(+), 57 deletions(-) diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index 1b90daf2d092..b1d488156fcf 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -22,7 +22,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "0.2" +const FormatVersion = "1.0" // Plan is the top-level representation of the json format of a plan. It includes // the complete config and current state. diff --git a/internal/command/jsonprovider/provider.go b/internal/command/jsonprovider/provider.go index b507bc242e9e..4487db4987ae 100644 --- a/internal/command/jsonprovider/provider.go +++ b/internal/command/jsonprovider/provider.go @@ -9,7 +9,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "0.2" +const FormatVersion = "1.0" // providers is the top-level object returned when exporting provider schemas type providers struct { diff --git a/internal/command/jsonstate/state.go b/internal/command/jsonstate/state.go index 341040d2d1c9..46532875c334 100644 --- a/internal/command/jsonstate/state.go +++ b/internal/command/jsonstate/state.go @@ -18,7 +18,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "0.2" +const FormatVersion = "1.0" // state is the top-level representation of the json format of a terraform // state. diff --git a/internal/command/testdata/providers-schema/basic/output.json b/internal/command/testdata/providers-schema/basic/output.json index f14786c3e31e..dfac55b38c35 100644 --- a/internal/command/testdata/providers-schema/basic/output.json +++ b/internal/command/testdata/providers-schema/basic/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "provider_schemas": { "registry.terraform.io/hashicorp/test": { "provider": { diff --git a/internal/command/testdata/providers-schema/empty/output.json b/internal/command/testdata/providers-schema/empty/output.json index 12d30d201356..381450cade5c 100644 --- a/internal/command/testdata/providers-schema/empty/output.json +++ b/internal/command/testdata/providers-schema/empty/output.json @@ -1,3 +1,3 @@ { - "format_version": "0.2" -} \ No newline at end of file + "format_version": "1.0" +} diff --git a/internal/command/testdata/providers-schema/required/output.json b/internal/command/testdata/providers-schema/required/output.json index f14786c3e31e..dfac55b38c35 100644 --- a/internal/command/testdata/providers-schema/required/output.json +++ b/internal/command/testdata/providers-schema/required/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "provider_schemas": { "registry.terraform.io/hashicorp/test": { "provider": { diff --git a/internal/command/testdata/show-json-sensitive/output.json b/internal/command/testdata/show-json-sensitive/output.json index 5f22c4ccf3a2..206fbb7f6e60 100644 --- a/internal/command/testdata/show-json-sensitive/output.json +++ b/internal/command/testdata/show-json-sensitive/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -66,7 +66,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json-state/basic/output.json b/internal/command/testdata/show-json-state/basic/output.json index 3087ad118050..229fa00e7262 100644 --- a/internal/command/testdata/show-json-state/basic/output.json +++ b/internal/command/testdata/show-json-state/basic/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.12.0", "values": { "root_module": { diff --git a/internal/command/testdata/show-json-state/empty/output.json b/internal/command/testdata/show-json-state/empty/output.json index 12d30d201356..381450cade5c 100644 --- a/internal/command/testdata/show-json-state/empty/output.json +++ b/internal/command/testdata/show-json-state/empty/output.json @@ -1,3 +1,3 @@ { - "format_version": "0.2" -} \ No newline at end of file + "format_version": "1.0" +} diff --git a/internal/command/testdata/show-json-state/modules/output.json b/internal/command/testdata/show-json-state/modules/output.json index eeee8f6cffbc..eba163bdbb52 100644 --- a/internal/command/testdata/show-json-state/modules/output.json +++ b/internal/command/testdata/show-json-state/modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.12.0", "values": { "outputs": { diff --git a/internal/command/testdata/show-json-state/sensitive-variables/output.json b/internal/command/testdata/show-json-state/sensitive-variables/output.json index b133aeef13bf..60503cd3ad80 100644 --- a/internal/command/testdata/show-json-state/sensitive-variables/output.json +++ b/internal/command/testdata/show-json-state/sensitive-variables/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.14.0", "values": { "root_module": { diff --git a/internal/command/testdata/show-json/basic-create/output.json b/internal/command/testdata/show-json/basic-create/output.json index 3474443ed386..d1b8aae5361b 100644 --- a/internal/command/testdata/show-json/basic-create/output.json +++ b/internal/command/testdata/show-json/basic-create/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-delete/output.json b/internal/command/testdata/show-json/basic-delete/output.json index 9ebea2058f78..8a0018cd5bff 100644 --- a/internal/command/testdata/show-json/basic-delete/output.json +++ b/internal/command/testdata/show-json/basic-delete/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -88,7 +88,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-update/output.json b/internal/command/testdata/show-json/basic-update/output.json index 2b8bc25e3034..e4b4731426a1 100644 --- a/internal/command/testdata/show-json/basic-update/output.json +++ b/internal/command/testdata/show-json/basic-update/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -68,7 +68,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/drift/output.json b/internal/command/testdata/show-json/drift/output.json index 7badb45e5edd..55c9e3f71cd3 100644 --- a/internal/command/testdata/show-json/drift/output.json +++ b/internal/command/testdata/show-json/drift/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "resources": [ @@ -105,7 +105,7 @@ } ], "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/module-depends-on/output.json b/internal/command/testdata/show-json/module-depends-on/output.json index cc7ed679f0cc..d02efaa22f0d 100644 --- a/internal/command/testdata/show-json/module-depends-on/output.json +++ b/internal/command/testdata/show-json/module-depends-on/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.13.1-dev", "planned_values": { "root_module": { diff --git a/internal/command/testdata/show-json/modules/output.json b/internal/command/testdata/show-json/modules/output.json index 440bebbff891..4ed0ea45d692 100644 --- a/internal/command/testdata/show-json/modules/output.json +++ b/internal/command/testdata/show-json/modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "outputs": { "test": { @@ -74,7 +74,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index d84bc5b08789..ba557de69c8c 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.13.0", "variables": { "test_var": { @@ -127,7 +127,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.13.0", "values": { "outputs": { diff --git a/internal/command/testdata/show-json/nested-modules/output.json b/internal/command/testdata/show-json/nested-modules/output.json index 80e7ae3588e9..359ea9ae181c 100644 --- a/internal/command/testdata/show-json/nested-modules/output.json +++ b/internal/command/testdata/show-json/nested-modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "child_modules": [ diff --git a/internal/command/testdata/show-json/provider-version-no-config/output.json b/internal/command/testdata/show-json/provider-version-no-config/output.json index 64b93ec751c0..6a8b1f451dc0 100644 --- a/internal/command/testdata/show-json/provider-version-no-config/output.json +++ b/internal/command/testdata/show-json/provider-version-no-config/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/provider-version/output.json b/internal/command/testdata/show-json/provider-version/output.json index b5369806e933..11fd3bd64c15 100644 --- a/internal/command/testdata/show-json/provider-version/output.json +++ b/internal/command/testdata/show-json/provider-version/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/requires-replace/output.json b/internal/command/testdata/show-json/requires-replace/output.json index 077d900b13b0..e71df784f4f7 100644 --- a/internal/command/testdata/show-json/requires-replace/output.json +++ b/internal/command/testdata/show-json/requires-replace/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "resources": [ @@ -48,7 +48,7 @@ } ], "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/sensitive-values/output.json b/internal/command/testdata/show-json/sensitive-values/output.json index 7cbc9ccf0e75..d7e4719c71f5 100644 --- a/internal/command/testdata/show-json/sensitive-values/output.json +++ b/internal/command/testdata/show-json/sensitive-values/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "boop" @@ -69,7 +69,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/validate-invalid/incorrectmodulename/output.json b/internal/command/testdata/validate-invalid/incorrectmodulename/output.json index 0c2ce68abd37..f144313fa455 100644 --- a/internal/command/testdata/validate-invalid/incorrectmodulename/output.json +++ b/internal/command/testdata/validate-invalid/incorrectmodulename/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 4, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/interpolation/output.json b/internal/command/testdata/validate-invalid/interpolation/output.json index 7845ec0f4e81..2843b19121fc 100644 --- a/internal/command/testdata/validate-invalid/interpolation/output.json +++ b/internal/command/testdata/validate-invalid/interpolation/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 2, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_defined_var/output.json b/internal/command/testdata/validate-invalid/missing_defined_var/output.json index c2a57c5e6a98..40258a98cd27 100644 --- a/internal/command/testdata/validate-invalid/missing_defined_var/output.json +++ b/internal/command/testdata/validate-invalid/missing_defined_var/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": true, "error_count": 0, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_quote/output.json b/internal/command/testdata/validate-invalid/missing_quote/output.json index cdf99d8b2a2b..87aeca8b7817 100644 --- a/internal/command/testdata/validate-invalid/missing_quote/output.json +++ b/internal/command/testdata/validate-invalid/missing_quote/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_var/output.json b/internal/command/testdata/validate-invalid/missing_var/output.json index 2a4e0be71ebd..6f0b9d5d4c8d 100644 --- a/internal/command/testdata/validate-invalid/missing_var/output.json +++ b/internal/command/testdata/validate-invalid/missing_var/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_modules/output.json b/internal/command/testdata/validate-invalid/multiple_modules/output.json index 4cd6dfb9f0ad..1aeaf929a913 100644 --- a/internal/command/testdata/validate-invalid/multiple_modules/output.json +++ b/internal/command/testdata/validate-invalid/multiple_modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_providers/output.json b/internal/command/testdata/validate-invalid/multiple_providers/output.json index 63eb2d193820..309cf0ea7c34 100644 --- a/internal/command/testdata/validate-invalid/multiple_providers/output.json +++ b/internal/command/testdata/validate-invalid/multiple_providers/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_resources/output.json b/internal/command/testdata/validate-invalid/multiple_resources/output.json index 33d5052284e9..ded584e6846c 100644 --- a/internal/command/testdata/validate-invalid/multiple_resources/output.json +++ b/internal/command/testdata/validate-invalid/multiple_resources/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/output.json b/internal/command/testdata/validate-invalid/output.json index 663fe0153071..73254853932f 100644 --- a/internal/command/testdata/validate-invalid/output.json +++ b/internal/command/testdata/validate-invalid/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/outputs/output.json b/internal/command/testdata/validate-invalid/outputs/output.json index d05ed4b77173..f774b458be4c 100644 --- a/internal/command/testdata/validate-invalid/outputs/output.json +++ b/internal/command/testdata/validate-invalid/outputs/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 2, "warning_count": 0, diff --git a/internal/command/testdata/validate-valid/output.json b/internal/command/testdata/validate-valid/output.json index c2a57c5e6a98..40258a98cd27 100644 --- a/internal/command/testdata/validate-valid/output.json +++ b/internal/command/testdata/validate-valid/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": true, "error_count": 0, "warning_count": 0, diff --git a/internal/command/views/validate.go b/internal/command/views/validate.go index 1e597277a478..08ce913f82ce 100644 --- a/internal/command/views/validate.go +++ b/internal/command/views/validate.go @@ -81,7 +81,7 @@ func (v *ValidateJSON) Results(diags tfdiags.Diagnostics) int { // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. - const FormatVersion = "0.1" + const FormatVersion = "1.0" type Output struct { FormatVersion string `json:"format_version"` diff --git a/website/docs/cli/commands/providers/schema.html.md b/website/docs/cli/commands/providers/schema.html.md index e97e50f2305e..2a3dddc1338e 100644 --- a/website/docs/cli/commands/providers/schema.html.md +++ b/website/docs/cli/commands/providers/schema.html.md @@ -23,7 +23,18 @@ The list of available flags are: Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. --> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. +The output includes a `format_version` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). ## Format Summary @@ -41,7 +52,7 @@ The JSON output format consists of the following objects and sub-objects: ```javascript { - "format_version": "0.1", + "format_version": "1.0", // "provider_schemas" describes the provider schemas for all // providers throughout the configuration tree. diff --git a/website/docs/cli/commands/validate.html.md b/website/docs/cli/commands/validate.html.md index 583186e3d069..e81da01b27a4 100644 --- a/website/docs/cli/commands/validate.html.md +++ b/website/docs/cli/commands/validate.html.md @@ -57,11 +57,18 @@ to the JSON output setting. For that reason, external software consuming Terraform's output should be prepared to find data on stdout that _isn't_ valid JSON, which it should then treat as a generic error case. -**Note:** The output includes a `format_version` key, which currently has major -version zero to indicate that the format is experimental and subject to change. -A future version will assign a non-zero major version and make stronger -promises about compatibility. We do not anticipate any significant breaking -changes to the format before its first major version, however. +The output includes a `format_version` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). In the normal case, Terraform will print a JSON object to the standard output stream. The top-level JSON object will have the following properties: diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index 9a3efeff5d46..b5f8daab35c3 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -16,7 +16,18 @@ Since the format of plan files isn't suited for use with external tools (and lik Use `terraform show -json ` to generate a JSON representation of a plan or state file. See [the `terraform show` documentation](/docs/cli/commands/show.html) for more details. --> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. +The output includes a `format_version` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). ## Format Summary @@ -60,7 +71,7 @@ For ease of consumption by callers, the plan representation includes a partial r ```javascript { - "format_version": "0.2", + "format_version": "1.0", // "prior_state" is a representation of the state that the configuration is // being applied to, using the state representation described above. From 9e71da61eb683f461a339cb6244e5a02130a7f1f Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 1 Sep 2021 12:54:48 -0500 Subject: [PATCH 032/644] Remove several ignore rules The main purpose of this change is to avoid a problem where new golden files added to certain directories for test purposes (like .log) shouldn't be ignored. Cleaning up a bit more and broadening the definition, this removes ignore rules for artifacts of Terraform itself (state files, plans). It's generally not recommended to be using this codebase as your Terraform working directory anyway; build here, test elsewhere. --- .gitignore | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/.gitignore b/.gitignore index 92764de852e3..e4881f29a717 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,6 @@ *.dll *.exe .DS_Store -example.tf -terraform.tfplan -terraform.tfstate bin/ modules-dev/ /pkg/ @@ -13,9 +10,6 @@ website/build website/node_modules .vagrant/ *.backup -./*.tfstate -.terraform/ -*.log *.bak *~ .*.swp @@ -27,9 +21,5 @@ website/node_modules website/vendor vendor/ -# Test exclusions -!command/testdata/**/*.tfstate -!command/testdata/**/.terraform/ - # Coverage coverage.txt From fa4c590f515a9a5ae40d9122b325a803be975f0c Mon Sep 17 00:00:00 2001 From: Yves Peter Date: Fri, 3 Sep 2021 08:23:17 +0200 Subject: [PATCH 033/644] Apply suggestions from code review Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/language/meta-arguments/lifecycle.html.md | 3 +-- website/docs/language/resources/provisioners/syntax.html.md | 6 ++---- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/website/docs/language/meta-arguments/lifecycle.html.md b/website/docs/language/meta-arguments/lifecycle.html.md index afa726cee081..9dec5a5cc8d8 100644 --- a/website/docs/language/meta-arguments/lifecycle.html.md +++ b/website/docs/language/meta-arguments/lifecycle.html.md @@ -46,8 +46,7 @@ The following arguments can be used within a `lifecycle` block: type before using `create_before_destroy` with it. Destroy provisioners of this resource will not run if `create_before_destroy` - is used. This limitation may be addressed in the future, see - [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) for details. + is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. * `prevent_destroy` (bool) - This meta-argument, when set to `true`, will cause Terraform to reject with an error any plan that would destroy the diff --git a/website/docs/language/resources/provisioners/syntax.html.md b/website/docs/language/resources/provisioners/syntax.html.md index 171f3fe13cdb..9bbb75979695 100644 --- a/website/docs/language/resources/provisioners/syntax.html.md +++ b/website/docs/language/resources/provisioners/syntax.html.md @@ -237,10 +237,8 @@ fail, Terraform will error and rerun the provisioners again on the next `terraform apply`. Due to this behavior, care should be taken for destroy provisioners to be safe to run multiple times. -Destroy provisioners will not run if the lifecycle Meta-Argument -[`create_before_destroy`](/docs/language/meta-arguments/lifecycle.html) is used -in the resource. This limitation may be addressed in the future, see -[GitHub issue](https://github.com/hashicorp/terraform/issues/13549) for details. + Destroy provisioners of this resource will not run if `create_before_destroy` + is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. Destroy-time provisioners can only run if they remain in the configuration at the time a resource is destroyed. If a resource block with a destroy-time From e3b6c6403c3057f5be12046740556fd3b1dc0363 Mon Sep 17 00:00:00 2001 From: drewmullen Date: Thu, 2 Sep 2021 08:29:43 -0400 Subject: [PATCH 034/644] include sha example and git docs --- website/docs/language/modules/sources.html.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/website/docs/language/modules/sources.html.md b/website/docs/language/modules/sources.html.md index aa637aa1186b..b9db802faf3e 100644 --- a/website/docs/language/modules/sources.html.md +++ b/website/docs/language/modules/sources.html.md @@ -237,16 +237,20 @@ only SSH key authentication is supported, and By default, Terraform will clone and use the default branch (referenced by `HEAD`) in the selected repository. You can override this using the -`ref` argument: +`ref` argument. The value of the `ref` argument can be any reference that would be accepted +by the `git checkout` command, such as branch, SHA-1 hash (short or full), or tag names. The [Git documentation](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#_single_revisions) contains a complete list. ```hcl +# referencing a specific release module "vpc" { source = "git::https://example.com/vpc.git?ref=v1.2.0" } -``` -The value of the `ref` argument can be any reference that would be accepted -by the `git checkout` command, including branch and tag names. +# referencing a specific commit SHA-1 hash +module "storage" { + source = "git::https://example.com/storage.git?ref=51d462976d84fdea54b47d80dcabbf680badcdb8" +} +``` ### "scp-like" address syntax From 06956773dc6611e59364883fdce8be7f0d5e7a50 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 3 Sep 2021 11:58:15 -0400 Subject: [PATCH 035/644] configs: Disable experiment warnings at link time This package level variable can be overridden at link time to allow temporarily disabling the UI warning when experimental features are enabled. This makes it easier to understand how UI will render when the feature is no longer experimental. This change is only for those developing Terraform. --- internal/configs/experiments.go | 34 ++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/internal/configs/experiments.go b/internal/configs/experiments.go index d6f200079e6e..8a7e7cb667d1 100644 --- a/internal/configs/experiments.go +++ b/internal/configs/experiments.go @@ -9,6 +9,16 @@ import ( "github.com/zclconf/go-cty/cty" ) +// When developing UI for experimental features, you can temporarily disable +// the experiment warning by setting this package-level variable to a non-empty +// value using a link-time flag: +// +// go install -ldflags="-X 'github.com/hashicorp/terraform/internal/configs.disableExperimentWarnings=yes'" +// +// This functionality is for development purposes only and is not a feature we +// are committing to supporting for end users. +var disableExperimentWarnings = "" + // sniffActiveExperiments does minimal parsing of the given body for // "terraform" blocks with "experiments" attributes, returning the // experiments found. @@ -126,17 +136,19 @@ func decodeExperimentsAttr(attr *hcl.Attribute) (experiments.Set, hcl.Diagnostic // No error at all means it's valid and current. ret.Add(exp) - // However, experimental features are subject to breaking changes - // in future releases, so we'll warn about them to help make sure - // folks aren't inadvertently using them in places where that'd be - // inappropriate, particularly if the experiment is active in a - // shared module they depend on. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagWarning, - Summary: fmt.Sprintf("Experimental feature %q is active", exp.Keyword()), - Detail: "Experimental features are subject to breaking changes in future minor or patch releases, based on feedback.\n\nIf you have feedback on the design of this feature, please open a GitHub issue to discuss it.", - Subject: expr.Range().Ptr(), - }) + if disableExperimentWarnings == "" { + // However, experimental features are subject to breaking changes + // in future releases, so we'll warn about them to help make sure + // folks aren't inadvertently using them in places where that'd be + // inappropriate, particularly if the experiment is active in a + // shared module they depend on. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagWarning, + Summary: fmt.Sprintf("Experimental feature %q is active", exp.Keyword()), + Detail: "Experimental features are subject to breaking changes in future minor or patch releases, based on feedback.\n\nIf you have feedback on the design of this feature, please open a GitHub issue to discuss it.", + Subject: expr.Range().Ptr(), + }) + } default: // This should never happen, because GetCurrent is not documented From ac2a870ea018f4721dd67ed7cb4e624ee8ab78b3 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 3 Sep 2021 13:53:52 -0400 Subject: [PATCH 036/644] allow json output to marshal ConfigModeAttr blocks In order to marshal config blocks using ConfigModeAttr, we need to insert the fixup body to map hcl blocks to the attribute in the schema. --- internal/command/jsonconfig/expression.go | 4 +++ .../command/jsonconfig/expression_test.go | 28 +++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/internal/command/jsonconfig/expression.go b/internal/command/jsonconfig/expression.go index 0244d73d0b36..fa443fc3ea50 100644 --- a/internal/command/jsonconfig/expression.go +++ b/internal/command/jsonconfig/expression.go @@ -10,6 +10,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/lang" + "github.com/hashicorp/terraform/internal/lang/blocktoattr" "github.com/zclconf/go-cty/cty" ctyjson "github.com/zclconf/go-cty/cty/json" ) @@ -96,6 +97,9 @@ func marshalExpressions(body hcl.Body, schema *configschema.Block) expressions { // (lowSchema is an hcl.BodySchema: // https://godoc.org/github.com/hashicorp/hcl/v2/hcl#BodySchema ) + // fix any ConfigModeAttr blocks present from legacy providers + body = blocktoattr.FixUpBlockAttrs(body, schema) + // Use the low-level schema with the body to decode one level We'll just // ignore any additional content that's not covered by the schema, which // will effectively ignore "dynamic" blocks, and may also ignore other diff --git a/internal/command/jsonconfig/expression_test.go b/internal/command/jsonconfig/expression_test.go index 971fb78d4d31..58af11dda53e 100644 --- a/internal/command/jsonconfig/expression_test.go +++ b/internal/command/jsonconfig/expression_test.go @@ -80,6 +80,29 @@ func TestMarshalExpressions(t *testing.T) { }, }, }, + { + hcltest.MockBody(&hcl.BodyContent{ + Blocks: hcl.Blocks{ + { + Type: "block_to_attr", + Body: hcltest.MockBody(&hcl.BodyContent{ + + Attributes: hcl.Attributes{ + "foo": { + Name: "foo", + Expr: hcltest.MockExprTraversalSrc(`module.foo.bar`), + }, + }, + }), + }, + }, + }), + expressions{ + "block_to_attr": expression{ + References: []string{"module.foo.bar", "module.foo"}, + }, + }, + }, } for _, test := range tests { @@ -89,6 +112,11 @@ func TestMarshalExpressions(t *testing.T) { Type: cty.String, Optional: true, }, + "block_to_attr": { + Type: cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + }, }, } From 29999c1d6f0bc58b4d8ce550a33046ce834370fb Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 3 Sep 2021 12:10:16 -0400 Subject: [PATCH 037/644] command: Render "moved" annotations in plan UI For resources which are planned to move, render the previous run address as additional information in the plan UI. For the case of a move-only resource (which otherwise is unchanged), we also render that as a planned change, but without any corresponding action symbol. If all changes in the plan are moves without changes, the plan is no longer considered "empty". In this case, we skip rendering the action symbols in the UI. --- internal/command/format/diff.go | 16 +++- internal/command/format/diff_test.go | 96 ++++++++++++++++++++-- internal/command/views/plan.go | 20 +++-- internal/command/views/plan_test.go | 13 +-- internal/plans/changes.go | 2 +- internal/plans/changes_src.go | 4 + internal/plans/changes_test.go | 117 +++++++++++++++++++++++++++ 7 files changed, 248 insertions(+), 20 deletions(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index 982b95980bf5..e111485e0268 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -72,13 +72,27 @@ func ResourceChange( // Some extra context about this unusual situation. buf.WriteString(color.Color("\n # (left over from a partially-failed replacement of this instance)")) } + case plans.NoOp: + if change.Moved() { + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has moved to [bold]%s[reset]", change.PrevRunAddr.String(), dispAddr))) + break + } + fallthrough default: // should never happen, since the above is exhaustive buf.WriteString(fmt.Sprintf("%s has an action the plan renderer doesn't support (this is a bug)", dispAddr)) } buf.WriteString(color.Color("[reset]\n")) - buf.WriteString(color.Color(DiffActionSymbol(change.Action)) + " ") + if change.Moved() && change.Action != plans.NoOp { + buf.WriteString(color.Color(fmt.Sprintf("[bold] # [reset]([bold]%s[reset] has moved to [bold]%s[reset])\n", change.PrevRunAddr.String(), dispAddr))) + } + + if change.Moved() && change.Action == plans.NoOp { + buf.WriteString(" ") + } else { + buf.WriteString(color.Color(DiffActionSymbol(change.Action)) + " ") + } switch addr.Resource.Resource.Mode { case addrs.ManagedResourceMode: diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index 31cb62d7d7c5..7ca289c79ad5 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -4448,6 +4448,79 @@ func TestResourceChange_sensitiveVariable(t *testing.T) { runTestCases(t, testCases) } +func TestResourceChange_moved(t *testing.T) { + prevRunAddr := addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_instance", + Name: "previous", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + + testCases := map[string]testCase{ + "moved and updated": { + PrevRunAddr: prevRunAddr, + Action: plans.Update, + Mode: addrs.ManagedResourceMode, + Before: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("12345"), + "foo": cty.StringVal("hello"), + "bar": cty.StringVal("baz"), + }), + After: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("12345"), + "foo": cty.StringVal("hello"), + "bar": cty.StringVal("boop"), + }), + Schema: &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "id": {Type: cty.String, Computed: true}, + "foo": {Type: cty.String, Optional: true}, + "bar": {Type: cty.String, Optional: true}, + }, + }, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example will be updated in-place + # (test_instance.previous has moved to test_instance.example) + ~ resource "test_instance" "example" { + ~ bar = "baz" -> "boop" + id = "12345" + # (1 unchanged attribute hidden) + } +`, + }, + "moved without changes": { + PrevRunAddr: prevRunAddr, + Action: plans.NoOp, + Mode: addrs.ManagedResourceMode, + Before: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("12345"), + "foo": cty.StringVal("hello"), + "bar": cty.StringVal("baz"), + }), + After: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("12345"), + "foo": cty.StringVal("hello"), + "bar": cty.StringVal("baz"), + }), + Schema: &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "id": {Type: cty.String, Computed: true}, + "foo": {Type: cty.String, Optional: true}, + "bar": {Type: cty.String, Optional: true}, + }, + }, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.previous has moved to test_instance.example + resource "test_instance" "example" { + id = "12345" + # (2 unchanged attributes hidden) + } +`, + }, + } + + runTestCases(t, testCases) +} + type testCase struct { Action plans.Action ActionReason plans.ResourceInstanceChangeActionReason @@ -4460,6 +4533,7 @@ type testCase struct { Schema *configschema.Block RequiredReplace cty.PathSet ExpectedOutput string + PrevRunAddr addrs.AbsResourceInstance } func runTestCases(t *testing.T, testCases map[string]testCase) { @@ -4493,13 +4567,23 @@ func runTestCases(t *testing.T, testCases map[string]testCase) { t.Fatal(err) } + addr := addrs.Resource{ + Mode: tc.Mode, + Type: "test_instance", + Name: "example", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + + prevRunAddr := tc.PrevRunAddr + // If no previous run address is given, reuse the current address + // to make initialization easier + if prevRunAddr.Resource.Resource.Type == "" { + prevRunAddr = addr + } + change := &plans.ResourceInstanceChangeSrc{ - Addr: addrs.Resource{ - Mode: tc.Mode, - Type: "test_instance", - Name: "example", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - DeposedKey: tc.DeposedKey, + Addr: addr, + PrevRunAddr: prevRunAddr, + DeposedKey: tc.DeposedKey, ProviderAddr: addrs.AbsProviderConfig{ Provider: addrs.NewDefaultProvider("test"), Module: addrs.RootModule, diff --git a/internal/command/views/plan.go b/internal/command/views/plan.go index 5d1798d2fbd2..ff794933b420 100644 --- a/internal/command/views/plan.go +++ b/internal/command/views/plan.go @@ -116,7 +116,7 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { counts := map[plans.Action]int{} var rChanges []*plans.ResourceInstanceChangeSrc for _, change := range plan.Changes.Resources { - if change.Action == plans.NoOp { + if change.Action == plans.NoOp && !change.Moved() { continue // We don't show anything for no-op changes } if change.Action == plans.Delete && change.Addr.Resource.Resource.Mode == addrs.DataResourceMode { @@ -125,7 +125,11 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { } rChanges = append(rChanges, change) - counts[change.Action]++ + + // Don't count move-only changes + if change.Action != plans.NoOp { + counts[change.Action]++ + } } var changedRootModuleOutputs []*plans.OutputChangeSrc for _, output := range plan.Changes.Outputs { @@ -138,7 +142,7 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { changedRootModuleOutputs = append(changedRootModuleOutputs, output) } - if len(counts) == 0 && len(changedRootModuleOutputs) == 0 { + if len(rChanges) == 0 && len(changedRootModuleOutputs) == 0 { // If we didn't find any changes to report at all then this is a // "No changes" plan. How we'll present this depends on whether // the plan is "applyable" and, if so, whether it had refresh changes @@ -225,7 +229,7 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { view.streams.Println("") } - if len(counts) != 0 { + if len(counts) > 0 { headerBuf := &bytes.Buffer{} fmt.Fprintf(headerBuf, "\n%s\n", strings.TrimSpace(format.WordWrap(planHeaderIntro, view.outputColumns()))) if counts[plans.Create] > 0 { @@ -247,9 +251,11 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { fmt.Fprintf(headerBuf, "%s read (data resources)\n", format.DiffActionSymbol(plans.Read)) } - view.streams.Println(view.colorize.Color(headerBuf.String())) + view.streams.Print(view.colorize.Color(headerBuf.String())) + } - view.streams.Printf("Terraform will perform the following actions:\n\n") + if len(rChanges) > 0 { + view.streams.Printf("\nTerraform will perform the following actions:\n\n") // Note: we're modifying the backing slice of this plan object in-place // here. The ordering of resource changes in a plan is not significant, @@ -265,7 +271,7 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { }) for _, rcs := range rChanges { - if rcs.Action == plans.NoOp { + if rcs.Action == plans.NoOp && !rcs.Moved() { continue } diff --git a/internal/command/views/plan_test.go b/internal/command/views/plan_test.go index 13cd3c4c3f03..757c7162ddee 100644 --- a/internal/command/views/plan_test.go +++ b/internal/command/views/plan_test.go @@ -63,12 +63,15 @@ func testPlan(t *testing.T) *plans.Plan { } changes := plans.NewChanges() + addr := addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + changes.SyncWrapper().AppendResourceInstanceChange(&plans.ResourceInstanceChangeSrc{ - Addr: addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "foo", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + Addr: addr, + PrevRunAddr: addr, ProviderAddr: addrs.AbsProviderConfig{ Provider: addrs.NewDefaultProvider("test"), Module: addrs.RootModule, diff --git a/internal/plans/changes.go b/internal/plans/changes.go index ba06244cb92c..c9aa38fd3863 100644 --- a/internal/plans/changes.go +++ b/internal/plans/changes.go @@ -33,7 +33,7 @@ func NewChanges() *Changes { func (c *Changes) Empty() bool { for _, res := range c.Resources { - if res.Action != NoOp { + if res.Action != NoOp || res.Moved() { return false } } diff --git a/internal/plans/changes_src.go b/internal/plans/changes_src.go index 69330a21d897..396493956771 100644 --- a/internal/plans/changes_src.go +++ b/internal/plans/changes_src.go @@ -125,6 +125,10 @@ func (rcs *ResourceInstanceChangeSrc) DeepCopy() *ResourceInstanceChangeSrc { return &ret } +func (rcs *ResourceInstanceChangeSrc) Moved() bool { + return !rcs.Addr.Equal(rcs.PrevRunAddr) +} + // OutputChangeSrc describes a change to an output value. type OutputChangeSrc struct { // Addr is the absolute address of the output value that the change diff --git a/internal/plans/changes_test.go b/internal/plans/changes_test.go index 16062429b853..5dbe10f08a93 100644 --- a/internal/plans/changes_test.go +++ b/internal/plans/changes_test.go @@ -4,10 +4,127 @@ import ( "fmt" "testing" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/lang/marks" "github.com/zclconf/go-cty/cty" ) +func TestChangesEmpty(t *testing.T) { + testCases := map[string]struct { + changes *Changes + want bool + }{ + "no changes": { + &Changes{}, + true, + }, + "resource change": { + &Changes{ + Resources: []*ResourceInstanceChangeSrc{ + { + Addr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + ChangeSrc: ChangeSrc{ + Action: Update, + }, + }, + }, + }, + false, + }, + "resource change with no-op action": { + &Changes{ + Resources: []*ResourceInstanceChangeSrc{ + { + Addr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + ChangeSrc: ChangeSrc{ + Action: NoOp, + }, + }, + }, + }, + true, + }, + "resource moved with no-op change": { + &Changes{ + Resources: []*ResourceInstanceChangeSrc{ + { + Addr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "toot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + ChangeSrc: ChangeSrc{ + Action: NoOp, + }, + }, + }, + }, + false, + }, + "output change": { + &Changes{ + Outputs: []*OutputChangeSrc{ + { + Addr: addrs.OutputValue{ + Name: "result", + }.Absolute(addrs.RootModuleInstance), + ChangeSrc: ChangeSrc{ + Action: Update, + }, + }, + }, + }, + false, + }, + "output change no-op": { + &Changes{ + Outputs: []*OutputChangeSrc{ + { + Addr: addrs.OutputValue{ + Name: "result", + }.Absolute(addrs.RootModuleInstance), + ChangeSrc: ChangeSrc{ + Action: NoOp, + }, + }, + }, + }, + true, + }, + } + + for name, tc := range testCases { + t.Run(name, func(t *testing.T) { + if got, want := tc.changes.Empty(), tc.want; got != want { + t.Fatalf("unexpected result: got %v, want %v", got, want) + } + }) + } +} + func TestChangeEncodeSensitive(t *testing.T) { testVals := []cty.Value{ cty.ObjectVal(map[string]cty.Value{ From 5e8806f397eacab529beb22536b5242a4c68eeaf Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 7 Sep 2021 11:34:25 -0400 Subject: [PATCH 038/644] update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2d74909b05d7..41523b54e837 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ ENHANCEMENTS: BUG FIXES: * core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) +* cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output [GH-29522] ## Previous Releases From ad634f60a5acbaade1eb8c225564e17ad2267f00 Mon Sep 17 00:00:00 2001 From: Paul Hinze Date: Tue, 7 Sep 2021 21:04:13 -0500 Subject: [PATCH 039/644] Add clarification to message about community PR review --- .github/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3080a1d3bea8..6a22f15cf285 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,6 +6,8 @@ This repository contains only Terraform core, which includes the command line in **Note:** Due to current low staffing on the Terraform Core team at HashiCorp, **we are not routinely reviewing and merging community-submitted pull requests**. We do hope to begin processing them again soon once we're back up to full staffing again, but for the moment we need to ask for patience. Thanks! +**Additional note:** The intent of the prior comment was to provide clarity for the community around what to expect for a small part of the work related to Terraform. This does not affect other PR reviews, such as those for Terraform providers. We expect that the relevant team will be appropriately staffed within the coming weeks, which should allow us to get back to normal community PR review practices. For the broader context and information on HashiCorp’s continued commitment to and investment in Terraform, see [this blog post](https://www.hashicorp.com/blog/terraform-community-contributions). + --- **All communication on GitHub, the community forum, and other HashiCorp-provided communication channels is subject to [the HashiCorp community guidelines](https://www.hashicorp.com/community-guidelines).** From cb5b1592281d264b5326069677738115a70e3357 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 8 Sep 2021 10:44:46 -0400 Subject: [PATCH 040/644] Update terraform_remote_state data source docs: (#29534) * Add docs for tfe_outputs data source * Add docs for Terraform Cloud usage --- website/docs/language/state/remote-state-data.html.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/website/docs/language/state/remote-state-data.html.md b/website/docs/language/state/remote-state-data.html.md index 717d8fb30804..10e51460068a 100644 --- a/website/docs/language/state/remote-state-data.html.md +++ b/website/docs/language/state/remote-state-data.html.md @@ -48,6 +48,7 @@ limited to) the following: | Google Cloud DNS
(for IP addresses and hostnames) | [`google_dns_record_set` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/dns_record_set) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | | Google Cloud Storage | [`google_storage_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket_object) | [`google_storage_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/storage_bucket_object) and [`http` data source](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | | HashiCorp Consul | [`consul_key_prefix` resource type](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/key_prefix) | [`consul_key_prefix` data source](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key_prefix) | +| HashiCorp Terraform Cloud | Normal `outputs` terraform block | [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) | | Kubernetes | [`kubernetes_config_map` resource type](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | [`kubernetes_config_map` data source](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/config_map) | | OCI Object Storage | [`oci_objectstorage_bucket` resource type](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/objectstorage_object) | [`oci_objectstorage_bucket` data source](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/objectstorage_object) | @@ -94,6 +95,12 @@ post-processing such as JSON decoding. You can then change that module later if you switch to a different strategy for sharing data between multiple Terraform configurations. +## Usage with Terraform Cloud/Enterprise + +When trying to access remote state outputs in Terraform Cloud/Enterprise, it is recommended to use the `tfe_outputs` data source in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) instead of relying the `terraform_remote_state` data source. + +See the [full documentation](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) for the `tfe_outputs` data source for more details. + ## Example Usage (`remote` Backend) ```hcl From 4a0b8d1e099c7cde1bdc68f3693f4034022ebd4b Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 8 Sep 2021 19:05:57 +0000 Subject: [PATCH 041/644] Release v1.1.0-alpha20210908 --- CHANGELOG.md | 2 +- version/version.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41523b54e837..809e5795bfc3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,7 +17,7 @@ ENHANCEMENTS: BUG FIXES: * core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) -* cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output [GH-29522] +* cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) ## Previous Releases diff --git a/version/version.go b/version/version.go index 86f22153dde3..6521dfbcce39 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "dev" +var Prerelease = "alpha20210908" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From 1cd6c9fae21ecdb6f84e190c50b42c640871ef76 Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 8 Sep 2021 19:21:43 +0000 Subject: [PATCH 042/644] Cleanup after v1.1.0-alpha20210908 release --- version/version.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version/version.go b/version/version.go index 6521dfbcce39..86f22153dde3 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "alpha20210908" +var Prerelease = "dev" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From cd29c3e5fdd4791362ac8a06906bdf987ea3b355 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 9 Sep 2021 11:25:35 -0400 Subject: [PATCH 043/644] Revert "json-output: Release format version 1.0" --- internal/command/jsonplan/plan.go | 2 +- internal/command/jsonprovider/provider.go | 2 +- internal/command/jsonstate/state.go | 2 +- .../testdata/providers-schema/basic/output.json | 2 +- .../testdata/providers-schema/empty/output.json | 4 ++-- .../providers-schema/required/output.json | 2 +- .../testdata/show-json-sensitive/output.json | 4 ++-- .../testdata/show-json-state/basic/output.json | 2 +- .../testdata/show-json-state/empty/output.json | 4 ++-- .../show-json-state/modules/output.json | 2 +- .../sensitive-variables/output.json | 2 +- .../testdata/show-json/basic-create/output.json | 4 ++-- .../testdata/show-json/basic-delete/output.json | 4 ++-- .../testdata/show-json/basic-update/output.json | 4 ++-- .../testdata/show-json/drift/output.json | 4 ++-- .../show-json/module-depends-on/output.json | 2 +- .../testdata/show-json/modules/output.json | 4 ++-- .../show-json/multi-resource-update/output.json | 4 ++-- .../show-json/nested-modules/output.json | 2 +- .../provider-version-no-config/output.json | 4 ++-- .../show-json/provider-version/output.json | 4 ++-- .../show-json/requires-replace/output.json | 4 ++-- .../show-json/sensitive-values/output.json | 4 ++-- .../incorrectmodulename/output.json | 2 +- .../validate-invalid/interpolation/output.json | 2 +- .../missing_defined_var/output.json | 2 +- .../validate-invalid/missing_quote/output.json | 2 +- .../validate-invalid/missing_var/output.json | 2 +- .../multiple_modules/output.json | 2 +- .../multiple_providers/output.json | 2 +- .../multiple_resources/output.json | 2 +- .../testdata/validate-invalid/output.json | 2 +- .../validate-invalid/outputs/output.json | 2 +- .../command/testdata/validate-valid/output.json | 2 +- internal/command/views/validate.go | 2 +- .../docs/cli/commands/providers/schema.html.md | 15 ++------------- website/docs/cli/commands/validate.html.md | 17 +++++------------ website/docs/internals/json-format.html.md | 15 ++------------- 38 files changed, 57 insertions(+), 86 deletions(-) diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index b1d488156fcf..1b90daf2d092 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -22,7 +22,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "1.0" +const FormatVersion = "0.2" // Plan is the top-level representation of the json format of a plan. It includes // the complete config and current state. diff --git a/internal/command/jsonprovider/provider.go b/internal/command/jsonprovider/provider.go index 4487db4987ae..b507bc242e9e 100644 --- a/internal/command/jsonprovider/provider.go +++ b/internal/command/jsonprovider/provider.go @@ -9,7 +9,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "1.0" +const FormatVersion = "0.2" // providers is the top-level object returned when exporting provider schemas type providers struct { diff --git a/internal/command/jsonstate/state.go b/internal/command/jsonstate/state.go index 46532875c334..341040d2d1c9 100644 --- a/internal/command/jsonstate/state.go +++ b/internal/command/jsonstate/state.go @@ -18,7 +18,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "1.0" +const FormatVersion = "0.2" // state is the top-level representation of the json format of a terraform // state. diff --git a/internal/command/testdata/providers-schema/basic/output.json b/internal/command/testdata/providers-schema/basic/output.json index dfac55b38c35..f14786c3e31e 100644 --- a/internal/command/testdata/providers-schema/basic/output.json +++ b/internal/command/testdata/providers-schema/basic/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "provider_schemas": { "registry.terraform.io/hashicorp/test": { "provider": { diff --git a/internal/command/testdata/providers-schema/empty/output.json b/internal/command/testdata/providers-schema/empty/output.json index 381450cade5c..12d30d201356 100644 --- a/internal/command/testdata/providers-schema/empty/output.json +++ b/internal/command/testdata/providers-schema/empty/output.json @@ -1,3 +1,3 @@ { - "format_version": "1.0" -} + "format_version": "0.2" +} \ No newline at end of file diff --git a/internal/command/testdata/providers-schema/required/output.json b/internal/command/testdata/providers-schema/required/output.json index dfac55b38c35..f14786c3e31e 100644 --- a/internal/command/testdata/providers-schema/required/output.json +++ b/internal/command/testdata/providers-schema/required/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "provider_schemas": { "registry.terraform.io/hashicorp/test": { "provider": { diff --git a/internal/command/testdata/show-json-sensitive/output.json b/internal/command/testdata/show-json-sensitive/output.json index 206fbb7f6e60..5f22c4ccf3a2 100644 --- a/internal/command/testdata/show-json-sensitive/output.json +++ b/internal/command/testdata/show-json-sensitive/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "bar" @@ -66,7 +66,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json-state/basic/output.json b/internal/command/testdata/show-json-state/basic/output.json index 229fa00e7262..3087ad118050 100644 --- a/internal/command/testdata/show-json-state/basic/output.json +++ b/internal/command/testdata/show-json-state/basic/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "terraform_version": "0.12.0", "values": { "root_module": { diff --git a/internal/command/testdata/show-json-state/empty/output.json b/internal/command/testdata/show-json-state/empty/output.json index 381450cade5c..12d30d201356 100644 --- a/internal/command/testdata/show-json-state/empty/output.json +++ b/internal/command/testdata/show-json-state/empty/output.json @@ -1,3 +1,3 @@ { - "format_version": "1.0" -} + "format_version": "0.2" +} \ No newline at end of file diff --git a/internal/command/testdata/show-json-state/modules/output.json b/internal/command/testdata/show-json-state/modules/output.json index eba163bdbb52..eeee8f6cffbc 100644 --- a/internal/command/testdata/show-json-state/modules/output.json +++ b/internal/command/testdata/show-json-state/modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "terraform_version": "0.12.0", "values": { "outputs": { diff --git a/internal/command/testdata/show-json-state/sensitive-variables/output.json b/internal/command/testdata/show-json-state/sensitive-variables/output.json index 60503cd3ad80..b133aeef13bf 100644 --- a/internal/command/testdata/show-json-state/sensitive-variables/output.json +++ b/internal/command/testdata/show-json-state/sensitive-variables/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "terraform_version": "0.14.0", "values": { "root_module": { diff --git a/internal/command/testdata/show-json/basic-create/output.json b/internal/command/testdata/show-json/basic-create/output.json index d1b8aae5361b..3474443ed386 100644 --- a/internal/command/testdata/show-json/basic-create/output.json +++ b/internal/command/testdata/show-json/basic-create/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-delete/output.json b/internal/command/testdata/show-json/basic-delete/output.json index 8a0018cd5bff..9ebea2058f78 100644 --- a/internal/command/testdata/show-json/basic-delete/output.json +++ b/internal/command/testdata/show-json/basic-delete/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "bar" @@ -88,7 +88,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-update/output.json b/internal/command/testdata/show-json/basic-update/output.json index e4b4731426a1..2b8bc25e3034 100644 --- a/internal/command/testdata/show-json/basic-update/output.json +++ b/internal/command/testdata/show-json/basic-update/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "bar" @@ -68,7 +68,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/drift/output.json b/internal/command/testdata/show-json/drift/output.json index 55c9e3f71cd3..7badb45e5edd 100644 --- a/internal/command/testdata/show-json/drift/output.json +++ b/internal/command/testdata/show-json/drift/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "planned_values": { "root_module": { "resources": [ @@ -105,7 +105,7 @@ } ], "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/module-depends-on/output.json b/internal/command/testdata/show-json/module-depends-on/output.json index d02efaa22f0d..cc7ed679f0cc 100644 --- a/internal/command/testdata/show-json/module-depends-on/output.json +++ b/internal/command/testdata/show-json/module-depends-on/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "terraform_version": "0.13.1-dev", "planned_values": { "root_module": { diff --git a/internal/command/testdata/show-json/modules/output.json b/internal/command/testdata/show-json/modules/output.json index 4ed0ea45d692..440bebbff891 100644 --- a/internal/command/testdata/show-json/modules/output.json +++ b/internal/command/testdata/show-json/modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "planned_values": { "outputs": { "test": { @@ -74,7 +74,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index ba557de69c8c..d84bc5b08789 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "terraform_version": "0.13.0", "variables": { "test_var": { @@ -127,7 +127,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "terraform_version": "0.13.0", "values": { "outputs": { diff --git a/internal/command/testdata/show-json/nested-modules/output.json b/internal/command/testdata/show-json/nested-modules/output.json index 359ea9ae181c..80e7ae3588e9 100644 --- a/internal/command/testdata/show-json/nested-modules/output.json +++ b/internal/command/testdata/show-json/nested-modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "planned_values": { "root_module": { "child_modules": [ diff --git a/internal/command/testdata/show-json/provider-version-no-config/output.json b/internal/command/testdata/show-json/provider-version-no-config/output.json index 6a8b1f451dc0..64b93ec751c0 100644 --- a/internal/command/testdata/show-json/provider-version-no-config/output.json +++ b/internal/command/testdata/show-json/provider-version-no-config/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/provider-version/output.json b/internal/command/testdata/show-json/provider-version/output.json index 11fd3bd64c15..b5369806e933 100644 --- a/internal/command/testdata/show-json/provider-version/output.json +++ b/internal/command/testdata/show-json/provider-version/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/requires-replace/output.json b/internal/command/testdata/show-json/requires-replace/output.json index e71df784f4f7..077d900b13b0 100644 --- a/internal/command/testdata/show-json/requires-replace/output.json +++ b/internal/command/testdata/show-json/requires-replace/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "planned_values": { "root_module": { "resources": [ @@ -48,7 +48,7 @@ } ], "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/sensitive-values/output.json b/internal/command/testdata/show-json/sensitive-values/output.json index d7e4719c71f5..7cbc9ccf0e75 100644 --- a/internal/command/testdata/show-json/sensitive-values/output.json +++ b/internal/command/testdata/show-json/sensitive-values/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.2", "variables": { "test_var": { "value": "boop" @@ -69,7 +69,7 @@ } }, "prior_state": { - "format_version": "1.0", + "format_version": "0.2", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/validate-invalid/incorrectmodulename/output.json b/internal/command/testdata/validate-invalid/incorrectmodulename/output.json index f144313fa455..0c2ce68abd37 100644 --- a/internal/command/testdata/validate-invalid/incorrectmodulename/output.json +++ b/internal/command/testdata/validate-invalid/incorrectmodulename/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 4, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/interpolation/output.json b/internal/command/testdata/validate-invalid/interpolation/output.json index 2843b19121fc..7845ec0f4e81 100644 --- a/internal/command/testdata/validate-invalid/interpolation/output.json +++ b/internal/command/testdata/validate-invalid/interpolation/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 2, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_defined_var/output.json b/internal/command/testdata/validate-invalid/missing_defined_var/output.json index 40258a98cd27..c2a57c5e6a98 100644 --- a/internal/command/testdata/validate-invalid/missing_defined_var/output.json +++ b/internal/command/testdata/validate-invalid/missing_defined_var/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": true, "error_count": 0, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_quote/output.json b/internal/command/testdata/validate-invalid/missing_quote/output.json index 87aeca8b7817..cdf99d8b2a2b 100644 --- a/internal/command/testdata/validate-invalid/missing_quote/output.json +++ b/internal/command/testdata/validate-invalid/missing_quote/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_var/output.json b/internal/command/testdata/validate-invalid/missing_var/output.json index 6f0b9d5d4c8d..2a4e0be71ebd 100644 --- a/internal/command/testdata/validate-invalid/missing_var/output.json +++ b/internal/command/testdata/validate-invalid/missing_var/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_modules/output.json b/internal/command/testdata/validate-invalid/multiple_modules/output.json index 1aeaf929a913..4cd6dfb9f0ad 100644 --- a/internal/command/testdata/validate-invalid/multiple_modules/output.json +++ b/internal/command/testdata/validate-invalid/multiple_modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_providers/output.json b/internal/command/testdata/validate-invalid/multiple_providers/output.json index 309cf0ea7c34..63eb2d193820 100644 --- a/internal/command/testdata/validate-invalid/multiple_providers/output.json +++ b/internal/command/testdata/validate-invalid/multiple_providers/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_resources/output.json b/internal/command/testdata/validate-invalid/multiple_resources/output.json index ded584e6846c..33d5052284e9 100644 --- a/internal/command/testdata/validate-invalid/multiple_resources/output.json +++ b/internal/command/testdata/validate-invalid/multiple_resources/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/output.json b/internal/command/testdata/validate-invalid/output.json index 73254853932f..663fe0153071 100644 --- a/internal/command/testdata/validate-invalid/output.json +++ b/internal/command/testdata/validate-invalid/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/outputs/output.json b/internal/command/testdata/validate-invalid/outputs/output.json index f774b458be4c..d05ed4b77173 100644 --- a/internal/command/testdata/validate-invalid/outputs/output.json +++ b/internal/command/testdata/validate-invalid/outputs/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": false, "error_count": 2, "warning_count": 0, diff --git a/internal/command/testdata/validate-valid/output.json b/internal/command/testdata/validate-valid/output.json index 40258a98cd27..c2a57c5e6a98 100644 --- a/internal/command/testdata/validate-valid/output.json +++ b/internal/command/testdata/validate-valid/output.json @@ -1,5 +1,5 @@ { - "format_version": "1.0", + "format_version": "0.1", "valid": true, "error_count": 0, "warning_count": 0, diff --git a/internal/command/views/validate.go b/internal/command/views/validate.go index 08ce913f82ce..1e597277a478 100644 --- a/internal/command/views/validate.go +++ b/internal/command/views/validate.go @@ -81,7 +81,7 @@ func (v *ValidateJSON) Results(diags tfdiags.Diagnostics) int { // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. - const FormatVersion = "1.0" + const FormatVersion = "0.1" type Output struct { FormatVersion string `json:"format_version"` diff --git a/website/docs/cli/commands/providers/schema.html.md b/website/docs/cli/commands/providers/schema.html.md index 2a3dddc1338e..e97e50f2305e 100644 --- a/website/docs/cli/commands/providers/schema.html.md +++ b/website/docs/cli/commands/providers/schema.html.md @@ -23,18 +23,7 @@ The list of available flags are: Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. -The output includes a `format_version` key, which as of Terraform 1.1.0 has -value `"1.0"`. The semantics of this version are: - -- We will increment the minor version, e.g. `"1.1"`, for backward-compatible - changes or additions. Ignore any object properties with unrecognized names to - remain forward-compatible with future minor versions. -- We will increment the major version, e.g. `"2.0"`, for changes that are not - backward-compatible. Reject any input which reports an unsupported major - version. - -We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +-> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. ## Format Summary @@ -52,7 +41,7 @@ The JSON output format consists of the following objects and sub-objects: ```javascript { - "format_version": "1.0", + "format_version": "0.1", // "provider_schemas" describes the provider schemas for all // providers throughout the configuration tree. diff --git a/website/docs/cli/commands/validate.html.md b/website/docs/cli/commands/validate.html.md index e81da01b27a4..583186e3d069 100644 --- a/website/docs/cli/commands/validate.html.md +++ b/website/docs/cli/commands/validate.html.md @@ -57,18 +57,11 @@ to the JSON output setting. For that reason, external software consuming Terraform's output should be prepared to find data on stdout that _isn't_ valid JSON, which it should then treat as a generic error case. -The output includes a `format_version` key, which as of Terraform 1.1.0 has -value `"1.0"`. The semantics of this version are: - -- We will increment the minor version, e.g. `"1.1"`, for backward-compatible - changes or additions. Ignore any object properties with unrecognized names to - remain forward-compatible with future minor versions. -- We will increment the major version, e.g. `"2.0"`, for changes that are not - backward-compatible. Reject any input which reports an unsupported major - version. - -We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +**Note:** The output includes a `format_version` key, which currently has major +version zero to indicate that the format is experimental and subject to change. +A future version will assign a non-zero major version and make stronger +promises about compatibility. We do not anticipate any significant breaking +changes to the format before its first major version, however. In the normal case, Terraform will print a JSON object to the standard output stream. The top-level JSON object will have the following properties: diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index b5f8daab35c3..9a3efeff5d46 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -16,18 +16,7 @@ Since the format of plan files isn't suited for use with external tools (and lik Use `terraform show -json ` to generate a JSON representation of a plan or state file. See [the `terraform show` documentation](/docs/cli/commands/show.html) for more details. -The output includes a `format_version` key, which as of Terraform 1.1.0 has -value `"1.0"`. The semantics of this version are: - -- We will increment the minor version, e.g. `"1.1"`, for backward-compatible - changes or additions. Ignore any object properties with unrecognized names to - remain forward-compatible with future minor versions. -- We will increment the major version, e.g. `"2.0"`, for changes that are not - backward-compatible. Reject any input which reports an unsupported major - version. - -We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +-> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. ## Format Summary @@ -71,7 +60,7 @@ For ease of consumption by callers, the plan representation includes a partial r ```javascript { - "format_version": "1.0", + "format_version": "0.2", // "prior_state" is a representation of the state that the configuration is // being applied to, using the state representation described above. From 64a95fc29f679fba074866bfcd207a4f408c2476 Mon Sep 17 00:00:00 2001 From: Paddy Date: Thu, 9 Sep 2021 11:33:07 -0700 Subject: [PATCH 044/644] Add docs on how to release a new major protocol version. (#29552) Releasing a new major protocol version requires coordination between a few different projects and codebases, and it's easy to forget a step. This commit introduces a doc to keep track of these steps, making it less likely one will be omitted or forgotten. --- docs/plugin-protocol/releasing-new-version.md | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 docs/plugin-protocol/releasing-new-version.md diff --git a/docs/plugin-protocol/releasing-new-version.md b/docs/plugin-protocol/releasing-new-version.md new file mode 100644 index 000000000000..2449b5c3d604 --- /dev/null +++ b/docs/plugin-protocol/releasing-new-version.md @@ -0,0 +1,53 @@ +# Releasing a New Version of the Protocol + +Terraform's plugin protocol is the contract between Terraform's plugins and +Terraform, and as such releasing a new version requires some coordination +between those pieces. This document is intended to be a checklist to consult +when adding a new major version of the protocol (X in X.Y) to ensure that +everything that needs to be is aware of it. + +## New Protobuf File + +The protocol is defined in protobuf files that live in the hashicorp/terraform +repository. Adding a new version of the protocol involves creating a new +`.proto` file in that directory. It is recommended that you copy the latest +protocol file, and modify it accordingly. + +## New terraform-plugin-go Package + +The +[hashicorp/terraform-plugin-go](https://github.com/hashicorp/terraform-plugin-go) +repository serves as the foundation for Terraform's plugin ecosystem. It needs +to know about the new major protocol version. Either open an issue in that repo +to have the Plugin SDK team add the new package, or if you would like to +contribute it yourself, open a PR. It is recommended that you copy the package +for the latest protocol version and modify it accordingly. + +## Update the Registry's List of Allowed Versions + +The Terraform Registry validates the protocol versions a provider advertises +support for when ingesting providers. Providers will not be able to advertise +support for the new protocol version until it is added to that list. + +## Update Terraform's Version Constraints + +Terraform only downloads providers that speak protocol versions it is +compatible with from the Registry during `terraform init`. When adding support +for a new protocol, you need to tell Terraform it knows that protocol version. +Modify the `SupportedPluginProtocols` variable in hashicorp/terraform's +`internal/getproviders/registry_client.go` file to include the new protocol. + +## Test Running a Provider With the Test Framework + +Use the provider test framework to test a provider written with the new +protocol. This end-to-end test ensures that providers written with the new +protocol work correctly wtih the test framework, especially in communicating +the protocol version between the test framework and Terraform. + +## Test Retrieving and Running a Provider From the Registry + +Publish a provider, either to the public registry or to the staging registry, +and test running `terraform init` and `terraform apply`, along with exercising +any of the new functionality the protocol version introduces. This end-to-end +test ensures that all the pieces needing to be updated before practitioners can +use providers built with the new protocol have been updated. From 782132da33c45ff257d4cbe43e65be1f6fd0dbd2 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 10 Sep 2021 14:44:03 -0400 Subject: [PATCH 045/644] remove incorrect computed check The config is already validated, and does not need to be checked in AssertPlanValid. Add some more coverage for plan validation. --- internal/plans/objchange/plan_valid.go | 5 - internal/plans/objchange/plan_valid_test.go | 194 +++++++++++++++++++- 2 files changed, 185 insertions(+), 14 deletions(-) diff --git a/internal/plans/objchange/plan_valid.go b/internal/plans/objchange/plan_valid.go index 2706a6c52e60..4f35f53478f1 100644 --- a/internal/plans/objchange/plan_valid.go +++ b/internal/plans/objchange/plan_valid.go @@ -286,11 +286,6 @@ func assertPlannedValueValid(attrS *configschema.Attribute, priorV, configV, pla } return errs } - } else { - if attrS.Computed { - errs = append(errs, path.NewErrorf("configuration present for computed attribute")) - return errs - } } // If this attribute has a NestedType, validate the nested object diff --git a/internal/plans/objchange/plan_valid_test.go b/internal/plans/objchange/plan_valid_test.go index 834d1046356d..5c054cb907e6 100644 --- a/internal/plans/objchange/plan_valid_test.go +++ b/internal/plans/objchange/plan_valid_test.go @@ -1387,6 +1387,7 @@ func TestAssertPlanValid(t *testing.T) { }, }, }, + Optional: true, Computed: true, }, "single": { @@ -1423,9 +1424,11 @@ func TestAssertPlanValid(t *testing.T) { "list": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ "name": cty.String, }))), - "set": cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{ - "name": cty.String, - }))), + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), + }), "single": cty.NullVal(cty.Object(map[string]cty.Type{ "name": cty.String, })), @@ -1437,14 +1440,14 @@ func TestAssertPlanValid(t *testing.T) { })), }), "list": cty.ListVal([]cty.Value{ - cty.UnknownVal(cty.Object(map[string]cty.Type{ - "name": cty.String, - })), + cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("computed"), + }), }), "set": cty.SetVal([]cty.Value{ - cty.UnknownVal(cty.Object(map[string]cty.Type{ - "name": cty.String, - })), + cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), }), "single": cty.UnknownVal(cty.Object(map[string]cty.Type{ "name": cty.String, @@ -1452,6 +1455,179 @@ func TestAssertPlanValid(t *testing.T) { }), nil, }, + "optional computed within nested objects": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + // When an object has dynamic attrs, the map may be + // handled as an object. + "map_as_obj": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Optional: true, + Computed: true, + }, + }, + }, + }, + "list": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Optional: true, + Computed: true, + }, + }, + }, + }, + "set": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSet, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Optional: true, + Computed: true, + }, + }, + }, + }, + "single": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSingle, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.DynamicPseudoType, + Optional: true, + Computed: true, + }, + }, + }, + }, + }, + }, + cty.NullVal(cty.Object(map[string]cty.Type{ + "map": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "map_as_obj": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.DynamicPseudoType, + })), + "list": cty.List(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "set": cty.Set(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + "single": cty.Object(map[string]cty.Type{ + "name": cty.String, + }), + })), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), + }), + "map_as_obj": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.DynamicPseudoType), + }), + }), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "single": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), + }), + "map_as_obj": cty.ObjectVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("computed"), + }), + }), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("computed"), + }), + }), + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + }), + }), + "single": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), + }), + nil, + }, + "cannot replace config nested attr": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Computed: true, + Optional: true, + }, + }, + }, + }, + }, + }, + cty.NullVal(cty.Object(map[string]cty.Type{ + "map": cty.Map(cty.Object(map[string]cty.Type{ + "name": cty.String, + })), + })), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_config"), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("from_provider"), + }), + }), + }), + []string{`.map.one.name: planned value cty.StringVal("from_provider") does not match config value cty.StringVal("from_config")`}, + }, } for name, test := range tests { From feb219a9c44652eac0ad02ab9272d6246de1443c Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 09:37:29 -0700 Subject: [PATCH 046/644] core: Un-export the LoadSchemas function The public interface for loading schemas is Context.Schemas, which can take into account the context's records of which plugin versions and checksums we're expecting. loadSchemas is an implementation detail of that, representing the part we run only after we've verified all of the plugins. --- internal/terraform/context.go | 2 +- internal/terraform/schemas.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/terraform/context.go b/internal/terraform/context.go index abb20528a448..907b68762343 100644 --- a/internal/terraform/context.go +++ b/internal/terraform/context.go @@ -221,7 +221,7 @@ func (c *Context) Schemas(config *configs.Config, state *states.State) (*Schemas } } - ret, err := LoadSchemas(config, state, c.components) + ret, err := loadSchemas(config, state, c.components) if err != nil { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, diff --git a/internal/terraform/schemas.go b/internal/terraform/schemas.go index 8531d118486d..974cbb2eb441 100644 --- a/internal/terraform/schemas.go +++ b/internal/terraform/schemas.go @@ -64,7 +64,7 @@ func (ss *Schemas) ProvisionerConfig(name string) *configschema.Block { return ss.Provisioners[name] } -// LoadSchemas searches the given configuration, state and plan (any of which +// loadSchemas searches the given configuration, state and plan (any of which // may be nil) for constructs that have an associated schema, requests the // necessary schemas from the given component factory (which must _not_ be nil), // and returns a single object representing all of the necessary schemas. @@ -74,7 +74,7 @@ func (ss *Schemas) ProvisionerConfig(name string) *configschema.Block { // either misbehavior on the part of one of the providers or of the provider // protocol itself. When returned with errors, the returned schemas object is // still valid but may be incomplete. -func LoadSchemas(config *configs.Config, state *states.State, components contextComponentFactory) (*Schemas, error) { +func loadSchemas(config *configs.Config, state *states.State, components contextComponentFactory) (*Schemas, error) { schemas := &Schemas{ Providers: map[addrs.Provider]*ProviderSchema{}, Provisioners: map[string]*configschema.Block{}, From d51921f08557644bcb61acf3c46bbd78a3ea3c11 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 10:16:44 -0700 Subject: [PATCH 047/644] core: Provider transformers don't use the set of all available providers In earlier incarnations of these transformers we used the set of all available providers for tasks such as generating implied provider configuration nodes. However, in modern Terraform we can extract all of the information we need from the configuration itself, and so these transformers weren't actually using this set of provider addresses. These also ended up getting left behind as sets of string rather than sets of addrs.Provider in our earlier refactoring work, which didn't really matter because the result wasn't used anywhere anyway. Rather than updating these to use addrs.Provider instead, I've just removed the unused arguments entirely in the hope of making it easier to see what inputs these transformers use to make their decisions. --- internal/terraform/graph_builder_apply.go | 2 +- .../terraform/graph_builder_destroy_plan.go | 2 +- internal/terraform/graph_builder_eval.go | 2 +- internal/terraform/graph_builder_import.go | 2 +- internal/terraform/graph_builder_plan.go | 2 +- internal/terraform/transform_provider.go | 18 +++++--------- internal/terraform/transform_provider_test.go | 24 +++++++++---------- internal/terraform/transform_root_test.go | 4 +--- 8 files changed, 24 insertions(+), 32 deletions(-) diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go index 683353cf9801..bf213d1d0620 100644 --- a/internal/terraform/graph_builder_apply.go +++ b/internal/terraform/graph_builder_apply.go @@ -116,7 +116,7 @@ func (b *ApplyGraphBuilder) Steps() []GraphTransformer { &AttachResourceConfigTransformer{Config: b.Config}, // add providers - TransformProviders(b.Components.ResourceProviders(), concreteProvider, b.Config), + transformProviders(concreteProvider, b.Config), // Remove modules no longer present in the config &RemovedModuleTransformer{Config: b.Config, State: b.State}, diff --git a/internal/terraform/graph_builder_destroy_plan.go b/internal/terraform/graph_builder_destroy_plan.go index 9962442af834..1973237b4bea 100644 --- a/internal/terraform/graph_builder_destroy_plan.go +++ b/internal/terraform/graph_builder_destroy_plan.go @@ -94,7 +94,7 @@ func (b *DestroyPlanGraphBuilder) Steps() []GraphTransformer { // Attach the configuration to any resources &AttachResourceConfigTransformer{Config: b.Config}, - TransformProviders(b.Components.ResourceProviders(), concreteProvider, b.Config), + transformProviders(concreteProvider, b.Config), // Destruction ordering. We require this only so that // targeting below will prune the correct things. diff --git a/internal/terraform/graph_builder_eval.go b/internal/terraform/graph_builder_eval.go index 18b6d5199719..65e663550652 100644 --- a/internal/terraform/graph_builder_eval.go +++ b/internal/terraform/graph_builder_eval.go @@ -75,7 +75,7 @@ func (b *EvalGraphBuilder) Steps() []GraphTransformer { // Attach the state &AttachStateTransformer{State: b.State}, - TransformProviders(b.Components.ResourceProviders(), concreteProvider, b.Config), + transformProviders(concreteProvider, b.Config), // Must attach schemas before ReferenceTransformer so that we can // analyze the configuration to find references. diff --git a/internal/terraform/graph_builder_import.go b/internal/terraform/graph_builder_import.go index af5df1403052..bbef67713f22 100644 --- a/internal/terraform/graph_builder_import.go +++ b/internal/terraform/graph_builder_import.go @@ -67,7 +67,7 @@ func (b *ImportGraphBuilder) Steps() []GraphTransformer { // Add the import steps &ImportStateTransformer{Targets: b.ImportTargets, Config: b.Config}, - TransformProviders(b.Components.ResourceProviders(), concreteProvider, config), + transformProviders(concreteProvider, config), // Must attach schemas before ReferenceTransformer so that we can // analyze the configuration to find references. diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index 84884c3d4ea0..8d680162492e 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -130,7 +130,7 @@ func (b *PlanGraphBuilder) Steps() []GraphTransformer { &AttachResourceConfigTransformer{Config: b.Config}, // add providers - TransformProviders(b.Components.ResourceProviders(), b.ConcreteProvider, b.Config), + transformProviders(b.ConcreteProvider, b.Config), // Remove modules no longer present in the config &RemovedModuleTransformer{Config: b.Config, State: b.State}, diff --git a/internal/terraform/transform_provider.go b/internal/terraform/transform_provider.go index ee5087eafa75..3e459e7a7b11 100644 --- a/internal/terraform/transform_provider.go +++ b/internal/terraform/transform_provider.go @@ -11,19 +11,17 @@ import ( "github.com/hashicorp/terraform/internal/tfdiags" ) -func TransformProviders(providers []string, concrete ConcreteProviderNodeFunc, config *configs.Config) GraphTransformer { +func transformProviders(concrete ConcreteProviderNodeFunc, config *configs.Config) GraphTransformer { return GraphTransformMulti( // Add providers from the config &ProviderConfigTransformer{ - Config: config, - Providers: providers, - Concrete: concrete, + Config: config, + Concrete: concrete, }, // Add any remaining missing providers &MissingProviderTransformer{ - Config: config, - Providers: providers, - Concrete: concrete, + Config: config, + Concrete: concrete, }, // Connect the providers &ProviderTransformer{ @@ -298,9 +296,6 @@ func (t *CloseProviderTransformer) Transform(g *Graph) error { // PruneProviderTransformer can then remove these once ProviderTransformer // has resolved all of the inheritence, etc. type MissingProviderTransformer struct { - // Providers is the list of providers we support. - Providers []string - // MissingProviderTransformer needs the config to rule out _implied_ default providers Config *configs.Config @@ -478,8 +473,7 @@ func (n *graphNodeProxyProvider) Target() GraphNodeProvider { // ProviderConfigTransformer adds all provider nodes from the configuration and // attaches the configs. type ProviderConfigTransformer struct { - Providers []string - Concrete ConcreteProviderNodeFunc + Concrete ConcreteProviderNodeFunc // each provider node is stored here so that the proxy nodes can look up // their targets by name. diff --git a/internal/terraform/transform_provider_test.go b/internal/terraform/transform_provider_test.go index 596a3973549c..0436fc03248f 100644 --- a/internal/terraform/transform_provider_test.go +++ b/internal/terraform/transform_provider_test.go @@ -31,7 +31,7 @@ func TestProviderTransformer(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - transform := &MissingProviderTransformer{Providers: []string{"aws"}} + transform := &MissingProviderTransformer{} if err := transform.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -79,7 +79,7 @@ func TestProviderTransformer_ImportModuleChild(t *testing.T) { } { - tf := &MissingProviderTransformer{Providers: []string{"foo", "bar"}} + tf := &MissingProviderTransformer{} if err := tf.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -108,7 +108,7 @@ func TestProviderTransformer_fqns(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - transform := &MissingProviderTransformer{Providers: []string{"aws"}, Config: mod} + transform := &MissingProviderTransformer{Config: mod} if err := transform.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -132,7 +132,7 @@ func TestCloseProviderTransformer(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - transform := &MissingProviderTransformer{Providers: []string{"aws"}} + transform := &MissingProviderTransformer{} if err := transform.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -164,7 +164,7 @@ func TestCloseProviderTransformer_withTargets(t *testing.T) { g := testProviderTransformerGraph(t, mod) transforms := []GraphTransformer{ - &MissingProviderTransformer{Providers: []string{"aws"}}, + &MissingProviderTransformer{}, &ProviderTransformer{}, &CloseProviderTransformer{}, &TargetsTransformer{ @@ -194,7 +194,7 @@ func TestMissingProviderTransformer(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - transform := &MissingProviderTransformer{Providers: []string{"aws", "foo", "bar"}} + transform := &MissingProviderTransformer{} if err := transform.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -228,7 +228,7 @@ func TestMissingProviderTransformer_grandchildMissing(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - transform := TransformProviders([]string{"aws", "foo", "bar"}, concrete, mod) + transform := transformProviders(concrete, mod) if err := transform.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -252,7 +252,7 @@ func TestPruneProviderTransformer(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - transform := &MissingProviderTransformer{Providers: []string{"foo"}} + transform := &MissingProviderTransformer{} if err := transform.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -293,7 +293,7 @@ func TestProviderConfigTransformer_parentProviders(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - tf := TransformProviders([]string{"aws"}, concrete, mod) + tf := transformProviders(concrete, mod) if err := tf.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -313,7 +313,7 @@ func TestProviderConfigTransformer_grandparentProviders(t *testing.T) { g := testProviderTransformerGraph(t, mod) { - tf := TransformProviders([]string{"aws"}, concrete, mod) + tf := transformProviders(concrete, mod) if err := tf.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -347,7 +347,7 @@ resource "test_object" "a" { g := testProviderTransformerGraph(t, mod) { - tf := TransformProviders([]string{"registry.terraform.io/hashicorp/test"}, concrete, mod) + tf := transformProviders(concrete, mod) if err := tf.Transform(g); err != nil { t.Fatalf("err: %s", err) } @@ -425,7 +425,7 @@ resource "test_object" "a" { g := testProviderTransformerGraph(t, mod) { - tf := TransformProviders([]string{"registry.terraform.io/hashicorp/test"}, concrete, mod) + tf := transformProviders(concrete, mod) if err := tf.Transform(g); err != nil { t.Fatalf("err: %s", err) } diff --git a/internal/terraform/transform_root_test.go b/internal/terraform/transform_root_test.go index 04b8659ded98..4a426b5e7cc2 100644 --- a/internal/terraform/transform_root_test.go +++ b/internal/terraform/transform_root_test.go @@ -19,9 +19,7 @@ func TestRootTransformer(t *testing.T) { } { - transform := &MissingProviderTransformer{ - Providers: []string{"aws", "do"}, - } + transform := &MissingProviderTransformer{} if err := transform.Transform(&g); err != nil { t.Fatalf("err: %s", err) } From dcfa077adf68efdcf0083280dff554720f7ba468 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 10:22:25 -0700 Subject: [PATCH 048/644] core: contextComponentFactory doesn't need to enumerate components In earlier Terraform versions we used the set of all available plugins of each type to make graph-building decisions, but in modern Terraform we make those decisions based entirely on the configuration. Consequently, we no longer need the methods which can enumerate all of the known plugin components of a given type. Instead, we just try to instantiate each of the plugins that the configuration refers to and then handle the error when that fails, which typically means that the user needs to run "terraform init" to install some new plugins. --- internal/terraform/context_components.go | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/internal/terraform/context_components.go b/internal/terraform/context_components.go index 8532cfd4a04f..66f5dc664b64 100644 --- a/internal/terraform/context_components.go +++ b/internal/terraform/context_components.go @@ -15,12 +15,10 @@ import ( type contextComponentFactory interface { // ResourceProvider creates a new ResourceProvider with the given type. ResourceProvider(typ addrs.Provider) (providers.Interface, error) - ResourceProviders() []string // ResourceProvisioner creates a new ResourceProvisioner with the given // type. ResourceProvisioner(typ string) (provisioners.Interface, error) - ResourceProvisioners() []string } // basicComponentFactory just calls a factory from a map directly. @@ -29,23 +27,6 @@ type basicComponentFactory struct { provisioners map[string]provisioners.Factory } -func (c *basicComponentFactory) ResourceProviders() []string { - var result []string - for k := range c.providers { - result = append(result, k.String()) - } - return result -} - -func (c *basicComponentFactory) ResourceProvisioners() []string { - var result []string - for k := range c.provisioners { - result = append(result, k) - } - - return result -} - func (c *basicComponentFactory) ResourceProvider(typ addrs.Provider) (providers.Interface, error) { f, ok := c.providers[typ] if !ok { From 80b3fcf93e98678baf223bee31077ca18170fc4b Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 10:58:05 -0700 Subject: [PATCH 049/644] core: Replace contextComponentFactory with contextPlugins In the v0.12 timeframe we made contextComponentFactory an interface with the expectation that we'd write mocks of it for tests, but in practice we ended up just always using the same "basicComponentFactory" implementation throughout. In the interests of simplification then, here we replace that interface and its sole implementation with a new concrete struct type contextPlugins. Along with the general benefit that this removes an unneeded indirection, this also means that we can add additional methods to the struct type without the usual restriction that interface types prefer to be small. In particular, in a future commit I'm planning to add methods for loading provider and provisioner schemas, working with the currently-unused new fields this commit has included in contextPlugins, as compared to its predecessor basicComponentFactory. --- internal/command/import_test.go | 2 +- internal/terraform/context.go | 11 +-- internal/terraform/context_apply.go | 2 +- internal/terraform/context_components.go | 46 --------- internal/terraform/context_eval.go | 8 +- internal/terraform/context_import.go | 2 +- internal/terraform/context_plan.go | 6 +- internal/terraform/context_plugins.go | 62 ++++++++++++ ...onents_test.go => context_plugins_test.go} | 13 +-- internal/terraform/context_validate.go | 10 +- internal/terraform/context_validate_test.go | 8 +- internal/terraform/eval_context_builtin.go | 6 +- .../terraform/eval_context_builtin_test.go | 8 +- internal/terraform/graph_builder_apply.go | 4 +- .../terraform/graph_builder_apply_test.go | 94 +++++++++---------- .../terraform/graph_builder_destroy_plan.go | 4 +- internal/terraform/graph_builder_eval.go | 4 +- internal/terraform/graph_builder_import.go | 5 +- internal/terraform/graph_builder_plan.go | 4 +- internal/terraform/graph_builder_plan_test.go | 56 +++++------ internal/terraform/graph_walk_context.go | 2 +- internal/terraform/schemas.go | 16 ++-- .../terraform/transform_destroy_cbd_test.go | 10 +- 23 files changed, 194 insertions(+), 189 deletions(-) delete mode 100644 internal/terraform/context_components.go create mode 100644 internal/terraform/context_plugins.go rename internal/terraform/{context_components_test.go => context_plugins_test.go} (87%) diff --git a/internal/command/import_test.go b/internal/command/import_test.go index bb56751e72ee..1469ea81d224 100644 --- a/internal/command/import_test.go +++ b/internal/command/import_test.go @@ -332,7 +332,7 @@ func TestImport_initializationErrorShouldUnlock(t *testing.T) { // specifically, it should fail due to a missing provider msg := strings.ReplaceAll(ui.ErrorWriter.String(), "\n", " ") - if want := `unknown provider "registry.terraform.io/hashicorp/unknown"`; !strings.Contains(msg, want) { + if want := `unavailable provider "registry.terraform.io/hashicorp/unknown"`; !strings.Contains(msg, want) { t.Errorf("incorrect message\nwant substring: %s\ngot:\n%s", want, msg) } diff --git a/internal/terraform/context.go b/internal/terraform/context.go index 907b68762343..e05200e1e527 100644 --- a/internal/terraform/context.go +++ b/internal/terraform/context.go @@ -88,7 +88,7 @@ type Context struct { // operations. meta *ContextMeta - components contextComponentFactory + plugins *contextPlugins dependencyLocks *depsfile.Locks providersInDevelopment map[addrs.Provider]struct{} @@ -144,10 +144,7 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { par = 10 } - components := &basicComponentFactory{ - providers: opts.Providers, - provisioners: opts.Provisioners, - } + plugins := newContextPlugins(opts.Providers, opts.Provisioners) log.Printf("[TRACE] terraform.NewContext: complete") @@ -156,7 +153,7 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { meta: opts.Meta, uiInput: opts.UIInput, - components: components, + plugins: plugins, dependencyLocks: opts.LockedDependencies, providersInDevelopment: opts.ProvidersInDevelopment, @@ -221,7 +218,7 @@ func (c *Context) Schemas(config *configs.Config, state *states.State) (*Schemas } } - ret, err := loadSchemas(config, state, c.components) + ret, err := loadSchemas(config, state, c.plugins) if err != nil { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go index 4ba7e8dc0eb9..4d5dc890f754 100644 --- a/internal/terraform/context_apply.go +++ b/internal/terraform/context_apply.go @@ -95,7 +95,7 @@ func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, schemas * Config: config, Changes: plan.Changes, State: plan.PriorState, - Components: c.components, + Plugins: c.plugins, Schemas: schemas, Targets: plan.TargetAddrs, ForceReplace: plan.ForceReplaceAddrs, diff --git a/internal/terraform/context_components.go b/internal/terraform/context_components.go deleted file mode 100644 index 66f5dc664b64..000000000000 --- a/internal/terraform/context_components.go +++ /dev/null @@ -1,46 +0,0 @@ -package terraform - -import ( - "fmt" - - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/providers" - "github.com/hashicorp/terraform/internal/provisioners" -) - -// contextComponentFactory is the interface that Context uses -// to initialize various components such as providers and provisioners. -// This factory gets more information than the raw maps using to initialize -// a Context. This information is used for debugging. -type contextComponentFactory interface { - // ResourceProvider creates a new ResourceProvider with the given type. - ResourceProvider(typ addrs.Provider) (providers.Interface, error) - - // ResourceProvisioner creates a new ResourceProvisioner with the given - // type. - ResourceProvisioner(typ string) (provisioners.Interface, error) -} - -// basicComponentFactory just calls a factory from a map directly. -type basicComponentFactory struct { - providers map[addrs.Provider]providers.Factory - provisioners map[string]provisioners.Factory -} - -func (c *basicComponentFactory) ResourceProvider(typ addrs.Provider) (providers.Interface, error) { - f, ok := c.providers[typ] - if !ok { - return nil, fmt.Errorf("unknown provider %q", typ.String()) - } - - return f() -} - -func (c *basicComponentFactory) ResourceProvisioner(typ string) (provisioners.Interface, error) { - f, ok := c.provisioners[typ] - if !ok { - return nil, fmt.Errorf("unknown provisioner %q", typ) - } - - return f() -} diff --git a/internal/terraform/context_eval.go b/internal/terraform/context_eval.go index 8be9b9367846..ad3deeee1d9d 100644 --- a/internal/terraform/context_eval.go +++ b/internal/terraform/context_eval.go @@ -66,10 +66,10 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a log.Printf("[DEBUG] Building and walking 'eval' graph") graph, moreDiags := (&EvalGraphBuilder{ - Config: config, - State: state, - Components: c.components, - Schemas: schemas, + Config: config, + State: state, + Plugins: c.plugins, + Schemas: schemas, }).Build(addrs.RootModuleInstance) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index 48a5858a3df1..8675e06b5f56 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -63,7 +63,7 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt builder := &ImportGraphBuilder{ ImportTargets: opts.Targets, Config: config, - Components: c.components, + Plugins: c.plugins, Schemas: schemas, } diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 7499e57d882b..9f9170c8aafc 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -371,7 +371,7 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, graph, diags := (&PlanGraphBuilder{ Config: config, State: prevRunState, - Components: c.components, + Plugins: c.plugins, Schemas: schemas, Targets: opts.Targets, ForceReplace: opts.ForceReplace, @@ -383,7 +383,7 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, graph, diags := (&PlanGraphBuilder{ Config: config, State: prevRunState, - Components: c.components, + Plugins: c.plugins, Schemas: schemas, Targets: opts.Targets, Validate: validate, @@ -395,7 +395,7 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, graph, diags := (&DestroyPlanGraphBuilder{ Config: config, State: prevRunState, - Components: c.components, + Plugins: c.plugins, Schemas: schemas, Targets: opts.Targets, Validate: validate, diff --git a/internal/terraform/context_plugins.go b/internal/terraform/context_plugins.go new file mode 100644 index 000000000000..2bd1964d3a66 --- /dev/null +++ b/internal/terraform/context_plugins.go @@ -0,0 +1,62 @@ +package terraform + +import ( + "fmt" + "sync" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/providers" + "github.com/hashicorp/terraform/internal/provisioners" +) + +// contextPlugins represents a library of available plugins (providers and +// provisioners) which we assume will all be used with the same +// terraform.Context, and thus it'll be safe to cache certain information +// about the providers for performance reasons. +type contextPlugins struct { + providerFactories map[addrs.Provider]providers.Factory + provisionerFactories map[string]provisioners.Factory + + // We memoize the schemas we've previously loaded in here, to avoid + // repeatedly paying the cost of activating the same plugins to access + // their schemas in various different spots. We use schemas for many + // purposes in Terraform, so there isn't a single choke point where + // it makes sense to preload all of them. + providerSchemas map[addrs.Provider]*ProviderSchema + provisionerSchemas map[string]*configschema.Block + schemasLock *sync.Mutex +} + +func newContextPlugins(providerFactories map[addrs.Provider]providers.Factory, provisionerFactories map[string]provisioners.Factory) *contextPlugins { + ret := &contextPlugins{ + providerFactories: providerFactories, + provisionerFactories: provisionerFactories, + } + ret.init() + return ret +} + +func (cp *contextPlugins) init() { + cp.providerSchemas = make(map[addrs.Provider]*ProviderSchema, len(cp.providerFactories)) + cp.provisionerSchemas = make(map[string]*configschema.Block, len(cp.provisionerFactories)) +} + +func (cp *contextPlugins) NewProviderInstance(addr addrs.Provider) (providers.Interface, error) { + f, ok := cp.providerFactories[addr] + if !ok { + return nil, fmt.Errorf("unavailable provider %q", addr.String()) + } + + return f() + +} + +func (cp *contextPlugins) NewProvisionerInstance(typ string) (provisioners.Interface, error) { + f, ok := cp.provisionerFactories[typ] + if !ok { + return nil, fmt.Errorf("unavailable provisioner %q", typ) + } + + return f() +} diff --git a/internal/terraform/context_components_test.go b/internal/terraform/context_plugins_test.go similarity index 87% rename from internal/terraform/context_components_test.go rename to internal/terraform/context_plugins_test.go index f92b41b6ac9e..130de5b52221 100644 --- a/internal/terraform/context_components_test.go +++ b/internal/terraform/context_plugins_test.go @@ -9,7 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/provisioners" ) -// simpleMockComponentFactory returns a component factory pre-configured with +// simpleMockPluginLibrary returns a plugin library pre-configured with // one provider and one provisioner, both called "test". // // The provider is built with simpleMockProvider and the provisioner with @@ -19,26 +19,27 @@ import ( // Each call to this function produces an entirely-separate set of objects, // so the caller can feel free to modify the returned value to further // customize the mocks contained within. -func simpleMockComponentFactory() *basicComponentFactory { +func simpleMockPluginLibrary() *contextPlugins { // We create these out here, rather than in the factory functions below, // because we want each call to the factory to return the _same_ instance, // so that test code can customize it before passing this component // factory into real code under test. provider := simpleMockProvider() provisioner := simpleMockProvisioner() - return &basicComponentFactory{ - providers: map[addrs.Provider]providers.Factory{ + ret := &contextPlugins{ + providerFactories: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("test"): func() (providers.Interface, error) { return provider, nil }, }, - provisioners: map[string]provisioners.Factory{ + provisionerFactories: map[string]provisioners.Factory{ "test": func() (provisioners.Interface, error) { return provisioner, nil }, }, } - + ret.init() // prepare the internal cache data structures + return ret } // simpleTestSchema returns a block schema that contains a few optional diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go index bda38633ab16..f95127895231 100644 --- a/internal/terraform/context_validate.go +++ b/internal/terraform/context_validate.go @@ -44,11 +44,11 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { log.Printf("[DEBUG] Building and walking validate graph") graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ - Config: config, - Components: c.components, - Schemas: schemas, - Validate: true, - State: states.NewState(), + Config: config, + Plugins: c.plugins, + Schemas: schemas, + Validate: true, + State: states.NewState(), }).Build(addrs.RootModuleInstance) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index b25bed35e9ee..e4eee13b4303 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -1198,10 +1198,10 @@ func TestContext2Validate_PlanGraphBuilder(t *testing.T) { assertNoDiagnostics(t, diags) graph, diags := ValidateGraphBuilder(&PlanGraphBuilder{ - Config: fixture.Config, - State: states.NewState(), - Components: c.components, - Schemas: schemas, + Config: fixture.Config, + State: states.NewState(), + Plugins: c.plugins, + Schemas: schemas, }).Build(addrs.RootModuleInstance) if diags.HasErrors() { t.Fatalf("errors from PlanGraphBuilder: %s", diags.Err()) diff --git a/internal/terraform/eval_context_builtin.go b/internal/terraform/eval_context_builtin.go index 1b971fd6b19c..6bcf91663023 100644 --- a/internal/terraform/eval_context_builtin.go +++ b/internal/terraform/eval_context_builtin.go @@ -62,7 +62,7 @@ type BuiltinEvalContext struct { VariableValues map[string]map[string]cty.Value VariableValuesLock *sync.Mutex - Components contextComponentFactory + Plugins *contextPlugins Hooks []Hook InputValue UIInput ProviderCache map[string]providers.Interface @@ -134,7 +134,7 @@ func (ctx *BuiltinEvalContext) InitProvider(addr addrs.AbsProviderConfig) (provi key := addr.String() - p, err := ctx.Components.ResourceProvider(addr.Provider) + p, err := ctx.Plugins.NewProviderInstance(addr.Provider) if err != nil { return nil, err } @@ -238,7 +238,7 @@ func (ctx *BuiltinEvalContext) Provisioner(n string) (provisioners.Interface, er p, ok := ctx.ProvisionerCache[n] if !ok { var err error - p, err = ctx.Components.ResourceProvisioner(n) + p, err = ctx.Plugins.NewProvisionerInstance(n) if err != nil { return nil, err } diff --git a/internal/terraform/eval_context_builtin_test.go b/internal/terraform/eval_context_builtin_test.go index 0521930b587a..0db0096a75ed 100644 --- a/internal/terraform/eval_context_builtin_test.go +++ b/internal/terraform/eval_context_builtin_test.go @@ -59,11 +59,9 @@ func TestBuildingEvalContextInitProvider(t *testing.T) { ctx = ctx.WithPath(addrs.RootModuleInstance).(*BuiltinEvalContext) ctx.ProviderLock = &lock ctx.ProviderCache = make(map[string]providers.Interface) - ctx.Components = &basicComponentFactory{ - providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): providers.FactoryFixed(testP), - }, - } + ctx.Plugins = newContextPlugins(map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): providers.FactoryFixed(testP), + }, nil) providerAddrDefault := addrs.AbsProviderConfig{ Module: addrs.RootModule, diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go index bf213d1d0620..ca8e5777fa0c 100644 --- a/internal/terraform/graph_builder_apply.go +++ b/internal/terraform/graph_builder_apply.go @@ -26,9 +26,9 @@ type ApplyGraphBuilder struct { // State is the current state State *states.State - // Components is a factory for the plug-in components (providers and + // Plugins is a library of the plug-in components (providers and // provisioners) available for use. - Components contextComponentFactory + Plugins *contextPlugins // Schemas is the repository of schemas we will draw from to analyse // the configuration. diff --git a/internal/terraform/graph_builder_apply_test.go b/internal/terraform/graph_builder_apply_test.go index b96149bac65d..9aaa1650d859 100644 --- a/internal/terraform/graph_builder_apply_test.go +++ b/internal/terraform/graph_builder_apply_test.go @@ -46,10 +46,10 @@ func TestApplyGraphBuilder(t *testing.T) { } b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-basic"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), + Config: testModule(t, "graph-builder-apply-basic"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), } g, err := b.Build(addrs.RootModuleInstance) @@ -110,11 +110,11 @@ func TestApplyGraphBuilder_depCbd(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-dep-cbd"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), - State: state, + Config: testModule(t, "graph-builder-apply-dep-cbd"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), + State: state, } g, err := b.Build(addrs.RootModuleInstance) @@ -184,10 +184,10 @@ func TestApplyGraphBuilder_doubleCBD(t *testing.T) { } b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-double-cbd"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), + Config: testModule(t, "graph-builder-apply-double-cbd"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), } g, err := b.Build(addrs.RootModuleInstance) @@ -278,11 +278,11 @@ func TestApplyGraphBuilder_destroyStateOnly(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "empty"), - Changes: changes, - State: state, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), + Config: testModule(t, "empty"), + Changes: changes, + State: state, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), } g, diags := b.Build(addrs.RootModuleInstance) @@ -341,11 +341,11 @@ func TestApplyGraphBuilder_destroyCount(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-count"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), - State: state, + Config: testModule(t, "graph-builder-apply-count"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), + State: state, } g, err := b.Build(addrs.RootModuleInstance) @@ -404,11 +404,11 @@ func TestApplyGraphBuilder_moduleDestroy(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-module-destroy"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), - State: state, + Config: testModule(t, "graph-builder-apply-module-destroy"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), + State: state, } g, err := b.Build(addrs.RootModuleInstance) @@ -442,10 +442,10 @@ func TestApplyGraphBuilder_targetModule(t *testing.T) { } b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-target-module"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), + Config: testModule(t, "graph-builder-apply-target-module"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child2", addrs.NoKey), }, @@ -539,11 +539,11 @@ func TestApplyGraphBuilder_updateFromOrphan(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-orphan-update"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: schemas, - State: state, + Config: testModule(t, "graph-builder-apply-orphan-update"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: schemas, + State: state, } g, err := b.Build(addrs.RootModuleInstance) @@ -640,11 +640,11 @@ func TestApplyGraphBuilder_updateFromCBDOrphan(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-apply-orphan-update"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: schemas, - State: state, + Config: testModule(t, "graph-builder-apply-orphan-update"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: schemas, + State: state, } g, err := b.Build(addrs.RootModuleInstance) @@ -691,11 +691,11 @@ func TestApplyGraphBuilder_orphanedWithProvider(t *testing.T) { ) b := &ApplyGraphBuilder{ - Config: testModule(t, "graph-builder-orphan-alias"), - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), - State: state, + Config: testModule(t, "graph-builder-orphan-alias"), + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), + State: state, } g, err := b.Build(addrs.RootModuleInstance) diff --git a/internal/terraform/graph_builder_destroy_plan.go b/internal/terraform/graph_builder_destroy_plan.go index 1973237b4bea..55bae82fdd35 100644 --- a/internal/terraform/graph_builder_destroy_plan.go +++ b/internal/terraform/graph_builder_destroy_plan.go @@ -23,9 +23,9 @@ type DestroyPlanGraphBuilder struct { // State is the current state State *states.State - // Components is a factory for the plug-in components (providers and + // Plugins is a library of plug-in components (providers and // provisioners) available for use. - Components contextComponentFactory + Plugins *contextPlugins // Schemas is the repository of schemas we will draw from to analyse // the configuration. diff --git a/internal/terraform/graph_builder_eval.go b/internal/terraform/graph_builder_eval.go index 65e663550652..f413dd7fea52 100644 --- a/internal/terraform/graph_builder_eval.go +++ b/internal/terraform/graph_builder_eval.go @@ -30,9 +30,9 @@ type EvalGraphBuilder struct { // State is the current state State *states.State - // Components is a factory for the plug-in components (providers and + // Plugins is a library of plug-in components (providers and // provisioners) available for use. - Components contextComponentFactory + Plugins *contextPlugins // Schemas is the repository of schemas we will draw from to analyse // the configuration. diff --git a/internal/terraform/graph_builder_import.go b/internal/terraform/graph_builder_import.go index bbef67713f22..d502b131ec69 100644 --- a/internal/terraform/graph_builder_import.go +++ b/internal/terraform/graph_builder_import.go @@ -17,8 +17,9 @@ type ImportGraphBuilder struct { // Module is a configuration to build the graph from. See ImportOpts.Config. Config *configs.Config - // Components is the factory for our available plugin components. - Components contextComponentFactory + // Plugins is a library of plug-in components (providers and + // provisioners) available for use. + Plugins *contextPlugins // Schemas is the repository of schemas we will draw from to analyse // the configuration. diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index 8d680162492e..e0a355d47f3c 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -28,9 +28,9 @@ type PlanGraphBuilder struct { // State is the current state State *states.State - // Components is a factory for the plug-in components (providers and + // Plugins is a library of plug-in components (providers and // provisioners) available for use. - Components contextComponentFactory + Plugins *contextPlugins // Schemas is the repository of schemas we will draw from to analyse // the configuration. diff --git a/internal/terraform/graph_builder_plan_test.go b/internal/terraform/graph_builder_plan_test.go index 6225e192e6c9..c5aa9a455914 100644 --- a/internal/terraform/graph_builder_plan_test.go +++ b/internal/terraform/graph_builder_plan_test.go @@ -26,16 +26,14 @@ func TestPlanGraphBuilder(t *testing.T) { }, } openstackProvider := mockProviderWithResourceTypeSchema("openstack_floating_ip", simpleTestSchema()) - components := &basicComponentFactory{ - providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): providers.FactoryFixed(awsProvider), - addrs.NewDefaultProvider("openstack"): providers.FactoryFixed(openstackProvider), - }, - } + plugins := newContextPlugins(map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): providers.FactoryFixed(awsProvider), + addrs.NewDefaultProvider("openstack"): providers.FactoryFixed(openstackProvider), + }, nil) b := &PlanGraphBuilder{ - Config: testModule(t, "graph-builder-plan-basic"), - Components: components, + Config: testModule(t, "graph-builder-plan-basic"), + Plugins: plugins, Schemas: &Schemas{ Providers: map[addrs.Provider]*ProviderSchema{ addrs.NewDefaultProvider("aws"): awsProvider.ProviderSchema(), @@ -77,15 +75,13 @@ func TestPlanGraphBuilder_dynamicBlock(t *testing.T) { }, }, }) - components := &basicComponentFactory{ - providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): providers.FactoryFixed(provider), - }, - } + plugins := newContextPlugins(map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): providers.FactoryFixed(provider), + }, nil) b := &PlanGraphBuilder{ - Config: testModule(t, "graph-builder-plan-dynblock"), - Components: components, + Config: testModule(t, "graph-builder-plan-dynblock"), + Plugins: plugins, Schemas: &Schemas{ Providers: map[addrs.Provider]*ProviderSchema{ addrs.NewDefaultProvider("test"): provider.ProviderSchema(), @@ -142,15 +138,13 @@ func TestPlanGraphBuilder_attrAsBlocks(t *testing.T) { }, }, }) - components := &basicComponentFactory{ - providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): providers.FactoryFixed(provider), - }, - } + plugins := newContextPlugins(map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): providers.FactoryFixed(provider), + }, nil) b := &PlanGraphBuilder{ - Config: testModule(t, "graph-builder-plan-attr-as-blocks"), - Components: components, + Config: testModule(t, "graph-builder-plan-attr-as-blocks"), + Plugins: plugins, Schemas: &Schemas{ Providers: map[addrs.Provider]*ProviderSchema{ addrs.NewDefaultProvider("test"): provider.ProviderSchema(), @@ -194,9 +188,9 @@ test_thing.b (expand) func TestPlanGraphBuilder_targetModule(t *testing.T) { b := &PlanGraphBuilder{ - Config: testModule(t, "graph-builder-plan-target-module-provider"), - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), + Config: testModule(t, "graph-builder-plan-target-module-provider"), + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child2", addrs.NoKey), }, @@ -216,15 +210,13 @@ func TestPlanGraphBuilder_targetModule(t *testing.T) { func TestPlanGraphBuilder_forEach(t *testing.T) { awsProvider := mockProviderWithResourceTypeSchema("aws_instance", simpleTestSchema()) - components := &basicComponentFactory{ - providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): providers.FactoryFixed(awsProvider), - }, - } + plugins := newContextPlugins(map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): providers.FactoryFixed(awsProvider), + }, nil) b := &PlanGraphBuilder{ - Config: testModule(t, "plan-for-each"), - Components: components, + Config: testModule(t, "plan-for-each"), + Plugins: plugins, Schemas: &Schemas{ Providers: map[addrs.Provider]*ProviderSchema{ addrs.NewDefaultProvider("aws"): awsProvider.ProviderSchema(), diff --git a/internal/terraform/graph_walk_context.go b/internal/terraform/graph_walk_context.go index 164a2ba2a58c..3561ab983b55 100644 --- a/internal/terraform/graph_walk_context.go +++ b/internal/terraform/graph_walk_context.go @@ -91,7 +91,7 @@ func (w *ContextGraphWalker) EvalContext() EvalContext { Hooks: w.Context.hooks, InputValue: w.Context.uiInput, InstanceExpanderValue: w.InstanceExpander, - Components: w.Context.components, + Plugins: w.Context.plugins, Schemas: w.Schemas, MoveResultsValue: w.MoveResults, ProviderCache: w.providerCache, diff --git a/internal/terraform/schemas.go b/internal/terraform/schemas.go index 974cbb2eb441..7b7177dbd001 100644 --- a/internal/terraform/schemas.go +++ b/internal/terraform/schemas.go @@ -74,22 +74,22 @@ func (ss *Schemas) ProvisionerConfig(name string) *configschema.Block { // either misbehavior on the part of one of the providers or of the provider // protocol itself. When returned with errors, the returned schemas object is // still valid but may be incomplete. -func loadSchemas(config *configs.Config, state *states.State, components contextComponentFactory) (*Schemas, error) { +func loadSchemas(config *configs.Config, state *states.State, plugins *contextPlugins) (*Schemas, error) { schemas := &Schemas{ Providers: map[addrs.Provider]*ProviderSchema{}, Provisioners: map[string]*configschema.Block{}, } var diags tfdiags.Diagnostics - newDiags := loadProviderSchemas(schemas.Providers, config, state, components) + newDiags := loadProviderSchemas(schemas.Providers, config, state, plugins) diags = diags.Append(newDiags) - newDiags = loadProvisionerSchemas(schemas.Provisioners, config, components) + newDiags = loadProvisionerSchemas(schemas.Provisioners, config, plugins) diags = diags.Append(newDiags) return schemas, diags.Err() } -func loadProviderSchemas(schemas map[addrs.Provider]*ProviderSchema, config *configs.Config, state *states.State, components contextComponentFactory) tfdiags.Diagnostics { +func loadProviderSchemas(schemas map[addrs.Provider]*ProviderSchema, config *configs.Config, state *states.State, plugins *contextPlugins) tfdiags.Diagnostics { var diags tfdiags.Diagnostics ensure := func(fqn addrs.Provider) { @@ -100,7 +100,7 @@ func loadProviderSchemas(schemas map[addrs.Provider]*ProviderSchema, config *con } log.Printf("[TRACE] LoadSchemas: retrieving schema for provider type %q", name) - provider, err := components.ResourceProvider(fqn) + provider, err := plugins.NewProviderInstance(fqn) if err != nil { // We'll put a stub in the map so we won't re-attempt this on // future calls. @@ -191,7 +191,7 @@ func loadProviderSchemas(schemas map[addrs.Provider]*ProviderSchema, config *con return diags } -func loadProvisionerSchemas(schemas map[string]*configschema.Block, config *configs.Config, components contextComponentFactory) tfdiags.Diagnostics { +func loadProvisionerSchemas(schemas map[string]*configschema.Block, config *configs.Config, plugins *contextPlugins) tfdiags.Diagnostics { var diags tfdiags.Diagnostics ensure := func(name string) { @@ -200,7 +200,7 @@ func loadProvisionerSchemas(schemas map[string]*configschema.Block, config *conf } log.Printf("[TRACE] LoadSchemas: retrieving schema for provisioner %q", name) - provisioner, err := components.ResourceProvisioner(name) + provisioner, err := plugins.NewProvisionerInstance(name) if err != nil { // We'll put a stub in the map so we won't re-attempt this on // future calls. @@ -237,7 +237,7 @@ func loadProvisionerSchemas(schemas map[string]*configschema.Block, config *conf // Must also visit our child modules, recursively. for _, cc := range config.Children { - childDiags := loadProvisionerSchemas(schemas, cc, components) + childDiags := loadProvisionerSchemas(schemas, cc, plugins) diags = diags.Append(childDiags) } } diff --git a/internal/terraform/transform_destroy_cbd_test.go b/internal/terraform/transform_destroy_cbd_test.go index 4e4409623dd1..a66243f540b3 100644 --- a/internal/terraform/transform_destroy_cbd_test.go +++ b/internal/terraform/transform_destroy_cbd_test.go @@ -14,11 +14,11 @@ func cbdTestGraph(t *testing.T, mod string, changes *plans.Changes, state *state module := testModule(t, mod) applyBuilder := &ApplyGraphBuilder{ - Config: module, - Changes: changes, - Components: simpleMockComponentFactory(), - Schemas: simpleTestSchemas(), - State: state, + Config: module, + Changes: changes, + Plugins: simpleMockPluginLibrary(), + Schemas: simpleTestSchemas(), + State: state, } g, err := (&BasicGraphBuilder{ Steps: cbdTestSteps(applyBuilder.Steps()), From 2bf1de1f5dfa09bbe3daf9dd6e73016e7eaf791b Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 11:27:07 -0700 Subject: [PATCH 050/644] core: Context.Schemas in terms of contextPlugins methods The responsibility for actually instantiating a single plugin and reading out its schema now belongs to the contextPlugins type, which memoizes the results by each plugin's unique identifier so that we can avoid retrieving the same schemas multiple times when working with the same context. This doesn't change the API of Context.Schemas but it does restore the spirit of an earlier version of terraform.Context which did all of the schema loading proactively inside terraform.NewContext. In an earlier commit we reduced the scope of terraform.NewContext, making schema loading a separate step, but in the process of doing that removed the effective memoization of the schema results that terraform.NewContext was providing. The memoization here will play out in a different way than before, because we'll be treating each plugin call as separate rather than proactively loading them all up front, but this is effectively the same because all of our operation methods on Context call Context.Schemas early in their work and thus end up forcing all of the necessary schemas to load up front nonetheless. --- internal/terraform/context_plugins.go | 105 ++++++++++++++++++++++++- internal/terraform/schemas.go | 109 +++++--------------------- 2 files changed, 122 insertions(+), 92 deletions(-) diff --git a/internal/terraform/context_plugins.go b/internal/terraform/context_plugins.go index 2bd1964d3a66..5711badbd758 100644 --- a/internal/terraform/context_plugins.go +++ b/internal/terraform/context_plugins.go @@ -2,6 +2,7 @@ package terraform import ( "fmt" + "log" "sync" "github.com/hashicorp/terraform/internal/addrs" @@ -25,7 +26,7 @@ type contextPlugins struct { // it makes sense to preload all of them. providerSchemas map[addrs.Provider]*ProviderSchema provisionerSchemas map[string]*configschema.Block - schemasLock *sync.Mutex + schemasLock sync.Mutex } func newContextPlugins(providerFactories map[addrs.Provider]providers.Factory, provisionerFactories map[string]provisioners.Factory) *contextPlugins { @@ -60,3 +61,105 @@ func (cp *contextPlugins) NewProvisionerInstance(typ string) (provisioners.Inter return f() } + +// ProviderSchema uses a temporary instance of the provider with the given +// address to obtain the full schema for all aspects of that provider. +// +// ProviderSchema memoizes results by unique provider address, so it's fine +// to repeatedly call this method with the same address if various different +// parts of Terraform all need the same schema information. +func (cp *contextPlugins) ProviderSchema(addr addrs.Provider) (*ProviderSchema, error) { + cp.schemasLock.Lock() + defer cp.schemasLock.Unlock() + + if schema, ok := cp.providerSchemas[addr]; ok { + return schema, nil + } + + log.Printf("[TRACE] terraform.contextPlugins: Initializing provider %q to read its schema", addr) + + provider, err := cp.NewProviderInstance(addr) + if err != nil { + return nil, fmt.Errorf("failed to instantiate provider %q to obtain schema: %s", addr, err) + } + defer provider.Close() + + resp := provider.GetProviderSchema() + if resp.Diagnostics.HasErrors() { + return nil, fmt.Errorf("failed to retrieve schema from provider %q: %s", addr, resp.Diagnostics.Err()) + } + + s := &ProviderSchema{ + Provider: resp.Provider.Block, + ResourceTypes: make(map[string]*configschema.Block), + DataSources: make(map[string]*configschema.Block), + + ResourceTypeSchemaVersions: make(map[string]uint64), + } + + if resp.Provider.Version < 0 { + // We're not using the version numbers here yet, but we'll check + // for validity anyway in case we start using them in future. + return nil, fmt.Errorf("provider %s has invalid negative schema version for its configuration blocks,which is a bug in the provider ", addr) + } + + for t, r := range resp.ResourceTypes { + if err := r.Block.InternalValidate(); err != nil { + return nil, fmt.Errorf("provider %s has invalid schema for managed resource type %q, which is a bug in the provider: %q", addr, t, err) + } + s.ResourceTypes[t] = r.Block + s.ResourceTypeSchemaVersions[t] = uint64(r.Version) + if r.Version < 0 { + return nil, fmt.Errorf("provider %s has invalid negative schema version for managed resource type %q, which is a bug in the provider", addr, t) + } + } + + for t, d := range resp.DataSources { + if err := d.Block.InternalValidate(); err != nil { + return nil, fmt.Errorf("provider %s has invalid schema for data resource type %q, which is a bug in the provider: %q", addr, t, err) + } + s.DataSources[t] = d.Block + if d.Version < 0 { + // We're not using the version numbers here yet, but we'll check + // for validity anyway in case we start using them in future. + return nil, fmt.Errorf("provider %s has invalid negative schema version for data resource type %q, which is a bug in the provider", addr, t) + } + } + + if resp.ProviderMeta.Block != nil { + s.ProviderMeta = resp.ProviderMeta.Block + } + + cp.providerSchemas[addr] = s + return s, nil +} + +// ProvisionerSchema uses a temporary instance of the provisioner with the +// given type name to obtain the schema for that provisioner's configuration. +// +// ProvisionerSchema memoizes results by provisioner type name, so it's fine +// to repeatedly call this method with the same name if various different +// parts of Terraform all need the same schema information. +func (cp *contextPlugins) ProvisionerSchema(typ string) (*configschema.Block, error) { + cp.schemasLock.Lock() + defer cp.schemasLock.Unlock() + + if schema, ok := cp.provisionerSchemas[typ]; ok { + return schema, nil + } + + log.Printf("[TRACE] terraform.contextPlugins: Initializing provisioner %q to read its schema", typ) + provisioner, err := cp.NewProvisionerInstance(typ) + if err != nil { + return nil, fmt.Errorf("failed to instantiate provisioner %q to obtain schema: %s", typ, err) + } + defer provisioner.Close() + + resp := provisioner.GetSchema() + if resp.Diagnostics.HasErrors() { + return nil, fmt.Errorf("failed to retrieve schema from provisioner %q: %s", typ, resp.Diagnostics.Err()) + } + + cp.provisionerSchemas[typ] = resp.Provisioner + return resp.Provisioner, nil +} diff --git a/internal/terraform/schemas.go b/internal/terraform/schemas.go index 7b7177dbd001..d09cc2cb2533 100644 --- a/internal/terraform/schemas.go +++ b/internal/terraform/schemas.go @@ -100,79 +100,23 @@ func loadProviderSchemas(schemas map[addrs.Provider]*ProviderSchema, config *con } log.Printf("[TRACE] LoadSchemas: retrieving schema for provider type %q", name) - provider, err := plugins.NewProviderInstance(fqn) + schema, err := plugins.ProviderSchema(fqn) if err != nil { // We'll put a stub in the map so we won't re-attempt this on - // future calls. + // future calls, which would then repeat the same error message + // multiple times. schemas[fqn] = &ProviderSchema{} diags = diags.Append( - fmt.Errorf("failed to instantiate provider %q to obtain schema: %s", name, err), + tfdiags.Sourceless( + tfdiags.Error, + "Failed to obtain provider schema", + fmt.Sprintf("Could not load the schema for provider %s: %s.", fqn, err), + ), ) return } - defer func() { - provider.Close() - }() - resp := provider.GetProviderSchema() - if resp.Diagnostics.HasErrors() { - // We'll put a stub in the map so we won't re-attempt this on - // future calls. - schemas[fqn] = &ProviderSchema{} - diags = diags.Append( - fmt.Errorf("failed to retrieve schema from provider %q: %s", name, resp.Diagnostics.Err()), - ) - return - } - - s := &ProviderSchema{ - Provider: resp.Provider.Block, - ResourceTypes: make(map[string]*configschema.Block), - DataSources: make(map[string]*configschema.Block), - - ResourceTypeSchemaVersions: make(map[string]uint64), - } - - if resp.Provider.Version < 0 { - // We're not using the version numbers here yet, but we'll check - // for validity anyway in case we start using them in future. - diags = diags.Append( - fmt.Errorf("invalid negative schema version provider configuration for provider %q", name), - ) - } - - for t, r := range resp.ResourceTypes { - if err := r.Block.InternalValidate(); err != nil { - diags = diags.Append(fmt.Errorf(errProviderSchemaInvalid, name, "resource", t, err)) - } - s.ResourceTypes[t] = r.Block - s.ResourceTypeSchemaVersions[t] = uint64(r.Version) - if r.Version < 0 { - diags = diags.Append( - fmt.Errorf("invalid negative schema version for resource type %s in provider %q", t, name), - ) - } - } - - for t, d := range resp.DataSources { - if err := d.Block.InternalValidate(); err != nil { - diags = diags.Append(fmt.Errorf(errProviderSchemaInvalid, name, "data source", t, err)) - } - s.DataSources[t] = d.Block - if d.Version < 0 { - // We're not using the version numbers here yet, but we'll check - // for validity anyway in case we start using them in future. - diags = diags.Append( - fmt.Errorf("invalid negative schema version for data source %s in provider %q", t, name), - ) - } - } - - schemas[fqn] = s - - if resp.ProviderMeta.Block != nil { - s.ProviderMeta = resp.ProviderMeta.Block - } + schemas[fqn] = schema } if config != nil { @@ -200,32 +144,23 @@ func loadProvisionerSchemas(schemas map[string]*configschema.Block, config *conf } log.Printf("[TRACE] LoadSchemas: retrieving schema for provisioner %q", name) - provisioner, err := plugins.NewProvisionerInstance(name) + schema, err := plugins.ProvisionerSchema(name) if err != nil { // We'll put a stub in the map so we won't re-attempt this on - // future calls. - schemas[name] = &configschema.Block{} - diags = diags.Append( - fmt.Errorf("failed to instantiate provisioner %q to obtain schema: %s", name, err), - ) - return - } - defer func() { - provisioner.Close() - }() - - resp := provisioner.GetSchema() - if resp.Diagnostics.HasErrors() { - // We'll put a stub in the map so we won't re-attempt this on - // future calls. + // future calls, which would then repeat the same error message + // multiple times. schemas[name] = &configschema.Block{} diags = diags.Append( - fmt.Errorf("failed to retrieve schema from provisioner %q: %s", name, resp.Diagnostics.Err()), + tfdiags.Sourceless( + tfdiags.Error, + "Failed to obtain provisioner schema", + fmt.Sprintf("Could not load the schema for provisioner %q: %s.", name, err), + ), ) return } - schemas[name] = resp.Provisioner + schemas[name] = schema } if config != nil { @@ -280,11 +215,3 @@ func (ps *ProviderSchema) SchemaForResourceType(mode addrs.ResourceMode, typeNam func (ps *ProviderSchema) SchemaForResourceAddr(addr addrs.Resource) (schema *configschema.Block, version uint64) { return ps.SchemaForResourceType(addr.Mode, addr.Type) } - -const errProviderSchemaInvalid = ` -Internal validation of the provider failed! This is always a bug with the -provider itself, and not a user issue. Please report this bug to the -maintainers of the %q provider: - -%s %s: %s -` From a59c2fe1b9c3b5c1742df4699708e1027cdba09e Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 15:44:07 -0700 Subject: [PATCH 051/644] core: EvalContextBuiltin no longer has a "Schemas" By tolerating ProviderSchema and ProvisionerSchema potentially returning errors, we can slightly simplify EvalContextBuiltin by having it retrieve individual schemas when needed directly from the "Plugins" object. EvalContextBuiltin already needs to be holding a contextPlugins instance for other reasons anyway, so this allows us to get the same result with fewer moving parts. --- internal/terraform/eval_context.go | 4 +-- internal/terraform/eval_context_builtin.go | 28 +++++++++---------- internal/terraform/eval_context_mock.go | 10 ++++--- internal/terraform/eval_provider.go | 5 +++- internal/terraform/graph_walk_context.go | 1 - .../node_resource_abstract_instance.go | 9 +++++- internal/terraform/node_resource_validate.go | 7 +++-- 7 files changed, 38 insertions(+), 26 deletions(-) diff --git a/internal/terraform/eval_context.go b/internal/terraform/eval_context.go index 2cee1b0711d9..61b4f2448f88 100644 --- a/internal/terraform/eval_context.go +++ b/internal/terraform/eval_context.go @@ -53,7 +53,7 @@ type EvalContext interface { // // This method expects an _absolute_ provider configuration address, since // resources in one module are able to use providers from other modules. - ProviderSchema(addrs.AbsProviderConfig) *ProviderSchema + ProviderSchema(addrs.AbsProviderConfig) (*ProviderSchema, error) // CloseProvider closes provider connections that aren't needed anymore. // @@ -84,7 +84,7 @@ type EvalContext interface { // ProvisionerSchema retrieves the main configuration schema for a // particular provisioner, which must have already been initialized with // InitProvisioner. - ProvisionerSchema(string) *configschema.Block + ProvisionerSchema(string) (*configschema.Block, error) // CloseProvisioner closes all provisioner plugins. CloseProvisioners() error diff --git a/internal/terraform/eval_context_builtin.go b/internal/terraform/eval_context_builtin.go index 6bcf91663023..ea83e82799b3 100644 --- a/internal/terraform/eval_context_builtin.go +++ b/internal/terraform/eval_context_builtin.go @@ -44,15 +44,6 @@ type BuiltinEvalContext struct { // eval context. Evaluator *Evaluator - // Schemas is a repository of all of the schemas we should need to - // decode configuration blocks and expressions. This must be constructed by - // the caller to include schemas for all of the providers, resource types, - // data sources and provisioners used by the given configuration and - // state. - // - // This must not be mutated during evaluation. - Schemas *Schemas - // VariableValues contains the variable values across all modules. This // structure is shared across the entire containing context, and so it // may be accessed only when holding VariableValuesLock. @@ -62,7 +53,10 @@ type BuiltinEvalContext struct { VariableValues map[string]map[string]cty.Value VariableValuesLock *sync.Mutex - Plugins *contextPlugins + // Plugins is a library of plugin components (providers and provisioners) + // available for use during a graph walk. + Plugins *contextPlugins + Hooks []Hook InputValue UIInput ProviderCache map[string]providers.Interface @@ -152,8 +146,8 @@ func (ctx *BuiltinEvalContext) Provider(addr addrs.AbsProviderConfig) providers. return ctx.ProviderCache[addr.String()] } -func (ctx *BuiltinEvalContext) ProviderSchema(addr addrs.AbsProviderConfig) *ProviderSchema { - return ctx.Schemas.ProviderSchema(addr.Provider) +func (ctx *BuiltinEvalContext) ProviderSchema(addr addrs.AbsProviderConfig) (*ProviderSchema, error) { + return ctx.Plugins.ProviderSchema(addr.Provider) } func (ctx *BuiltinEvalContext) CloseProvider(addr addrs.AbsProviderConfig) error { @@ -184,7 +178,11 @@ func (ctx *BuiltinEvalContext) ConfigureProvider(addr addrs.AbsProviderConfig, c return diags } - providerSchema := ctx.ProviderSchema(addr) + providerSchema, err := ctx.ProviderSchema(addr) + if err != nil { + diags = diags.Append(fmt.Errorf("failed to read schema for %s: %s", addr, err)) + return diags + } if providerSchema == nil { diags = diags.Append(fmt.Errorf("schema for %s is not available", addr)) return diags @@ -249,8 +247,8 @@ func (ctx *BuiltinEvalContext) Provisioner(n string) (provisioners.Interface, er return p, nil } -func (ctx *BuiltinEvalContext) ProvisionerSchema(n string) *configschema.Block { - return ctx.Schemas.ProvisionerConfig(n) +func (ctx *BuiltinEvalContext) ProvisionerSchema(n string) (*configschema.Block, error) { + return ctx.Plugins.ProvisionerSchema(n) } func (ctx *BuiltinEvalContext) CloseProvisioners() error { diff --git a/internal/terraform/eval_context_mock.go b/internal/terraform/eval_context_mock.go index 0e4fd32d6903..52a06c3ee719 100644 --- a/internal/terraform/eval_context_mock.go +++ b/internal/terraform/eval_context_mock.go @@ -43,6 +43,7 @@ type MockEvalContext struct { ProviderSchemaCalled bool ProviderSchemaAddr addrs.AbsProviderConfig ProviderSchemaSchema *ProviderSchema + ProviderSchemaError error CloseProviderCalled bool CloseProviderAddr addrs.AbsProviderConfig @@ -71,6 +72,7 @@ type MockEvalContext struct { ProvisionerSchemaCalled bool ProvisionerSchemaName string ProvisionerSchemaSchema *configschema.Block + ProvisionerSchemaError error CloseProvisionersCalled bool @@ -173,10 +175,10 @@ func (c *MockEvalContext) Provider(addr addrs.AbsProviderConfig) providers.Inter return c.ProviderProvider } -func (c *MockEvalContext) ProviderSchema(addr addrs.AbsProviderConfig) *ProviderSchema { +func (c *MockEvalContext) ProviderSchema(addr addrs.AbsProviderConfig) (*ProviderSchema, error) { c.ProviderSchemaCalled = true c.ProviderSchemaAddr = addr - return c.ProviderSchemaSchema + return c.ProviderSchemaSchema, c.ProviderSchemaError } func (c *MockEvalContext) CloseProvider(addr addrs.AbsProviderConfig) error { @@ -214,10 +216,10 @@ func (c *MockEvalContext) Provisioner(n string) (provisioners.Interface, error) return c.ProvisionerProvisioner, nil } -func (c *MockEvalContext) ProvisionerSchema(n string) *configschema.Block { +func (c *MockEvalContext) ProvisionerSchema(n string) (*configschema.Block, error) { c.ProvisionerSchemaCalled = true c.ProvisionerSchemaName = n - return c.ProvisionerSchemaSchema + return c.ProvisionerSchemaSchema, c.ProvisionerSchemaError } func (c *MockEvalContext) CloseProvisioners() error { diff --git a/internal/terraform/eval_provider.go b/internal/terraform/eval_provider.go index 31f7b0453a09..a97f347e404f 100644 --- a/internal/terraform/eval_provider.go +++ b/internal/terraform/eval_provider.go @@ -51,6 +51,9 @@ func getProvider(ctx EvalContext, addr addrs.AbsProviderConfig) (providers.Inter } // Not all callers require a schema, so we will leave checking for a nil // schema to the callers. - schema := ctx.ProviderSchema(addr) + schema, err := ctx.ProviderSchema(addr) + if err != nil { + return nil, &ProviderSchema{}, fmt.Errorf("failed to read schema for provider %s: %w", addr, err) + } return provider, schema, nil } diff --git a/internal/terraform/graph_walk_context.go b/internal/terraform/graph_walk_context.go index 3561ab983b55..6fd790e92f3b 100644 --- a/internal/terraform/graph_walk_context.go +++ b/internal/terraform/graph_walk_context.go @@ -92,7 +92,6 @@ func (w *ContextGraphWalker) EvalContext() EvalContext { InputValue: w.Context.uiInput, InstanceExpanderValue: w.InstanceExpander, Plugins: w.Context.plugins, - Schemas: w.Schemas, MoveResultsValue: w.MoveResults, ProviderCache: w.providerCache, ProviderInputConfig: w.Context.providerInputConfig, diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index 9f07068e3901..e73939a8e32d 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -1809,7 +1809,14 @@ func (n *NodeAbstractResourceInstance) applyProvisioners(ctx EvalContext, state return diags.Append(err) } - schema := ctx.ProvisionerSchema(prov.Type) + schema, err := ctx.ProvisionerSchema(prov.Type) + if err != nil { + // This error probably won't be a great diagnostic, but in practice + // we typically catch this problem long before we get here, so + // it should be rare to return via this codepath. + diags = diags.Append(err) + return diags + } config, configDiags := evalScope(ctx, prov.Config, self, schema) diags = diags.Append(configDiags) diff --git a/internal/terraform/node_resource_validate.go b/internal/terraform/node_resource_validate.go index ebf597c066ef..cd4ec91fe80b 100644 --- a/internal/terraform/node_resource_validate.go +++ b/internal/terraform/node_resource_validate.go @@ -77,9 +77,12 @@ func (n *NodeValidatableResource) validateProvisioner(ctx EvalContext, p *config if provisioner == nil { return diags.Append(fmt.Errorf("provisioner %s not initialized", p.Type)) } - provisionerSchema := ctx.ProvisionerSchema(p.Type) + provisionerSchema, err := ctx.ProvisionerSchema(p.Type) + if err != nil { + return diags.Append(fmt.Errorf("failed to read schema for provisioner %s: %s", p.Type, err)) + } if provisionerSchema == nil { - return diags.Append(fmt.Errorf("provisioner %s not initialized", p.Type)) + return diags.Append(fmt.Errorf("provisioner %s has no schema", p.Type)) } // Validate the provisioner's own config first From 38ec730b0e35c5ddd63d64690e123ef6d26371c3 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 16:36:27 -0700 Subject: [PATCH 052/644] core: Opportunistic schema loading during graph construction Previously the graph builders all expected to be given a full manifest of all of the plugin component schemas that they could need during their analysis work. That made sense when terraform.NewContext would always proactively load all of the schemas before doing any other work, but we now have a load-as-needed strategy for schemas. We'll now have the graph builders use the contextPlugins object they each already hold to retrieve individual schemas when needed. This avoids the need to prepare a redundant data structure to pass alongside the contextPlugins object, and leans on the memoization behavior inside contextPlugins to preserve the old behavior of loading each provider's schema only once. --- internal/terraform/context_apply.go | 13 ++---- internal/terraform/context_eval.go | 1 - internal/terraform/context_import.go | 1 - internal/terraform/context_plan.go | 3 -- internal/terraform/context_plugins.go | 34 ++++++++++++++ internal/terraform/context_validate.go | 1 - internal/terraform/context_validate_test.go | 1 - internal/terraform/graph_builder_apply.go | 16 +++---- .../terraform/graph_builder_apply_test.go | 10 ----- .../terraform/graph_builder_destroy_plan.go | 9 +--- internal/terraform/graph_builder_eval.go | 6 +-- internal/terraform/graph_builder_import.go | 6 +-- internal/terraform/graph_builder_plan.go | 6 +-- internal/terraform/graph_builder_plan_test.go | 22 --------- internal/terraform/schemas_test.go | 45 +++++++++++++++++++ internal/terraform/transform_attach_schema.go | 22 ++++++--- internal/terraform/transform_destroy_cbd.go | 5 --- .../terraform/transform_destroy_cbd_test.go | 1 - internal/terraform/transform_destroy_edge.go | 5 --- .../terraform/transform_destroy_edge_test.go | 18 +++----- .../transform_transitive_reduction_test.go | 28 ++++++------ 21 files changed, 126 insertions(+), 127 deletions(-) diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go index 4d5dc890f754..ff32074ec8b2 100644 --- a/internal/terraform/context_apply.go +++ b/internal/terraform/context_apply.go @@ -32,7 +32,7 @@ func (c *Context) Apply(plan *plans.Plan, config *configs.Config) (*states.State log.Printf("[DEBUG] Building and walking apply graph for %s plan", plan.UIMode) - graph, operation, moreDiags := c.applyGraph(plan, config, schemas, true) + graph, operation, moreDiags := c.applyGraph(plan, config, true) if moreDiags.HasErrors() { return nil, diags } @@ -90,13 +90,12 @@ Note that the -target option is not suitable for routine use, and is provided on return newState, diags } -func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, schemas *Schemas, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { +func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { graph, diags := (&ApplyGraphBuilder{ Config: config, Changes: plan.Changes, State: plan.PriorState, Plugins: c.plugins, - Schemas: schemas, Targets: plan.TargetAddrs, ForceReplace: plan.ForceReplaceAddrs, Validate: validate, @@ -130,13 +129,7 @@ func (c *Context) ApplyGraphForUI(plan *plans.Plan, config *configs.Config) (*Gr var diags tfdiags.Diagnostics - schemas, moreDiags := c.Schemas(config, plan.PriorState) - diags = diags.Append(moreDiags) - if diags.HasErrors() { - return nil, diags - } - - graph, _, moreDiags := c.applyGraph(plan, config, schemas, false) + graph, _, moreDiags := c.applyGraph(plan, config, false) diags = diags.Append(moreDiags) return graph, diags } diff --git a/internal/terraform/context_eval.go b/internal/terraform/context_eval.go index ad3deeee1d9d..8201db4d6153 100644 --- a/internal/terraform/context_eval.go +++ b/internal/terraform/context_eval.go @@ -69,7 +69,6 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a Config: config, State: state, Plugins: c.plugins, - Schemas: schemas, }).Build(addrs.RootModuleInstance) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index 8675e06b5f56..f4bc6d809b83 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -64,7 +64,6 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt ImportTargets: opts.Targets, Config: config, Plugins: c.plugins, - Schemas: schemas, } // Build the graph diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 9f9170c8aafc..208ee771c7c4 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -372,7 +372,6 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, Config: config, State: prevRunState, Plugins: c.plugins, - Schemas: schemas, Targets: opts.Targets, ForceReplace: opts.ForceReplace, Validate: validate, @@ -384,7 +383,6 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, Config: config, State: prevRunState, Plugins: c.plugins, - Schemas: schemas, Targets: opts.Targets, Validate: validate, skipRefresh: opts.SkipRefresh, @@ -396,7 +394,6 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, Config: config, State: prevRunState, Plugins: c.plugins, - Schemas: schemas, Targets: opts.Targets, Validate: validate, skipRefresh: opts.SkipRefresh, diff --git a/internal/terraform/context_plugins.go b/internal/terraform/context_plugins.go index 5711badbd758..4fbdf84d0a44 100644 --- a/internal/terraform/context_plugins.go +++ b/internal/terraform/context_plugins.go @@ -134,6 +134,40 @@ func (cp *contextPlugins) ProviderSchema(addr addrs.Provider) (*ProviderSchema, return s, nil } +// ProviderConfigSchema is a helper wrapper around ProviderSchema which first +// reads the full schema of the given provider and then extracts just the +// provider's configuration schema, which defines what's expected in a +// "provider" block in the configuration when configuring this provider. +func (cp *contextPlugins) ProviderConfigSchema(providerAddr addrs.Provider) (*configschema.Block, error) { + providerSchema, err := cp.ProviderSchema(providerAddr) + if err != nil { + return nil, err + } + + return providerSchema.Provider, nil +} + +// ResourceTypeSchema is a helper wrapper around ProviderSchema which first +// reads the schema of the given provider and then tries to find the schema +// for the resource type of the given resource mode in that provider. +// +// ResourceTypeSchema will return an error if the provider schema lookup +// fails, but will return nil if the provider schema lookup succeeds but then +// the provider doesn't have a resource of the requested type. +// +// Managed resource types have versioned schemas, so the second return value +// is the current schema version number for the requested resource. The version +// is irrelevant for other resource modes. +func (cp *contextPlugins) ResourceTypeSchema(providerAddr addrs.Provider, resourceMode addrs.ResourceMode, resourceType string) (*configschema.Block, uint64, error) { + providerSchema, err := cp.ProviderSchema(providerAddr) + if err != nil { + return nil, 0, err + } + + schema, version := providerSchema.SchemaForResourceType(resourceMode, resourceType) + return schema, version, nil +} + // ProvisionerSchema uses a temporary instance of the provisioner with the // given type name to obtain the schema for that provisioner's configuration. // diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go index f95127895231..f5aa8540c26c 100644 --- a/internal/terraform/context_validate.go +++ b/internal/terraform/context_validate.go @@ -46,7 +46,6 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ Config: config, Plugins: c.plugins, - Schemas: schemas, Validate: true, State: states.NewState(), }).Build(addrs.RootModuleInstance) diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index e4eee13b4303..0c5a2a3a5379 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -1201,7 +1201,6 @@ func TestContext2Validate_PlanGraphBuilder(t *testing.T) { Config: fixture.Config, State: states.NewState(), Plugins: c.plugins, - Schemas: schemas, }).Build(addrs.RootModuleInstance) if diags.HasErrors() { t.Fatalf("errors from PlanGraphBuilder: %s", diags.Err()) diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go index ca8e5777fa0c..94f1e7699fb5 100644 --- a/internal/terraform/graph_builder_apply.go +++ b/internal/terraform/graph_builder_apply.go @@ -30,10 +30,6 @@ type ApplyGraphBuilder struct { // provisioners) available for use. Plugins *contextPlugins - // Schemas is the repository of schemas we will draw from to analyse - // the configuration. - Schemas *Schemas - // Targets are resources to target. This is only required to make sure // unnecessary outputs aren't included in the apply graph. The plan // builder successfully handles targeting resources. In the future, @@ -123,7 +119,7 @@ func (b *ApplyGraphBuilder) Steps() []GraphTransformer { // Must attach schemas before ReferenceTransformer so that we can // analyze the configuration to find references. - &AttachSchemaTransformer{Schemas: b.Schemas, Config: b.Config}, + &AttachSchemaTransformer{Plugins: b.Plugins, Config: b.Config}, // Create expansion nodes for all of the module calls. This must // come after all other transformers that create nodes representing @@ -140,14 +136,12 @@ func (b *ApplyGraphBuilder) Steps() []GraphTransformer { // Destruction ordering &DestroyEdgeTransformer{ - Config: b.Config, - State: b.State, - Schemas: b.Schemas, + Config: b.Config, + State: b.State, }, &CBDEdgeTransformer{ - Config: b.Config, - State: b.State, - Schemas: b.Schemas, + Config: b.Config, + State: b.State, }, // We need to remove configuration nodes that are not used at all, as diff --git a/internal/terraform/graph_builder_apply_test.go b/internal/terraform/graph_builder_apply_test.go index 9aaa1650d859..e1aba8d2c136 100644 --- a/internal/terraform/graph_builder_apply_test.go +++ b/internal/terraform/graph_builder_apply_test.go @@ -49,7 +49,6 @@ func TestApplyGraphBuilder(t *testing.T) { Config: testModule(t, "graph-builder-apply-basic"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), } g, err := b.Build(addrs.RootModuleInstance) @@ -113,7 +112,6 @@ func TestApplyGraphBuilder_depCbd(t *testing.T) { Config: testModule(t, "graph-builder-apply-dep-cbd"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), State: state, } @@ -187,7 +185,6 @@ func TestApplyGraphBuilder_doubleCBD(t *testing.T) { Config: testModule(t, "graph-builder-apply-double-cbd"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), } g, err := b.Build(addrs.RootModuleInstance) @@ -282,7 +279,6 @@ func TestApplyGraphBuilder_destroyStateOnly(t *testing.T) { Changes: changes, State: state, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), } g, diags := b.Build(addrs.RootModuleInstance) @@ -344,7 +340,6 @@ func TestApplyGraphBuilder_destroyCount(t *testing.T) { Config: testModule(t, "graph-builder-apply-count"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), State: state, } @@ -407,7 +402,6 @@ func TestApplyGraphBuilder_moduleDestroy(t *testing.T) { Config: testModule(t, "graph-builder-apply-module-destroy"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), State: state, } @@ -445,7 +439,6 @@ func TestApplyGraphBuilder_targetModule(t *testing.T) { Config: testModule(t, "graph-builder-apply-target-module"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child2", addrs.NoKey), }, @@ -542,7 +535,6 @@ func TestApplyGraphBuilder_updateFromOrphan(t *testing.T) { Config: testModule(t, "graph-builder-apply-orphan-update"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: schemas, State: state, } @@ -643,7 +635,6 @@ func TestApplyGraphBuilder_updateFromCBDOrphan(t *testing.T) { Config: testModule(t, "graph-builder-apply-orphan-update"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: schemas, State: state, } @@ -694,7 +685,6 @@ func TestApplyGraphBuilder_orphanedWithProvider(t *testing.T) { Config: testModule(t, "graph-builder-orphan-alias"), Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), State: state, } diff --git a/internal/terraform/graph_builder_destroy_plan.go b/internal/terraform/graph_builder_destroy_plan.go index 55bae82fdd35..0bac6305e08f 100644 --- a/internal/terraform/graph_builder_destroy_plan.go +++ b/internal/terraform/graph_builder_destroy_plan.go @@ -27,10 +27,6 @@ type DestroyPlanGraphBuilder struct { // provisioners) available for use. Plugins *contextPlugins - // Schemas is the repository of schemas we will draw from to analyse - // the configuration. - Schemas *Schemas - // Targets are resources to target Targets []addrs.Targetable @@ -99,9 +95,8 @@ func (b *DestroyPlanGraphBuilder) Steps() []GraphTransformer { // Destruction ordering. We require this only so that // targeting below will prune the correct things. &DestroyEdgeTransformer{ - Config: b.Config, - State: b.State, - Schemas: b.Schemas, + Config: b.Config, + State: b.State, }, &TargetsTransformer{Targets: b.Targets}, diff --git a/internal/terraform/graph_builder_eval.go b/internal/terraform/graph_builder_eval.go index f413dd7fea52..ee9d6b8e83de 100644 --- a/internal/terraform/graph_builder_eval.go +++ b/internal/terraform/graph_builder_eval.go @@ -33,10 +33,6 @@ type EvalGraphBuilder struct { // Plugins is a library of plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins - - // Schemas is the repository of schemas we will draw from to analyse - // the configuration. - Schemas *Schemas } // See GraphBuilder @@ -79,7 +75,7 @@ func (b *EvalGraphBuilder) Steps() []GraphTransformer { // Must attach schemas before ReferenceTransformer so that we can // analyze the configuration to find references. - &AttachSchemaTransformer{Schemas: b.Schemas, Config: b.Config}, + &AttachSchemaTransformer{Plugins: b.Plugins, Config: b.Config}, // Create expansion nodes for all of the module calls. This must // come after all other transformers that create nodes representing diff --git a/internal/terraform/graph_builder_import.go b/internal/terraform/graph_builder_import.go index d502b131ec69..9910354cf5f9 100644 --- a/internal/terraform/graph_builder_import.go +++ b/internal/terraform/graph_builder_import.go @@ -20,10 +20,6 @@ type ImportGraphBuilder struct { // Plugins is a library of plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins - - // Schemas is the repository of schemas we will draw from to analyse - // the configuration. - Schemas *Schemas } // Build builds the graph according to the steps returned by Steps. @@ -72,7 +68,7 @@ func (b *ImportGraphBuilder) Steps() []GraphTransformer { // Must attach schemas before ReferenceTransformer so that we can // analyze the configuration to find references. - &AttachSchemaTransformer{Schemas: b.Schemas, Config: b.Config}, + &AttachSchemaTransformer{Plugins: b.Plugins, Config: b.Config}, // Create expansion nodes for all of the module calls. This must // come after all other transformers that create nodes representing diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index e0a355d47f3c..b267f9c428c7 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -32,10 +32,6 @@ type PlanGraphBuilder struct { // provisioners) available for use. Plugins *contextPlugins - // Schemas is the repository of schemas we will draw from to analyse - // the configuration. - Schemas *Schemas - // Targets are resources to target Targets []addrs.Targetable @@ -137,7 +133,7 @@ func (b *PlanGraphBuilder) Steps() []GraphTransformer { // Must attach schemas before ReferenceTransformer so that we can // analyze the configuration to find references. - &AttachSchemaTransformer{Schemas: b.Schemas, Config: b.Config}, + &AttachSchemaTransformer{Plugins: b.Plugins, Config: b.Config}, // Create expansion nodes for all of the module calls. This must // come after all other transformers that create nodes representing diff --git a/internal/terraform/graph_builder_plan_test.go b/internal/terraform/graph_builder_plan_test.go index c5aa9a455914..689f9faff3db 100644 --- a/internal/terraform/graph_builder_plan_test.go +++ b/internal/terraform/graph_builder_plan_test.go @@ -34,12 +34,6 @@ func TestPlanGraphBuilder(t *testing.T) { b := &PlanGraphBuilder{ Config: testModule(t, "graph-builder-plan-basic"), Plugins: plugins, - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("aws"): awsProvider.ProviderSchema(), - addrs.NewDefaultProvider("openstack"): openstackProvider.ProviderSchema(), - }, - }, } g, err := b.Build(addrs.RootModuleInstance) @@ -82,11 +76,6 @@ func TestPlanGraphBuilder_dynamicBlock(t *testing.T) { b := &PlanGraphBuilder{ Config: testModule(t, "graph-builder-plan-dynblock"), Plugins: plugins, - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("test"): provider.ProviderSchema(), - }, - }, } g, err := b.Build(addrs.RootModuleInstance) @@ -145,11 +134,6 @@ func TestPlanGraphBuilder_attrAsBlocks(t *testing.T) { b := &PlanGraphBuilder{ Config: testModule(t, "graph-builder-plan-attr-as-blocks"), Plugins: plugins, - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("test"): provider.ProviderSchema(), - }, - }, } g, err := b.Build(addrs.RootModuleInstance) @@ -190,7 +174,6 @@ func TestPlanGraphBuilder_targetModule(t *testing.T) { b := &PlanGraphBuilder{ Config: testModule(t, "graph-builder-plan-target-module-provider"), Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), Targets: []addrs.Targetable{ addrs.RootModuleInstance.Child("child2", addrs.NoKey), }, @@ -217,11 +200,6 @@ func TestPlanGraphBuilder_forEach(t *testing.T) { b := &PlanGraphBuilder{ Config: testModule(t, "plan-for-each"), Plugins: plugins, - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("aws"): awsProvider.ProviderSchema(), - }, - }, } g, err := b.Build(addrs.RootModuleInstance) diff --git a/internal/terraform/schemas_test.go b/internal/terraform/schemas_test.go index 00b6438eebab..044b795a50a9 100644 --- a/internal/terraform/schemas_test.go +++ b/internal/terraform/schemas_test.go @@ -3,6 +3,7 @@ package terraform import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/providers" ) func simpleTestSchemas() *Schemas { @@ -18,3 +19,47 @@ func simpleTestSchemas() *Schemas { }, } } + +// schemaOnlyProvidersForTesting is a testing helper that constructs a +// plugin library that contains a set of providers that only know how to +// return schema, and will exhibit undefined behavior if used for any other +// purpose. +// +// The intended use for this is in testing components that use schemas to +// drive other behavior, such as reference analysis during graph construction, +// but that don't actually need to interact with providers otherwise. +func schemaOnlyProvidersForTesting(schemas map[addrs.Provider]*ProviderSchema) *contextPlugins { + factories := make(map[addrs.Provider]providers.Factory, len(schemas)) + + for providerAddr, schema := range schemas { + + resp := &providers.GetProviderSchemaResponse{ + Provider: providers.Schema{ + Block: schema.Provider, + }, + ResourceTypes: make(map[string]providers.Schema), + DataSources: make(map[string]providers.Schema), + } + for t, tSchema := range schema.ResourceTypes { + resp.ResourceTypes[t] = providers.Schema{ + Block: tSchema, + Version: int64(schema.ResourceTypeSchemaVersions[t]), + } + } + for t, tSchema := range schema.DataSources { + resp.DataSources[t] = providers.Schema{ + Block: tSchema, + } + } + + provider := &MockProvider{ + GetProviderSchemaResponse: resp, + } + + factories[providerAddr] = func() (providers.Interface, error) { + return provider, nil + } + } + + return newContextPlugins(factories, nil) +} diff --git a/internal/terraform/transform_attach_schema.go b/internal/terraform/transform_attach_schema.go index b013931f1816..8f7a59083348 100644 --- a/internal/terraform/transform_attach_schema.go +++ b/internal/terraform/transform_attach_schema.go @@ -43,15 +43,15 @@ type GraphNodeAttachProvisionerSchema interface { // GraphNodeAttachProvisionerSchema, looks up the needed schemas for each // and then passes them to a method implemented by the node. type AttachSchemaTransformer struct { - Schemas *Schemas + Plugins *contextPlugins Config *configs.Config } func (t *AttachSchemaTransformer) Transform(g *Graph) error { - if t.Schemas == nil { + if t.Plugins == nil { // Should never happen with a reasonable caller, but we'll return a // proper error here anyway so that we'll fail gracefully. - return fmt.Errorf("AttachSchemaTransformer used with nil Schemas") + return fmt.Errorf("AttachSchemaTransformer used with nil Plugins") } for _, v := range g.Vertices() { @@ -62,7 +62,10 @@ func (t *AttachSchemaTransformer) Transform(g *Graph) error { typeName := addr.Resource.Type providerFqn := tv.Provider() - schema, version := t.Schemas.ResourceTypeConfig(providerFqn, mode, typeName) + schema, version, err := t.Plugins.ResourceTypeSchema(providerFqn, mode, typeName) + if err != nil { + return fmt.Errorf("failed to read schema for %s in %s: %s", addr, providerFqn, err) + } if schema == nil { log.Printf("[ERROR] AttachSchemaTransformer: No resource schema available for %s", addr) continue @@ -73,8 +76,10 @@ func (t *AttachSchemaTransformer) Transform(g *Graph) error { if tv, ok := v.(GraphNodeAttachProviderConfigSchema); ok { providerAddr := tv.ProviderAddr() - schema := t.Schemas.ProviderConfig(providerAddr.Provider) - + schema, err := t.Plugins.ProviderConfigSchema(providerAddr.Provider) + if err != nil { + return fmt.Errorf("failed to read provider configuration schema for %s: %s", providerAddr.Provider, err) + } if schema == nil { log.Printf("[ERROR] AttachSchemaTransformer: No provider config schema available for %s", providerAddr) continue @@ -86,7 +91,10 @@ func (t *AttachSchemaTransformer) Transform(g *Graph) error { if tv, ok := v.(GraphNodeAttachProvisionerSchema); ok { names := tv.ProvisionedBy() for _, name := range names { - schema := t.Schemas.ProvisionerConfig(name) + schema, err := t.Plugins.ProvisionerSchema(name) + if err != nil { + return fmt.Errorf("failed to read provisioner configuration schema for %q: %s", name, err) + } if schema == nil { log.Printf("[ERROR] AttachSchemaTransformer: No schema available for provisioner %q on %q", name, dag.VertexName(v)) continue diff --git a/internal/terraform/transform_destroy_cbd.go b/internal/terraform/transform_destroy_cbd.go index 5650d1a92d71..cc6c2c15db0a 100644 --- a/internal/terraform/transform_destroy_cbd.go +++ b/internal/terraform/transform_destroy_cbd.go @@ -115,11 +115,6 @@ type CBDEdgeTransformer struct { // any way possible. Either can be nil if not availabile. Config *configs.Config State *states.State - - // If configuration is present then Schemas is required in order to - // obtain schema information from providers and provisioners so we can - // properly resolve implicit dependencies. - Schemas *Schemas } func (t *CBDEdgeTransformer) Transform(g *Graph) error { diff --git a/internal/terraform/transform_destroy_cbd_test.go b/internal/terraform/transform_destroy_cbd_test.go index a66243f540b3..629ca54778be 100644 --- a/internal/terraform/transform_destroy_cbd_test.go +++ b/internal/terraform/transform_destroy_cbd_test.go @@ -17,7 +17,6 @@ func cbdTestGraph(t *testing.T, mod string, changes *plans.Changes, state *state Config: module, Changes: changes, Plugins: simpleMockPluginLibrary(), - Schemas: simpleTestSchemas(), State: state, } g, err := (&BasicGraphBuilder{ diff --git a/internal/terraform/transform_destroy_edge.go b/internal/terraform/transform_destroy_edge.go index 83ebb075868d..521acced02e7 100644 --- a/internal/terraform/transform_destroy_edge.go +++ b/internal/terraform/transform_destroy_edge.go @@ -45,11 +45,6 @@ type DestroyEdgeTransformer struct { // to determine what a destroy node depends on. Any of these can be nil. Config *configs.Config State *states.State - - // If configuration is present then Schemas is required in order to - // obtain schema information from providers and provisioners in order - // to properly resolve implicit dependencies. - Schemas *Schemas } func (t *DestroyEdgeTransformer) Transform(g *Graph) error { diff --git a/internal/terraform/transform_destroy_edge_test.go b/internal/terraform/transform_destroy_edge_test.go index 902baec4f3ae..a5176a3cc7d3 100644 --- a/internal/terraform/transform_destroy_edge_test.go +++ b/internal/terraform/transform_destroy_edge_test.go @@ -38,8 +38,7 @@ func TestDestroyEdgeTransformer_basic(t *testing.T) { } tf := &DestroyEdgeTransformer{ - Config: testModule(t, "transform-destroy-edge-basic"), - Schemas: simpleTestSchemas(), + Config: testModule(t, "transform-destroy-edge-basic"), } if err := tf.Transform(&g); err != nil { t.Fatalf("err: %s", err) @@ -95,8 +94,7 @@ func TestDestroyEdgeTransformer_multi(t *testing.T) { } tf := &DestroyEdgeTransformer{ - Config: testModule(t, "transform-destroy-edge-multi"), - Schemas: simpleTestSchemas(), + Config: testModule(t, "transform-destroy-edge-multi"), } if err := tf.Transform(&g); err != nil { t.Fatalf("err: %s", err) @@ -113,8 +111,7 @@ func TestDestroyEdgeTransformer_selfRef(t *testing.T) { g := Graph{Path: addrs.RootModuleInstance} g.Add(testDestroyNode("test_object.A")) tf := &DestroyEdgeTransformer{ - Config: testModule(t, "transform-destroy-edge-self-ref"), - Schemas: simpleTestSchemas(), + Config: testModule(t, "transform-destroy-edge-self-ref"), } if err := tf.Transform(&g); err != nil { t.Fatalf("err: %s", err) @@ -157,8 +154,7 @@ func TestDestroyEdgeTransformer_module(t *testing.T) { } tf := &DestroyEdgeTransformer{ - Config: testModule(t, "transform-destroy-edge-module"), - Schemas: simpleTestSchemas(), + Config: testModule(t, "transform-destroy-edge-module"), } if err := tf.Transform(&g); err != nil { t.Fatalf("err: %s", err) @@ -219,8 +215,7 @@ func TestDestroyEdgeTransformer_moduleOnly(t *testing.T) { } tf := &DestroyEdgeTransformer{ - Config: testModule(t, "transform-destroy-edge-module-only"), - Schemas: simpleTestSchemas(), + Config: testModule(t, "transform-destroy-edge-module-only"), } if err := tf.Transform(&g); err != nil { t.Fatalf("err: %s", err) @@ -297,8 +292,7 @@ resource "test_instance" "a" { `, }) tf := &DestroyEdgeTransformer{ - Config: m, - Schemas: simpleTestSchemas(), + Config: m, } if err := tf.Transform(&g); err != nil { t.Fatalf("err: %s", err) diff --git a/internal/terraform/transform_transitive_reduction_test.go b/internal/terraform/transform_transitive_reduction_test.go index e1e744b15533..1339d071fec2 100644 --- a/internal/terraform/transform_transitive_reduction_test.go +++ b/internal/terraform/transform_transitive_reduction_test.go @@ -30,26 +30,24 @@ func TestTransitiveReductionTransformer(t *testing.T) { { transform := &AttachSchemaTransformer{ - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("aws"): { - ResourceTypes: map[string]*configschema.Block{ - "aws_instance": &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "A": { - Type: cty.String, - Optional: true, - }, - "B": { - Type: cty.String, - Optional: true, - }, + Plugins: schemaOnlyProvidersForTesting(map[addrs.Provider]*ProviderSchema{ + addrs.NewDefaultProvider("aws"): { + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "A": { + Type: cty.String, + Optional: true, + }, + "B": { + Type: cty.String, + Optional: true, }, }, }, }, }, - }, + }), } if err := transform.Transform(&g); err != nil { t.Fatalf("err: %s", err) From 343279110a461ce455b30e291768b2522d39bbf8 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 31 Aug 2021 17:53:03 -0700 Subject: [PATCH 053/644] core: Graph walk loads plugin schemas opportunistically Previously our graph walker expected to recieve a data structure containing schemas for all of the provider and provisioner plugins used in the configuration and state. That made sense back when terraform.NewContext was responsible for loading all of the schemas before taking any other action, but it no longer has that responsiblity. Instead, we'll now make sure that the "contextPlugins" object reaches all of the locations where we need schema -- many of which already had access to that object anyway -- and then load the needed schemas just in time. The contextPlugins object memoizes schema lookups, so we can safely call it many times with the same provider address or provisioner type name and know that it'll still only load each distinct plugin once per Context object. As of this commit, the Context.Schemas method is now a public interface only and not used by logic in the "terraform" package at all. However, that does leave us in a rather tenuous situation of relying on the fact that all practical users of terraform.Context end up calling "Schemas" at some point in order to verify that we have all of the expected versions of plugins. That's a non-obvious implicit dependency, and so in subsequent commits we'll gradually move all responsibility for verifying plugin versions into the caller of terraform.NewContext, which'll heal a long-standing architectural wart whereby the caller is responsible for installing and locating the plugin executables but not for verifying that what's installed is conforming to the current configuration and dependency lock file. --- internal/backend/local/backend_plan_test.go | 2 +- internal/command/plan_test.go | 2 +- internal/terraform/context_apply.go | 7 -- internal/terraform/context_eval.go | 7 -- internal/terraform/context_import.go | 7 -- internal/terraform/context_plan.go | 19 +--- internal/terraform/context_test.go | 4 + internal/terraform/context_validate.go | 7 -- internal/terraform/context_validate_test.go | 7 +- internal/terraform/context_walk.go | 8 -- internal/terraform/evaluate.go | 21 ++-- internal/terraform/evaluate_test.go | 108 ++++++++++---------- internal/terraform/evaluate_valid.go | 13 ++- internal/terraform/evaluate_valid_test.go | 22 ++-- internal/terraform/graph_walk_context.go | 3 +- 15 files changed, 99 insertions(+), 138 deletions(-) diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 5866048f9f0a..73bd78df4d79 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -136,7 +136,7 @@ func TestLocal_plan_context_error(t *testing.T) { // the backend should be unlocked after a run assertBackendStateUnlocked(t, b) - if got, want := done(t).Stderr(), "Error: Failed to load plugin schemas"; !strings.Contains(got, want) { + if got, want := done(t).Stderr(), "failed to read schema for test_instance.foo in registry.terraform.io/hashicorp/test"; !strings.Contains(got, want) { t.Fatalf("unexpected error output:\n%s\nwant: %s", got, want) } } diff --git a/internal/command/plan_test.go b/internal/command/plan_test.go index 5638a9abfd3f..880f2e971e98 100644 --- a/internal/command/plan_test.go +++ b/internal/command/plan_test.go @@ -1051,7 +1051,7 @@ func TestPlan_init_required(t *testing.T) { t.Fatalf("expected error, got success") } got := output.Stderr() - if !strings.Contains(got, `Please run "terraform init".`) { + if !strings.Contains(got, `failed to read schema for test_instance.foo in registry.terraform.io/hashicorp/test`) { t.Fatal("wrong error message in output:", got) } } diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go index ff32074ec8b2..e94449b7261d 100644 --- a/internal/terraform/context_apply.go +++ b/internal/terraform/context_apply.go @@ -24,12 +24,6 @@ func (c *Context) Apply(plan *plans.Plan, config *configs.Config) (*states.State defer c.acquireRun("apply")() var diags tfdiags.Diagnostics - schemas, moreDiags := c.Schemas(config, plan.PriorState) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - return nil, diags - } - log.Printf("[DEBUG] Building and walking apply graph for %s plan", plan.UIMode) graph, operation, moreDiags := c.applyGraph(plan, config, true) @@ -58,7 +52,6 @@ func (c *Context) Apply(plan *plans.Plan, config *configs.Config) (*states.State workingState := plan.PriorState.DeepCopy() walker, walkDiags := c.walk(graph, operation, &graphWalkOpts{ Config: config, - Schemas: schemas, InputState: workingState, Changes: plan.Changes, RootVariableValues: variables, diff --git a/internal/terraform/context_eval.go b/internal/terraform/context_eval.go index 8201db4d6153..efc24767c205 100644 --- a/internal/terraform/context_eval.go +++ b/internal/terraform/context_eval.go @@ -40,12 +40,6 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a var diags tfdiags.Diagnostics defer c.acquireRun("eval")() - schemas, moreDiags := c.Schemas(config, state) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - return nil, diags - } - // Start with a copy of state so that we don't affect the instance that // the caller is holding. state = state.DeepCopy() @@ -78,7 +72,6 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a walkOpts := &graphWalkOpts{ InputState: state, Config: config, - Schemas: schemas, RootVariableValues: variables, } diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index f4bc6d809b83..af17cbd62dc8 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -48,12 +48,6 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt // Hold a lock since we can modify our own state here defer c.acquireRun("import")() - schemas, moreDiags := c.Schemas(config, prevRunState) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - return nil, diags - } - // Don't modify our caller's state state := prevRunState.DeepCopy() @@ -78,7 +72,6 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt // Walk it walker, walkDiags := c.walk(graph, walkImport, &graphWalkOpts{ Config: config, - Schemas: schemas, InputState: state, RootVariableValues: variables, }) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 208ee771c7c4..248673254cf0 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -324,16 +324,10 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r var diags tfdiags.Diagnostics log.Printf("[DEBUG] Building and walking plan graph for %s", opts.Mode) - schemas, moreDiags := c.Schemas(config, prevRunState) - diags = diags.Append(moreDiags) - if diags.HasErrors() { - return nil, diags - } - prevRunState = prevRunState.DeepCopy() // don't modify the caller's object when we process the moves moveStmts, moveResults := c.prePlanFindAndApplyMoves(config, prevRunState, opts.Targets) - graph, walkOp, moreDiags := c.planGraph(config, prevRunState, opts, schemas, true) + graph, walkOp, moreDiags := c.planGraph(config, prevRunState, opts, true) diags = diags.Append(moreDiags) if diags.HasErrors() { return nil, diags @@ -344,7 +338,6 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r changes := plans.NewChanges() walker, walkDiags := c.walk(graph, walkOp, &graphWalkOpts{ Config: config, - Schemas: schemas, InputState: prevRunState, Changes: changes, MoveResults: moveResults, @@ -365,7 +358,7 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r return plan, diags } -func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, opts *PlanOpts, schemas *Schemas, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { +func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, opts *PlanOpts, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { switch mode := opts.Mode; mode { case plans.NormalMode: graph, diags := (&PlanGraphBuilder{ @@ -421,13 +414,7 @@ func (c *Context) PlanGraphForUI(config *configs.Config, prevRunState *states.St opts := &PlanOpts{Mode: mode} - schemas, moreDiags := c.Schemas(config, prevRunState) - diags = diags.Append(moreDiags) - if diags.HasErrors() { - return nil, diags - } - - graph, _, moreDiags := c.planGraph(config, prevRunState, opts, schemas, false) + graph, _, moreDiags := c.planGraph(config, prevRunState, opts, false) diags = diags.Append(moreDiags) return graph, diags } diff --git a/internal/terraform/context_test.go b/internal/terraform/context_test.go index 47fd32f4bc15..02addb4dbf68 100644 --- a/internal/terraform/context_test.go +++ b/internal/terraform/context_test.go @@ -123,6 +123,10 @@ func TestNewContextRequiredVersion(t *testing.T) { } func TestNewContext_lockedDependencies(t *testing.T) { + // TODO: Remove this test altogether once we've factored out the version + // and checksum verification to be exclusively the caller's responsibility. + t.Skip("only one step away from locked dependencies being the caller's responsibility") + configBeepGreaterThanOne := ` terraform { required_providers { diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go index f5aa8540c26c..b079477bafee 100644 --- a/internal/terraform/context_validate.go +++ b/internal/terraform/context_validate.go @@ -35,12 +35,6 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { return diags } - schemas, moreDiags := c.Schemas(config, nil) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - return diags - } - log.Printf("[DEBUG] Building and walking validate graph") graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ @@ -74,7 +68,6 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { walker, walkDiags := c.walk(graph, walkValidate, &graphWalkOpts{ Config: config, - Schemas: schemas, RootVariableValues: varValues, }) diags = diags.Append(walker.NonFatalDiagnostics) diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index 0c5a2a3a5379..4f628945e144 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -1193,10 +1193,6 @@ func TestContext2Validate_PlanGraphBuilder(t *testing.T) { opts := fixture.ContextOpts() c := testContext2(t, opts) - state := states.NewState() - schemas, diags := c.Schemas(fixture.Config, state) - assertNoDiagnostics(t, diags) - graph, diags := ValidateGraphBuilder(&PlanGraphBuilder{ Config: fixture.Config, State: states.NewState(), @@ -1207,8 +1203,7 @@ func TestContext2Validate_PlanGraphBuilder(t *testing.T) { } defer c.acquireRun("validate-test")() walker, diags := c.walk(graph, walkValidate, &graphWalkOpts{ - Config: fixture.Config, - Schemas: schemas, + Config: fixture.Config, }) if diags.HasErrors() { t.Fatal(diags.Err()) diff --git a/internal/terraform/context_walk.go b/internal/terraform/context_walk.go index b44a5910c5d5..e041f80b2e43 100644 --- a/internal/terraform/context_walk.go +++ b/internal/terraform/context_walk.go @@ -23,7 +23,6 @@ type graphWalkOpts struct { InputState *states.State Changes *plans.Changes Config *configs.Config - Schemas *Schemas RootVariableValues InputValues MoveResults map[addrs.UniqueKey]refactoring.MoveResult @@ -95,12 +94,6 @@ func (c *Context) graphWalker(operation walkOperation, opts *graphWalkOpts) *Con changes = plans.NewChanges() } - if opts.Schemas == nil { - // Should never happen: caller must always set this one. - // (We catch this here, rather than later, to get a more intelligible - // stack trace when it _does_ panic.) - panic("Context.graphWalker call without Schemas") - } if opts.Config == nil { panic("Context.graphWalker call without Config") } @@ -109,7 +102,6 @@ func (c *Context) graphWalker(operation walkOperation, opts *graphWalkOpts) *Con Context: c, State: state, Config: opts.Config, - Schemas: opts.Schemas, RefreshState: refreshState, PrevRunState: prevRunState, Changes: changes.SyncWrapper(), diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index efcc9c1f418a..47889a9a477d 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -46,13 +46,13 @@ type Evaluator struct { VariableValues map[string]map[string]cty.Value VariableValuesLock *sync.Mutex - // Schemas is a repository of all of the schemas we should need to - // evaluate expressions. This must be constructed by the caller to - // include schemas for all of the providers, resource types, data sources - // and provisioners used by the given configuration and state. + // Plugins is the library of available plugin components (providers and + // provisioners) that we have available to help us evaluate expressions + // that interact with plugin-provided objects. // - // This must not be mutated during evaluation. - Schemas *Schemas + // From this we only access the schemas of the plugins, and don't otherwise + // interact with plugin instances. + Plugins *contextPlugins // State is the current state, embedded in a wrapper that ensures that // it can be safely accessed and modified concurrently. @@ -892,8 +892,13 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc } func (d *evaluationStateData) getResourceSchema(addr addrs.Resource, providerAddr addrs.AbsProviderConfig) *configschema.Block { - schemas := d.Evaluator.Schemas - schema, _ := schemas.ResourceTypeConfig(providerAddr.Provider, addr.Mode, addr.Type) + schema, _, err := d.Evaluator.Plugins.ResourceTypeSchema(providerAddr.Provider, addr.Mode, addr.Type) + if err != nil { + // We have plently other codepaths that will detect and report + // schema lookup errors before we'd reach this point, so we'll just + // treat a failure here the same as having no schema. + return nil + } return schema } diff --git a/internal/terraform/evaluate_test.go b/internal/terraform/evaluate_test.go index f8a46d4fce1e..ffd067f3fe0b 100644 --- a/internal/terraform/evaluate_test.go +++ b/internal/terraform/evaluate_test.go @@ -193,79 +193,77 @@ func TestEvaluatorGetResource(t *testing.T) { }, }, State: stateSync, - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("test"): { - Provider: &configschema.Block{}, - ResourceTypes: map[string]*configschema.Block{ - "test_resource": { - Attributes: map[string]*configschema.Attribute{ - "id": { - Type: cty.String, - Computed: true, - }, - "value": { - Type: cty.String, - Computed: true, - Sensitive: true, - }, + Plugins: schemaOnlyProvidersForTesting(map[addrs.Provider]*ProviderSchema{ + addrs.NewDefaultProvider("test"): { + Provider: &configschema.Block{}, + ResourceTypes: map[string]*configschema.Block{ + "test_resource": { + Attributes: map[string]*configschema.Attribute{ + "id": { + Type: cty.String, + Computed: true, }, - BlockTypes: map[string]*configschema.NestedBlock{ - "nesting_list": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "value": {Type: cty.String, Optional: true}, - "sensitive_value": {Type: cty.String, Optional: true, Sensitive: true}, - }, + "value": { + Type: cty.String, + Computed: true, + Sensitive: true, + }, + }, + BlockTypes: map[string]*configschema.NestedBlock{ + "nesting_list": { + Block: configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "value": {Type: cty.String, Optional: true}, + "sensitive_value": {Type: cty.String, Optional: true, Sensitive: true}, }, - Nesting: configschema.NestingList, }, - "nesting_map": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "foo": {Type: cty.String, Optional: true, Sensitive: true}, - }, + Nesting: configschema.NestingList, + }, + "nesting_map": { + Block: configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true, Sensitive: true}, }, - Nesting: configschema.NestingMap, }, - "nesting_set": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "baz": {Type: cty.String, Optional: true, Sensitive: true}, - }, + Nesting: configschema.NestingMap, + }, + "nesting_set": { + Block: configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "baz": {Type: cty.String, Optional: true, Sensitive: true}, }, - Nesting: configschema.NestingSet, }, - "nesting_single": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "boop": {Type: cty.String, Optional: true, Sensitive: true}, - }, + Nesting: configschema.NestingSet, + }, + "nesting_single": { + Block: configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "boop": {Type: cty.String, Optional: true, Sensitive: true}, }, - Nesting: configschema.NestingSingle, }, - "nesting_nesting": { - Block: configschema.Block{ - BlockTypes: map[string]*configschema.NestedBlock{ - "nesting_list": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "value": {Type: cty.String, Optional: true}, - "sensitive_value": {Type: cty.String, Optional: true, Sensitive: true}, - }, + Nesting: configschema.NestingSingle, + }, + "nesting_nesting": { + Block: configschema.Block{ + BlockTypes: map[string]*configschema.NestedBlock{ + "nesting_list": { + Block: configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "value": {Type: cty.String, Optional: true}, + "sensitive_value": {Type: cty.String, Optional: true, Sensitive: true}, }, - Nesting: configschema.NestingList, }, + Nesting: configschema.NestingList, }, }, - Nesting: configschema.NestingSingle, }, + Nesting: configschema.NestingSingle, }, }, }, }, }, - }, + }), } data := &evaluationStateData{ @@ -430,7 +428,7 @@ func TestEvaluatorGetResource_changes(t *testing.T) { }, }, State: stateSync, - Schemas: schemas, + Plugins: schemaOnlyProvidersForTesting(schemas.Providers), } data := &evaluationStateData{ diff --git a/internal/terraform/evaluate_valid.go b/internal/terraform/evaluate_valid.go index 68943a84205c..232f6913da77 100644 --- a/internal/terraform/evaluate_valid.go +++ b/internal/terraform/evaluate_valid.go @@ -224,7 +224,18 @@ func (d *evaluationStateData) staticValidateResourceReference(modCfg *configs.Co } providerFqn := modCfg.Module.ProviderForLocalConfig(cfg.ProviderConfigAddr()) - schema, _ := d.Evaluator.Schemas.ResourceTypeConfig(providerFqn, addr.Mode, addr.Type) + schema, _, err := d.Evaluator.Plugins.ResourceTypeSchema(providerFqn, addr.Mode, addr.Type) + if err != nil { + // Prior validation should've taken care of a schema lookup error, + // so we should never get here but we'll handle it here anyway for + // robustness. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Failed provider schema lookup`, + Detail: fmt.Sprintf(`Couldn't load schema for %s resource type %q in %s: %s.`, modeAdjective, addr.Type, providerFqn.String(), err), + Subject: rng.ToHCL().Ptr(), + }) + } if schema == nil { // Prior validation should've taken care of a resource block with an diff --git a/internal/terraform/evaluate_valid_test.go b/internal/terraform/evaluate_valid_test.go index ff8ca4397aec..cfdfdea1f5e1 100644 --- a/internal/terraform/evaluate_valid_test.go +++ b/internal/terraform/evaluate_valid_test.go @@ -69,21 +69,19 @@ For example, to correlate with indices of a referring resource, use: cfg := testModule(t, "static-validate-refs") evaluator := &Evaluator{ Config: cfg, - Schemas: &Schemas{ - Providers: map[addrs.Provider]*ProviderSchema{ - addrs.NewDefaultProvider("aws"): { - ResourceTypes: map[string]*configschema.Block{ - "aws_instance": {}, - }, + Plugins: schemaOnlyProvidersForTesting(map[addrs.Provider]*ProviderSchema{ + addrs.NewDefaultProvider("aws"): { + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": {}, }, - addrs.MustParseProviderSourceString("foobar/beep"): { - ResourceTypes: map[string]*configschema.Block{ - // intentional mismatch between resource type prefix and provider type - "boop_instance": {}, - }, + }, + addrs.MustParseProviderSourceString("foobar/beep"): { + ResourceTypes: map[string]*configschema.Block{ + // intentional mismatch between resource type prefix and provider type + "boop_instance": {}, }, }, - }, + }), } for _, test := range tests { diff --git a/internal/terraform/graph_walk_context.go b/internal/terraform/graph_walk_context.go index 6fd790e92f3b..39a97032c555 100644 --- a/internal/terraform/graph_walk_context.go +++ b/internal/terraform/graph_walk_context.go @@ -34,7 +34,6 @@ type ContextGraphWalker struct { Operation walkOperation StopContext context.Context RootVariableValues InputValues - Schemas *Schemas Config *configs.Config // This is an output. Do not set this, nor read it while a graph walk @@ -81,7 +80,7 @@ func (w *ContextGraphWalker) EvalContext() EvalContext { Operation: w.Operation, State: w.State, Changes: w.Changes, - Schemas: w.Schemas, + Plugins: w.Context.plugins, VariableValues: w.variableValues, VariableValuesLock: &w.variableValuesLock, } From 65e0c448a0e38307d1a08e1af062f03c0d16a12d Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 1 Sep 2021 17:01:44 -0700 Subject: [PATCH 054/644] workdir: Start of a new package for working directory state management Thus far our various interactions with the bits of state we keep associated with a working directory have all been implemented directly inside the "command" package -- often in the huge command.Meta type -- and not managed collectively via a single component. There's too many little codepaths reading and writing from the working directory and data directory to refactor it all in one step, but this is an attempt at a first step towards a future where everything that reads and writes from the current working directory would do so via an object that encapsulates the implementation details and offers a high-level API to read and write all of these session-persistent settings. The design here continues our gradual path towards using a dependency injection style where "package main" is solely responsible for directly interacting with the OS command line, the OS environment, the OS working directory, the stdio streams, and the CLI configuration, and then communicating the resulting information to the rest of Terraform by wiring together objects. It seems likely that eventually we'll have enough wiring code in package main to justify a more explicit organization of that code, but for this commit the new "workdir.Dir" object is just wired directly in place of its predecessors, without any significant change of code organization at that top layer. This first commit focuses on the main files and directories we use to find provider plugins, because a subsequent commit will lightly reorganize the separation of concerns for plugin launching with a similar goal of collecting all of the relevant logic together into one spot. --- commands.go | 9 +- internal/command/command_test.go | 69 ++++++++- internal/command/get_test.go | 31 ++-- internal/command/meta.go | 61 ++++---- internal/command/meta_backend_test.go | 14 +- internal/command/meta_config.go | 23 +-- internal/command/meta_providers.go | 4 +- internal/command/plugins.go | 38 +---- internal/command/workdir/dir.go | 149 +++++++++++++++++++ internal/command/workdir/doc.go | 16 ++ internal/command/workdir/normalize_path.go | 52 +++++++ internal/command/workdir/plugin_dirs.go | 83 +++++++++++ internal/command/workdir/plugin_dirs_test.go | 60 ++++++++ working_dir.go | 12 ++ 14 files changed, 507 insertions(+), 114 deletions(-) create mode 100644 internal/command/workdir/dir.go create mode 100644 internal/command/workdir/doc.go create mode 100644 internal/command/workdir/normalize_path.go create mode 100644 internal/command/workdir/plugin_dirs.go create mode 100644 internal/command/workdir/plugin_dirs_test.go create mode 100644 working_dir.go diff --git a/commands.go b/commands.go index e5d7a3605e08..2c1cb90ee1ae 100644 --- a/commands.go +++ b/commands.go @@ -77,12 +77,12 @@ func initCommands( configDir = "" // No config dir available (e.g. looking up a home directory failed) } - dataDir := os.Getenv("TF_DATA_DIR") + wd := WorkingDir(originalWorkingDir, os.Getenv("TF_DATA_DIR")) meta := command.Meta{ - OriginalWorkingDir: originalWorkingDir, - Streams: streams, - View: views.NewView(streams).SetRunningInAutomation(inAutomation), + WorkingDir: wd, + Streams: streams, + View: views.NewView(streams).SetRunningInAutomation(inAutomation), Color: true, GlobalPluginDirs: globalPluginDirs(), @@ -94,7 +94,6 @@ func initCommands( RunningInAutomation: inAutomation, CLIConfigDir: configDir, PluginCacheDir: config.PluginCacheDir, - OverrideDataDir: dataDir, ShutdownCh: makeShutdownCh(), diff --git a/internal/command/command_test.go b/internal/command/command_test.go index 5bc136ffe15a..e182807a0cfe 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -24,6 +24,7 @@ import ( backendInit "github.com/hashicorp/terraform/internal/backend/init" backendLocal "github.com/hashicorp/terraform/internal/backend/local" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/command/workdir" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configload" "github.com/hashicorp/terraform/internal/configs/configschema" @@ -108,6 +109,65 @@ func tempDir(t *testing.T) string { return dir } +// tempWorkingDir constructs a workdir.Dir object referring to a newly-created +// temporary directory, and returns that object along with a cleanup function +// to call once the calling test is complete. +// +// Although workdir.Dir is built to support arbitrary base directories, the +// not-yet-migrated behaviors in command.Meta tend to expect the root module +// directory to be the real process working directory, and so if you intend +// to use the result inside a command.Meta object you must use a pattern +// similar to the following when initializing your test: +// +// wd, cleanup := tempWorkingDir(t) +// defer cleanup() +// defer testChdir(t, wd.RootModuleDir())() +// +// Note that testChdir modifies global state for the test process, and so a +// test using this pattern must never call t.Parallel(). +func tempWorkingDir(t *testing.T) (*workdir.Dir, func() error) { + t.Helper() + + dirPath, err := os.MkdirTemp("", "tf-command-test-") + if err != nil { + t.Fatal(err) + } + done := func() error { + return os.RemoveAll(dirPath) + } + t.Logf("temporary directory %s", dirPath) + + return workdir.NewDir(dirPath), done +} + +// tempWorkingDirFixture is like tempWorkingDir but it also copies the content +// from a fixture directory into the temporary directory before returning it. +// +// The same caveats about working directory apply as for testWorkingDir. See +// the testWorkingDir commentary for an example of how to use this function +// along with testChdir to meet the expectations of command.Meta legacy +// functionality. +func tempWorkingDirFixture(t *testing.T, fixtureName string) (*workdir.Dir, func() error) { + t.Helper() + + dirPath, err := os.MkdirTemp("", "tf-command-test-"+fixtureName) + if err != nil { + t.Fatal(err) + } + done := func() error { + return os.RemoveAll(dirPath) + } + t.Logf("temporary directory %s with fixture %q", dirPath, fixtureName) + + fixturePath := testFixturePath(fixtureName) + testCopyDir(t, fixturePath, dirPath) + // NOTE: Unfortunately because testCopyDir immediately aborts the test + // on failure, a failure to copy will prevent us from cleaning up the + // temporary directory. Oh well. :( + + return workdir.NewDir(dirPath), done +} + func testFixturePath(name string) string { return filepath.Join(fixtureDir, name) } @@ -853,8 +913,10 @@ func testLockState(sourceDir, path string) (func(), error) { } // testCopyDir recursively copies a directory tree, attempting to preserve -// permissions. Source directory must exist, destination directory must *not* -// exist. Symlinks are ignored and skipped. +// permissions. Source directory must exist, destination directory may exist +// but will be created if not; it should typically be a temporary directory, +// and thus already created using os.MkdirTemp or similar. +// Symlinks are ignored and skipped. func testCopyDir(t *testing.T, src, dst string) { t.Helper() @@ -873,9 +935,6 @@ func testCopyDir(t *testing.T, src, dst string) { if err != nil && !os.IsNotExist(err) { t.Fatal(err) } - if err == nil { - t.Fatal("destination already exists") - } err = os.MkdirAll(dst, si.Mode()) if err != nil { diff --git a/internal/command/get_test.go b/internal/command/get_test.go index 7d9137425ad8..2e9f04611ad1 100644 --- a/internal/command/get_test.go +++ b/internal/command/get_test.go @@ -1,7 +1,6 @@ package command import ( - "os" "strings" "testing" @@ -9,17 +8,16 @@ import ( ) func TestGet(t *testing.T) { - td := tempDir(t) - testCopyDir(t, testFixturePath("get"), td) - defer os.RemoveAll(td) - defer testChdir(t, td)() + wd, cleanup := tempWorkingDirFixture(t, "get") + defer cleanup() + defer testChdir(t, wd.RootModuleDir())() - ui := new(cli.MockUi) + ui := cli.NewMockUi() c := &GetCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), Ui: ui, - dataDir: tempDir(t), + WorkingDir: wd, }, } @@ -35,12 +33,16 @@ func TestGet(t *testing.T) { } func TestGet_multipleArgs(t *testing.T) { - ui := new(cli.MockUi) + wd, cleanup := tempWorkingDir(t) + defer cleanup() + defer testChdir(t, wd.RootModuleDir())() + + ui := cli.NewMockUi() c := &GetCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), Ui: ui, - dataDir: tempDir(t), + WorkingDir: wd, }, } @@ -54,17 +56,16 @@ func TestGet_multipleArgs(t *testing.T) { } func TestGet_update(t *testing.T) { - td := tempDir(t) - testCopyDir(t, testFixturePath("get"), td) - defer os.RemoveAll(td) - defer testChdir(t, td)() + wd, cleanup := tempWorkingDirFixture(t, "get") + defer cleanup() + defer testChdir(t, wd.RootModuleDir())() - ui := new(cli.MockUi) + ui := cli.NewMockUi() c := &GetCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), Ui: ui, - dataDir: tempDir(t), + WorkingDir: wd, }, } diff --git a/internal/command/meta.go b/internal/command/meta.go index 072cfad419ef..79e1b6f843a2 100644 --- a/internal/command/meta.go +++ b/internal/command/meta.go @@ -16,6 +16,9 @@ import ( plugin "github.com/hashicorp/go-plugin" "github.com/hashicorp/terraform-svchost/disco" + "github.com/mitchellh/cli" + "github.com/mitchellh/colorstring" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/backend/local" @@ -23,17 +26,15 @@ import ( "github.com/hashicorp/terraform/internal/command/format" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/command/webbrowser" + "github.com/hashicorp/terraform/internal/command/workdir" "github.com/hashicorp/terraform/internal/configs/configload" "github.com/hashicorp/terraform/internal/getproviders" + legacy "github.com/hashicorp/terraform/internal/legacy/terraform" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" "github.com/hashicorp/terraform/internal/terminal" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" - "github.com/mitchellh/cli" - "github.com/mitchellh/colorstring" - - legacy "github.com/hashicorp/terraform/internal/legacy/terraform" ) // Meta are the meta-options that are available on all or most commands. @@ -42,16 +43,19 @@ type Meta struct { // command with a Meta field. These are expected to be set externally // (not from within the command itself). - // OriginalWorkingDir, if set, is the actual working directory where - // Terraform was run from. This might not be the _actual_ current working - // directory, because users can add the -chdir=... option to the beginning - // of their command line to ask Terraform to switch. + // WorkingDir is an object representing the "working directory" where we're + // running commands. In the normal case this literally refers to the + // working directory of the Terraform process, though this can take on + // a more symbolic meaning when the user has overridden default behavior + // to specify a different working directory or to override the special + // data directory where we'll persist settings that must survive between + // consecutive commands. // - // Most things should just use the current working directory in order to - // respect the user's override, but we retain this for exceptional - // situations where we need to refer back to the original working directory - // for some reason. - OriginalWorkingDir string + // We're currently gradually migrating the various bits of state that + // must persist between consecutive commands in a session to be encapsulated + // in here, but we're not there yet and so there are also some methods on + // Meta which directly read and modify paths inside the data directory. + WorkingDir *workdir.Dir // Streams tracks the raw Stdout, Stderr, and Stdin handles along with // some basic metadata about them, such as whether each is connected to @@ -102,11 +106,6 @@ type Meta struct { // provider version can be obtained. ProviderSource getproviders.Source - // OverrideDataDir, if non-empty, overrides the return value of the - // DataDir method for situations where the local .terraform/ directory - // is not suitable, e.g. because of a read-only filesystem. - OverrideDataDir string - // BrowserLauncher is used by commands that need to open a URL in a // web browser. BrowserLauncher webbrowser.Launcher @@ -135,10 +134,6 @@ type Meta struct { // Protected: commands can set these //---------------------------------------------------------- - // Modify the data directory location. This should be accessed through the - // DataDir method. - dataDir string - // pluginPath is a user defined set of directories to look for plugins. // This is set during init with the `-plugin-dir` flag, saved to a file in // the data directory. @@ -265,13 +260,25 @@ func (m *Meta) Colorize() *colorstring.Colorize { } } +// fixupMissingWorkingDir is a compensation for various existing tests which +// directly construct incomplete "Meta" objects. Specifically, it deals with +// a test that omits a WorkingDir value by constructing one just-in-time. +// +// We shouldn't ever rely on this in any real codepath, because it doesn't +// take into account the various ways users can override our default +// directory selection behaviors. +func (m *Meta) fixupMissingWorkingDir() { + if m.WorkingDir == nil { + log.Printf("[WARN] This 'Meta' object is missing its WorkingDir, so we're creating a default one suitable only for tests") + m.WorkingDir = workdir.NewDir(".") + } +} + // DataDir returns the directory where local data will be stored. // Defaults to DefaultDataDir in the current working directory. func (m *Meta) DataDir() string { - if m.OverrideDataDir != "" { - return m.OverrideDataDir - } - return DefaultDataDir + m.fixupMissingWorkingDir() + return m.WorkingDir.DataDir() } const ( @@ -499,7 +506,7 @@ func (m *Meta) contextOpts() (*terraform.ContextOpts, error) { opts.Meta = &terraform.ContextMeta{ Env: workspace, - OriginalWorkingDir: m.OriginalWorkingDir, + OriginalWorkingDir: m.WorkingDir.OriginalWorkingDir(), } return &opts, nil diff --git a/internal/command/meta_backend_test.go b/internal/command/meta_backend_test.go index c489de08830c..23f021b8245d 100644 --- a/internal/command/meta_backend_test.go +++ b/internal/command/meta_backend_test.go @@ -1855,17 +1855,19 @@ func TestMetaBackend_configToExtra(t *testing.T) { // no config; return inmem backend stored in state func TestBackendFromState(t *testing.T) { - td := tempDir(t) - testCopyDir(t, testFixturePath("backend-from-state"), td) - defer os.RemoveAll(td) - defer testChdir(t, td)() + wd, cleanup := tempWorkingDirFixture(t, "backend-from-state") + defer cleanup() + defer testChdir(t, wd.RootModuleDir())() // Setup the meta m := testMetaBackend(t, nil) + m.WorkingDir = wd // terraform caches a small "state" file that stores the backend config. // This test must override m.dataDir so it loads the "terraform.tfstate" file in the - // test directory as the backend config cache - m.OverrideDataDir = td + // test directory as the backend config cache. This fixture is really a + // fixture for the data dir rather than the module dir, so we'll override + // them to match just for this test. + wd.OverrideDataDir(".") stateBackend, diags := m.backendFromState() if diags.HasErrors() { diff --git a/internal/command/meta_config.go b/internal/command/meta_config.go index 3c91a936494e..439df6b9130b 100644 --- a/internal/command/meta_config.go +++ b/internal/command/meta_config.go @@ -27,27 +27,8 @@ import ( // paths used to load configuration, because we want to prefer recording // relative paths in source code references within the configuration. func (m *Meta) normalizePath(path string) string { - var err error - - // First we will make it absolute so that we have a consistent place - // to start. - path, err = filepath.Abs(path) - if err != nil { - // We'll just accept what we were given, then. - return path - } - - cwd, err := os.Getwd() - if err != nil || !filepath.IsAbs(cwd) { - return path - } - - ret, err := filepath.Rel(cwd, path) - if err != nil { - return path - } - - return ret + m.fixupMissingWorkingDir() + return m.WorkingDir.NormalizePath(path) } // loadConfig reads a configuration from the given directory, which should diff --git a/internal/command/meta_providers.go b/internal/command/meta_providers.go index 42a3acc6a9b3..84ccc89d87a4 100644 --- a/internal/command/meta_providers.go +++ b/internal/command/meta_providers.go @@ -6,7 +6,6 @@ import ( "log" "os" "os/exec" - "path/filepath" "strings" "github.com/hashicorp/go-multierror" @@ -109,7 +108,8 @@ func (m *Meta) providerCustomLocalDirectorySource(dirs []string) getproviders.So // Only one object returned from this method should be live at any time, // because objects inside contain caches that must be maintained properly. func (m *Meta) providerLocalCacheDir() *providercache.Dir { - dir := filepath.Join(m.DataDir(), "providers") + m.fixupMissingWorkingDir() + dir := m.WorkingDir.ProviderLocalCacheDir() return providercache.NewDir(dir) } diff --git a/internal/command/plugins.go b/internal/command/plugins.go index dba535137ec1..7467b09db96a 100644 --- a/internal/command/plugins.go +++ b/internal/command/plugins.go @@ -1,11 +1,8 @@ package command import ( - "encoding/json" "fmt" - "io/ioutil" "log" - "os" "os/exec" "path/filepath" "runtime" @@ -36,46 +33,21 @@ func (m *Meta) storePluginPath(pluginPath []string) error { return nil } - path := filepath.Join(m.DataDir(), PluginPathFile) + m.fixupMissingWorkingDir() // remove the plugin dir record if the path was set to an empty string if len(pluginPath) == 1 && (pluginPath[0] == "") { - err := os.Remove(path) - if !os.IsNotExist(err) { - return err - } - return nil - } - - js, err := json.MarshalIndent(pluginPath, "", " ") - if err != nil { - return err + return m.WorkingDir.SetForcedPluginDirs(nil) } - // if this fails, so will WriteFile - os.MkdirAll(m.DataDir(), 0755) - - return ioutil.WriteFile(path, js, 0644) + return m.WorkingDir.SetForcedPluginDirs(pluginPath) } // Load the user-defined plugin search path into Meta.pluginPath if the file // exists. func (m *Meta) loadPluginPath() ([]string, error) { - js, err := ioutil.ReadFile(filepath.Join(m.DataDir(), PluginPathFile)) - if os.IsNotExist(err) { - return nil, nil - } - - if err != nil { - return nil, err - } - - var pluginPath []string - if err := json.Unmarshal(js, &pluginPath); err != nil { - return nil, err - } - - return pluginPath, nil + m.fixupMissingWorkingDir() + return m.WorkingDir.ForcedPluginDirs() } // the default location for automatically installed plugins diff --git a/internal/command/workdir/dir.go b/internal/command/workdir/dir.go new file mode 100644 index 000000000000..1af5b8ed0cce --- /dev/null +++ b/internal/command/workdir/dir.go @@ -0,0 +1,149 @@ +package workdir + +import ( + "fmt" + "os" + "path/filepath" +) + +// Dir represents a single Terraform working directory. +// +// "Working directory" is unfortunately a slight misnomer, because non-default +// options can potentially stretch the definition such that multiple working +// directories end up appearing to share a data directory, or other similar +// anomolies, but we continue to use this terminology both for historical +// reasons and because it reflects the common case without any special +// overrides. +// +// The naming convention for methods on this type is that methods whose names +// begin with "Override" affect only characteristics of the particular object +// they're called on, changing where it looks for data, while methods whose +// names begin with "Set" will write settings to disk such that other instances +// referring to the same directories will also see them. Given that, the +// "Override" methods should be used only during the initialization steps +// for a Dir object, typically only inside "package main", so that all +// subsequent work elsewhere will access consistent locations on disk. +// +// We're gradually transitioning to using this type to manage working directory +// settings, and so not everything in the working directory "data dir" is +// encapsulated here yet, but hopefully we'll gradually migrate all of those +// settings here over time. The working directory state not yet managed in here +// is typically managed directly in the "command" package, either directly +// inside commands or in methods of the giant command.Meta type. +type Dir struct { + // mainDir is the path to the directory that we present as the + // "working directory" in the user model, which is typically the + // current working directory when running Terraform CLI, or the + // directory explicitly chosen by the user using the -chdir=... + // global option. + mainDir string + + // originalDir is the path to the working directory that was + // selected when creating the Terraform CLI process, regardless of + // -chdir=... being set. This is only for very limited purposes + // related to backward compatibility; most functionality should + // use mainDir instead. + originalDir string + + // dataDir is the path to the directory where we will store our + // working directory settings and artifacts. This is typically a + // directory named ".terraform" within mainDir, but users may + // override it. + dataDir string +} + +// NewDir constructs a new working directory, anchored at the given path. +// +// In normal use, mainPath should be "." to reflect the current working +// directory, with "package main" having switched the process's current +// working directory if necessary prior to calling this function. However, +// unusual situations in tests may set mainPath to a temporary directory, or +// similar. +// +// WARNING: Although the logic in this package is intended to work regardless +// of whether mainPath is actually the current working directory, we're +// currently in a transitional state where this package shares responsibility +// for the working directory with various command.Meta methods, and those +// often assume that the main path of the working directory will always be +// ".". If you're writing test code that spans across both areas of +// responsibility then you must ensure that the test temporarily changes the +// test process's working directory to the directory returned by RootModuleDir +// before using the result inside a command.Meta. +func NewDir(mainPath string) *Dir { + mainPath = filepath.Clean(mainPath) + return &Dir{ + mainDir: mainPath, + originalDir: mainPath, + dataDir: filepath.Join(mainPath, ".terraform"), + } +} + +// OverrideOriginalWorkingDir records a different path as the +// "original working directory" for the reciever. +// +// Use this only to record the original working directory when Terraform is run +// with the -chdir=... global option. In that case, the directory given in +// -chdir=... is the "main path" to pass in to NewDir, while the original +// working directory should be sent to this method. +func (d *Dir) OverrideOriginalWorkingDir(originalPath string) { + d.originalDir = filepath.Clean(originalPath) +} + +// OverrideDataDir chooses a specific alternative directory to read and write +// the persistent working directory settings. +// +// "package main" can call this if it detects that the user has overridden +// the default location by setting the relevant environment variable. Don't +// call this when that environment variable isn't set, in order to preserve +// the default setting of a dot-prefixed directory directly inside the main +// working directory. +func (d *Dir) OverrideDataDir(dataDir string) { + d.dataDir = filepath.Clean(dataDir) +} + +// RootModuleDir returns the directory where we expect to find the root module +// configuration for this working directory. +func (d *Dir) RootModuleDir() string { + // The root module configuration is just directly inside the main directory. + return d.mainDir +} + +// OriginalWorkingDir returns the true, operating-system-originated working +// directory that the current Terraform process was launched from. +// +// This is usually the same as the main working directory, but differs in the +// special case where the user ran Terraform with the global -chdir=... +// option. This is here only for a few backward compatibility affordances +// from before we had the -chdir=... option, so should typically not be used +// for anything new. +func (d *Dir) OriginalWorkingDir() string { + return d.originalDir +} + +// DataDir returns the base path where the reciever keeps all of the settings +// and artifacts that must persist between consecutive commands in a single +// session. +// +// This is exported only to allow the legacy behaviors in command.Meta to +// continue accessing this directory directly. Over time we should replace +// all of those direct accesses with methods on this type, and then remove +// this method. Avoid using this method for new use-cases. +func (d *Dir) DataDir() string { + return d.dataDir +} + +// ensureDataDir creates the data directory and all of the necessary parent +// directories that lead to it, if they don't already exist. +// +// For directories that already exist ensureDataDir will preserve their +// permissions, while it'll create any new directories to be owned by the user +// running Terraform, readable and writable by that user, and readable by +// all other users, or some approximation of that on non-Unix platforms which +// have a different permissions model. +func (d *Dir) ensureDataDir() error { + err := os.MkdirAll(d.dataDir, 0755) + if err != nil { + return fmt.Errorf("failed to prepare working directory: %w", err) + } + return nil +} diff --git a/internal/command/workdir/doc.go b/internal/command/workdir/doc.go new file mode 100644 index 000000000000..d645e4f09d20 --- /dev/null +++ b/internal/command/workdir/doc.go @@ -0,0 +1,16 @@ +// Package workdir models the various local artifacts and state we keep inside +// a Terraform "working directory". +// +// The working directory artifacts and settings are typically initialized or +// modified by "terraform init", after which they persist for use by other +// commands in the same directory, but are not visible to commands run in +// other working directories or on other computers. +// +// Although "terraform init" is the main command which modifies a workdir, +// other commands do sometimes make more focused modifications for settings +// which can typically change multiple times during a session, such as the +// currently-selected workspace name. Any command which modifies the working +// directory settings must discard and reload any objects which derived from +// those settings, because otherwise the existing objects will often continue +// to follow the settings that were present when they were created. +package workdir diff --git a/internal/command/workdir/normalize_path.go b/internal/command/workdir/normalize_path.go new file mode 100644 index 000000000000..4bef076882e4 --- /dev/null +++ b/internal/command/workdir/normalize_path.go @@ -0,0 +1,52 @@ +package workdir + +import ( + "path/filepath" +) + +// NormalizePath attempts to transform the given path so that it's relative +// to the working directory, which is our preferred way to present and store +// paths to files and directories within a configuration so that they can +// be portable to operations in other working directories. +// +// It isn't always possible to produce a relative path. For example, on Windows +// the given path might be on a different volume (e.g. drive letter or network +// share) than the working directory. +// +// Note that the result will be relative to the main directory of the receiver, +// which should always be the actual process working directory in normal code, +// but might be some other temporary working directory when in test code. +// If you need to access the file or directory that the result refers to with +// functions that aren't aware of our base directory, you can use something +// like the following, which again should be needed only in test code which +// might need to inspect the filesystem in order to make assertions: +// +// filepath.Join(d.RootModuleDir(), normalizePathResult) +// +// The above is suitable only for situations where the given path is known +// to be beneath the working directory, which is the typical situation for +// temporary working directories created for automated tests. +func (d *Dir) NormalizePath(given string) string { + // We need an absolute version of d.mainDir in order for our "Rel" + // result to be reliable. + absMain, err := filepath.Abs(d.mainDir) + if err != nil { + // Weird, but okay... + return filepath.Clean(given) + } + + if !filepath.IsAbs(given) { + given = filepath.Join(absMain, given) + } + + ret, err := filepath.Rel(absMain, given) + if err != nil { + // It's not always possible to find a relative path. For example, + // the given path might be on an entirely separate volume + // (e.g. drive letter or network share) on a Windows system, which + // always requires an absolute path. + return filepath.Clean(given) + } + + return ret +} diff --git a/internal/command/workdir/plugin_dirs.go b/internal/command/workdir/plugin_dirs.go new file mode 100644 index 000000000000..017b0ffc16da --- /dev/null +++ b/internal/command/workdir/plugin_dirs.go @@ -0,0 +1,83 @@ +package workdir + +import ( + "encoding/json" + "io/ioutil" + "os" + "path/filepath" +) + +const PluginPathFilename = "plugin_path" + +// ProviderLocalCacheDir returns the directory we'll use as the +// working-directory-specific local cache of providers. +// +// The provider installer's job is to make sure that all providers needed for +// a particular working directory are available in this cache directory. No +// other component may write here, and in particular a Dir object itself +// never reads or writes into this directory, instead just delegating all of +// that responsibility to other components. +// +// Typically, the caller will ultimately pass the result of this method either +// directly or indirectly into providercache.NewDir, to get an object +// responsible for managing the contents. +func (d *Dir) ProviderLocalCacheDir() string { + return filepath.Join(d.dataDir, "providers") +} + +// ForcedPluginDirs returns a list of directories to use to find plugins, +// instead of the default locations. +// +// Returns an zero-length list and no error in the normal case where there +// are no overridden search directories. If ForcedPluginDirs returns a +// non-empty list with no errors then the result totally replaces the default +// search directories. +func (d *Dir) ForcedPluginDirs() ([]string, error) { + raw, err := ioutil.ReadFile(filepath.Join(d.dataDir, PluginPathFilename)) + if os.IsNotExist(err) { + return nil, nil + } + + if err != nil { + return nil, err + } + + var pluginPath []string + if err := json.Unmarshal(raw, &pluginPath); err != nil { + return nil, err + } + return pluginPath, nil +} + +// SetForcedPluginDirs records an overridden list of directories to search +// to find plugins, instead of the default locations. See ForcePluginDirs +// for more information. +// +// Pass a zero-length list to deactivate forced plugin directories altogether, +// thus allowing the working directory to return to using the default +// search directories. +func (d *Dir) SetForcedPluginDirs(dirs []string) error { + + filePath := filepath.Join(d.dataDir, PluginPathFilename) + switch { + case len(dirs) == 0: + err := os.Remove(filePath) + if !os.IsNotExist(err) { + return err + } + return nil + default: + // We'll ignore errors from this one, because if we fail to create + // the directory then we'll fail to create the file below too, + // and that subsequent error will more directly reflect what we + // are trying to do here. + d.ensureDataDir() + + raw, err := json.MarshalIndent(dirs, "", " ") + if err != nil { + return err + } + + return ioutil.WriteFile(filePath, raw, 0644) + } +} diff --git a/internal/command/workdir/plugin_dirs_test.go b/internal/command/workdir/plugin_dirs_test.go new file mode 100644 index 000000000000..5ed224ab3f36 --- /dev/null +++ b/internal/command/workdir/plugin_dirs_test.go @@ -0,0 +1,60 @@ +package workdir + +import ( + "os" + "path/filepath" + "testing" + + "github.com/google/go-cmp/cmp" +) + +func TestDirForcedPluginDirs(t *testing.T) { + tmpDir, err := os.MkdirTemp("", "terraform-workdir-") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + dir := NewDir(tmpDir) + // We'll use the default convention of a data dir nested inside the + // working directory, so we don't need to override anything on "dir". + + want := []string(nil) + got, err := dir.ForcedPluginDirs() + if err != nil { + t.Fatal(err) + } + if diff := cmp.Diff(want, got); diff != "" { + t.Errorf("wrong initial settings\n%s", diff) + } + + fakeDir1 := filepath.Join(tmpDir, "boop1") + fakeDir2 := filepath.Join(tmpDir, "boop2") + err = dir.SetForcedPluginDirs([]string{fakeDir1, fakeDir2}) + if err != nil { + t.Fatal(err) + } + + want = []string{fakeDir1, fakeDir2} + got, err = dir.ForcedPluginDirs() + if err != nil { + t.Fatal(err) + } + if diff := cmp.Diff(want, got); diff != "" { + t.Errorf("wrong updated settings\n%s", diff) + } + + err = dir.SetForcedPluginDirs(nil) + if err != nil { + t.Fatal(err) + } + + want = nil + got, err = dir.ForcedPluginDirs() + if err != nil { + t.Fatal(err) + } + if diff := cmp.Diff(want, got); diff != "" { + t.Errorf("wrong final settings, after reverting back to defaults\n%s", diff) + } +} diff --git a/working_dir.go b/working_dir.go new file mode 100644 index 000000000000..6d9945c0c5f5 --- /dev/null +++ b/working_dir.go @@ -0,0 +1,12 @@ +package main + +import "github.com/hashicorp/terraform/internal/command/workdir" + +func WorkingDir(originalDir string, overrideDataDir string) *workdir.Dir { + ret := workdir.NewDir(".") // caller should already have used os.Chdir in "-chdir=..." mode + ret.OverrideOriginalWorkingDir(originalDir) + if overrideDataDir != "" { + ret.OverrideDataDir(overrideDataDir) + } + return ret +} From c8e2be76d2572282d4bde28afdaeb03fdfba8764 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dra=C5=A1ko=20Radovanovi=C4=87?= Date: Sat, 11 Sep 2021 15:33:14 +0200 Subject: [PATCH 055/644] Fix a documentation typo --- website/docs/language/expressions/function-calls.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/language/expressions/function-calls.html.md b/website/docs/language/expressions/function-calls.html.md index b55d6a16db02..f01a6563ca9c 100644 --- a/website/docs/language/expressions/function-calls.html.md +++ b/website/docs/language/expressions/function-calls.html.md @@ -98,8 +98,8 @@ dynamically on disk as part of the plan or apply steps. The `timestamp` function returns a representation of the current system time at the point when Terraform calls it, and the `uuid` function returns a random -result which differs on each call. Without any special behavior these would -would both cause the final configuration during the apply step not to match the +result which differs on each call. Without any special behavior, these would +both cause the final configuration during the apply step not to match the actions shown in the plan, which violates the Terraform execution model. For that reason, Terraform arranges for both of those functions to produce From af4f4540a95fcb03144023531c6144bc20900c2c Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 10 Sep 2021 09:27:28 -0400 Subject: [PATCH 056/644] configschema: do not expose optional attributes Objects with optional attributes are only used for the decoding of HCL, and those types should never be exposed elsewhere within terraform. Separate the external ImpliedType method from the cty.Type generated internally for the decoder spec. This unfortunately causes our ImpliedType method to return a different type than the hcldec.ImpliedType function, but the former is only used within terraform for concrete values, while the latter is used to decode HCL. Renaming the ImpliedType methods could be done to further differentiate them, but that does cause fairly large diff in the codebase that does not seem worth the effort at this time. --- internal/configs/configschema/decoder_spec.go | 6 +- internal/configs/configschema/implied_type.go | 24 ++- .../configs/configschema/implied_type_test.go | 195 ++++++++++++++++-- 3 files changed, 207 insertions(+), 18 deletions(-) diff --git a/internal/configs/configschema/decoder_spec.go b/internal/configs/configschema/decoder_spec.go index 19bea49170c7..d127ccd6f4ae 100644 --- a/internal/configs/configschema/decoder_spec.go +++ b/internal/configs/configschema/decoder_spec.go @@ -121,7 +121,7 @@ func (b *Block) DecoderSpec() hcldec.Spec { // implied type more complete, but if there are any // dynamically-typed attributes inside we must use a tuple // instead, at the expense of our type then not being predictable. - if blockS.Block.ImpliedType().HasDynamicTypes() { + if blockS.Block.specType().HasDynamicTypes() { ret[name] = &hcldec.BlockTupleSpec{ TypeName: name, Nested: childSpec, @@ -155,7 +155,7 @@ func (b *Block) DecoderSpec() hcldec.Spec { // implied type more complete, but if there are any // dynamically-typed attributes inside we must use a tuple // instead, at the expense of our type then not being predictable. - if blockS.Block.ImpliedType().HasDynamicTypes() { + if blockS.Block.specType().HasDynamicTypes() { ret[name] = &hcldec.BlockObjectSpec{ TypeName: name, Nested: childSpec, @@ -195,7 +195,7 @@ func (a *Attribute) decoderSpec(name string) hcldec.Spec { panic("Invalid attribute schema: NestedType and Type cannot both be set. This is a bug in the provider.") } - ty := a.NestedType.ImpliedType() + ty := a.NestedType.specType() ret.Type = ty ret.Required = a.Required || a.NestedType.MinItems > 0 return ret diff --git a/internal/configs/configschema/implied_type.go b/internal/configs/configschema/implied_type.go index 58b9951101c4..1a19a8c07a28 100644 --- a/internal/configs/configschema/implied_type.go +++ b/internal/configs/configschema/implied_type.go @@ -8,11 +8,23 @@ import ( // ImpliedType returns the cty.Type that would result from decoding a // configuration block using the receiving block schema. // +// The type returned from Block.ImpliedType differs from the type returned by +// hcldec.ImpliedType in that there will be no objects with optional +// attributes, since this value is not to be used for the decoding of +// configuration. +// // ImpliedType always returns a result, even if the given schema is // inconsistent. Code that creates configschema.Block objects should be // tested using the InternalValidate method to detect any inconsistencies // that would cause this method to fall back on defaults and assumptions. func (b *Block) ImpliedType() cty.Type { + return b.specType().WithoutOptionalAttributesDeep() +} + +// specType returns the cty.Type used for decoding a configuration +// block using the receiving block schema. This is the type used internally by +// hcldec to decode configuration. +func (b *Block) specType() cty.Type { if b == nil { return cty.EmptyObject } @@ -41,14 +53,20 @@ func (b *Block) ContainsSensitive() bool { return false } -// ImpliedType returns the cty.Type that would result from decoding a NestedType -// Attribute using the receiving block schema. +// ImpliedType returns the cty.Type that would result from decoding a +// NestedType Attribute using the receiving block schema. // // ImpliedType always returns a result, even if the given schema is // inconsistent. Code that creates configschema.Object objects should be tested // using the InternalValidate method to detect any inconsistencies that would // cause this method to fall back on defaults and assumptions. func (o *Object) ImpliedType() cty.Type { + return o.specType().WithoutOptionalAttributesDeep() +} + +// specType returns the cty.Type used for decoding a NestedType Attribute using +// the receiving block schema. +func (o *Object) specType() cty.Type { if o == nil { return cty.EmptyObject } @@ -56,7 +74,7 @@ func (o *Object) ImpliedType() cty.Type { attrTys := make(map[string]cty.Type, len(o.Attributes)) for name, attrS := range o.Attributes { if attrS.NestedType != nil { - attrTys[name] = attrS.NestedType.ImpliedType() + attrTys[name] = attrS.NestedType.specType() } else { attrTys[name] = attrS.Type } diff --git a/internal/configs/configschema/implied_type_test.go b/internal/configs/configschema/implied_type_test.go index d36239615c48..0fd8b01b5772 100644 --- a/internal/configs/configschema/implied_type_test.go +++ b/internal/configs/configschema/implied_type_test.go @@ -112,6 +112,36 @@ func TestBlockImpliedType(t *testing.T) { }), }), }, + "nested objects with optional attrs": { + &Block{ + Attributes: map[string]*Attribute{ + "map": { + Optional: true, + NestedType: &Object{ + Nesting: NestingMap, + Attributes: map[string]*Attribute{ + "optional": {Type: cty.String, Optional: true}, + "required": {Type: cty.Number, Required: true}, + "computed": {Type: cty.List(cty.Bool), Computed: true}, + "optional_computed": {Type: cty.Map(cty.Bool), Optional: true, Computed: true}, + }, + }, + }, + }, + }, + // The ImpliedType from the type-level block should not contain any + // optional attributes. + cty.Object(map[string]cty.Type{ + "map": cty.Map(cty.Object( + map[string]cty.Type{ + "optional": cty.String, + "required": cty.Number, + "computed": cty.List(cty.Bool), + "optional_computed": cty.Map(cty.Bool), + }, + )), + }), + }, } for name, test := range tests { @@ -147,14 +177,13 @@ func TestObjectImpliedType(t *testing.T) { "optional_computed": {Type: cty.Map(cty.Bool), Optional: true, Computed: true}, }, }, - cty.ObjectWithOptionalAttrs( + cty.Object( map[string]cty.Type{ "optional": cty.String, "required": cty.Number, "computed": cty.List(cty.Bool), "optional_computed": cty.Map(cty.Bool), }, - []string{"optional", "computed", "optional_computed"}, ), }, "nested attributes": { @@ -175,14 +204,14 @@ func TestObjectImpliedType(t *testing.T) { }, }, }, - cty.ObjectWithOptionalAttrs(map[string]cty.Type{ - "nested_type": cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + cty.Object(map[string]cty.Type{ + "nested_type": cty.Object(map[string]cty.Type{ "optional": cty.String, "required": cty.Number, "computed": cty.List(cty.Bool), "optional_computed": cty.Map(cty.Bool), - }, []string{"optional", "computed", "optional_computed"}), - }, []string{"nested_type"}), + }), + }), }, "nested object-type attributes": { &Object{ @@ -208,15 +237,15 @@ func TestObjectImpliedType(t *testing.T) { }, }, }, - cty.ObjectWithOptionalAttrs(map[string]cty.Type{ - "nested_type": cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + cty.Object(map[string]cty.Type{ + "nested_type": cty.Object(map[string]cty.Type{ "optional": cty.String, "required": cty.Number, "computed": cty.List(cty.Bool), "optional_computed": cty.Map(cty.Bool), - "object": cty.ObjectWithOptionalAttrs(map[string]cty.Type{"optional": cty.String, "required": cty.Number}, []string{"optional"}), - }, []string{"optional", "computed", "optional_computed"}), - }, []string{"nested_type"}), + "object": cty.Object(map[string]cty.Type{"optional": cty.String, "required": cty.Number}), + }), + }), }, "NestingList": { &Object{ @@ -225,7 +254,7 @@ func TestObjectImpliedType(t *testing.T) { "foo": {Type: cty.String, Optional: true}, }, }, - cty.List(cty.ObjectWithOptionalAttrs(map[string]cty.Type{"foo": cty.String}, []string{"foo"})), + cty.List(cty.Object(map[string]cty.Type{"foo": cty.String})), }, "NestingMap": { &Object{ @@ -336,3 +365,145 @@ func TestObjectContainsSensitive(t *testing.T) { } } + +// Nested attribute should return optional object attributes for decoding. +func TestObjectSpecType(t *testing.T) { + tests := map[string]struct { + Schema *Object + Want cty.Type + }{ + "attributes": { + &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "optional": {Type: cty.String, Optional: true}, + "required": {Type: cty.Number, Required: true}, + "computed": {Type: cty.List(cty.Bool), Computed: true}, + "optional_computed": {Type: cty.Map(cty.Bool), Optional: true, Computed: true}, + }, + }, + cty.ObjectWithOptionalAttrs( + map[string]cty.Type{ + "optional": cty.String, + "required": cty.Number, + "computed": cty.List(cty.Bool), + "optional_computed": cty.Map(cty.Bool), + }, + []string{"optional", "computed", "optional_computed"}, + ), + }, + "nested attributes": { + &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "nested_type": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "optional": {Type: cty.String, Optional: true}, + "required": {Type: cty.Number, Required: true}, + "computed": {Type: cty.List(cty.Bool), Computed: true}, + "optional_computed": {Type: cty.Map(cty.Bool), Optional: true, Computed: true}, + }, + }, + Optional: true, + }, + }, + }, + cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + "nested_type": cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + "optional": cty.String, + "required": cty.Number, + "computed": cty.List(cty.Bool), + "optional_computed": cty.Map(cty.Bool), + }, []string{"optional", "computed", "optional_computed"}), + }, []string{"nested_type"}), + }, + "nested object-type attributes": { + &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "nested_type": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "optional": {Type: cty.String, Optional: true}, + "required": {Type: cty.Number, Required: true}, + "computed": {Type: cty.List(cty.Bool), Computed: true}, + "optional_computed": {Type: cty.Map(cty.Bool), Optional: true, Computed: true}, + "object": { + Type: cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + "optional": cty.String, + "required": cty.Number, + }, []string{"optional"}), + }, + }, + }, + Optional: true, + }, + }, + }, + cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + "nested_type": cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + "optional": cty.String, + "required": cty.Number, + "computed": cty.List(cty.Bool), + "optional_computed": cty.Map(cty.Bool), + "object": cty.ObjectWithOptionalAttrs(map[string]cty.Type{"optional": cty.String, "required": cty.Number}, []string{"optional"}), + }, []string{"optional", "computed", "optional_computed"}), + }, []string{"nested_type"}), + }, + "NestingList": { + &Object{ + Nesting: NestingList, + Attributes: map[string]*Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + cty.List(cty.ObjectWithOptionalAttrs(map[string]cty.Type{"foo": cty.String}, []string{"foo"})), + }, + "NestingMap": { + &Object{ + Nesting: NestingMap, + Attributes: map[string]*Attribute{ + "foo": {Type: cty.String}, + }, + }, + cty.Map(cty.Object(map[string]cty.Type{"foo": cty.String})), + }, + "NestingSet": { + &Object{ + Nesting: NestingSet, + Attributes: map[string]*Attribute{ + "foo": {Type: cty.String}, + }, + }, + cty.Set(cty.Object(map[string]cty.Type{"foo": cty.String})), + }, + "deeply nested NestingList": { + &Object{ + Nesting: NestingList, + Attributes: map[string]*Attribute{ + "foo": { + NestedType: &Object{ + Nesting: NestingList, + Attributes: map[string]*Attribute{ + "bar": {Type: cty.String}, + }, + }, + }, + }, + }, + cty.List(cty.Object(map[string]cty.Type{"foo": cty.List(cty.Object(map[string]cty.Type{"bar": cty.String}))})), + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + got := test.Schema.specType() + if !got.Equals(test.Want) { + t.Errorf("wrong result\ngot: %#v\nwant: %#v", got, test.Want) + } + }) + } +} From 43123d284e45327c5cf686dc2e477e0a919d0333 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 10 Sep 2021 09:38:59 -0400 Subject: [PATCH 057/644] optional attrs should not be in ProposedNew --- internal/plans/objchange/objchange_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/plans/objchange/objchange_test.go b/internal/plans/objchange/objchange_test.go index 7facea9e5378..77147989b885 100644 --- a/internal/plans/objchange/objchange_test.go +++ b/internal/plans/objchange/objchange_test.go @@ -1452,12 +1452,12 @@ func TestProposedNew(t *testing.T) { "map": cty.NullVal(cty.Map(cty.Object(map[string]cty.Type{"bar": cty.String}))), "set": cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{"bar": cty.String}))), "nested_map": cty.NullVal(cty.Map(cty.Object(map[string]cty.Type{ - "inner": cty.ObjectWithOptionalAttrs(map[string]cty.Type{ + "inner": cty.Object(map[string]cty.Type{ "optional": cty.String, "computed": cty.String, "optional_computed": cty.String, "required": cty.String, - }, []string{"computed", "optional", "optional_computed"}), + }), }))), }), }, From 53a73a8ab67bfff3d3b5e78359c808dd88979a4d Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 10 Sep 2021 10:58:44 -0400 Subject: [PATCH 058/644] configs: add ConstraintType to config.Variable In order to handle optional attributes, the Variable type needs to keep track of the type constraint for decoding and conversion, as well as the concrete type for creating values and type comparison. Since the Type field is referenced throughout the codebase, and for future refactoring if the handling of optional attributes changes significantly, the constraint is now loaded into an entirely new field called ConstraintType. This prevents types containing ObjectWithOptionalAttrs from escaping the decode/conversion codepaths into the rest of the codebase. --- internal/backend/unparsed_value_test.go | 23 +++++++++++-------- internal/configs/experiments.go | 2 +- internal/configs/module_merge.go | 3 ++- internal/configs/module_merge_test.go | 2 ++ internal/configs/named_values.go | 16 +++++++++---- internal/terraform/evaluate.go | 11 ++++++++- internal/terraform/evaluate_test.go | 16 ++++++++----- internal/terraform/node_module_variable.go | 5 ++-- .../terraform/node_module_variable_test.go | 17 ++++++++++---- internal/terraform/node_root_variable_test.go | 5 +++- internal/terraform/variables.go | 4 +--- 11 files changed, 70 insertions(+), 34 deletions(-) diff --git a/internal/backend/unparsed_value_test.go b/internal/backend/unparsed_value_test.go index 7d392e0cebad..6df7c226a47b 100644 --- a/internal/backend/unparsed_value_test.go +++ b/internal/backend/unparsed_value_test.go @@ -24,9 +24,10 @@ func TestParseVariableValuesUndeclared(t *testing.T) { } decls := map[string]*configs.Variable{ "declared1": { - Name: "declared1", - Type: cty.String, - ParsingMode: configs.VariableParseLiteral, + Name: "declared1", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, DeclRange: hcl.Range{ Filename: "fake.tf", Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, @@ -34,9 +35,10 @@ func TestParseVariableValuesUndeclared(t *testing.T) { }, }, "missing1": { - Name: "missing1", - Type: cty.String, - ParsingMode: configs.VariableParseLiteral, + Name: "missing1", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, DeclRange: hcl.Range{ Filename: "fake.tf", Start: hcl.Pos{Line: 3, Column: 1, Byte: 0}, @@ -44,10 +46,11 @@ func TestParseVariableValuesUndeclared(t *testing.T) { }, }, "missing2": { - Name: "missing1", - Type: cty.String, - ParsingMode: configs.VariableParseLiteral, - Default: cty.StringVal("default for missing2"), + Name: "missing1", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, + Default: cty.StringVal("default for missing2"), DeclRange: hcl.Range{ Filename: "fake.tf", Start: hcl.Pos{Line: 4, Column: 1, Byte: 0}, diff --git a/internal/configs/experiments.go b/internal/configs/experiments.go index 8a7e7cb667d1..4b8f10c412f1 100644 --- a/internal/configs/experiments.go +++ b/internal/configs/experiments.go @@ -198,7 +198,7 @@ func checkModuleExperiments(m *Module) hcl.Diagnostics { if !m.ActiveExperiments.Has(experiments.ModuleVariableOptionalAttrs) { for _, v := range m.Variables { - if typeConstraintHasOptionalAttrs(v.Type) { + if typeConstraintHasOptionalAttrs(v.ConstraintType) { diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: "Optional object type attributes are experimental", diff --git a/internal/configs/module_merge.go b/internal/configs/module_merge.go index d9b21cacce3a..014d2329cd3b 100644 --- a/internal/configs/module_merge.go +++ b/internal/configs/module_merge.go @@ -51,6 +51,7 @@ func (v *Variable) merge(ov *Variable) hcl.Diagnostics { } if ov.Type != cty.NilType { v.Type = ov.Type + v.ConstraintType = ov.ConstraintType } if ov.ParsingMode != 0 { v.ParsingMode = ov.ParsingMode @@ -67,7 +68,7 @@ func (v *Variable) merge(ov *Variable) hcl.Diagnostics { // constraint but the converted value cannot. In practice, this situation // should be rare since most of our conversions are interchangable. if v.Default != cty.NilVal { - val, err := convert.Convert(v.Default, v.Type) + val, err := convert.Convert(v.Default, v.ConstraintType) if err != nil { // What exactly we'll say in the error message here depends on whether // it was Default or Type that was overridden here. diff --git a/internal/configs/module_merge_test.go b/internal/configs/module_merge_test.go index c7db323163bc..0a57e06bc560 100644 --- a/internal/configs/module_merge_test.go +++ b/internal/configs/module_merge_test.go @@ -25,6 +25,7 @@ func TestModuleOverrideVariable(t *testing.T) { DescriptionSet: true, Default: cty.StringVal("b_override"), Type: cty.String, + ConstraintType: cty.String, ParsingMode: VariableParseLiteral, DeclRange: hcl.Range{ Filename: "testdata/valid-modules/override-variable/primary.tf", @@ -46,6 +47,7 @@ func TestModuleOverrideVariable(t *testing.T) { DescriptionSet: true, Default: cty.StringVal("b_override partial"), Type: cty.String, + ConstraintType: cty.String, ParsingMode: VariableParseLiteral, DeclRange: hcl.Range{ Filename: "testdata/valid-modules/override-variable/primary.tf", diff --git a/internal/configs/named_values.go b/internal/configs/named_values.go index 40c45685f052..21abd33c2253 100644 --- a/internal/configs/named_values.go +++ b/internal/configs/named_values.go @@ -22,7 +22,13 @@ type Variable struct { Name string Description string Default cty.Value - Type cty.Type + + // Type is the concrete type of the variable value. + Type cty.Type + // ConstraintType is used for decoding and type conversions, and may + // contain nested ObjectWithOptionalAttr types. + ConstraintType cty.Type + ParsingMode VariableParsingMode Validations []*VariableValidation Sensitive bool @@ -45,6 +51,7 @@ func decodeVariableBlock(block *hcl.Block, override bool) (*Variable, hcl.Diagno // or not they are set when we merge. if !override { v.Type = cty.DynamicPseudoType + v.ConstraintType = cty.DynamicPseudoType v.ParsingMode = VariableParseLiteral } @@ -92,7 +99,8 @@ func decodeVariableBlock(block *hcl.Block, override bool) (*Variable, hcl.Diagno if attr, exists := content.Attributes["type"]; exists { ty, parseMode, tyDiags := decodeVariableType(attr.Expr) diags = append(diags, tyDiags...) - v.Type = ty + v.ConstraintType = ty + v.Type = ty.WithoutOptionalAttributesDeep() v.ParsingMode = parseMode } @@ -112,9 +120,9 @@ func decodeVariableBlock(block *hcl.Block, override bool) (*Variable, hcl.Diagno // attribute above. // However, we can't do this if we're in an override file where // the type might not be set; we'll catch that during merge. - if v.Type != cty.NilType { + if v.ConstraintType != cty.NilType { var err error - val, err = convert.Convert(val, v.Type) + val, err = convert.Convert(val, v.ConstraintType) if err != nil { diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagError, diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index efcc9c1f418a..b7dbe68f0a10 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -238,7 +238,16 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd return cty.DynamicVal, diags } + // wantType is the concrete value type to be returned. wantType := cty.DynamicPseudoType + + // converstionType is the type used for conversion, which may include + // optional attributes. + conversionType := cty.DynamicPseudoType + + if config.ConstraintType != cty.NilType { + conversionType = config.ConstraintType + } if config.Type != cty.NilType { wantType = config.Type } @@ -282,7 +291,7 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd } var err error - val, err = convert.Convert(val, wantType) + val, err = convert.Convert(val, conversionType) if err != nil { // We should never get here because this problem should've been caught // during earlier validation, but we'll do something reasonable anyway. diff --git a/internal/terraform/evaluate_test.go b/internal/terraform/evaluate_test.go index f8a46d4fce1e..922f916c9eb4 100644 --- a/internal/terraform/evaluate_test.go +++ b/internal/terraform/evaluate_test.go @@ -95,15 +95,19 @@ func TestEvaluatorGetInputVariable(t *testing.T) { Module: &configs.Module{ Variables: map[string]*configs.Variable{ "some_var": { - Name: "some_var", - Sensitive: true, - Default: cty.StringVal("foo"), + Name: "some_var", + Sensitive: true, + Default: cty.StringVal("foo"), + Type: cty.String, + ConstraintType: cty.String, }, // Avoid double marking a value "some_other_var": { - Name: "some_other_var", - Sensitive: true, - Default: cty.StringVal("bar"), + Name: "some_other_var", + Sensitive: true, + Default: cty.StringVal("bar"), + Type: cty.String, + ConstraintType: cty.String, }, }, }, diff --git a/internal/terraform/node_module_variable.go b/internal/terraform/node_module_variable.go index 38ac62ac0596..3487f6d08807 100644 --- a/internal/terraform/node_module_variable.go +++ b/internal/terraform/node_module_variable.go @@ -200,7 +200,6 @@ func (n *nodeModuleVariable) DotNode(name string, opts *dag.DotOpts) *dag.DotNod // validation, and we will not have any expansion module instance // repetition data. func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnly bool) (map[string]cty.Value, error) { - wantType := n.Config.Type name := n.Addr.Variable.Name expr := n.Expr @@ -238,7 +237,7 @@ func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnl // now we can do our own local type conversion and produce an error message // with better context if it fails. var convErr error - val, convErr = convert.Convert(val, wantType) + val, convErr = convert.Convert(val, n.Config.ConstraintType) if convErr != nil { diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, @@ -251,7 +250,7 @@ func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnl }) // We'll return a placeholder unknown value to avoid producing // redundant downstream errors. - val = cty.UnknownVal(wantType) + val = cty.UnknownVal(n.Config.Type) } vals := make(map[string]cty.Value) diff --git a/internal/terraform/node_module_variable_test.go b/internal/terraform/node_module_variable_test.go index f060d3ea2868..e2b458cdbbbe 100644 --- a/internal/terraform/node_module_variable_test.go +++ b/internal/terraform/node_module_variable_test.go @@ -7,6 +7,7 @@ import ( "github.com/go-test/deep" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hclsyntax" + "github.com/zclconf/go-cty/cty" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" @@ -16,7 +17,9 @@ func TestNodeModuleVariablePath(t *testing.T) { n := &nodeModuleVariable{ Addr: addrs.RootModuleInstance.InputVariable("foo"), Config: &configs.Variable{ - Name: "foo", + Name: "foo", + Type: cty.String, + ConstraintType: cty.String, }, } @@ -31,7 +34,9 @@ func TestNodeModuleVariableReferenceableName(t *testing.T) { n := &nodeExpandModuleVariable{ Addr: addrs.InputVariable{Name: "foo"}, Config: &configs.Variable{ - Name: "foo", + Name: "foo", + Type: cty.String, + ConstraintType: cty.String, }, } @@ -64,7 +69,9 @@ func TestNodeModuleVariableReference(t *testing.T) { Addr: addrs.InputVariable{Name: "foo"}, Module: addrs.RootModule.Child("bar"), Config: &configs.Variable{ - Name: "foo", + Name: "foo", + Type: cty.String, + ConstraintType: cty.String, }, Expr: &hclsyntax.ScopeTraversalExpr{ Traversal: hcl.Traversal{ @@ -90,7 +97,9 @@ func TestNodeModuleVariableReference_grandchild(t *testing.T) { Addr: addrs.InputVariable{Name: "foo"}, Module: addrs.RootModule.Child("bar"), Config: &configs.Variable{ - Name: "foo", + Name: "foo", + Type: cty.String, + ConstraintType: cty.String, }, Expr: &hclsyntax.ScopeTraversalExpr{ Traversal: hcl.Traversal{ diff --git a/internal/terraform/node_root_variable_test.go b/internal/terraform/node_root_variable_test.go index 7a94f4b951ac..bd3d9c2d65c4 100644 --- a/internal/terraform/node_root_variable_test.go +++ b/internal/terraform/node_root_variable_test.go @@ -5,6 +5,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" + "github.com/zclconf/go-cty/cty" ) func TestNodeRootVariableExecute(t *testing.T) { @@ -13,7 +14,9 @@ func TestNodeRootVariableExecute(t *testing.T) { n := &NodeRootVariable{ Addr: addrs.InputVariable{Name: "foo"}, Config: &configs.Variable{ - Name: "foo", + Name: "foo", + Type: cty.String, + ConstraintType: cty.String, }, } diff --git a/internal/terraform/variables.go b/internal/terraform/variables.go index fca392802587..7a6ace0eee5c 100644 --- a/internal/terraform/variables.go +++ b/internal/terraform/variables.go @@ -262,10 +262,8 @@ func checkInputVariables(vcs map[string]*configs.Variable, vs InputValues) tfdia continue } - wantType := vc.Type - // A given value is valid if it can convert to the desired type. - _, err := convert.Convert(val.Value, wantType) + _, err := convert.Convert(val.Value, vc.ConstraintType) if err != nil { switch val.SourceType { case ValueFromConfig, ValueFromAutoFile, ValueFromNamedFile: From 7f26531d4fa7c064e5cca345d6574e0ee9b76400 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 10 Sep 2021 11:11:06 -0400 Subject: [PATCH 059/644] variable types should always be populated --- internal/terraform/evaluate.go | 27 ++++++--------------------- 1 file changed, 6 insertions(+), 21 deletions(-) diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index b7dbe68f0a10..62dbb791d7d4 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -237,21 +237,6 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd }) return cty.DynamicVal, diags } - - // wantType is the concrete value type to be returned. - wantType := cty.DynamicPseudoType - - // converstionType is the type used for conversion, which may include - // optional attributes. - conversionType := cty.DynamicPseudoType - - if config.ConstraintType != cty.NilType { - conversionType = config.ConstraintType - } - if config.Type != cty.NilType { - wantType = config.Type - } - d.Evaluator.VariableValuesLock.Lock() defer d.Evaluator.VariableValuesLock.Unlock() @@ -271,15 +256,15 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd if d.Operation == walkValidate { // Ensure variable sensitivity is captured in the validate walk if config.Sensitive { - return cty.UnknownVal(wantType).Mark(marks.Sensitive), diags + return cty.UnknownVal(config.Type).Mark(marks.Sensitive), diags } - return cty.UnknownVal(wantType), diags + return cty.UnknownVal(config.Type), diags } moduleAddrStr := d.ModulePath.String() vals := d.Evaluator.VariableValues[moduleAddrStr] if vals == nil { - return cty.UnknownVal(wantType), diags + return cty.UnknownVal(config.Type), diags } val, isSet := vals[addr.Name] @@ -287,11 +272,11 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd if config.Default != cty.NilVal { return config.Default, diags } - return cty.UnknownVal(wantType), diags + return cty.UnknownVal(config.Type), diags } var err error - val, err = convert.Convert(val, conversionType) + val, err = convert.Convert(val, config.ConstraintType) if err != nil { // We should never get here because this problem should've been caught // during earlier validation, but we'll do something reasonable anyway. @@ -303,7 +288,7 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd }) // Stub out our return value so that the semantic checker doesn't // produce redundant downstream errors. - val = cty.UnknownVal(wantType) + val = cty.UnknownVal(config.Type) } // Mark if sensitive From d0993b0e80d31acf6a4e8c1bb14c3080b63daa08 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 13 Sep 2021 13:22:36 -0400 Subject: [PATCH 060/644] fix temp directory handling in some tests Cleanup some more test fixtures to use t.TempDir Use EvalSymlinks with temp dir paths to help with MacOS errors from various terraform components. --- internal/backend/local/backend_local_test.go | 2 +- internal/backend/local/backend_plan_test.go | 22 +++++++------------- internal/backend/local/testing.go | 12 +---------- internal/command/command_test.go | 21 +++++-------------- internal/command/get_test.go | 6 ++---- internal/command/meta_backend_test.go | 3 +-- 6 files changed, 18 insertions(+), 48 deletions(-) diff --git a/internal/backend/local/backend_local_test.go b/internal/backend/local/backend_local_test.go index 67314d730c5c..fae2b1ae0953 100644 --- a/internal/backend/local/backend_local_test.go +++ b/internal/backend/local/backend_local_test.go @@ -132,7 +132,7 @@ func TestLocalRun_stalePlan(t *testing.T) { stateFile := statefile.New(plan.PriorState, "boop", 2) // Roundtrip through serialization as expected by the operation - outDir := testTempDir(t) + outDir := t.TempDir() defer os.RemoveAll(outDir) planPath := filepath.Join(outDir, "plan.tfplan") if err := planfile.Create(planPath, configload.NewEmptySnapshot(), prevStateFile, stateFile, plan); err != nil { diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 73bd78df4d79..0e7992111124 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -174,7 +174,7 @@ func TestLocal_planOutputsChanged(t *testing.T) { // unknown" situation because that's already common for printing out // resource changes and we already have many tests for that. })) - outDir := testTempDir(t) + outDir := t.TempDir() defer os.RemoveAll(outDir) planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan-outputs-changed") @@ -232,7 +232,7 @@ func TestLocal_planModuleOutputsChanged(t *testing.T) { OutputValue: addrs.OutputValue{Name: "changed"}, }, cty.StringVal("before"), false) })) - outDir := testTempDir(t) + outDir := t.TempDir() defer os.RemoveAll(outDir) planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan-module-outputs-changed") @@ -275,8 +275,7 @@ func TestLocal_planTainted(t *testing.T) { defer cleanup() p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState_tainted()) - outDir := testTempDir(t) - defer os.RemoveAll(outDir) + outDir := t.TempDir() planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan") defer configCleanup() @@ -356,8 +355,7 @@ func TestLocal_planDeposedOnly(t *testing.T) { }, ) })) - outDir := testTempDir(t) - defer os.RemoveAll(outDir) + outDir := t.TempDir() planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan") defer configCleanup() @@ -448,8 +446,7 @@ func TestLocal_planTainted_createBeforeDestroy(t *testing.T) { defer cleanup() p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState_tainted()) - outDir := testTempDir(t) - defer os.RemoveAll(outDir) + outDir := t.TempDir() planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan-cbd") defer configCleanup() @@ -540,8 +537,7 @@ func TestLocal_planDestroy(t *testing.T) { TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState()) - outDir := testTempDir(t) - defer os.RemoveAll(outDir) + outDir := t.TempDir() planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -594,8 +590,7 @@ func TestLocal_planDestroy_withDataSources(t *testing.T) { TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState_withDataSource()) - outDir := testTempDir(t) - defer os.RemoveAll(outDir) + outDir := t.TempDir() planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/destroy-with-ds") @@ -670,8 +665,7 @@ func TestLocal_planOutPathNoChange(t *testing.T) { TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState()) - outDir := testTempDir(t) - defer os.RemoveAll(outDir) + outDir := t.TempDir() planPath := filepath.Join(outDir, "plan.tfplan") op, configCleanup, done := testOperationPlan(t, "./testdata/plan") diff --git a/internal/backend/local/testing.go b/internal/backend/local/testing.go index d8230403b36f..bfff7f003584 100644 --- a/internal/backend/local/testing.go +++ b/internal/backend/local/testing.go @@ -1,7 +1,6 @@ package local import ( - "io/ioutil" "os" "path/filepath" "testing" @@ -24,7 +23,7 @@ import ( // public fields without any locks. func TestLocal(t *testing.T) (*Local, func()) { t.Helper() - tempDir := testTempDir(t) + tempDir := t.TempDir() local := New() local.StatePath = filepath.Join(tempDir, "state.tfstate") @@ -189,15 +188,6 @@ func (b *TestLocalNoDefaultState) StateMgr(name string) (statemgr.Full, error) { return b.Local.StateMgr(name) } -func testTempDir(t *testing.T) string { - d, err := ioutil.TempDir("", "tf") - if err != nil { - t.Fatalf("err: %s", err) - } - - return d -} - func testStateFile(t *testing.T, path string, s *states.State) { stateFile := statemgr.NewFilesystem(path) stateFile.WriteState(s) diff --git a/internal/command/command_test.go b/internal/command/command_test.go index e182807a0cfe..70da240e86ff 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -147,16 +147,10 @@ func tempWorkingDir(t *testing.T) (*workdir.Dir, func() error) { // the testWorkingDir commentary for an example of how to use this function // along with testChdir to meet the expectations of command.Meta legacy // functionality. -func tempWorkingDirFixture(t *testing.T, fixtureName string) (*workdir.Dir, func() error) { +func tempWorkingDirFixture(t *testing.T, fixtureName string) *workdir.Dir { t.Helper() - dirPath, err := os.MkdirTemp("", "tf-command-test-"+fixtureName) - if err != nil { - t.Fatal(err) - } - done := func() error { - return os.RemoveAll(dirPath) - } + dirPath := testTempDir(t) t.Logf("temporary directory %s with fixture %q", dirPath, fixtureName) fixturePath := testFixturePath(fixtureName) @@ -165,7 +159,7 @@ func tempWorkingDirFixture(t *testing.T, fixtureName string) (*workdir.Dir, func // on failure, a failure to copy will prevent us from cleaning up the // temporary directory. Oh well. :( - return workdir.NewDir(dirPath), done + return workdir.NewDir(dirPath) } func testFixturePath(name string) string { @@ -550,13 +544,8 @@ func testTempFile(t *testing.T) string { func testTempDir(t *testing.T) string { t.Helper() - - d, err := ioutil.TempDir(testingDir, "tf") - if err != nil { - t.Fatalf("err: %s", err) - } - - d, err = filepath.EvalSymlinks(d) + d := t.TempDir() + d, err := filepath.EvalSymlinks(d) if err != nil { t.Fatal(err) } diff --git a/internal/command/get_test.go b/internal/command/get_test.go index 2e9f04611ad1..b2a3ea0a75ac 100644 --- a/internal/command/get_test.go +++ b/internal/command/get_test.go @@ -8,8 +8,7 @@ import ( ) func TestGet(t *testing.T) { - wd, cleanup := tempWorkingDirFixture(t, "get") - defer cleanup() + wd := tempWorkingDirFixture(t, "get") defer testChdir(t, wd.RootModuleDir())() ui := cli.NewMockUi() @@ -56,8 +55,7 @@ func TestGet_multipleArgs(t *testing.T) { } func TestGet_update(t *testing.T) { - wd, cleanup := tempWorkingDirFixture(t, "get") - defer cleanup() + wd := tempWorkingDirFixture(t, "get") defer testChdir(t, wd.RootModuleDir())() ui := cli.NewMockUi() diff --git a/internal/command/meta_backend_test.go b/internal/command/meta_backend_test.go index 23f021b8245d..82dbb0355a4b 100644 --- a/internal/command/meta_backend_test.go +++ b/internal/command/meta_backend_test.go @@ -1855,8 +1855,7 @@ func TestMetaBackend_configToExtra(t *testing.T) { // no config; return inmem backend stored in state func TestBackendFromState(t *testing.T) { - wd, cleanup := tempWorkingDirFixture(t, "backend-from-state") - defer cleanup() + wd := tempWorkingDirFixture(t, "backend-from-state") defer testChdir(t, wd.RootModuleDir())() // Setup the meta From 172200808b8e6910e6bfe51010cb3aed04d76e6b Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 13 Sep 2021 14:21:26 -0500 Subject: [PATCH 061/644] Correct terraform.env deprecation message typo --- internal/terraform/evaluate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index 6fad6192eb31..5e746b6d1c5e 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -911,7 +911,7 @@ func (d *evaluationStateData) GetTerraformAttr(addr addrs.TerraformAttr, rng tfd diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: `Invalid "terraform" attribute`, - Detail: `The terraform.env attribute was deprecated in v0.10 and removed in v0.12. The "state environment" concept was rename to "workspace" in v0.12, and so the workspace name can now be accessed using the terraform.workspace attribute.`, + Detail: `The terraform.env attribute was deprecated in v0.10 and removed in v0.12. The "state environment" concept was renamed to "workspace" in v0.12, and so the workspace name can now be accessed using the terraform.workspace attribute.`, Subject: rng.ToHCL().Ptr(), }) return cty.DynamicVal, diags From 718fa3895f7364f75d0418595f15a31bb7b99ef7 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 14 Sep 2021 09:43:00 -0700 Subject: [PATCH 062/644] backend: Remove Operation.Parallelism field The presence of this field was confusing because in practice the local backend doesn't use it for anything and the remote backend was using it only to return an error if it's set to anything other than the default, under the assumption that it would always match ContextOpts.Parallelism. The "command" package is the one actually responsible for handling this option, and it does so by placing it into the partial ContextOpts which it passes into the backend when preparing for a local operation. To make that clearer, here we remove Operation.Parallelism and change the few uses of it to refer to ContextOpts.Parallelism instead, so that everyone is reading and writing this value from the same place. --- internal/backend/backend.go | 1 - internal/backend/remote/backend_apply.go | 2 +- internal/backend/remote/backend_apply_test.go | 6 ++++-- internal/backend/remote/backend_plan.go | 2 +- internal/backend/remote/backend_plan_test.go | 6 ++++-- internal/command/meta_backend.go | 1 - 6 files changed, 10 insertions(+), 8 deletions(-) diff --git a/internal/backend/backend.go b/internal/backend/backend.go index caac42cc6731..d8b28b9435f4 100644 --- a/internal/backend/backend.go +++ b/internal/backend/backend.go @@ -249,7 +249,6 @@ type Operation struct { // behavior of the operation. PlanMode plans.Mode AutoApprove bool - Parallelism int Targets []addrs.Targetable ForceReplace []addrs.AbsResourceInstance Variables map[string]UnparsedVariableValue diff --git a/internal/backend/remote/backend_apply.go b/internal/backend/remote/backend_apply.go index 2ec123d30afa..ef89466a235b 100644 --- a/internal/backend/remote/backend_apply.go +++ b/internal/backend/remote/backend_apply.go @@ -42,7 +42,7 @@ func (b *Remote) opApply(stopCtx, cancelCtx context.Context, op *backend.Operati return nil, diags.Err() } - if op.Parallelism != defaultParallelism { + if b.ContextOpts != nil && b.ContextOpts.Parallelism != defaultParallelism { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Custom parallelism values are currently not supported", diff --git a/internal/backend/remote/backend_apply_test.go b/internal/backend/remote/backend_apply_test.go index d54914559717..4bc2a909f288 100644 --- a/internal/backend/remote/backend_apply_test.go +++ b/internal/backend/remote/backend_apply_test.go @@ -46,7 +46,6 @@ func testOperationApplyWithTimeout(t *testing.T, configDir string, timeout time. return &backend.Operation{ ConfigDir: configDir, ConfigLoader: configLoader, - Parallelism: defaultParallelism, PlanRefresh: true, StateLocker: clistate.NewLocker(timeout, stateLockerView), Type: backend.OperationTypeApply, @@ -223,7 +222,10 @@ func TestRemote_applyWithParallelism(t *testing.T) { op, configCleanup, done := testOperationApply(t, "./testdata/apply") defer configCleanup() - op.Parallelism = 3 + if b.ContextOpts == nil { + b.ContextOpts = &terraform.ContextOpts{} + } + b.ContextOpts.Parallelism = 3 op.Workspace = backend.DefaultStateName run, err := b.Operation(context.Background(), op) diff --git a/internal/backend/remote/backend_plan.go b/internal/backend/remote/backend_plan.go index 82f33ec2dc3b..736c040b4d8b 100644 --- a/internal/backend/remote/backend_plan.go +++ b/internal/backend/remote/backend_plan.go @@ -38,7 +38,7 @@ func (b *Remote) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operatio return nil, diags.Err() } - if op.Parallelism != defaultParallelism { + if b.ContextOpts != nil && b.ContextOpts.Parallelism != defaultParallelism { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Custom parallelism values are currently not supported", diff --git a/internal/backend/remote/backend_plan_test.go b/internal/backend/remote/backend_plan_test.go index a231f149ecfa..6d4ced7b87a7 100644 --- a/internal/backend/remote/backend_plan_test.go +++ b/internal/backend/remote/backend_plan_test.go @@ -44,7 +44,6 @@ func testOperationPlanWithTimeout(t *testing.T, configDir string, timeout time.D return &backend.Operation{ ConfigDir: configDir, ConfigLoader: configLoader, - Parallelism: defaultParallelism, PlanRefresh: true, StateLocker: clistate.NewLocker(timeout, stateLockerView), Type: backend.OperationTypePlan, @@ -198,7 +197,10 @@ func TestRemote_planWithParallelism(t *testing.T) { op, configCleanup, done := testOperationPlan(t, "./testdata/plan") defer configCleanup() - op.Parallelism = 3 + if b.ContextOpts == nil { + b.ContextOpts = &terraform.ContextOpts{} + } + b.ContextOpts.Parallelism = 3 op.Workspace = backend.DefaultStateName run, err := b.Operation(context.Background(), op) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 71ebfbe26224..82ecd89c7850 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -349,7 +349,6 @@ func (m *Meta) Operation(b backend.Backend) *backend.Operation { return &backend.Operation{ PlanOutBackend: planOutBackend, - Parallelism: m.parallelism, Targets: m.targets, UIIn: m.UIInput(), UIOut: m.Ui, From 332ea1f233891e45bd274e714ab8e4e11c79dc95 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 14 Sep 2021 09:47:24 -0700 Subject: [PATCH 063/644] backend/local: TestLocal_plan_context_error to fail terraform.NewContext The original intent of this test was to verify that we properly release the state lock if terraform.NewContext fails. This was in response to a bug in an earlier version of Terraform where that wasn't true. In the recent refactoring that made terraform.NewContext no longer responsible for provider constraint/checksum verification, this test began testing a failed plan operation instead, which left the error return path from terraform.NewContext untested. An invalid parallelism value is the one remaining case where terraform.NewContext can return an error, so as a localized fix for this test I've switched it to just intentionally set an invalid parallelism value. This is still not ideal because it's still testing an implementation detail, but I've at least left a comment inline to try to be clearer about what the goal is here so that we can respond in a more appropriate way if future changes cause this test to fail again. In the long run I'd like to move this last remaining check out to be the responsibility of the CLI layer, with terraform.NewContext either just assuming the value correct or panicking when it isn't, but the handling of this CLI option is currently rather awkwardly spread across the command and backend packages so we'll save that refactoring for a later date. --- internal/backend/local/backend_plan_test.go | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 0e7992111124..7d5b92b161bb 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -119,9 +119,24 @@ func TestLocal_plan_context_error(t *testing.T) { b, cleanup := TestLocal(t) defer cleanup() + // This is an intentionally-invalid value to make terraform.NewContext fail + // when b.Operation calls it. + // NOTE: This test was originally using a provider initialization failure + // as its forced error condition, but terraform.NewContext is no longer + // responsible for checking that. Invalid parallelism is the last situation + // where terraform.NewContext can return error diagnostics, and arguably + // we should be validating this argument at the UI layer anyway, so perhaps + // in future we'll make terraform.NewContext never return errors and then + // this test will become redundant, because its purpose is specifically + // to test that we properly unlock the state if terraform.NewContext + // returns an error. + if b.ContextOpts == nil { + b.ContextOpts = &terraform.ContextOpts{} + } + b.ContextOpts.Parallelism = -1 + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") defer configCleanup() - op.PlanRefresh = true // we coerce a failure in Context() by omitting the provider schema run, err := b.Operation(context.Background(), op) @@ -136,7 +151,7 @@ func TestLocal_plan_context_error(t *testing.T) { // the backend should be unlocked after a run assertBackendStateUnlocked(t, b) - if got, want := done(t).Stderr(), "failed to read schema for test_instance.foo in registry.terraform.io/hashicorp/test"; !strings.Contains(got, want) { + if got, want := done(t).Stderr(), "Error: Invalid parallelism value"; !strings.Contains(got, want) { t.Fatalf("unexpected error output:\n%s\nwant: %s", got, want) } } From 902987061321e6860329d121178d166c254b8f46 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 14 Sep 2021 15:55:20 -0400 Subject: [PATCH 064/644] handle NestedTypes in Block.CoerceValue The CoerceValue code was not updated to handle NestedTypes, and while none of the new codepaths make use of this method, there are still some internal uses. --- internal/configs/configschema/coerce_value.go | 48 +++++++-------- .../configs/configschema/coerce_value_test.go | 61 +++++++++++++++++++ 2 files changed, 84 insertions(+), 25 deletions(-) diff --git a/internal/configs/configschema/coerce_value.go b/internal/configs/configschema/coerce_value.go index 41a533745c38..66804c375200 100644 --- a/internal/configs/configschema/coerce_value.go +++ b/internal/configs/configschema/coerce_value.go @@ -27,16 +27,19 @@ func (b *Block) CoerceValue(in cty.Value) (cty.Value, error) { } func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { + convType := b.specType() + impliedType := convType.WithoutOptionalAttributesDeep() + switch { case in.IsNull(): - return cty.NullVal(b.ImpliedType()), nil + return cty.NullVal(impliedType), nil case !in.IsKnown(): - return cty.UnknownVal(b.ImpliedType()), nil + return cty.UnknownVal(impliedType), nil } ty := in.Type() if !ty.IsObjectType() { - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("an object is required") + return cty.UnknownVal(impliedType), path.NewErrorf("an object is required") } for name := range ty.AttributeTypes() { @@ -46,29 +49,32 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { if _, defined := b.BlockTypes[name]; defined { continue } - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("unexpected attribute %q", name) + return cty.UnknownVal(impliedType), path.NewErrorf("unexpected attribute %q", name) } attrs := make(map[string]cty.Value) for name, attrS := range b.Attributes { + attrType := impliedType.AttributeType(name) + attrConvType := convType.AttributeType(name) + var val cty.Value switch { case ty.HasAttribute(name): val = in.GetAttr(name) case attrS.Computed || attrS.Optional: - val = cty.NullVal(attrS.Type) + val = cty.NullVal(attrType) default: - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("attribute %q is required", name) + return cty.UnknownVal(impliedType), path.NewErrorf("attribute %q is required", name) } - val, err := attrS.coerceValue(val, append(path, cty.GetAttrStep{Name: name})) + val, err := convert.Convert(val, attrConvType) if err != nil { - return cty.UnknownVal(b.ImpliedType()), err + return cty.UnknownVal(impliedType), append(path, cty.GetAttrStep{Name: name}).NewError(err) } - attrs[name] = val } + for typeName, blockS := range b.BlockTypes { switch blockS.Nesting { @@ -79,7 +85,7 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { val := in.GetAttr(typeName) attrs[typeName], err = blockS.coerceValue(val, append(path, cty.GetAttrStep{Name: typeName})) if err != nil { - return cty.UnknownVal(b.ImpliedType()), err + return cty.UnknownVal(impliedType), err } default: attrs[typeName] = blockS.EmptyValue() @@ -100,7 +106,7 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { } if !coll.CanIterateElements() { - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("must be a list") + return cty.UnknownVal(impliedType), path.NewErrorf("must be a list") } l := coll.LengthInt() @@ -116,7 +122,7 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { idx, val := it.Element() val, err = blockS.coerceValue(val, append(path, cty.IndexStep{Key: idx})) if err != nil { - return cty.UnknownVal(b.ImpliedType()), err + return cty.UnknownVal(impliedType), err } elems = append(elems, val) } @@ -141,7 +147,7 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { } if !coll.CanIterateElements() { - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("must be a set") + return cty.UnknownVal(impliedType), path.NewErrorf("must be a set") } l := coll.LengthInt() @@ -157,7 +163,7 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { idx, val := it.Element() val, err = blockS.coerceValue(val, append(path, cty.IndexStep{Key: idx})) if err != nil { - return cty.UnknownVal(b.ImpliedType()), err + return cty.UnknownVal(impliedType), err } elems = append(elems, val) } @@ -182,7 +188,7 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { } if !coll.CanIterateElements() { - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("must be a map") + return cty.UnknownVal(impliedType), path.NewErrorf("must be a map") } l := coll.LengthInt() if l == 0 { @@ -196,11 +202,11 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { var err error key, val := it.Element() if key.Type() != cty.String || key.IsNull() || !key.IsKnown() { - return cty.UnknownVal(b.ImpliedType()), path.NewErrorf("must be a map") + return cty.UnknownVal(impliedType), path.NewErrorf("must be a map") } val, err = blockS.coerceValue(val, append(path, cty.IndexStep{Key: key})) if err != nil { - return cty.UnknownVal(b.ImpliedType()), err + return cty.UnknownVal(impliedType), err } elems[key.AsString()] = val } @@ -240,11 +246,3 @@ func (b *Block) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { return cty.ObjectVal(attrs), nil } - -func (a *Attribute) coerceValue(in cty.Value, path cty.Path) (cty.Value, error) { - val, err := convert.Convert(in, a.Type) - if err != nil { - return cty.UnknownVal(a.Type), path.NewError(err) - } - return val, nil -} diff --git a/internal/configs/configschema/coerce_value_test.go b/internal/configs/configschema/coerce_value_test.go index 3f57b174bef3..37f81b76986f 100644 --- a/internal/configs/configschema/coerce_value_test.go +++ b/internal/configs/configschema/coerce_value_test.go @@ -538,6 +538,67 @@ func TestCoerceValue(t *testing.T) { }), ``, }, + "nested types": { + // handle NestedTypes + &Block{ + Attributes: map[string]*Attribute{ + "foo": { + NestedType: &Object{ + Nesting: NestingList, + Attributes: map[string]*Attribute{ + "bar": { + Type: cty.String, + Required: true, + }, + "baz": { + Type: cty.Map(cty.String), + Optional: true, + }, + }, + }, + Optional: true, + }, + "fob": { + NestedType: &Object{ + Nesting: NestingSet, + Attributes: map[string]*Attribute{ + "bar": { + Type: cty.String, + Optional: true, + }, + }, + }, + Optional: true, + }, + }, + }, + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("beep"), + }), + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("boop"), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("beep"), + "baz": cty.NullVal(cty.Map(cty.String)), + }), + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("boop"), + "baz": cty.NullVal(cty.Map(cty.String)), + }), + }), + "fob": cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{ + "bar": cty.String, + }))), + }), + ``, + }, } for name, test := range tests { From 331dc8b14ccdb75d6ed19e740803bf839c218842 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 14 Sep 2021 16:36:45 -0400 Subject: [PATCH 065/644] handle empty containers in ProposedNew NestedTypes Empty containers of NestedTypes were not handled in ProposedNew, causing plans to be submitted with null values where there was configuration present. --- internal/plans/objchange/objchange.go | 13 ++-- internal/plans/objchange/objchange_test.go | 75 ++++++++++++++++++++++ 2 files changed, 79 insertions(+), 9 deletions(-) diff --git a/internal/plans/objchange/objchange.go b/internal/plans/objchange/objchange.go index 281b9dd13ac0..739d666480bc 100644 --- a/internal/plans/objchange/objchange.go +++ b/internal/plans/objchange/objchange.go @@ -308,7 +308,9 @@ func proposedNewAttributes(attrs map[string]*configschema.Attribute, prior, conf } func proposedNewNestedType(schema *configschema.Object, prior, config cty.Value) cty.Value { - var newV cty.Value + // If the config is null or empty, we will be using this default value. + newV := config + switch schema.Nesting { case configschema.NestingSingle: if !config.IsNull() { @@ -323,6 +325,7 @@ func proposedNewNestedType(schema *configschema.Object, prior, config cty.Value) if config.IsKnown() && !config.IsNull() { configVLen = config.LengthInt() } + if configVLen > 0 { newVals := make([]cty.Value, 0, configVLen) for it := config.ElementIterator(); it.Next(); { @@ -345,8 +348,6 @@ func proposedNewNestedType(schema *configschema.Object, prior, config cty.Value) } else { newV = cty.ListVal(newVals) } - } else { - newV = cty.NullVal(schema.ImpliedType()) } case configschema.NestingMap: @@ -378,8 +379,6 @@ func proposedNewNestedType(schema *configschema.Object, prior, config cty.Value) // object values so that elements might have different types // in case of dynamically-typed attributes. newV = cty.ObjectVal(newVals) - } else { - newV = cty.NullVal(schema.ImpliedType()) } } else { configVLen := 0 @@ -403,8 +402,6 @@ func proposedNewNestedType(schema *configschema.Object, prior, config cty.Value) newVals[k] = cty.ObjectVal(newEV) } newV = cty.MapVal(newVals) - } else { - newV = cty.NullVal(schema.ImpliedType()) } } @@ -446,8 +443,6 @@ func proposedNewNestedType(schema *configschema.Object, prior, config cty.Value) } } newV = cty.SetVal(newVals) - } else { - newV = cty.NullVal(schema.ImpliedType()) } } diff --git a/internal/plans/objchange/objchange_test.go b/internal/plans/objchange/objchange_test.go index 77147989b885..b0021fb14b20 100644 --- a/internal/plans/objchange/objchange_test.go +++ b/internal/plans/objchange/objchange_test.go @@ -1461,6 +1461,81 @@ func TestProposedNew(t *testing.T) { }))), }), }, + "expected empty NestedTypes": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "set": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSet, + Attributes: map[string]*configschema.Attribute{ + "bar": {Type: cty.String}, + }, + }, + Optional: true, + }, + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "bar": {Type: cty.String}, + }, + }, + Optional: true, + }, + }, + }, + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapValEmpty(cty.Object(map[string]cty.Type{"bar": cty.String})), + "set": cty.SetValEmpty(cty.Object(map[string]cty.Type{"bar": cty.String})), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapValEmpty(cty.Object(map[string]cty.Type{"bar": cty.String})), + "set": cty.SetValEmpty(cty.Object(map[string]cty.Type{"bar": cty.String})), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapValEmpty(cty.Object(map[string]cty.Type{"bar": cty.String})), + "set": cty.SetValEmpty(cty.Object(map[string]cty.Type{"bar": cty.String})), + }), + }, + "optional types set replacement": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "set": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSet, + Attributes: map[string]*configschema.Attribute{ + "bar": { + Type: cty.String, + Required: true, + }, + }, + }, + Optional: true, + }, + }, + }, + cty.ObjectVal(map[string]cty.Value{ + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("old"), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("new"), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "set": cty.SetVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "bar": cty.StringVal("new"), + }), + }), + }), + }, } for name, test := range tests { From b4594551f768589d1c6a36177f3ad2f0cadf6157 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 14 Sep 2021 15:19:28 -0700 Subject: [PATCH 066/644] refactoring: TestValidateMoves/cyclic_chain can now pass When originally filling out these test cases we didn't yet have the logic in place to detect chained moves and so this test couldn't succeed in spite of being correct. We now have chain-detection implemented and so consequently we can also detect cyclic chains. This commit largely just enables the original test unchanged, although it does include the text of the final error message for reporting cyclic move chains which wasn't yet finalized when we were stubbing out this test case originally. --- internal/refactoring/move_validate_test.go | 48 +++++++++++----------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/internal/refactoring/move_validate_test.go b/internal/refactoring/move_validate_test.go index 5ab83d3aa283..7ec8ab2f9e28 100644 --- a/internal/refactoring/move_validate_test.go +++ b/internal/refactoring/move_validate_test.go @@ -129,31 +129,31 @@ func TestValidateMoves(t *testing.T) { }, WantError: `Redundant move statement: This statement declares a move from module.a to the same address, which is the same as not declaring this move at all.`, }, - /* - // TODO: This test can't pass until we've implemented - // addrs.MoveEndpointInModule.CanChainFrom, which is what - // detects the chaining condition this is testing for. - "cyclic chain": { - Statements: []MoveStatement{ - makeTestMoveStmt(t, - ``, - `module.a`, - `module.b`, - ), - makeTestMoveStmt(t, - ``, - `module.b`, - `module.c`, - ), - makeTestMoveStmt(t, - ``, - `module.c`, - `module.a`, - ), - }, - WantError: `bad cycle`, + "cyclic chain": { + Statements: []MoveStatement{ + makeTestMoveStmt(t, + ``, + `module.a`, + `module.b`, + ), + makeTestMoveStmt(t, + ``, + `module.b`, + `module.c`, + ), + makeTestMoveStmt(t, + ``, + `module.c`, + `module.a`, + ), }, - */ + WantError: `Cyclic dependency in move statements: The following chained move statements form a cycle, and so there is no final location to move objects to: + - test:1,1: module.a[*] → module.b[*] + - test:1,1: module.b[*] → module.c[*] + - test:1,1: module.c[*] → module.a[*] + +A chain of move statements must end with an address that doesn't appear in any other statements, and which typically also refers to an object still declared in the configuration.`, + }, "module.single as a call still exists in configuration": { Statements: []MoveStatement{ makeTestMoveStmt(t, From e6a76d8ba0694a1068e5664f32a6911b3bfb3e65 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 15 Sep 2021 15:54:16 -0700 Subject: [PATCH 067/644] core: Fail if a moved resource instance is excluded by -target Because "moved" blocks produce changes that span across more than one resource instance address at the same time, we need to take extra care with them during planning. The -target option allows for restricting Terraform's attention only to a subset of resources when planning, as an escape hatch to recover from bugs and mistakes. However, we need to avoid any situation where only one "side" of a move would be considered in a particular plan, because that'd create a new situation that would be otherwise unreachable and would be difficult to recover from. As a compromise then, we'll reject an attempt to create a targeted plan if the plan involves resolving a pending move and if the source address of that move is not included in the targets. Our error message offers the user two possible resolutions: to create an untargeted plan, thus allowing everything to resolve, or to add additional -target options to include just the existing resource instances that have pending moves to resolve. This compromise recognizes that it is possible -- though hopefully rare -- that a user could potentially both be recovering from a bug or mistake at the same time as processing a move, if e.g. the bug was fixed by upgrading a module and the new version includes a new "moved" block. In that edge case, it might be necessary to just add the one additional address to the targets rather than removing the targets altogether, if creating a normal untargeted plan is impossible due to whatever bug they're trying to recover from. --- internal/terraform/context_plan.go | 92 +++++++++-- internal/terraform/context_plan2_test.go | 199 +++++++++++++++++++++++ 2 files changed, 277 insertions(+), 14 deletions(-) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 248673254cf0..7d1353c6a5df 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -3,6 +3,8 @@ package terraform import ( "fmt" "log" + "sort" + "strings" "github.com/zclconf/go-cty/cty" @@ -113,7 +115,7 @@ func (c *Context) Plan(config *configs.Config, prevRunState *states.State, opts tfdiags.Warning, "Resource targeting is in effect", `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. - + The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, )) } @@ -297,23 +299,75 @@ func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState *states.State, targets []addrs.Targetable) ([]refactoring.MoveStatement, map[addrs.UniqueKey]refactoring.MoveResult) { moveStmts := refactoring.FindMoveStatements(config) moveResults := refactoring.ApplyMoves(moveStmts, prevRunState) - if len(targets) > 0 { - for _, result := range moveResults { - matchesTarget := false - for _, targetAddr := range targets { - if targetAddr.TargetContains(result.From) { - matchesTarget = true - break - } + return moveStmts, moveResults +} + +func (c *Context) prePlanVerifyTargetedMoves(moveResults map[addrs.UniqueKey]refactoring.MoveResult, targets []addrs.Targetable) tfdiags.Diagnostics { + if len(targets) < 1 { + return nil // the following only matters when targeting + } + + var diags tfdiags.Diagnostics + + var excluded []addrs.AbsResourceInstance + for _, result := range moveResults { + fromMatchesTarget := false + toMatchesTarget := false + for _, targetAddr := range targets { + if targetAddr.TargetContains(result.From) { + fromMatchesTarget = true } - //lint:ignore SA9003 TODO - if !matchesTarget { - // TODO: Return an error stating that a targeted plan is - // only valid if it includes this address that was moved. + if targetAddr.TargetContains(result.To) { + toMatchesTarget = true } } + if !fromMatchesTarget { + excluded = append(excluded, result.From) + } + if !toMatchesTarget { + excluded = append(excluded, result.To) + } } - return moveStmts, moveResults + if len(excluded) > 0 { + sort.Slice(excluded, func(i, j int) bool { + return excluded[i].Less(excluded[j]) + }) + + var listBuf strings.Builder + var prevResourceAddr addrs.AbsResource + for _, instAddr := range excluded { + // Targeting generally ends up selecting whole resources rather + // than individual instances, because we don't factor in + // individual instances until DynamicExpand, so we're going to + // always show whole resource addresses here, excluding any + // instance keys. (This also neatly avoids dealing with the + // different quoting styles required for string instance keys + // on different shells, which is handy.) + // + // To avoid showing duplicates when we have multiple instances + // of the same resource, we'll remember the most recent + // resource we rendered in prevResource, which is sufficient + // because we sorted the list of instance addresses above, and + // our sort order always groups together instances of the same + // resource. + resourceAddr := instAddr.ContainingResource() + if resourceAddr.Equal(prevResourceAddr) { + continue + } + fmt.Fprintf(&listBuf, "\n -target=%q", resourceAddr.String()) + prevResourceAddr = resourceAddr + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Moved resource instances excluded by targeting", + fmt.Sprintf( + "Resource instances in your current state have moved to new addresses in the latest configuration. Terraform must include those resource instances while planning in order to ensure a correct result, but your -target=... options to not fully cover all of those resource instances.\n\nTo create a valid plan, either remove your -target=... options altogether or add the following additional target options:%s\n\nNote that adding these options may include further additional resource instances in your plan, in order to respect object dependencies.", + listBuf.String(), + ), + )) + } + + return diags } func (c *Context) postPlanValidateMoves(config *configs.Config, stmts []refactoring.MoveStatement, allInsts instances.Set) tfdiags.Diagnostics { @@ -327,6 +381,16 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r prevRunState = prevRunState.DeepCopy() // don't modify the caller's object when we process the moves moveStmts, moveResults := c.prePlanFindAndApplyMoves(config, prevRunState, opts.Targets) + // If resource targeting is in effect then it might conflict with the + // move result. + diags = diags.Append(c.prePlanVerifyTargetedMoves(moveResults, opts.Targets)) + if diags.HasErrors() { + // We'll return early here, because if we have any moved resource + // instances excluded by targeting then planning is likely to encounter + // strange problems that may lead to confusing error messages. + return nil, diags + } + graph, walkOp, moreDiags := c.planGraph(config, prevRunState, opts, true) diags = diags.Append(moreDiags) if diags.HasErrors() { diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 53053fedadc1..a1c4e9feb94b 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -7,12 +7,14 @@ import ( "testing" "github.com/davecgh/go-spew/spew" + "github.com/google/go-cmp/cmp" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/lang/marks" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" ) @@ -772,6 +774,203 @@ func TestContext2Plan_movedResourceBasic(t *testing.T) { }) } +func TestContext2Plan_movedResourceUntargeted(t *testing.T) { + addrA := mustResourceInstanceAddr("test_object.a") + addrB := mustResourceInstanceAddr("test_object.b") + m := testModuleInline(t, map[string]string{ + "main.tf": ` + resource "test_object" "b" { + } + + moved { + from = test_object.a + to = test_object.b + } + + terraform { + experiments = [config_driven_move] + } + `, + }) + + state := states.BuildState(func(s *states.SyncState) { + // The prior state tracks test_object.a, which we should treat as + // test_object.b because of the "moved" block in the config. + s.SetResourceInstanceCurrent(addrA, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + + p := simpleMockProvider() + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + t.Run("without targeting instance A", func(t *testing.T) { + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + // NOTE: addrA isn't included here, but it's pending move to addrB + // and so this plan request is invalid. + addrB, + }, + }) + diags.Sort() + + // We're semi-abusing "ForRPC" here just to get diagnostics that are + // more easily comparable than the various different diagnostics types + // tfdiags uses internally. The RPC-friendly diagnostics are also + // comparison-friendly, by discarding all of the dynamic type information. + gotDiags := diags.ForRPC() + wantDiags := tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Warning, + "Resource targeting is in effect", + `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. + +The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, + ), + tfdiags.Sourceless( + tfdiags.Error, + "Moved resource instances excluded by targeting", + `Resource instances in your current state have moved to new addresses in the latest configuration. Terraform must include those resource instances while planning in order to ensure a correct result, but your -target=... options to not fully cover all of those resource instances. + +To create a valid plan, either remove your -target=... options altogether or add the following additional target options: + -target="test_object.a" + +Note that adding these options may include further additional resource instances in your plan, in order to respect object dependencies.`, + ), + }.ForRPC() + + if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { + t.Errorf("wrong diagnostics\n%s", diff) + } + }) + t.Run("without targeting instance B", func(t *testing.T) { + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + addrA, + // NOTE: addrB isn't included here, but it's pending move from + // addrA and so this plan request is invalid. + }, + }) + diags.Sort() + + // We're semi-abusing "ForRPC" here just to get diagnostics that are + // more easily comparable than the various different diagnostics types + // tfdiags uses internally. The RPC-friendly diagnostics are also + // comparison-friendly, by discarding all of the dynamic type information. + gotDiags := diags.ForRPC() + wantDiags := tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Warning, + "Resource targeting is in effect", + `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. + +The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, + ), + tfdiags.Sourceless( + tfdiags.Error, + "Moved resource instances excluded by targeting", + `Resource instances in your current state have moved to new addresses in the latest configuration. Terraform must include those resource instances while planning in order to ensure a correct result, but your -target=... options to not fully cover all of those resource instances. + +To create a valid plan, either remove your -target=... options altogether or add the following additional target options: + -target="test_object.b" + +Note that adding these options may include further additional resource instances in your plan, in order to respect object dependencies.`, + ), + }.ForRPC() + + if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { + t.Errorf("wrong diagnostics\n%s", diff) + } + }) + t.Run("without targeting either instance", func(t *testing.T) { + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + mustResourceInstanceAddr("test_object.unrelated"), + // NOTE: neither addrA nor addrB are included here, but there's + // a pending move between them and so this is invalid. + }, + }) + diags.Sort() + + // We're semi-abusing "ForRPC" here just to get diagnostics that are + // more easily comparable than the various different diagnostics types + // tfdiags uses internally. The RPC-friendly diagnostics are also + // comparison-friendly, by discarding all of the dynamic type information. + gotDiags := diags.ForRPC() + wantDiags := tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Warning, + "Resource targeting is in effect", + `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. + +The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, + ), + tfdiags.Sourceless( + tfdiags.Error, + "Moved resource instances excluded by targeting", + `Resource instances in your current state have moved to new addresses in the latest configuration. Terraform must include those resource instances while planning in order to ensure a correct result, but your -target=... options to not fully cover all of those resource instances. + +To create a valid plan, either remove your -target=... options altogether or add the following additional target options: + -target="test_object.a" + -target="test_object.b" + +Note that adding these options may include further additional resource instances in your plan, in order to respect object dependencies.`, + ), + }.ForRPC() + + if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { + t.Errorf("wrong diagnostics\n%s", diff) + } + }) + t.Run("with both addresses in the target set", func(t *testing.T) { + // The error messages in the other subtests above suggest adding + // addresses to the set of targets. This additional test makes sure that + // following that advice actually leads to a valid result. + + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + Targets: []addrs.Targetable{ + // This time we're including both addresses in the target, + // to get the same effect an end-user would get if following + // the advice in our error message in the other subtests. + addrA, + addrB, + }, + }) + diags.Sort() + + // We're semi-abusing "ForRPC" here just to get diagnostics that are + // more easily comparable than the various different diagnostics types + // tfdiags uses internally. The RPC-friendly diagnostics are also + // comparison-friendly, by discarding all of the dynamic type information. + gotDiags := diags.ForRPC() + wantDiags := tfdiags.Diagnostics{ + // Still get the warning about the -target option... + tfdiags.Sourceless( + tfdiags.Warning, + "Resource targeting is in effect", + `You are creating a plan with the -target option, which means that the result of this plan may not represent all of the changes requested by the current configuration. + +The -target option is not for routine use, and is provided only for exceptional situations such as recovering from errors or mistakes, or when Terraform specifically suggests to use it as part of an error message.`, + ), + // ...but now we have no error about test_object.a + }.ForRPC() + + if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { + t.Errorf("wrong diagnostics\n%s", diff) + } + + }) +} + func TestContext2Plan_refreshOnlyMode(t *testing.T) { addr := mustResourceInstanceAddr("test_object.a") From bebf1ad23a674559c3257fc3ec6b55546e85dc03 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 13 Sep 2021 16:29:15 -0400 Subject: [PATCH 068/644] core: Compute resource drift after plan walk Rather than delaying resource drift detection until it is ready to be presented, here we perform that computation after the plan walk has completed. The resulting drift is represented like planned resource changes, using a slice of ResourceInstanceChangeSrc values. --- internal/plans/plan.go | 1 + internal/terraform/context_plan.go | 134 ++++++++++++++++++++- internal/terraform/context_plan2_test.go | 22 ++++ internal/terraform/context_refresh_test.go | 12 ++ 4 files changed, 165 insertions(+), 4 deletions(-) diff --git a/internal/plans/plan.go b/internal/plans/plan.go index 68e60ad98ab6..a96a056480e1 100644 --- a/internal/plans/plan.go +++ b/internal/plans/plan.go @@ -31,6 +31,7 @@ type Plan struct { VariableValues map[string]DynamicValue Changes *Changes + DriftedResources []*ResourceInstanceChangeSrc TargetAddrs []addrs.Targetable ForceReplaceAddrs []addrs.AbsResourceInstance ProviderSHA256s map[string][]byte diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 248673254cf0..0326e083307a 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -347,11 +347,17 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r diags = diags.Append(walkDiags) diags = diags.Append(c.postPlanValidateMoves(config, moveStmts, walker.InstanceExpander.AllInstances())) + prevRunState = walker.PrevRunState.Close() + priorState := walker.RefreshState.Close() + driftedResources, driftDiags := c.driftedResources(config, prevRunState, priorState, moveResults) + diags = diags.Append(driftDiags) + plan := &plans.Plan{ - UIMode: opts.Mode, - Changes: changes, - PriorState: walker.RefreshState.Close(), - PrevRunState: walker.PrevRunState.Close(), + UIMode: opts.Mode, + Changes: changes, + DriftedResources: driftedResources, + PrevRunState: prevRunState, + PriorState: priorState, // Other fields get populated by Context.Plan after we return } @@ -398,6 +404,126 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, } } +func (c *Context) driftedResources(config *configs.Config, oldState, newState *states.State, moves map[addrs.UniqueKey]refactoring.MoveResult) ([]*plans.ResourceInstanceChangeSrc, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + if newState.ManagedResourcesEqual(oldState) { + // Nothing to do, because we only detect and report drift for managed + // resource instances. + return nil, diags + } + + schemas, schemaDiags := c.Schemas(config, newState) + diags = diags.Append(schemaDiags) + if diags.HasErrors() { + return nil, diags + } + + var drs []*plans.ResourceInstanceChangeSrc + + for _, ms := range oldState.Modules { + for _, rs := range ms.Resources { + if rs.Addr.Resource.Mode != addrs.ManagedResourceMode { + // Drift reporting is only for managed resources + continue + } + + provider := rs.ProviderConfig.Provider + for key, oldIS := range rs.Instances { + if oldIS.Current == nil { + // Not interested in instances that only have deposed objects + continue + } + addr := rs.Addr.Instance(key) + newIS := newState.ResourceInstance(addr) + + schema, _ := schemas.ResourceTypeConfig( + provider, + addr.Resource.Resource.Mode, + addr.Resource.Resource.Type, + ) + if schema == nil { + // This should never happen, but just in case + return nil, diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Missing resource schema from provider", + fmt.Sprintf("No resource schema found for %s.", addr.Resource.Resource.Type), + )) + } + ty := schema.ImpliedType() + + oldObj, err := oldIS.Current.Decode(ty) + if err != nil { + // This should also never happen + return nil, diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to decode resource from state", + fmt.Sprintf("Error decoding %q from previous state: %s", addr.String(), err), + )) + } + + var newObj *states.ResourceInstanceObject + if newIS != nil && newIS.Current != nil { + newObj, err = newIS.Current.Decode(ty) + if err != nil { + // This should also never happen + return nil, diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to decode resource from state", + fmt.Sprintf("Error decoding %q from prior state: %s", addr.String(), err), + )) + } + } + + var oldVal, newVal cty.Value + oldVal = oldObj.Value + if newObj != nil { + newVal = newObj.Value + } else { + newVal = cty.NullVal(ty) + } + + if oldVal.RawEquals(newVal) { + // No drift if the two values are semantically equivalent + continue + } + + // We can only detect updates and deletes as drift. + action := plans.Update + if newVal.IsNull() { + action = plans.Delete + } + + prevRunAddr := addr + if move, ok := moves[addr.UniqueKey()]; ok { + prevRunAddr = move.From + } + + change := &plans.ResourceInstanceChange{ + Addr: addr, + PrevRunAddr: prevRunAddr, + ProviderAddr: rs.ProviderConfig, + Change: plans.Change{ + Action: action, + Before: oldVal, + After: newVal, + }, + } + + changeSrc, err := change.Encode(ty) + if err != nil { + diags = diags.Append(err) + return nil, diags + } + + drs = append(drs, changeSrc) + } + } + } + + return drs, diags +} + // PlanGraphForUI is a last vestage of graphs in the public interface of Context // (as opposed to graphs as an implementation detail) intended only for use // by the "terraform graph" command when asked to render a plan-time graph. diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 53053fedadc1..fc670ce31255 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -106,6 +106,23 @@ resource "test_object" "a" { } } + // This situation should result in a drifted resource change. + var drifted *plans.ResourceInstanceChangeSrc + for _, dr := range plan.DriftedResources { + if dr.Addr.Equal(addr) { + drifted = dr + break + } + } + + if drifted == nil { + t.Errorf("instance %s is missing from the drifted resource changes", addr) + } else { + if got, want := drifted.Action, plans.Delete; got != want { + t.Errorf("unexpected instance %s drifted resource change action. got: %s, want: %s", addr, got, want) + } + } + // Because the configuration still mentions test_object.a, we should've // planned to recreate it in order to fix the drift. for _, c := range plan.Changes.Resources { @@ -1037,6 +1054,11 @@ func TestContext2Plan_refreshOnlyMode_deposed(t *testing.T) { t.Errorf("wrong value for output value 'out'\ngot: %#v\nwant: %#v", got, want) } } + + // Deposed objects should not be represented in drift. + if len(plan.DriftedResources) > 0 { + t.Errorf("unexpected drifted resources (%d)", len(plan.DriftedResources)) + } } func TestContext2Plan_invalidSensitiveModuleOutput(t *testing.T) { diff --git a/internal/terraform/context_refresh_test.go b/internal/terraform/context_refresh_test.go index dd319254a6f2..49cd02e0ea5a 100644 --- a/internal/terraform/context_refresh_test.go +++ b/internal/terraform/context_refresh_test.go @@ -219,6 +219,10 @@ func TestContext2Refresh_targeted(t *testing.T) { ResourceTypes: map[string]*configschema.Block{ "aws_elb": { Attributes: map[string]*configschema.Attribute{ + "id": { + Type: cty.String, + Computed: true, + }, "instances": { Type: cty.Set(cty.String), Optional: true, @@ -295,6 +299,10 @@ func TestContext2Refresh_targetedCount(t *testing.T) { ResourceTypes: map[string]*configschema.Block{ "aws_elb": { Attributes: map[string]*configschema.Attribute{ + "id": { + Type: cty.String, + Computed: true, + }, "instances": { Type: cty.Set(cty.String), Optional: true, @@ -381,6 +389,10 @@ func TestContext2Refresh_targetedCountIndex(t *testing.T) { ResourceTypes: map[string]*configschema.Block{ "aws_elb": { Attributes: map[string]*configschema.Attribute{ + "id": { + Type: cty.String, + Computed: true, + }, "instances": { Type: cty.Set(cty.String), Optional: true, From c4688345a1c050a6410395fc4f24553df66ecee9 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 13 Sep 2021 16:49:19 -0400 Subject: [PATCH 069/644] plans: Add resource drift to the plan file format --- .../plans/internal/planproto/planfile.pb.go | 294 +++++++++--------- .../plans/internal/planproto/planfile.proto | 5 + internal/plans/planfile/planfile_test.go | 3 +- internal/plans/planfile/tfplan.go | 20 ++ internal/plans/planfile/tfplan_test.go | 41 +++ 5 files changed, 223 insertions(+), 140 deletions(-) diff --git a/internal/plans/internal/planproto/planfile.pb.go b/internal/plans/internal/planproto/planfile.pb.go index 9f541946c6d5..a612c03a3887 100644 --- a/internal/plans/internal/planproto/planfile.pb.go +++ b/internal/plans/internal/planproto/planfile.pb.go @@ -222,6 +222,10 @@ type Plan struct { // configuration, including any nested modules. Use the address of // each resource to determine which module it belongs to. ResourceChanges []*ResourceInstanceChange `protobuf:"bytes,3,rep,name=resource_changes,json=resourceChanges,proto3" json:"resource_changes,omitempty"` + // An unordered set of detected drift: changes made to resources outside of + // Terraform, computed by comparing the previous run's state to the state + // after refresh. + ResourceDrift []*ResourceInstanceChange `protobuf:"bytes,18,rep,name=resource_drift,json=resourceDrift,proto3" json:"resource_drift,omitempty"` // An unordered set of proposed changes to outputs in the root module // of the configuration. This set also includes "no action" changes for // outputs that are not changing, as context for detecting inconsistencies @@ -306,6 +310,13 @@ func (x *Plan) GetResourceChanges() []*ResourceInstanceChange { return nil } +func (x *Plan) GetResourceDrift() []*ResourceInstanceChange { + if x != nil { + return x.ResourceDrift + } + return nil +} + func (x *Plan) GetOutputChanges() []*OutputChange { if x != nil { return x.OutputChanges @@ -952,7 +963,7 @@ var File_planfile_proto protoreflect.FileDescriptor var file_planfile_proto_rawDesc = []byte{ 0x0a, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x66, 0x69, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, - 0x12, 0x06, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x22, 0xa5, 0x05, 0x0a, 0x04, 0x50, 0x6c, 0x61, + 0x12, 0x06, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x22, 0xec, 0x05, 0x0a, 0x04, 0x50, 0x6c, 0x61, 0x6e, 0x12, 0x18, 0x0a, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, 0x04, 0x52, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x25, 0x0a, 0x07, 0x75, 0x69, 0x5f, 0x6d, 0x6f, 0x64, 0x65, 0x18, 0x11, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x0c, 0x2e, 0x74, @@ -965,124 +976,128 @@ var file_planfile_proto_rawDesc = []byte{ 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x1e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x0f, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, - 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x12, 0x3b, 0x0a, 0x0e, 0x6f, 0x75, 0x74, 0x70, - 0x75, 0x74, 0x5f, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, - 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x4f, 0x75, 0x74, 0x70, 0x75, 0x74, - 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x0d, 0x6f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x43, 0x68, - 0x61, 0x6e, 0x67, 0x65, 0x73, 0x12, 0x21, 0x0a, 0x0c, 0x74, 0x61, 0x72, 0x67, 0x65, 0x74, 0x5f, - 0x61, 0x64, 0x64, 0x72, 0x73, 0x18, 0x05, 0x20, 0x03, 0x28, 0x09, 0x52, 0x0b, 0x74, 0x61, 0x72, - 0x67, 0x65, 0x74, 0x41, 0x64, 0x64, 0x72, 0x73, 0x12, 0x2e, 0x0a, 0x13, 0x66, 0x6f, 0x72, 0x63, - 0x65, 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x5f, 0x61, 0x64, 0x64, 0x72, 0x73, 0x18, - 0x10, 0x20, 0x03, 0x28, 0x09, 0x52, 0x11, 0x66, 0x6f, 0x72, 0x63, 0x65, 0x52, 0x65, 0x70, 0x6c, - 0x61, 0x63, 0x65, 0x41, 0x64, 0x64, 0x72, 0x73, 0x12, 0x2b, 0x0a, 0x11, 0x74, 0x65, 0x72, 0x72, - 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x5f, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x0e, 0x20, - 0x01, 0x28, 0x09, 0x52, 0x10, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x56, 0x65, - 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x49, 0x0a, 0x0f, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, - 0x72, 0x5f, 0x68, 0x61, 0x73, 0x68, 0x65, 0x73, 0x18, 0x0f, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x20, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x72, 0x6f, - 0x76, 0x69, 0x64, 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, - 0x52, 0x0e, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, 0x73, - 0x12, 0x29, 0x0a, 0x07, 0x62, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x18, 0x0d, 0x20, 0x01, 0x28, - 0x0b, 0x32, 0x0f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x42, 0x61, 0x63, 0x6b, 0x65, - 0x6e, 0x64, 0x52, 0x07, 0x62, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x1a, 0x52, 0x0a, 0x0e, 0x56, - 0x61, 0x72, 0x69, 0x61, 0x62, 0x6c, 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, + 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x12, 0x45, 0x0a, 0x0e, 0x72, 0x65, 0x73, 0x6f, + 0x75, 0x72, 0x63, 0x65, 0x5f, 0x64, 0x72, 0x69, 0x66, 0x74, 0x18, 0x12, 0x20, 0x03, 0x28, 0x0b, + 0x32, 0x1e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, + 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, + 0x52, 0x0d, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x44, 0x72, 0x69, 0x66, 0x74, 0x12, + 0x3b, 0x0a, 0x0e, 0x6f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x5f, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, + 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, + 0x2e, 0x4f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x0d, 0x6f, + 0x75, 0x74, 0x70, 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x73, 0x12, 0x21, 0x0a, 0x0c, + 0x74, 0x61, 0x72, 0x67, 0x65, 0x74, 0x5f, 0x61, 0x64, 0x64, 0x72, 0x73, 0x18, 0x05, 0x20, 0x03, + 0x28, 0x09, 0x52, 0x0b, 0x74, 0x61, 0x72, 0x67, 0x65, 0x74, 0x41, 0x64, 0x64, 0x72, 0x73, 0x12, + 0x2e, 0x0a, 0x13, 0x66, 0x6f, 0x72, 0x63, 0x65, 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, + 0x5f, 0x61, 0x64, 0x64, 0x72, 0x73, 0x18, 0x10, 0x20, 0x03, 0x28, 0x09, 0x52, 0x11, 0x66, 0x6f, + 0x72, 0x63, 0x65, 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x41, 0x64, 0x64, 0x72, 0x73, 0x12, + 0x2b, 0x0a, 0x11, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x5f, 0x76, 0x65, 0x72, + 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x0e, 0x20, 0x01, 0x28, 0x09, 0x52, 0x10, 0x74, 0x65, 0x72, 0x72, + 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x49, 0x0a, 0x0f, + 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x68, 0x61, 0x73, 0x68, 0x65, 0x73, 0x18, + 0x0f, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, + 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, + 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x52, 0x0e, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, + 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, 0x73, 0x12, 0x29, 0x0a, 0x07, 0x62, 0x61, 0x63, 0x6b, 0x65, + 0x6e, 0x64, 0x18, 0x0d, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, + 0x6e, 0x2e, 0x42, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x52, 0x07, 0x62, 0x61, 0x63, 0x6b, 0x65, + 0x6e, 0x64, 0x1a, 0x52, 0x0a, 0x0e, 0x56, 0x61, 0x72, 0x69, 0x61, 0x62, 0x6c, 0x65, 0x73, 0x45, + 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, + 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x2a, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, + 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, + 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x76, 0x61, 0x6c, + 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x1a, 0x4f, 0x0a, 0x13, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, + 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, - 0x2a, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, - 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x1a, - 0x4f, 0x0a, 0x13, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, - 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, - 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x22, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, - 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, - 0x2e, 0x48, 0x61, 0x73, 0x68, 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, - 0x22, 0x69, 0x0a, 0x07, 0x42, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x74, - 0x79, 0x70, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x74, 0x79, 0x70, 0x65, 0x12, - 0x2c, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, - 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, - 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x1c, 0x0a, - 0x09, 0x77, 0x6f, 0x72, 0x6b, 0x73, 0x70, 0x61, 0x63, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, - 0x52, 0x09, 0x77, 0x6f, 0x72, 0x6b, 0x73, 0x70, 0x61, 0x63, 0x65, 0x22, 0xe4, 0x01, 0x0a, 0x06, - 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x0a, 0x06, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, - 0x18, 0x01, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, - 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x06, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x2c, - 0x0a, 0x06, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x14, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, - 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x73, 0x12, 0x42, 0x0a, 0x16, - 0x62, 0x65, 0x66, 0x6f, 0x72, 0x65, 0x5f, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, - 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x14, 0x62, 0x65, 0x66, 0x6f, - 0x72, 0x65, 0x53, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, - 0x12, 0x40, 0x0a, 0x15, 0x61, 0x66, 0x74, 0x65, 0x72, 0x5f, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, - 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, - 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x13, 0x61, - 0x66, 0x74, 0x65, 0x72, 0x53, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, - 0x68, 0x73, 0x22, 0xd3, 0x02, 0x0a, 0x16, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, - 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, - 0x04, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0d, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x61, 0x64, 0x64, - 0x72, 0x12, 0x22, 0x0a, 0x0d, 0x70, 0x72, 0x65, 0x76, 0x5f, 0x72, 0x75, 0x6e, 0x5f, 0x61, 0x64, - 0x64, 0x72, 0x18, 0x0e, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0b, 0x70, 0x72, 0x65, 0x76, 0x52, 0x75, - 0x6e, 0x41, 0x64, 0x64, 0x72, 0x12, 0x1f, 0x0a, 0x0b, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, - 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x07, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0a, 0x64, 0x65, 0x70, 0x6f, - 0x73, 0x65, 0x64, 0x4b, 0x65, 0x79, 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, - 0x65, 0x72, 0x18, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, - 0x65, 0x72, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x09, 0x20, 0x01, - 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, - 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, - 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x0a, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, - 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x10, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, - 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x18, 0x0b, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, - 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x12, 0x49, 0x0a, - 0x0d, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x72, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x18, 0x0c, - 0x20, 0x01, 0x28, 0x0e, 0x32, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, - 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, - 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x52, 0x0c, 0x61, 0x63, 0x74, 0x69, - 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x22, 0x68, 0x0a, 0x0c, 0x4f, 0x75, 0x74, 0x70, - 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, - 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, 0x06, - 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, - 0x61, 0x6e, 0x67, 0x65, 0x12, 0x1c, 0x0a, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, - 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x08, 0x52, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, - 0x76, 0x65, 0x22, 0x28, 0x0a, 0x0c, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, - 0x75, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x18, 0x01, 0x20, - 0x01, 0x28, 0x0c, 0x52, 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x22, 0x1e, 0x0a, 0x04, - 0x48, 0x61, 0x73, 0x68, 0x12, 0x16, 0x0a, 0x06, 0x73, 0x68, 0x61, 0x32, 0x35, 0x36, 0x18, 0x01, - 0x20, 0x01, 0x28, 0x0c, 0x52, 0x06, 0x73, 0x68, 0x61, 0x32, 0x35, 0x36, 0x22, 0xa5, 0x01, 0x0a, - 0x04, 0x50, 0x61, 0x74, 0x68, 0x12, 0x27, 0x0a, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x18, 0x01, - 0x20, 0x03, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, - 0x74, 0x68, 0x2e, 0x53, 0x74, 0x65, 0x70, 0x52, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x1a, 0x74, - 0x0a, 0x04, 0x53, 0x74, 0x65, 0x70, 0x12, 0x27, 0x0a, 0x0e, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, - 0x75, 0x74, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, - 0x52, 0x0d, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, - 0x37, 0x0a, 0x0b, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x02, - 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, - 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x48, 0x00, 0x52, 0x0a, 0x65, 0x6c, - 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x4b, 0x65, 0x79, 0x42, 0x0a, 0x0a, 0x08, 0x73, 0x65, 0x6c, 0x65, - 0x63, 0x74, 0x6f, 0x72, 0x2a, 0x31, 0x0a, 0x04, 0x4d, 0x6f, 0x64, 0x65, 0x12, 0x0a, 0x0a, 0x06, - 0x4e, 0x4f, 0x52, 0x4d, 0x41, 0x4c, 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x44, 0x45, 0x53, 0x54, - 0x52, 0x4f, 0x59, 0x10, 0x01, 0x12, 0x10, 0x0a, 0x0c, 0x52, 0x45, 0x46, 0x52, 0x45, 0x53, 0x48, - 0x5f, 0x4f, 0x4e, 0x4c, 0x59, 0x10, 0x02, 0x2a, 0x70, 0x0a, 0x06, 0x41, 0x63, 0x74, 0x69, 0x6f, - 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4f, 0x50, 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, 0x43, - 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x01, 0x12, 0x08, 0x0a, 0x04, 0x52, 0x45, 0x41, 0x44, 0x10, - 0x02, 0x12, 0x0a, 0x0a, 0x06, 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x12, 0x0a, 0x0a, - 0x06, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x05, 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, 0x4c, - 0x45, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, - 0x06, 0x12, 0x16, 0x0a, 0x12, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, - 0x5f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x07, 0x2a, 0x80, 0x01, 0x0a, 0x1c, 0x52, 0x65, - 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, - 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, - 0x4e, 0x45, 0x10, 0x00, 0x12, 0x1b, 0x0a, 0x17, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, - 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x54, 0x41, 0x49, 0x4e, 0x54, 0x45, 0x44, 0x10, - 0x01, 0x12, 0x16, 0x0a, 0x12, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, 0x5f, - 0x52, 0x45, 0x51, 0x55, 0x45, 0x53, 0x54, 0x10, 0x02, 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, 0x50, - 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, 0x4e, - 0x4e, 0x4f, 0x54, 0x5f, 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x42, 0x42, 0x5a, 0x40, - 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, - 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, - 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, 0x6e, - 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, 0x6f, - 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x22, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0c, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x48, 0x61, 0x73, 0x68, 0x52, 0x05, 0x76, 0x61, + 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x22, 0x69, 0x0a, 0x07, 0x42, 0x61, 0x63, 0x6b, 0x65, + 0x6e, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x74, 0x79, 0x70, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, + 0x52, 0x04, 0x74, 0x79, 0x70, 0x65, 0x12, 0x2c, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, + 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, + 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, + 0x6e, 0x66, 0x69, 0x67, 0x12, 0x1c, 0x0a, 0x09, 0x77, 0x6f, 0x72, 0x6b, 0x73, 0x70, 0x61, 0x63, + 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x77, 0x6f, 0x72, 0x6b, 0x73, 0x70, 0x61, + 0x63, 0x65, 0x22, 0xe4, 0x01, 0x0a, 0x06, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x0a, + 0x06, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x0e, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x06, 0x61, + 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x2c, 0x0a, 0x06, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x73, 0x18, + 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, + 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x76, 0x61, 0x6c, + 0x75, 0x65, 0x73, 0x12, 0x42, 0x0a, 0x16, 0x62, 0x65, 0x66, 0x6f, 0x72, 0x65, 0x5f, 0x73, 0x65, + 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, 0x18, 0x03, 0x20, + 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, + 0x68, 0x52, 0x14, 0x62, 0x65, 0x66, 0x6f, 0x72, 0x65, 0x53, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, + 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, 0x12, 0x40, 0x0a, 0x15, 0x61, 0x66, 0x74, 0x65, 0x72, + 0x5f, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, + 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, + 0x50, 0x61, 0x74, 0x68, 0x52, 0x13, 0x61, 0x66, 0x74, 0x65, 0x72, 0x53, 0x65, 0x6e, 0x73, 0x69, + 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, 0x22, 0xd3, 0x02, 0x0a, 0x16, 0x52, 0x65, + 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, + 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0d, 0x20, 0x01, + 0x28, 0x09, 0x52, 0x04, 0x61, 0x64, 0x64, 0x72, 0x12, 0x22, 0x0a, 0x0d, 0x70, 0x72, 0x65, 0x76, + 0x5f, 0x72, 0x75, 0x6e, 0x5f, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0e, 0x20, 0x01, 0x28, 0x09, 0x52, + 0x0b, 0x70, 0x72, 0x65, 0x76, 0x52, 0x75, 0x6e, 0x41, 0x64, 0x64, 0x72, 0x12, 0x1f, 0x0a, 0x0b, + 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x07, 0x20, 0x01, 0x28, + 0x09, 0x52, 0x0a, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x4b, 0x65, 0x79, 0x12, 0x1a, 0x0a, + 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, + 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, + 0x6e, 0x67, 0x65, 0x18, 0x09, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, + 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x0a, 0x20, 0x01, + 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x10, 0x72, + 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x18, + 0x0b, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, + 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x52, 0x65, 0x70, + 0x6c, 0x61, 0x63, 0x65, 0x12, 0x49, 0x0a, 0x0d, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x72, + 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x18, 0x0c, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x24, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, + 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, + 0x6e, 0x52, 0x0c, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x22, + 0x68, 0x0a, 0x0c, 0x4f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, + 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, + 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x02, 0x20, + 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, + 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x1c, 0x0a, 0x09, 0x73, + 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x08, 0x52, 0x09, + 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x22, 0x28, 0x0a, 0x0c, 0x44, 0x79, 0x6e, + 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x6d, 0x73, 0x67, + 0x70, 0x61, 0x63, 0x6b, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x6d, 0x73, 0x67, 0x70, + 0x61, 0x63, 0x6b, 0x22, 0x1e, 0x0a, 0x04, 0x48, 0x61, 0x73, 0x68, 0x12, 0x16, 0x0a, 0x06, 0x73, + 0x68, 0x61, 0x32, 0x35, 0x36, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x06, 0x73, 0x68, 0x61, + 0x32, 0x35, 0x36, 0x22, 0xa5, 0x01, 0x0a, 0x04, 0x50, 0x61, 0x74, 0x68, 0x12, 0x27, 0x0a, 0x05, + 0x73, 0x74, 0x65, 0x70, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x2e, 0x53, 0x74, 0x65, 0x70, 0x52, 0x05, + 0x73, 0x74, 0x65, 0x70, 0x73, 0x1a, 0x74, 0x0a, 0x04, 0x53, 0x74, 0x65, 0x70, 0x12, 0x27, 0x0a, + 0x0e, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, + 0x01, 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, 0x52, 0x0d, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, + 0x74, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, + 0x74, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, + 0x65, 0x48, 0x00, 0x52, 0x0a, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x4b, 0x65, 0x79, 0x42, + 0x0a, 0x0a, 0x08, 0x73, 0x65, 0x6c, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x2a, 0x31, 0x0a, 0x04, 0x4d, + 0x6f, 0x64, 0x65, 0x12, 0x0a, 0x0a, 0x06, 0x4e, 0x4f, 0x52, 0x4d, 0x41, 0x4c, 0x10, 0x00, 0x12, + 0x0b, 0x0a, 0x07, 0x44, 0x45, 0x53, 0x54, 0x52, 0x4f, 0x59, 0x10, 0x01, 0x12, 0x10, 0x0a, 0x0c, + 0x52, 0x45, 0x46, 0x52, 0x45, 0x53, 0x48, 0x5f, 0x4f, 0x4e, 0x4c, 0x59, 0x10, 0x02, 0x2a, 0x70, + 0x0a, 0x06, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4f, 0x50, + 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x01, 0x12, 0x08, + 0x0a, 0x04, 0x52, 0x45, 0x41, 0x44, 0x10, 0x02, 0x12, 0x0a, 0x0a, 0x06, 0x55, 0x50, 0x44, 0x41, + 0x54, 0x45, 0x10, 0x03, 0x12, 0x0a, 0x0a, 0x06, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x05, + 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, + 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x06, 0x12, 0x16, 0x0a, 0x12, 0x43, 0x52, 0x45, 0x41, + 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x07, + 0x2a, 0x80, 0x01, 0x0a, 0x1c, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, + 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, + 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, 0x1b, 0x0a, 0x17, 0x52, + 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x54, + 0x41, 0x49, 0x4e, 0x54, 0x45, 0x44, 0x10, 0x01, 0x12, 0x16, 0x0a, 0x12, 0x52, 0x45, 0x50, 0x4c, + 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, 0x5f, 0x52, 0x45, 0x51, 0x55, 0x45, 0x53, 0x54, 0x10, 0x02, + 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, + 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, 0x4e, 0x4e, 0x4f, 0x54, 0x5f, 0x55, 0x50, 0x44, 0x41, 0x54, + 0x45, 0x10, 0x03, 0x42, 0x42, 0x5a, 0x40, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, + 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, + 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, + 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, + 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( @@ -1119,27 +1134,28 @@ var file_planfile_proto_depIdxs = []int32{ 0, // 0: tfplan.Plan.ui_mode:type_name -> tfplan.Mode 11, // 1: tfplan.Plan.variables:type_name -> tfplan.Plan.VariablesEntry 6, // 2: tfplan.Plan.resource_changes:type_name -> tfplan.ResourceInstanceChange - 7, // 3: tfplan.Plan.output_changes:type_name -> tfplan.OutputChange - 12, // 4: tfplan.Plan.provider_hashes:type_name -> tfplan.Plan.ProviderHashesEntry - 4, // 5: tfplan.Plan.backend:type_name -> tfplan.Backend - 8, // 6: tfplan.Backend.config:type_name -> tfplan.DynamicValue - 1, // 7: tfplan.Change.action:type_name -> tfplan.Action - 8, // 8: tfplan.Change.values:type_name -> tfplan.DynamicValue - 10, // 9: tfplan.Change.before_sensitive_paths:type_name -> tfplan.Path - 10, // 10: tfplan.Change.after_sensitive_paths:type_name -> tfplan.Path - 5, // 11: tfplan.ResourceInstanceChange.change:type_name -> tfplan.Change - 10, // 12: tfplan.ResourceInstanceChange.required_replace:type_name -> tfplan.Path - 2, // 13: tfplan.ResourceInstanceChange.action_reason:type_name -> tfplan.ResourceInstanceActionReason - 5, // 14: tfplan.OutputChange.change:type_name -> tfplan.Change - 13, // 15: tfplan.Path.steps:type_name -> tfplan.Path.Step - 8, // 16: tfplan.Plan.VariablesEntry.value:type_name -> tfplan.DynamicValue - 9, // 17: tfplan.Plan.ProviderHashesEntry.value:type_name -> tfplan.Hash - 8, // 18: tfplan.Path.Step.element_key:type_name -> tfplan.DynamicValue - 19, // [19:19] is the sub-list for method output_type - 19, // [19:19] is the sub-list for method input_type - 19, // [19:19] is the sub-list for extension type_name - 19, // [19:19] is the sub-list for extension extendee - 0, // [0:19] is the sub-list for field type_name + 6, // 3: tfplan.Plan.resource_drift:type_name -> tfplan.ResourceInstanceChange + 7, // 4: tfplan.Plan.output_changes:type_name -> tfplan.OutputChange + 12, // 5: tfplan.Plan.provider_hashes:type_name -> tfplan.Plan.ProviderHashesEntry + 4, // 6: tfplan.Plan.backend:type_name -> tfplan.Backend + 8, // 7: tfplan.Backend.config:type_name -> tfplan.DynamicValue + 1, // 8: tfplan.Change.action:type_name -> tfplan.Action + 8, // 9: tfplan.Change.values:type_name -> tfplan.DynamicValue + 10, // 10: tfplan.Change.before_sensitive_paths:type_name -> tfplan.Path + 10, // 11: tfplan.Change.after_sensitive_paths:type_name -> tfplan.Path + 5, // 12: tfplan.ResourceInstanceChange.change:type_name -> tfplan.Change + 10, // 13: tfplan.ResourceInstanceChange.required_replace:type_name -> tfplan.Path + 2, // 14: tfplan.ResourceInstanceChange.action_reason:type_name -> tfplan.ResourceInstanceActionReason + 5, // 15: tfplan.OutputChange.change:type_name -> tfplan.Change + 13, // 16: tfplan.Path.steps:type_name -> tfplan.Path.Step + 8, // 17: tfplan.Plan.VariablesEntry.value:type_name -> tfplan.DynamicValue + 9, // 18: tfplan.Plan.ProviderHashesEntry.value:type_name -> tfplan.Hash + 8, // 19: tfplan.Path.Step.element_key:type_name -> tfplan.DynamicValue + 20, // [20:20] is the sub-list for method output_type + 20, // [20:20] is the sub-list for method input_type + 20, // [20:20] is the sub-list for extension type_name + 20, // [20:20] is the sub-list for extension extendee + 0, // [0:20] is the sub-list for field type_name } func init() { file_planfile_proto_init() } diff --git a/internal/plans/internal/planproto/planfile.proto b/internal/plans/internal/planproto/planfile.proto index 6ec4ae402441..d1427bfbea47 100644 --- a/internal/plans/internal/planproto/planfile.proto +++ b/internal/plans/internal/planproto/planfile.proto @@ -33,6 +33,11 @@ message Plan { // each resource to determine which module it belongs to. repeated ResourceInstanceChange resource_changes = 3; + // An unordered set of detected drift: changes made to resources outside of + // Terraform, computed by comparing the previous run's state to the state + // after refresh. + repeated ResourceInstanceChange resource_drift = 18; + // An unordered set of proposed changes to outputs in the root module // of the configuration. This set also includes "no action" changes for // outputs that are not changing, as context for detecting inconsistencies diff --git a/internal/plans/planfile/planfile_test.go b/internal/plans/planfile/planfile_test.go index b0001312d40f..14d23c87a67b 100644 --- a/internal/plans/planfile/planfile_test.go +++ b/internal/plans/planfile/planfile_test.go @@ -51,7 +51,8 @@ func TestRoundtrip(t *testing.T) { Resources: []*plans.ResourceInstanceChangeSrc{}, Outputs: []*plans.OutputChangeSrc{}, }, - ProviderSHA256s: map[string][]byte{}, + DriftedResources: []*plans.ResourceInstanceChangeSrc{}, + ProviderSHA256s: map[string][]byte{}, VariableValues: map[string]plans.DynamicValue{ "foo": plans.DynamicValue([]byte("foo placeholder")), }, diff --git a/internal/plans/planfile/tfplan.go b/internal/plans/planfile/tfplan.go index 7572020b6c41..8cfd3694fb4f 100644 --- a/internal/plans/planfile/tfplan.go +++ b/internal/plans/planfile/tfplan.go @@ -56,6 +56,7 @@ func readTfplan(r io.Reader) (*plans.Plan, error) { Outputs: []*plans.OutputChangeSrc{}, Resources: []*plans.ResourceInstanceChangeSrc{}, }, + DriftedResources: []*plans.ResourceInstanceChangeSrc{}, ProviderSHA256s: map[string][]byte{}, } @@ -98,6 +99,16 @@ func readTfplan(r io.Reader) (*plans.Plan, error) { plan.Changes.Resources = append(plan.Changes.Resources, change) } + for _, rawRC := range rawPlan.ResourceDrift { + change, err := resourceChangeFromTfplan(rawRC) + if err != nil { + // errors from resourceChangeFromTfplan already include context + return nil, err + } + + plan.DriftedResources = append(plan.DriftedResources, change) + } + for _, rawTargetAddr := range rawPlan.TargetAddrs { target, diags := addrs.ParseTargetStr(rawTargetAddr) if diags.HasErrors() { @@ -342,6 +353,7 @@ func writeTfplan(plan *plans.Plan, w io.Writer) error { Variables: map[string]*planproto.DynamicValue{}, OutputChanges: []*planproto.OutputChange{}, ResourceChanges: []*planproto.ResourceInstanceChange{}, + ResourceDrift: []*planproto.ResourceInstanceChange{}, } switch plan.UIMode { @@ -388,6 +400,14 @@ func writeTfplan(plan *plans.Plan, w io.Writer) error { rawPlan.ResourceChanges = append(rawPlan.ResourceChanges, rawRC) } + for _, rc := range plan.DriftedResources { + rawRC, err := resourceChangeToTfplan(rc) + if err != nil { + return err + } + rawPlan.ResourceDrift = append(rawPlan.ResourceDrift, rawRC) + } + for _, targetAddr := range plan.TargetAddrs { rawPlan.TargetAddrs = append(rawPlan.TargetAddrs, targetAddr.String()) } diff --git a/internal/plans/planfile/tfplan_test.go b/internal/plans/planfile/tfplan_test.go index b6c69657e4d3..7ab62de532d7 100644 --- a/internal/plans/planfile/tfplan_test.go +++ b/internal/plans/planfile/tfplan_test.go @@ -118,6 +118,46 @@ func TestTFPlanRoundTrip(t *testing.T) { }, }, }, + DriftedResources: []*plans.ResourceInstanceChangeSrc{ + { + Addr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.IntKey(0)).Absolute(addrs.RootModuleInstance), + PrevRunAddr: addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_thing", + Name: "woot", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + ProviderAddr: addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ChangeSrc: plans.ChangeSrc{ + Action: plans.DeleteThenCreate, + Before: mustNewDynamicValue(cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("foo-bar-baz"), + "boop": cty.ListVal([]cty.Value{ + cty.StringVal("beep"), + }), + }), objTy), + After: mustNewDynamicValue(cty.ObjectVal(map[string]cty.Value{ + "id": cty.UnknownVal(cty.String), + "boop": cty.ListVal([]cty.Value{ + cty.StringVal("beep"), + cty.StringVal("bonk"), + }), + }), objTy), + AfterValMarks: []cty.PathValueMarks{ + { + Path: cty.GetAttrPath("boop").IndexInt(1), + Marks: cty.NewValueMarks(marks.Sensitive), + }, + }, + }, + }, + }, TargetAddrs: []addrs.Targetable{ addrs.Resource{ Mode: addrs.ManagedResourceMode, @@ -243,6 +283,7 @@ func TestTFPlanRoundTripDestroy(t *testing.T) { }, }, }, + DriftedResources: []*plans.ResourceInstanceChangeSrc{}, TargetAddrs: []addrs.Targetable{ addrs.Resource{ Mode: addrs.ManagedResourceMode, From f0cf4235f9e8eafe1d13a6a6e0720f0f0bc67e7e Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 13 Sep 2021 17:30:16 -0400 Subject: [PATCH 070/644] cli: Refactor resource drift rendering --- internal/command/format/diff.go | 175 +++------------ internal/command/format/diff_test.go | 2 +- .../command/format/difflanguage_string.go | 29 +++ internal/command/jsonplan/plan.go | 187 +++------------- .../testdata/show-json/drift/output.json | 1 + .../multi-resource-update/output.json | 3 +- internal/command/views/operation_test.go | 209 +++++++----------- internal/command/views/plan.go | 116 ++++------ 8 files changed, 208 insertions(+), 514 deletions(-) create mode 100644 internal/command/format/difflanguage_string.go diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index e111485e0268..0028d0038cda 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -20,6 +20,21 @@ import ( "github.com/hashicorp/terraform/internal/states" ) +// DiffLanguage controls the description of the resource change reasons. +type DiffLanguage rune + +//go:generate go run golang.org/x/tools/cmd/stringer -type=DiffLanguage diff.go + +const ( + // DiffLanguageProposedChange indicates that the change is one which is + // planned to be applied. + DiffLanguageProposedChange DiffLanguage = 'P' + + // DiffLanguageDetectedDrift indicates that the change is detected drift + // from the configuration. + DiffLanguageDetectedDrift DiffLanguage = 'D' +) + // ResourceChange returns a string representation of a change to a particular // resource, for inclusion in user-facing plan output. // @@ -33,6 +48,7 @@ func ResourceChange( change *plans.ResourceInstanceChangeSrc, schema *configschema.Block, color *colorstring.Colorize, + language DiffLanguage, ) string { addr := change.Addr var buf bytes.Buffer @@ -56,7 +72,14 @@ func ResourceChange( case plans.Read: buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be read during apply\n # (config refers to values not yet known)", dispAddr))) case plans.Update: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be updated in-place", dispAddr))) + switch language { + case DiffLanguageProposedChange: + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be updated in-place", dispAddr))) + case DiffLanguageDetectedDrift: + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has changed", dispAddr))) + default: + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] update (unknown reason %s)", dispAddr, language))) + } case plans.CreateThenDelete, plans.DeleteThenCreate: switch change.ActionReason { case plans.ResourceInstanceReplaceBecauseTainted: @@ -67,7 +90,14 @@ func ResourceChange( buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] must be [bold][red]replaced", dispAddr))) } case plans.Delete: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be [bold][red]destroyed", dispAddr))) + switch language { + case DiffLanguageProposedChange: + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be [bold][red]destroyed", dispAddr))) + case DiffLanguageDetectedDrift: + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has been deleted", dispAddr))) + default: + buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] delete (unknown reason %s)", dispAddr, language))) + } if change.DeposedKey != states.NotDeposed { // Some extra context about this unusual situation. buf.WriteString(color.Color("\n # (left over from a partially-failed replacement of this instance)")) @@ -154,147 +184,6 @@ func ResourceChange( return buf.String() } -// ResourceInstanceDrift returns a string representation of a change to a -// particular resource instance that was made outside of Terraform, for -// reporting a change that has already happened rather than one that is planned. -// -// The the two resource instances have equal current objects then the result -// will be an empty string to indicate that there is no drift to render. -// -// The resource schema must be provided along with the change so that the -// formatted change can reflect the configuration structure for the associated -// resource. -// -// If "color" is non-nil, it will be used to color the result. Otherwise, -// no color codes will be included. -func ResourceInstanceDrift( - addr addrs.AbsResourceInstance, - before, after *states.ResourceInstance, - schema *configschema.Block, - color *colorstring.Colorize, -) string { - var buf bytes.Buffer - - if color == nil { - color = &colorstring.Colorize{ - Colors: colorstring.DefaultColors, - Disable: true, - Reset: false, - } - } - - dispAddr := addr.String() - action := plans.Update - - switch { - case before == nil || before.Current == nil: - // before should never be nil, but before.Current can be if the - // instance was deposed. There is nothing to render for a deposed - // instance, since we intend to remove it. - return "" - - case after == nil || after.Current == nil: - // The object was deleted - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has been deleted", dispAddr))) - action = plans.Delete - default: - // The object was changed - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has been changed", dispAddr))) - } - - buf.WriteString(color.Color("[reset]\n")) - - buf.WriteString(color.Color(DiffActionSymbol(action)) + " ") - - switch addr.Resource.Resource.Mode { - case addrs.ManagedResourceMode: - buf.WriteString(fmt.Sprintf( - "resource %q %q", - addr.Resource.Resource.Type, - addr.Resource.Resource.Name, - )) - case addrs.DataResourceMode: - buf.WriteString(fmt.Sprintf( - "data %q %q ", - addr.Resource.Resource.Type, - addr.Resource.Resource.Name, - )) - default: - // should never happen, since the above is exhaustive - buf.WriteString(addr.String()) - } - - buf.WriteString(" {") - - p := blockBodyDiffPrinter{ - buf: &buf, - color: color, - action: action, - } - - // Most commonly-used resources have nested blocks that result in us - // going at least three traversals deep while we recurse here, so we'll - // start with that much capacity and then grow as needed for deeper - // structures. - path := make(cty.Path, 0, 3) - - ty := schema.ImpliedType() - - var err error - var oldObj, newObj *states.ResourceInstanceObject - oldObj, err = before.Current.Decode(ty) - if err != nil { - // We shouldn't encounter errors here because Terraform Core should've - // made sure that the previous run object conforms to the current - // schema by having the provider upgrade it, but we'll be robust here - // in case there are some edges we didn't find yet. - return fmt.Sprintf(" # %s previous run state doesn't conform to current schema; this is a Terraform bug\n # %s\n", addr, err) - } - if after != nil && after.Current != nil { - newObj, err = after.Current.Decode(ty) - if err != nil { - // We shouldn't encounter errors here because Terraform Core should've - // made sure that the prior state object conforms to the current - // schema by having the provider upgrade it, even if we skipped - // refreshing on this run, but we'll be robust here in case there are - // some edges we didn't find yet. - return fmt.Sprintf(" # %s refreshed state doesn't conform to current schema; this is a Terraform bug\n # %s\n", addr, err) - } - } - - oldVal := oldObj.Value - var newVal cty.Value - if newObj != nil { - newVal = newObj.Value - } else { - newVal = cty.NullVal(ty) - } - - if newVal.RawEquals(oldVal) { - // Nothing to show, then. - return "" - } - - // We currently have an opt-out that permits the legacy SDK to return values - // that defy our usual conventions around handling of nesting blocks. To - // avoid the rendering code from needing to handle all of these, we'll - // normalize first. - // (Ideally we'd do this as part of the SDK opt-out implementation in core, - // but we've added it here for now to reduce risk of unexpected impacts - // on other code in core.) - oldVal = objchange.NormalizeObjectFromLegacySDK(oldVal, schema) - newVal = objchange.NormalizeObjectFromLegacySDK(newVal, schema) - - result := p.writeBlockBodyDiff(schema, oldVal, newVal, 6, path) - if result.bodyWritten { - buf.WriteString("\n") - buf.WriteString(strings.Repeat(" ", 4)) - } - buf.WriteString("}\n") - - return buf.String() -} - // OutputChanges returns a string representation of a set of changes to output // values for inclusion in user-facing plan output. // diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index 7ca289c79ad5..b59a3af56412 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -4599,7 +4599,7 @@ func runTestCases(t *testing.T, testCases map[string]testCase) { RequiredReplace: tc.RequiredReplace, } - output := ResourceChange(change, tc.Schema, color) + output := ResourceChange(change, tc.Schema, color, DiffLanguageProposedChange) if diff := cmp.Diff(output, tc.ExpectedOutput); diff != "" { t.Errorf("wrong output\n%s", diff) } diff --git a/internal/command/format/difflanguage_string.go b/internal/command/format/difflanguage_string.go new file mode 100644 index 000000000000..8399cddc4645 --- /dev/null +++ b/internal/command/format/difflanguage_string.go @@ -0,0 +1,29 @@ +// Code generated by "stringer -type=DiffLanguage diff.go"; DO NOT EDIT. + +package format + +import "strconv" + +func _() { + // An "invalid array index" compiler error signifies that the constant values have changed. + // Re-run the stringer command to generate them again. + var x [1]struct{} + _ = x[DiffLanguageProposedChange-80] + _ = x[DiffLanguageDetectedDrift-68] +} + +const ( + _DiffLanguage_name_0 = "DiffLanguageDetectedDrift" + _DiffLanguage_name_1 = "DiffLanguageProposedChange" +) + +func (i DiffLanguage) String() string { + switch { + case i == 68: + return _DiffLanguage_name_0 + case i == 80: + return _DiffLanguage_name_1 + default: + return "DiffLanguage(" + strconv.FormatInt(int64(i), 10) + ")" + } +} diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index 1b90daf2d092..1d7eff1ffb37 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -130,15 +130,17 @@ func Marshal( } // output.ResourceDrift - err = output.marshalResourceDrift(p.PrevRunState, p.PriorState, schemas) + output.ResourceDrift, err = output.marshalResourceChanges(p.DriftedResources, schemas) if err != nil { - return nil, fmt.Errorf("error in marshalResourceDrift: %s", err) + return nil, fmt.Errorf("error in marshaling resource drift: %s", err) } // output.ResourceChanges - err = output.marshalResourceChanges(p.Changes, schemas) - if err != nil { - return nil, fmt.Errorf("error in marshalResourceChanges: %s", err) + if p.Changes != nil { + output.ResourceChanges, err = output.marshalResourceChanges(p.Changes.Resources, schemas) + if err != nil { + return nil, fmt.Errorf("error in marshaling resource changes: %s", err) + } } // output.OutputChanges @@ -188,149 +190,10 @@ func (p *plan) marshalPlanVariables(vars map[string]plans.DynamicValue, schemas return nil } -func (p *plan) marshalResourceDrift(oldState, newState *states.State, schemas *terraform.Schemas) error { - // Our goal here is to build a data structure of the same shape as we use - // to describe planned resource changes, but in this case we'll be - // taking the old and new values from different state snapshots rather - // than from a real "Changes" object. - // - // In doing this we make an assumption that drift detection can only - // ever show objects as updated or removed, and will never show anything - // as created because we only refresh objects we were already tracking - // after the previous run. This means we can use oldState as our baseline - // for what resource instances we might include, and check for each item - // whether it's present in newState. If we ever have some mechanism to - // detect "additive drift" later then we'll need to take a different - // approach here, but we have no plans for that at the time of writing. - // - // We also assume that both states have had all managed resource objects - // upgraded to match the current schemas given in schemas, so we shouldn't - // need to contend with oldState having old-shaped objects even if the - // user changed provider versions since the last run. - - if newState.ManagedResourcesEqual(oldState) { - // Nothing to do, because we only detect and report drift for managed - // resource instances. - return nil - } - for _, ms := range oldState.Modules { - for _, rs := range ms.Resources { - if rs.Addr.Resource.Mode != addrs.ManagedResourceMode { - // Drift reporting is only for managed resources - continue - } - - provider := rs.ProviderConfig.Provider - for key, oldIS := range rs.Instances { - if oldIS.Current == nil { - // Not interested in instances that only have deposed objects - continue - } - addr := rs.Addr.Instance(key) - newIS := newState.ResourceInstance(addr) - - schema, _ := schemas.ResourceTypeConfig( - provider, - addr.Resource.Resource.Mode, - addr.Resource.Resource.Type, - ) - if schema == nil { - return fmt.Errorf("no schema found for %s (in provider %s)", addr, provider) - } - ty := schema.ImpliedType() - - oldObj, err := oldIS.Current.Decode(ty) - if err != nil { - return fmt.Errorf("failed to decode previous run data for %s: %s", addr, err) - } - - var newObj *states.ResourceInstanceObject - if newIS != nil && newIS.Current != nil { - newObj, err = newIS.Current.Decode(ty) - if err != nil { - return fmt.Errorf("failed to decode refreshed data for %s: %s", addr, err) - } - } - - var oldVal, newVal cty.Value - oldVal = oldObj.Value - if newObj != nil { - newVal = newObj.Value - } else { - newVal = cty.NullVal(ty) - } - - if oldVal.RawEquals(newVal) { - // No drift if the two values are semantically equivalent - continue - } - - oldSensitive := jsonstate.SensitiveAsBool(oldVal) - newSensitive := jsonstate.SensitiveAsBool(newVal) - oldVal, _ = oldVal.UnmarkDeep() - newVal, _ = newVal.UnmarkDeep() - - var before, after []byte - var beforeSensitive, afterSensitive []byte - before, err = ctyjson.Marshal(oldVal, oldVal.Type()) - if err != nil { - return fmt.Errorf("failed to encode previous run data for %s as JSON: %s", addr, err) - } - after, err = ctyjson.Marshal(newVal, oldVal.Type()) - if err != nil { - return fmt.Errorf("failed to encode refreshed data for %s as JSON: %s", addr, err) - } - beforeSensitive, err = ctyjson.Marshal(oldSensitive, oldSensitive.Type()) - if err != nil { - return fmt.Errorf("failed to encode previous run data sensitivity for %s as JSON: %s", addr, err) - } - afterSensitive, err = ctyjson.Marshal(newSensitive, newSensitive.Type()) - if err != nil { - return fmt.Errorf("failed to encode refreshed data sensitivity for %s as JSON: %s", addr, err) - } - - // We can only detect updates and deletes as drift. - action := plans.Update - if newVal.IsNull() { - action = plans.Delete - } +func (p *plan) marshalResourceChanges(resources []*plans.ResourceInstanceChangeSrc, schemas *terraform.Schemas) ([]resourceChange, error) { + var ret []resourceChange - change := resourceChange{ - Address: addr.String(), - ModuleAddress: addr.Module.String(), - Mode: "managed", // drift reporting is only for managed resources - Name: addr.Resource.Resource.Name, - Type: addr.Resource.Resource.Type, - ProviderName: provider.String(), - - Change: change{ - Actions: actionString(action.String()), - Before: json.RawMessage(before), - BeforeSensitive: json.RawMessage(beforeSensitive), - After: json.RawMessage(after), - AfterSensitive: json.RawMessage(afterSensitive), - // AfterUnknown is never populated here because - // values in a state are always fully known. - }, - } - p.ResourceDrift = append(p.ResourceDrift, change) - } - } - } - - sort.Slice(p.ResourceChanges, func(i, j int) bool { - return p.ResourceChanges[i].Address < p.ResourceChanges[j].Address - }) - - return nil -} - -func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform.Schemas) error { - if changes == nil { - // Nothing to do! - return nil - } - for _, rc := range changes.Resources { + for _, rc := range resources { var r resourceChange addr := rc.Addr r.Address = addr.String() @@ -349,12 +212,12 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform addr.Resource.Resource.Type, ) if schema == nil { - return fmt.Errorf("no schema found for %s (in provider %s)", r.Address, rc.ProviderAddr.Provider) + return nil, fmt.Errorf("no schema found for %s (in provider %s)", r.Address, rc.ProviderAddr.Provider) } changeV, err := rc.Decode(schema.ImpliedType()) if err != nil { - return err + return nil, err } // We drop the marks from the change, as decoding is only an // intermediate step to re-encode the values as json @@ -368,7 +231,7 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform if changeV.Before != cty.NilVal { before, err = ctyjson.Marshal(changeV.Before, changeV.Before.Type()) if err != nil { - return err + return nil, err } marks := rc.BeforeValMarks if schema.ContainsSensitive() { @@ -377,14 +240,14 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform bs := jsonstate.SensitiveAsBool(changeV.Before.MarkWithPaths(marks)) beforeSensitive, err = ctyjson.Marshal(bs, bs.Type()) if err != nil { - return err + return nil, err } } if changeV.After != cty.NilVal { if changeV.After.IsWhollyKnown() { after, err = ctyjson.Marshal(changeV.After, changeV.After.Type()) if err != nil { - return err + return nil, err } afterUnknown = cty.EmptyObjectVal } else { @@ -394,7 +257,7 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform } else { after, err = ctyjson.Marshal(filteredAfter, filteredAfter.Type()) if err != nil { - return err + return nil, err } } afterUnknown = unknownAsBool(changeV.After) @@ -406,17 +269,17 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform as := jsonstate.SensitiveAsBool(changeV.After.MarkWithPaths(marks)) afterSensitive, err = ctyjson.Marshal(as, as.Type()) if err != nil { - return err + return nil, err } } a, err := ctyjson.Marshal(afterUnknown, afterUnknown.Type()) if err != nil { - return err + return nil, err } replacePaths, err := encodePaths(rc.RequiredReplace) if err != nil { - return err + return nil, err } r.Change = change{ @@ -444,7 +307,7 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform case addrs.DataResourceMode: r.Mode = "data" default: - return fmt.Errorf("resource %s has an unsupported mode %s", r.Address, addr.Resource.Resource.Mode.String()) + return nil, fmt.Errorf("resource %s has an unsupported mode %s", r.Address, addr.Resource.Resource.Mode.String()) } r.ModuleAddress = addr.Module.String() r.Name = addr.Resource.Resource.Name @@ -461,18 +324,18 @@ func (p *plan) marshalResourceChanges(changes *plans.Changes, schemas *terraform case plans.ResourceInstanceReplaceByRequest: r.ActionReason = "replace_by_request" default: - return fmt.Errorf("resource %s has an unsupported action reason %s", r.Address, rc.ActionReason) + return nil, fmt.Errorf("resource %s has an unsupported action reason %s", r.Address, rc.ActionReason) } - p.ResourceChanges = append(p.ResourceChanges, r) + ret = append(ret, r) } - sort.Slice(p.ResourceChanges, func(i, j int) bool { - return p.ResourceChanges[i].Address < p.ResourceChanges[j].Address + sort.Slice(ret, func(i, j int) bool { + return ret[i].Address < ret[j].Address }) - return nil + return ret, nil } func (p *plan) marshalOutputChanges(changes *plans.Changes) error { diff --git a/internal/command/testdata/show-json/drift/output.json b/internal/command/testdata/show-json/drift/output.json index 7badb45e5edd..79e702161576 100644 --- a/internal/command/testdata/show-json/drift/output.json +++ b/internal/command/testdata/show-json/drift/output.json @@ -52,6 +52,7 @@ "id": "placeholder" }, "after_sensitive": {}, + "after_unknown": {}, "before_sensitive": {} } } diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index d84bc5b08789..a7a6a3053fac 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -62,7 +62,8 @@ }, "after": null, "before_sensitive": {}, - "after_sensitive": false + "after_sensitive": false, + "after_unknown": {} } } ], diff --git a/internal/command/views/operation_test.go b/internal/command/views/operation_test.go index fd56350c5ebe..b2e4f8f8e47a 100644 --- a/internal/command/views/operation_test.go +++ b/internal/command/views/operation_test.go @@ -13,6 +13,7 @@ import ( "github.com/hashicorp/terraform/internal/states/statefile" "github.com/hashicorp/terraform/internal/terminal" "github.com/hashicorp/terraform/internal/terraform" + "github.com/zclconf/go-cty/cty" ) func TestOperation_stopping(t *testing.T) { @@ -82,10 +83,8 @@ func TestOperation_planNoChanges(t *testing.T) { "nothing at all in normal mode": { func(schemas *terraform.Schemas) *plans.Plan { return &plans.Plan{ - UIMode: plans.NormalMode, - Changes: plans.NewChanges(), - PrevRunState: states.NewState(), - PriorState: states.NewState(), + UIMode: plans.NormalMode, + Changes: plans.NewChanges(), } }, "no differences, so no changes are needed.", @@ -93,10 +92,8 @@ func TestOperation_planNoChanges(t *testing.T) { "nothing at all in refresh-only mode": { func(schemas *terraform.Schemas) *plans.Plan { return &plans.Plan{ - UIMode: plans.RefreshOnlyMode, - Changes: plans.NewChanges(), - PrevRunState: states.NewState(), - PriorState: states.NewState(), + UIMode: plans.RefreshOnlyMode, + Changes: plans.NewChanges(), } }, "Terraform has checked that the real remote objects still match", @@ -104,148 +101,90 @@ func TestOperation_planNoChanges(t *testing.T) { "nothing at all in destroy mode": { func(schemas *terraform.Schemas) *plans.Plan { return &plans.Plan{ - UIMode: plans.DestroyMode, - Changes: plans.NewChanges(), - PrevRunState: states.NewState(), - PriorState: states.NewState(), - } - }, - "No objects need to be destroyed.", - }, - "no drift to display with only deposed instances": { - // changes in deposed instances will cause a change in state, but - // have nothing to display to the user - func(schemas *terraform.Schemas) *plans.Plan { - return &plans.Plan{ - UIMode: plans.NormalMode, + UIMode: plans.DestroyMode, Changes: plans.NewChanges(), - PrevRunState: states.BuildState(func(state *states.SyncState) { - state.SetResourceInstanceDeposed( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "somewhere", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - states.NewDeposedKey(), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo": "ok", "bars":[]}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), - PriorState: states.NewState(), } }, - "no differences, so no changes are needed.", + "No objects need to be destroyed.", }, "drift detected in normal mode": { func(schemas *terraform.Schemas) *plans.Plan { - return &plans.Plan{ - UIMode: plans.NormalMode, - Changes: plans.NewChanges(), - PrevRunState: states.BuildState(func(state *states.SyncState) { - state.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "somewhere", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), - PriorState: states.NewState(), + addr := addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "somewhere", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + schema, _ := schemas.ResourceTypeConfig( + addrs.NewDefaultProvider("test"), + addr.Resource.Resource.Mode, + addr.Resource.Resource.Type, + ) + ty := schema.ImpliedType() + rc := &plans.ResourceInstanceChange{ + Addr: addr, + PrevRunAddr: addr, + ProviderAddr: addrs.RootModuleInstance.ProviderConfigDefault( + addrs.NewDefaultProvider("test"), + ), + Change: plans.Change{ + Action: plans.Update, + Before: cty.NullVal(ty), + After: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("1234"), + "foo": cty.StringVal("bar"), + }), + }, } - }, - "to update the Terraform state to match, create and apply a refresh-only plan", - }, - "drift detected with deposed": { - func(schemas *terraform.Schemas) *plans.Plan { + rcs, err := rc.Encode(ty) + if err != nil { + panic(err) + } + drs := []*plans.ResourceInstanceChangeSrc{rcs} return &plans.Plan{ - UIMode: plans.NormalMode, - Changes: plans.NewChanges(), - PrevRunState: states.BuildState(func(state *states.SyncState) { - state.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "changes", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"b"}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - state.SetResourceInstanceDeposed( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "broken", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - states.NewDeposedKey(), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"c"}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), - PriorState: states.BuildState(func(state *states.SyncState) { - state.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "changed", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"b"}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - state.SetResourceInstanceDeposed( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "broken", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - states.NewDeposedKey(), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"d"}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), + UIMode: plans.NormalMode, + Changes: plans.NewChanges(), + DriftedResources: drs, } }, "to update the Terraform state to match, create and apply a refresh-only plan", }, "drift detected in refresh-only mode": { func(schemas *terraform.Schemas) *plans.Plan { + addr := addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "somewhere", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + schema, _ := schemas.ResourceTypeConfig( + addrs.NewDefaultProvider("test"), + addr.Resource.Resource.Mode, + addr.Resource.Resource.Type, + ) + ty := schema.ImpliedType() + rc := &plans.ResourceInstanceChange{ + Addr: addr, + PrevRunAddr: addr, + ProviderAddr: addrs.RootModuleInstance.ProviderConfigDefault( + addrs.NewDefaultProvider("test"), + ), + Change: plans.Change{ + Action: plans.Update, + Before: cty.NullVal(ty), + After: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("1234"), + "foo": cty.StringVal("bar"), + }), + }, + } + rcs, err := rc.Encode(ty) + if err != nil { + panic(err) + } + drs := []*plans.ResourceInstanceChangeSrc{rcs} return &plans.Plan{ - UIMode: plans.RefreshOnlyMode, - Changes: plans.NewChanges(), - PrevRunState: states.BuildState(func(state *states.SyncState) { - state.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_resource", - Name: "somewhere", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{}`), - }, - addrs.RootModuleInstance.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), - PriorState: states.NewState(), + UIMode: plans.RefreshOnlyMode, + Changes: plans.NewChanges(), + DriftedResources: drs, } }, "If you were expecting these changes then you can apply this plan", diff --git a/internal/command/views/plan.go b/internal/command/views/plan.go index ff794933b420..175c263698a2 100644 --- a/internal/command/views/plan.go +++ b/internal/command/views/plan.go @@ -10,7 +10,6 @@ import ( "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/format" "github.com/hashicorp/terraform/internal/plans" - "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -97,8 +96,9 @@ func (v *PlanJSON) HelpPrompt() { // The plan renderer is used by the Operation view (for plan and apply // commands) and the Show view (for the show command). func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { - haveRefreshChanges := renderChangesDetectedByRefresh(plan.PrevRunState, plan.PriorState, schemas, view) + haveRefreshChanges := len(plan.DriftedResources) > 0 if haveRefreshChanges { + renderChangesDetectedByRefresh(plan.DriftedResources, schemas, view) switch plan.UIMode { case plans.RefreshOnlyMode: view.streams.Println(format.WordWrap( @@ -292,6 +292,7 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { rcs, rSchema, view.colorize, + format.DiffLanguageProposedChange, )) } @@ -344,82 +345,53 @@ func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { // renderChangesDetectedByRefresh returns true if it produced at least one // line of output, and guarantees to always produce whole lines terminated // by newline characters. -func renderChangesDetectedByRefresh(before, after *states.State, schemas *terraform.Schemas, view *View) bool { - // ManagedResourceEqual checks that the state is exactly equal for all - // managed resources; but semantically equivalent states, or changes to - // deposed instances may not actually represent changes we need to present - // to the user, so for now this only serves as a short-circuit to skip - // attempting to render the diffs below. - if after.ManagedResourcesEqual(before) { - return false - } - - var diffs []string - - for _, bms := range before.Modules { - for _, brs := range bms.Resources { - if brs.Addr.Resource.Mode != addrs.ManagedResourceMode { - continue // only managed resources can "drift" - } - addr := brs.Addr - prs := after.Resource(brs.Addr) - - provider := brs.ProviderConfig.Provider - providerSchema := schemas.ProviderSchema(provider) - if providerSchema == nil { - // Should never happen - view.streams.Printf("(schema missing for %s)\n", provider) - continue - } - rSchema, _ := providerSchema.SchemaForResourceAddr(addr.Resource) - if rSchema == nil { - // Should never happen - view.streams.Printf("(schema missing for %s)\n", addr) - continue - } +func renderChangesDetectedByRefresh(drs []*plans.ResourceInstanceChangeSrc, schemas *terraform.Schemas, view *View) { + view.streams.Print( + view.colorize.Color("[reset]\n[bold][cyan]Note:[reset][bold] Objects have changed outside of Terraform[reset]\n\n"), + ) + view.streams.Print(format.WordWrap( + "Terraform detected the following changes made outside of Terraform since the last \"terraform apply\":\n\n", + view.outputColumns(), + )) + + // Note: we're modifying the backing slice of this plan object in-place + // here. The ordering of resource changes in a plan is not significant, + // but we can only do this safely here because we can assume that nobody + // is concurrently modifying our changes while we're trying to print it. + sort.Slice(drs, func(i, j int) bool { + iA := drs[i].Addr + jA := drs[j].Addr + if iA.String() == jA.String() { + return drs[i].DeposedKey < drs[j].DeposedKey + } + return iA.Less(jA) + }) - for key, bis := range brs.Instances { - if bis.Current == nil { - // No current instance to render here - continue - } - var pis *states.ResourceInstance - if prs != nil { - pis = prs.Instance(key) - } + for _, rcs := range drs { + if rcs.Action == plans.NoOp && !rcs.Moved() { + continue + } - diff := format.ResourceInstanceDrift( - addr.Instance(key), - bis, pis, - rSchema, - view.colorize, - ) - if diff != "" { - diffs = append(diffs, diff) - } - } + providerSchema := schemas.ProviderSchema(rcs.ProviderAddr.Provider) + if providerSchema == nil { + // Should never happen + view.streams.Printf("(schema missing for %s)\n\n", rcs.ProviderAddr) + continue + } + rSchema, _ := providerSchema.SchemaForResourceAddr(rcs.Addr.Resource.Resource) + if rSchema == nil { + // Should never happen + view.streams.Printf("(schema missing for %s)\n\n", rcs.Addr) + continue } - } - // If we only have changes regarding deposed instances, or the diff - // renderer is suppressing irrelevant changes from the legacy SDK, there - // may not have been anything to display to the user. - if len(diffs) > 0 { - view.streams.Print( - view.colorize.Color("[reset]\n[bold][cyan]Note:[reset][bold] Objects have changed outside of Terraform[reset]\n\n"), - ) - view.streams.Print(format.WordWrap( - "Terraform detected the following changes made outside of Terraform since the last \"terraform apply\":\n\n", - view.outputColumns(), + view.streams.Println(format.ResourceChange( + rcs, + rSchema, + view.colorize, + format.DiffLanguageDetectedDrift, )) - - for _, diff := range diffs { - view.streams.Print(diff) - } - return true } - - return false } const planHeaderIntro = ` From d5b5407ccc66f4808e1b5009bb4e5a93dde67dc2 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 15 Sep 2021 16:53:58 -0400 Subject: [PATCH 071/644] format: Fix incorrect nesting of Color/Sprintf Colorizing the result of an interpolated string can result in incorrect output, if the values used to generate the string happen to include color codes such as `[red]` or `[bold]`. Instead we should always colorize the format string before calling functions like `Sprintf`. This commit fixes all instances in this file. --- internal/command/format/diff.go | 44 ++++++++++++++++----------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index 0028d0038cda..c70918af4ac2 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -68,35 +68,35 @@ func ResourceChange( switch change.Action { case plans.Create: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be created", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] will be created"), dispAddr)) case plans.Read: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be read during apply\n # (config refers to values not yet known)", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] will be read during apply\n # (config refers to values not yet known)"), dispAddr)) case plans.Update: switch language { case DiffLanguageProposedChange: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be updated in-place", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] will be updated in-place"), dispAddr)) case DiffLanguageDetectedDrift: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has changed", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] has changed"), dispAddr)) default: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] update (unknown reason %s)", dispAddr, language))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] update (unknown reason %s)"), dispAddr, language)) } case plans.CreateThenDelete, plans.DeleteThenCreate: switch change.ActionReason { case plans.ResourceInstanceReplaceBecauseTainted: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] is tainted, so must be [bold][red]replaced", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] is tainted, so must be [bold][red]replaced"), dispAddr)) case plans.ResourceInstanceReplaceByRequest: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be [bold][red]replaced[reset], as requested", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] will be [bold][red]replaced[reset], as requested"), dispAddr)) default: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] must be [bold][red]replaced", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] must be [bold][red]replaced"), dispAddr)) } case plans.Delete: switch language { case DiffLanguageProposedChange: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] will be [bold][red]destroyed", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] will be [bold][red]destroyed"), dispAddr)) case DiffLanguageDetectedDrift: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has been deleted", dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] has been deleted"), dispAddr)) default: - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] delete (unknown reason %s)", dispAddr, language))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] delete (unknown reason %s)"), dispAddr, language)) } if change.DeposedKey != states.NotDeposed { // Some extra context about this unusual situation. @@ -104,7 +104,7 @@ func ResourceChange( } case plans.NoOp: if change.Moved() { - buf.WriteString(color.Color(fmt.Sprintf("[bold] # %s[reset] has moved to [bold]%s[reset]", change.PrevRunAddr.String(), dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] has moved to [bold]%s[reset]"), change.PrevRunAddr.String(), dispAddr)) break } fallthrough @@ -115,7 +115,7 @@ func ResourceChange( buf.WriteString(color.Color("[reset]\n")) if change.Moved() && change.Action != plans.NoOp { - buf.WriteString(color.Color(fmt.Sprintf("[bold] # [reset]([bold]%s[reset] has moved to [bold]%s[reset])\n", change.PrevRunAddr.String(), dispAddr))) + buf.WriteString(fmt.Sprintf(color.Color("[bold] # [reset]([bold]%s[reset] has moved to [bold]%s[reset])\n"), change.PrevRunAddr.String(), dispAddr)) } if change.Moved() && change.Action == plans.NoOp { @@ -290,7 +290,7 @@ func (p *blockBodyDiffPrinter) writeBlockBodyDiff(schema *configschema.Block, ol } p.buf.WriteString("\n") p.buf.WriteString(strings.Repeat(" ", indent+2)) - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", result.skippedBlocks, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), result.skippedBlocks, noun)) } } @@ -1310,7 +1310,7 @@ func (p *blockBodyDiffPrinter) writeValueDiff(old, new cty.Value, indent int, pa if suppressedElements == 1 { noun = "element" } - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", suppressedElements, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), suppressedElements, noun)) p.buf.WriteString("\n") } @@ -1371,7 +1371,7 @@ func (p *blockBodyDiffPrinter) writeValueDiff(old, new cty.Value, indent int, pa if hidden == 1 { noun = "element" } - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", hidden, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), hidden, noun)) p.buf.WriteString("\n") } @@ -1513,7 +1513,7 @@ func (p *blockBodyDiffPrinter) writeValueDiff(old, new cty.Value, indent int, pa if suppressedElements == 1 { noun = "element" } - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", suppressedElements, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), suppressedElements, noun)) p.buf.WriteString("\n") } @@ -1605,7 +1605,7 @@ func (p *blockBodyDiffPrinter) writeValueDiff(old, new cty.Value, indent int, pa if suppressedElements == 1 { noun = "element" } - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", suppressedElements, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), suppressedElements, noun)) p.buf.WriteString("\n") } @@ -1678,7 +1678,7 @@ func (p *blockBodyDiffPrinter) writeSensitivityWarning(old, new cty.Value, inden if new.HasMark(marks.Sensitive) && !old.HasMark(marks.Sensitive) { p.buf.WriteString(strings.Repeat(" ", indent)) - p.buf.WriteString(p.color.Color(fmt.Sprintf("# [yellow]Warning:[reset] this %s will be marked as sensitive and will not\n", diffType))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("# [yellow]Warning:[reset] this %s will be marked as sensitive and will not\n"), diffType)) p.buf.WriteString(strings.Repeat(" ", indent)) p.buf.WriteString(fmt.Sprintf("# display in UI output after applying this change.%s\n", valueUnchangedSuffix)) } @@ -1686,7 +1686,7 @@ func (p *blockBodyDiffPrinter) writeSensitivityWarning(old, new cty.Value, inden // Note if changing this attribute will change its sensitivity if old.HasMark(marks.Sensitive) && !new.HasMark(marks.Sensitive) { p.buf.WriteString(strings.Repeat(" ", indent)) - p.buf.WriteString(p.color.Color(fmt.Sprintf("# [yellow]Warning:[reset] this %s will no longer be marked as sensitive\n", diffType))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("# [yellow]Warning:[reset] this %s will no longer be marked as sensitive\n"), diffType)) p.buf.WriteString(strings.Repeat(" ", indent)) p.buf.WriteString(fmt.Sprintf("# after applying this change.%s\n", valueUnchangedSuffix)) } @@ -1948,7 +1948,7 @@ func (p *blockBodyDiffPrinter) writeSkippedAttr(skipped, indent int) { } p.buf.WriteString("\n") p.buf.WriteString(strings.Repeat(" ", indent)) - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", skipped, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), skipped, noun)) } } @@ -1959,7 +1959,7 @@ func (p *blockBodyDiffPrinter) writeSkippedElems(skipped, indent int) { noun = "element" } p.buf.WriteString(strings.Repeat(" ", indent)) - p.buf.WriteString(p.color.Color(fmt.Sprintf("[dark_gray]# (%d unchanged %s hidden)[reset]", skipped, noun))) + p.buf.WriteString(fmt.Sprintf(p.color.Color("[dark_gray]# (%d unchanged %s hidden)[reset]"), skipped, noun)) p.buf.WriteString("\n") } } From 4d1baaceabaa968c1e5009536a70341b1657b7fe Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 16 Sep 2021 17:06:52 -0400 Subject: [PATCH 072/644] Add Machine-Readable UI to sidebar and add hyphen :-) --- .../internals/machine-readable-ui.html.md | 4 ++-- website/layouts/docs.erb | 23 +++++++++++-------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/website/docs/internals/machine-readable-ui.html.md b/website/docs/internals/machine-readable-ui.html.md index 76f675132071..250481eb7306 100644 --- a/website/docs/internals/machine-readable-ui.html.md +++ b/website/docs/internals/machine-readable-ui.html.md @@ -1,12 +1,12 @@ --- layout: "docs" -page_title: "Internals: Machine Readable UI" +page_title: "Internals: Machine-Readable UI" sidebar_current: "docs-internals-machine-readable-ui" description: |- Terraform provides a machine-readable streaming JSON UI output for plan, apply, and refresh operations. --- -# Machine Readable UI +# Machine-Readable UI -> **Note:** This format is available in Terraform 0.15.3 and later. diff --git a/website/layouts/docs.erb b/website/layouts/docs.erb index 06fcc1ea5ca3..b5b13bb5380c 100644 --- a/website/layouts/docs.erb +++ b/website/layouts/docs.erb @@ -543,40 +543,45 @@
  • - Module Registry Protocol + JSON Output Format
  • - Provider Network Mirror Protocol + Login Protocol
  • - Provider Registry Protocol + Machine-Readable UI
  • - Resource Graph + Module Registry Protocol
  • - Resource Lifecycle + Provider Metadata
  • - Login Protocol + Provider Network Mirror Protocol
  • - JSON Output Format + Provider Registry Protocol
  • - Remote Service Discovery + Resource Graph
  • - Provider Metadata + Resource Lifecycle
    • + +
  • + Remote Service Discovery +
    • + From a8e5b6a4ad1747d95a6f00acde01d68f3fc5b3b8 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 16 Sep 2021 17:11:31 -0400 Subject: [PATCH 073/644] Fix alphabetical order of sidebar --- website/layouts/docs.erb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/layouts/docs.erb b/website/layouts/docs.erb index b5b13bb5380c..da4f0f6c9176 100644 --- a/website/layouts/docs.erb +++ b/website/layouts/docs.erb @@ -571,15 +571,15 @@
  • - Resource Graph + Remote Service Discovery
    • - +
  • - Resource Lifecycle + Resource Graph
  • - Remote Service Discovery + Resource Lifecycle
    • From 9a7bbdab6f0707fa07de5b1a57a50f492ab00459 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 17 Sep 2021 14:46:44 -0400 Subject: [PATCH 074/644] Fix terraform add test failure due to bad merge --- internal/command/add_test.go | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/internal/command/add_test.go b/internal/command/add_test.go index 7effd2f698ea..7afe5e754bc6 100644 --- a/internal/command/add_test.go +++ b/internal/command/add_test.go @@ -136,9 +136,23 @@ resource "test_instance" "new" { fmt.Println(output.Stderr()) t.Fatalf("wrong exit status. Got %d, want 0", code) } - expected := `resource "test_instance" "new" { + expected := `# NOTE: The "terraform add" command is currently experimental and offers only a +# starting point for your resource configuration, with some limitations. +# +# The behavior of this command may change in future based on feedback, possibly +# in incompatible ways. We don't recommend building automation around this +# command at this time. If you have feedback about this command, please open +# a feature request issue in the Terraform GitHub repository. +resource "test_instance" "new" { value = null # REQUIRED string } +# NOTE: The "terraform add" command is currently experimental and offers only a +# starting point for your resource configuration, with some limitations. +# +# The behavior of this command may change in future based on feedback, possibly +# in incompatible ways. We don't recommend building automation around this +# command at this time. If you have feedback about this command, please open +# a feature request issue in the Terraform GitHub repository. resource "test_instance" "new2" { value = null # REQUIRED string } @@ -261,7 +275,14 @@ resource "test_instance" "new" { fmt.Println(output.Stderr()) t.Fatalf("wrong exit status. Got %d, want 0", code) } - expected := `resource "test_instance" "exists" { + expected := `# NOTE: The "terraform add" command is currently experimental and offers only a +# starting point for your resource configuration, with some limitations. +# +# The behavior of this command may change in future based on feedback, possibly +# in incompatible ways. We don't recommend building automation around this +# command at this time. If you have feedback about this command, please open +# a feature request issue in the Terraform GitHub repository. +resource "test_instance" "exists" { value = null # REQUIRED string } ` From 61b2d8e3fe89d2397ac8286bcba32060ea96c47d Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 16 Sep 2021 12:42:00 -0400 Subject: [PATCH 075/644] core: Plan drift includes move-only changes Previously, drifted resources included only updates and deletes. To correctly display the full changes which would result as part of a refresh-only apply, the drifted resources must also include move-only changes. --- internal/terraform/context_plan.go | 36 ++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index fce564bf3fa3..20124bd88436 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -499,6 +499,14 @@ func (c *Context) driftedResources(config *configs.Config, oldState, newState *s continue } addr := rs.Addr.Instance(key) + + // Previous run address defaults to the current address, but + // can differ if the resource moved before refreshing + prevRunAddr := addr + if move, ok := moves[addr.UniqueKey()]; ok { + prevRunAddr = move.From + } + newIS := newState.ResourceInstance(addr) schema, _ := schemas.ResourceTypeConfig( @@ -547,20 +555,30 @@ func (c *Context) driftedResources(config *configs.Config, oldState, newState *s newVal = cty.NullVal(ty) } - if oldVal.RawEquals(newVal) { + if oldVal.RawEquals(newVal) && addr.Equal(prevRunAddr) { // No drift if the two values are semantically equivalent + // and no move has happened continue } - // We can only detect updates and deletes as drift. - action := plans.Update - if newVal.IsNull() { + // We can detect three types of changes after refreshing state, + // only two of which are easily understood as "drift": + // + // - Resources which were deleted outside of Terraform; + // - Resources where the object value has changed outside of + // Terraform; + // - Resources which have been moved without other changes. + // + // All of these are returned as drift, to allow refresh-only plans + // to present a full set of changes which will be applied. + var action plans.Action + switch { + case newVal.IsNull(): action = plans.Delete - } - - prevRunAddr := addr - if move, ok := moves[addr.UniqueKey()]; ok { - prevRunAddr = move.From + case !oldVal.RawEquals(newVal): + action = plans.Update + default: + action = plans.NoOp } change := &plans.ResourceInstanceChange{ From 638784b19590c489cf03d7567e77a901d1a5a313 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 16 Sep 2021 12:44:13 -0400 Subject: [PATCH 076/644] cli: Omit move-only drift, except for refresh-only The set of drifted resources now includes move-only changes, where the object value is identical but a move has been executed. In normal operation, we previousl displayed these moves twice: once as part of drift output, and once as part of planned changes. As of this commit we omit move-only changes from drift display, except for refresh-only plans. This fixes the redundant output. --- internal/command/views/operation_test.go | 49 ++++++++++++++++ internal/command/views/plan.go | 23 ++++++-- internal/terraform/context_plan.go | 2 +- internal/terraform/context_plan2_test.go | 75 ++++++++++++++++++++++++ 4 files changed, 142 insertions(+), 7 deletions(-) diff --git a/internal/command/views/operation_test.go b/internal/command/views/operation_test.go index b2e4f8f8e47a..56ced35779a2 100644 --- a/internal/command/views/operation_test.go +++ b/internal/command/views/operation_test.go @@ -189,6 +189,55 @@ func TestOperation_planNoChanges(t *testing.T) { }, "If you were expecting these changes then you can apply this plan", }, + "move-only changes in refresh-only mode": { + func(schemas *terraform.Schemas) *plans.Plan { + addr := addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "somewhere", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + addrPrev := addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "anywhere", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + schema, _ := schemas.ResourceTypeConfig( + addrs.NewDefaultProvider("test"), + addr.Resource.Resource.Mode, + addr.Resource.Resource.Type, + ) + ty := schema.ImpliedType() + rc := &plans.ResourceInstanceChange{ + Addr: addr, + PrevRunAddr: addrPrev, + ProviderAddr: addrs.RootModuleInstance.ProviderConfigDefault( + addrs.NewDefaultProvider("test"), + ), + Change: plans.Change{ + Action: plans.NoOp, + Before: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("1234"), + "foo": cty.StringVal("bar"), + }), + After: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("1234"), + "foo": cty.StringVal("bar"), + }), + }, + } + rcs, err := rc.Encode(ty) + if err != nil { + panic(err) + } + drs := []*plans.ResourceInstanceChangeSrc{rcs} + return &plans.Plan{ + UIMode: plans.RefreshOnlyMode, + Changes: plans.NewChanges(), + DriftedResources: drs, + } + }, + "test_resource.anywhere has moved to test_resource.somewhere", + }, "drift detected in destroy mode": { func(schemas *terraform.Schemas) *plans.Plan { return &plans.Plan{ diff --git a/internal/command/views/plan.go b/internal/command/views/plan.go index 175c263698a2..b861ddcfdf3f 100644 --- a/internal/command/views/plan.go +++ b/internal/command/views/plan.go @@ -96,9 +96,24 @@ func (v *PlanJSON) HelpPrompt() { // The plan renderer is used by the Operation view (for plan and apply // commands) and the Show view (for the show command). func renderPlan(plan *plans.Plan, schemas *terraform.Schemas, view *View) { - haveRefreshChanges := len(plan.DriftedResources) > 0 + // In refresh-only mode, we show all resources marked as drifted, + // including those which have moved without other changes. In other plan + // modes, move-only changes will be rendered in the planned changes, so + // we skip them here. + var driftedResources []*plans.ResourceInstanceChangeSrc + if plan.UIMode == plans.RefreshOnlyMode { + driftedResources = plan.DriftedResources + } else { + for _, dr := range plan.DriftedResources { + if dr.Action != plans.NoOp { + driftedResources = append(driftedResources, dr) + } + } + } + + haveRefreshChanges := len(driftedResources) > 0 if haveRefreshChanges { - renderChangesDetectedByRefresh(plan.DriftedResources, schemas, view) + renderChangesDetectedByRefresh(driftedResources, schemas, view) switch plan.UIMode { case plans.RefreshOnlyMode: view.streams.Println(format.WordWrap( @@ -368,10 +383,6 @@ func renderChangesDetectedByRefresh(drs []*plans.ResourceInstanceChangeSrc, sche }) for _, rcs := range drs { - if rcs.Action == plans.NoOp && !rcs.Moved() { - continue - } - providerSchema := schemas.ProviderSchema(rcs.ProviderAddr.Provider) if providerSchema == nil { // Should never happen diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 20124bd88436..3735dd91c927 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -471,7 +471,7 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, func (c *Context) driftedResources(config *configs.Config, oldState, newState *states.State, moves map[addrs.UniqueKey]refactoring.MoveResult) ([]*plans.ResourceInstanceChangeSrc, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics - if newState.ManagedResourcesEqual(oldState) { + if newState.ManagedResourcesEqual(oldState) && len(moves) == 0 { // Nothing to do, because we only detect and report drift for managed // resource instances. return nil, diags diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 46185ae22e76..1167f234c00d 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -984,7 +984,82 @@ The -target option is not for routine use, and is provided only for exceptional if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { t.Errorf("wrong diagnostics\n%s", diff) } + }) +} + +func TestContext2Plan_movedResourceRefreshOnly(t *testing.T) { + addrA := mustResourceInstanceAddr("test_object.a") + addrB := mustResourceInstanceAddr("test_object.b") + m := testModuleInline(t, map[string]string{ + "main.tf": ` + resource "test_object" "b" { + } + + moved { + from = test_object.a + to = test_object.b + } + + terraform { + experiments = [config_driven_move] + } + `, + }) + + state := states.BuildState(func(s *states.SyncState) { + // The prior state tracks test_object.a, which we should treat as + // test_object.b because of the "moved" block in the config. + s.SetResourceInstanceCurrent(addrA, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + p := simpleMockProvider() + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + }) + if diags.HasErrors() { + t.Fatalf("unexpected errors\n%s", diags.Err().Error()) + } + + t.Run(addrA.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrA) + if instPlan != nil { + t.Fatalf("unexpected plan for %s; should've moved to %s", addrA, addrB) + } + }) + t.Run(addrB.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrB) + if instPlan != nil { + t.Fatalf("unexpected plan for %s", addrB) + } + }) + t.Run("drift", func(t *testing.T) { + var drifted *plans.ResourceInstanceChangeSrc + for _, dr := range plan.DriftedResources { + if dr.Addr.Equal(addrB) { + drifted = dr + break + } + } + + if drifted == nil { + t.Fatalf("instance %s is missing from the drifted resource changes", addrB) + } + + if got, want := drifted.PrevRunAddr, addrA; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := drifted.Action, plans.NoOp; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } }) } From 7f99a8802e85e09ef4407d8931ddc99b3b5507e1 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 16 Sep 2021 17:23:32 -0700 Subject: [PATCH 077/644] addrs: MoveEndpointInModule.SelectsResource This is similar to the existing SelectsModule method, returning true if the reciever selects either a particular resource as a whole or any of the instances of that resource. We don't need this test in the normal case, but we will need it in a subsequent commit when we'll be possibly generating _implied_ move statements between instances of resources, but only if there aren't explicit move statements mentioning those resources already. --- internal/addrs/move_endpoint_module.go | 31 +++++ internal/addrs/move_endpoint_module_test.go | 127 ++++++++++++++++++++ 2 files changed, 158 insertions(+) diff --git a/internal/addrs/move_endpoint_module.go b/internal/addrs/move_endpoint_module.go index 654252ba9f25..5b9b62478c1e 100644 --- a/internal/addrs/move_endpoint_module.go +++ b/internal/addrs/move_endpoint_module.go @@ -233,6 +233,37 @@ func (e *MoveEndpointInModule) SelectsModule(addr ModuleInstance) bool { return true } +// SelectsResource returns true if the receiver directly selects either +// the given resource or one of its instances. +func (e *MoveEndpointInModule) SelectsResource(addr AbsResource) bool { + // Only a subset of subject types can possibly select a resource, so + // we'll take care of those quickly before we do anything more expensive. + switch e.relSubject.(type) { + case AbsResource, AbsResourceInstance: + // okay + default: + return false // can't possibly match + } + + if !e.SelectsModule(addr.Module) { + return false + } + + // If we get here then we know the module part matches, so we only need + // to worry about the relative resource part. + switch relSubject := e.relSubject.(type) { + case AbsResource: + return addr.Resource.Equal(relSubject.Resource) + case AbsResourceInstance: + // We intentionally ignore the instance key, because we consider + // instances to be part of the resource they belong to. + return addr.Resource.Equal(relSubject.Resource.Resource) + default: + // We should've filtered out all other types above + panic(fmt.Sprintf("unsupported relSubject type %T", relSubject)) + } +} + // moduleInstanceCanMatch indicates that modA can match modB taking into // account steps with an anyKey InstanceKey as wildcards. The comparison of // wildcard steps is done symmetrically, because varying portions of either diff --git a/internal/addrs/move_endpoint_module_test.go b/internal/addrs/move_endpoint_module_test.go index 6c85380b6089..bda37ca53974 100644 --- a/internal/addrs/move_endpoint_module_test.go +++ b/internal/addrs/move_endpoint_module_test.go @@ -1457,6 +1457,133 @@ func TestSelectsModule(t *testing.T) { } } +func TestSelectsResource(t *testing.T) { + matchingResource := Resource{ + Mode: ManagedResourceMode, + Type: "foo", + Name: "matching", + } + unmatchingResource := Resource{ + Mode: ManagedResourceMode, + Type: "foo", + Name: "unmatching", + } + childMod := Module{ + "child", + } + childModMatchingInst := ModuleInstance{ + ModuleInstanceStep{Name: "child", InstanceKey: StringKey("matching")}, + } + childModUnmatchingInst := ModuleInstance{ + ModuleInstanceStep{Name: "child", InstanceKey: StringKey("unmatching")}, + } + + tests := []struct { + Endpoint *MoveEndpointInModule + Addr AbsResource + Selects bool + }{ + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Absolute(nil), + }, + Addr: matchingResource.Absolute(nil), + Selects: true, // exact match + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: unmatchingResource.Absolute(nil), + }, + Addr: matchingResource.Absolute(nil), + Selects: false, // wrong resource name + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: unmatchingResource.Instance(IntKey(1)).Absolute(nil), + }, + Addr: matchingResource.Absolute(nil), + Selects: false, // wrong resource name + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Instance(NoKey).Absolute(nil), + }, + Addr: matchingResource.Absolute(nil), + Selects: true, // matches one instance + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Instance(IntKey(0)).Absolute(nil), + }, + Addr: matchingResource.Absolute(nil), + Selects: true, // matches one instance + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Instance(StringKey("a")).Absolute(nil), + }, + Addr: matchingResource.Absolute(nil), + Selects: true, // matches one instance + }, + { + Endpoint: &MoveEndpointInModule{ + module: childMod, + relSubject: matchingResource.Absolute(nil), + }, + Addr: matchingResource.Absolute(childModMatchingInst), + Selects: true, // in one of the instances of the module where the statement was written + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Absolute(childModMatchingInst), + }, + Addr: matchingResource.Absolute(childModMatchingInst), + Selects: true, // exact match + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Instance(IntKey(2)).Absolute(childModMatchingInst), + }, + Addr: matchingResource.Absolute(childModMatchingInst), + Selects: true, // matches one instance + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: matchingResource.Absolute(childModMatchingInst), + }, + Addr: matchingResource.Absolute(childModUnmatchingInst), + Selects: false, // the containing module instance doesn't match + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: AbsModuleCall{ + Module: mustParseModuleInstanceStr("module.foo[2]"), + Call: ModuleCall{Name: "bar"}, + }, + }, + Addr: matchingResource.Absolute(mustParseModuleInstanceStr("module.foo[2]")), + Selects: false, // a module call can't match a resource + }, + { + Endpoint: &MoveEndpointInModule{ + relSubject: mustParseModuleInstanceStr("module.foo[2]"), + }, + Addr: matchingResource.Absolute(mustParseModuleInstanceStr("module.foo[2]")), + Selects: false, // a module instance can't match a resource + }, + } + + for i, test := range tests { + t.Run(fmt.Sprintf("[%02d]%s SelectsResource(%s)", i, test.Endpoint, test.Addr), + func(t *testing.T) { + if got, want := test.Endpoint.SelectsResource(test.Addr), test.Selects; got != want { + t.Errorf("wrong result\nReceiver: %s\nArgument: %s\ngot: %t\nwant: %t", test.Endpoint, test.Addr, got, want) + } + }, + ) + } +} + func mustParseAbsResourceInstanceStr(s string) AbsResourceInstance { r, diags := ParseAbsResourceInstanceStr(s) if diags.HasErrors() { From ef5a1c9cfe5b0c5c578707c135028528322e4d99 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 16 Sep 2021 17:58:06 -0700 Subject: [PATCH 078/644] refactoring: ImpliedMoveStatements function This new function complements the existing function FindMoveStatements by potentially generating additional "implied" move statements that aren't written explicit in the configuration but that we'll infer by comparing the configuration and te previous run state. The goal here is to infer only enough to replicate the effect of the "count boundary fixup" graph node (terraform.NodeCountBoundary) that we currently use to deal with this concern of preserving the zero-instance when switching between "count" and not "count". This is just dead code for now. A subsequent commit will introduce this into the "terraform" package while also removing terraform.NodeCountBoundary, thus achieving the same effect as before but in a way that'll get reported in the UI as a move, using the same language that we'd use for an explicit move statement. --- internal/addrs/move_endpoint_module.go | 40 ++++++ internal/refactoring/move_statement.go | 129 +++++++++++++++++ internal/refactoring/move_statement_test.go | 132 ++++++++++++++++++ .../move-statement-implied.tf | 46 ++++++ 4 files changed, 347 insertions(+) create mode 100644 internal/refactoring/move_statement_test.go create mode 100644 internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf diff --git a/internal/addrs/move_endpoint_module.go b/internal/addrs/move_endpoint_module.go index 5b9b62478c1e..8bbbe83e7d11 100644 --- a/internal/addrs/move_endpoint_module.go +++ b/internal/addrs/move_endpoint_module.go @@ -2,6 +2,7 @@ package addrs import ( "fmt" + "reflect" "strings" "github.com/hashicorp/terraform/internal/tfdiags" @@ -51,6 +52,27 @@ type MoveEndpointInModule struct { relSubject AbsMoveable } +// ImpliedMoveStatementEndpoint is a special constructor for MoveEndpointInModule +// which is suitable only for constructing "implied" move statements, which +// means that we inferred the statement automatically rather than building it +// from an explicit block in the configuration. +// +// Implied move endpoints, just as for the statements they are embedded in, +// have somewhat-related-but-imprecise source ranges, typically referring to +// some general configuration construct that implied the statement, because +// by definition there is no explicit move endpoint expression in this case. +func ImpliedMoveStatementEndpoint(addr AbsResourceInstance, rng tfdiags.SourceRange) *MoveEndpointInModule { + // implied move endpoints always belong to the root module, because each + // one refers to a single resource instance inside a specific module + // instance, rather than all instances of the module where the resource + // was declared. + return &MoveEndpointInModule{ + SourceRange: rng, + module: RootModule, + relSubject: addr, + } +} + func (e *MoveEndpointInModule) ObjectKind() MoveEndpointKind { return absMoveableEndpointKind(e.relSubject) } @@ -85,6 +107,24 @@ func (e *MoveEndpointInModule) String() string { return buf.String() } +// Equal returns true if the reciever represents the same matching pattern +// as the other given endpoint, ignoring the source location information. +// +// This is not an optimized function and is here primarily to help with +// writing concise assertions in test code. +func (e *MoveEndpointInModule) Equal(other *MoveEndpointInModule) bool { + if (e == nil) != (other == nil) { + return false + } + if !e.module.Equal(other.module) { + return false + } + // This assumes that all of our possible "movables" are trivially + // comparable with reflect, which is true for all of them at the time + // of writing. + return reflect.DeepEqual(e.relSubject, other.relSubject) +} + // Module returns the address of the module where the receiving address was // declared. func (e *MoveEndpointInModule) Module() Module { diff --git a/internal/refactoring/move_statement.go b/internal/refactoring/move_statement.go index 9edafc7b4c09..baaf9d519b85 100644 --- a/internal/refactoring/move_statement.go +++ b/internal/refactoring/move_statement.go @@ -5,12 +5,26 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" ) type MoveStatement struct { From, To *addrs.MoveEndpointInModule DeclRange tfdiags.SourceRange + + // Implied is true for statements produced by ImpliedMoveStatements, and + // false for statements produced by FindMoveStatements. + // + // An "implied" statement is one that has no explicit "moved" block in + // the configuration and was instead generated automatically based on a + // comparison between current configuration and previous run state. + // For implied statements, the DeclRange field contains the source location + // of something in the source code that implied the statement, in which + // case it would probably be confusing to show that source range to the + // user, e.g. in an error message, without clearly mentioning that it's + // related to an implied move statement. + Implied bool } // FindMoveStatements recurses through the modules of the given configuration @@ -34,6 +48,7 @@ func findMoveStatements(cfg *configs.Config, into []MoveStatement) []MoveStateme From: fromAddr, To: toAddr, DeclRange: tfdiags.SourceRangeFromHCL(mc.DeclRange), + Implied: false, }) } @@ -44,6 +59,102 @@ func findMoveStatements(cfg *configs.Config, into []MoveStatement) []MoveStateme return into } +// ImpliedMoveStatements compares addresses in the given state with addresses +// in the given configuration and potentially returns additional MoveStatement +// objects representing moves we infer automatically, even though they aren't +// explicitly recorded in the configuration. +// +// We do this primarily for backward compatibility with behaviors of Terraform +// versions prior to introducing explicit "moved" blocks. Specifically, this +// function aims to achieve the same result as the "NodeCountBoundary" +// heuristic from Terraform v1.0 and earlier, where adding or removing the +// "count" meta-argument from an already-created resource can automatically +// preserve the zeroth or the NoKey instance, depending on the direction of +// the change. We do this only for resources that aren't mentioned already +// in at least one explicit move statement. +// +// As with the previous-version heuristics it replaces, this is a best effort +// and doesn't handle all situations. An explicit move statement is always +// preferred, but our goal here is to match exactly the same cases that the +// old heuristic would've matched, to retain compatibility for existing modules. +// +// We should think very hard before adding any _new_ implication rules for +// moved statements. +func ImpliedMoveStatements(rootCfg *configs.Config, prevRunState *states.State, explicitStmts []MoveStatement) []MoveStatement { + return impliedMoveStatements(rootCfg, prevRunState, explicitStmts, nil) +} + +func impliedMoveStatements(cfg *configs.Config, prevRunState *states.State, explicitStmts []MoveStatement, into []MoveStatement) []MoveStatement { + modAddr := cfg.Path + + // There can be potentially many instances of the module, so we need + // to consider each of them separately. + for _, modState := range prevRunState.ModuleInstances(modAddr) { + // What we're looking for here is either a no-key resource instance + // where the configuration has count set or a zero-key resource + // instance where the configuration _doesn't_ have count set. + // If so, we'll generate a statement replacing no-key with zero-key or + // vice-versa. + for _, rState := range modState.Resources { + rAddr := rState.Addr + rCfg := cfg.Module.ResourceByAddr(rAddr.Resource) + if rCfg == nil { + // If there's no configuration at all then there can't be any + // automatic move fixup to do. + continue + } + approxSrcRange := tfdiags.SourceRangeFromHCL(rCfg.DeclRange) + + // NOTE: We're intentionally not checking to see whether the + // "to" addresses in our implied statements already have + // instances recorded in state, because ApplyMoves should + // deal with such conflicts in a deterministic way for both + // explicit and implicit moves, and we'd rather have that + // handled all in one place. + + var fromKey, toKey addrs.InstanceKey + + switch { + case rCfg.Count != nil: + // If we have a count expression then we'll use _that_ as + // a slightly-more-precise approximate source range. + approxSrcRange = tfdiags.SourceRangeFromHCL(rCfg.Count.Range()) + + if riState := rState.Instances[addrs.NoKey]; riState != nil { + fromKey = addrs.NoKey + toKey = addrs.IntKey(0) + } + default: + if riState := rState.Instances[addrs.IntKey(0)]; riState != nil { + fromKey = addrs.IntKey(0) + toKey = addrs.NoKey + } + } + + if fromKey != toKey { + // We mustn't generate an impied statement if the user already + // wrote an explicit statement referring to this resource, + // because they may wish to select an instance key other than + // zero as the one to retain. + if !haveMoveStatementForResource(rAddr, explicitStmts) { + into = append(into, MoveStatement{ + From: addrs.ImpliedMoveStatementEndpoint(rAddr.Instance(fromKey), approxSrcRange), + To: addrs.ImpliedMoveStatementEndpoint(rAddr.Instance(toKey), approxSrcRange), + DeclRange: approxSrcRange, + Implied: true, + }) + } + } + } + } + + for _, childCfg := range cfg.Children { + into = findMoveStatements(childCfg, into) + } + + return into +} + func (s *MoveStatement) ObjectKind() addrs.MoveEndpointKind { // addrs.UnifyMoveEndpoints guarantees that both of our addresses have // the same kind, so we can just arbitrary use From and assume To will @@ -55,3 +166,21 @@ func (s *MoveStatement) ObjectKind() addrs.MoveEndpointKind { func (s *MoveStatement) Name() string { return fmt.Sprintf("%s->%s", s.From, s.To) } + +func haveMoveStatementForResource(addr addrs.AbsResource, stmts []MoveStatement) bool { + // This is not a particularly optimal way to answer this question, + // particularly since our caller calls this function in a loop already, + // but we expect the total number of explicit statements to be small + // in any reasonable Terraform configuration and so a more complicated + // approach wouldn't be justified here. + + for _, stmt := range stmts { + if stmt.From.SelectsResource(addr) { + return true + } + if stmt.To.SelectsResource(addr) { + return true + } + } + return false +} diff --git a/internal/refactoring/move_statement_test.go b/internal/refactoring/move_statement_test.go new file mode 100644 index 000000000000..93164f94cc5e --- /dev/null +++ b/internal/refactoring/move_statement_test.go @@ -0,0 +1,132 @@ +package refactoring + +import ( + "sort" + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +func TestImpliedMoveStatements(t *testing.T) { + resourceAddr := func(name string) addrs.AbsResource { + return addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "foo", + Name: name, + }.Absolute(addrs.RootModuleInstance) + } + instObjState := func() *states.ResourceInstanceObjectSrc { + return &states.ResourceInstanceObjectSrc{} + } + providerAddr := addrs.AbsProviderConfig{ + Module: addrs.RootModule, + Provider: addrs.MustParseProviderSourceString("hashicorp/foo"), + } + + rootCfg, _ := loadRefactoringFixture(t, "testdata/move-statement-implied") + prevRunState := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + resourceAddr("formerly_count").Instance(addrs.IntKey(0)), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("formerly_count").Instance(addrs.IntKey(1)), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("now_count").Instance(addrs.NoKey), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("formerly_count_explicit").Instance(addrs.IntKey(0)), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("formerly_count_explicit").Instance(addrs.IntKey(1)), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("now_count_explicit").Instance(addrs.NoKey), + instObjState(), + providerAddr, + ) + + // This "ambiguous" resource is representing a rare but possible + // situation where we end up having a mixture of different index + // types in the state at the same time. The main way to get into + // this state would be to remove "count = 1" and then have the + // provider fail to destroy the zero-key instance even though we + // already created the no-key instance. Users can also get here + // by using "terraform state mv" in weird ways. + s.SetResourceInstanceCurrent( + resourceAddr("ambiguous").Instance(addrs.NoKey), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("ambiguous").Instance(addrs.IntKey(0)), + instObjState(), + providerAddr, + ) + }) + + explicitStmts := FindMoveStatements(rootCfg) + got := ImpliedMoveStatements(rootCfg, prevRunState, explicitStmts) + want := []MoveStatement{ + { + From: addrs.ImpliedMoveStatementEndpoint(resourceAddr("formerly_count").Instance(addrs.IntKey(0)), tfdiags.SourceRange{}), + To: addrs.ImpliedMoveStatementEndpoint(resourceAddr("formerly_count").Instance(addrs.NoKey), tfdiags.SourceRange{}), + Implied: true, + DeclRange: tfdiags.SourceRange{ + Filename: "testdata/move-statement-implied/move-statement-implied.tf", + Start: tfdiags.SourcePos{Line: 9, Column: 1, Byte: 232}, + End: tfdiags.SourcePos{Line: 9, Column: 32, Byte: 263}, + }, + }, + { + From: addrs.ImpliedMoveStatementEndpoint(resourceAddr("now_count").Instance(addrs.NoKey), tfdiags.SourceRange{}), + To: addrs.ImpliedMoveStatementEndpoint(resourceAddr("now_count").Instance(addrs.IntKey(0)), tfdiags.SourceRange{}), + Implied: true, + DeclRange: tfdiags.SourceRange{ + Filename: "testdata/move-statement-implied/move-statement-implied.tf", + Start: tfdiags.SourcePos{Line: 14, Column: 11, Byte: 334}, + End: tfdiags.SourcePos{Line: 14, Column: 12, Byte: 335}, + }, + }, + + // We generate foo.ambiguous[0] to foo.ambiguous here, even though + // there's already a foo.ambiguous in the state, because it's the + // responsibility of the later ApplyMoves step to deal with the + // situation where an object wants to move into an address already + // occupied by another object. + { + From: addrs.ImpliedMoveStatementEndpoint(resourceAddr("ambiguous").Instance(addrs.IntKey(0)), tfdiags.SourceRange{}), + To: addrs.ImpliedMoveStatementEndpoint(resourceAddr("ambiguous").Instance(addrs.NoKey), tfdiags.SourceRange{}), + Implied: true, + DeclRange: tfdiags.SourceRange{ + Filename: "testdata/move-statement-implied/move-statement-implied.tf", + Start: tfdiags.SourcePos{Line: 42, Column: 1, Byte: 709}, + End: tfdiags.SourcePos{Line: 42, Column: 27, Byte: 735}, + }, + }, + } + + sort.Slice(got, func(i, j int) bool { + // This is just an arbitrary sort to make the result consistent + // regardless of what order the ImpliedMoveStatements function + // visits the entries in the state/config. + return got[i].DeclRange.Start.Line < got[j].DeclRange.Start.Line + }) + + if diff := cmp.Diff(want, got); diff != "" { + t.Errorf("wrong result\n%s", diff) + } +} diff --git a/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf b/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf new file mode 100644 index 000000000000..1de3238bdb34 --- /dev/null +++ b/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf @@ -0,0 +1,46 @@ +# This fixture is useful only in conjunction with a previous run state that +# conforms to the statements encoded in the resource names. It's for +# TestImpliedMoveStatements only. + +terraform { + experiments = [config_driven_move] +} + +resource "foo" "formerly_count" { + # but not count anymore +} + +resource "foo" "now_count" { + count = 2 +} + +resource "foo" "new_no_count" { +} + +resource "foo" "new_count" { + count = 2 +} + +resource "foo" "formerly_count_explicit" { + # but not count anymore +} + +moved { + from = foo.formerly_count_explicit[1] + to = foo.formerly_count_explicit +} + +resource "foo" "now_count_explicit" { + count = 2 +} + +moved { + from = foo.now_count_explicit + to = foo.now_count_explicit[1] +} + +resource "foo" "ambiguous" { + # this one doesn't have count in the config, but the test should + # set it up to have both no-key and zero-key instances in the + # state. +} From ee9e346039ebe5f60782be24c82dd0c36fc1a783 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 17 Sep 2021 15:08:29 -0700 Subject: [PATCH 079/644] refactoring: ApplyMoves skips moving when destination address occupied Per our rule that the content of the state can never make a move statement invalid, our behavior for two objects trying to occupy the same address will be to just ignore that and let the object already at the address take priority. For the moment this is silent from an end-user perspective and appears only in our internal logs. However, I'm hoping that our future planned adjustment to the interface of this function will include some way to allow reporting these collisions in some end-user-visible way, either as a separate warning per collision or as a single warning that collects together all of the collisions into a single message somehow. This situation can arise both because the previous run state already contained an object at the target address of a move and because more than one move ends up trying to target the same location. In the latter case, which one "wins" is decided by our depth-first traversal order, which is in turn derived from our chaining and nesting rules and is therefore arbitrary but deterministic. --- internal/refactoring/move_execute.go | 36 +++++++++ internal/refactoring/move_execute_test.go | 96 +++++++++++++++++++++++ 2 files changed, 132 insertions(+) diff --git a/internal/refactoring/move_execute.go b/internal/refactoring/move_execute.go index 178a336af0b7..66c0d6c0a0ea 100644 --- a/internal/refactoring/move_execute.go +++ b/internal/refactoring/move_execute.go @@ -79,6 +79,18 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] // directly. if newAddr, matches := modAddr.MoveDestination(stmt.From, stmt.To); matches { log.Printf("[TRACE] refactoring.ApplyMoves: %s has moved to %s", modAddr, newAddr) + + // If we already have a module at the new address then + // we'll skip this move and let the existing object take + // priority. + // TODO: This should probably generate a user-visible + // warning, but we'd need to rethink the signature of this + // function to achieve that. + if ms := state.Module(newAddr); ms != nil { + log.Printf("[WARN] Skipped moving %s to %s, because there's already another module instance at the destination", modAddr, newAddr) + continue + } + // We need to visit all of the resource instances in the // module and record them individually as results. for _, rs := range ms.Resources { @@ -105,6 +117,18 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] rAddr := rs.Addr if newAddr, matches := rAddr.MoveDestination(stmt.From, stmt.To); matches { log.Printf("[TRACE] refactoring.ApplyMoves: resource %s has moved to %s", rAddr, newAddr) + + // If we already have a resource at the new address then + // we'll skip this move and let the existing object take + // priority. + // TODO: This should probably generate a user-visible + // warning, but we'd need to rethink the signature of this + // function to achieve that. + if rs := state.Resource(newAddr); rs != nil { + log.Printf("[WARN] Skipped moving %s to %s, because there's already another resource at the destination", rAddr, newAddr) + continue + } + for key := range rs.Instances { oldInst := rAddr.Instance(key) newInst := newAddr.Instance(key) @@ -122,6 +146,18 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] iAddr := rAddr.Instance(key) if newAddr, matches := iAddr.MoveDestination(stmt.From, stmt.To); matches { log.Printf("[TRACE] refactoring.ApplyMoves: resource instance %s has moved to %s", iAddr, newAddr) + + // If we already have a resource instance at the new + // address then we'll skip this move and let the existing + // object take priority. + // TODO: This should probably generate a user-visible + // warning, but we'd need to rethink the signature of this + // function to achieve that. + if is := state.ResourceInstance(newAddr); is != nil { + log.Printf("[WARN] Skipped moving %s to %s, because there's already another resource instance at the destination", iAddr, newAddr) + continue + } + result := MoveResult{From: iAddr, To: newAddr} results[iAddr.UniqueKey()] = result results[newAddr.UniqueKey()] = result diff --git a/internal/refactoring/move_execute_test.go b/internal/refactoring/move_execute_test.go index 63c54a7adbca..f3ab1ec1e31f 100644 --- a/internal/refactoring/move_execute_test.go +++ b/internal/refactoring/move_execute_test.go @@ -391,6 +391,102 @@ func TestApplyMoves(t *testing.T) { `module.bar[0].foo.to[0]`, }, }, + + "move module instance to already-existing module instance": { + []MoveStatement{ + testMoveStatement(t, "", "module.bar[0]", "module.boo"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["module.bar[0].foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["module.boo.foo.to[0]"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + map[addrs.UniqueKey]MoveResult{ + // Nothing moved, because the module.b address is already + // occupied by another module. + }, + []string{ + `module.bar[0].foo.from`, + `module.boo.foo.to[0]`, + }, + }, + + "move resource to already-existing resource": { + []MoveStatement{ + testMoveStatement(t, "", "foo.from", "foo.to"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["foo.to"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + map[addrs.UniqueKey]MoveResult{ + // Nothing moved, because the module.b address is already + // occupied by another module. + }, + []string{ + `foo.from`, + `foo.to`, + }, + }, + + "move resource instance to already-existing resource instance": { + []MoveStatement{ + testMoveStatement(t, "", "foo.from", "foo.to[0]"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["foo.to[0]"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + map[addrs.UniqueKey]MoveResult{ + // Nothing moved, because the module.b address is already + // occupied by another module. + }, + []string{ + `foo.from`, + `foo.to[0]`, + }, + }, } for name, test := range tests { From f0034beb339c52521c5c7cd40c99e225d861b2ac Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 17 Sep 2021 15:32:32 -0700 Subject: [PATCH 080/644] core: refactoring.ImpliedMoveStatements replaces NodeCountBoundary Going back a long time we've had a special magic behavior which tries to recognize a situation where a module author either added or removed the "count" argument from a resource that already has instances, and to silently rename the zeroth or no-key instance so that we don't plan to destroy and recreate the associated object. Now we have a more general idea of "move statements", and specifically the idea of "implied" move statements which replicates the same heuristic we used to use for this behavior, we can treat this magic renaming rule as just another "move statement", special only in that Terraform generates it automatically rather than it being written out explicitly in the configuration. In return for wiring that in, we can now remove altogether the NodeCountBoundary graph node type and its associated graph transformer, CountBoundaryTransformer. We handle moves as a preprocessing step before building the plan graph, so we no longer need to include any special nodes in the graph to deal with that situation. The test updates here are mainly for the graph builders themselves, to acknowledge that indeed we're no longer inserting the NodeCountBoundary vertices. The vertices that NodeCountBoundary previously depended on now become dependencies of the special "root" vertex, although in many cases here we don't see that explicitly because of the transitive reduction algorithm, which notices when there's already an equivalent indirect dependency chain and removes the redundant edge. We already have plenty of test coverage for these "count boundary" cases in the context tests whose names start with TestContext2Plan_count and TestContext2Apply_resourceCount, all of which continued to pass here without any modification and so are not visible in the diff. The test functions particularly relevant to this situation are: - TestContext2Plan_countIncreaseFromNotSet - TestContext2Plan_countDecreaseToOne - TestContext2Plan_countOneIndex - TestContext2Apply_countDecreaseToOneCorrupted The last of those in particular deals with the situation where we have both a no-key instance _and_ a zero-key instance in the prior state, which is interesting here because to exercises an intentional interaction between refactoring.ImpliedMoveStatements and refactoring.ApplyMoves, where we intentionally generate an implied move statement that produces a collision and then expect ApplyMoves to deal with it in the same way as it would deal with all other collisions, and thus ensure we handle both the explicit and implied collisions in the same way. This does affect some UI-level tests, because a nice side-effect of this new treatment of this old feature is that we can now report explicitly in the UI that we're assigning new addresses to these objects, whereas before we just said nothing and hoped the user would just guess what had happened and why they therefore weren't seeing a diff. The backend/local plan tests actually had a pre-existing bug where they were using a state with a different instance key than the config called for but getting away with it because we'd previously silently fix it up. That's still fixed up, but now done with an explicit mention in the UI and so I made the state consistent with the configuration here so that the tests would be able to recognize _real_ differences where present, as opposed to the errant difference caused by that inconsistency. --- internal/backend/local/backend_plan_test.go | 2 +- .../multi-resource-update/output.json | 12 ++- internal/states/sync.go | 54 ------------- internal/terraform/context_apply_test.go | 19 ++++- internal/terraform/context_plan.go | 9 ++- internal/terraform/eval_count.go | 31 ------- internal/terraform/graph_builder_apply.go | 5 -- .../terraform/graph_builder_apply_test.go | 29 +++---- internal/terraform/graph_builder_plan.go | 5 -- internal/terraform/graph_builder_plan_test.go | 54 +++++-------- internal/terraform/node_count_boundary.go | 80 ------------------- .../terraform/node_count_boundary_test.go | 72 ----------------- internal/terraform/node_resource_plan.go | 4 - .../terraform/transform_count_boundary.go | 33 -------- 14 files changed, 65 insertions(+), 344 deletions(-) delete mode 100644 internal/terraform/node_count_boundary.go delete mode 100644 internal/terraform/node_count_boundary_test.go delete mode 100644 internal/terraform/transform_count_boundary.go diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 7d5b92b161bb..6bae23555f3a 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -746,7 +746,7 @@ func testPlanState() *states.State { Mode: addrs.ManagedResourceMode, Type: "test_instance", Name: "foo", - }.Instance(addrs.IntKey(0)), + }.Instance(addrs.NoKey), &states.ResourceInstanceObjectSrc{ Status: states.ObjectReady, AttrsJSON: []byte(`{ diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index a7a6a3053fac..247749261356 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -47,22 +47,26 @@ }, "resource_drift": [ { - "address": "test_instance.test", + "address": "test_instance.test[0]", "mode": "managed", "type": "test_instance", "provider_name": "registry.terraform.io/hashicorp/test", "name": "test", + "index": 0, "change": { "actions": [ - "delete" + "no-op" ], "before": { "ami": "bar", "id": "placeholder" }, - "after": null, + "after": { + "ami": "bar", + "id": "placeholder" + }, "before_sensitive": {}, - "after_sensitive": false, + "after_sensitive": {}, "after_unknown": {} } } diff --git a/internal/states/sync.go b/internal/states/sync.go index c70714f9df49..f21984279509 100644 --- a/internal/states/sync.go +++ b/internal/states/sync.go @@ -248,60 +248,6 @@ func (s *SyncState) RemoveResourceIfEmpty(addr addrs.AbsResource) bool { return true } -// MaybeFixUpResourceInstanceAddressForCount deals with the situation where a -// resource has changed from having "count" set to not set, or vice-versa, and -// so we need to rename the zeroth instance key to no key at all, or vice-versa. -// -// Set countEnabled to true if the resource has count set in its new -// configuration, or false if it does not. -// -// The state is modified in-place if necessary, moving a resource instance -// between the two addresses. The return value is true if a change was made, -// and false otherwise. -func (s *SyncState) MaybeFixUpResourceInstanceAddressForCount(addr addrs.ConfigResource, countEnabled bool) bool { - s.lock.Lock() - defer s.lock.Unlock() - - // get all modules instances that may match this state - modules := s.state.ModuleInstances(addr.Module) - if len(modules) == 0 { - return false - } - - changed := false - - for _, ms := range modules { - relAddr := addr.Resource - rs := ms.Resource(relAddr) - if rs == nil { - continue - } - - huntKey := addrs.NoKey - replaceKey := addrs.InstanceKey(addrs.IntKey(0)) - if !countEnabled { - huntKey, replaceKey = replaceKey, huntKey - } - - is, exists := rs.Instances[huntKey] - if !exists { - continue - } - - if _, exists := rs.Instances[replaceKey]; exists { - // If the replacement key also exists then we'll do nothing and keep both. - continue - } - - // If we get here then we need to "rename" from hunt to replace - rs.Instances[replaceKey] = is - delete(rs.Instances, huntKey) - changed = true - } - - return changed -} - // SetResourceInstanceCurrent saves the given instance object as the current // generation of the resource instance with the given address, simultaneously // updating the recorded provider configuration address, dependencies, and diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 9d155e73e865..babf067a5e69 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -2073,9 +2073,22 @@ func TestContext2Apply_countDecreaseToOneX(t *testing.T) { // https://github.com/PeoplePerHour/terraform/pull/11 // -// This tests a case where both a "resource" and "resource.0" are in -// the state file, which apparently is a reasonable backwards compatibility -// concern found in the above 3rd party repo. +// This tests a rare but possible situation where we have both a no-key and +// a zero-key instance of the same resource in the configuration when we +// disable count. +// +// The main way to get here is for a provider to fail to destroy the zero-key +// instance but succeed in creating the no-key instance, since those two +// can typically happen concurrently. There are various other ways to get here +// that might be considered user error, such as using "terraform state mv" +// to create a strange combination of different key types on the same resource. +// +// This test indirectly exercises an intentional interaction between +// refactoring.ImpliedMoveStatements and refactoring.ApplyMoves: we'll first +// generate an implied move statement from aws_instance.foo[0] to +// aws_instance.foo, but then refactoring.ApplyMoves should notice that and +// ignore the statement, in the same way as it would if an explicit move +// statement specified the same situation. func TestContext2Apply_countDecreaseToOneCorrupted(t *testing.T) { m := testModule(t, "apply-count-dec-one") p := testProvider("aws") diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 3735dd91c927..f70a8f67b746 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -297,7 +297,14 @@ func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State } func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState *states.State, targets []addrs.Targetable) ([]refactoring.MoveStatement, map[addrs.UniqueKey]refactoring.MoveResult) { - moveStmts := refactoring.FindMoveStatements(config) + explicitMoveStmts := refactoring.FindMoveStatements(config) + implicitMoveStmts := refactoring.ImpliedMoveStatements(config, prevRunState, explicitMoveStmts) + var moveStmts []refactoring.MoveStatement + if stmtsLen := len(explicitMoveStmts) + len(implicitMoveStmts); stmtsLen > 0 { + moveStmts = make([]refactoring.MoveStatement, 0, stmtsLen) + moveStmts = append(moveStmts, explicitMoveStmts...) + moveStmts = append(moveStmts, implicitMoveStmts...) + } moveResults := refactoring.ApplyMoves(moveStmts, prevRunState) return moveStmts, moveResults } diff --git a/internal/terraform/eval_count.go b/internal/terraform/eval_count.go index a7f3c25ab35d..c74a051b301f 100644 --- a/internal/terraform/eval_count.go +++ b/internal/terraform/eval_count.go @@ -2,10 +2,8 @@ package terraform import ( "fmt" - "log" "github.com/hashicorp/hcl/v2" - "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" "github.com/zclconf/go-cty/cty/gocty" @@ -101,32 +99,3 @@ func evaluateCountExpressionValue(expr hcl.Expression, ctx EvalContext) (cty.Val return countVal, diags } - -// fixResourceCountSetTransition is a helper function to fix up the state when a -// resource transitions its "count" from being set to unset or vice-versa, -// treating a 0-key and a no-key instance as aliases for one another across -// the transition. -// -// The correct time to call this function is in the DynamicExpand method for -// a node representing a resource, just after evaluating the count with -// evaluateCountExpression, and before any other analysis of the -// state such as orphan detection. -// -// This function calls methods on the given EvalContext to update the current -// state in-place, if necessary. It is a no-op if there is no count transition -// taking place. -// -// Since the state is modified in-place, this function must take a writer lock -// on the state. The caller must therefore not also be holding a state lock, -// or this function will block forever awaiting the lock. -func fixResourceCountSetTransition(ctx EvalContext, addr addrs.ConfigResource, countEnabled bool) { - state := ctx.State() - if state.MaybeFixUpResourceInstanceAddressForCount(addr, countEnabled) { - log.Printf("[TRACE] renamed first %s instance in transient state due to count argument change", addr) - } - - refreshState := ctx.RefreshState() - if refreshState != nil && refreshState.MaybeFixUpResourceInstanceAddressForCount(addr, countEnabled) { - log.Printf("[TRACE] renamed first %s instance in transient state due to count argument change", addr) - } -} diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go index 94f1e7699fb5..75f9d3d4ad25 100644 --- a/internal/terraform/graph_builder_apply.go +++ b/internal/terraform/graph_builder_apply.go @@ -152,11 +152,6 @@ func (b *ApplyGraphBuilder) Steps() []GraphTransformer { // Target &TargetsTransformer{Targets: b.Targets}, - // Add the node to fix the state count boundaries - &CountBoundaryTransformer{ - Config: b.Config, - }, - // Close opened plugin connections &CloseProviderTransformer{}, diff --git a/internal/terraform/graph_builder_apply_test.go b/internal/terraform/graph_builder_apply_test.go index e1aba8d2c136..88ebcfefd1f3 100644 --- a/internal/terraform/graph_builder_apply_test.go +++ b/internal/terraform/graph_builder_apply_test.go @@ -5,10 +5,12 @@ import ( "strings" "testing" + "github.com/google/go-cmp/cmp" + "github.com/zclconf/go-cty/cty" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/states" - "github.com/zclconf/go-cty/cty" ) func TestApplyGraphBuilder_impl(t *testing.T) { @@ -60,11 +62,10 @@ func TestApplyGraphBuilder(t *testing.T) { t.Fatalf("wrong path %q", g.Path.String()) } - actual := strings.TrimSpace(g.String()) - - expected := strings.TrimSpace(testApplyGraphBuilderStr) - if actual != expected { - t.Fatalf("wrong result\n\ngot:\n%s\n\nwant:\n%s", actual, expected) + got := strings.TrimSpace(g.String()) + want := strings.TrimSpace(testApplyGraphBuilderStr) + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong result\n%s", diff) } } @@ -352,10 +353,10 @@ func TestApplyGraphBuilder_destroyCount(t *testing.T) { t.Fatalf("wrong module path %q", g.Path) } - actual := strings.TrimSpace(g.String()) - expected := strings.TrimSpace(testApplyGraphBuilderDestroyCountStr) - if actual != expected { - t.Fatalf("wrong result\n\ngot:\n%s\n\nwant:\n%s", actual, expected) + got := strings.TrimSpace(g.String()) + want := strings.TrimSpace(testApplyGraphBuilderDestroyCountStr) + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong result\n%s", diff) } } @@ -699,9 +700,6 @@ func TestApplyGraphBuilder_orphanedWithProvider(t *testing.T) { } const testApplyGraphBuilderStr = ` -meta.count-boundary (EachMode fixup) - module.child (close) - test_object.other module.child (close) module.child.test_object.other module.child (expand) @@ -721,7 +719,7 @@ provider["registry.terraform.io/hashicorp/test"] (close) module.child.test_object.other test_object.other root - meta.count-boundary (EachMode fixup) + module.child (close) provider["registry.terraform.io/hashicorp/test"] (close) test_object.create test_object.create (expand) @@ -735,13 +733,10 @@ test_object.other (expand) ` const testApplyGraphBuilderDestroyCountStr = ` -meta.count-boundary (EachMode fixup) - test_object.B provider["registry.terraform.io/hashicorp/test"] provider["registry.terraform.io/hashicorp/test"] (close) test_object.B root - meta.count-boundary (EachMode fixup) provider["registry.terraform.io/hashicorp/test"] (close) test_object.A (expand) provider["registry.terraform.io/hashicorp/test"] diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index b267f9c428c7..709b917b6733 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -156,11 +156,6 @@ func (b *PlanGraphBuilder) Steps() []GraphTransformer { // node due to dependency edges, to avoid graph cycles during apply. &ForcedCBDTransformer{}, - // Add the node to fix the state count boundaries - &CountBoundaryTransformer{ - Config: b.Config, - }, - // Close opened plugin connections &CloseProviderTransformer{}, diff --git a/internal/terraform/graph_builder_plan_test.go b/internal/terraform/graph_builder_plan_test.go index 689f9faff3db..9ec16c6ed79f 100644 --- a/internal/terraform/graph_builder_plan_test.go +++ b/internal/terraform/graph_builder_plan_test.go @@ -4,10 +4,12 @@ import ( "strings" "testing" + "github.com/google/go-cmp/cmp" + "github.com/zclconf/go-cty/cty" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/providers" - "github.com/zclconf/go-cty/cty" ) func TestPlanGraphBuilder_impl(t *testing.T) { @@ -45,10 +47,10 @@ func TestPlanGraphBuilder(t *testing.T) { t.Fatalf("wrong module path %q", g.Path) } - actual := strings.TrimSpace(g.String()) - expected := strings.TrimSpace(testPlanGraphBuilderStr) - if actual != expected { - t.Fatalf("expected:\n%s\n\ngot:\n%s", expected, actual) + got := strings.TrimSpace(g.String()) + want := strings.TrimSpace(testPlanGraphBuilderStr) + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong result\n%s", diff) } } @@ -92,15 +94,12 @@ func TestPlanGraphBuilder_dynamicBlock(t *testing.T) { // is that at the end test_thing.c depends on both test_thing.a and // test_thing.b. Other details might shift over time as other logic in // the graph builders changes. - actual := strings.TrimSpace(g.String()) - expected := strings.TrimSpace(` -meta.count-boundary (EachMode fixup) - test_thing.c (expand) + got := strings.TrimSpace(g.String()) + want := strings.TrimSpace(` provider["registry.terraform.io/hashicorp/test"] provider["registry.terraform.io/hashicorp/test"] (close) test_thing.c (expand) root - meta.count-boundary (EachMode fixup) provider["registry.terraform.io/hashicorp/test"] (close) test_thing.a (expand) provider["registry.terraform.io/hashicorp/test"] @@ -110,8 +109,8 @@ test_thing.c (expand) test_thing.a (expand) test_thing.b (expand) `) - if actual != expected { - t.Fatalf("expected:\n%s\n\ngot:\n%s", expected, actual) + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong result\n%s", diff) } } @@ -150,23 +149,20 @@ func TestPlanGraphBuilder_attrAsBlocks(t *testing.T) { // list-of-objects attribute. This requires some special effort // inside lang.ReferencesInBlock to make sure it searches blocks of // type "nested" along with an attribute named "nested". - actual := strings.TrimSpace(g.String()) - expected := strings.TrimSpace(` -meta.count-boundary (EachMode fixup) - test_thing.b (expand) + got := strings.TrimSpace(g.String()) + want := strings.TrimSpace(` provider["registry.terraform.io/hashicorp/test"] provider["registry.terraform.io/hashicorp/test"] (close) test_thing.b (expand) root - meta.count-boundary (EachMode fixup) provider["registry.terraform.io/hashicorp/test"] (close) test_thing.a (expand) provider["registry.terraform.io/hashicorp/test"] test_thing.b (expand) test_thing.a (expand) `) - if actual != expected { - t.Fatalf("expected:\n%s\n\ngot:\n%s", expected, actual) + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong result\n%s", diff) } } @@ -211,12 +207,12 @@ func TestPlanGraphBuilder_forEach(t *testing.T) { t.Fatalf("wrong module path %q", g.Path) } - actual := strings.TrimSpace(g.String()) + got := strings.TrimSpace(g.String()) // We're especially looking for the edge here, where aws_instance.bat // has a dependency on aws_instance.boo - expected := strings.TrimSpace(testPlanGraphBuilderForEachStr) - if actual != expected { - t.Fatalf("expected:\n%s\n\ngot:\n%s", expected, actual) + want := strings.TrimSpace(testPlanGraphBuilderForEachStr) + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong result\n%s", diff) } } @@ -230,9 +226,6 @@ aws_security_group.firewall (expand) provider["registry.terraform.io/hashicorp/aws"] local.instance_id (expand) aws_instance.web (expand) -meta.count-boundary (EachMode fixup) - aws_load_balancer.weblb (expand) - output.instance_id openstack_floating_ip.random (expand) provider["registry.terraform.io/hashicorp/openstack"] output.instance_id @@ -245,7 +238,7 @@ provider["registry.terraform.io/hashicorp/openstack"] provider["registry.terraform.io/hashicorp/openstack"] (close) openstack_floating_ip.random (expand) root - meta.count-boundary (EachMode fixup) + output.instance_id provider["registry.terraform.io/hashicorp/aws"] (close) provider["registry.terraform.io/hashicorp/openstack"] (close) var.foo @@ -263,12 +256,6 @@ aws_instance.boo (expand) provider["registry.terraform.io/hashicorp/aws"] aws_instance.foo (expand) provider["registry.terraform.io/hashicorp/aws"] -meta.count-boundary (EachMode fixup) - aws_instance.bar (expand) - aws_instance.bar2 (expand) - aws_instance.bat (expand) - aws_instance.baz (expand) - aws_instance.foo (expand) provider["registry.terraform.io/hashicorp/aws"] provider["registry.terraform.io/hashicorp/aws"] (close) aws_instance.bar (expand) @@ -277,6 +264,5 @@ provider["registry.terraform.io/hashicorp/aws"] (close) aws_instance.baz (expand) aws_instance.foo (expand) root - meta.count-boundary (EachMode fixup) provider["registry.terraform.io/hashicorp/aws"] (close) ` diff --git a/internal/terraform/node_count_boundary.go b/internal/terraform/node_count_boundary.go deleted file mode 100644 index 26968b11937d..000000000000 --- a/internal/terraform/node_count_boundary.go +++ /dev/null @@ -1,80 +0,0 @@ -package terraform - -import ( - "fmt" - "log" - - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/configs" - "github.com/hashicorp/terraform/internal/tfdiags" -) - -// NodeCountBoundary fixes up any transitions between "each modes" in objects -// saved in state, such as switching from NoEach to EachInt. -type NodeCountBoundary struct { - Config *configs.Config -} - -var _ GraphNodeExecutable = (*NodeCountBoundary)(nil) - -func (n *NodeCountBoundary) Name() string { - return "meta.count-boundary (EachMode fixup)" -} - -// GraphNodeExecutable -func (n *NodeCountBoundary) Execute(ctx EvalContext, op walkOperation) (diags tfdiags.Diagnostics) { - // We'll temporarily lock the state to grab the modules, then work on each - // one separately while taking a lock again for each separate resource. - // This means that if another caller concurrently adds a module here while - // we're working then we won't update it, but that's no worse than the - // concurrent writer blocking for our entire fixup process and _then_ - // adding a new module, and in practice the graph node associated with - // this eval depends on everything else in the graph anyway, so there - // should not be concurrent writers. - state := ctx.State().Lock() - moduleAddrs := make([]addrs.ModuleInstance, 0, len(state.Modules)) - for _, m := range state.Modules { - moduleAddrs = append(moduleAddrs, m.Addr) - } - ctx.State().Unlock() - - for _, addr := range moduleAddrs { - cfg := n.Config.DescendentForInstance(addr) - if cfg == nil { - log.Printf("[WARN] Not fixing up EachModes for %s because it has no config", addr) - continue - } - if err := n.fixModule(ctx, addr); err != nil { - diags = diags.Append(err) - return diags - } - } - return diags -} - -func (n *NodeCountBoundary) fixModule(ctx EvalContext, moduleAddr addrs.ModuleInstance) error { - ms := ctx.State().Module(moduleAddr) - cfg := n.Config.DescendentForInstance(moduleAddr) - if ms == nil { - // Theoretically possible for a concurrent writer to delete a module - // while we're running, but in practice the graph node that called us - // depends on everything else in the graph and so there can never - // be a concurrent writer. - return fmt.Errorf("[WARN] no state found for %s while trying to fix up EachModes", moduleAddr) - } - if cfg == nil { - return fmt.Errorf("[WARN] no config found for %s while trying to fix up EachModes", moduleAddr) - } - - for _, r := range ms.Resources { - rCfg := cfg.Module.ResourceByAddr(r.Addr.Resource) - if rCfg == nil { - log.Printf("[WARN] Not fixing up EachModes for %s because it has no config", r.Addr) - continue - } - hasCount := rCfg.Count != nil - fixResourceCountSetTransition(ctx, r.Addr.Config(), hasCount) - } - - return nil -} diff --git a/internal/terraform/node_count_boundary_test.go b/internal/terraform/node_count_boundary_test.go deleted file mode 100644 index 096a980ad773..000000000000 --- a/internal/terraform/node_count_boundary_test.go +++ /dev/null @@ -1,72 +0,0 @@ -package terraform - -import ( - "testing" - - "github.com/hashicorp/hcl/v2/hcltest" - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/configs" - "github.com/hashicorp/terraform/internal/states" - "github.com/zclconf/go-cty/cty" -) - -func TestNodeCountBoundaryExecute(t *testing.T) { - - // Create a state with a single instance (addrs.NoKey) of test_instance.foo - state := states.NewState() - state.Module(addrs.RootModuleInstance).SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_instance", - Name: "foo", - }.Instance(addrs.NoKey), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"type":"string","value":"hello"}`), - }, - addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider("test"), - Module: addrs.RootModule, - }, - ) - - // Create a config that uses count to create 2 instances of test_instance.foo - rc := &configs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_instance", - Name: "foo", - Count: hcltest.MockExprLiteral(cty.NumberIntVal(2)), - Config: configs.SynthBody("", map[string]cty.Value{ - "test_string": cty.StringVal("hello"), - }), - } - config := &configs.Config{ - Module: &configs.Module{ - ManagedResources: map[string]*configs.Resource{ - "test_instance.foo": rc, - }, - }, - } - - ctx := &MockEvalContext{ - StateState: state.SyncWrapper(), - } - node := NodeCountBoundary{Config: config} - - diags := node.Execute(ctx, walkApply) - if diags.HasErrors() { - t.Fatalf("unexpected error: %s", diags.Err()) - } - if !state.HasResources() { - t.Fatal("resources missing from state") - } - - // verify that the resource changed from test_instance.foo to - // test_instance.foo.0 in the state - actual := state.String() - expected := "test_instance.foo.0:\n ID = \n provider = provider[\"registry.terraform.io/hashicorp/test\"]\n type = string\n value = hello" - - if actual != expected { - t.Fatalf("wrong result: %s", actual) - } -} diff --git a/internal/terraform/node_resource_plan.go b/internal/terraform/node_resource_plan.go index 64850c3b7a0f..c732575e5650 100644 --- a/internal/terraform/node_resource_plan.go +++ b/internal/terraform/node_resource_plan.go @@ -304,10 +304,6 @@ func (n *NodePlannableResource) ModifyCreateBeforeDestroy(v bool) error { func (n *NodePlannableResource) DynamicExpand(ctx EvalContext) (*Graph, error) { var diags tfdiags.Diagnostics - // We need to potentially rename an instance address in the state - // if we're transitioning whether "count" is set at all. - fixResourceCountSetTransition(ctx, n.Addr.Config(), n.Config.Count != nil) - // Our instance expander should already have been informed about the // expansion of this resource and of all of its containing modules, so // it can tell us which instance addresses we need to process. diff --git a/internal/terraform/transform_count_boundary.go b/internal/terraform/transform_count_boundary.go deleted file mode 100644 index 9f944240edb9..000000000000 --- a/internal/terraform/transform_count_boundary.go +++ /dev/null @@ -1,33 +0,0 @@ -package terraform - -import ( - "github.com/hashicorp/terraform/internal/configs" - "github.com/hashicorp/terraform/internal/dag" -) - -// CountBoundaryTransformer adds a node that depends on everything else -// so that it runs last in order to clean up the state for nodes that -// are on the "count boundary": "foo.0" when only one exists becomes "foo" -type CountBoundaryTransformer struct { - Config *configs.Config -} - -func (t *CountBoundaryTransformer) Transform(g *Graph) error { - node := &NodeCountBoundary{ - Config: t.Config, - } - g.Add(node) - - // Depends on everything - for _, v := range g.Vertices() { - // Don't connect to ourselves - if v == node { - continue - } - - // Connect! - g.Connect(dag.BasicEdge(node, v)) - } - - return nil -} From 78705f4f109d7c1e23e09658fd44c5b7ebccd85f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 20 Sep 2021 11:29:24 -0700 Subject: [PATCH 081/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 809e5795bfc3..281c399ccaec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ NEW FEATURES: ENHANCEMENTS: * config: Terraform now checks the syntax of and normalizes module source addresses (the `source` argument in `module` blocks) during configuration decoding rather than only at module installation time. This is largely just an internal refactoring, but a visible benefit of this change is that the `terraform init` messages about module downloading will now show the canonical module package address Terraform is downloading from, after interpreting the special shorthands for common cases like GitHub URLs. ([#28854](https://github.com/hashicorp/terraform/issues/28854)) +* cli: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. [GH-29605] BUG FIXES: From 78c4a8c4617d4fa615768f27a0bd50cc3f648cfe Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 17 Sep 2021 13:18:34 -0400 Subject: [PATCH 082/644] json-output: Previous address for resource changes Configuration-driven moves are represented in the plan file by setting the resource's `PrevRunAddr` to a different value than its `Addr`. For JSON plan output, we here add a new field to resource changes, `previous_address`, which is present and non-empty only if the resource is planned to be moved. Like the CLI UI, refresh-only plans will include move-only changes in the resource drift JSON output. In normal plan mode, these are elided to avoid redundancy with planned changes. --- internal/command/jsonplan/plan.go | 25 ++- internal/command/jsonplan/resource.go | 12 ++ .../testdata/show-json/moved-drift/main.tf | 22 +++ .../show-json/moved-drift/output.json | 177 ++++++++++++++++++ .../show-json/moved-drift/terraform.tfstate | 38 ++++ .../command/testdata/show-json/moved/main.tf | 12 ++ .../testdata/show-json/moved/output.json | 89 +++++++++ .../show-json/moved/terraform.tfstate | 23 +++ .../multi-resource-update/output.json | 27 +-- website/docs/internals/json-format.html.md | 8 +- 10 files changed, 403 insertions(+), 30 deletions(-) create mode 100644 internal/command/testdata/show-json/moved-drift/main.tf create mode 100644 internal/command/testdata/show-json/moved-drift/output.json create mode 100644 internal/command/testdata/show-json/moved-drift/terraform.tfstate create mode 100644 internal/command/testdata/show-json/moved/main.tf create mode 100644 internal/command/testdata/show-json/moved/output.json create mode 100644 internal/command/testdata/show-json/moved/terraform.tfstate diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index 1d7eff1ffb37..b2bf2cceb80b 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -130,9 +130,25 @@ func Marshal( } // output.ResourceDrift - output.ResourceDrift, err = output.marshalResourceChanges(p.DriftedResources, schemas) - if err != nil { - return nil, fmt.Errorf("error in marshaling resource drift: %s", err) + if len(p.DriftedResources) > 0 { + // In refresh-only mode, we render all resources marked as drifted, + // including those which have moved without other changes. In other plan + // modes, move-only changes will be included in the planned changes, so + // we skip them here. + var driftedResources []*plans.ResourceInstanceChangeSrc + if p.UIMode == plans.RefreshOnlyMode { + driftedResources = p.DriftedResources + } else { + for _, dr := range p.DriftedResources { + if dr.Action != plans.NoOp { + driftedResources = append(driftedResources, dr) + } + } + } + output.ResourceDrift, err = output.marshalResourceChanges(driftedResources, schemas) + if err != nil { + return nil, fmt.Errorf("error in marshaling resource drift: %s", err) + } } // output.ResourceChanges @@ -197,6 +213,9 @@ func (p *plan) marshalResourceChanges(resources []*plans.ResourceInstanceChangeS var r resourceChange addr := rc.Addr r.Address = addr.String() + if !addr.Equal(rc.PrevRunAddr) { + r.PreviousAddress = rc.PrevRunAddr.String() + } dataSource := addr.Resource.Resource.Mode == addrs.DataResourceMode // We create "delete" actions for data resources so we can clean up diff --git a/internal/command/jsonplan/resource.go b/internal/command/jsonplan/resource.go index ca1299c994a7..1e737a626654 100644 --- a/internal/command/jsonplan/resource.go +++ b/internal/command/jsonplan/resource.go @@ -48,6 +48,18 @@ type resourceChange struct { // Address is the absolute resource address Address string `json:"address,omitempty"` + // PreviousAddress is the absolute address that this resource instance had + // at the conclusion of a previous run. + // + // This will typically be omitted, but will be present if the previous + // resource instance was subject to a "moved" block that we handled in the + // process of creating this plan. + // + // Note that this behavior diverges from the internal plan data structure, + // where the previous address is set equal to the current address in the + // common case, rather than being omitted. + PreviousAddress string `json:"previous_address,omitempty"` + // ModuleAddress is the module portion of the above address. Omitted if the // instance is in the root module. ModuleAddress string `json:"module_address,omitempty"` diff --git a/internal/command/testdata/show-json/moved-drift/main.tf b/internal/command/testdata/show-json/moved-drift/main.tf new file mode 100644 index 000000000000..afdf9fe668cd --- /dev/null +++ b/internal/command/testdata/show-json/moved-drift/main.tf @@ -0,0 +1,22 @@ +# In state with `ami = "foo"`, so this should be a regular update. The provider +# should not detect changes on refresh. +resource "test_instance" "no_refresh" { + ami = "bar" +} + +# In state with `ami = "refresh-me"`, but the provider will return +# `"refreshed"` after the refresh phase. The plan should show the drift +# (`"refresh-me"` to `"refreshed"`) and plan the update (`"refreshed"` to +# `"baz"`). +resource "test_instance" "should_refresh_with_move" { + ami = "baz" +} + +terraform { + experiments = [ config_driven_move ] +} + +moved { + from = test_instance.should_refresh + to = test_instance.should_refresh_with_move +} diff --git a/internal/command/testdata/show-json/moved-drift/output.json b/internal/command/testdata/show-json/moved-drift/output.json new file mode 100644 index 000000000000..0d151808fa87 --- /dev/null +++ b/internal/command/testdata/show-json/moved-drift/output.json @@ -0,0 +1,177 @@ +{ + "format_version": "0.2", + "planned_values": { + "root_module": { + "resources": [ + { + "address": "test_instance.no_refresh", + "mode": "managed", + "type": "test_instance", + "name": "no_refresh", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "bar", + "id": "placeholder" + }, + "sensitive_values": {} + }, + { + "address": "test_instance.should_refresh_with_move", + "mode": "managed", + "type": "test_instance", + "name": "should_refresh_with_move", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "baz", + "id": "placeholder" + }, + "sensitive_values": {} + } + ] + } + }, + "resource_drift": [ + { + "address": "test_instance.should_refresh_with_move", + "mode": "managed", + "type": "test_instance", + "previous_address": "test_instance.should_refresh", + "provider_name": "registry.terraform.io/hashicorp/test", + "name": "should_refresh_with_move", + "change": { + "actions": [ + "update" + ], + "before": { + "ami": "refresh-me", + "id": "placeholder" + }, + "after": { + "ami": "refreshed", + "id": "placeholder" + }, + "after_sensitive": {}, + "after_unknown": {}, + "before_sensitive": {} + } + } + ], + "resource_changes": [ + { + "address": "test_instance.no_refresh", + "mode": "managed", + "type": "test_instance", + "provider_name": "registry.terraform.io/hashicorp/test", + "name": "no_refresh", + "change": { + "actions": [ + "update" + ], + "before": { + "ami": "foo", + "id": "placeholder" + }, + "after": { + "ami": "bar", + "id": "placeholder" + }, + "after_unknown": {}, + "after_sensitive": {}, + "before_sensitive": {} + } + }, + { + "address": "test_instance.should_refresh_with_move", + "mode": "managed", + "type": "test_instance", + "previous_address": "test_instance.should_refresh", + "provider_name": "registry.terraform.io/hashicorp/test", + "name": "should_refresh_with_move", + "change": { + "actions": [ + "update" + ], + "before": { + "ami": "refreshed", + "id": "placeholder" + }, + "after": { + "ami": "baz", + "id": "placeholder" + }, + "after_unknown": {}, + "after_sensitive": {}, + "before_sensitive": {} + } + } + ], + "prior_state": { + "format_version": "0.2", + "values": { + "root_module": { + "resources": [ + { + "address": "test_instance.no_refresh", + "mode": "managed", + "type": "test_instance", + "name": "no_refresh", + "schema_version": 0, + "provider_name": "registry.terraform.io/hashicorp/test", + "values": { + "ami": "foo", + "id": "placeholder" + }, + "sensitive_values": {} + }, + { + "address": "test_instance.should_refresh_with_move", + "mode": "managed", + "type": "test_instance", + "name": "should_refresh_with_move", + "schema_version": 0, + "provider_name": "registry.terraform.io/hashicorp/test", + "values": { + "ami": "refreshed", + "id": "placeholder" + }, + "sensitive_values": {} + } + ] + } + } + }, + "configuration": { + "root_module": { + "resources": [ + { + "address": "test_instance.no_refresh", + "mode": "managed", + "type": "test_instance", + "name": "no_refresh", + "provider_config_key": "test", + "schema_version": 0, + "expressions": { + "ami": { + "constant_value": "bar" + } + } + }, + { + "address": "test_instance.should_refresh_with_move", + "mode": "managed", + "type": "test_instance", + "name": "should_refresh_with_move", + "provider_config_key": "test", + "schema_version": 0, + "expressions": { + "ami": { + "constant_value": "baz" + } + } + } + ] + } + } +} diff --git a/internal/command/testdata/show-json/moved-drift/terraform.tfstate b/internal/command/testdata/show-json/moved-drift/terraform.tfstate new file mode 100644 index 000000000000..02b8944d8994 --- /dev/null +++ b/internal/command/testdata/show-json/moved-drift/terraform.tfstate @@ -0,0 +1,38 @@ +{ + "version": 4, + "terraform_version": "0.12.0", + "serial": 7, + "lineage": "configuredUnchanged", + "resources": [ + { + "mode": "managed", + "type": "test_instance", + "name": "no_refresh", + "provider": "provider[\"registry.terraform.io/hashicorp/test\"]", + "instances": [ + { + "schema_version": 0, + "attributes": { + "ami": "foo", + "id": "placeholder" + } + } + ] + }, + { + "mode": "managed", + "type": "test_instance", + "name": "should_refresh", + "provider": "provider[\"registry.terraform.io/hashicorp/test\"]", + "instances": [ + { + "schema_version": 0, + "attributes": { + "ami": "refresh-me", + "id": "placeholder" + } + } + ] + } + ] +} diff --git a/internal/command/testdata/show-json/moved/main.tf b/internal/command/testdata/show-json/moved/main.tf new file mode 100644 index 000000000000..0be803cbc9d2 --- /dev/null +++ b/internal/command/testdata/show-json/moved/main.tf @@ -0,0 +1,12 @@ +resource "test_instance" "baz" { + ami = "baz" +} + +terraform { + experiments = [ config_driven_move ] +} + +moved { + from = test_instance.foo + to = test_instance.baz +} diff --git a/internal/command/testdata/show-json/moved/output.json b/internal/command/testdata/show-json/moved/output.json new file mode 100644 index 000000000000..3ce28198342e --- /dev/null +++ b/internal/command/testdata/show-json/moved/output.json @@ -0,0 +1,89 @@ +{ + "format_version": "0.2", + "planned_values": { + "root_module": { + "resources": [ + { + "address": "test_instance.baz", + "mode": "managed", + "type": "test_instance", + "name": "baz", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "baz", + "id": "placeholder" + }, + "sensitive_values": {} + } + ] + } + }, + "resource_changes": [ + { + "address": "test_instance.baz", + "mode": "managed", + "type": "test_instance", + "previous_address": "test_instance.foo", + "provider_name": "registry.terraform.io/hashicorp/test", + "name": "baz", + "change": { + "actions": [ + "update" + ], + "before": { + "ami": "foo", + "id": "placeholder" + }, + "after": { + "ami": "baz", + "id": "placeholder" + }, + "after_unknown": {}, + "after_sensitive": {}, + "before_sensitive": {} + } + } + ], + "prior_state": { + "format_version": "0.2", + "values": { + "root_module": { + "resources": [ + { + "address": "test_instance.baz", + "mode": "managed", + "type": "test_instance", + "name": "baz", + "schema_version": 0, + "provider_name": "registry.terraform.io/hashicorp/test", + "values": { + "ami": "foo", + "id": "placeholder" + }, + "sensitive_values": {} + } + ] + } + } + }, + "configuration": { + "root_module": { + "resources": [ + { + "address": "test_instance.baz", + "mode": "managed", + "type": "test_instance", + "name": "baz", + "provider_config_key": "test", + "schema_version": 0, + "expressions": { + "ami": { + "constant_value": "baz" + } + } + } + ] + } + } +} diff --git a/internal/command/testdata/show-json/moved/terraform.tfstate b/internal/command/testdata/show-json/moved/terraform.tfstate new file mode 100644 index 000000000000..b4e5718874d0 --- /dev/null +++ b/internal/command/testdata/show-json/moved/terraform.tfstate @@ -0,0 +1,23 @@ +{ + "version": 4, + "terraform_version": "0.12.0", + "serial": 7, + "lineage": "configuredUnchanged", + "resources": [ + { + "mode": "managed", + "type": "test_instance", + "name": "foo", + "provider": "provider[\"registry.terraform.io/hashicorp/test\"]", + "instances": [ + { + "schema_version": 0, + "attributes": { + "ami": "foo", + "id": "placeholder" + } + } + ] + } + ] +} diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index 247749261356..262b6194b9bf 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -45,32 +45,6 @@ ] } }, - "resource_drift": [ - { - "address": "test_instance.test[0]", - "mode": "managed", - "type": "test_instance", - "provider_name": "registry.terraform.io/hashicorp/test", - "name": "test", - "index": 0, - "change": { - "actions": [ - "no-op" - ], - "before": { - "ami": "bar", - "id": "placeholder" - }, - "after": { - "ami": "bar", - "id": "placeholder" - }, - "before_sensitive": {}, - "after_sensitive": {}, - "after_unknown": {} - } - } - ], "resource_changes": [ { "address": "test_instance.test[0]", @@ -78,6 +52,7 @@ "type": "test_instance", "name": "test", "index": 0, + "previous_address": "test_instance.test", "provider_name": "registry.terraform.io/hashicorp/test", "change": { "actions": [ diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index 9a3efeff5d46..ffe54c2cc8b6 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -98,9 +98,15 @@ For ease of consumption by callers, the plan representation includes a partial r { // "address" is the full absolute address of the resource instance this // change applies to, in the same format as addresses in a value - // representation + // representation. "address": "module.child.aws_instance.foo[0]", + // "previous_address" is the full absolute address of this resource + // instance as it was known after the previous Terraform run. + // Included only if the address has changed, e.g. by handling + // a "moved" block in the configuration. + "previous_address": "module.instances.aws_instance.foo[0]", + // "module_address", if set, is the module portion of the above address. // Omitted if the instance is in the root module. "module_address": "module.child", From b59b057591bfab5e1561a66a249df360756a6e60 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 17 Sep 2021 14:09:20 -0400 Subject: [PATCH 083/644] json-output: Config-driven move support in JSON UI Add previous address information to the `planned_change` and `resource_drift` messages for the streaming JSON UI output of plan and apply operations. Here we also add a "move" action value to the `change` object of these messages, to represent a move-only operation. As part of this work we also simplify this code to use the plan's DriftedResources values instead of recomputing the drift from state. --- internal/command/views/json/change.go | 15 +- internal/command/views/json_view_test.go | 6 +- internal/command/views/operation.go | 103 +----- internal/command/views/operation_test.go | 293 +++++++++++++----- .../internals/machine-readable-ui.html.md | 3 +- 5 files changed, 247 insertions(+), 173 deletions(-) diff --git a/internal/command/views/json/change.go b/internal/command/views/json/change.go index bee20904e184..c18a2c15a456 100644 --- a/internal/command/views/json/change.go +++ b/internal/command/views/json/change.go @@ -12,14 +12,22 @@ func NewResourceInstanceChange(change *plans.ResourceInstanceChangeSrc) *Resourc Action: changeAction(change.Action), Reason: changeReason(change.ActionReason), } + if !change.Addr.Equal(change.PrevRunAddr) { + if c.Action == ActionNoOp { + c.Action = ActionMove + } + pr := newResourceAddr(change.PrevRunAddr) + c.PreviousResource = &pr + } return c } type ResourceInstanceChange struct { - Resource ResourceAddr `json:"resource"` - Action ChangeAction `json:"action"` - Reason ChangeReason `json:"reason,omitempty"` + Resource ResourceAddr `json:"resource"` + PreviousResource *ResourceAddr `json:"previous_resource,omitempty"` + Action ChangeAction `json:"action"` + Reason ChangeReason `json:"reason,omitempty"` } func (c *ResourceInstanceChange) String() string { @@ -30,6 +38,7 @@ type ChangeAction string const ( ActionNoOp ChangeAction = "noop" + ActionMove ChangeAction = "move" ActionCreate ChangeAction = "create" ActionRead ChangeAction = "read" ActionUpdate ChangeAction = "update" diff --git a/internal/command/views/json_view_test.go b/internal/command/views/json_view_test.go index c755cf0b7f34..6bb5c4913241 100644 --- a/internal/command/views/json_view_test.go +++ b/internal/command/views/json_view_test.go @@ -111,7 +111,8 @@ func TestJSONView_PlannedChange(t *testing.T) { } managed := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_instance", Name: "bar"} cs := &plans.ResourceInstanceChangeSrc{ - Addr: managed.Instance(addrs.StringKey("boop")).Absolute(foo), + Addr: managed.Instance(addrs.StringKey("boop")).Absolute(foo), + PrevRunAddr: managed.Instance(addrs.StringKey("boop")).Absolute(foo), ChangeSrc: plans.ChangeSrc{ Action: plans.Create, }, @@ -151,7 +152,8 @@ func TestJSONView_ResourceDrift(t *testing.T) { } managed := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_instance", Name: "bar"} cs := &plans.ResourceInstanceChangeSrc{ - Addr: managed.Instance(addrs.StringKey("boop")).Absolute(foo), + Addr: managed.Instance(addrs.StringKey("boop")).Absolute(foo), + PrevRunAddr: managed.Instance(addrs.StringKey("boop")).Absolute(foo), ChangeSrc: plans.ChangeSrc{ Action: plans.Update, }, diff --git a/internal/command/views/operation.go b/internal/command/views/operation.go index b38e93b6f556..01daedc39b3f 100644 --- a/internal/command/views/operation.go +++ b/internal/command/views/operation.go @@ -3,7 +3,6 @@ package views import ( "bytes" "fmt" - "sort" "strings" "github.com/hashicorp/terraform/internal/addrs" @@ -11,11 +10,9 @@ import ( "github.com/hashicorp/terraform/internal/command/format" "github.com/hashicorp/terraform/internal/command/views/json" "github.com/hashicorp/terraform/internal/plans" - "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/statefile" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" - "github.com/zclconf/go-cty/cty" ) type Operation interface { @@ -163,10 +160,14 @@ func (v *OperationJSON) EmergencyDumpState(stateFile *statefile.File) error { // Log a change summary and a series of "planned" messages for the changes in // the plan. func (v *OperationJSON) Plan(plan *plans.Plan, schemas *terraform.Schemas) { - if err := v.resourceDrift(plan.PrevRunState, plan.PriorState, schemas); err != nil { - var diags tfdiags.Diagnostics - diags = diags.Append(err) - v.Diagnostics(diags) + for _, dr := range plan.DriftedResources { + // In refresh-only mode, we output all resources marked as drifted, + // including those which have moved without other changes. In other plan + // modes, move-only changes will be included in the planned changes, so + // we skip them here. + if dr.Action != plans.NoOp || plan.UIMode == plans.RefreshOnlyMode { + v.view.ResourceDrift(json.NewResourceInstanceChange(dr)) + } } cs := &json.ChangeSummary{ @@ -189,7 +190,7 @@ func (v *OperationJSON) Plan(plan *plans.Plan, schemas *terraform.Schemas) { cs.Remove++ } - if change.Action != plans.NoOp { + if change.Action != plans.NoOp || !change.Addr.Equal(change.PrevRunAddr) { v.view.PlannedChange(json.NewResourceInstanceChange(change)) } } @@ -208,92 +209,6 @@ func (v *OperationJSON) Plan(plan *plans.Plan, schemas *terraform.Schemas) { } } -func (v *OperationJSON) resourceDrift(oldState, newState *states.State, schemas *terraform.Schemas) error { - if newState.ManagedResourcesEqual(oldState) { - // Nothing to do, because we only detect and report drift for managed - // resource instances. - return nil - } - var changes []*json.ResourceInstanceChange - for _, ms := range oldState.Modules { - for _, rs := range ms.Resources { - if rs.Addr.Resource.Mode != addrs.ManagedResourceMode { - // Drift reporting is only for managed resources - continue - } - - provider := rs.ProviderConfig.Provider - for key, oldIS := range rs.Instances { - if oldIS.Current == nil { - // Not interested in instances that only have deposed objects - continue - } - addr := rs.Addr.Instance(key) - newIS := newState.ResourceInstance(addr) - - schema, _ := schemas.ResourceTypeConfig( - provider, - addr.Resource.Resource.Mode, - addr.Resource.Resource.Type, - ) - if schema == nil { - return fmt.Errorf("no schema found for %s (in provider %s)", addr, provider) - } - ty := schema.ImpliedType() - - oldObj, err := oldIS.Current.Decode(ty) - if err != nil { - return fmt.Errorf("failed to decode previous run data for %s: %s", addr, err) - } - - var newObj *states.ResourceInstanceObject - if newIS != nil && newIS.Current != nil { - newObj, err = newIS.Current.Decode(ty) - if err != nil { - return fmt.Errorf("failed to decode refreshed data for %s: %s", addr, err) - } - } - - var oldVal, newVal cty.Value - oldVal = oldObj.Value - if newObj != nil { - newVal = newObj.Value - } else { - newVal = cty.NullVal(ty) - } - - if oldVal.RawEquals(newVal) { - // No drift if the two values are semantically equivalent - continue - } - - // We can only detect updates and deletes as drift. - action := plans.Update - if newVal.IsNull() { - action = plans.Delete - } - - change := &plans.ResourceInstanceChangeSrc{ - Addr: addr, - ChangeSrc: plans.ChangeSrc{ - Action: action, - }, - } - changes = append(changes, json.NewResourceInstanceChange(change)) - } - } - } - - // Sort the change structs lexically by address to give stable output - sort.Slice(changes, func(i, j int) bool { return changes[i].Resource.Addr < changes[j].Resource.Addr }) - - for _, change := range changes { - v.view.ResourceDrift(change) - } - - return nil -} - func (v *OperationJSON) PlannedChange(change *plans.ResourceInstanceChangeSrc) { if change.Action == plans.Delete && change.Addr.Resource.Resource.Mode == addrs.DataResourceMode { // Avoid rendering data sources on deletion diff --git a/internal/command/views/operation_test.go b/internal/command/views/operation_test.go index 56ced35779a2..aa86fe1445ac 100644 --- a/internal/command/views/operation_test.go +++ b/internal/command/views/operation_test.go @@ -479,29 +479,35 @@ func TestOperationJSON_plan(t *testing.T) { Changes: &plans.Changes{ Resources: []*plans.ResourceInstanceChangeSrc{ { - Addr: boop.Instance(addrs.IntKey(0)).Absolute(root), - ChangeSrc: plans.ChangeSrc{Action: plans.CreateThenDelete}, + Addr: boop.Instance(addrs.IntKey(0)).Absolute(root), + PrevRunAddr: boop.Instance(addrs.IntKey(0)).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.CreateThenDelete}, }, { - Addr: boop.Instance(addrs.IntKey(1)).Absolute(root), - ChangeSrc: plans.ChangeSrc{Action: plans.Create}, + Addr: boop.Instance(addrs.IntKey(1)).Absolute(root), + PrevRunAddr: boop.Instance(addrs.IntKey(1)).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Create}, }, { - Addr: boop.Instance(addrs.IntKey(0)).Absolute(vpc), - ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, + Addr: boop.Instance(addrs.IntKey(0)).Absolute(vpc), + PrevRunAddr: boop.Instance(addrs.IntKey(0)).Absolute(vpc), + ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, }, { - Addr: beep.Instance(addrs.NoKey).Absolute(root), - ChangeSrc: plans.ChangeSrc{Action: plans.DeleteThenCreate}, + Addr: beep.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: beep.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.DeleteThenCreate}, }, { - Addr: beep.Instance(addrs.NoKey).Absolute(vpc), - ChangeSrc: plans.ChangeSrc{Action: plans.Update}, + Addr: beep.Instance(addrs.NoKey).Absolute(vpc), + PrevRunAddr: beep.Instance(addrs.NoKey).Absolute(vpc), + ChangeSrc: plans.ChangeSrc{Action: plans.Update}, }, // Data source deletion should not show up in the logs { - Addr: derp.Instance(addrs.NoKey).Absolute(root), - ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, + Addr: derp.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: derp.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, }, }, }, @@ -623,74 +629,175 @@ func TestOperationJSON_plan(t *testing.T) { testJSONViewOutputEquals(t, done(t).Stdout(), want) } -func TestOperationJSON_planDrift(t *testing.T) { +func TestOperationJSON_planDriftWithMove(t *testing.T) { streams, done := terminal.StreamsForTesting(t) v := &OperationJSON{view: NewJSONView(NewView(streams))} root := addrs.RootModuleInstance boop := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "boop"} beep := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "beep"} - derp := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "derp"} + blep := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "blep"} + honk := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "honk"} plan := &plans.Plan{ + UIMode: plans.NormalMode, + Changes: &plans.Changes{ + Resources: []*plans.ResourceInstanceChangeSrc{ + { + Addr: honk.Instance(addrs.StringKey("bonk")).Absolute(root), + PrevRunAddr: honk.Instance(addrs.IntKey(0)).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.NoOp}, + }, + }, + }, + DriftedResources: []*plans.ResourceInstanceChangeSrc{ + { + Addr: beep.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: beep.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, + }, + { + Addr: boop.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: blep.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Update}, + }, + // Move-only resource drift should not be present in normal mode plans + { + Addr: honk.Instance(addrs.StringKey("bonk")).Absolute(root), + PrevRunAddr: honk.Instance(addrs.IntKey(0)).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.NoOp}, + }, + }, + } + v.Plan(plan, testSchemas()) + + want := []map[string]interface{}{ + // Drift detected: delete + { + "@level": "info", + "@message": "test_resource.beep: Drift detected (delete)", + "@module": "terraform.ui", + "type": "resource_drift", + "change": map[string]interface{}{ + "action": "delete", + "resource": map[string]interface{}{ + "addr": "test_resource.beep", + "implied_provider": "test", + "module": "", + "resource": "test_resource.beep", + "resource_key": nil, + "resource_name": "beep", + "resource_type": "test_resource", + }, + }, + }, + // Drift detected: update with move + { + "@level": "info", + "@message": "test_resource.boop: Drift detected (update)", + "@module": "terraform.ui", + "type": "resource_drift", + "change": map[string]interface{}{ + "action": "update", + "resource": map[string]interface{}{ + "addr": "test_resource.boop", + "implied_provider": "test", + "module": "", + "resource": "test_resource.boop", + "resource_key": nil, + "resource_name": "boop", + "resource_type": "test_resource", + }, + "previous_resource": map[string]interface{}{ + "addr": "test_resource.blep", + "implied_provider": "test", + "module": "", + "resource": "test_resource.blep", + "resource_key": nil, + "resource_name": "blep", + "resource_type": "test_resource", + }, + }, + }, + // Move-only change + { + "@level": "info", + "@message": `test_resource.honk["bonk"]: Plan to move`, + "@module": "terraform.ui", + "type": "planned_change", + "change": map[string]interface{}{ + "action": "move", + "resource": map[string]interface{}{ + "addr": `test_resource.honk["bonk"]`, + "implied_provider": "test", + "module": "", + "resource": `test_resource.honk["bonk"]`, + "resource_key": "bonk", + "resource_name": "honk", + "resource_type": "test_resource", + }, + "previous_resource": map[string]interface{}{ + "addr": `test_resource.honk[0]`, + "implied_provider": "test", + "module": "", + "resource": `test_resource.honk[0]`, + "resource_key": float64(0), + "resource_name": "honk", + "resource_type": "test_resource", + }, + }, + }, + // No changes + { + "@level": "info", + "@message": "Plan: 0 to add, 0 to change, 0 to destroy.", + "@module": "terraform.ui", + "type": "change_summary", + "changes": map[string]interface{}{ + "operation": "plan", + "add": float64(0), + "change": float64(0), + "remove": float64(0), + }, + }, + } + + testJSONViewOutputEquals(t, done(t).Stdout(), want) +} + +func TestOperationJSON_planDriftWithMoveRefreshOnly(t *testing.T) { + streams, done := terminal.StreamsForTesting(t) + v := &OperationJSON{view: NewJSONView(NewView(streams))} + + root := addrs.RootModuleInstance + boop := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "boop"} + beep := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "beep"} + blep := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "blep"} + honk := addrs.Resource{Mode: addrs.ManagedResourceMode, Type: "test_resource", Name: "honk"} + + plan := &plans.Plan{ + UIMode: plans.RefreshOnlyMode, Changes: &plans.Changes{ Resources: []*plans.ResourceInstanceChangeSrc{}, }, - PrevRunState: states.BuildState(func(state *states.SyncState) { - // Update - state.SetResourceInstanceCurrent( - boop.Instance(addrs.NoKey).Absolute(root), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"bar"}`), - }, - root.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - // Delete - state.SetResourceInstanceCurrent( - beep.Instance(addrs.NoKey).Absolute(root), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"boop"}`), - }, - root.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - // No-op - state.SetResourceInstanceCurrent( - derp.Instance(addrs.NoKey).Absolute(root), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"boop"}`), - }, - root.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), - PriorState: states.BuildState(func(state *states.SyncState) { - // Update - state.SetResourceInstanceCurrent( - boop.Instance(addrs.NoKey).Absolute(root), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"baz"}`), - }, - root.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - // Delete - state.SetResourceInstanceCurrent( - beep.Instance(addrs.NoKey).Absolute(root), - nil, - root.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - // No-op - state.SetResourceInstanceCurrent( - derp.Instance(addrs.NoKey).Absolute(root), - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{"foo":"boop"}`), - }, - root.ProviderConfigDefault(addrs.NewDefaultProvider("test")), - ) - }), + DriftedResources: []*plans.ResourceInstanceChangeSrc{ + { + Addr: beep.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: beep.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, + }, + { + Addr: boop.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: blep.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Update}, + }, + // Move-only resource drift should be present in refresh-only plans + { + Addr: honk.Instance(addrs.StringKey("bonk")).Absolute(root), + PrevRunAddr: honk.Instance(addrs.IntKey(0)).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.NoOp}, + }, + }, } v.Plan(plan, testSchemas()) @@ -731,6 +838,43 @@ func TestOperationJSON_planDrift(t *testing.T) { "resource_name": "boop", "resource_type": "test_resource", }, + "previous_resource": map[string]interface{}{ + "addr": "test_resource.blep", + "implied_provider": "test", + "module": "", + "resource": "test_resource.blep", + "resource_key": nil, + "resource_name": "blep", + "resource_type": "test_resource", + }, + }, + }, + // Drift detected: Move-only change + { + "@level": "info", + "@message": `test_resource.honk["bonk"]: Drift detected (move)`, + "@module": "terraform.ui", + "type": "resource_drift", + "change": map[string]interface{}{ + "action": "move", + "resource": map[string]interface{}{ + "addr": `test_resource.honk["bonk"]`, + "implied_provider": "test", + "module": "", + "resource": `test_resource.honk["bonk"]`, + "resource_key": "bonk", + "resource_name": "honk", + "resource_type": "test_resource", + }, + "previous_resource": map[string]interface{}{ + "addr": `test_resource.honk[0]`, + "implied_provider": "test", + "module": "", + "resource": `test_resource.honk[0]`, + "resource_key": float64(0), + "resource_name": "honk", + "resource_type": "test_resource", + }, }, }, // No changes @@ -846,20 +990,23 @@ func TestOperationJSON_plannedChange(t *testing.T) { // Replace requested by user v.PlannedChange(&plans.ResourceInstanceChangeSrc{ Addr: boop.Instance(addrs.IntKey(0)).Absolute(root), + PrevRunAddr: boop.Instance(addrs.IntKey(0)).Absolute(root), ChangeSrc: plans.ChangeSrc{Action: plans.DeleteThenCreate}, ActionReason: plans.ResourceInstanceReplaceByRequest, }) // Simple create v.PlannedChange(&plans.ResourceInstanceChangeSrc{ - Addr: boop.Instance(addrs.IntKey(1)).Absolute(root), - ChangeSrc: plans.ChangeSrc{Action: plans.Create}, + Addr: boop.Instance(addrs.IntKey(1)).Absolute(root), + PrevRunAddr: boop.Instance(addrs.IntKey(1)).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Create}, }) // Data source deletion v.PlannedChange(&plans.ResourceInstanceChangeSrc{ - Addr: derp.Instance(addrs.NoKey).Absolute(root), - ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, + Addr: derp.Instance(addrs.NoKey).Absolute(root), + PrevRunAddr: derp.Instance(addrs.NoKey).Absolute(root), + ChangeSrc: plans.ChangeSrc{Action: plans.Delete}, }) // Expect only two messages, as the data source deletion should be a no-op diff --git a/website/docs/internals/machine-readable-ui.html.md b/website/docs/internals/machine-readable-ui.html.md index 250481eb7306..53b3e47e0946 100644 --- a/website/docs/internals/machine-readable-ui.html.md +++ b/website/docs/internals/machine-readable-ui.html.md @@ -124,7 +124,8 @@ This message does not include details about the exact changes which caused the c At the end of a plan or before an apply, Terraform will emit a `planned_change` message for each resource which has changes to apply. This message has an embedded `change` object with the following keys: - `resource`: object describing the address of the resource to be changed; see [resource object](#resource-object) below for details -- `action`: the action planned to be taken for the resource. Values: `noop`, `create`, `read`, `update`, `replace`, `delete`. +- `previous_resource`: object describing the previous address of the resource, if this change includes a configuration-driven move +- `action`: the action planned to be taken for the resource. Values: `noop`, `create`, `read`, `update`, `replace`, `delete`, `move`. - `reason`: an optional reason for the change, currently only used when the action is `replace`. Values: - `tainted`: resource was marked as tainted - `requested`: user requested that the resource be replaced, for example via the `-replace` plan flag From 4fe75bead33dc03346bc8eeb20c878f0936c536c Mon Sep 17 00:00:00 2001 From: Paddy Date: Tue, 21 Sep 2021 05:45:04 -0700 Subject: [PATCH 084/644] Remove panic debugging information (#29512) It was out of date. Fixes #1113. --- website/docs/internals/debugging.html.md | 60 ------------------------ 1 file changed, 60 deletions(-) diff --git a/website/docs/internals/debugging.html.md b/website/docs/internals/debugging.html.md index 5262c62b1aa8..885065ee4e77 100644 --- a/website/docs/internals/debugging.html.md +++ b/website/docs/internals/debugging.html.md @@ -26,63 +26,3 @@ the same level arguments as `TF_LOG`, but only activate a subset of the logs. To persist logged output you can set `TF_LOG_PATH` in order to force the log to always be appended to a specific file when logging is enabled. Note that even when `TF_LOG_PATH` is set, `TF_LOG` must be set in order for any logging to be enabled. If you find a bug with Terraform, please include the detailed log by using a service such as gist. - -## Interpreting a Crash Log - -If Terraform ever crashes (a "panic" in the Go runtime), it saves a log file -with the debug logs from the session as well as the panic message and backtrace -to `crash.log`. Generally speaking, this log file is meant to be passed along -to the developers via a GitHub Issue. As a user, you're not required to dig -into this file. - -However, if you are interested in figuring out what might have gone wrong -before filing an issue, here are the basic details of how to read a crash -log. - -The most interesting part of a crash log is the panic message itself and the -backtrace immediately following. So the first thing to do is to search the file -for `panic: `, which should jump you right to this message. It will look -something like this: - -```text -panic: runtime error: invalid memory address or nil pointer dereference - -goroutine 123 [running]: -panic(0xabc100, 0xd93000a0a0) - /opt/go/src/runtime/panic.go:464 +0x3e6 -github.com/hashicorp/terraform/builtin/providers/aws.resourceAwsSomeResourceCreate(...) - /opt/gopath/src/github.com/hashicorp/terraform/builtin/providers/aws/resource_aws_some_resource.go:123 +0x123 -github.com/hashicorp/terraform/helper/schema.(*Resource).Refresh(...) - /opt/gopath/src/github.com/hashicorp/terraform/helper/schema/resource.go:209 +0x123 -github.com/hashicorp/terraform/helper/schema.(*Provider).Refresh(...) - /opt/gopath/src/github.com/hashicorp/terraform/helper/schema/provider.go:187 +0x123 -github.com/hashicorp/terraform/rpc.(*ResourceProviderServer).Refresh(...) - /opt/gopath/src/github.com/hashicorp/terraform/rpc/resource_provider.go:345 +0x6a -reflect.Value.call(...) - /opt/go/src/reflect/value.go:435 +0x120d -reflect.Value.Call(...) - /opt/go/src/reflect/value.go:303 +0xb1 -net/rpc.(*service).call(...) - /opt/go/src/net/rpc/server.go:383 +0x1c2 -created by net/rpc.(*Server).ServeCodec - /opt/go/src/net/rpc/server.go:477 +0x49d -``` - -The key part of this message is the first two lines that involve `hashicorp/terraform`. In this example: - -```text -github.com/hashicorp/terraform/builtin/providers/aws.resourceAwsSomeResourceCreate(...) - /opt/gopath/src/github.com/hashicorp/terraform/builtin/providers/aws/resource_aws_some_resource.go:123 +0x123 -``` - -The first line tells us that the method that failed is -`resourceAwsSomeResourceCreate`, which we can deduce that involves the creation -of a (fictional) `aws_some_resource`. - -The second line points to the exact line of code that caused the panic, -which--combined with the panic message itself--is normally enough for a -developer to quickly figure out the cause of the issue. - -As a user, this information can help work around the problem in a pinch, since -it should hopefully point to the area of the code base in which the crash is -happening. From 8684a85e26bbaa9b17e3ed7c043c92443554fa6b Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 21 Sep 2021 22:00:32 -0500 Subject: [PATCH 085/644] command: Ensure all answers were used in command.testInputResponseMap Remove answers from testInputResponse as they are given, and raise an error during cleanup if any answers remain unused. This enables tests to ensure that the expected mock answers are actually used in a test; previously, an entire branch of code including an input sequence could be omitted and the test(s) would not fail. The only test that had unused answers in this map is one leftover from legacy state migrations, a prompt that was removed in 7c93b2e5e637bdee37c5e505d13121d9bfee223d --- internal/command/command_test.go | 4 ++++ internal/command/init_test.go | 5 ----- internal/command/ui_input.go | 1 + 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/internal/command/command_test.go b/internal/command/command_test.go index 70da240e86ff..d1a43cf659ca 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -716,6 +716,10 @@ func testInputMap(t *testing.T, answers map[string]string) func() { // Return the cleanup return func() { + if len(testInputResponseMap) > 0 { + t.Fatalf("expected no unused answers provided to command.testInputMap, got: %v", testInputResponseMap) + } + test = true testInputResponseMap = nil } diff --git a/internal/command/init_test.go b/internal/command/init_test.go index a0a5e0b5123b..b75da1f4f899 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -540,11 +540,6 @@ func TestInit_backendConfigFileChange(t *testing.T) { defer os.RemoveAll(td) defer testChdir(t, td)() - // Ask input - defer testInputMap(t, map[string]string{ - "backend-migrate-to-new": "no", - })() - ui := new(cli.MockUi) view, _ := testView(t) c := &InitCommand{ diff --git a/internal/command/ui_input.go b/internal/command/ui_input.go index 930bbd84202a..071982dec283 100644 --- a/internal/command/ui_input.go +++ b/internal/command/ui_input.go @@ -90,6 +90,7 @@ func (i *UIInput) Input(ctx context.Context, opts *terraform.InputOpts) (string, return "", fmt.Errorf("unexpected input request in test: %s", opts.Id) } + delete(testInputResponseMap, opts.Id) return v, nil } From d054102d38c54be67edccdd8f191e1beecd68252 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 21 Sep 2021 11:00:52 -0700 Subject: [PATCH 086/644] addrs: AbsResource.UniqueKey distinct from AbsResourceInstance.UniqueKey The whole point of UniqueKey is to deal with the fact that we have some distinct address types which have an identical string representation, but unfortunately that fact caused us to not notice that we'd incorrectly made AbsResource.UniqueKey return a no-key instance UniqueKey instead of its own distinct unique key type. --- internal/addrs/resource.go | 6 ++- internal/addrs/resource_test.go | 71 +++++++++++++++++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) diff --git a/internal/addrs/resource.go b/internal/addrs/resource.go index 2c69d2f70517..0ebf89d999ec 100644 --- a/internal/addrs/resource.go +++ b/internal/addrs/resource.go @@ -194,8 +194,12 @@ func (r AbsResource) absMoveableSigil() { // AbsResource is moveable } +type absResourceKey string + +func (r absResourceKey) uniqueKeySigil() {} + func (r AbsResource) UniqueKey() UniqueKey { - return absResourceInstanceKey(r.String()) + return absResourceKey(r.String()) } // AbsResourceInstance is an absolute address for a resource instance under a diff --git a/internal/addrs/resource_test.go b/internal/addrs/resource_test.go index fbaa981f4de1..d68d2b5d4a27 100644 --- a/internal/addrs/resource_test.go +++ b/internal/addrs/resource_test.go @@ -215,6 +215,77 @@ func TestAbsResourceInstanceEqual_false(t *testing.T) { } } +func TestAbsResourceUniqueKey(t *testing.T) { + resourceAddr1 := Resource{ + Mode: ManagedResourceMode, + Type: "a", + Name: "b1", + }.Absolute(RootModuleInstance) + resourceAddr2 := Resource{ + Mode: ManagedResourceMode, + Type: "a", + Name: "b2", + }.Absolute(RootModuleInstance) + resourceAddr3 := Resource{ + Mode: ManagedResourceMode, + Type: "a", + Name: "in_module", + }.Absolute(RootModuleInstance.Child("boop", NoKey)) + + tests := []struct { + Reciever AbsResource + Other UniqueKeyer + WantEqual bool + }{ + { + resourceAddr1, + resourceAddr1, + true, + }, + { + resourceAddr1, + resourceAddr2, + false, + }, + { + resourceAddr1, + resourceAddr3, + false, + }, + { + resourceAddr3, + resourceAddr3, + true, + }, + { + resourceAddr1, + resourceAddr1.Instance(NoKey), + false, // no-key instance key is distinct from its resource even though they have the same String result + }, + { + resourceAddr1, + resourceAddr1.Instance(IntKey(1)), + false, + }, + } + + for _, test := range tests { + t.Run(fmt.Sprintf("%s matches %T %s?", test.Reciever, test.Other, test.Other), func(t *testing.T) { + rKey := test.Reciever.UniqueKey() + oKey := test.Other.UniqueKey() + + gotEqual := rKey == oKey + if gotEqual != test.WantEqual { + t.Errorf( + "wrong result\nreceiver: %s\nother: %s (%T)\ngot: %t\nwant: %t", + test.Reciever, test.Other, test.Other, + gotEqual, test.WantEqual, + ) + } + }) + } +} + func TestConfigResourceEqual_true(t *testing.T) { resources := []ConfigResource{ { From 83f03766739394cafd5983ebc0d5fb46b2a20133 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 21 Sep 2021 12:57:12 -0700 Subject: [PATCH 087/644] refactoring: ApplyMoves new return type When we originally stubbed ApplyMoves we didn't know yet how exactly we'd be using the result, so we made it a double-indexed map allowing looking up moves in both directions. However, in practice we only actually need to look up old addresses by new addresses, and so this commit first removes the double indexing so that each move is only represented by one element in the map. We also need to describe situations where a move was blocked, because in a future commit we'll generate some warnings in those cases. Therefore ApplyMoves now returns a MoveResults object which contains both a map of changes and a map of blocks. The map of blocks isn't used yet as of this commit, but we'll use it in a later commit to produce warnings within the "terraform" package. --- internal/refactoring/move_execute.go | 143 ++++++--- internal/refactoring/move_execute_test.go | 288 ++++++++++++------ internal/refactoring/move_validate_test.go | 23 -- internal/terraform/context_plan.go | 12 +- internal/terraform/context_walk.go | 3 +- internal/terraform/eval_context.go | 2 +- internal/terraform/eval_context_builtin.go | 4 +- internal/terraform/eval_context_mock.go | 4 +- internal/terraform/graph_walk_context.go | 12 +- .../node_resource_abstract_instance.go | 10 +- 10 files changed, 321 insertions(+), 180 deletions(-) diff --git a/internal/refactoring/move_execute.go b/internal/refactoring/move_execute.go index 66c0d6c0a0ea..322569803a23 100644 --- a/internal/refactoring/move_execute.go +++ b/internal/refactoring/move_execute.go @@ -10,10 +10,6 @@ import ( "github.com/hashicorp/terraform/internal/states" ) -type MoveResult struct { - From, To addrs.AbsResourceInstance -} - // ApplyMoves modifies in-place the given state object so that any existing // objects that are matched by a "from" argument of one of the move statements // will be moved to instead appear at the "to" argument of that statement. @@ -29,8 +25,11 @@ type MoveResult struct { // // ApplyMoves expects exclusive access to the given state while it's running. // Don't read or write any part of the state structure until ApplyMoves returns. -func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey]MoveResult { - results := make(map[addrs.UniqueKey]MoveResult) +func ApplyMoves(stmts []MoveStatement, state *states.State) MoveResults { + ret := MoveResults{ + Changes: make(map[addrs.UniqueKey]MoveSuccess), + Blocked: make(map[addrs.UniqueKey]MoveBlocked), + } // The methodology here is to construct a small graph of all of the move // statements where the edges represent where a particular statement @@ -44,7 +43,7 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] // at all. The separate validation step should detect this and return // an error. if len(g.Cycles()) != 0 { - return results + return ret } // The starting nodes are the ones that don't depend on any other nodes. @@ -57,11 +56,33 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] if startNodes.Len() == 0 { log.Println("[TRACE] refactoring.ApplyMoves: No 'moved' statements to consider in this configuration") - return results + return ret } log.Printf("[TRACE] refactoring.ApplyMoves: Processing 'moved' statements in the configuration\n%s", logging.Indent(g.String())) + recordOldAddr := func(oldAddr, newAddr addrs.AbsResourceInstance) { + oldAddrKey := oldAddr.UniqueKey() + newAddrKey := newAddr.UniqueKey() + if prevMove, exists := ret.Changes[oldAddrKey]; exists { + // If the old address was _already_ the result of a move then + // we'll replace that entry so that our results summarize a chain + // of moves into a single entry. + delete(ret.Changes, oldAddrKey) + oldAddr = prevMove.From + } + ret.Changes[newAddrKey] = MoveSuccess{ + From: oldAddr, + To: newAddr, + } + } + recordBlockage := func(newAddr, wantedAddr addrs.AbsMoveable) { + ret.Blocked[newAddr.UniqueKey()] = MoveBlocked{ + Wanted: wantedAddr, + Actual: newAddr, + } + } + g.ReverseDepthFirstWalk(startNodes, func(v dag.Vertex, depth int) error { stmt := v.(*MoveStatement) @@ -83,11 +104,9 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] // If we already have a module at the new address then // we'll skip this move and let the existing object take // priority. - // TODO: This should probably generate a user-visible - // warning, but we'd need to rethink the signature of this - // function to achieve that. if ms := state.Module(newAddr); ms != nil { log.Printf("[WARN] Skipped moving %s to %s, because there's already another module instance at the destination", modAddr, newAddr) + recordBlockage(modAddr, newAddr) continue } @@ -98,12 +117,7 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] for key := range rs.Instances { oldInst := relAddr.Instance(key).Absolute(modAddr) newInst := relAddr.Instance(key).Absolute(newAddr) - result := MoveResult{ - From: oldInst, - To: newInst, - } - results[oldInst.UniqueKey()] = result - results[newInst.UniqueKey()] = result + recordOldAddr(oldInst, newInst) } } @@ -121,23 +135,16 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] // If we already have a resource at the new address then // we'll skip this move and let the existing object take // priority. - // TODO: This should probably generate a user-visible - // warning, but we'd need to rethink the signature of this - // function to achieve that. if rs := state.Resource(newAddr); rs != nil { log.Printf("[WARN] Skipped moving %s to %s, because there's already another resource at the destination", rAddr, newAddr) + recordBlockage(rAddr, newAddr) continue } for key := range rs.Instances { oldInst := rAddr.Instance(key) newInst := newAddr.Instance(key) - result := MoveResult{ - From: oldInst, - To: newInst, - } - results[oldInst.UniqueKey()] = result - results[newInst.UniqueKey()] = result + recordOldAddr(oldInst, newInst) } state.MoveAbsResource(rAddr, newAddr) continue @@ -150,17 +157,13 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] // If we already have a resource instance at the new // address then we'll skip this move and let the existing // object take priority. - // TODO: This should probably generate a user-visible - // warning, but we'd need to rethink the signature of this - // function to achieve that. if is := state.ResourceInstance(newAddr); is != nil { log.Printf("[WARN] Skipped moving %s to %s, because there's already another resource instance at the destination", iAddr, newAddr) + recordBlockage(iAddr, newAddr) continue } - result := MoveResult{From: iAddr, To: newAddr} - results[iAddr.UniqueKey()] = result - results[newAddr.UniqueKey()] = result + recordOldAddr(iAddr, newAddr) state.MoveAbsResourceInstance(iAddr, newAddr) continue @@ -175,17 +178,7 @@ func ApplyMoves(stmts []MoveStatement, state *states.State) map[addrs.UniqueKey] return nil }) - // FIXME: In the case of either chained or nested moves, "results" will - // be left in a pretty interesting shape where the "old" address will - // refer to a result that describes only the first step, while the "new" - // address will refer to a result that describes only the last step. - // To make that actually useful we'll need a different strategy where - // the result describes the _effective_ source and destination, skipping - // over any intermediate steps we took to get there, so that ultimately - // we'll have enough information to annotate items in the plan with the - // addresses the originally moved from. - - return results + return ret } // buildMoveStatementGraph constructs a dependency graph of the given move @@ -218,3 +211,67 @@ func buildMoveStatementGraph(stmts []MoveStatement) *dag.AcyclicGraph { return g } + +// MoveResults describes the outcome of an ApplyMoves call. +type MoveResults struct { + // Changes is a map from the unique keys of the final new resource + // instance addresses to an object describing what changed. + // + // This includes one entry for each resource instance address that was + // the destination of a move statement. It doesn't include resource + // instances that were not affected by moves at all, but it does include + // resource instance addresses that were "blocked" (also recorded in + // BlockedAddrs) if and only if they were able to move at least + // partially along a chain before being blocked. + // + // In the return value from ApplyMoves, all of the keys are guaranteed to + // be unique keys derived from addrs.AbsResourceInstance values. + Changes map[addrs.UniqueKey]MoveSuccess + + // Blocked is a map from the unique keys of the final new + // resource instances addresses to information about where they "wanted" + // to move, but were blocked by a pre-existing object at the same address. + // + // "Blocking" can arise in unusual situations where multiple points along + // a move chain were already bound to objects, and thus only one of them + // can actually adopt the final position in the chain. It can also + // occur in other similar situations, such as if a configuration contains + // a move of an entire module and a move of an individual resource into + // that module, such that the individual resource would collide with a + // resource in the whole module that was moved. + // + // In the return value from ApplyMoves, all of the keys are guaranteed to + // be unique keys derived from values of addrs.AbsMoveable types. + Blocked map[addrs.UniqueKey]MoveBlocked +} + +type MoveSuccess struct { + From addrs.AbsResourceInstance + To addrs.AbsResourceInstance +} + +type MoveBlocked struct { + Wanted addrs.AbsMoveable + Actual addrs.AbsMoveable +} + +// AddrMoved returns true if and only if the given resource instance moved to +// a new address in the ApplyMoves call that the receiver is describing. +// +// If AddrMoved returns true, you can pass the same address to method OldAddr +// to find its original address prior to moving. +func (rs MoveResults) AddrMoved(newAddr addrs.AbsResourceInstance) bool { + _, ok := rs.Changes[newAddr.UniqueKey()] + return ok +} + +// OldAddr returns the old address of the given resource instance address, or +// just returns back the same address if the given instance wasn't affected by +// any move statements. +func (rs MoveResults) OldAddr(newAddr addrs.AbsResourceInstance) addrs.AbsResourceInstance { + change, ok := rs.Changes[newAddr.UniqueKey()] + if !ok { + return newAddr + } + return change.From +} diff --git a/internal/refactoring/move_execute_test.go b/internal/refactoring/move_execute_test.go index f3ab1ec1e31f..e913df9f4723 100644 --- a/internal/refactoring/move_execute_test.go +++ b/internal/refactoring/move_execute_test.go @@ -115,13 +115,16 @@ func TestApplyMoves(t *testing.T) { }.Instance(addrs.IntKey(0)).Absolute(moduleBarKey), } - emptyResults := map[addrs.UniqueKey]MoveResult{} + emptyResults := MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{}, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, + } tests := map[string]struct { Stmts []MoveStatement State *states.State - WantResults map[addrs.UniqueKey]MoveResult + WantResults MoveResults WantInstanceAddrs []string }{ "no moves and empty state": { @@ -161,15 +164,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["foo.from"].UniqueKey(): { - From: instAddrs["foo.from"], - To: instAddrs["foo.to"], - }, - instAddrs["foo.to"].UniqueKey(): { - From: instAddrs["foo.from"], - To: instAddrs["foo.to"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["foo.to"].UniqueKey(): { + From: instAddrs["foo.from"], + To: instAddrs["foo.to"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `foo.to`, @@ -189,15 +191,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["foo.from[0]"].UniqueKey(): { - From: instAddrs["foo.from[0]"], - To: instAddrs["foo.to[0]"], - }, - instAddrs["foo.to[0]"].UniqueKey(): { - From: instAddrs["foo.from[0]"], - To: instAddrs["foo.to[0]"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["foo.to[0]"].UniqueKey(): { + From: instAddrs["foo.from[0]"], + To: instAddrs["foo.to[0]"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `foo.to[0]`, @@ -218,19 +219,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["foo.from"].UniqueKey(): { - From: instAddrs["foo.from"], - To: instAddrs["foo.mid"], - }, - instAddrs["foo.mid"].UniqueKey(): { - From: instAddrs["foo.mid"], - To: instAddrs["foo.to"], - }, - instAddrs["foo.to"].UniqueKey(): { - From: instAddrs["foo.mid"], - To: instAddrs["foo.to"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["foo.to"].UniqueKey(): { + From: instAddrs["foo.from"], + To: instAddrs["foo.to"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `foo.to`, @@ -251,15 +247,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["foo.from[0]"].UniqueKey(): { - From: instAddrs["foo.from[0]"], - To: instAddrs["module.boo.foo.to[0]"], - }, - instAddrs["module.boo.foo.to[0]"].UniqueKey(): { - From: instAddrs["foo.from[0]"], - To: instAddrs["module.boo.foo.to[0]"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.boo.foo.to[0]"].UniqueKey(): { + From: instAddrs["foo.from[0]"], + To: instAddrs["module.boo.foo.to[0]"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `module.boo.foo.to[0]`, @@ -280,15 +275,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["module.boo.foo.from[0]"].UniqueKey(): { - From: instAddrs["module.boo.foo.from[0]"], - To: instAddrs["module.bar[0].foo.to[0]"], - }, - instAddrs["module.bar[0].foo.to[0]"].UniqueKey(): { - From: instAddrs["module.boo.foo.from[0]"], - To: instAddrs["module.bar[0].foo.to[0]"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.bar[0].foo.to[0]"].UniqueKey(): { + From: instAddrs["module.boo.foo.from[0]"], + To: instAddrs["module.bar[0].foo.to[0]"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `module.bar[0].foo.to[0]`, @@ -309,15 +303,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["module.boo.foo.from[0]"].UniqueKey(): { - From: instAddrs["module.boo.foo.from[0]"], - To: instAddrs["module.bar[0].foo.from[0]"], - }, - instAddrs["module.bar[0].foo.from[0]"].UniqueKey(): { - From: instAddrs["module.boo.foo.from[0]"], - To: instAddrs["module.bar[0].foo.from[0]"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.bar[0].foo.from[0]"].UniqueKey(): { + From: instAddrs["module.boo.foo.from[0]"], + To: instAddrs["module.bar[0].foo.from[0]"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `module.bar[0].foo.from[0]`, @@ -339,19 +332,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["module.boo.foo.from[0]"].UniqueKey(): { - From: instAddrs["module.boo.foo.from[0]"], - To: instAddrs["module.bar[0].foo.from[0]"], - }, - instAddrs["module.bar[0].foo.from[0]"].UniqueKey(): { - From: instAddrs["module.bar[0].foo.from[0]"], - To: instAddrs["module.bar[0].foo.to[0]"], - }, - instAddrs["module.bar[0].foo.to[0]"].UniqueKey(): { - From: instAddrs["module.bar[0].foo.from[0]"], - To: instAddrs["module.bar[0].foo.to[0]"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.bar[0].foo.to[0]"].UniqueKey(): { + From: instAddrs["module.boo.foo.from[0]"], + To: instAddrs["module.bar[0].foo.to[0]"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `module.bar[0].foo.to[0]`, @@ -373,19 +361,14 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - instAddrs["module.boo.foo.from[0]"].UniqueKey(): { - From: instAddrs["module.boo.foo.from[0]"], - To: instAddrs["module.bar[0].foo.from[0]"], - }, - instAddrs["module.bar[0].foo.from[0]"].UniqueKey(): { - From: instAddrs["module.bar[0].foo.from[0]"], - To: instAddrs["module.bar[0].foo.to[0]"], - }, - instAddrs["module.bar[0].foo.to[0]"].UniqueKey(): { - From: instAddrs["module.bar[0].foo.from[0]"], - To: instAddrs["module.bar[0].foo.to[0]"], + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.bar[0].foo.to[0]"].UniqueKey(): { + From: instAddrs["module.boo.foo.from[0]"], + To: instAddrs["module.bar[0].foo.to[0]"], + }, }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, []string{ `module.bar[0].foo.to[0]`, @@ -414,9 +397,16 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ + MoveResults{ // Nothing moved, because the module.b address is already // occupied by another module. + Changes: map[addrs.UniqueKey]MoveSuccess{}, + Blocked: map[addrs.UniqueKey]MoveBlocked{ + instAddrs["module.bar[0].foo.from"].Module.UniqueKey(): { + Wanted: instAddrs["module.boo.foo.to[0]"].Module, + Actual: instAddrs["module.bar[0].foo.from"].Module, + }, + }, }, []string{ `module.bar[0].foo.from`, @@ -446,9 +436,16 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - // Nothing moved, because the module.b address is already - // occupied by another module. + MoveResults{ + // Nothing moved, because the from.to address is already + // occupied by another resource. + Changes: map[addrs.UniqueKey]MoveSuccess{}, + Blocked: map[addrs.UniqueKey]MoveBlocked{ + instAddrs["foo.from"].ContainingResource().UniqueKey(): { + Wanted: instAddrs["foo.to"].ContainingResource(), + Actual: instAddrs["foo.from"].ContainingResource(), + }, + }, }, []string{ `foo.from`, @@ -478,22 +475,141 @@ func TestApplyMoves(t *testing.T) { providerAddr, ) }), - map[addrs.UniqueKey]MoveResult{ - // Nothing moved, because the module.b address is already - // occupied by another module. + MoveResults{ + // Nothing moved, because the from.to[0] address is already + // occupied by another resource instance. + Changes: map[addrs.UniqueKey]MoveSuccess{}, + Blocked: map[addrs.UniqueKey]MoveBlocked{ + instAddrs["foo.from"].UniqueKey(): { + Wanted: instAddrs["foo.to[0]"], + Actual: instAddrs["foo.from"], + }, + }, }, []string{ `foo.from`, `foo.to[0]`, }, }, + + // FIXME: This test seems to flap between the result the test case + // currently records and the "more intuitive" results included inline, + // which suggests we have a missing edge in our move dependency graph. + // (The MoveResults commented out below predates some changes to that + // struct, so will need updating once we uncomment this test.) + /* + "move module and then move resource into it": { + []MoveStatement{ + testMoveStatement(t, "", "module.bar[0]", "module.boo"), + testMoveStatement(t, "", "foo.from", "module.boo.foo.from"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["module.bar[0].foo.to"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + MoveResults{ + // FIXME: This result is counter-intuitive, because ApplyMoves + // handled the resource move first and then the module move + // collided with it. It would be arguably more intuitive to + // complete the module move first and then let the "smaller" + // resource move merge into it. + // (The arguably-more-intuitive results are commented out + // in the maps below.) + + Changes: map[addrs.UniqueKey]MoveSuccess{ + //instAddrs["module.boo.foo.to"].UniqueKey(): instAddrs["module.bar[0].foo.to"], + //instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["foo.from"], + instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["foo.from"], + }, + Blocked: map[addrs.UniqueKey]MoveBlocked{ + // intuitive result: nothing blocked + instAddrs["module.bar[0].foo.to"].Module.UniqueKey(): instAddrs["module.boo.foo.from"].Module, + }, + }, + []string{ + //`foo.from`, + //`module.boo.foo.from`, + `module.bar[0].foo.to`, + `module.boo.foo.from`, + }, + }, + */ + + // FIXME: This test seems to flap between the result the test case + // currently records and the "more intuitive" results included inline, + // which suggests we have a missing edge in our move dependency graph. + // (The MoveResults commented out below predates some changes to that + // struct, so will need updating once we uncomment this test.) + /* + "module move collides with resource move": { + []MoveStatement{ + testMoveStatement(t, "", "module.bar[0]", "module.boo"), + testMoveStatement(t, "", "foo.from", "module.boo.foo.from"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["module.bar[0].foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + MoveResults{ + // FIXME: This result is counter-intuitive, because ApplyMoves + // handled the resource move first and then it was the + // module move that collided, whereas it would arguably have + // been better to let the module take priority and have only + // the one resource move be ignored due to the collision. + // (The arguably-more-intuitive results are commented out + // in the maps below.) + Changes: map[addrs.UniqueKey]MoveSuccess{ + //instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["module.bar[0].foo.from"], + instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["foo.from"], + }, + Blocked: map[addrs.UniqueKey]MoveBlocked{ + //instAddrs["foo.from"].UniqueKey(): instAddrs["module.bar[0].foo.from"], + instAddrs["module.bar[0].foo.from"].Module.UniqueKey(): instAddrs["module.boo.foo.from"].Module, + }, + }, + []string{ + //`foo.from`, + //`module.boo.foo.from`, + `module.bar[0].foo.from`, + `module.boo.foo.from`, + }, + }, + */ } for name, test := range tests { t.Run(name, func(t *testing.T) { var stmtsBuf strings.Builder for _, stmt := range test.Stmts { - fmt.Fprintf(&stmtsBuf, "- from: %s\n to: %s\n", stmt.From, stmt.To) + fmt.Fprintf(&stmtsBuf, "• from: %s\n to: %s\n", stmt.From, stmt.To) } t.Logf("move statements:\n%s", stmtsBuf.String()) diff --git a/internal/refactoring/move_validate_test.go b/internal/refactoring/move_validate_test.go index 7ec8ab2f9e28..49f8acd86bff 100644 --- a/internal/refactoring/move_validate_test.go +++ b/internal/refactoring/move_validate_test.go @@ -325,29 +325,6 @@ Each resource can have moved from only one source resource.`, Each resource can have moved from only one source resource.`, }, - /* - // FIXME: This rule requires a deeper analysis to understand that - // module.single already contains a test.single and thus moving - // it to module.foo implicitly also moves module.single.test.single - // module.foo.test.single. - "two different moves to nested test.single by different paths": { - Statements: []MoveStatement{ - makeTestMoveStmt(t, - ``, - `test.beep`, - `module.foo.test.single`, - ), - makeTestMoveStmt(t, - ``, - `module.single`, - `module.foo`, - ), - }, - WantError: `Ambiguous move statements: A statement at test:1,1 declared that test.beep moved to module.foo.test.single, but this statement instead declares that module.single.test.single moved there. - - Each resource can have moved from only one source resource.`, - }, - */ "move from resource in another module package": { Statements: []MoveStatement{ makeTestMoveStmt(t, diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index f70a8f67b746..a48676ffa2bf 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -296,7 +296,7 @@ func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State return destroyPlan, diags } -func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState *states.State, targets []addrs.Targetable) ([]refactoring.MoveStatement, map[addrs.UniqueKey]refactoring.MoveResult) { +func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState *states.State, targets []addrs.Targetable) ([]refactoring.MoveStatement, refactoring.MoveResults) { explicitMoveStmts := refactoring.FindMoveStatements(config) implicitMoveStmts := refactoring.ImpliedMoveStatements(config, prevRunState, explicitMoveStmts) var moveStmts []refactoring.MoveStatement @@ -309,7 +309,7 @@ func (c *Context) prePlanFindAndApplyMoves(config *configs.Config, prevRunState return moveStmts, moveResults } -func (c *Context) prePlanVerifyTargetedMoves(moveResults map[addrs.UniqueKey]refactoring.MoveResult, targets []addrs.Targetable) tfdiags.Diagnostics { +func (c *Context) prePlanVerifyTargetedMoves(moveResults refactoring.MoveResults, targets []addrs.Targetable) tfdiags.Diagnostics { if len(targets) < 1 { return nil // the following only matters when targeting } @@ -317,7 +317,7 @@ func (c *Context) prePlanVerifyTargetedMoves(moveResults map[addrs.UniqueKey]ref var diags tfdiags.Diagnostics var excluded []addrs.AbsResourceInstance - for _, result := range moveResults { + for _, result := range moveResults.Changes { fromMatchesTarget := false toMatchesTarget := false for _, targetAddr := range targets { @@ -475,10 +475,10 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, } } -func (c *Context) driftedResources(config *configs.Config, oldState, newState *states.State, moves map[addrs.UniqueKey]refactoring.MoveResult) ([]*plans.ResourceInstanceChangeSrc, tfdiags.Diagnostics) { +func (c *Context) driftedResources(config *configs.Config, oldState, newState *states.State, moves refactoring.MoveResults) ([]*plans.ResourceInstanceChangeSrc, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics - if newState.ManagedResourcesEqual(oldState) && len(moves) == 0 { + if newState.ManagedResourcesEqual(oldState) && len(moves.Changes) == 0 { // Nothing to do, because we only detect and report drift for managed // resource instances. return nil, diags @@ -510,7 +510,7 @@ func (c *Context) driftedResources(config *configs.Config, oldState, newState *s // Previous run address defaults to the current address, but // can differ if the resource moved before refreshing prevRunAddr := addr - if move, ok := moves[addr.UniqueKey()]; ok { + if move, ok := moves.Changes[addr.UniqueKey()]; ok { prevRunAddr = move.From } diff --git a/internal/terraform/context_walk.go b/internal/terraform/context_walk.go index e041f80b2e43..166341513cce 100644 --- a/internal/terraform/context_walk.go +++ b/internal/terraform/context_walk.go @@ -3,7 +3,6 @@ package terraform import ( "log" - "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/instances" "github.com/hashicorp/terraform/internal/plans" @@ -25,7 +24,7 @@ type graphWalkOpts struct { Config *configs.Config RootVariableValues InputValues - MoveResults map[addrs.UniqueKey]refactoring.MoveResult + MoveResults refactoring.MoveResults } func (c *Context) walk(graph *Graph, operation walkOperation, opts *graphWalkOpts) (*ContextGraphWalker, tfdiags.Diagnostics) { diff --git a/internal/terraform/eval_context.go b/internal/terraform/eval_context.go index 61b4f2448f88..4b5a3a5c2cac 100644 --- a/internal/terraform/eval_context.go +++ b/internal/terraform/eval_context.go @@ -174,7 +174,7 @@ type EvalContext interface { // This data structure is created prior to the graph walk and read-only // thereafter, so callers must not modify the returned map or any other // objects accessible through it. - MoveResults() map[addrs.UniqueKey]refactoring.MoveResult + MoveResults() refactoring.MoveResults // WithPath returns a copy of the context with the internal path set to the // path argument. diff --git a/internal/terraform/eval_context_builtin.go b/internal/terraform/eval_context_builtin.go index ea83e82799b3..ecbac446e7cc 100644 --- a/internal/terraform/eval_context_builtin.go +++ b/internal/terraform/eval_context_builtin.go @@ -69,7 +69,7 @@ type BuiltinEvalContext struct { RefreshStateValue *states.SyncState PrevRunStateValue *states.SyncState InstanceExpanderValue *instances.Expander - MoveResultsValue map[addrs.UniqueKey]refactoring.MoveResult + MoveResultsValue refactoring.MoveResults } // BuiltinEvalContext implements EvalContext @@ -368,6 +368,6 @@ func (ctx *BuiltinEvalContext) InstanceExpander() *instances.Expander { return ctx.InstanceExpanderValue } -func (ctx *BuiltinEvalContext) MoveResults() map[addrs.UniqueKey]refactoring.MoveResult { +func (ctx *BuiltinEvalContext) MoveResults() refactoring.MoveResults { return ctx.MoveResultsValue } diff --git a/internal/terraform/eval_context_mock.go b/internal/terraform/eval_context_mock.go index 52a06c3ee719..edcdaac6b62c 100644 --- a/internal/terraform/eval_context_mock.go +++ b/internal/terraform/eval_context_mock.go @@ -132,7 +132,7 @@ type MockEvalContext struct { PrevRunStateState *states.SyncState MoveResultsCalled bool - MoveResultsResults map[addrs.UniqueKey]refactoring.MoveResult + MoveResultsResults refactoring.MoveResults InstanceExpanderCalled bool InstanceExpanderExpander *instances.Expander @@ -353,7 +353,7 @@ func (c *MockEvalContext) PrevRunState() *states.SyncState { return c.PrevRunStateState } -func (c *MockEvalContext) MoveResults() map[addrs.UniqueKey]refactoring.MoveResult { +func (c *MockEvalContext) MoveResults() refactoring.MoveResults { c.MoveResultsCalled = true return c.MoveResultsResults } diff --git a/internal/terraform/graph_walk_context.go b/internal/terraform/graph_walk_context.go index 39a97032c555..9e9e2a88fd49 100644 --- a/internal/terraform/graph_walk_context.go +++ b/internal/terraform/graph_walk_context.go @@ -25,12 +25,12 @@ type ContextGraphWalker struct { // Configurable values Context *Context - State *states.SyncState // Used for safe concurrent access to state - RefreshState *states.SyncState // Used for safe concurrent access to state - PrevRunState *states.SyncState // Used for safe concurrent access to state - Changes *plans.ChangesSync // Used for safe concurrent writes to changes - InstanceExpander *instances.Expander // Tracks our gradual expansion of module and resource instances - MoveResults map[addrs.UniqueKey]refactoring.MoveResult // Read-only record of earlier processing of move statements + State *states.SyncState // Used for safe concurrent access to state + RefreshState *states.SyncState // Used for safe concurrent access to state + PrevRunState *states.SyncState // Used for safe concurrent access to state + Changes *plans.ChangesSync // Used for safe concurrent writes to changes + InstanceExpander *instances.Expander // Tracks our gradual expansion of module and resource instances + MoveResults refactoring.MoveResults // Read-only record of earlier processing of move statements Operation walkOperation StopContext context.Context RootVariableValues InputValues diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index e73939a8e32d..3cab2b181a99 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -2282,13 +2282,5 @@ func (n *NodeAbstractResourceInstance) prevRunAddr(ctx EvalContext) addrs.AbsRes func resourceInstancePrevRunAddr(ctx EvalContext, currentAddr addrs.AbsResourceInstance) addrs.AbsResourceInstance { table := ctx.MoveResults() - - result, ok := table[currentAddr.UniqueKey()] - if !ok { - // If there's no entry in the table then we'll assume it didn't move - // at all, and so its previous address is the same as the current one. - return currentAddr - } - - return result.From + return table.OldAddr(currentAddr) } From 6b4e73af48f1cb78e51a634b077f73548db39ddc Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 22 Sep 2021 12:09:26 -0400 Subject: [PATCH 088/644] skip the blocktoattr fixup with nested types If structural types are being used, we can be assured that the legacy SDK SchemaConfigModeAttr is not being used, and the fixup is not needed. This prevents inadvertent mapping of blocks to structural attributes, and allows us to skip the fixup overhead when possible. --- internal/lang/blocktoattr/fixup.go | 27 +++++++++++++++++++++++ internal/lang/blocktoattr/fixup_test.go | 29 +++++++++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/internal/lang/blocktoattr/fixup.go b/internal/lang/blocktoattr/fixup.go index 1864e3e5016c..90eb260d7289 100644 --- a/internal/lang/blocktoattr/fixup.go +++ b/internal/lang/blocktoattr/fixup.go @@ -12,6 +12,10 @@ import ( // type in the schema to be written with HCL block syntax as multiple nested // blocks with the attribute name as the block type. // +// The fixup is only applied in the absence of structural attribute types. The +// presence of these types indicate the use of a provider which does not +// support mapping blocks to attributes. +// // This partially restores some of the block/attribute confusion from HCL 1 // so that existing patterns that depended on that confusion can continue to // be used in the short term while we settle on a longer-term strategy. @@ -28,6 +32,10 @@ func FixUpBlockAttrs(body hcl.Body, schema *configschema.Block) hcl.Body { schema = &configschema.Block{} } + if skipFixup(schema) { + return body + } + return &fixupBody{ original: body, schema: schema, @@ -35,6 +43,25 @@ func FixUpBlockAttrs(body hcl.Body, schema *configschema.Block) hcl.Body { } } +// skipFixup detects any use of Attribute.NestedType. Because the fixup was +// only supported for the legacy SDK, there is no situation where structural +// attributes are used where the fixup is expected. +func skipFixup(schema *configschema.Block) bool { + for _, attr := range schema.Attributes { + if attr.NestedType != nil { + return true + } + } + + for _, block := range schema.BlockTypes { + if skipFixup(&block.Block) { + return true + } + } + + return false +} + type fixupBody struct { original hcl.Body schema *configschema.Block diff --git a/internal/lang/blocktoattr/fixup_test.go b/internal/lang/blocktoattr/fixup_test.go index 8c7640521b13..92799394fa95 100644 --- a/internal/lang/blocktoattr/fixup_test.go +++ b/internal/lang/blocktoattr/fixup_test.go @@ -400,6 +400,35 @@ container { }), wantErrs: true, }, + "no fixup allowed": { + src: ` + container { + foo = "one" + } + `, + schema: &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "container": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "foo": { + Type: cty.String, + }, + }, + }, + }, + }, + }, + want: cty.ObjectVal(map[string]cty.Value{ + "container": cty.NullVal(cty.List( + cty.Object(map[string]cty.Type{ + "foo": cty.String, + }), + )), + }), + wantErrs: true, + }, } ctx := &hcl.EvalContext{ From 3f1c15c792ff18496774ecf951818068ab77c3ba Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 22 Sep 2021 10:31:31 -0700 Subject: [PATCH 089/644] Upgrade to Go 1.17.1 --- .go-version | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.go-version b/.go-version index 092afa15df4d..511a76e6faf8 100644 --- a/.go-version +++ b/.go-version @@ -1 +1 @@ -1.17.0 +1.17.1 From d14bbbb6f2a86118015b3de46246e14cdb4977b9 Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 22 Sep 2021 17:49:31 +0000 Subject: [PATCH 090/644] Release v1.1.0-alpha20210922 --- CHANGELOG.md | 2 +- version/version.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 281c399ccaec..474e343fd2a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ NEW FEATURES: ENHANCEMENTS: * config: Terraform now checks the syntax of and normalizes module source addresses (the `source` argument in `module` blocks) during configuration decoding rather than only at module installation time. This is largely just an internal refactoring, but a visible benefit of this change is that the `terraform init` messages about module downloading will now show the canonical module package address Terraform is downloading from, after interpreting the special shorthands for common cases like GitHub URLs. ([#28854](https://github.com/hashicorp/terraform/issues/28854)) -* cli: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. [GH-29605] +* cli: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. ([#29605](https://github.com/hashicorp/terraform/issues/29605)) BUG FIXES: diff --git a/version/version.go b/version/version.go index 86f22153dde3..5faa69bee97e 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "dev" +var Prerelease = "alpha20210922" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From cd1d30ea95a0f16818c5d7915fd1983994a26b0d Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 22 Sep 2021 18:12:02 +0000 Subject: [PATCH 091/644] Cleanup after v1.1.0-alpha20210922 release --- version/version.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version/version.go b/version/version.go index 5faa69bee97e..86f22153dde3 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "alpha20210922" +var Prerelease = "dev" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From 8706a18c4b69850cee1736f3af26869317313f3b Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 22 Sep 2021 15:59:25 -0400 Subject: [PATCH 092/644] refine the skipFixup heuristic We can also rule out some attribute types as indicating something other than the legacy SDK. - Tuple types were not generated at all. - There were no single objects types, the convention was to use a block list or set of length 1. - Maps of objects were not possible to generate, since named blocks were not implemented. - Nested collections were not supported, but when they were generated they would have primitive types. --- internal/lang/blocktoattr/fixup.go | 34 ++++++++++++++++++++++--- internal/lang/blocktoattr/fixup_test.go | 34 ++++++++++++++++++++++++- 2 files changed, 64 insertions(+), 4 deletions(-) diff --git a/internal/lang/blocktoattr/fixup.go b/internal/lang/blocktoattr/fixup.go index 90eb260d7289..5d05a86f2f5f 100644 --- a/internal/lang/blocktoattr/fixup.go +++ b/internal/lang/blocktoattr/fixup.go @@ -1,6 +1,8 @@ package blocktoattr import ( + "log" + "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hcldec" "github.com/hashicorp/terraform/internal/configs/configschema" @@ -33,6 +35,10 @@ func FixUpBlockAttrs(body hcl.Body, schema *configschema.Block) hcl.Body { } if skipFixup(schema) { + // we don't have any context for the resource name or type, but + // hopefully this could help locate the evaluation in the logs if there + // were a problem + log.Println("[DEBUG] skipping FixUpBlockAttrs") return body } @@ -43,14 +49,36 @@ func FixUpBlockAttrs(body hcl.Body, schema *configschema.Block) hcl.Body { } } -// skipFixup detects any use of Attribute.NestedType. Because the fixup was -// only supported for the legacy SDK, there is no situation where structural -// attributes are used where the fixup is expected. +// skipFixup detects any use of Attribute.NestedType, or Types which could not +// be generate by the legacy SDK when taking SchemaConfigModeAttr into account. func skipFixup(schema *configschema.Block) bool { for _, attr := range schema.Attributes { if attr.NestedType != nil { return true } + ty := attr.Type + + // Lists and sets of objects could be generated by + // SchemaConfigModeAttr, but some other combinations can be ruled out. + + // Tuples and objects could not be generated at all. + if ty.IsTupleType() || ty.IsObjectType() { + return true + } + + // A map of objects was not possible. + if ty.IsMapType() && ty.ElementType().IsObjectType() { + return true + } + + // Nested collections were not really supported, but could be generated + // with string types (though we conservatively limit this to primitive types) + if ty.IsCollectionType() { + ety := ty.ElementType() + if ety.IsCollectionType() && !ety.ElementType().IsPrimitiveType() { + return true + } + } } for _, block := range schema.BlockTypes { diff --git a/internal/lang/blocktoattr/fixup_test.go b/internal/lang/blocktoattr/fixup_test.go index 92799394fa95..36ab48041c9a 100644 --- a/internal/lang/blocktoattr/fixup_test.go +++ b/internal/lang/blocktoattr/fixup_test.go @@ -400,7 +400,7 @@ container { }), wantErrs: true, }, - "no fixup allowed": { + "no fixup allowed with NestedType": { src: ` container { foo = "one" @@ -429,6 +429,38 @@ container { }), wantErrs: true, }, + "no fixup allowed new types": { + src: ` + container { + foo = "one" + } + `, + schema: &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + // This could be a ConfigModeAttr fixup + "container": { + Type: cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + }, + // But the presence of this type means it must have been + // declared by a new SDK + "new_type": { + Type: cty.Object(map[string]cty.Type{ + "boo": cty.String, + }), + }, + }, + }, + want: cty.ObjectVal(map[string]cty.Value{ + "container": cty.NullVal(cty.List( + cty.Object(map[string]cty.Type{ + "foo": cty.String, + }), + )), + }), + wantErrs: true, + }, } ctx := &hcl.EvalContext{ From 60bc7aa05dbd99dd9e1809a4bec7d1f392f5730d Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 21 Sep 2021 23:29:02 -0500 Subject: [PATCH 093/644] command: Auto-select single workspace if necessary When initializing a backend, if the currently selected workspace does not exist, the user is prompted to select from the list of workspaces the backend provides. Instead, we should automatically select the only workspace available _if_ that's all that's there. Although with being a nice bit of polish, this enables future improvments with Terraform Cloud in potentially removing the implicit depenency on always using the 'default' workspace when the current configuration is mapped to a single TFC workspace. --- internal/command/meta_backend.go | 14 +++- internal/command/meta_backend_test.go | 79 ++++++++++++++++++- .../.terraform/environment | 1 + .../.terraform/terraform.tfstate | 23 ++++++ .../main.tf | 7 ++ .../terraform.tfstate | 13 +++ .../terraform.tfstate.d/foo/terraform.tfstate | 13 +++ .../.terraform/environment | 1 + .../.terraform/terraform.tfstate | 23 ++++++ .../main.tf | 7 ++ 10 files changed, 177 insertions(+), 4 deletions(-) create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/environment create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/terraform.tfstate create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/main.tf create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate.d/foo/terraform.tfstate create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/environment create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/terraform.tfstate create mode 100644 internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/main.tf diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 82ecd89c7850..f467579ba973 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -196,13 +196,19 @@ func (m *Meta) selectWorkspace(b backend.Backend) error { var list strings.Builder for i, w := range workspaces { if w == workspace { + log.Printf("[TRACE] Meta.selectWorkspace: the currently selected workspace is present in the configured backend (%s)", workspace) return nil } fmt.Fprintf(&list, "%d. %s\n", i+1, w) } - // If the selected workspace doesn't exist, ask the user to select - // a workspace from the list of existing workspaces. + // If the backend only has a single workspace, select that as the current workspace + if len(workspaces) == 1 { + log.Printf("[TRACE] Meta.selectWorkspace: automatically selecting the single workspace provided by the backend (%s)", workspaces[0]) + return m.SetWorkspace(workspaces[0]) + } + + // Otherwise, ask the user to select a workspace from the list of existing workspaces. v, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "select-workspace", Query: fmt.Sprintf( @@ -220,7 +226,9 @@ func (m *Meta) selectWorkspace(b backend.Backend) error { return fmt.Errorf("Failed to select workspace: input not a valid number") } - return m.SetWorkspace(workspaces[idx-1]) + workspace = workspaces[idx-1] + log.Printf("[TRACE] Meta.selectWorkspace: setting the current workpace according to user selection (%s)", workspace) + return m.SetWorkspace(workspace) } // BackendForPlan is similar to Backend, but uses backend settings that were diff --git a/internal/command/meta_backend_test.go b/internal/command/meta_backend_test.go index 82dbb0355a4b..be8fec9708e9 100644 --- a/internal/command/meta_backend_test.go +++ b/internal/command/meta_backend_test.go @@ -789,6 +789,84 @@ func TestMetaBackend_reconfigureChange(t *testing.T) { } } +// Initializing a backend which supports workspaces and does *not* have +// the currently selected workspace should prompt the user with a list of +// workspaces to choose from to select a valid one, if more than one workspace +// is available. +func TestMetaBackend_initSelectedWorkspaceDoesNotExist(t *testing.T) { + // Create a temporary working directory that is empty + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-selected-workspace-doesnt-exist-multi"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + // Setup the meta + m := testMetaBackend(t, nil) + + defer testInputMap(t, map[string]string{ + "select-workspace": "2", + })() + + // Get the backend + _, diags := m.Backend(&BackendOpts{Init: true}) + if diags.HasErrors() { + t.Fatal(diags.Err()) + } + + expected := "foo" + actual, err := m.Workspace() + if err != nil { + t.Fatal(err) + } + + if actual != expected { + t.Fatalf("expected selected workspace to be %q, but was %q", expected, actual) + } +} + +// Initializing a backend which supports workspaces and does *not* have the +// currently selected workspace - and which only has a single workspace - should +// automatically select that single workspace. +func TestMetaBackend_initSelectedWorkspaceDoesNotExistAutoSelect(t *testing.T) { + // Create a temporary working directory that is empty + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-selected-workspace-doesnt-exist-single"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + // Setup the meta + m := testMetaBackend(t, nil) + + // this should not ask for input + m.input = false + + // Assert test precondition: The current selected workspace is "bar" + previousName, err := m.Workspace() + if err != nil { + t.Fatal(err) + } + + if previousName != "bar" { + t.Fatalf("expected test fixture to start with 'bar' as the current selected workspace") + } + + // Get the backend + _, diags := m.Backend(&BackendOpts{Init: true}) + if diags.HasErrors() { + t.Fatal(diags.Err()) + } + + expected := "default" + actual, err := m.Workspace() + if err != nil { + t.Fatal(err) + } + + if actual != expected { + t.Fatalf("expected selected workspace to be %q, but was %q", expected, actual) + } +} + // Changing a configured backend, copying state func TestMetaBackend_configuredChangeCopy(t *testing.T) { // Create a temporary working directory that is empty @@ -1267,7 +1345,6 @@ func TestMetaBackend_configuredChangeCopy_multiToNoDefaultWithoutDefault(t *test // Ask input defer testInputMap(t, map[string]string{ "backend-migrate-multistate-to-multistate": "yes", - "select-workspace": "1", })() // Setup the meta diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/environment b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/environment new file mode 100644 index 000000000000..5716ca5987cb --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/environment @@ -0,0 +1 @@ +bar diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/terraform.tfstate b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/terraform.tfstate new file mode 100644 index 000000000000..19a90cc6b895 --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/.terraform/terraform.tfstate @@ -0,0 +1,23 @@ +{ + "version": 3, + "serial": 2, + "lineage": "2f3864a6-1d3e-1999-0f84-36cdb61179d3", + "backend": { + "type": "local", + "config": { + "path": null, + "workspace_dir": null + }, + "hash": 666019178 + }, + "modules": [ + { + "path": [ + "root" + ], + "outputs": {}, + "resources": {}, + "depends_on": [] + } + ] +} diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/main.tf b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/main.tf new file mode 100644 index 000000000000..da6f209e14ea --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/main.tf @@ -0,0 +1,7 @@ +terraform { + backend "local" {} +} + +output "foo" { + value = "bar" +} diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate new file mode 100644 index 000000000000..47de0a47e7d8 --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate @@ -0,0 +1,13 @@ +{ + "version": 4, + "terraform_version": "1.1.0", + "serial": 1, + "lineage": "cc4bb587-aa35-87ad-b3b7-7abdb574f2a1", + "outputs": { + "foo": { + "value": "bar", + "type": "string" + } + }, + "resources": [] +} diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate.d/foo/terraform.tfstate b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate.d/foo/terraform.tfstate new file mode 100644 index 000000000000..70021d04ad47 --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-multi/terraform.tfstate.d/foo/terraform.tfstate @@ -0,0 +1,13 @@ +{ + "version": 4, + "terraform_version": "1.1.0", + "serial": 1, + "lineage": "8ad3c77d-51aa-d90a-4f12-176f538b6e8b", + "outputs": { + "foo": { + "value": "bar", + "type": "string" + } + }, + "resources": [] +} diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/environment b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/environment new file mode 100644 index 000000000000..5716ca5987cb --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/environment @@ -0,0 +1 @@ +bar diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/terraform.tfstate b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/terraform.tfstate new file mode 100644 index 000000000000..19a90cc6b895 --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/.terraform/terraform.tfstate @@ -0,0 +1,23 @@ +{ + "version": 3, + "serial": 2, + "lineage": "2f3864a6-1d3e-1999-0f84-36cdb61179d3", + "backend": { + "type": "local", + "config": { + "path": null, + "workspace_dir": null + }, + "hash": 666019178 + }, + "modules": [ + { + "path": [ + "root" + ], + "outputs": {}, + "resources": {}, + "depends_on": [] + } + ] +} diff --git a/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/main.tf b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/main.tf new file mode 100644 index 000000000000..da6f209e14ea --- /dev/null +++ b/internal/command/testdata/init-backend-selected-workspace-doesnt-exist-single/main.tf @@ -0,0 +1,7 @@ +terraform { + backend "local" {} +} + +output "foo" { + value = "bar" +} From 171cdbbf939e12153d93a1c06806a7ad507ced3c Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 22 Sep 2021 15:55:56 -0500 Subject: [PATCH 094/644] command: Clean up testInputResponseMap before failing on unused answers If you don't, the unused answers will persist in the package-level var and bleed in to other tests. --- internal/command/command_test.go | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/internal/command/command_test.go b/internal/command/command_test.go index d1a43cf659ca..929bfb43975b 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -716,12 +716,15 @@ func testInputMap(t *testing.T, answers map[string]string) func() { // Return the cleanup return func() { - if len(testInputResponseMap) > 0 { - t.Fatalf("expected no unused answers provided to command.testInputMap, got: %v", testInputResponseMap) - } + var unusedAnswers = testInputResponseMap + // First, clean up! test = true testInputResponseMap = nil + + if len(unusedAnswers) > 0 { + t.Fatalf("expected no unused answers provided to command.testInputMap, got: %v", unusedAnswers) + } } } From ceb580ec40ba9cfa4f3e19ba83301dc3062c0ee8 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 23 Sep 2021 16:38:08 -0400 Subject: [PATCH 095/644] core: Fix refresh-only interaction with orphans When planning in refresh-only mode, we must not remove orphaned resources due to changed count or for_each values from the planned state. This was previously happening because we failed to pass through the plan's skip-plan-changes flag to the instance orphan node. --- internal/terraform/context_plan2_test.go | 142 +++++++++++++++++++++++ internal/terraform/node_resource_plan.go | 3 + 2 files changed, 145 insertions(+) diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 1167f234c00d..5b388148e59d 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -1335,6 +1335,148 @@ func TestContext2Plan_refreshOnlyMode_deposed(t *testing.T) { } } +func TestContext2Plan_refreshOnlyMode_orphan(t *testing.T) { + addr := mustAbsResourceAddr("test_object.a") + + // The configuration, the prior state, and the refresh result intentionally + // have different values for "test_string" so we can observe that the + // refresh took effect but the configuration change wasn't considered. + m := testModuleInline(t, map[string]string{ + "main.tf": ` + resource "test_object" "a" { + arg = "after" + count = 1 + } + + output "out" { + value = test_object.a.*.arg + } + `, + }) + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent(addr.Instance(addrs.IntKey(0)), &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"arg":"before"}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + s.SetResourceInstanceCurrent(addr.Instance(addrs.IntKey(1)), &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"arg":"before"}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + + p := simpleMockProvider() + p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{ + Provider: providers.Schema{Block: simpleTestSchema()}, + ResourceTypes: map[string]providers.Schema{ + "test_object": { + Block: &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "arg": {Type: cty.String, Optional: true}, + }, + }, + }, + }, + } + p.ReadResourceFn = func(req providers.ReadResourceRequest) providers.ReadResourceResponse { + newVal, err := cty.Transform(req.PriorState, func(path cty.Path, v cty.Value) (cty.Value, error) { + if len(path) == 1 && path[0] == (cty.GetAttrStep{Name: "arg"}) { + return cty.StringVal("current"), nil + } + return v, nil + }) + if err != nil { + // shouldn't get here + t.Fatalf("ReadResourceFn transform failed") + return providers.ReadResourceResponse{} + } + return providers.ReadResourceResponse{ + NewState: newVal, + } + } + p.UpgradeResourceStateFn = func(req providers.UpgradeResourceStateRequest) (resp providers.UpgradeResourceStateResponse) { + // We should've been given the prior state JSON as our input to upgrade. + if !bytes.Contains(req.RawStateJSON, []byte("before")) { + t.Fatalf("UpgradeResourceState request doesn't contain the 'before' object\n%s", req.RawStateJSON) + } + + // We'll put something different in "arg" as part of upgrading, just + // so that we can verify below that PrevRunState contains the upgraded + // (but NOT refreshed) version of the object. + resp.UpgradedState = cty.ObjectVal(map[string]cty.Value{ + "arg": cty.StringVal("upgraded"), + }) + return resp + } + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + }) + if diags.HasErrors() { + t.Fatalf("unexpected errors\n%s", diags.Err().Error()) + } + + if !p.UpgradeResourceStateCalled { + t.Errorf("Provider's UpgradeResourceState wasn't called; should've been") + } + if !p.ReadResourceCalled { + t.Errorf("Provider's ReadResource wasn't called; should've been") + } + + if got, want := len(plan.Changes.Resources), 0; got != want { + t.Errorf("plan contains resource changes; want none\n%s", spew.Sdump(plan.Changes.Resources)) + } + + if rState := plan.PriorState.Resource(addr); rState == nil { + t.Errorf("%s has no prior state at all after plan", addr) + } else { + for i := 0; i < 2; i++ { + instKey := addrs.IntKey(i) + if obj := rState.Instance(instKey).Current; obj == nil { + t.Errorf("%s%s has no object after plan", addr, instKey) + } else if got, want := obj.AttrsJSON, `"current"`; !bytes.Contains(got, []byte(want)) { + // Should've saved the result of refreshing + t.Errorf("%s%s has wrong prior state after plan\ngot:\n%s\n\nwant substring: %s", addr, instKey, got, want) + } + } + } + if rState := plan.PrevRunState.Resource(addr); rState == nil { + t.Errorf("%s has no prior state at all after plan", addr) + } else { + for i := 0; i < 2; i++ { + instKey := addrs.IntKey(i) + if obj := rState.Instance(instKey).Current; obj == nil { + t.Errorf("%s%s has no object after plan", addr, instKey) + } else if got, want := obj.AttrsJSON, `"upgraded"`; !bytes.Contains(got, []byte(want)) { + // Should've saved the result of upgrading + t.Errorf("%s%s has wrong prior state after plan\ngot:\n%s\n\nwant substring: %s", addr, instKey, got, want) + } + } + } + + // The output value should also have updated. If not, it's likely that we + // skipped updating the working state to match the refreshed state when we + // were evaluating the resource. + if outChangeSrc := plan.Changes.OutputValue(addrs.RootModuleInstance.OutputValue("out")); outChangeSrc == nil { + t.Errorf("no change planned for output value 'out'") + } else { + outChange, err := outChangeSrc.Decode() + if err != nil { + t.Fatalf("failed to decode output value 'out': %s", err) + } + got := outChange.After + want := cty.TupleVal([]cty.Value{cty.StringVal("current"), cty.StringVal("current")}) + if !want.RawEquals(got) { + t.Errorf("wrong value for output value 'out'\ngot: %#v\nwant: %#v", got, want) + } + } +} + func TestContext2Plan_invalidSensitiveModuleOutput(t *testing.T) { m := testModuleInline(t, map[string]string{ "child/main.tf": ` diff --git a/internal/terraform/node_resource_plan.go b/internal/terraform/node_resource_plan.go index c732575e5650..a9f3ca0e5dfd 100644 --- a/internal/terraform/node_resource_plan.go +++ b/internal/terraform/node_resource_plan.go @@ -132,6 +132,8 @@ func (n *nodeExpandPlannableResource) DynamicExpand(ctx EvalContext) (*Graph, er return &NodePlannableResourceInstanceOrphan{ NodeAbstractResourceInstance: a, + skipRefresh: n.skipRefresh, + skipPlanChanges: n.skipPlanChanges, } } @@ -351,6 +353,7 @@ func (n *NodePlannableResource) DynamicExpand(ctx EvalContext) (*Graph, error) { return &NodePlannableResourceInstanceOrphan{ NodeAbstractResourceInstance: a, skipRefresh: n.skipRefresh, + skipPlanChanges: n.skipPlanChanges, } } From 9c078c27cf39062302ad20680777014aae643c12 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 14 Sep 2021 09:13:13 -0400 Subject: [PATCH 096/644] temp path clean for some backend tests --- internal/backend/local/backend_apply_test.go | 18 +++------ internal/backend/local/backend_local_test.go | 9 ++--- internal/backend/local/backend_plan_test.go | 40 +++++++------------ .../backend/local/backend_refresh_test.go | 18 +++------ internal/backend/local/testing.go | 16 +++----- 5 files changed, 35 insertions(+), 66 deletions(-) diff --git a/internal/backend/local/backend_apply_test.go b/internal/backend/local/backend_apply_test.go index 07d5f8a6e2ca..4ffc0fa0a871 100644 --- a/internal/backend/local/backend_apply_test.go +++ b/internal/backend/local/backend_apply_test.go @@ -27,8 +27,7 @@ import ( ) func TestLocal_applyBasic(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", applyFixtureSchema()) p.ApplyResourceChangeResponse = &providers.ApplyResourceChangeResponse{NewState: cty.ObjectVal(map[string]cty.Value{ @@ -73,8 +72,7 @@ test_instance.foo: } func TestLocal_applyEmptyDir(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", &terraform.ProviderSchema{}) p.ApplyResourceChangeResponse = &providers.ApplyResourceChangeResponse{NewState: cty.ObjectVal(map[string]cty.Value{"id": cty.StringVal("yes")})} @@ -108,8 +106,7 @@ func TestLocal_applyEmptyDir(t *testing.T) { } func TestLocal_applyEmptyDirDestroy(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", &terraform.ProviderSchema{}) p.ApplyResourceChangeResponse = &providers.ApplyResourceChangeResponse{} @@ -139,8 +136,7 @@ func TestLocal_applyEmptyDirDestroy(t *testing.T) { } func TestLocal_applyError(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) schema := &terraform.ProviderSchema{ ResourceTypes: map[string]*configschema.Block{ @@ -208,8 +204,7 @@ test_instance.foo: } func TestLocal_applyBackendFail(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", applyFixtureSchema()) @@ -272,8 +267,7 @@ test_instance.foo: (tainted) } func TestLocal_applyRefreshFalse(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState()) diff --git a/internal/backend/local/backend_local_test.go b/internal/backend/local/backend_local_test.go index fae2b1ae0953..13070c2d3c8d 100644 --- a/internal/backend/local/backend_local_test.go +++ b/internal/backend/local/backend_local_test.go @@ -25,8 +25,7 @@ import ( func TestLocalRun(t *testing.T) { configDir := "./testdata/empty" - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) defer configCleanup() @@ -53,8 +52,7 @@ func TestLocalRun(t *testing.T) { func TestLocalRun_error(t *testing.T) { configDir := "./testdata/invalid" - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) // This backend will return an error when asked to RefreshState, which // should then cause LocalRun to return with the state unlocked. @@ -85,8 +83,7 @@ func TestLocalRun_error(t *testing.T) { func TestLocalRun_stalePlan(t *testing.T) { configDir := "./testdata/apply" - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) defer configCleanup() diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 6bae23555f3a..2a9f3f8287b0 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -23,8 +23,7 @@ import ( ) func TestLocal_planBasic(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", planFixtureSchema()) op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -53,8 +52,7 @@ func TestLocal_planBasic(t *testing.T) { } func TestLocal_planInAutomation(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) TestLocalProvider(t, b, "test", planFixtureSchema()) const msg = `You didn't use the -out option` @@ -85,8 +83,7 @@ func TestLocal_planInAutomation(t *testing.T) { } func TestLocal_planNoConfig(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) TestLocalProvider(t, b, "test", &terraform.ProviderSchema{}) op, configCleanup, done := testOperationPlan(t, "./testdata/empty") @@ -116,8 +113,7 @@ func TestLocal_planNoConfig(t *testing.T) { // This test validates the state lacking behavior when the inner call to // Context() fails func TestLocal_plan_context_error(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) // This is an intentionally-invalid value to make terraform.NewContext fail // when b.Operation calls it. @@ -157,8 +153,7 @@ func TestLocal_plan_context_error(t *testing.T) { } func TestLocal_planOutputsChanged(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) testStateFile(t, b.StatePath, states.BuildState(func(ss *states.SyncState) { ss.SetOutputValue(addrs.AbsOutputValue{ Module: addrs.RootModuleInstance, @@ -239,8 +234,7 @@ state, without changing any real infrastructure. // Module outputs should not cause the plan to be rendered func TestLocal_planModuleOutputsChanged(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) testStateFile(t, b.StatePath, states.BuildState(func(ss *states.SyncState) { ss.SetOutputValue(addrs.AbsOutputValue{ Module: addrs.RootModuleInstance.Child("mod", addrs.NoKey), @@ -286,8 +280,7 @@ No changes. Your infrastructure matches the configuration. } func TestLocal_planTainted(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState_tainted()) outDir := t.TempDir() @@ -343,8 +336,7 @@ Plan: 1 to add, 0 to change, 1 to destroy.` } func TestLocal_planDeposedOnly(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, states.BuildState(func(ss *states.SyncState) { ss.SetResourceInstanceDeposed( @@ -457,8 +449,8 @@ Plan: 1 to add, 0 to change, 1 to destroy.` } func TestLocal_planTainted_createBeforeDestroy(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) + p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState_tainted()) outDir := t.TempDir() @@ -514,8 +506,7 @@ Plan: 1 to add, 0 to change, 1 to destroy.` } func TestLocal_planRefreshFalse(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState()) @@ -546,8 +537,7 @@ func TestLocal_planRefreshFalse(t *testing.T) { } func TestLocal_planDestroy(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState()) @@ -599,8 +589,7 @@ func TestLocal_planDestroy(t *testing.T) { } func TestLocal_planDestroy_withDataSources(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState_withDataSource()) @@ -675,8 +664,7 @@ func getAddrs(resources []*plans.ResourceInstanceChangeSrc) []string { } func TestLocal_planOutPathNoChange(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) TestLocalProvider(t, b, "test", planFixtureSchema()) testStateFile(t, b.StatePath, testPlanState()) diff --git a/internal/backend/local/backend_refresh_test.go b/internal/backend/local/backend_refresh_test.go index 7fafee1b40b8..0e502267cc64 100644 --- a/internal/backend/local/backend_refresh_test.go +++ b/internal/backend/local/backend_refresh_test.go @@ -22,8 +22,7 @@ import ( ) func TestLocal_refresh(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", refreshFixtureSchema()) testStateFile(t, b.StatePath, testRefreshState()) @@ -58,8 +57,7 @@ test_instance.foo: } func TestLocal_refreshInput(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) schema := &terraform.ProviderSchema{ Provider: &configschema.Block{ @@ -121,8 +119,7 @@ test_instance.foo: } func TestLocal_refreshValidate(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", refreshFixtureSchema()) testStateFile(t, b.StatePath, testRefreshState()) p.ReadResourceFn = nil @@ -151,8 +148,7 @@ test_instance.foo: } func TestLocal_refreshValidateProviderConfigured(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) schema := &terraform.ProviderSchema{ Provider: &configschema.Block{ @@ -204,8 +200,7 @@ test_instance.foo: // This test validates the state lacking behavior when the inner call to // Context() fails func TestLocal_refresh_context_error(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) testStateFile(t, b.StatePath, testRefreshState()) op, configCleanup, done := testOperationRefresh(t, "./testdata/apply") defer configCleanup() @@ -225,8 +220,7 @@ func TestLocal_refresh_context_error(t *testing.T) { } func TestLocal_refreshEmptyState(t *testing.T) { - b, cleanup := TestLocal(t) - defer cleanup() + b := TestLocal(t) p := TestLocalProvider(t, b, "test", refreshFixtureSchema()) testStateFile(t, b.StatePath, states.NewState()) diff --git a/internal/backend/local/testing.go b/internal/backend/local/testing.go index bfff7f003584..d4fe51d9736f 100644 --- a/internal/backend/local/testing.go +++ b/internal/backend/local/testing.go @@ -1,7 +1,6 @@ package local import ( - "os" "path/filepath" "testing" @@ -21,9 +20,12 @@ import ( // // No operations will be called on the returned value, so you can still set // public fields without any locks. -func TestLocal(t *testing.T) (*Local, func()) { +func TestLocal(t *testing.T) *Local { t.Helper() - tempDir := t.TempDir() + tempDir, err := filepath.EvalSymlinks(t.TempDir()) + if err != nil { + t.Fatal(err) + } local := New() local.StatePath = filepath.Join(tempDir, "state.tfstate") @@ -32,13 +34,7 @@ func TestLocal(t *testing.T) (*Local, func()) { local.StateWorkspaceDir = filepath.Join(tempDir, "state.tfstate.d") local.ContextOpts = &terraform.ContextOpts{} - cleanup := func() { - if err := os.RemoveAll(tempDir); err != nil { - t.Fatal("error cleanup up test:", err) - } - } - - return local, cleanup + return local } // TestLocalProvider modifies the ContextOpts of the *Local parameter to From 7b99861b1c0acf65ab994e06be13eb08ac6f353f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 22 Sep 2021 16:57:01 -0700 Subject: [PATCH 097/644] refactoring: Don't implicitly move for resources with for_each Our previous rule for implicitly moving from IntKey(0) to NoKey would apply that move even when the current resource configuration uses for_each, because we were only considering whether "count" were set. Previously this was relatively harmless because the resource instance in question would end up planned for deletion anyway: neither an IntKey nor a NoKey are valid keys for for_each. Now that we're going to be announcing these moves explicitly in the UI, it would be confusing to see Terraform report that IntKey moved to NoKey in a situation where the config changed from count to for_each, so to address that we'll only generate the implied statement if neither repetition argument is set. --- internal/refactoring/move_statement.go | 2 +- internal/refactoring/move_statement_test.go | 14 ++++++++++++-- .../move-statement-implied.tf | 8 ++++++++ 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/internal/refactoring/move_statement.go b/internal/refactoring/move_statement.go index baaf9d519b85..a363602c3992 100644 --- a/internal/refactoring/move_statement.go +++ b/internal/refactoring/move_statement.go @@ -124,7 +124,7 @@ func impliedMoveStatements(cfg *configs.Config, prevRunState *states.State, expl fromKey = addrs.NoKey toKey = addrs.IntKey(0) } - default: + case rCfg.Count == nil && rCfg.ForEach == nil: // no repetition at all if riState := rState.Instances[addrs.IntKey(0)]; riState != nil { fromKey = addrs.IntKey(0) toKey = addrs.NoKey diff --git a/internal/refactoring/move_statement_test.go b/internal/refactoring/move_statement_test.go index 93164f94cc5e..9724b1fe1c27 100644 --- a/internal/refactoring/move_statement_test.go +++ b/internal/refactoring/move_statement_test.go @@ -58,6 +58,16 @@ func TestImpliedMoveStatements(t *testing.T) { instObjState(), providerAddr, ) + s.SetResourceInstanceCurrent( + resourceAddr("now_for_each_formerly_count").Instance(addrs.IntKey(0)), + instObjState(), + providerAddr, + ) + s.SetResourceInstanceCurrent( + resourceAddr("now_for_each_formerly_no_count").Instance(addrs.NoKey), + instObjState(), + providerAddr, + ) // This "ambiguous" resource is representing a rare but possible // situation where we end up having a mixture of different index @@ -113,8 +123,8 @@ func TestImpliedMoveStatements(t *testing.T) { Implied: true, DeclRange: tfdiags.SourceRange{ Filename: "testdata/move-statement-implied/move-statement-implied.tf", - Start: tfdiags.SourcePos{Line: 42, Column: 1, Byte: 709}, - End: tfdiags.SourcePos{Line: 42, Column: 27, Byte: 735}, + Start: tfdiags.SourcePos{Line: 50, Column: 1, Byte: 858}, + End: tfdiags.SourcePos{Line: 50, Column: 27, Byte: 884}, }, }, } diff --git a/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf b/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf index 1de3238bdb34..142ffe702ae3 100644 --- a/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf +++ b/internal/refactoring/testdata/move-statement-implied/move-statement-implied.tf @@ -39,6 +39,14 @@ moved { to = foo.now_count_explicit[1] } +resource "foo" "now_for_each_formerly_count" { + for_each = { a = 1 } +} + +resource "foo" "now_for_each_formerly_no_count" { + for_each = { a = 1 } +} + resource "foo" "ambiguous" { # this one doesn't have count in the config, but the test should # set it up to have both no-key and zero-key instances in the From a1a713cf281d9d07ef2dad96d625703051e3e1c6 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 22 Sep 2021 17:58:41 -0700 Subject: [PATCH 098/644] core: Report ActionReasons when we plan to delete "orphans" There are a few different reasons why a resource instance tracked in the prior state might be considered an "orphan", but previously we reported them all identically in the planned changes. In order to help users understand the reason for a surprising planned delete, we'll now try to specify an additional reason for the planned deletion, covering all of the main reasons why that could happen. This commit only introduces the new detail to the plans.Changes result, though it also incidentally exposes it as part of the JSON plan result in order to keep that working without returning errors in these new cases. We'll expose this information in the human-oriented UI output in a subsequent commit. --- internal/command/jsonplan/plan.go | 10 ++ .../show-json/basic-delete/output.json | 1 + internal/plans/changes.go | 34 ++++ .../plans/internal/planproto/planfile.pb.go | 54 +++++-- .../plans/internal/planproto/planfile.proto | 5 + internal/plans/planfile/tfplan.go | 20 +++ ...sourceinstancechangeactionreason_string.go | 33 +++- internal/terraform/context_apply_test.go | 147 ++++++++++++++++++ internal/terraform/context_plan_test.go | 37 ++++- .../terraform/node_resource_plan_orphan.go | 112 +++++++++++++ website/docs/internals/json-format.html.md | 14 ++ 11 files changed, 445 insertions(+), 22 deletions(-) diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index b2bf2cceb80b..c0b726422871 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -342,6 +342,16 @@ func (p *plan) marshalResourceChanges(resources []*plans.ResourceInstanceChangeS r.ActionReason = "replace_because_tainted" case plans.ResourceInstanceReplaceByRequest: r.ActionReason = "replace_by_request" + case plans.ResourceInstanceDeleteBecauseNoResourceConfig: + r.ActionReason = "delete_because_no_resource_config" + case plans.ResourceInstanceDeleteBecauseWrongRepetition: + r.ActionReason = "delete_because_wrong_repetition" + case plans.ResourceInstanceDeleteBecauseCountIndex: + r.ActionReason = "delete_because_count_index" + case plans.ResourceInstanceDeleteBecauseEachKey: + r.ActionReason = "delete_because_each_key" + case plans.ResourceInstanceDeleteBecauseNoModule: + r.ActionReason = "delete_because_no_module" default: return nil, fmt.Errorf("resource %s has an unsupported action reason %s", r.Address, rc.ActionReason) } diff --git a/internal/command/testdata/show-json/basic-delete/output.json b/internal/command/testdata/show-json/basic-delete/output.json index 9ebea2058f78..ae6e67f760b3 100644 --- a/internal/command/testdata/show-json/basic-delete/output.json +++ b/internal/command/testdata/show-json/basic-delete/output.json @@ -60,6 +60,7 @@ "type": "test_instance", "provider_name": "registry.terraform.io/hashicorp/test", "name": "test-delete", + "action_reason": "delete_because_no_resource_config", "change": { "actions": [ "delete" diff --git a/internal/plans/changes.go b/internal/plans/changes.go index c9aa38fd3863..510eb2c7cfee 100644 --- a/internal/plans/changes.go +++ b/internal/plans/changes.go @@ -349,6 +349,40 @@ const ( // the ResourceInstanceChange object to give information about specifically // which arguments changed in a non-updatable way. ResourceInstanceReplaceBecauseCannotUpdate ResourceInstanceChangeActionReason = 'F' + + // ResourceInstanceDeleteBecauseNoResourceConfig indicates that the + // resource instance is planned to be deleted because there's no + // corresponding resource configuration block in the configuration. + ResourceInstanceDeleteBecauseNoResourceConfig ResourceInstanceChangeActionReason = 'N' + + // ResourceInstanceDeleteBecauseWrongRepetition indicates that the + // resource instance is planned to be deleted because the instance key + // type isn't consistent with the repetition mode selected in the + // resource configuration. + ResourceInstanceDeleteBecauseWrongRepetition ResourceInstanceChangeActionReason = 'W' + + // ResourceInstanceDeleteBecauseCountIndex indicates that the resource + // instance is planned to be deleted because its integer instance key + // is out of range for the current configured resource "count" value. + ResourceInstanceDeleteBecauseCountIndex ResourceInstanceChangeActionReason = 'C' + + // ResourceInstanceDeleteBecauseEachKey indicates that the resource + // instance is planned to be deleted because its string instance key + // isn't one of the keys included in the current configured resource + // "for_each" value. + ResourceInstanceDeleteBecauseEachKey ResourceInstanceChangeActionReason = 'E' + + // ResourceInstanceDeleteBecauseNoModule indicates that the resource + // instance is planned to be deleted because it belongs to a module + // instance that's no longer declared in the configuration. + // + // This is less specific than the reasons we return for the various ways + // a resource instance itself can be no longer declared, including both + // the total removal of a module block and changes to its count/for_each + // arguments. This difference in detail is out of pragmatism, because + // potentially multiple nested modules could all contribute conflicting + // specific reasons for a particular instance to no longer be declared. + ResourceInstanceDeleteBecauseNoModule ResourceInstanceChangeActionReason = 'M' ) // OutputChange describes a change to an output value. diff --git a/internal/plans/internal/planproto/planfile.pb.go b/internal/plans/internal/planproto/planfile.pb.go index a612c03a3887..beb50852ab15 100644 --- a/internal/plans/internal/planproto/planfile.pb.go +++ b/internal/plans/internal/planproto/planfile.pb.go @@ -145,10 +145,15 @@ func (Action) EnumDescriptor() ([]byte, []int) { type ResourceInstanceActionReason int32 const ( - ResourceInstanceActionReason_NONE ResourceInstanceActionReason = 0 - ResourceInstanceActionReason_REPLACE_BECAUSE_TAINTED ResourceInstanceActionReason = 1 - ResourceInstanceActionReason_REPLACE_BY_REQUEST ResourceInstanceActionReason = 2 - ResourceInstanceActionReason_REPLACE_BECAUSE_CANNOT_UPDATE ResourceInstanceActionReason = 3 + ResourceInstanceActionReason_NONE ResourceInstanceActionReason = 0 + ResourceInstanceActionReason_REPLACE_BECAUSE_TAINTED ResourceInstanceActionReason = 1 + ResourceInstanceActionReason_REPLACE_BY_REQUEST ResourceInstanceActionReason = 2 + ResourceInstanceActionReason_REPLACE_BECAUSE_CANNOT_UPDATE ResourceInstanceActionReason = 3 + ResourceInstanceActionReason_DELETE_BECAUSE_NO_RESOURCE_CONFIG ResourceInstanceActionReason = 4 + ResourceInstanceActionReason_DELETE_BECAUSE_WRONG_REPETITION ResourceInstanceActionReason = 5 + ResourceInstanceActionReason_DELETE_BECAUSE_COUNT_INDEX ResourceInstanceActionReason = 6 + ResourceInstanceActionReason_DELETE_BECAUSE_EACH_KEY ResourceInstanceActionReason = 7 + ResourceInstanceActionReason_DELETE_BECAUSE_NO_MODULE ResourceInstanceActionReason = 8 ) // Enum value maps for ResourceInstanceActionReason. @@ -158,12 +163,22 @@ var ( 1: "REPLACE_BECAUSE_TAINTED", 2: "REPLACE_BY_REQUEST", 3: "REPLACE_BECAUSE_CANNOT_UPDATE", + 4: "DELETE_BECAUSE_NO_RESOURCE_CONFIG", + 5: "DELETE_BECAUSE_WRONG_REPETITION", + 6: "DELETE_BECAUSE_COUNT_INDEX", + 7: "DELETE_BECAUSE_EACH_KEY", + 8: "DELETE_BECAUSE_NO_MODULE", } ResourceInstanceActionReason_value = map[string]int32{ - "NONE": 0, - "REPLACE_BECAUSE_TAINTED": 1, - "REPLACE_BY_REQUEST": 2, - "REPLACE_BECAUSE_CANNOT_UPDATE": 3, + "NONE": 0, + "REPLACE_BECAUSE_TAINTED": 1, + "REPLACE_BY_REQUEST": 2, + "REPLACE_BECAUSE_CANNOT_UPDATE": 3, + "DELETE_BECAUSE_NO_RESOURCE_CONFIG": 4, + "DELETE_BECAUSE_WRONG_REPETITION": 5, + "DELETE_BECAUSE_COUNT_INDEX": 6, + "DELETE_BECAUSE_EACH_KEY": 7, + "DELETE_BECAUSE_NO_MODULE": 8, } ) @@ -1085,7 +1100,7 @@ var file_planfile_proto_rawDesc = []byte{ 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x06, 0x12, 0x16, 0x0a, 0x12, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x07, - 0x2a, 0x80, 0x01, 0x0a, 0x1c, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, + 0x2a, 0xa7, 0x02, 0x0a, 0x1c, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, 0x1b, 0x0a, 0x17, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x54, @@ -1093,11 +1108,22 @@ var file_planfile_proto_rawDesc = []byte{ 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, 0x5f, 0x52, 0x45, 0x51, 0x55, 0x45, 0x53, 0x54, 0x10, 0x02, 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, 0x4e, 0x4e, 0x4f, 0x54, 0x5f, 0x55, 0x50, 0x44, 0x41, 0x54, - 0x45, 0x10, 0x03, 0x42, 0x42, 0x5a, 0x40, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, - 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, - 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, - 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, - 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x45, 0x10, 0x03, 0x12, 0x25, 0x0a, 0x21, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, + 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x4e, 0x4f, 0x5f, 0x52, 0x45, 0x53, 0x4f, 0x55, 0x52, 0x43, + 0x45, 0x5f, 0x43, 0x4f, 0x4e, 0x46, 0x49, 0x47, 0x10, 0x04, 0x12, 0x23, 0x0a, 0x1f, 0x44, 0x45, + 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x57, 0x52, 0x4f, + 0x4e, 0x47, 0x5f, 0x52, 0x45, 0x50, 0x45, 0x54, 0x49, 0x54, 0x49, 0x4f, 0x4e, 0x10, 0x05, 0x12, + 0x1e, 0x0a, 0x1a, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, + 0x45, 0x5f, 0x43, 0x4f, 0x55, 0x4e, 0x54, 0x5f, 0x49, 0x4e, 0x44, 0x45, 0x58, 0x10, 0x06, 0x12, + 0x1b, 0x0a, 0x17, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, + 0x45, 0x5f, 0x45, 0x41, 0x43, 0x48, 0x5f, 0x4b, 0x45, 0x59, 0x10, 0x07, 0x12, 0x1c, 0x0a, 0x18, + 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x4e, + 0x4f, 0x5f, 0x4d, 0x4f, 0x44, 0x55, 0x4c, 0x45, 0x10, 0x08, 0x42, 0x42, 0x5a, 0x40, 0x67, 0x69, + 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, + 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, + 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, 0x6e, 0x74, 0x65, + 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x06, + 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( diff --git a/internal/plans/internal/planproto/planfile.proto b/internal/plans/internal/planproto/planfile.proto index d1427bfbea47..1bbe7425e502 100644 --- a/internal/plans/internal/planproto/planfile.proto +++ b/internal/plans/internal/planproto/planfile.proto @@ -131,6 +131,11 @@ enum ResourceInstanceActionReason { REPLACE_BECAUSE_TAINTED = 1; REPLACE_BY_REQUEST = 2; REPLACE_BECAUSE_CANNOT_UPDATE = 3; + DELETE_BECAUSE_NO_RESOURCE_CONFIG = 4; + DELETE_BECAUSE_WRONG_REPETITION = 5; + DELETE_BECAUSE_COUNT_INDEX = 6; + DELETE_BECAUSE_EACH_KEY = 7; + DELETE_BECAUSE_NO_MODULE = 8; } message ResourceInstanceChange { diff --git a/internal/plans/planfile/tfplan.go b/internal/plans/planfile/tfplan.go index 8cfd3694fb4f..87d21822efc8 100644 --- a/internal/plans/planfile/tfplan.go +++ b/internal/plans/planfile/tfplan.go @@ -228,6 +228,16 @@ func resourceChangeFromTfplan(rawChange *planproto.ResourceInstanceChange) (*pla ret.ActionReason = plans.ResourceInstanceReplaceBecauseTainted case planproto.ResourceInstanceActionReason_REPLACE_BY_REQUEST: ret.ActionReason = plans.ResourceInstanceReplaceByRequest + case planproto.ResourceInstanceActionReason_DELETE_BECAUSE_NO_RESOURCE_CONFIG: + ret.ActionReason = plans.ResourceInstanceDeleteBecauseNoResourceConfig + case planproto.ResourceInstanceActionReason_DELETE_BECAUSE_WRONG_REPETITION: + ret.ActionReason = plans.ResourceInstanceDeleteBecauseWrongRepetition + case planproto.ResourceInstanceActionReason_DELETE_BECAUSE_COUNT_INDEX: + ret.ActionReason = plans.ResourceInstanceDeleteBecauseCountIndex + case planproto.ResourceInstanceActionReason_DELETE_BECAUSE_EACH_KEY: + ret.ActionReason = plans.ResourceInstanceDeleteBecauseEachKey + case planproto.ResourceInstanceActionReason_DELETE_BECAUSE_NO_MODULE: + ret.ActionReason = plans.ResourceInstanceDeleteBecauseNoModule default: return nil, fmt.Errorf("resource has invalid action reason %s", rawChange.ActionReason) } @@ -499,6 +509,16 @@ func resourceChangeToTfplan(change *plans.ResourceInstanceChangeSrc) (*planproto ret.ActionReason = planproto.ResourceInstanceActionReason_REPLACE_BECAUSE_TAINTED case plans.ResourceInstanceReplaceByRequest: ret.ActionReason = planproto.ResourceInstanceActionReason_REPLACE_BY_REQUEST + case plans.ResourceInstanceDeleteBecauseNoResourceConfig: + ret.ActionReason = planproto.ResourceInstanceActionReason_DELETE_BECAUSE_NO_RESOURCE_CONFIG + case plans.ResourceInstanceDeleteBecauseWrongRepetition: + ret.ActionReason = planproto.ResourceInstanceActionReason_DELETE_BECAUSE_WRONG_REPETITION + case plans.ResourceInstanceDeleteBecauseCountIndex: + ret.ActionReason = planproto.ResourceInstanceActionReason_DELETE_BECAUSE_COUNT_INDEX + case plans.ResourceInstanceDeleteBecauseEachKey: + ret.ActionReason = planproto.ResourceInstanceActionReason_DELETE_BECAUSE_EACH_KEY + case plans.ResourceInstanceDeleteBecauseNoModule: + ret.ActionReason = planproto.ResourceInstanceActionReason_DELETE_BECAUSE_NO_MODULE default: return nil, fmt.Errorf("resource %s has unsupported action reason %s", change.Addr, change.ActionReason) } diff --git a/internal/plans/resourceinstancechangeactionreason_string.go b/internal/plans/resourceinstancechangeactionreason_string.go index 0731f67591a9..135e6d2c638d 100644 --- a/internal/plans/resourceinstancechangeactionreason_string.go +++ b/internal/plans/resourceinstancechangeactionreason_string.go @@ -12,25 +12,46 @@ func _() { _ = x[ResourceInstanceReplaceBecauseTainted-84] _ = x[ResourceInstanceReplaceByRequest-82] _ = x[ResourceInstanceReplaceBecauseCannotUpdate-70] + _ = x[ResourceInstanceDeleteBecauseNoResourceConfig-78] + _ = x[ResourceInstanceDeleteBecauseWrongRepetition-87] + _ = x[ResourceInstanceDeleteBecauseCountIndex-67] + _ = x[ResourceInstanceDeleteBecauseEachKey-69] + _ = x[ResourceInstanceDeleteBecauseNoModule-77] } const ( _ResourceInstanceChangeActionReason_name_0 = "ResourceInstanceChangeNoReason" - _ResourceInstanceChangeActionReason_name_1 = "ResourceInstanceReplaceBecauseCannotUpdate" - _ResourceInstanceChangeActionReason_name_2 = "ResourceInstanceReplaceByRequest" - _ResourceInstanceChangeActionReason_name_3 = "ResourceInstanceReplaceBecauseTainted" + _ResourceInstanceChangeActionReason_name_1 = "ResourceInstanceDeleteBecauseCountIndex" + _ResourceInstanceChangeActionReason_name_2 = "ResourceInstanceDeleteBecauseEachKeyResourceInstanceReplaceBecauseCannotUpdate" + _ResourceInstanceChangeActionReason_name_3 = "ResourceInstanceDeleteBecauseNoModuleResourceInstanceDeleteBecauseNoResourceConfig" + _ResourceInstanceChangeActionReason_name_4 = "ResourceInstanceReplaceByRequest" + _ResourceInstanceChangeActionReason_name_5 = "ResourceInstanceReplaceBecauseTainted" + _ResourceInstanceChangeActionReason_name_6 = "ResourceInstanceDeleteBecauseWrongRepetition" +) + +var ( + _ResourceInstanceChangeActionReason_index_2 = [...]uint8{0, 36, 78} + _ResourceInstanceChangeActionReason_index_3 = [...]uint8{0, 37, 82} ) func (i ResourceInstanceChangeActionReason) String() string { switch { case i == 0: return _ResourceInstanceChangeActionReason_name_0 - case i == 70: + case i == 67: return _ResourceInstanceChangeActionReason_name_1 + case 69 <= i && i <= 70: + i -= 69 + return _ResourceInstanceChangeActionReason_name_2[_ResourceInstanceChangeActionReason_index_2[i]:_ResourceInstanceChangeActionReason_index_2[i+1]] + case 77 <= i && i <= 78: + i -= 77 + return _ResourceInstanceChangeActionReason_name_3[_ResourceInstanceChangeActionReason_index_3[i]:_ResourceInstanceChangeActionReason_index_3[i+1]] case i == 82: - return _ResourceInstanceChangeActionReason_name_2 + return _ResourceInstanceChangeActionReason_name_4 case i == 84: - return _ResourceInstanceChangeActionReason_name_3 + return _ResourceInstanceChangeActionReason_name_5 + case i == 87: + return _ResourceInstanceChangeActionReason_name_6 default: return "ResourceInstanceChangeActionReason(" + strconv.FormatInt(int64(i), 10) + ")" } diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index babf067a5e69..a525ab52d19c 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -2127,6 +2127,30 @@ func TestContext2Apply_countDecreaseToOneCorrupted(t *testing.T) { t.Fatalf("wrong plan result\ngot:\n%s\nwant:\n%s", got, want) } } + { + change := plan.Changes.ResourceInstance(mustResourceInstanceAddr("aws_instance.foo[0]")) + if change == nil { + t.Fatalf("no planned change for instance zero") + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for instance zero %s; want %s", got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseWrongRepetition; got != want { + t.Errorf("wrong action reason for instance zero %s; want %s", got, want) + } + } + { + change := plan.Changes.ResourceInstance(mustResourceInstanceAddr("aws_instance.foo")) + if change == nil { + t.Fatalf("no planned change for no-key instance") + } + if got, want := change.Action, plans.NoOp; got != want { + t.Errorf("wrong action for no-key instance %s; want %s", got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason for no-key instance %s; want %s", got, want) + } + } s, diags := ctx.Apply(plan, m) if diags.HasErrors() { @@ -2562,6 +2586,20 @@ func TestContext2Apply_orphanResource(t *testing.T) { }) plan, diags = ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) + { + addr := mustResourceInstanceAddr("test_thing.one[0]") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseNoResourceConfig; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + } + state, diags = ctx.Apply(plan, m) assertNoErrors(t, diags) @@ -2613,6 +2651,22 @@ func TestContext2Apply_moduleOrphanInheritAlias(t *testing.T) { plan, diags := ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) + { + addr := mustResourceInstanceAddr("module.child.aws_instance.bar") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + // This should ideally be ResourceInstanceDeleteBecauseNoModule, but + // the codepath deciding this doesn't currently have enough information + // to differentiate, and so this is a compromise. + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseNoResourceConfig; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + } state, diags = ctx.Apply(plan, m) if diags.HasErrors() { @@ -8898,6 +8952,43 @@ func TestContext2Apply_scaleInMultivarRef(t *testing.T) { }, }) assertNoErrors(t, diags) + { + addr := mustResourceInstanceAddr("aws_instance.one[0]") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + // This test was originally written with Terraform v0.11 and earlier + // in mind, so it declares a no-key instance of aws_instance.one, + // but its configuration sets count (to zero) and so we end up first + // moving the no-key instance to the zero key and then planning to + // destroy the zero key. + if got, want := change.PrevRunAddr, mustResourceInstanceAddr("aws_instance.one"); !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", addr, got, want) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseCountIndex; got != want { + t.Errorf("wrong action reason for %s %s; want %s", addr, got, want) + } + } + { + addr := mustResourceInstanceAddr("aws_instance.two") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + if got, want := change.PrevRunAddr, mustResourceInstanceAddr("aws_instance.two"); !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", addr, got, want) + } + if got, want := change.Action, plans.Update; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason for %s %s; want %s", addr, got, want) + } + } // Applying the plan should now succeed _, diags = ctx.Apply(plan, m) @@ -10960,6 +11051,38 @@ locals { if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } + { + addr := mustResourceInstanceAddr("test_instance.a[0]") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + if got, want := change.PrevRunAddr, mustResourceInstanceAddr("test_instance.a[0]"); !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", addr, got, want) + } + if got, want := change.Action, plans.NoOp; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason for %s %s; want %s", addr, got, want) + } + } + { + addr := mustResourceInstanceAddr("test_instance.a[1]") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + if got, want := change.PrevRunAddr, mustResourceInstanceAddr("test_instance.a[1]"); !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", addr, got, want) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseCountIndex; got != want { + t.Errorf("wrong action reason for %s %s; want %s", addr, got, want) + } + } state, diags = ctx.Apply(plan, m) if diags.HasErrors() { @@ -10991,6 +11114,30 @@ locals { if diags.HasErrors() { t.Fatal(diags.ErrWithWarnings()) } + { + addr := mustResourceInstanceAddr("test_instance.a[0]") + change := plan.Changes.ResourceInstance(addr) + if change == nil { + t.Fatalf("no planned change for %s", addr) + } + if got, want := change.PrevRunAddr, mustResourceInstanceAddr("test_instance.a[0]"); !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", addr, got, want) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", addr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseCountIndex; got != want { + t.Errorf("wrong action reason for %s %s; want %s", addr, got, want) + } + } + { + addr := mustResourceInstanceAddr("test_instance.a[1]") + change := plan.Changes.ResourceInstance(addr) + if change != nil { + // It was already removed in the previous plan/apply + t.Errorf("unexpected planned change for %s", addr) + } + } state, diags = ctx.Apply(plan, m) if diags.HasErrors() { diff --git a/internal/terraform/context_plan_test.go b/internal/terraform/context_plan_test.go index 475bcb661f13..9cb4c8925573 100644 --- a/internal/terraform/context_plan_test.go +++ b/internal/terraform/context_plan_test.go @@ -3559,7 +3559,7 @@ func TestContext2Plan_orphan(t *testing.T) { if res.Action != plans.Delete { t.Fatalf("resource %s should be removed", i) } - if got, want := ric.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + if got, want := ric.ActionReason, plans.ResourceInstanceDeleteBecauseNoResourceConfig; got != want { t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) } case "aws_instance.foo": @@ -6138,8 +6138,41 @@ resource "test_instance" "b" { }, }) - _, diags := ctx.Plan(m, state, DefaultPlanOpts) + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) assertNoErrors(t, diags) + + t.Run("test_instance.a[0]", func(t *testing.T) { + instAddr := mustResourceInstanceAddr("test_instance.a[0]") + change := plan.Changes.ResourceInstance(instAddr) + if change == nil { + t.Fatalf("no planned change for %s", instAddr) + } + if got, want := change.PrevRunAddr, instAddr; !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", instAddr, got, want) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", instAddr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseWrongRepetition; got != want { + t.Errorf("wrong action reason for %s %s; want %s", instAddr, got, want) + } + }) + t.Run("test_instance.b", func(t *testing.T) { + instAddr := mustResourceInstanceAddr("test_instance.b") + change := plan.Changes.ResourceInstance(instAddr) + if change == nil { + t.Fatalf("no planned change for %s", instAddr) + } + if got, want := change.PrevRunAddr, instAddr; !want.Equal(got) { + t.Errorf("wrong previous run address for %s %s; want %s", instAddr, got, want) + } + if got, want := change.Action, plans.Delete; got != want { + t.Errorf("wrong action for %s %s; want %s", instAddr, got, want) + } + if got, want := change.ActionReason, plans.ResourceInstanceDeleteBecauseWrongRepetition; got != want { + t.Errorf("wrong action reason for %s %s; want %s", instAddr, got, want) + } + }) } func TestContext2Plan_targetedModuleInstance(t *testing.T) { diff --git a/internal/terraform/node_resource_plan_orphan.go b/internal/terraform/node_resource_plan_orphan.go index 2c28d88a33dd..7f9a683f1ad9 100644 --- a/internal/terraform/node_resource_plan_orphan.go +++ b/internal/terraform/node_resource_plan_orphan.go @@ -134,6 +134,11 @@ func (n *NodePlannableResourceInstanceOrphan) managedResourceExecute(ctx EvalCon return diags } + // We might be able to offer an approximate reason for why we are + // planning to delete this object. (This is best-effort; we might + // sometimes not have a reason.) + change.ActionReason = n.deleteActionReason(ctx) + diags = diags.Append(n.writeChange(ctx, change, "")) if diags.HasErrors() { return diags @@ -148,3 +153,110 @@ func (n *NodePlannableResourceInstanceOrphan) managedResourceExecute(ctx EvalCon return diags } + +func (n *NodePlannableResourceInstanceOrphan) deleteActionReason(ctx EvalContext) plans.ResourceInstanceChangeActionReason { + cfg := n.Config + if cfg == nil { + // NOTE: We'd ideally detect if the containing module is what's missing + // and then use ResourceInstanceDeleteBecauseNoModule for that case, + // but we don't currently have access to the full configuration here, + // so we need to be less specific. + return plans.ResourceInstanceDeleteBecauseNoResourceConfig + } + + switch n.Addr.Resource.Key.(type) { + case nil: // no instance key at all + if cfg.Count != nil || cfg.ForEach != nil { + return plans.ResourceInstanceDeleteBecauseWrongRepetition + } + case addrs.IntKey: + if cfg.Count == nil { + // This resource isn't using "count" at all, then + return plans.ResourceInstanceDeleteBecauseWrongRepetition + } + + expander := ctx.InstanceExpander() + if expander == nil { + break // only for tests that produce an incomplete MockEvalContext + } + insts := expander.ExpandResource(n.Addr.ContainingResource()) + + declared := false + for _, inst := range insts { + if n.Addr.Equal(inst) { + declared = true + } + } + if !declared { + // This instance key is outside of the configured range + return plans.ResourceInstanceDeleteBecauseCountIndex + } + case addrs.StringKey: + if cfg.ForEach == nil { + // This resource isn't using "for_each" at all, then + return plans.ResourceInstanceDeleteBecauseWrongRepetition + } + + expander := ctx.InstanceExpander() + if expander == nil { + break // only for tests that produce an incomplete MockEvalContext + } + insts := expander.ExpandResource(n.Addr.ContainingResource()) + + declared := false + for _, inst := range insts { + if n.Addr.Equal(inst) { + declared = true + } + } + if !declared { + // This instance key is outside of the configured range + return plans.ResourceInstanceDeleteBecauseEachKey + } + } + + // If we get here then the instance key type matches the configured + // repetition mode, and so we need to consider whether the key itself + // is within the range of the repetition construct. + if expander := ctx.InstanceExpander(); expander != nil { // (sometimes nil in MockEvalContext in tests) + // First we'll check whether our containing module instance still + // exists, so we can talk about that differently in the reason. + declared := false + for _, inst := range expander.ExpandModule(n.Addr.Module.Module()) { + if n.Addr.Module.Equal(inst) { + declared = true + break + } + } + if !declared { + return plans.ResourceInstanceDeleteBecauseNoModule + } + + // Now we've proven that we're in a still-existing module instance, + // we'll see if our instance key matches something actually declared. + declared = false + for _, inst := range expander.ExpandResource(n.Addr.ContainingResource()) { + if n.Addr.Equal(inst) { + declared = true + break + } + } + if !declared { + // Because we already checked that the key _type_ was correct + // above, we can assume that any mismatch here is a range error, + // and thus we just need to decide which of the two range + // errors we're going to return. + switch n.Addr.Resource.Key.(type) { + case addrs.IntKey: + return plans.ResourceInstanceDeleteBecauseCountIndex + case addrs.StringKey: + return plans.ResourceInstanceDeleteBecauseEachKey + } + } + } + + // If we didn't find any specific reason to report, we'll report "no reason" + // as a fallback, which means the UI should just state it'll be deleted + // without any explicit reasoning. + return plans.ResourceInstanceChangeNoReason +} diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index ffe54c2cc8b6..aa4df209af18 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -149,6 +149,20 @@ For ease of consumption by callers, the plan representation includes a partial r // - "replace_by_request": the user explicitly called for this object // to be replaced as an option when creating the plan, which therefore // overrode what would have been a "no-op" or "update" action otherwise. + // - "delete_because_no_resource_config": Terraform found no resource + // configuration corresponding to this instance. + // - "delete_because_no_module": The resource instance belongs to a + // module instance that's no longer declared, perhaps due to changing + // the "count" or "for_each" argument on one of the containing modules. + // - "delete_because_wrong_repetition": The instance key portion of the + // resource address isn't of a suitable type for the corresponding + // resource's configured repetition mode (count, for_each, or neither). + // - "delete_because_count_index": The corresponding resource uses count, + // but the instance key is out of range for the currently-configured + // count value. + // - "delete_because_each_key": The corresponding resource uses for_each, + // but the instance key doesn't match any of the keys in the + // currently-configured for_each value. // // If there is no special reason to note, Terraform will omit this // property altogether. From 04f9e7148cd5cc8fa74ccd8af0c8dd2472d3a7f2 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 22 Sep 2021 18:23:35 -0700 Subject: [PATCH 099/644] command/format: Include deletion reasons in plan report The core runtime is now able to specify a reason for some situations when Terraform plans to delete a resource instance. This commit makes that information visible in the human-oriented UI. A previous commit already made the underlying data informing these new hints visible as part of the machine-oriented (JSON) plan output. This also removes the bold formatting from the existing "has moved to" hints, because subjectively it seemed like the result was emphasizing too many parts of the output and thus somewhat defeating the benefit of the emphasis in trying to create additional visual hierarchy for sighted users running Terraform in a terminal. Now only the first line containing the main action statement will be in bold, and all of the parenthesized follow-up notes will be unformatted. --- internal/command/format/diff.go | 27 +++- internal/command/format/diff_test.go | 229 ++++++++++++++++++++++++++- 2 files changed, 253 insertions(+), 3 deletions(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index c70918af4ac2..ec777b5852fa 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -98,6 +98,31 @@ func ResourceChange( default: buf.WriteString(fmt.Sprintf(color.Color("[bold] # %s[reset] delete (unknown reason %s)"), dispAddr, language)) } + // We can sometimes give some additional detail about why we're + // proposing to delete. We show this as additional notes, rather than + // as additional wording in the main action statement, in an attempt + // to make the "will be destroyed" message prominent and consistent + // in all cases, for easier scanning of this often-risky action. + switch change.ActionReason { + case plans.ResourceInstanceDeleteBecauseNoResourceConfig: + buf.WriteString(fmt.Sprintf("\n # (because %s is not in configuration)", addr.Resource.Resource)) + case plans.ResourceInstanceDeleteBecauseNoModule: + buf.WriteString(fmt.Sprintf("\n # (because %s is not in configuration)", addr.Module)) + case plans.ResourceInstanceDeleteBecauseWrongRepetition: + // We have some different variations of this one + switch addr.Resource.Key.(type) { + case nil: + buf.WriteString("\n # (because resource uses count or for_each)") + case addrs.IntKey: + buf.WriteString("\n # (because resource does not use count)") + case addrs.StringKey: + buf.WriteString("\n # (because resource does not use for_each)") + } + case plans.ResourceInstanceDeleteBecauseCountIndex: + buf.WriteString(fmt.Sprintf("\n # (because index %s is out of range for count)", addr.Resource.Key)) + case plans.ResourceInstanceDeleteBecauseEachKey: + buf.WriteString(fmt.Sprintf("\n # (because key %s is not in for_each map)", addr.Resource.Key)) + } if change.DeposedKey != states.NotDeposed { // Some extra context about this unusual situation. buf.WriteString(color.Color("\n # (left over from a partially-failed replacement of this instance)")) @@ -115,7 +140,7 @@ func ResourceChange( buf.WriteString(color.Color("[reset]\n")) if change.Moved() && change.Action != plans.NoOp { - buf.WriteString(fmt.Sprintf(color.Color("[bold] # [reset]([bold]%s[reset] has moved to [bold]%s[reset])\n"), change.PrevRunAddr.String(), dispAddr)) + buf.WriteString(fmt.Sprintf(color.Color(" # [reset](moved from %s)\n"), change.PrevRunAddr.String())) } if change.Moved() && change.Action == plans.NoOp { diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index b59a3af56412..6a720210ed7b 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -3504,6 +3504,229 @@ func TestResourceChange_nestedMap(t *testing.T) { runTestCases(t, testCases) } +func TestResourceChange_actionReason(t *testing.T) { + emptySchema := &configschema.Block{} + nullVal := cty.NullVal(cty.EmptyObject) + emptyVal := cty.EmptyObjectVal + + testCases := map[string]testCase{ + "delete for no particular reason": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceChangeNoReason, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example will be destroyed + - resource "test_instance" "example" {} +`, + }, + "delete because of wrong repetition mode (NoKey)": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseWrongRepetition, + Mode: addrs.ManagedResourceMode, + InstanceKey: addrs.NoKey, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example will be destroyed + # (because resource uses count or for_each) + - resource "test_instance" "example" {} +`, + }, + "delete because of wrong repetition mode (IntKey)": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseWrongRepetition, + Mode: addrs.ManagedResourceMode, + InstanceKey: addrs.IntKey(1), + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example[1] will be destroyed + # (because resource does not use count) + - resource "test_instance" "example" {} +`, + }, + "delete because of wrong repetition mode (StringKey)": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseWrongRepetition, + Mode: addrs.ManagedResourceMode, + InstanceKey: addrs.StringKey("a"), + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example["a"] will be destroyed + # (because resource does not use for_each) + - resource "test_instance" "example" {} +`, + }, + "delete because no resource configuration": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseNoResourceConfig, + ModuleInst: addrs.RootModuleInstance.Child("foo", addrs.NoKey), + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # module.foo.test_instance.example will be destroyed + # (because test_instance.example is not in configuration) + - resource "test_instance" "example" {} +`, + }, + "delete because no module": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseNoModule, + ModuleInst: addrs.RootModuleInstance.Child("foo", addrs.IntKey(1)), + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # module.foo[1].test_instance.example will be destroyed + # (because module.foo[1] is not in configuration) + - resource "test_instance" "example" {} +`, + }, + "delete because out of range for count": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseCountIndex, + Mode: addrs.ManagedResourceMode, + InstanceKey: addrs.IntKey(1), + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example[1] will be destroyed + # (because index [1] is out of range for count) + - resource "test_instance" "example" {} +`, + }, + "delete because out of range for for_each": { + Action: plans.Delete, + ActionReason: plans.ResourceInstanceDeleteBecauseEachKey, + Mode: addrs.ManagedResourceMode, + InstanceKey: addrs.StringKey("boop"), + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example["boop"] will be destroyed + # (because key ["boop"] is not in for_each map) + - resource "test_instance" "example" {} +`, + }, + "replace for no particular reason (delete first)": { + Action: plans.DeleteThenCreate, + ActionReason: plans.ResourceInstanceChangeNoReason, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example must be replaced +-/+ resource "test_instance" "example" {} +`, + }, + "replace for no particular reason (create first)": { + Action: plans.CreateThenDelete, + ActionReason: plans.ResourceInstanceChangeNoReason, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example must be replaced ++/- resource "test_instance" "example" {} +`, + }, + "replace by request (delete first)": { + Action: plans.DeleteThenCreate, + ActionReason: plans.ResourceInstanceReplaceByRequest, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example will be replaced, as requested +-/+ resource "test_instance" "example" {} +`, + }, + "replace by request (create first)": { + Action: plans.CreateThenDelete, + ActionReason: plans.ResourceInstanceReplaceByRequest, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example will be replaced, as requested ++/- resource "test_instance" "example" {} +`, + }, + "replace because tainted (delete first)": { + Action: plans.DeleteThenCreate, + ActionReason: plans.ResourceInstanceReplaceBecauseTainted, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example is tainted, so must be replaced +-/+ resource "test_instance" "example" {} +`, + }, + "replace because tainted (create first)": { + Action: plans.CreateThenDelete, + ActionReason: plans.ResourceInstanceReplaceBecauseTainted, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + ExpectedOutput: ` # test_instance.example is tainted, so must be replaced ++/- resource "test_instance" "example" {} +`, + }, + "replace because cannot update (delete first)": { + Action: plans.DeleteThenCreate, + ActionReason: plans.ResourceInstanceReplaceBecauseCannotUpdate, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + // This one has no special message, because the fuller explanation + // typically appears inline as a "# forces replacement" comment. + // (not shown here) + ExpectedOutput: ` # test_instance.example must be replaced +-/+ resource "test_instance" "example" {} +`, + }, + "replace because cannot update (create first)": { + Action: plans.CreateThenDelete, + ActionReason: plans.ResourceInstanceReplaceBecauseCannotUpdate, + Mode: addrs.ManagedResourceMode, + Before: emptyVal, + After: nullVal, + Schema: emptySchema, + RequiredReplace: cty.NewPathSet(), + // This one has no special message, because the fuller explanation + // typically appears inline as a "# forces replacement" comment. + // (not shown here) + ExpectedOutput: ` # test_instance.example must be replaced ++/- resource "test_instance" "example" {} +`, + }, + } + + runTestCases(t, testCases) +} + func TestResourceChange_sensitiveVariable(t *testing.T) { testCases := map[string]testCase{ "creation": { @@ -4479,7 +4702,7 @@ func TestResourceChange_moved(t *testing.T) { }, RequiredReplace: cty.NewPathSet(), ExpectedOutput: ` # test_instance.example will be updated in-place - # (test_instance.previous has moved to test_instance.example) + # (moved from test_instance.previous) ~ resource "test_instance" "example" { ~ bar = "baz" -> "boop" id = "12345" @@ -4524,7 +4747,9 @@ func TestResourceChange_moved(t *testing.T) { type testCase struct { Action plans.Action ActionReason plans.ResourceInstanceChangeActionReason + ModuleInst addrs.ModuleInstance Mode addrs.ResourceMode + InstanceKey addrs.InstanceKey DeposedKey states.DeposedKey Before cty.Value BeforeValMarks []cty.PathValueMarks @@ -4571,7 +4796,7 @@ func runTestCases(t *testing.T, testCases map[string]testCase) { Mode: tc.Mode, Type: "test_instance", Name: "example", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance) + }.Instance(tc.InstanceKey).Absolute(tc.ModuleInst) prevRunAddr := tc.PrevRunAddr // If no previous run address is given, reuse the current address From 1bff623fd9578df46a64ac984d64195d1c30554c Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 23 Sep 2021 11:18:29 -0700 Subject: [PATCH 100/644] core: Report a warning if any moves get blocked In most cases Terraform will be able to automatically fully resolve all of the pending move statements before creating a plan, but there are some edge cases where we can end up wanting to move one object to a location where another object is already declared. One relatively-obvious example is if someone uses "terraform state mv" in order to create a set of resource instance bindings that could never have arising in normal Terraform use. A less obvious example arises from the interactions between moves at different levels of granularity. If we are both moving a module to a new address and moving a resource into an instance of the new module at the same time, the old module might well have already had a resource of the same name and so the resource move will be unresolvable. In these situations Terraform will move the objects as far as possible, but because it's never valid for a move "from" address to still be declared in the configuration Terraform will inevitably always plan to destroy the objects that didn't find a final home. To give some additional explanation for that result, here we'll add a warning which describes what happened. This is not a particularly actionable warning because we don't really have enough information to guess what the user intended, but we do at least prompt that they might be able to use the "terraform state" family of subcommands to repair the ambiguous situation before planning, if they want a different result than what Terraform proposed. --- internal/terraform/context_plan.go | 30 ++++++++ internal/terraform/context_plan2_test.go | 96 ++++++++++++++++++++++++ 2 files changed, 126 insertions(+) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index a48676ffa2bf..084a8ab8a782 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -1,6 +1,7 @@ package terraform import ( + "bytes" "fmt" "log" "sort" @@ -417,6 +418,14 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) diags = diags.Append(c.postPlanValidateMoves(config, moveStmts, walker.InstanceExpander.AllInstances())) + if len(moveResults.Blocked) > 0 && !diags.HasErrors() { + // If we had blocked moves and we're not going to be returning errors + // then we'll report the blockers as a warning. We do this only in the + // absense of errors because invalid move statements might well be + // the root cause of the blockers, and so better to give an actionable + // error message than a less-actionable warning. + diags = diags.Append(blockedMovesWarningDiag(moveResults)) + } prevRunState = walker.PrevRunState.Close() priorState := walker.RefreshState.Close() @@ -633,3 +642,24 @@ func (c *Context) PlanGraphForUI(config *configs.Config, prevRunState *states.St diags = diags.Append(moreDiags) return graph, diags } + +func blockedMovesWarningDiag(results refactoring.MoveResults) tfdiags.Diagnostic { + if len(results.Blocked) < 1 { + // Caller should check first + panic("request to render blocked moves warning without any blocked moves") + } + + var itemsBuf bytes.Buffer + for _, blocked := range results.Blocked { + fmt.Fprintf(&itemsBuf, "\n - %s could not move to %s", blocked.Actual, blocked.Wanted) + } + + return tfdiags.Sourceless( + tfdiags.Warning, + "Unresolved resource instance address changes", + fmt.Sprintf( + "Terraform tried to adjust resource instance addresses in the prior state based on change information recorded in the configuration, but some adjustments did not succeed due to existing objects already at the intended addresses:%s\n\nTerraform has planned to destroy these objects. If Terraform's proposed changes aren't appropriate, you must first resolve the conflicts using the \"terraform state\" subcommands and then create a new plan.", + itemsBuf.String(), + ), + ) +} diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 1167f234c00d..962142416590 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -791,6 +791,102 @@ func TestContext2Plan_movedResourceBasic(t *testing.T) { }) } +func TestContext2Plan_movedResourceCollision(t *testing.T) { + addrNoKey := mustResourceInstanceAddr("test_object.a") + addrZeroKey := mustResourceInstanceAddr("test_object.a[0]") + m := testModuleInline(t, map[string]string{ + "main.tf": ` + resource "test_object" "a" { + # No "count" set, so test_object.a[0] will want + # to implicitly move to test_object.a, but will get + # blocked by the existing object at that address. + } + `, + }) + + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent(addrNoKey, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + s.SetResourceInstanceCurrent(addrZeroKey, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + + p := simpleMockProvider() + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + }) + if diags.HasErrors() { + t.Fatalf("unexpected errors\n%s", diags.Err().Error()) + } + + // We should have a warning, though! We'll lightly abuse the "for RPC" + // feature of diagnostics to get some more-readily-comparable diagnostic + // values. + gotDiags := diags.ForRPC() + wantDiags := tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Warning, + "Unresolved resource instance address changes", + `Terraform tried to adjust resource instance addresses in the prior state based on change information recorded in the configuration, but some adjustments did not succeed due to existing objects already at the intended addresses: + - test_object.a[0] could not move to test_object.a + +Terraform has planned to destroy these objects. If Terraform's proposed changes aren't appropriate, you must first resolve the conflicts using the "terraform state" subcommands and then create a new plan.`, + ), + }.ForRPC() + if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { + t.Errorf("wrong diagnostics\n%s", diff) + } + + t.Run(addrNoKey.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrNoKey) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrNoKey) + } + + if got, want := instPlan.Addr, addrNoKey; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrNoKey; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.NoOp; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) + t.Run(addrZeroKey.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrZeroKey) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrZeroKey) + } + + if got, want := instPlan.Addr, addrZeroKey; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrZeroKey; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.Delete; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceDeleteBecauseWrongRepetition; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) +} + func TestContext2Plan_movedResourceUntargeted(t *testing.T) { addrA := mustResourceInstanceAddr("test_object.a") addrB := mustResourceInstanceAddr("test_object.b") From d97ef10bb8cc01ab6975590ea6a410a6f586a64e Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 23 Sep 2021 11:27:44 -0700 Subject: [PATCH 101/644] core: Don't return other errors if move statements are invalid Because our validation rules depend on some dynamic results produced by actually running the plan, we deal with moves in a "backwards" order where we try to apply them first -- ignoring anything strange we might find -- and then validate the original statements only after planning. An unfortunate consequence of that approach is that when the move statements are invalid it's likely that move execution will not fully complete, and so the generated plan is likely to be incorrect and might well include errors resulting from the unresolved moves. To mitigate that, here we let any move validation errors supersede all other diagnostics that the plan phase might've generated, in the hope that it'll help the user focus on fixing the incorrect move statements without creating confusing by reporting errors that only appeared as a quick of how Terraform worked around the invalid move statements earlier. --- internal/terraform/context_plan.go | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 084a8ab8a782..001a2507ad78 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -417,7 +417,18 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) - diags = diags.Append(c.postPlanValidateMoves(config, moveStmts, walker.InstanceExpander.AllInstances())) + moveValidateDiags := c.postPlanValidateMoves(config, moveStmts, walker.InstanceExpander.AllInstances()) + if moveValidateDiags.HasErrors() { + // If any of the move statements are invalid then those errors take + // precedence over any other errors because an incomplete move graph + // is quite likely to be the _cause_ of various errors. This oddity + // comes from the fact that we need to apply the moves before we + // actually validate them, because validation depends on the result + // of first trying to plan. + return nil, moveValidateDiags + } + diags = diags.Append(moveValidateDiags) // might just contain warnings + if len(moveResults.Blocked) > 0 && !diags.HasErrors() { // If we had blocked moves and we're not going to be returning errors // then we'll report the blockers as a warning. We do this only in the From 0f76e3a4e1eb1078ec19e17ea5834ea296365f93 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 23 Sep 2021 14:47:01 -0700 Subject: [PATCH 102/644] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 474e343fd2a0..60a318aba4e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ UPGRADE NOTES: NEW FEATURES: +* cli: When Terraform plans to destroy a resource instance due to it no longer being declared in the configuration, the proposed plan output will now include a note hinting at what situation prompted that proposal, so you can more easily see what configuration change might avoid the object being destroyed. ([#29637](https://github.com/hashicorp/terraform/pull/29637)) +* cli: When Terraform automatically moves a singleton resource instance to index zero or vice-versa in response to adding or removing `count`, it'll report explicitly that it did so as part of the plan output. ([#29605](https://github.com/hashicorp/terraform/pull/29605)) * cli: The (currently-experimental) `terraform add` generates a starting point for a particular resource configuration. ([#28874](https://github.com/hashicorp/terraform/issues/28874)) * config: a new `type()` function, only available in `terraform console` ([#28501](https://github.com/hashicorp/terraform/issues/28501)) From 5d620303eb1b6bb6562a634991f5a59bc79902ea Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 23 Sep 2021 14:47:40 -0700 Subject: [PATCH 103/644] Update CHANGELOG.md --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 60a318aba4e0..f5b11e243e4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,10 +7,10 @@ UPGRADE NOTES: NEW FEATURES: -* cli: When Terraform plans to destroy a resource instance due to it no longer being declared in the configuration, the proposed plan output will now include a note hinting at what situation prompted that proposal, so you can more easily see what configuration change might avoid the object being destroyed. ([#29637](https://github.com/hashicorp/terraform/pull/29637)) -* cli: When Terraform automatically moves a singleton resource instance to index zero or vice-versa in response to adding or removing `count`, it'll report explicitly that it did so as part of the plan output. ([#29605](https://github.com/hashicorp/terraform/pull/29605)) -* cli: The (currently-experimental) `terraform add` generates a starting point for a particular resource configuration. ([#28874](https://github.com/hashicorp/terraform/issues/28874)) -* config: a new `type()` function, only available in `terraform console` ([#28501](https://github.com/hashicorp/terraform/issues/28501)) +* `terraform plan` and `terraform apply`: When Terraform plans to destroy a resource instance due to it no longer being declared in the configuration, the proposed plan output will now include a note hinting at what situation prompted that proposal, so you can more easily see what configuration change might avoid the object being destroyed. ([#29637](https://github.com/hashicorp/terraform/pull/29637)) +* `terraform plan` and `terraform apply`: When Terraform automatically moves a singleton resource instance to index zero or vice-versa in response to adding or removing `count`, it'll report explicitly that it did so as part of the plan output. ([#29605](https://github.com/hashicorp/terraform/pull/29605)) +* `terraform add`: The (currently-experimental) `terraform add` generates a starting point for a particular resource configuration. ([#28874](https://github.com/hashicorp/terraform/issues/28874)) +* config: a new `type()` function, available only in `terraform console`. ([#28501](https://github.com/hashicorp/terraform/issues/28501)) ENHANCEMENTS: From 57318ef56117139b12de8fffcf36f527eb7b66ac Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 24 Sep 2021 09:26:09 -0400 Subject: [PATCH 104/644] backend/remote: Support interop from 0.14 to 1.1 The previous conservative guarantee that we would not make backwards incompatible changes to the state file format until at least Terraform 1.1 can now be extended. Terraform 0.14 through 1.1 will be able to interoperably use state files, so we can update the remote backend version compatibility check accordingly. --- internal/backend/remote/backend.go | 6 +++--- internal/backend/remote/backend_test.go | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/internal/backend/remote/backend.go b/internal/backend/remote/backend.go index b4aa115a798b..5e09e7207d3f 100644 --- a/internal/backend/remote/backend.go +++ b/internal/backend/remote/backend.go @@ -917,9 +917,9 @@ func (b *Remote) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.D // are aware of are: // // - 0.14.0 is guaranteed to be compatible with versions up to but not - // including 1.1.0 - v110 := version.Must(version.NewSemver("1.1.0")) - if tfversion.SemVer.LessThan(v110) && remoteVersion.LessThan(v110) { + // including 1.2.0 + v120 := version.Must(version.NewSemver("1.2.0")) + if tfversion.SemVer.LessThan(v120) && remoteVersion.LessThan(v120) { return diags } // - Any new Terraform state version will require at least minor patch diff --git a/internal/backend/remote/backend_test.go b/internal/backend/remote/backend_test.go index 3f0755a0e5ac..d00b61ae263d 100644 --- a/internal/backend/remote/backend_test.go +++ b/internal/backend/remote/backend_test.go @@ -566,7 +566,8 @@ func TestRemote_VerifyWorkspaceTerraformVersion(t *testing.T) { {"0.14.0", "0.13.5", false, false}, {"0.14.0", "0.14.1", true, false}, {"0.14.0", "1.0.99", true, false}, - {"0.14.0", "1.1.0", true, true}, + {"0.14.0", "1.1.0", true, false}, + {"0.14.0", "1.2.0", true, true}, {"1.2.0", "1.2.99", true, false}, {"1.2.0", "1.3.0", true, true}, {"0.15.0", "latest", true, false}, From 24a2bd630121cc3fd4dea49d79a63e70eb2de47b Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 14 Sep 2021 09:09:31 -0400 Subject: [PATCH 105/644] tfproto version 6.1 Minor version increase to deprecate min_items and max_items in nested types. Nested types have MinItems and MaxItems fields that were inherited from the block implementation, but were never validated by Terraform, and are not supported by the HCL decoder validations. Mark these fields as deprecated, indicating that the SDK should handle the required validation. --- docs/plugin-protocol/tfplugin6.1.proto | 321 +++++++++++++ internal/tfplugin6/tfplugin6.pb.go | 622 +++++++++++++------------ internal/tfplugin6/tfplugin6.proto | 2 +- 3 files changed, 635 insertions(+), 310 deletions(-) create mode 100644 docs/plugin-protocol/tfplugin6.1.proto diff --git a/docs/plugin-protocol/tfplugin6.1.proto b/docs/plugin-protocol/tfplugin6.1.proto new file mode 100644 index 000000000000..e8912cd0b799 --- /dev/null +++ b/docs/plugin-protocol/tfplugin6.1.proto @@ -0,0 +1,321 @@ +// Terraform Plugin RPC protocol version 6.1 +// +// This file defines version 6.1 of the RPC protocol. To implement a plugin +// against this protocol, copy this definition into your own codebase and +// use protoc to generate stubs for your target language. +// +// This file will not be updated. Any minor versions of protocol 6 to follow +// should copy this file and modify the copy while maintaing backwards +// compatibility. Breaking changes, if any are required, will come +// in a subsequent major version with its own separate proto definition. +// +// Note that only the proto files included in a release tag of Terraform are +// official protocol releases. Proto files taken from other commits may include +// incomplete changes or features that did not make it into a final release. +// In all reasonable cases, plugin developers should take the proto file from +// the tag of the most recent release of Terraform, and not from the main +// branch or any other development branch. +// +syntax = "proto3"; +option go_package = "github.com/hashicorp/terraform/internal/tfplugin6"; + +package tfplugin6; + +// DynamicValue is an opaque encoding of terraform data, with the field name +// indicating the encoding scheme used. +message DynamicValue { + bytes msgpack = 1; + bytes json = 2; +} + +message Diagnostic { + enum Severity { + INVALID = 0; + ERROR = 1; + WARNING = 2; + } + Severity severity = 1; + string summary = 2; + string detail = 3; + AttributePath attribute = 4; +} + +message AttributePath { + message Step { + oneof selector { + // Set "attribute_name" to represent looking up an attribute + // in the current object value. + string attribute_name = 1; + // Set "element_key_*" to represent looking up an element in + // an indexable collection type. + string element_key_string = 2; + int64 element_key_int = 3; + } + } + repeated Step steps = 1; +} + +message StopProvider { + message Request { + } + message Response { + string Error = 1; + } +} + +// RawState holds the stored state for a resource to be upgraded by the +// provider. It can be in one of two formats, the current json encoded format +// in bytes, or the legacy flatmap format as a map of strings. +message RawState { + bytes json = 1; + map flatmap = 2; +} + +enum StringKind { + PLAIN = 0; + MARKDOWN = 1; +} + +// Schema is the configuration schema for a Resource or Provider. +message Schema { + message Block { + int64 version = 1; + repeated Attribute attributes = 2; + repeated NestedBlock block_types = 3; + string description = 4; + StringKind description_kind = 5; + bool deprecated = 6; + } + + message Attribute { + string name = 1; + bytes type = 2; + Object nested_type = 10; + string description = 3; + bool required = 4; + bool optional = 5; + bool computed = 6; + bool sensitive = 7; + StringKind description_kind = 8; + bool deprecated = 9; + } + + message NestedBlock { + enum NestingMode { + INVALID = 0; + SINGLE = 1; + LIST = 2; + SET = 3; + MAP = 4; + GROUP = 5; + } + + string type_name = 1; + Block block = 2; + NestingMode nesting = 3; + int64 min_items = 4; + int64 max_items = 5; + } + + message Object { + enum NestingMode { + INVALID = 0; + SINGLE = 1; + LIST = 2; + SET = 3; + MAP = 4; + } + + repeated Attribute attributes = 1; + NestingMode nesting = 3; + int64 min_items = 4 [deprecated = true]; + int64 max_items = 5 [deprecated = true]; + } + + // The version of the schema. + // Schemas are versioned, so that providers can upgrade a saved resource + // state when the schema is changed. + int64 version = 1; + + // Block is the top level configuration block for this schema. + Block block = 2; +} + +service Provider { + //////// Information about what a provider supports/expects + rpc GetProviderSchema(GetProviderSchema.Request) returns (GetProviderSchema.Response); + rpc ValidateProviderConfig(ValidateProviderConfig.Request) returns (ValidateProviderConfig.Response); + rpc ValidateResourceConfig(ValidateResourceConfig.Request) returns (ValidateResourceConfig.Response); + rpc ValidateDataResourceConfig(ValidateDataResourceConfig.Request) returns (ValidateDataResourceConfig.Response); + rpc UpgradeResourceState(UpgradeResourceState.Request) returns (UpgradeResourceState.Response); + + //////// One-time initialization, called before other functions below + rpc ConfigureProvider(ConfigureProvider.Request) returns (ConfigureProvider.Response); + + //////// Managed Resource Lifecycle + rpc ReadResource(ReadResource.Request) returns (ReadResource.Response); + rpc PlanResourceChange(PlanResourceChange.Request) returns (PlanResourceChange.Response); + rpc ApplyResourceChange(ApplyResourceChange.Request) returns (ApplyResourceChange.Response); + rpc ImportResourceState(ImportResourceState.Request) returns (ImportResourceState.Response); + + rpc ReadDataSource(ReadDataSource.Request) returns (ReadDataSource.Response); + + //////// Graceful Shutdown + rpc StopProvider(StopProvider.Request) returns (StopProvider.Response); +} + +message GetProviderSchema { + message Request { + } + message Response { + Schema provider = 1; + map resource_schemas = 2; + map data_source_schemas = 3; + repeated Diagnostic diagnostics = 4; + Schema provider_meta = 5; + } +} + +message ValidateProviderConfig { + message Request { + DynamicValue config = 1; + } + message Response { + repeated Diagnostic diagnostics = 2; + } +} + +message UpgradeResourceState { + message Request { + string type_name = 1; + + // version is the schema_version number recorded in the state file + int64 version = 2; + + // raw_state is the raw states as stored for the resource. Core does + // not have access to the schema of prior_version, so it's the + // provider's responsibility to interpret this value using the + // appropriate older schema. The raw_state will be the json encoded + // state, or a legacy flat-mapped format. + RawState raw_state = 3; + } + message Response { + // new_state is a msgpack-encoded data structure that, when interpreted with + // the _current_ schema for this resource type, is functionally equivalent to + // that which was given in prior_state_raw. + DynamicValue upgraded_state = 1; + + // diagnostics describes any errors encountered during migration that could not + // be safely resolved, and warnings about any possibly-risky assumptions made + // in the upgrade process. + repeated Diagnostic diagnostics = 2; + } +} + +message ValidateResourceConfig { + message Request { + string type_name = 1; + DynamicValue config = 2; + } + message Response { + repeated Diagnostic diagnostics = 1; + } +} + +message ValidateDataResourceConfig { + message Request { + string type_name = 1; + DynamicValue config = 2; + } + message Response { + repeated Diagnostic diagnostics = 1; + } +} + +message ConfigureProvider { + message Request { + string terraform_version = 1; + DynamicValue config = 2; + } + message Response { + repeated Diagnostic diagnostics = 1; + } +} + +message ReadResource { + message Request { + string type_name = 1; + DynamicValue current_state = 2; + bytes private = 3; + DynamicValue provider_meta = 4; + } + message Response { + DynamicValue new_state = 1; + repeated Diagnostic diagnostics = 2; + bytes private = 3; + } +} + +message PlanResourceChange { + message Request { + string type_name = 1; + DynamicValue prior_state = 2; + DynamicValue proposed_new_state = 3; + DynamicValue config = 4; + bytes prior_private = 5; + DynamicValue provider_meta = 6; + } + + message Response { + DynamicValue planned_state = 1; + repeated AttributePath requires_replace = 2; + bytes planned_private = 3; + repeated Diagnostic diagnostics = 4; + } +} + +message ApplyResourceChange { + message Request { + string type_name = 1; + DynamicValue prior_state = 2; + DynamicValue planned_state = 3; + DynamicValue config = 4; + bytes planned_private = 5; + DynamicValue provider_meta = 6; + } + message Response { + DynamicValue new_state = 1; + bytes private = 2; + repeated Diagnostic diagnostics = 3; + } +} + +message ImportResourceState { + message Request { + string type_name = 1; + string id = 2; + } + + message ImportedResource { + string type_name = 1; + DynamicValue state = 2; + bytes private = 3; + } + + message Response { + repeated ImportedResource imported_resources = 1; + repeated Diagnostic diagnostics = 2; + } +} + +message ReadDataSource { + message Request { + string type_name = 1; + DynamicValue config = 2; + DynamicValue provider_meta = 3; + } + message Response { + DynamicValue state = 1; + repeated Diagnostic diagnostics = 2; + } +} diff --git a/internal/tfplugin6/tfplugin6.pb.go b/internal/tfplugin6/tfplugin6.pb.go index afd77a0eedbb..d3152b355b58 100644 --- a/internal/tfplugin6/tfplugin6.pb.go +++ b/internal/tfplugin6/tfplugin6.pb.go @@ -1,6 +1,6 @@ -// Terraform Plugin RPC protocol version 6.0 +// Terraform Plugin RPC protocol version 6.1 // -// This file defines version 6.0 of the RPC protocol. To implement a plugin +// This file defines version 6.1 of the RPC protocol. To implement a plugin // against this protocol, copy this definition into your own codebase and // use protoc to generate stubs for your target language. // @@ -1480,8 +1480,10 @@ type Schema_Object struct { Attributes []*Schema_Attribute `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes,omitempty"` Nesting Schema_Object_NestingMode `protobuf:"varint,3,opt,name=nesting,proto3,enum=tfplugin6.Schema_Object_NestingMode" json:"nesting,omitempty"` - MinItems int64 `protobuf:"varint,4,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"` - MaxItems int64 `protobuf:"varint,5,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"` + // Deprecated: Do not use. + MinItems int64 `protobuf:"varint,4,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"` + // Deprecated: Do not use. + MaxItems int64 `protobuf:"varint,5,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"` } func (x *Schema_Object) Reset() { @@ -1530,6 +1532,7 @@ func (x *Schema_Object) GetNesting() Schema_Object_NestingMode { return Schema_Object_INVALID } +// Deprecated: Do not use. func (x *Schema_Object) GetMinItems() int64 { if x != nil { return x.MinItems @@ -1537,6 +1540,7 @@ func (x *Schema_Object) GetMinItems() int64 { return 0 } +// Deprecated: Do not use. func (x *Schema_Object) GetMaxItems() int64 { if x != nil { return x.MaxItems @@ -2974,7 +2978,7 @@ var file_tfplugin6_proto_rawDesc = []byte{ 0x74, 0x6d, 0x61, 0x70, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x14, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, - 0x65, 0x3a, 0x02, 0x38, 0x01, 0x22, 0x8d, 0x0a, 0x0a, 0x06, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, + 0x65, 0x3a, 0x02, 0x38, 0x01, 0x22, 0x95, 0x0a, 0x0a, 0x06, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x12, 0x18, 0x0a, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, 0x03, 0x52, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x2d, 0x0a, 0x05, 0x62, 0x6c, 0x6f, 0x63, 0x6b, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, @@ -3039,7 +3043,7 @@ var file_tfplugin6_proto_rawDesc = []byte{ 0x53, 0x49, 0x4e, 0x47, 0x4c, 0x45, 0x10, 0x01, 0x12, 0x08, 0x0a, 0x04, 0x4c, 0x49, 0x53, 0x54, 0x10, 0x02, 0x12, 0x07, 0x0a, 0x03, 0x53, 0x45, 0x54, 0x10, 0x03, 0x12, 0x07, 0x0a, 0x03, 0x4d, 0x41, 0x50, 0x10, 0x04, 0x12, 0x09, 0x0a, 0x05, 0x47, 0x52, 0x4f, 0x55, 0x50, 0x10, 0x05, 0x1a, - 0x83, 0x02, 0x0a, 0x06, 0x4f, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x12, 0x3b, 0x0a, 0x0a, 0x61, 0x74, + 0x8b, 0x02, 0x0a, 0x06, 0x4f, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x12, 0x3b, 0x0a, 0x0a, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x1b, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x41, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x52, 0x0a, 0x61, 0x74, 0x74, @@ -3047,328 +3051,328 @@ var file_tfplugin6_proto_rawDesc = []byte{ 0x6e, 0x67, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x4f, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x2e, 0x4e, 0x65, 0x73, 0x74, 0x69, 0x6e, 0x67, 0x4d, 0x6f, 0x64, 0x65, 0x52, 0x07, - 0x6e, 0x65, 0x73, 0x74, 0x69, 0x6e, 0x67, 0x12, 0x1b, 0x0a, 0x09, 0x6d, 0x69, 0x6e, 0x5f, 0x69, - 0x74, 0x65, 0x6d, 0x73, 0x18, 0x04, 0x20, 0x01, 0x28, 0x03, 0x52, 0x08, 0x6d, 0x69, 0x6e, 0x49, - 0x74, 0x65, 0x6d, 0x73, 0x12, 0x1b, 0x0a, 0x09, 0x6d, 0x61, 0x78, 0x5f, 0x69, 0x74, 0x65, 0x6d, - 0x73, 0x18, 0x05, 0x20, 0x01, 0x28, 0x03, 0x52, 0x08, 0x6d, 0x61, 0x78, 0x49, 0x74, 0x65, 0x6d, - 0x73, 0x22, 0x42, 0x0a, 0x0b, 0x4e, 0x65, 0x73, 0x74, 0x69, 0x6e, 0x67, 0x4d, 0x6f, 0x64, 0x65, - 0x12, 0x0b, 0x0a, 0x07, 0x49, 0x4e, 0x56, 0x41, 0x4c, 0x49, 0x44, 0x10, 0x00, 0x12, 0x0a, 0x0a, - 0x06, 0x53, 0x49, 0x4e, 0x47, 0x4c, 0x45, 0x10, 0x01, 0x12, 0x08, 0x0a, 0x04, 0x4c, 0x49, 0x53, - 0x54, 0x10, 0x02, 0x12, 0x07, 0x0a, 0x03, 0x53, 0x45, 0x54, 0x10, 0x03, 0x12, 0x07, 0x0a, 0x03, - 0x4d, 0x41, 0x50, 0x10, 0x04, 0x22, 0xd0, 0x04, 0x0a, 0x11, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, - 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x1a, 0x09, 0x0a, 0x07, 0x52, - 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0xaf, 0x04, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, - 0x6e, 0x73, 0x65, 0x12, 0x2d, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, - 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, - 0x65, 0x72, 0x12, 0x65, 0x0a, 0x10, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x5f, 0x73, - 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x3a, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, - 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, - 0x6e, 0x73, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, - 0x6d, 0x61, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x52, 0x0f, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, - 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x12, 0x6c, 0x0a, 0x13, 0x64, 0x61, 0x74, - 0x61, 0x5f, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x5f, 0x73, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, - 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x3c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, - 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, - 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x2e, 0x44, 0x61, - 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x45, - 0x6e, 0x74, 0x72, 0x79, 0x52, 0x11, 0x64, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, - 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, - 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, - 0x12, 0x36, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, - 0x61, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, - 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x55, 0x0a, 0x14, 0x52, 0x65, 0x73, 0x6f, + 0x6e, 0x65, 0x73, 0x74, 0x69, 0x6e, 0x67, 0x12, 0x1f, 0x0a, 0x09, 0x6d, 0x69, 0x6e, 0x5f, 0x69, + 0x74, 0x65, 0x6d, 0x73, 0x18, 0x04, 0x20, 0x01, 0x28, 0x03, 0x42, 0x02, 0x18, 0x01, 0x52, 0x08, + 0x6d, 0x69, 0x6e, 0x49, 0x74, 0x65, 0x6d, 0x73, 0x12, 0x1f, 0x0a, 0x09, 0x6d, 0x61, 0x78, 0x5f, + 0x69, 0x74, 0x65, 0x6d, 0x73, 0x18, 0x05, 0x20, 0x01, 0x28, 0x03, 0x42, 0x02, 0x18, 0x01, 0x52, + 0x08, 0x6d, 0x61, 0x78, 0x49, 0x74, 0x65, 0x6d, 0x73, 0x22, 0x42, 0x0a, 0x0b, 0x4e, 0x65, 0x73, + 0x74, 0x69, 0x6e, 0x67, 0x4d, 0x6f, 0x64, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x49, 0x4e, 0x56, 0x41, + 0x4c, 0x49, 0x44, 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, 0x53, 0x49, 0x4e, 0x47, 0x4c, 0x45, 0x10, + 0x01, 0x12, 0x08, 0x0a, 0x04, 0x4c, 0x49, 0x53, 0x54, 0x10, 0x02, 0x12, 0x07, 0x0a, 0x03, 0x53, + 0x45, 0x54, 0x10, 0x03, 0x12, 0x07, 0x0a, 0x03, 0x4d, 0x41, 0x50, 0x10, 0x04, 0x22, 0xd0, 0x04, + 0x0a, 0x11, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, + 0x65, 0x6d, 0x61, 0x1a, 0x09, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0xaf, + 0x04, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x2d, 0x0a, 0x08, 0x70, + 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, + 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x65, 0x0a, 0x10, 0x72, 0x65, + 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x5f, 0x73, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x18, 0x02, + 0x20, 0x03, 0x28, 0x0b, 0x32, 0x3a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, + 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, - 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, - 0x65, 0x79, 0x12, 0x27, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, - 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, - 0x68, 0x65, 0x6d, 0x61, 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x1a, - 0x57, 0x0a, 0x16, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, - 0x65, 0x6d, 0x61, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, - 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x27, 0x0a, 0x05, 0x76, - 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, - 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x52, 0x05, 0x76, - 0x61, 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x22, 0x99, 0x01, 0x0a, 0x16, 0x56, 0x61, 0x6c, - 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, - 0x66, 0x69, 0x67, 0x1a, 0x3a, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x2f, - 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, - 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, - 0x43, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, - 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, - 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, - 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, - 0x74, 0x69, 0x63, 0x73, 0x22, 0x90, 0x02, 0x0a, 0x14, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x1a, 0x72, 0x0a, - 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, - 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, - 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, - 0x18, 0x02, 0x20, 0x01, 0x28, 0x03, 0x52, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, - 0x30, 0x0a, 0x09, 0x72, 0x61, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, - 0x28, 0x0b, 0x32, 0x13, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, - 0x61, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x52, 0x08, 0x72, 0x61, 0x77, 0x53, 0x74, 0x61, 0x74, - 0x65, 0x1a, 0x83, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x3e, - 0x0a, 0x0e, 0x75, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, + 0x52, 0x0f, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, + 0x73, 0x12, 0x6c, 0x0a, 0x13, 0x64, 0x61, 0x74, 0x61, 0x5f, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x5f, 0x73, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x3c, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, + 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, + 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x2e, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x52, 0x11, 0x64, 0x61, + 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x12, + 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x04, + 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, + 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x12, 0x36, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, + 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0b, 0x32, + 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, + 0x6d, 0x61, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, + 0x1a, 0x55, 0x0a, 0x14, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, + 0x6d, 0x61, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, + 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x27, 0x0a, 0x05, 0x76, 0x61, + 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x52, 0x05, 0x76, 0x61, + 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x1a, 0x57, 0x0a, 0x16, 0x44, 0x61, 0x74, 0x61, 0x53, + 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x73, 0x45, 0x6e, 0x74, 0x72, + 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, + 0x6b, 0x65, 0x79, 0x12, 0x27, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, + 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, + 0x63, 0x68, 0x65, 0x6d, 0x61, 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, + 0x22, 0x99, 0x01, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, + 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x3a, 0x0a, 0x07, 0x52, + 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, - 0x0d, 0x75, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x37, - 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, - 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, - 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, - 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xb6, 0x01, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, - 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, - 0x69, 0x67, 0x1a, 0x57, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, - 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, - 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, - 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, - 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, - 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x43, 0x0a, 0x08, 0x52, - 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, - 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, - 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, - 0x22, 0xba, 0x01, 0x0a, 0x1a, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, - 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, - 0x57, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, - 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, - 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, - 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, - 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x43, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, - 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, - 0x69, 0x63, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, - 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xc1, 0x01, - 0x0a, 0x11, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, - 0x64, 0x65, 0x72, 0x1a, 0x67, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x2b, - 0x0a, 0x11, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x5f, 0x76, 0x65, 0x72, 0x73, - 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x10, 0x74, 0x65, 0x72, 0x72, 0x61, - 0x66, 0x6f, 0x72, 0x6d, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x2f, 0x0a, 0x06, 0x63, - 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, - 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x43, 0x0a, 0x08, - 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, - 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, - 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, - 0x73, 0x22, 0xe3, 0x02, 0x0a, 0x0c, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, - 0x63, 0x65, 0x1a, 0xbc, 0x01, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, - 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, - 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x63, - 0x75, 0x72, 0x72, 0x65, 0x6e, 0x74, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, + 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x43, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, + 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, + 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0x90, 0x02, 0x0a, + 0x14, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x53, 0x74, 0x61, 0x74, 0x65, 0x1a, 0x72, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, + 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x18, 0x0a, + 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x02, 0x20, 0x01, 0x28, 0x03, 0x52, 0x07, + 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x30, 0x0a, 0x09, 0x72, 0x61, 0x77, 0x5f, 0x73, + 0x74, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x13, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x61, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x52, + 0x08, 0x72, 0x61, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x1a, 0x83, 0x01, 0x0a, 0x08, 0x52, 0x65, + 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x3e, 0x0a, 0x0e, 0x75, 0x70, 0x67, 0x72, 0x61, 0x64, + 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, + 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0d, 0x75, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, + 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, + 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, + 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, + 0xb6, 0x01, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, + 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x57, 0x0a, 0x07, 0x52, 0x65, + 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, + 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, + 0x6d, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, - 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x63, 0x75, 0x72, - 0x72, 0x65, 0x6e, 0x74, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, - 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, - 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, - 0x6d, 0x65, 0x74, 0x61, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, + 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, + 0x66, 0x69, 0x67, 0x1a, 0x43, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, + 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x01, + 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, + 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xba, 0x01, 0x0a, 0x1a, 0x56, 0x61, 0x6c, + 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x57, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, + 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, + 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, + 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, + 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, + 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, + 0x1a, 0x43, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x37, 0x0a, 0x0b, + 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, + 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, + 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, + 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xc1, 0x01, 0x0a, 0x11, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, + 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x1a, 0x67, 0x0a, 0x07, 0x52, + 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x2b, 0x0a, 0x11, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, + 0x6f, 0x72, 0x6d, 0x5f, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, + 0x09, 0x52, 0x10, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x56, 0x65, 0x72, 0x73, + 0x69, 0x6f, 0x6e, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, + 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, + 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, + 0x6e, 0x66, 0x69, 0x67, 0x1a, 0x43, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, + 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, + 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xe3, 0x02, 0x0a, 0x0c, 0x52, 0x65, + 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x1a, 0xbc, 0x01, 0x0a, 0x07, 0x52, + 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, + 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, + 0x61, 0x6d, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x63, 0x75, 0x72, 0x72, 0x65, 0x6e, 0x74, 0x5f, 0x73, + 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, - 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, - 0x61, 0x1a, 0x93, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x34, - 0x0a, 0x09, 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, - 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, - 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x08, 0x6e, 0x65, 0x77, 0x53, - 0x74, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, - 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, - 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x12, 0x18, 0x0a, - 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, - 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x22, 0xc4, 0x04, 0x0a, 0x12, 0x50, 0x6c, 0x61, 0x6e, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xbb, + 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x63, 0x75, 0x72, 0x72, 0x65, 0x6e, 0x74, 0x53, 0x74, 0x61, 0x74, + 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, + 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, + 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x04, 0x20, 0x01, + 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, + 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, + 0x76, 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x93, 0x01, 0x0a, 0x08, 0x52, 0x65, + 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x34, 0x0a, 0x09, 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, + 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, + 0x75, 0x65, 0x52, 0x08, 0x6e, 0x65, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, + 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, + 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, + 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, + 0x73, 0x74, 0x69, 0x63, 0x73, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, + 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x22, + 0xc4, 0x04, 0x0a, 0x12, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xbb, 0x02, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, + 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, + 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, + 0x38, 0x0a, 0x0b, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, + 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0a, 0x70, + 0x72, 0x69, 0x6f, 0x72, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x45, 0x0a, 0x12, 0x70, 0x72, 0x6f, + 0x70, 0x6f, 0x73, 0x65, 0x64, 0x5f, 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, + 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x10, + 0x70, 0x72, 0x6f, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x4e, 0x65, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, + 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, + 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, + 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, + 0x67, 0x12, 0x23, 0x0a, 0x0d, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x5f, 0x70, 0x72, 0x69, 0x76, 0x61, + 0x74, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x0c, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x50, + 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, + 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, + 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, + 0x4d, 0x65, 0x74, 0x61, 0x1a, 0xef, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, + 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, + 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, + 0x65, 0x52, 0x0c, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, + 0x43, 0x0a, 0x10, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x73, 0x5f, 0x72, 0x65, 0x70, 0x6c, + 0x61, 0x63, 0x65, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x18, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x41, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x50, + 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x73, 0x52, 0x65, 0x70, + 0x6c, 0x61, 0x63, 0x65, 0x12, 0x27, 0x0a, 0x0f, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, + 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x0e, 0x70, + 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x50, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, + 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x04, 0x20, 0x03, + 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, + 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, + 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xe4, 0x03, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, + 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xb6, 0x02, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x38, 0x0a, 0x0b, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0a, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x53, 0x74, 0x61, 0x74, - 0x65, 0x12, 0x45, 0x0a, 0x12, 0x70, 0x72, 0x6f, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x5f, 0x6e, 0x65, - 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, - 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x10, 0x70, 0x72, 0x6f, 0x70, 0x6f, 0x73, 0x65, 0x64, - 0x4e, 0x65, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, - 0x69, 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, + 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, - 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x23, 0x0a, 0x0d, 0x70, 0x72, 0x69, - 0x6f, 0x72, 0x5f, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0c, - 0x52, 0x0c, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x50, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x3c, - 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, - 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, - 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0xef, 0x01, 0x0a, - 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, - 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, - 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, - 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x6c, 0x61, 0x6e, 0x6e, - 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x43, 0x0a, 0x10, 0x72, 0x65, 0x71, 0x75, 0x69, - 0x72, 0x65, 0x73, 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x18, 0x02, 0x20, 0x03, 0x28, - 0x0b, 0x32, 0x18, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x41, 0x74, - 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x50, 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, 0x71, - 0x75, 0x69, 0x72, 0x65, 0x73, 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x12, 0x27, 0x0a, 0x0f, - 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, - 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x50, 0x72, - 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, - 0x74, 0x69, 0x63, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, - 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, - 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xe4, - 0x03, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xb6, 0x02, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, - 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, - 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, - 0x38, 0x0a, 0x0b, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, - 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, - 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0a, 0x70, - 0x72, 0x69, 0x6f, 0x72, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, - 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, + 0x65, 0x52, 0x0c, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, + 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32, + 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, + 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, + 0x12, 0x27, 0x0a, 0x0f, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x70, 0x72, 0x69, 0x76, + 0x61, 0x74, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x6e, + 0x65, 0x64, 0x50, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, + 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, - 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x6c, 0x61, 0x6e, 0x6e, - 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, - 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, + 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x93, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, + 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x34, 0x0a, 0x09, 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, + 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, - 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x27, 0x0a, 0x0f, 0x70, 0x6c, 0x61, 0x6e, - 0x6e, 0x65, 0x64, 0x5f, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, - 0x0c, 0x52, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x50, 0x72, 0x69, 0x76, 0x61, 0x74, - 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, - 0x74, 0x61, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, - 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, - 0x93, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x34, 0x0a, 0x09, - 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, - 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, - 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x08, 0x6e, 0x65, 0x77, 0x53, 0x74, 0x61, - 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, - 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, - 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, - 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, - 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, - 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xed, 0x02, 0x0a, 0x13, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x1a, 0x36, 0x0a, - 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, - 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, - 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x0e, 0x0a, 0x02, 0x69, 0x64, 0x18, 0x02, 0x20, 0x01, 0x28, - 0x09, 0x52, 0x02, 0x69, 0x64, 0x1a, 0x78, 0x0a, 0x10, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, - 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, - 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, - 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2d, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, - 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, - 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, - 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x1a, - 0xa3, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x5e, 0x0a, 0x12, - 0x69, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x5f, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, - 0x65, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x2f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, - 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, - 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x52, 0x11, 0x69, 0x6d, 0x70, 0x6f, 0x72, - 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x73, 0x12, 0x37, 0x0a, 0x0b, - 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, - 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, - 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, - 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0x9c, 0x02, 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, - 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x1a, 0x95, 0x01, 0x0a, 0x07, 0x52, 0x65, 0x71, - 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, - 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, - 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, - 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, - 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, - 0x69, 0x67, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, - 0x65, 0x74, 0x61, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x52, 0x08, 0x6e, 0x65, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, + 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, + 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, + 0x69, 0x63, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, + 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xed, 0x02, + 0x0a, 0x13, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x53, 0x74, 0x61, 0x74, 0x65, 0x1a, 0x36, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, + 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x0e, 0x0a, + 0x02, 0x69, 0x64, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x69, 0x64, 0x1a, 0x78, 0x0a, + 0x10, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, + 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2d, + 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, + 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, + 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, + 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x1a, 0xa3, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, + 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x5e, 0x0a, 0x12, 0x69, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, + 0x5f, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, + 0x32, 0x2f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, + 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, + 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x52, 0x11, 0x69, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x73, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, + 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, + 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0x9c, 0x02, + 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x1a, 0x95, 0x01, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, + 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, + 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, + 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, - 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, - 0x1a, 0x72, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x2d, 0x0a, 0x05, - 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, - 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, - 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, - 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, - 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, - 0x74, 0x69, 0x63, 0x73, 0x2a, 0x25, 0x0a, 0x0a, 0x53, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x4b, 0x69, - 0x6e, 0x64, 0x12, 0x09, 0x0a, 0x05, 0x50, 0x4c, 0x41, 0x49, 0x4e, 0x10, 0x00, 0x12, 0x0c, 0x0a, - 0x08, 0x4d, 0x41, 0x52, 0x4b, 0x44, 0x4f, 0x57, 0x4e, 0x10, 0x01, 0x32, 0xcc, 0x09, 0x0a, 0x08, - 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x60, 0x0a, 0x11, 0x47, 0x65, 0x74, 0x50, - 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x12, 0x24, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, - 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x71, 0x75, - 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, - 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, - 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x6f, 0x0a, 0x16, 0x56, 0x61, - 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, - 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, - 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, - 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, - 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, - 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, - 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x6f, 0x0a, 0x16, 0x56, - 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, - 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, - 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, - 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, - 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, - 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x7b, 0x0a, 0x1a, - 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, - 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x2d, 0x2e, 0x74, 0x66, 0x70, - 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, - 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, - 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2e, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, - 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, - 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x69, 0x0a, 0x14, 0x55, 0x70, 0x67, - 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, - 0x65, 0x12, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, 0x70, - 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, - 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x28, 0x2e, 0x74, 0x66, 0x70, - 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, - 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, - 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x60, 0x0a, 0x11, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, - 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, - 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, - 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, 0x6e, 0x66, - 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, - 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x51, 0x0a, 0x0c, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, - 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x1f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, - 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, - 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x63, 0x0a, 0x12, 0x50, 0x6c, 0x61, - 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, - 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, - 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, - 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, - 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, - 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, - 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, - 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, + 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, + 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x03, 0x20, 0x01, 0x28, + 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, + 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, + 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x72, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, + 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x2d, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, + 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, + 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, + 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, + 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x2a, 0x25, 0x0a, 0x0a, + 0x53, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x4b, 0x69, 0x6e, 0x64, 0x12, 0x09, 0x0a, 0x05, 0x50, 0x4c, + 0x41, 0x49, 0x4e, 0x10, 0x00, 0x12, 0x0c, 0x0a, 0x08, 0x4d, 0x41, 0x52, 0x4b, 0x44, 0x4f, 0x57, + 0x4e, 0x10, 0x01, 0x32, 0xcc, 0x09, 0x0a, 0x08, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, + 0x12, 0x60, 0x0a, 0x11, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, + 0x63, 0x68, 0x65, 0x6d, 0x61, 0x12, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, + 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, + 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, + 0x73, 0x65, 0x12, 0x6f, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, + 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, 0x74, + 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, + 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, + 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x12, 0x6f, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, + 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, + 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, + 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, + 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, + 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x7b, 0x0a, 0x1a, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, + 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, + 0x69, 0x67, 0x12, 0x2d, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, + 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, + 0x74, 0x1a, 0x2e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, + 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, + 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, + 0x65, 0x12, 0x69, 0x0a, 0x14, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, + 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, + 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, + 0x73, 0x74, 0x1a, 0x28, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, + 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, + 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x60, 0x0a, 0x11, + 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, + 0x72, 0x12, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, + 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, + 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x51, + 0x0a, 0x0c, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x1f, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x52, + 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, + 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, + 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, + 0x65, 0x12, 0x63, 0x0a, 0x12, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x52, + 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, + 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, + 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, - 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, 0x0a, 0x13, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x26, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, + 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, + 0x0a, 0x13, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x57, - 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x12, 0x21, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, - 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, - 0x65, 0x73, 0x74, 0x1a, 0x22, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, - 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, - 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x51, 0x0a, 0x0c, 0x53, 0x74, 0x6f, 0x70, 0x50, - 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x1f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, - 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, - 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x42, 0x33, 0x5a, 0x31, 0x67, 0x69, - 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, - 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, - 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x62, - 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, + 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, + 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x57, 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, + 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x21, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x22, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, + 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, + 0x51, 0x0a, 0x0c, 0x53, 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, + 0x1f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, 0x70, + 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, + 0x1a, 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, + 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, + 0x73, 0x65, 0x42, 0x33, 0x5a, 0x31, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, + 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, + 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x74, 0x66, + 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( diff --git a/internal/tfplugin6/tfplugin6.proto b/internal/tfplugin6/tfplugin6.proto index ae47060038b5..70bb64b942f0 120000 --- a/internal/tfplugin6/tfplugin6.proto +++ b/internal/tfplugin6/tfplugin6.proto @@ -1 +1 @@ -../../docs/plugin-protocol/tfplugin6.0.proto \ No newline at end of file +../../docs/plugin-protocol/tfplugin6.1.proto \ No newline at end of file From 9847eaa9cfb0be406845d04477e160f45d6cf5f5 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 24 Sep 2021 12:26:00 -0400 Subject: [PATCH 106/644] remove usage of MinItems/MaxItems MinItems and MaxItems are not used on nested types in the protocol, so remove their usage in Terraform to prevent future confusion. --- internal/command/jsonprovider/attribute.go | 4 ---- internal/configs/configschema/decoder_spec.go | 6 +----- .../configs/configschema/internal_validate.go | 16 ++-------------- .../configschema/internal_validate_test.go | 15 --------------- internal/configs/configschema/schema.go | 7 ------- internal/plugin6/convert/schema.go | 4 ---- internal/plugin6/convert/schema_test.go | 2 -- 7 files changed, 3 insertions(+), 51 deletions(-) diff --git a/internal/command/jsonprovider/attribute.go b/internal/command/jsonprovider/attribute.go index 803e4e5f0a92..9425cd9e5893 100644 --- a/internal/command/jsonprovider/attribute.go +++ b/internal/command/jsonprovider/attribute.go @@ -22,8 +22,6 @@ type attribute struct { type nestedType struct { Attributes map[string]*attribute `json:"attributes,omitempty"` NestingMode string `json:"nesting_mode,omitempty"` - MinItems uint64 `json:"min_items,omitempty"` - MaxItems uint64 `json:"max_items,omitempty"` } func marshalStringKind(sk configschema.StringKind) string { @@ -55,8 +53,6 @@ func marshalAttribute(attr *configschema.Attribute) *attribute { if attr.NestedType != nil { nestedTy := nestedType{ - MinItems: uint64(attr.NestedType.MinItems), - MaxItems: uint64(attr.NestedType.MaxItems), NestingMode: nestingModeString(attr.NestedType.Nesting), } attrs := make(map[string]*attribute, len(attr.NestedType.Attributes)) diff --git a/internal/configs/configschema/decoder_spec.go b/internal/configs/configschema/decoder_spec.go index d127ccd6f4ae..d2d6616dd8e9 100644 --- a/internal/configs/configschema/decoder_spec.go +++ b/internal/configs/configschema/decoder_spec.go @@ -187,17 +187,13 @@ func (a *Attribute) decoderSpec(name string) hcldec.Spec { } if a.NestedType != nil { - // FIXME: a panic() is a bad UX. InternalValidate() can check Attribute - // schemas as well so a fix might be to call it when we get the schema - // from the provider in Context(). Since this could be a breaking - // change, we'd need to communicate well before adding that call. if a.Type != cty.NilType { panic("Invalid attribute schema: NestedType and Type cannot both be set. This is a bug in the provider.") } ty := a.NestedType.specType() ret.Type = ty - ret.Required = a.Required || a.NestedType.MinItems > 0 + ret.Required = a.Required return ret } diff --git a/internal/configs/configschema/internal_validate.go b/internal/configs/configschema/internal_validate.go index 2afa724e150a..8876672d793b 100644 --- a/internal/configs/configschema/internal_validate.go +++ b/internal/configs/configschema/internal_validate.go @@ -131,17 +131,9 @@ func (a *Attribute) internalValidate(name, prefix string) error { if a.NestedType != nil { switch a.NestedType.Nesting { - case NestingSingle: - switch { - case a.NestedType.MinItems != a.NestedType.MaxItems: - err = multierror.Append(err, fmt.Errorf("%s%s: MinItems and MaxItems must match in NestingSingle mode", prefix, name)) - case a.NestedType.MinItems < 0 || a.NestedType.MinItems > 1: - err = multierror.Append(err, fmt.Errorf("%s%s: MinItems and MaxItems must be set to either 0 or 1 in NestingSingle mode", prefix, name)) - } + case NestingSingle, NestingMap: + // no validations to perform case NestingList, NestingSet: - if a.NestedType.MinItems > a.NestedType.MaxItems && a.NestedType.MaxItems != 0 { - err = multierror.Append(err, fmt.Errorf("%s%s: MinItems must be less than or equal to MaxItems in %s mode", prefix, name, a.NestedType.Nesting)) - } if a.NestedType.Nesting == NestingSet { ety := a.NestedType.ImpliedType() if ety.HasDynamicTypes() { @@ -151,10 +143,6 @@ func (a *Attribute) internalValidate(name, prefix string) error { err = multierror.Append(err, fmt.Errorf("%s%s: NestingSet blocks may not contain attributes of cty.DynamicPseudoType", prefix, name)) } } - case NestingMap: - if a.NestedType.MinItems != 0 || a.NestedType.MaxItems != 0 { - err = multierror.Append(err, fmt.Errorf("%s%s: MinItems and MaxItems must both be 0 in NestingMap mode", prefix, name)) - } default: err = multierror.Append(err, fmt.Errorf("%s%s: invalid nesting mode %s", prefix, name, a.NestedType.Nesting)) } diff --git a/internal/configs/configschema/internal_validate_test.go b/internal/configs/configschema/internal_validate_test.go index dc70a5fa8003..3be461d4481d 100644 --- a/internal/configs/configschema/internal_validate_test.go +++ b/internal/configs/configschema/internal_validate_test.go @@ -143,21 +143,6 @@ func TestBlockInternalValidate(t *testing.T) { []string{"fooBar: name may contain only lowercase letters, digits and underscores"}, }, */ - "attribute with invalid NestedType nesting": { - &Block{ - Attributes: map[string]*Attribute{ - "foo": { - NestedType: &Object{ - Nesting: NestingSingle, - MinItems: 10, - MaxItems: 10, - }, - Optional: true, - }, - }, - }, - []string{"foo: MinItems and MaxItems must be set to either 0 or 1 in NestingSingle mode"}, - }, "attribute with invalid NestedType attribute": { &Block{ Attributes: map[string]*Attribute{ diff --git a/internal/configs/configschema/schema.go b/internal/configs/configschema/schema.go index 581bead8b98e..9ecc71e54d5c 100644 --- a/internal/configs/configschema/schema.go +++ b/internal/configs/configschema/schema.go @@ -87,13 +87,6 @@ type Object struct { // many instances of the Object are allowed, how many labels it expects, and // how the resulting data will be converted into a data structure. Nesting NestingMode - - // MinItems and MaxItems set, for the NestingList and NestingSet nesting - // modes, lower and upper limits on the number of child blocks allowed - // of the given type. If both are left at zero, no limit is applied. - // These fields are ignored for other nesting modes and must both be left - // at zero. - MinItems, MaxItems int } // NestedBlock represents the embedding of one block within another. diff --git a/internal/plugin6/convert/schema.go b/internal/plugin6/convert/schema.go index fa405acf11c2..0bdf4e28402f 100644 --- a/internal/plugin6/convert/schema.go +++ b/internal/plugin6/convert/schema.go @@ -199,8 +199,6 @@ func protoObjectToConfigSchema(b *proto.Schema_Object) *configschema.Object { object := &configschema.Object{ Attributes: make(map[string]*configschema.Attribute), Nesting: nesting, - MinItems: int(b.MinItems), - MaxItems: int(b.MaxItems), } for _, a := range b.Attributes { @@ -295,7 +293,5 @@ func configschemaObjectToProto(b *configschema.Object) *proto.Schema_Object { return &proto.Schema_Object{ Attributes: attributes, Nesting: nesting, - MinItems: int64(b.MinItems), - MaxItems: int64(b.MaxItems), } } diff --git a/internal/plugin6/convert/schema_test.go b/internal/plugin6/convert/schema_test.go index a94e812f1150..9befe4c5afb0 100644 --- a/internal/plugin6/convert/schema_test.go +++ b/internal/plugin6/convert/schema_test.go @@ -126,7 +126,6 @@ func TestConvertSchemaBlocks(t *testing.T) { Computed: true, }, }, - MinItems: 3, }, Required: true, }, @@ -246,7 +245,6 @@ func TestConvertSchemaBlocks(t *testing.T) { Computed: true, }, }, - MinItems: 3, }, Required: true, }, From b699391d04faf00641d0c30d24bd55dd679d946c Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 24 Sep 2021 11:18:39 -0400 Subject: [PATCH 107/644] json-output: Add change reasons to explain deletes The extra feedback information for why resource instance deletion is planned is now included in the streaming JSON UI output. We also add an explicit case for no-op actions to switch statements in this package to ensure exhaustiveness, for future linting. --- internal/command/views/json/change.go | 16 ++++++++++++++++ internal/command/views/json/hook.go | 12 ++++++++++++ .../docs/internals/machine-readable-ui.html.md | 7 ++++++- 3 files changed, 34 insertions(+), 1 deletion(-) diff --git a/internal/command/views/json/change.go b/internal/command/views/json/change.go index c18a2c15a456..4a8aa4e5bd14 100644 --- a/internal/command/views/json/change.go +++ b/internal/command/views/json/change.go @@ -73,6 +73,12 @@ const ( ReasonRequested ChangeReason = "requested" ReasonCannotUpdate ChangeReason = "cannot_update" ReasonUnknown ChangeReason = "unknown" + + ReasonDeleteBecauseNoResourceConfig ChangeReason = "delete_because_no_resource_config" + ReasonDeleteBecauseWrongRepetition ChangeReason = "delete_because_wrong_repetition" + ReasonDeleteBecauseCountIndex ChangeReason = "delete_because_count_index" + ReasonDeleteBecauseEachKey ChangeReason = "delete_because_each_key" + ReasonDeleteBecauseNoModule ChangeReason = "delete_because_no_module" ) func changeReason(reason plans.ResourceInstanceChangeActionReason) ChangeReason { @@ -85,6 +91,16 @@ func changeReason(reason plans.ResourceInstanceChangeActionReason) ChangeReason return ReasonRequested case plans.ResourceInstanceReplaceBecauseCannotUpdate: return ReasonCannotUpdate + case plans.ResourceInstanceDeleteBecauseNoResourceConfig: + return ReasonDeleteBecauseNoResourceConfig + case plans.ResourceInstanceDeleteBecauseWrongRepetition: + return ReasonDeleteBecauseWrongRepetition + case plans.ResourceInstanceDeleteBecauseCountIndex: + return ReasonDeleteBecauseCountIndex + case plans.ResourceInstanceDeleteBecauseEachKey: + return ReasonDeleteBecauseEachKey + case plans.ResourceInstanceDeleteBecauseNoModule: + return ReasonDeleteBecauseNoModule default: // This should never happen, but there's no good way to guarantee // exhaustive handling of the enum, so a generic fall back is better diff --git a/internal/command/views/json/hook.go b/internal/command/views/json/hook.go index 1736e10a5476..142a4d1fd199 100644 --- a/internal/command/views/json/hook.go +++ b/internal/command/views/json/hook.go @@ -314,6 +314,10 @@ func startActionVerb(action plans.Action) string { // This is not currently possible to reach, as we receive separate // passes for create and delete return "Replacing" + case plans.NoOp: + // This should never be possible: a no-op planned change should not + // be applied. We'll fall back to "Applying". + fallthrough default: return "Applying" } @@ -336,6 +340,10 @@ func progressActionVerb(action plans.Action) string { // This is not currently possible to reach, as we receive separate // passes for create and delete return "replacing" + case plans.NoOp: + // This should never be possible: a no-op planned change should not + // be applied. We'll fall back to "applying". + fallthrough default: return "applying" } @@ -358,6 +366,10 @@ func actionNoun(action plans.Action) string { // This is not currently possible to reach, as we receive separate // passes for create and delete return "Replacement" + case plans.NoOp: + // This should never be possible: a no-op planned change should not + // be applied. We'll fall back to "Apply". + fallthrough default: return "Apply" } diff --git a/website/docs/internals/machine-readable-ui.html.md b/website/docs/internals/machine-readable-ui.html.md index 53b3e47e0946..94427cc6d38e 100644 --- a/website/docs/internals/machine-readable-ui.html.md +++ b/website/docs/internals/machine-readable-ui.html.md @@ -126,10 +126,15 @@ At the end of a plan or before an apply, Terraform will emit a `planned_change` - `resource`: object describing the address of the resource to be changed; see [resource object](#resource-object) below for details - `previous_resource`: object describing the previous address of the resource, if this change includes a configuration-driven move - `action`: the action planned to be taken for the resource. Values: `noop`, `create`, `read`, `update`, `replace`, `delete`, `move`. -- `reason`: an optional reason for the change, currently only used when the action is `replace`. Values: +- `reason`: an optional reason for the change, currently only used when the action is `replace` or `delete`. Values: - `tainted`: resource was marked as tainted - `requested`: user requested that the resource be replaced, for example via the `-replace` plan flag - `cannot_update`: changes to configuration force the resource to be deleted and created rather than updated + - `delete_because_no_resource_config`: no matching resource in configuration + - `delete_because_wrong_repetition`: resource instance key has no corresponding `count` or `for_each` in configuration + - `delete_because_count_index`: resource instance key is outside the range of the `count` argument + - `delete_because_each_key`: resource instance key is not included in the `for_each` argument + - `delete_because_no_module`: enclosing module instance is not in configuration This message does not include details about the exact changes which caused the change to be planned. That information is available in [the JSON plan output](./json-format.html). From e09bad76ff31dfde1f964e3197e10d13bf8a45da Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 24 Sep 2021 15:02:30 -0400 Subject: [PATCH 108/644] build: Add exhaustive switch statement lint For now, only check the JSON views package, since this was the instance that most recently tripped us up. There are a few dozen failures elsewhere in Terraform which would need to be addressed before expanding this to other packages. --- .circleci/config.yml | 3 ++- Makefile | 3 +++ go.mod | 5 +++-- go.sum | 12 ++++++++++-- scripts/exhaustive.sh | 7 +++++++ tools/tools.go | 1 + 6 files changed, 26 insertions(+), 5 deletions(-) create mode 100755 scripts/exhaustive.sh diff --git a/.circleci/config.yml b/.circleci/config.yml index 0113ae17c3f4..b9132f634ac8 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -27,7 +27,8 @@ jobs: - checkout - run: go mod verify - run: go install honnef.co/go/tools/cmd/staticcheck - - run: make fmtcheck generate staticcheck + - run: go install github.com/nishanths/exhaustive/... + - run: make fmtcheck generate staticcheck exhaustive - run: name: verify no code was generated command: | diff --git a/Makefile b/Makefile index 16e2abaa5b2c..aa29d369669e 100644 --- a/Makefile +++ b/Makefile @@ -23,6 +23,9 @@ fmtcheck: staticcheck: @sh -c "'$(CURDIR)/scripts/staticcheck.sh'" +exhaustive: + @sh -c "'$(CURDIR)/scripts/exhaustive.sh'" + website: ifeq (,$(wildcard $(GOPATH)/src/$(WEBSITE_REPO))) echo "$(WEBSITE_REPO) not found in your GOPATH (necessary for layouts and assets), get-ting..." diff --git a/go.mod b/go.mod index 6cbca3b170df..bc3fae7b74e8 100644 --- a/go.mod +++ b/go.mod @@ -125,6 +125,7 @@ require ( github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.1 // indirect github.com/mozillazg/go-httpheader v0.3.0 // indirect + github.com/nishanths/exhaustive v0.2.3 github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect github.com/oklog/run v1.0.0 // indirect github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db @@ -158,11 +159,11 @@ require ( golang.org/x/mod v0.4.2 golang.org/x/net v0.0.0-20210614182718-04defd469f4e golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 - golang.org/x/sys v0.0.0-20210423082822-04245dca01da + golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf golang.org/x/text v0.3.6 golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect - golang.org/x/tools v0.1.0 + golang.org/x/tools v0.1.4 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/api v0.44.0-impersonate-preview google.golang.org/appengine v1.6.7 // indirect diff --git a/go.sum b/go.sum index b89a0b92cdb7..b5c72603f3a3 100644 --- a/go.sum +++ b/go.sum @@ -536,6 +536,8 @@ github.com/mozillazg/go-httpheader v0.3.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK0 github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw= +github.com/nishanths/exhaustive v0.2.3 h1:+ANTMqRNrqwInnP9aszg/0jDo+zbXa4x66U19Bx/oTk= +github.com/nishanths/exhaustive v0.2.3/go.mod h1:bhIX678Nx8inLM9PbpvK1yv6oGtoP8BfaIeMzgBNKvc= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d/go.mod h1:YUTz3bUH2ZwIWBy3CJBeOBEugqcmXREj14T+iG/4k4U= github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw= @@ -643,6 +645,7 @@ github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9de github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/zclconf/go-cty v1.0.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.1.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.2.0/go.mod h1:hOPWgoHbaTUnI5k4D2ld+GRpFJSCe6bCM7m1q/N4PQ8= @@ -770,6 +773,7 @@ golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwY golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210614182718-04defd469f4e h1:XpT3nA5TvE525Ne3hInMh6+GETgn27Zfm9dxsThnX2Q= golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= @@ -850,8 +854,11 @@ golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210220050731-9a76102bfb43/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210305230114-8fe3ee5dd75b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210423082822-04245dca01da h1:b3NXsE2LusjYGGjL5bxEVZZORm/YEFFrWFjR8eFrw/c= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf h1:MZ2shdL+ZM/XzY3ZGOnh4Nlpnxz5GSOhOmtHo3iPU6M= @@ -923,8 +930,9 @@ golang.org/x/tools v0.0.0-20201110124207-079ba7bd75cd/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.0.0-20201201161351-ac6f37ff4c2a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= -golang.org/x/tools v0.1.0 h1:po9/4sTYwZU9lPhi1tOrb4hCv3qrhiQ77LZfGa2OjwY= golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= +golang.org/x/tools v0.1.4 h1:cVngSRcfgyZCzys3KYOpCFa+4dqX/Oub9tAq00ttGVs= +golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/scripts/exhaustive.sh b/scripts/exhaustive.sh new file mode 100755 index 000000000000..73dbbc56ce23 --- /dev/null +++ b/scripts/exhaustive.sh @@ -0,0 +1,7 @@ +#!/usr/bin/env bash + +echo "==> Checking for switch statement exhaustiveness..." + +# For now we're only checking a handful of packages, rather than defaulting to +# everything with a skip list. +exhaustive ./internal/command/views/json diff --git a/tools/tools.go b/tools/tools.go index 712cd6717c56..f575e0189f40 100644 --- a/tools/tools.go +++ b/tools/tools.go @@ -7,6 +7,7 @@ import ( _ "github.com/golang/mock/mockgen" _ "github.com/golang/protobuf/protoc-gen-go" _ "github.com/mitchellh/gox" + _ "github.com/nishanths/exhaustive" _ "golang.org/x/tools/cmd/cover" _ "golang.org/x/tools/cmd/stringer" _ "google.golang.org/grpc/cmd/protoc-gen-go-grpc" From cac1f5c2641bb21d3e14a570dc10ff01801cf459 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 24 Sep 2021 18:08:33 -0400 Subject: [PATCH 109/644] refactoring: exhaustive NestedWithin checks When checking dependencies between statements, we need to check all combinations of To and From addresses. --- internal/refactoring/move_execute.go | 39 +++- internal/refactoring/move_execute_test.go | 206 +++++++++++----------- 2 files changed, 140 insertions(+), 105 deletions(-) diff --git a/internal/refactoring/move_execute.go b/internal/refactoring/move_execute.go index 322569803a23..7f5fbae23b36 100644 --- a/internal/refactoring/move_execute.go +++ b/internal/refactoring/move_execute.go @@ -200,10 +200,13 @@ func buildMoveStatementGraph(stmts []MoveStatement) *dag.AcyclicGraph { for dependerI := range stmts { depender := &stmts[dependerI] for dependeeI := range stmts { + if dependerI == dependeeI { + // skip comparing the statement to itself + continue + } dependee := &stmts[dependeeI] - dependeeTo := dependee.To - dependerFrom := depender.From - if dependerFrom.CanChainFrom(dependeeTo) || dependerFrom.NestedWithin(dependeeTo) { + + if statementDependsOn(depender, dependee) { g.Connect(dag.BasicEdge(depender, dependee)) } } @@ -212,6 +215,36 @@ func buildMoveStatementGraph(stmts []MoveStatement) *dag.AcyclicGraph { return g } +// statementDependsOn returns true if statement a depends on statement b; +// i.e. statement b must be executed before statement a. +func statementDependsOn(a, b *MoveStatement) bool { + // chain-able moves are simple, as on the destination of one move could be + // equal to the source of another. + if a.From.CanChainFrom(b.To) { + return true + } + + // Statement nesting in more complex, as we have 8 possible combinations to + // assess. Here we list all combinations, along with the statement which + // must be executed first when one address is nested within another. + // A.From IsNestedWithin B.From => A + // A.From IsNestedWithin B.To => B + // A.To IsNestedWithin B.From => A + // A.To IsNestedWithin B.To => B + // B.From IsNestedWithin A.From => B + // B.From IsNestedWithin A.To => A + // B.To IsNestedWithin A.From => B + // B.To IsNestedWithin A.To => A + // + // Since we are only interested in checking if A depends on B, we only need + // to check the 4 possibilities above which result in B being executed + // first. + return a.From.NestedWithin(b.To) || + a.To.NestedWithin(b.To) || + b.From.NestedWithin(a.From) || + b.To.NestedWithin(a.From) +} + // MoveResults describes the outcome of an ApplyMoves call. type MoveResults struct { // Changes is a map from the unique keys of the final new resource diff --git a/internal/refactoring/move_execute_test.go b/internal/refactoring/move_execute_test.go index e913df9f4723..ab71f5b0fe36 100644 --- a/internal/refactoring/move_execute_test.go +++ b/internal/refactoring/move_execute_test.go @@ -491,118 +491,120 @@ func TestApplyMoves(t *testing.T) { `foo.to[0]`, }, }, - - // FIXME: This test seems to flap between the result the test case - // currently records and the "more intuitive" results included inline, - // which suggests we have a missing edge in our move dependency graph. - // (The MoveResults commented out below predates some changes to that - // struct, so will need updating once we uncomment this test.) - /* - "move module and then move resource into it": { - []MoveStatement{ - testMoveStatement(t, "", "module.bar[0]", "module.boo"), - testMoveStatement(t, "", "foo.from", "module.boo.foo.from"), + "move resource and containing module": { + []MoveStatement{ + testMoveStatement(t, "", "module.boo", "module.bar[0]"), + testMoveStatement(t, "boo", "foo.from", "foo.to"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["module.boo.foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.bar[0].foo.to"].UniqueKey(): { + From: instAddrs["module.boo.foo.from"], + To: instAddrs["module.bar[0].foo.to"], + }, }, - states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( - instAddrs["module.bar[0].foo.to"], - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{}`), - }, - providerAddr, - ) - s.SetResourceInstanceCurrent( + Blocked: map[addrs.UniqueKey]MoveBlocked{}, + }, + []string{ + `module.bar[0].foo.to`, + }, + }, + + "move module and then move resource into it": { + []MoveStatement{ + testMoveStatement(t, "", "module.bar[0]", "module.boo"), + testMoveStatement(t, "", "foo.from", "module.boo.foo.from"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["module.bar[0].foo.to"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + instAddrs["module.boo.foo.from"].UniqueKey(): { instAddrs["foo.from"], - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{}`), - }, - providerAddr, - ) - }), - MoveResults{ - // FIXME: This result is counter-intuitive, because ApplyMoves - // handled the resource move first and then the module move - // collided with it. It would be arguably more intuitive to - // complete the module move first and then let the "smaller" - // resource move merge into it. - // (The arguably-more-intuitive results are commented out - // in the maps below.) - - Changes: map[addrs.UniqueKey]MoveSuccess{ - //instAddrs["module.boo.foo.to"].UniqueKey(): instAddrs["module.bar[0].foo.to"], - //instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["foo.from"], - instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["foo.from"], - }, - Blocked: map[addrs.UniqueKey]MoveBlocked{ - // intuitive result: nothing blocked - instAddrs["module.bar[0].foo.to"].Module.UniqueKey(): instAddrs["module.boo.foo.from"].Module, + instAddrs["module.boo.foo.from"], + }, + instAddrs["module.boo.foo.to"].UniqueKey(): { + instAddrs["module.bar[0].foo.to"], + instAddrs["module.boo.foo.to"], }, }, - []string{ - //`foo.from`, - //`module.boo.foo.from`, - `module.bar[0].foo.to`, - `module.boo.foo.from`, - }, + Blocked: map[addrs.UniqueKey]MoveBlocked{}, }, - */ - - // FIXME: This test seems to flap between the result the test case - // currently records and the "more intuitive" results included inline, - // which suggests we have a missing edge in our move dependency graph. - // (The MoveResults commented out below predates some changes to that - // struct, so will need updating once we uncomment this test.) - /* - "module move collides with resource move": { - []MoveStatement{ - testMoveStatement(t, "", "module.bar[0]", "module.boo"), - testMoveStatement(t, "", "foo.from", "module.boo.foo.from"), - }, - states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( + []string{ + `module.boo.foo.from`, + `module.boo.foo.to`, + }, + }, + + "module move collides with resource move": { + []MoveStatement{ + testMoveStatement(t, "", "module.bar[0]", "module.boo"), + testMoveStatement(t, "", "foo.from", "module.boo.foo.from"), + }, + states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + instAddrs["module.bar[0].foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + s.SetResourceInstanceCurrent( + instAddrs["foo.from"], + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{}`), + }, + providerAddr, + ) + }), + MoveResults{ + Changes: map[addrs.UniqueKey]MoveSuccess{ + + instAddrs["module.boo.foo.from"].UniqueKey(): { instAddrs["module.bar[0].foo.from"], - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{}`), - }, - providerAddr, - ) - s.SetResourceInstanceCurrent( - instAddrs["foo.from"], - &states.ResourceInstanceObjectSrc{ - Status: states.ObjectReady, - AttrsJSON: []byte(`{}`), - }, - providerAddr, - ) - }), - MoveResults{ - // FIXME: This result is counter-intuitive, because ApplyMoves - // handled the resource move first and then it was the - // module move that collided, whereas it would arguably have - // been better to let the module take priority and have only - // the one resource move be ignored due to the collision. - // (The arguably-more-intuitive results are commented out - // in the maps below.) - Changes: map[addrs.UniqueKey]MoveSuccess{ - //instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["module.bar[0].foo.from"], - instAddrs["module.boo.foo.from"].UniqueKey(): instAddrs["foo.from"], - }, - Blocked: map[addrs.UniqueKey]MoveBlocked{ - //instAddrs["foo.from"].UniqueKey(): instAddrs["module.bar[0].foo.from"], - instAddrs["module.bar[0].foo.from"].Module.UniqueKey(): instAddrs["module.boo.foo.from"].Module, + instAddrs["module.boo.foo.from"], }, }, - []string{ - //`foo.from`, - //`module.boo.foo.from`, - `module.bar[0].foo.from`, - `module.boo.foo.from`, + Blocked: map[addrs.UniqueKey]MoveBlocked{ + instAddrs["foo.from"].ContainingResource().UniqueKey(): { + Actual: instAddrs["foo.from"].ContainingResource(), + Wanted: instAddrs["module.boo.foo.from"].ContainingResource(), + }, }, }, - */ + []string{ + `foo.from`, + `module.boo.foo.from`, + }, + }, } for name, test := range tests { From f60d55d6adf8a60c7ff58c9056d101e928b2b6de Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 27 Sep 2021 13:45:51 -0700 Subject: [PATCH 110/644] core: Emit only one warning for move collisions in destroy-plan mode Our current implementation of destroy planning includes secretly running a normal plan first, in order to get its effect of refreshing the state. Previously our warning about colliding moves would betray that implementation detail because we'd return it from both of our planning operations here and thus show the message twice. That would also have happened in theory for any other warnings emitted by both plan operations, but it's the move collision warning that made it immediately visible. We'll now only return warnings from the initial plan if we're also returning errors from that plan, and thus the warnings of both plans can never mix together into the same diags and thus we'll avoid duplicating any warnings. This does mean that we'd lose any warnings which might hypothetically emerge only from the hidden normal plan and not from the subsequent destroy plan, but we'll accept that as an okay tradeoff here because those warnings are likely to not be super relevant to the destroy case anyway, or else we'd emit them from the destroy-plan walk too. --- internal/terraform/context_plan.go | 15 ++- internal/terraform/context_plan2_test.go | 118 +++++++++++++++++++++++ 2 files changed, 131 insertions(+), 2 deletions(-) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 001a2507ad78..5610a445ba71 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -262,8 +262,19 @@ func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State normalOpts := *opts normalOpts.Mode = plans.NormalMode refreshPlan, refreshDiags := c.plan(config, prevRunState, rootVariables, &normalOpts) - diags = diags.Append(refreshDiags) - if diags.HasErrors() { + if refreshDiags.HasErrors() { + // NOTE: Normally we'd append diagnostics regardless of whether + // there are errors, just in case there are warnings we'd want to + // preserve, but we're intentionally _not_ doing that here because + // if the first plan succeeded then we'll be running another plan + // in DestroyMode below, and we don't want to double-up any + // warnings that both plan walks would generate. + // (This does mean we won't show any warnings that would've been + // unique to only this walk, but we're assuming here that if the + // warnings aren't also applicable to a destroy plan then we'd + // rather not show them here, because this non-destroy plan for + // refreshing is largely an implementation detail.) + diags = diags.Append(refreshDiags) return nil, diags } diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index e0c57cd0a8bc..6d54e9eef180 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -887,6 +887,124 @@ Terraform has planned to destroy these objects. If Terraform's proposed changes }) } +func TestContext2Plan_movedResourceCollisionDestroy(t *testing.T) { + // This is like TestContext2Plan_movedResourceCollision but intended to + // ensure we still produce the expected warning (and produce it only once) + // when we're creating a destroy plan, rather than a normal plan. + // (This case is interesting at the time of writing because we happen to + // use a normal plan as a trick to refresh before creating a destroy plan. + // This test will probably become uninteresting if a future change to + // the destroy-time planning behavior handles refreshing in a different + // way, which avoids this pre-processing step of running a normal plan + // first.) + + addrNoKey := mustResourceInstanceAddr("test_object.a") + addrZeroKey := mustResourceInstanceAddr("test_object.a[0]") + m := testModuleInline(t, map[string]string{ + "main.tf": ` + resource "test_object" "a" { + # No "count" set, so test_object.a[0] will want + # to implicitly move to test_object.a, but will get + # blocked by the existing object at that address. + } + `, + }) + + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent(addrNoKey, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + s.SetResourceInstanceCurrent(addrZeroKey, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + + p := simpleMockProvider() + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + if diags.HasErrors() { + t.Fatalf("unexpected errors\n%s", diags.Err().Error()) + } + + // We should have a warning, though! We'll lightly abuse the "for RPC" + // feature of diagnostics to get some more-readily-comparable diagnostic + // values. + gotDiags := diags.ForRPC() + wantDiags := tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Warning, + "Unresolved resource instance address changes", + // NOTE: This message is _lightly_ confusing in the destroy case, + // because it says "Terraform has planned to destroy these objects" + // but this is a plan to destroy all objects, anyway. We expect the + // conflict situation to be pretty rare though, and even rarer in + // a "terraform destroy", so we'll just live with that for now + // unless we see evidence that lots of folks are being confused by + // it in practice. + `Terraform tried to adjust resource instance addresses in the prior state based on change information recorded in the configuration, but some adjustments did not succeed due to existing objects already at the intended addresses: + - test_object.a[0] could not move to test_object.a + +Terraform has planned to destroy these objects. If Terraform's proposed changes aren't appropriate, you must first resolve the conflicts using the "terraform state" subcommands and then create a new plan.`, + ), + }.ForRPC() + if diff := cmp.Diff(wantDiags, gotDiags); diff != "" { + // If we get here with a diff that makes it seem like the above warning + // is being reported twice, the likely cause is not correctly handling + // the warnings from the hidden normal plan we run as part of preparing + // for a destroy plan, unless that strategy has changed in the meantime + // since we originally wrote this test. + t.Errorf("wrong diagnostics\n%s", diff) + } + + t.Run(addrNoKey.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrNoKey) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrNoKey) + } + + if got, want := instPlan.Addr, addrNoKey; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrNoKey; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.Delete; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) + t.Run(addrZeroKey.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrZeroKey) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrZeroKey) + } + + if got, want := instPlan.Addr, addrZeroKey; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrZeroKey; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.Delete; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) +} + func TestContext2Plan_movedResourceUntargeted(t *testing.T) { addrA := mustResourceInstanceAddr("test_object.a") addrB := mustResourceInstanceAddr("test_object.b") From 625e76867883e41b7bdac50a56952dc3d09f94f7 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 28 Sep 2021 12:38:40 -0400 Subject: [PATCH 111/644] make sure required_version is checked before diags We must ensure that the terraform required_version is checked as early as possible, so that new configuration constructs don't cause init to fail without indicating the version is incompatible. The loadConfig call before the earlyconfig parsing seems to be unneeded, and we can delay that to de-tangle it from installing the modules which may have their own constraints. TODO: it seems that loadConfig should be able to handle returning the version constraints in the same manner as loadSingleModule. --- internal/command/init.go | 62 ++++++++++++------- internal/command/init_test.go | 27 ++++++++ .../init-check-required-version-first/main.tf | 17 +++++ 3 files changed, 82 insertions(+), 24 deletions(-) create mode 100644 internal/command/testdata/init-check-required-version-first/main.tf diff --git a/internal/command/init.go b/internal/command/init.go index 96a383159f04..02f555ee0a8e 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -150,19 +150,7 @@ func (c *InitCommand) Run(args []string) int { // initialization functionality remains built around "earlyconfig" and // so we need to still load the module via that mechanism anyway until we // can do some more invasive refactoring here. - rootMod, confDiags := c.loadSingleModule(path) rootModEarly, earlyConfDiags := c.loadSingleModuleEarly(path) - if confDiags.HasErrors() { - c.Ui.Error(c.Colorize().Color(strings.TrimSpace(errInitConfigError))) - // TODO: It would be nice to check the version constraints in - // rootModEarly.RequiredCore and print out a hint if the module is - // declaring that it's not compatible with this version of Terraform, - // though we're deferring that for now because we're intending to - // refactor our use of "earlyconfig" here anyway and so whatever we - // might do here right now would likely be invalidated by that. - c.showDiagnostics(confDiags) - return 1 - } // If _only_ the early loader encountered errors then that's unusual // (it should generally be a superset of the normal loader) but we'll // return those errors anyway since otherwise we'll probably get @@ -172,7 +160,12 @@ func (c *InitCommand) Run(args []string) int { c.Ui.Error(c.Colorize().Color(strings.TrimSpace(errInitConfigError))) // Errors from the early loader are generally not as high-quality since // it has less context to work with. - diags = diags.Append(confDiags) + + // TODO: It would be nice to check the version constraints in + // rootModEarly.RequiredCore and print out a hint if the module is + // declaring that it's not compatible with this version of Terraform, + // and that may be what caused earlyconfig to fail. + diags = diags.Append(earlyConfDiags) c.showDiagnostics(diags) return 1 } @@ -189,23 +182,44 @@ func (c *InitCommand) Run(args []string) int { } } + // Using loadSingleModule will allow us to get the sniffed required_version + // before trying to build the complete config. + rootMod, _ := c.loadSingleModule(path) + // We can ignore the error, since we are going to reload the full config + // again below once we know the root module constraints are valid. + if rootMod != nil { + rootCfg := &configs.Config{ + Module: rootMod, + } + // If our module version constraints are not valid, then there is no + // need to continue processing. + versionDiags := terraform.CheckCoreVersionRequirements(rootCfg) + if versionDiags.HasErrors() { + c.showDiagnostics(versionDiags) + return 1 + } + } + // With all of the modules (hopefully) installed, we can now try to load the // whole configuration tree. config, confDiags := c.loadConfig(path) - diags = diags.Append(confDiags) - if confDiags.HasErrors() { - c.Ui.Error(strings.TrimSpace(errInitConfigError)) - c.showDiagnostics(diags) - return 1 - } + // configDiags will be handled after the version constraint check, since an + // incorrect version of terraform may be producing errors for configuration + // constructs added in later versions. - // Before we go further, we'll check to make sure none of the modules in the - // configuration declare that they don't support this Terraform version, so - // we can produce a version-related error message rather than + // Check again to make sure none of the modules in the configuration + // declare that they don't support this Terraform version, so we can + // produce a version-related error message rather than // potentially-confusing downstream errors. versionDiags := terraform.CheckCoreVersionRequirements(config) - diags = diags.Append(versionDiags) if versionDiags.HasErrors() { + c.showDiagnostics(versionDiags) + return 1 + } + + diags = diags.Append(confDiags) + if confDiags.HasErrors() { + c.Ui.Error(strings.TrimSpace(errInitConfigError)) c.showDiagnostics(diags) return 1 } @@ -213,7 +227,7 @@ func (c *InitCommand) Run(args []string) int { var back backend.Backend if flagBackend { - be, backendOutput, backendDiags := c.initBackend(rootMod, flagConfigExtra) + be, backendOutput, backendDiags := c.initBackend(config.Root.Module, flagConfigExtra) diags = diags.Append(backendDiags) if backendDiags.HasErrors() { c.showDiagnostics(diags) diff --git a/internal/command/init_test.go b/internal/command/init_test.go index b75da1f4f899..2bf1e0e26481 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -1608,6 +1608,33 @@ func TestInit_checkRequiredVersion(t *testing.T) { } } +// Verify that init will error out with an invalid version constraint, even if +// there are other invalid configuration constructs. +func TestInit_checkRequiredVersionFirst(t *testing.T) { + td := t.TempDir() + testCopyDir(t, testFixturePath("init-check-required-version-first"), td) + defer testChdir(t, td)() + + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + Ui: ui, + View: view, + }, + } + + args := []string{} + if code := c.Run(args); code != 1 { + t.Fatalf("got exit status %d; want 1\nstderr:\n%s\n\nstdout:\n%s", code, ui.ErrorWriter.String(), ui.OutputWriter.String()) + } + errStr := ui.ErrorWriter.String() + if !strings.Contains(errStr, `Unsupported Terraform Core version`) { + t.Fatalf("output should point to unmet version constraint, but is:\n\n%s", errStr) + } +} + func TestInit_providerLockFile(t *testing.T) { // Create a temporary working directory that is empty td := tempDir(t) diff --git a/internal/command/testdata/init-check-required-version-first/main.tf b/internal/command/testdata/init-check-required-version-first/main.tf new file mode 100644 index 000000000000..ab311d066953 --- /dev/null +++ b/internal/command/testdata/init-check-required-version-first/main.tf @@ -0,0 +1,17 @@ +terraform { + required_version = ">200.0.0" + + bad { + block = "false" + } + + required_providers { + bang = { + oops = "boom" + } + } +} + +nope { + boom {} +} From a53faf43f67859a5b72544221336df7ac2eb04ad Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 28 Sep 2021 13:02:26 -0400 Subject: [PATCH 112/644] return partial config from LoadConfig with errors LoadConfig should return any parsed configuration in order for the caller to verify `required_version`. --- internal/command/init.go | 2 +- internal/configs/configload/loader_load.go | 8 +++++++- internal/configs/configload/loader_load_test.go | 12 ++++++++++-- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index 02f555ee0a8e..ec6fa5723cc0 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -227,7 +227,7 @@ func (c *InitCommand) Run(args []string) int { var back backend.Backend if flagBackend { - be, backendOutput, backendDiags := c.initBackend(config.Root.Module, flagConfigExtra) + be, backendOutput, backendDiags := c.initBackend(config.Module, flagConfigExtra) diags = diags.Append(backendDiags) if backendDiags.HasErrors() { c.showDiagnostics(diags) diff --git a/internal/configs/configload/loader_load.go b/internal/configs/configload/loader_load.go index 323001de1028..9ae440274035 100644 --- a/internal/configs/configload/loader_load.go +++ b/internal/configs/configload/loader_load.go @@ -21,7 +21,13 @@ import ( func (l *Loader) LoadConfig(rootDir string) (*configs.Config, hcl.Diagnostics) { rootMod, diags := l.parser.LoadConfigDir(rootDir) if rootMod == nil || diags.HasErrors() { - return nil, diags + // Ensure we return any parsed modules here so that required_version + // constraints can be verified even when encountering errors. + cfg := &configs.Config{ + Module: rootMod, + } + + return cfg, diags } cfg, cDiags := configs.BuildConfig(rootMod, configs.ModuleWalkerFunc(l.moduleWalkerLoad)) diff --git a/internal/configs/configload/loader_load_test.go b/internal/configs/configload/loader_load_test.go index 82d8db0cd4fe..ab8dd5dee630 100644 --- a/internal/configs/configload/loader_load_test.go +++ b/internal/configs/configload/loader_load_test.go @@ -91,8 +91,16 @@ func TestLoaderLoadConfig_loadDiags(t *testing.T) { t.Fatalf("unexpected error from NewLoader: %s", err) } - _, diags := loader.LoadConfig(fixtureDir) + cfg, diags := loader.LoadConfig(fixtureDir) if !diags.HasErrors() { - t.Fatalf("success; want error") + t.Fatal("success; want error") + } + + if cfg == nil { + t.Fatal("partial config not returned with diagnostics") + } + + if cfg.Module == nil { + t.Fatal("expected config module") } } From c2e0d265cfe946fca70faf68935f73df178cab30 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 28 Sep 2021 13:06:22 -0400 Subject: [PATCH 113/644] LoadModule now always returns the module We don't need to load the configuration twice, since configload can return the module for us. --- internal/command/init.go | 24 +------ internal/command/init_test.go | 66 +++++++++++++------ .../main.tf | 3 + .../mod/main.tf | 17 +++++ 4 files changed, 69 insertions(+), 41 deletions(-) create mode 100644 internal/command/testdata/init-check-required-version-first-module/main.tf create mode 100644 internal/command/testdata/init-check-required-version-first-module/mod/main.tf diff --git a/internal/command/init.go b/internal/command/init.go index ec6fa5723cc0..551a4d0b8a5a 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -182,24 +182,6 @@ func (c *InitCommand) Run(args []string) int { } } - // Using loadSingleModule will allow us to get the sniffed required_version - // before trying to build the complete config. - rootMod, _ := c.loadSingleModule(path) - // We can ignore the error, since we are going to reload the full config - // again below once we know the root module constraints are valid. - if rootMod != nil { - rootCfg := &configs.Config{ - Module: rootMod, - } - // If our module version constraints are not valid, then there is no - // need to continue processing. - versionDiags := terraform.CheckCoreVersionRequirements(rootCfg) - if versionDiags.HasErrors() { - c.showDiagnostics(versionDiags) - return 1 - } - } - // With all of the modules (hopefully) installed, we can now try to load the // whole configuration tree. config, confDiags := c.loadConfig(path) @@ -207,9 +189,9 @@ func (c *InitCommand) Run(args []string) int { // incorrect version of terraform may be producing errors for configuration // constructs added in later versions. - // Check again to make sure none of the modules in the configuration - // declare that they don't support this Terraform version, so we can - // produce a version-related error message rather than + // Before we go further, we'll check to make sure none of the modules in + // the configuration declare that they don't support this Terraform + // version, so we can produce a version-related error message rather than // potentially-confusing downstream errors. versionDiags := terraform.CheckCoreVersionRequirements(config) if versionDiags.HasErrors() { diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 2bf1e0e26481..2d96b27b4403 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -1611,28 +1611,54 @@ func TestInit_checkRequiredVersion(t *testing.T) { // Verify that init will error out with an invalid version constraint, even if // there are other invalid configuration constructs. func TestInit_checkRequiredVersionFirst(t *testing.T) { - td := t.TempDir() - testCopyDir(t, testFixturePath("init-check-required-version-first"), td) - defer testChdir(t, td)() + t.Run("root_module", func(t *testing.T) { + td := t.TempDir() + testCopyDir(t, testFixturePath("init-check-required-version-first"), td) + defer testChdir(t, td)() - ui := cli.NewMockUi() - view, _ := testView(t) - c := &InitCommand{ - Meta: Meta{ - testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, - View: view, - }, - } + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + Ui: ui, + View: view, + }, + } - args := []string{} - if code := c.Run(args); code != 1 { - t.Fatalf("got exit status %d; want 1\nstderr:\n%s\n\nstdout:\n%s", code, ui.ErrorWriter.String(), ui.OutputWriter.String()) - } - errStr := ui.ErrorWriter.String() - if !strings.Contains(errStr, `Unsupported Terraform Core version`) { - t.Fatalf("output should point to unmet version constraint, but is:\n\n%s", errStr) - } + args := []string{} + if code := c.Run(args); code != 1 { + t.Fatalf("got exit status %d; want 1\nstderr:\n%s\n\nstdout:\n%s", code, ui.ErrorWriter.String(), ui.OutputWriter.String()) + } + errStr := ui.ErrorWriter.String() + if !strings.Contains(errStr, `Unsupported Terraform Core version`) { + t.Fatalf("output should point to unmet version constraint, but is:\n\n%s", errStr) + } + }) + t.Run("sub_module", func(t *testing.T) { + td := t.TempDir() + testCopyDir(t, testFixturePath("init-check-required-version-first-module"), td) + defer testChdir(t, td)() + + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + Ui: ui, + View: view, + }, + } + + args := []string{} + if code := c.Run(args); code != 1 { + t.Fatalf("got exit status %d; want 1\nstderr:\n%s\n\nstdout:\n%s", code, ui.ErrorWriter.String(), ui.OutputWriter.String()) + } + errStr := ui.ErrorWriter.String() + if !strings.Contains(errStr, `Unsupported Terraform Core version`) { + t.Fatalf("output should point to unmet version constraint, but is:\n\n%s", errStr) + } + }) } func TestInit_providerLockFile(t *testing.T) { diff --git a/internal/command/testdata/init-check-required-version-first-module/main.tf b/internal/command/testdata/init-check-required-version-first-module/main.tf new file mode 100644 index 000000000000..ba846846994e --- /dev/null +++ b/internal/command/testdata/init-check-required-version-first-module/main.tf @@ -0,0 +1,3 @@ +module "mod" { + source = "./mod" +} diff --git a/internal/command/testdata/init-check-required-version-first-module/mod/main.tf b/internal/command/testdata/init-check-required-version-first-module/mod/main.tf new file mode 100644 index 000000000000..ab311d066953 --- /dev/null +++ b/internal/command/testdata/init-check-required-version-first-module/mod/main.tf @@ -0,0 +1,17 @@ +terraform { + required_version = ">200.0.0" + + bad { + block = "false" + } + + required_providers { + bang = { + oops = "boom" + } + } +} + +nope { + boom {} +} From ab0322e406294104adeb86c38216bce2576a730a Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 28 Sep 2021 13:18:09 -0400 Subject: [PATCH 114/644] remove debugging println --- internal/command/show_test.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/internal/command/show_test.go b/internal/command/show_test.go index b70ce14c1cb4..ea266d2cb32c 100644 --- a/internal/command/show_test.go +++ b/internal/command/show_test.go @@ -103,8 +103,6 @@ func TestShow_aliasedProvider(t *testing.T) { }, } - fmt.Println(os.Getwd()) - // the statefile created by testStateFile is named state.tfstate args := []string{"state.tfstate"} if code := c.Run(args); code != 0 { From c9a5fdb36631f306d44e00fd41d224c3e737c035 Mon Sep 17 00:00:00 2001 From: Zach Whaley Date: Wed, 29 Sep 2021 15:36:59 -0500 Subject: [PATCH 115/644] cliconfig: Fix error message about invalid credentials helper type --- internal/command/cliconfig/credentials.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/command/cliconfig/credentials.go b/internal/command/cliconfig/credentials.go index 967f719eb9e5..185baf9d5b46 100644 --- a/internal/command/cliconfig/credentials.go +++ b/internal/command/cliconfig/credentials.go @@ -46,7 +46,7 @@ func (c *Config) CredentialsSource(helperPlugins pluginDiscovery.PluginMetaSet) for givenType, givenConfig := range c.CredentialsHelpers { available := helperPlugins.WithName(givenType) if available.Count() == 0 { - log.Printf("[ERROR] Unable to find credentials helper %q; ignoring", helperType) + log.Printf("[ERROR] Unable to find credentials helper %q; ignoring", givenType) break } From 0062e7112aac83304ea906f08c5aeb89b4ebfefa Mon Sep 17 00:00:00 2001 From: Melissa Gurney Greene Date: Wed, 29 Sep 2021 13:42:54 -0700 Subject: [PATCH 116/644] Update publish.html.md (#29671) Updated language around contributing modules with overlapping features in the Publishing Modules section: "We welcome..." (all contributions) --- website/docs/language/modules/develop/publish.html.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/docs/language/modules/develop/publish.html.md b/website/docs/language/modules/develop/publish.html.md index 93a17e3dfdd7..2f1419dbbaba 100644 --- a/website/docs/language/modules/develop/publish.html.md +++ b/website/docs/language/modules/develop/publish.html.md @@ -28,6 +28,9 @@ If you do not wish to publish your modules in the public registry, you can instead use a [private registry](/docs/registry/private.html) to get the same benefits. +We welcome contributions of Terraform modules from our community members, partners, and customers. Our ecosystem is made richer by each new module created or an existing one updated, as they reflect the wide range of experience and technical requirements of the community that uses them. Our cloud provider partners often seek to develop specific modules for popular or challenging use cases on their platform and utilize them as valuable learning experiences to empathize with their users. Similarly, our community module developers incorporate a variety of opinions and use cases from the broader Terraform community. Both types of modules have their place in the Terraform registry, accessible to practitioners who can decide which modules best fit their requirements. + + ## Distribution via other sources Although the registry is the native mechanism for distributing re-usable From fe671206cc85d6b9c21d8c89cafd4dadcbb6ca3d Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 29 Sep 2021 16:45:29 -0400 Subject: [PATCH 117/644] Add detail about the protocol deprecation Make sure it's clear that the deprecated fields serve no purpose, and should be ignored. --- docs/plugin-protocol/tfplugin6.1.proto | 3 +++ internal/tfplugin6/tfplugin6.pb.go | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/plugin-protocol/tfplugin6.1.proto b/docs/plugin-protocol/tfplugin6.1.proto index e8912cd0b799..3f6dead35e18 100644 --- a/docs/plugin-protocol/tfplugin6.1.proto +++ b/docs/plugin-protocol/tfplugin6.1.proto @@ -128,6 +128,9 @@ message Schema { repeated Attribute attributes = 1; NestingMode nesting = 3; + + // MinItems and MaxItems were never used in the protocol, and have no + // effect on validation. int64 min_items = 4 [deprecated = true]; int64 max_items = 5 [deprecated = true]; } diff --git a/internal/tfplugin6/tfplugin6.pb.go b/internal/tfplugin6/tfplugin6.pb.go index d3152b355b58..d73ab55ec009 100644 --- a/internal/tfplugin6/tfplugin6.pb.go +++ b/internal/tfplugin6/tfplugin6.pb.go @@ -1480,6 +1480,9 @@ type Schema_Object struct { Attributes []*Schema_Attribute `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes,omitempty"` Nesting Schema_Object_NestingMode `protobuf:"varint,3,opt,name=nesting,proto3,enum=tfplugin6.Schema_Object_NestingMode" json:"nesting,omitempty"` + // MinItems and MaxItems were never used in the protocol, and have no + // effect on validation. + // // Deprecated: Do not use. MinItems int64 `protobuf:"varint,4,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"` // Deprecated: Do not use. From 016463ea9c01fbfff0bbd4bb29b29b03d935be45 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 28 Sep 2021 17:57:10 -0400 Subject: [PATCH 118/644] don't check all ancestors for data depends_on Only depends_on ancestors for transitive dependencies when we're not pointed directly at a resource. We can't be much more precise here, since in order to maintain our guarantee that data sources will wait for explicit dependencies, if those dependencies happen to be a module, output, or variable, we have to find some upstream managed resource in order to check for a planned change. --- internal/terraform/transform_reference.go | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/internal/terraform/transform_reference.go b/internal/terraform/transform_reference.go index fe64e370770d..bd07161ca02e 100644 --- a/internal/terraform/transform_reference.go +++ b/internal/terraform/transform_reference.go @@ -353,11 +353,19 @@ func (m ReferenceMap) dependsOn(g *Graph, depender graphNodeDependsOn) ([]dag.Ve } res = append(res, rv) - // and check any ancestors for transitive dependencies - ans, _ := g.Ancestors(rv) - for _, v := range ans { - if isDependableResource(v) { - res = append(res, v) + // Check any ancestors for transitive dependencies when we're + // not pointed directly at a resource. We can't be much more + // precise here, since in order to maintain our guarantee that data + // sources will wait for explicit dependencies, if those dependencies + // happen to be a module, output, or variable, we have to find some + // upstream managed resource in order to check for a planned + // change. + if _, ok := rv.(GraphNodeConfigResource); !ok { + ans, _ := g.Ancestors(rv) + for _, v := range ans { + if isDependableResource(v) { + res = append(res, v) + } } } } From 618e9cf8ecd1b02323af7fa3e86a4dc9c4848379 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 30 Sep 2021 16:00:37 -0400 Subject: [PATCH 119/644] test for unexpected data reads --- internal/terraform/context_plan2_test.go | 108 +++++++++++++++++++++++ 1 file changed, 108 insertions(+) diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 6d54e9eef180..b1034d7fb62e 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -1971,3 +1971,111 @@ func TestContext2Plan_forceReplaceIncompleteAddr(t *testing.T) { } }) } + +// Verify that adding a module instance does force existing module data sources +// to be deferred +func TestContext2Plan_noChangeDataSourceAddingModuleInstance(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` +locals { + data = { + a = "a" + b = "b" + } +} + +module "one" { + source = "./mod" + for_each = local.data + input = each.value +} + +module "two" { + source = "./mod" + for_each = module.one + input = each.value.output +} +`, + "mod/main.tf": ` +variable "input" { +} + +resource "test_resource" "x" { + value = var.input +} + +data "test_data_source" "d" { + foo = test_resource.x.id +} + +output "output" { + value = test_resource.x.id +} +`, + }) + + p := testProvider("test") + p.ReadDataSourceResponse = &providers.ReadDataSourceResponse{ + State: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("data"), + "foo": cty.StringVal("foo"), + }), + } + state := states.NewState() + modOne := addrs.RootModuleInstance.Child("one", addrs.StringKey("a")) + modTwo := addrs.RootModuleInstance.Child("two", addrs.StringKey("a")) + one := state.EnsureModule(modOne) + two := state.EnsureModule(modTwo) + one.SetResourceInstanceCurrent( + mustResourceInstanceAddr(`test_resource.x`).Resource, + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"foo","value":"a"}`), + }, + mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`), + ) + one.SetResourceInstanceCurrent( + mustResourceInstanceAddr(`data.test_data_source.d`).Resource, + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"data"}`), + }, + mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`), + ) + two.SetResourceInstanceCurrent( + mustResourceInstanceAddr(`test_resource.x`).Resource, + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"foo","value":"foo"}`), + }, + mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`), + ) + two.SetResourceInstanceCurrent( + mustResourceInstanceAddr(`data.test_data_source.d`).Resource, + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectReady, + AttrsJSON: []byte(`{"id":"data"}`), + }, + mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`), + ) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + assertNoErrors(t, diags) + + for _, res := range plan.Changes.Resources { + // both existing data sources should be read during plan + if res.Addr.Module[0].InstanceKey == addrs.StringKey("b") { + continue + } + + if res.Addr.Resource.Resource.Mode == addrs.DataResourceMode && res.Action != plans.NoOp { + t.Errorf("unexpected %s plan for %s", res.Action, res.Addr) + } + } +} From 8d193ad268c6601ac917194e24f581ad36bb91d0 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 29 Sep 2021 15:51:09 -0700 Subject: [PATCH 120/644] core: Simplify and centralize plugin availability checks Historically the responsibility for making sure that all of the available providers are of suitable versions and match the appropriate checksums has been split rather inexplicably over multiple different layers, with some of the checks happening as late as creating a terraform.Context. We're gradually iterating towards making that all be handled in one place, but in this step we're just cleaning up some old remnants from the main "terraform" package, which is now no longer responsible for any version or checksum verification and instead just assumes it's been provided with suitable factory functions by its caller. We do still have a pre-check here to make sure that we at least have a factory function for each plugin the configuration seems to depend on, because if we don't do that up front then it ends up getting caught instead deep inside the Terraform runtime, often inside a concurrent graph walk and thus it's not deterministic which codepath will happen to catch it on a particular run. As of this commit, this actually does leave some holes in our checks: the command package is using the dependency lock file to make sure we have exactly the provider packages we expect (exact versions and checksums), which is the most crucial part, but we don't yet have any spot where we make sure that the lock file is consistent with the current configuration, and we are no longer preserving the provider checksums as part of a saved plan. Both of those will come in subsequent commits. While it's unusual to have a series of commits that briefly subtracts functionality and then adds back in equivalent functionality later, the lock file checking is the only part that's crucial for security reasons, with everything else mainly just being to give better feedback when folks seem to be using Terraform incorrectly. The other bits are therefore mostly cosmetic and okay to be absent briefly as we work towards a better design that is clearer about where that responsibility belongs. --- internal/backend/local/backend_local.go | 5 - internal/command/meta.go | 24 -- internal/command/plan_test.go | 2 +- internal/command/plugins_lock.go | 7 - .../plans/internal/planproto/planfile.pb.go | 369 +++++++----------- .../plans/internal/planproto/planfile.proto | 16 - internal/plans/plan.go | 1 - internal/plans/planfile/planfile_test.go | 1 - internal/plans/planfile/tfplan.go | 17 - internal/plans/planfile/tfplan_test.go | 8 - internal/terraform/context.go | 183 +++++---- internal/terraform/context_plan.go | 7 +- internal/terraform/context_plan_test.go | 7 - internal/terraform/context_plugins.go | 10 + internal/terraform/context_refresh_test.go | 5 +- internal/terraform/context_test.go | 266 +++++-------- internal/terraform/context_validate.go | 6 +- 17 files changed, 364 insertions(+), 570 deletions(-) diff --git a/internal/backend/local/backend_local.go b/internal/backend/local/backend_local.go index 0ba6e66fc681..5ce5929ee310 100644 --- a/internal/backend/local/backend_local.go +++ b/internal/backend/local/backend_local.go @@ -252,11 +252,6 @@ func (b *Local) localRunForPlanFile(pf *planfile.Reader, run *backend.LocalRun, // we need to apply the plan. run.Plan = plan - // When we're applying a saved plan, our context must verify that all of - // the providers it ends up using are identical to those which created - // the plan. - coreOpts.ProviderSHA256s = plan.ProviderSHA256s - tfCtx, moreDiags := terraform.NewContext(coreOpts) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { diff --git a/internal/command/meta.go b/internal/command/meta.go index 79e1b6f843a2..0a4029ef0151 100644 --- a/internal/command/meta.go +++ b/internal/command/meta.go @@ -478,32 +478,8 @@ func (m *Meta) contextOpts() (*terraform.ContextOpts, error) { } opts.Providers = providerFactories opts.Provisioners = m.provisionerFactories() - - // Read the dependency locks so that they can be verified against the - // provider requirements in the configuration - lockedDependencies, diags := m.lockedDependencies() - - // If the locks file is invalid, we should fail early rather than - // ignore it. A missing locks file will return no error. - if diags.HasErrors() { - return nil, diags.Err() - } - opts.LockedDependencies = lockedDependencies - - // If any unmanaged providers or dev overrides are enabled, they must - // be listed in the context so that they can be ignored when verifying - // the locks against the configuration - opts.ProvidersInDevelopment = make(map[addrs.Provider]struct{}) - for provider := range m.UnmanagedProviders { - opts.ProvidersInDevelopment[provider] = struct{}{} - } - for provider := range m.ProviderDevOverrides { - opts.ProvidersInDevelopment[provider] = struct{}{} - } } - opts.ProviderSHA256s = m.providerPluginsLock().Read() - opts.Meta = &terraform.ContextMeta{ Env: workspace, OriginalWorkingDir: m.WorkingDir.OriginalWorkingDir(), diff --git a/internal/command/plan_test.go b/internal/command/plan_test.go index 880f2e971e98..68f051f55532 100644 --- a/internal/command/plan_test.go +++ b/internal/command/plan_test.go @@ -1051,7 +1051,7 @@ func TestPlan_init_required(t *testing.T) { t.Fatalf("expected error, got success") } got := output.Stderr() - if !strings.Contains(got, `failed to read schema for test_instance.foo in registry.terraform.io/hashicorp/test`) { + if !strings.Contains(got, "Error: Missing required provider") { t.Fatal("wrong error message in output:", got) } } diff --git a/internal/command/plugins_lock.go b/internal/command/plugins_lock.go index b7f3c6b4e9db..03f11b71d286 100644 --- a/internal/command/plugins_lock.go +++ b/internal/command/plugins_lock.go @@ -5,15 +5,8 @@ import ( "fmt" "io/ioutil" "log" - "path/filepath" ) -func (m *Meta) providerPluginsLock() *pluginSHA256LockFile { - return &pluginSHA256LockFile{ - Filename: filepath.Join(m.pluginDir(), "lock.json"), - } -} - type pluginSHA256LockFile struct { Filename string } diff --git a/internal/plans/internal/planproto/planfile.pb.go b/internal/plans/internal/planproto/planfile.pb.go index beb50852ab15..a8810e0d746a 100644 --- a/internal/plans/internal/planproto/planfile.pb.go +++ b/internal/plans/internal/planproto/planfile.pb.go @@ -257,9 +257,6 @@ type Plan struct { ForceReplaceAddrs []string `protobuf:"bytes,16,rep,name=force_replace_addrs,json=forceReplaceAddrs,proto3" json:"force_replace_addrs,omitempty"` // The version string for the Terraform binary that created this plan. TerraformVersion string `protobuf:"bytes,14,opt,name=terraform_version,json=terraformVersion,proto3" json:"terraform_version,omitempty"` - // SHA256 digests of all of the provider plugin binaries that were used - // in the creation of this plan. - ProviderHashes map[string]*Hash `protobuf:"bytes,15,rep,name=provider_hashes,json=providerHashes,proto3" json:"provider_hashes,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // Backend is a description of the backend configuration and other related // settings at the time the plan was created. Backend *Backend `protobuf:"bytes,13,opt,name=backend,proto3" json:"backend,omitempty"` @@ -360,13 +357,6 @@ func (x *Plan) GetTerraformVersion() string { return "" } -func (x *Plan) GetProviderHashes() map[string]*Hash { - if x != nil { - return x.ProviderHashes - } - return nil -} - func (x *Plan) GetBackend() *Backend { if x != nil { return x.Backend @@ -785,61 +775,6 @@ func (x *DynamicValue) GetMsgpack() []byte { return nil } -// Hash represents a hash value. -// -// At present hashes always use the SHA256 algorithm. In future other hash -// algorithms may be used, possibly with a transitional period of including -// both as separate attributes of this type. Consumers must ignore attributes -// they don't support and fail if no supported attribute is present. The -// top-level format version will not be incremented for changes to the set of -// hash algorithms. -type Hash struct { - state protoimpl.MessageState - sizeCache protoimpl.SizeCache - unknownFields protoimpl.UnknownFields - - Sha256 []byte `protobuf:"bytes,1,opt,name=sha256,proto3" json:"sha256,omitempty"` -} - -func (x *Hash) Reset() { - *x = Hash{} - if protoimpl.UnsafeEnabled { - mi := &file_planfile_proto_msgTypes[6] - ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) - ms.StoreMessageInfo(mi) - } -} - -func (x *Hash) String() string { - return protoimpl.X.MessageStringOf(x) -} - -func (*Hash) ProtoMessage() {} - -func (x *Hash) ProtoReflect() protoreflect.Message { - mi := &file_planfile_proto_msgTypes[6] - if protoimpl.UnsafeEnabled && x != nil { - ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) - if ms.LoadMessageInfo() == nil { - ms.StoreMessageInfo(mi) - } - return ms - } - return mi.MessageOf(x) -} - -// Deprecated: Use Hash.ProtoReflect.Descriptor instead. -func (*Hash) Descriptor() ([]byte, []int) { - return file_planfile_proto_rawDescGZIP(), []int{6} -} - -func (x *Hash) GetSha256() []byte { - if x != nil { - return x.Sha256 - } - return nil -} - // Path represents a set of steps to traverse into a data structure. It is // used to refer to a sub-structure within a dynamic data structure presented // separately. @@ -854,7 +789,7 @@ type Path struct { func (x *Path) Reset() { *x = Path{} if protoimpl.UnsafeEnabled { - mi := &file_planfile_proto_msgTypes[7] + mi := &file_planfile_proto_msgTypes[6] ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) ms.StoreMessageInfo(mi) } @@ -867,7 +802,7 @@ func (x *Path) String() string { func (*Path) ProtoMessage() {} func (x *Path) ProtoReflect() protoreflect.Message { - mi := &file_planfile_proto_msgTypes[7] + mi := &file_planfile_proto_msgTypes[6] if protoimpl.UnsafeEnabled && x != nil { ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) if ms.LoadMessageInfo() == nil { @@ -880,7 +815,7 @@ func (x *Path) ProtoReflect() protoreflect.Message { // Deprecated: Use Path.ProtoReflect.Descriptor instead. func (*Path) Descriptor() ([]byte, []int) { - return file_planfile_proto_rawDescGZIP(), []int{7} + return file_planfile_proto_rawDescGZIP(), []int{6} } func (x *Path) GetSteps() []*Path_Step { @@ -904,7 +839,7 @@ type Path_Step struct { func (x *Path_Step) Reset() { *x = Path_Step{} if protoimpl.UnsafeEnabled { - mi := &file_planfile_proto_msgTypes[10] + mi := &file_planfile_proto_msgTypes[8] ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) ms.StoreMessageInfo(mi) } @@ -917,7 +852,7 @@ func (x *Path_Step) String() string { func (*Path_Step) ProtoMessage() {} func (x *Path_Step) ProtoReflect() protoreflect.Message { - mi := &file_planfile_proto_msgTypes[10] + mi := &file_planfile_proto_msgTypes[8] if protoimpl.UnsafeEnabled && x != nil { ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) if ms.LoadMessageInfo() == nil { @@ -930,7 +865,7 @@ func (x *Path_Step) ProtoReflect() protoreflect.Message { // Deprecated: Use Path_Step.ProtoReflect.Descriptor instead. func (*Path_Step) Descriptor() ([]byte, []int) { - return file_planfile_proto_rawDescGZIP(), []int{7, 0} + return file_planfile_proto_rawDescGZIP(), []int{6, 0} } func (m *Path_Step) GetSelector() isPath_Step_Selector { @@ -978,7 +913,7 @@ var File_planfile_proto protoreflect.FileDescriptor var file_planfile_proto_rawDesc = []byte{ 0x0a, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x66, 0x69, 0x6c, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, - 0x12, 0x06, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x22, 0xec, 0x05, 0x0a, 0x04, 0x50, 0x6c, 0x61, + 0x12, 0x06, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x22, 0xd0, 0x04, 0x0a, 0x04, 0x50, 0x6c, 0x61, 0x6e, 0x12, 0x18, 0x0a, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, 0x04, 0x52, 0x07, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x25, 0x0a, 0x07, 0x75, 0x69, 0x5f, 0x6d, 0x6f, 0x64, 0x65, 0x18, 0x11, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x0c, 0x2e, 0x74, @@ -1007,123 +942,111 @@ var file_planfile_proto_rawDesc = []byte{ 0x72, 0x63, 0x65, 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x41, 0x64, 0x64, 0x72, 0x73, 0x12, 0x2b, 0x0a, 0x11, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x5f, 0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x18, 0x0e, 0x20, 0x01, 0x28, 0x09, 0x52, 0x10, 0x74, 0x65, 0x72, 0x72, - 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x49, 0x0a, 0x0f, - 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x68, 0x61, 0x73, 0x68, 0x65, 0x73, 0x18, - 0x0f, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, - 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, - 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x52, 0x0e, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, - 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, 0x73, 0x12, 0x29, 0x0a, 0x07, 0x62, 0x61, 0x63, 0x6b, 0x65, - 0x6e, 0x64, 0x18, 0x0d, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, - 0x6e, 0x2e, 0x42, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x52, 0x07, 0x62, 0x61, 0x63, 0x6b, 0x65, - 0x6e, 0x64, 0x1a, 0x52, 0x0a, 0x0e, 0x56, 0x61, 0x72, 0x69, 0x61, 0x62, 0x6c, 0x65, 0x73, 0x45, - 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, - 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x2a, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, - 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, - 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x76, 0x61, 0x6c, - 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x1a, 0x4f, 0x0a, 0x13, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, - 0x65, 0x72, 0x48, 0x61, 0x73, 0x68, 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, - 0x03, 0x6b, 0x65, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, - 0x22, 0x0a, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0c, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x48, 0x61, 0x73, 0x68, 0x52, 0x05, 0x76, 0x61, - 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x22, 0x69, 0x0a, 0x07, 0x42, 0x61, 0x63, 0x6b, 0x65, - 0x6e, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x74, 0x79, 0x70, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, - 0x52, 0x04, 0x74, 0x79, 0x70, 0x65, 0x12, 0x2c, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, - 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, - 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, - 0x6e, 0x66, 0x69, 0x67, 0x12, 0x1c, 0x0a, 0x09, 0x77, 0x6f, 0x72, 0x6b, 0x73, 0x70, 0x61, 0x63, - 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x77, 0x6f, 0x72, 0x6b, 0x73, 0x70, 0x61, - 0x63, 0x65, 0x22, 0xe4, 0x01, 0x0a, 0x06, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x0a, - 0x06, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x0e, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x06, 0x61, - 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x2c, 0x0a, 0x06, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x73, 0x18, - 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, - 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x76, 0x61, 0x6c, - 0x75, 0x65, 0x73, 0x12, 0x42, 0x0a, 0x16, 0x62, 0x65, 0x66, 0x6f, 0x72, 0x65, 0x5f, 0x73, 0x65, - 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, 0x18, 0x03, 0x20, - 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, - 0x68, 0x52, 0x14, 0x62, 0x65, 0x66, 0x6f, 0x72, 0x65, 0x53, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, - 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, 0x12, 0x40, 0x0a, 0x15, 0x61, 0x66, 0x74, 0x65, 0x72, - 0x5f, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, 0x73, - 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, - 0x50, 0x61, 0x74, 0x68, 0x52, 0x13, 0x61, 0x66, 0x74, 0x65, 0x72, 0x53, 0x65, 0x6e, 0x73, 0x69, - 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, 0x22, 0xd3, 0x02, 0x0a, 0x16, 0x52, 0x65, - 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x43, 0x68, - 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0d, 0x20, 0x01, - 0x28, 0x09, 0x52, 0x04, 0x61, 0x64, 0x64, 0x72, 0x12, 0x22, 0x0a, 0x0d, 0x70, 0x72, 0x65, 0x76, - 0x5f, 0x72, 0x75, 0x6e, 0x5f, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0e, 0x20, 0x01, 0x28, 0x09, 0x52, - 0x0b, 0x70, 0x72, 0x65, 0x76, 0x52, 0x75, 0x6e, 0x41, 0x64, 0x64, 0x72, 0x12, 0x1f, 0x0a, 0x0b, - 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x07, 0x20, 0x01, 0x28, - 0x09, 0x52, 0x0a, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x4b, 0x65, 0x79, 0x12, 0x1a, 0x0a, - 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x08, 0x20, 0x01, 0x28, 0x09, 0x52, - 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, - 0x6e, 0x67, 0x65, 0x18, 0x09, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, - 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x0a, 0x20, 0x01, - 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x10, 0x72, - 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x5f, 0x72, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x18, - 0x0b, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, - 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x52, 0x65, 0x70, - 0x6c, 0x61, 0x63, 0x65, 0x12, 0x49, 0x0a, 0x0d, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x5f, 0x72, - 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x18, 0x0c, 0x20, 0x01, 0x28, 0x0e, 0x32, 0x24, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, - 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, - 0x6e, 0x52, 0x0c, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x22, - 0x68, 0x0a, 0x0c, 0x4f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, - 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, - 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x02, 0x20, - 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, - 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x1c, 0x0a, 0x09, 0x73, - 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x08, 0x52, 0x09, - 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x22, 0x28, 0x0a, 0x0c, 0x44, 0x79, 0x6e, - 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x6d, 0x73, 0x67, - 0x70, 0x61, 0x63, 0x6b, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x6d, 0x73, 0x67, 0x70, - 0x61, 0x63, 0x6b, 0x22, 0x1e, 0x0a, 0x04, 0x48, 0x61, 0x73, 0x68, 0x12, 0x16, 0x0a, 0x06, 0x73, - 0x68, 0x61, 0x32, 0x35, 0x36, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x06, 0x73, 0x68, 0x61, - 0x32, 0x35, 0x36, 0x22, 0xa5, 0x01, 0x0a, 0x04, 0x50, 0x61, 0x74, 0x68, 0x12, 0x27, 0x0a, 0x05, - 0x73, 0x74, 0x65, 0x70, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x11, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x2e, 0x53, 0x74, 0x65, 0x70, 0x52, 0x05, - 0x73, 0x74, 0x65, 0x70, 0x73, 0x1a, 0x74, 0x0a, 0x04, 0x53, 0x74, 0x65, 0x70, 0x12, 0x27, 0x0a, - 0x0e, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, - 0x01, 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, 0x52, 0x0d, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, - 0x74, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, - 0x74, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, - 0x65, 0x48, 0x00, 0x52, 0x0a, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x4b, 0x65, 0x79, 0x42, - 0x0a, 0x0a, 0x08, 0x73, 0x65, 0x6c, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x2a, 0x31, 0x0a, 0x04, 0x4d, - 0x6f, 0x64, 0x65, 0x12, 0x0a, 0x0a, 0x06, 0x4e, 0x4f, 0x52, 0x4d, 0x41, 0x4c, 0x10, 0x00, 0x12, - 0x0b, 0x0a, 0x07, 0x44, 0x45, 0x53, 0x54, 0x52, 0x4f, 0x59, 0x10, 0x01, 0x12, 0x10, 0x0a, 0x0c, - 0x52, 0x45, 0x46, 0x52, 0x45, 0x53, 0x48, 0x5f, 0x4f, 0x4e, 0x4c, 0x59, 0x10, 0x02, 0x2a, 0x70, - 0x0a, 0x06, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4f, 0x50, - 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x01, 0x12, 0x08, - 0x0a, 0x04, 0x52, 0x45, 0x41, 0x44, 0x10, 0x02, 0x12, 0x0a, 0x0a, 0x06, 0x55, 0x50, 0x44, 0x41, - 0x54, 0x45, 0x10, 0x03, 0x12, 0x0a, 0x0a, 0x06, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x05, - 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, - 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x06, 0x12, 0x16, 0x0a, 0x12, 0x43, 0x52, 0x45, 0x41, - 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x10, 0x07, - 0x2a, 0xa7, 0x02, 0x0a, 0x1c, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, - 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, 0x73, 0x6f, - 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, 0x1b, 0x0a, 0x17, 0x52, - 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x54, - 0x41, 0x49, 0x4e, 0x54, 0x45, 0x44, 0x10, 0x01, 0x12, 0x16, 0x0a, 0x12, 0x52, 0x45, 0x50, 0x4c, - 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, 0x5f, 0x52, 0x45, 0x51, 0x55, 0x45, 0x53, 0x54, 0x10, 0x02, - 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, - 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, 0x4e, 0x4e, 0x4f, 0x54, 0x5f, 0x55, 0x50, 0x44, 0x41, 0x54, - 0x45, 0x10, 0x03, 0x12, 0x25, 0x0a, 0x21, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, - 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x4e, 0x4f, 0x5f, 0x52, 0x45, 0x53, 0x4f, 0x55, 0x52, 0x43, - 0x45, 0x5f, 0x43, 0x4f, 0x4e, 0x46, 0x49, 0x47, 0x10, 0x04, 0x12, 0x23, 0x0a, 0x1f, 0x44, 0x45, - 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x57, 0x52, 0x4f, - 0x4e, 0x47, 0x5f, 0x52, 0x45, 0x50, 0x45, 0x54, 0x49, 0x54, 0x49, 0x4f, 0x4e, 0x10, 0x05, 0x12, - 0x1e, 0x0a, 0x1a, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, - 0x45, 0x5f, 0x43, 0x4f, 0x55, 0x4e, 0x54, 0x5f, 0x49, 0x4e, 0x44, 0x45, 0x58, 0x10, 0x06, 0x12, - 0x1b, 0x0a, 0x17, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, - 0x45, 0x5f, 0x45, 0x41, 0x43, 0x48, 0x5f, 0x4b, 0x45, 0x59, 0x10, 0x07, 0x12, 0x1c, 0x0a, 0x18, - 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x4e, - 0x4f, 0x5f, 0x4d, 0x4f, 0x44, 0x55, 0x4c, 0x45, 0x10, 0x08, 0x42, 0x42, 0x5a, 0x40, 0x67, 0x69, - 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, - 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, - 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x73, 0x2f, 0x69, 0x6e, 0x74, 0x65, - 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x06, - 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x61, 0x66, 0x6f, 0x72, 0x6d, 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x12, 0x29, 0x0a, 0x07, + 0x62, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x18, 0x0d, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0f, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x42, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x52, 0x07, + 0x62, 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x1a, 0x52, 0x0a, 0x0e, 0x56, 0x61, 0x72, 0x69, 0x61, + 0x62, 0x6c, 0x65, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, + 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x2a, 0x0a, 0x05, 0x76, + 0x61, 0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, + 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x3a, 0x02, 0x38, 0x01, 0x22, 0x69, 0x0a, 0x07, 0x42, + 0x61, 0x63, 0x6b, 0x65, 0x6e, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x74, 0x79, 0x70, 0x65, 0x18, 0x01, + 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x74, 0x79, 0x70, 0x65, 0x12, 0x2c, 0x0a, 0x06, 0x63, 0x6f, + 0x6e, 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, + 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x1c, 0x0a, 0x09, 0x77, 0x6f, 0x72, 0x6b, + 0x73, 0x70, 0x61, 0x63, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x09, 0x77, 0x6f, 0x72, + 0x6b, 0x73, 0x70, 0x61, 0x63, 0x65, 0x22, 0xe4, 0x01, 0x0a, 0x06, 0x43, 0x68, 0x61, 0x6e, 0x67, + 0x65, 0x12, 0x26, 0x0a, 0x06, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x18, 0x01, 0x20, 0x01, 0x28, + 0x0e, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x41, 0x63, 0x74, 0x69, 0x6f, + 0x6e, 0x52, 0x06, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x2c, 0x0a, 0x06, 0x76, 0x61, 0x6c, + 0x75, 0x65, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, + 0x06, 0x76, 0x61, 0x6c, 0x75, 0x65, 0x73, 0x12, 0x42, 0x0a, 0x16, 0x62, 0x65, 0x66, 0x6f, 0x72, + 0x65, 0x5f, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x5f, 0x70, 0x61, 0x74, 0x68, + 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, + 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x14, 0x62, 0x65, 0x66, 0x6f, 0x72, 0x65, 0x53, 0x65, 0x6e, + 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, 0x12, 0x40, 0x0a, 0x15, 0x61, + 0x66, 0x74, 0x65, 0x72, 0x5f, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x5f, 0x70, + 0x61, 0x74, 0x68, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x13, 0x61, 0x66, 0x74, 0x65, 0x72, 0x53, + 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x50, 0x61, 0x74, 0x68, 0x73, 0x22, 0xd3, 0x02, + 0x0a, 0x16, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, + 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x61, 0x64, 0x64, 0x72, + 0x18, 0x0d, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x61, 0x64, 0x64, 0x72, 0x12, 0x22, 0x0a, 0x0d, + 0x70, 0x72, 0x65, 0x76, 0x5f, 0x72, 0x75, 0x6e, 0x5f, 0x61, 0x64, 0x64, 0x72, 0x18, 0x0e, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x0b, 0x70, 0x72, 0x65, 0x76, 0x52, 0x75, 0x6e, 0x41, 0x64, 0x64, 0x72, + 0x12, 0x1f, 0x0a, 0x0b, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x5f, 0x6b, 0x65, 0x79, 0x18, + 0x07, 0x20, 0x01, 0x28, 0x09, 0x52, 0x0a, 0x64, 0x65, 0x70, 0x6f, 0x73, 0x65, 0x64, 0x4b, 0x65, + 0x79, 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x18, 0x08, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x26, 0x0a, + 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x18, 0x09, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, + 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, + 0x18, 0x0a, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, + 0x37, 0x0a, 0x10, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, 0x64, 0x5f, 0x72, 0x65, 0x70, 0x6c, + 0x61, 0x63, 0x65, 0x18, 0x0b, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x0c, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x52, 0x0f, 0x72, 0x65, 0x71, 0x75, 0x69, 0x72, 0x65, + 0x64, 0x52, 0x65, 0x70, 0x6c, 0x61, 0x63, 0x65, 0x12, 0x49, 0x0a, 0x0d, 0x61, 0x63, 0x74, 0x69, + 0x6f, 0x6e, 0x5f, 0x72, 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x18, 0x0c, 0x20, 0x01, 0x28, 0x0e, 0x32, + 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, + 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x52, 0x0c, 0x61, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x61, + 0x73, 0x6f, 0x6e, 0x22, 0x68, 0x0a, 0x0c, 0x4f, 0x75, 0x74, 0x70, 0x75, 0x74, 0x43, 0x68, 0x61, + 0x6e, 0x67, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, + 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, + 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x0e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, + 0x2e, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x52, 0x06, 0x63, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, + 0x1c, 0x0a, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x18, 0x03, 0x20, 0x01, + 0x28, 0x08, 0x52, 0x09, 0x73, 0x65, 0x6e, 0x73, 0x69, 0x74, 0x69, 0x76, 0x65, 0x22, 0x28, 0x0a, + 0x0c, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x12, 0x18, 0x0a, + 0x07, 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, + 0x6d, 0x73, 0x67, 0x70, 0x61, 0x63, 0x6b, 0x22, 0xa5, 0x01, 0x0a, 0x04, 0x50, 0x61, 0x74, 0x68, + 0x12, 0x27, 0x0a, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, + 0x11, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x50, 0x61, 0x74, 0x68, 0x2e, 0x53, 0x74, + 0x65, 0x70, 0x52, 0x05, 0x73, 0x74, 0x65, 0x70, 0x73, 0x1a, 0x74, 0x0a, 0x04, 0x53, 0x74, 0x65, + 0x70, 0x12, 0x27, 0x0a, 0x0e, 0x61, 0x74, 0x74, 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x5f, 0x6e, + 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x48, 0x00, 0x52, 0x0d, 0x61, 0x74, 0x74, + 0x72, 0x69, 0x62, 0x75, 0x74, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x65, 0x6c, + 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x5f, 0x6b, 0x65, 0x79, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, + 0x14, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x61, 0x6e, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, + 0x56, 0x61, 0x6c, 0x75, 0x65, 0x48, 0x00, 0x52, 0x0a, 0x65, 0x6c, 0x65, 0x6d, 0x65, 0x6e, 0x74, + 0x4b, 0x65, 0x79, 0x42, 0x0a, 0x0a, 0x08, 0x73, 0x65, 0x6c, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x2a, + 0x31, 0x0a, 0x04, 0x4d, 0x6f, 0x64, 0x65, 0x12, 0x0a, 0x0a, 0x06, 0x4e, 0x4f, 0x52, 0x4d, 0x41, + 0x4c, 0x10, 0x00, 0x12, 0x0b, 0x0a, 0x07, 0x44, 0x45, 0x53, 0x54, 0x52, 0x4f, 0x59, 0x10, 0x01, + 0x12, 0x10, 0x0a, 0x0c, 0x52, 0x45, 0x46, 0x52, 0x45, 0x53, 0x48, 0x5f, 0x4f, 0x4e, 0x4c, 0x59, + 0x10, 0x02, 0x2a, 0x70, 0x0a, 0x06, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, + 0x4e, 0x4f, 0x4f, 0x50, 0x10, 0x00, 0x12, 0x0a, 0x0a, 0x06, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, + 0x10, 0x01, 0x12, 0x08, 0x0a, 0x04, 0x52, 0x45, 0x41, 0x44, 0x10, 0x02, 0x12, 0x0a, 0x0a, 0x06, + 0x55, 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x12, 0x0a, 0x0a, 0x06, 0x44, 0x45, 0x4c, 0x45, + 0x54, 0x45, 0x10, 0x05, 0x12, 0x16, 0x0a, 0x12, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x54, + 0x48, 0x45, 0x4e, 0x5f, 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x10, 0x06, 0x12, 0x16, 0x0a, 0x12, + 0x43, 0x52, 0x45, 0x41, 0x54, 0x45, 0x5f, 0x54, 0x48, 0x45, 0x4e, 0x5f, 0x44, 0x45, 0x4c, 0x45, + 0x54, 0x45, 0x10, 0x07, 0x2a, 0xa7, 0x02, 0x0a, 0x1c, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6e, 0x63, 0x65, 0x41, 0x63, 0x74, 0x69, 0x6f, 0x6e, 0x52, + 0x65, 0x61, 0x73, 0x6f, 0x6e, 0x12, 0x08, 0x0a, 0x04, 0x4e, 0x4f, 0x4e, 0x45, 0x10, 0x00, 0x12, + 0x1b, 0x0a, 0x17, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, + 0x53, 0x45, 0x5f, 0x54, 0x41, 0x49, 0x4e, 0x54, 0x45, 0x44, 0x10, 0x01, 0x12, 0x16, 0x0a, 0x12, + 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, 0x42, 0x59, 0x5f, 0x52, 0x45, 0x51, 0x55, 0x45, + 0x53, 0x54, 0x10, 0x02, 0x12, 0x21, 0x0a, 0x1d, 0x52, 0x45, 0x50, 0x4c, 0x41, 0x43, 0x45, 0x5f, + 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x43, 0x41, 0x4e, 0x4e, 0x4f, 0x54, 0x5f, 0x55, + 0x50, 0x44, 0x41, 0x54, 0x45, 0x10, 0x03, 0x12, 0x25, 0x0a, 0x21, 0x44, 0x45, 0x4c, 0x45, 0x54, + 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x4e, 0x4f, 0x5f, 0x52, 0x45, 0x53, + 0x4f, 0x55, 0x52, 0x43, 0x45, 0x5f, 0x43, 0x4f, 0x4e, 0x46, 0x49, 0x47, 0x10, 0x04, 0x12, 0x23, + 0x0a, 0x1f, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, 0x53, 0x45, + 0x5f, 0x57, 0x52, 0x4f, 0x4e, 0x47, 0x5f, 0x52, 0x45, 0x50, 0x45, 0x54, 0x49, 0x54, 0x49, 0x4f, + 0x4e, 0x10, 0x05, 0x12, 0x1e, 0x0a, 0x1a, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, + 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x43, 0x4f, 0x55, 0x4e, 0x54, 0x5f, 0x49, 0x4e, 0x44, 0x45, + 0x58, 0x10, 0x06, 0x12, 0x1b, 0x0a, 0x17, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, + 0x43, 0x41, 0x55, 0x53, 0x45, 0x5f, 0x45, 0x41, 0x43, 0x48, 0x5f, 0x4b, 0x45, 0x59, 0x10, 0x07, + 0x12, 0x1c, 0x0a, 0x18, 0x44, 0x45, 0x4c, 0x45, 0x54, 0x45, 0x5f, 0x42, 0x45, 0x43, 0x41, 0x55, + 0x53, 0x45, 0x5f, 0x4e, 0x4f, 0x5f, 0x4d, 0x4f, 0x44, 0x55, 0x4c, 0x45, 0x10, 0x08, 0x42, 0x42, + 0x5a, 0x40, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, + 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, + 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x73, 0x2f, + 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x70, 0x6c, 0x61, 0x6e, 0x70, 0x72, 0x6f, + 0x74, 0x6f, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( @@ -1139,7 +1062,7 @@ func file_planfile_proto_rawDescGZIP() []byte { } var file_planfile_proto_enumTypes = make([]protoimpl.EnumInfo, 3) -var file_planfile_proto_msgTypes = make([]protoimpl.MessageInfo, 11) +var file_planfile_proto_msgTypes = make([]protoimpl.MessageInfo, 9) var file_planfile_proto_goTypes = []interface{}{ (Mode)(0), // 0: tfplan.Mode (Action)(0), // 1: tfplan.Action @@ -1150,38 +1073,34 @@ var file_planfile_proto_goTypes = []interface{}{ (*ResourceInstanceChange)(nil), // 6: tfplan.ResourceInstanceChange (*OutputChange)(nil), // 7: tfplan.OutputChange (*DynamicValue)(nil), // 8: tfplan.DynamicValue - (*Hash)(nil), // 9: tfplan.Hash - (*Path)(nil), // 10: tfplan.Path - nil, // 11: tfplan.Plan.VariablesEntry - nil, // 12: tfplan.Plan.ProviderHashesEntry - (*Path_Step)(nil), // 13: tfplan.Path.Step + (*Path)(nil), // 9: tfplan.Path + nil, // 10: tfplan.Plan.VariablesEntry + (*Path_Step)(nil), // 11: tfplan.Path.Step } var file_planfile_proto_depIdxs = []int32{ 0, // 0: tfplan.Plan.ui_mode:type_name -> tfplan.Mode - 11, // 1: tfplan.Plan.variables:type_name -> tfplan.Plan.VariablesEntry + 10, // 1: tfplan.Plan.variables:type_name -> tfplan.Plan.VariablesEntry 6, // 2: tfplan.Plan.resource_changes:type_name -> tfplan.ResourceInstanceChange 6, // 3: tfplan.Plan.resource_drift:type_name -> tfplan.ResourceInstanceChange 7, // 4: tfplan.Plan.output_changes:type_name -> tfplan.OutputChange - 12, // 5: tfplan.Plan.provider_hashes:type_name -> tfplan.Plan.ProviderHashesEntry - 4, // 6: tfplan.Plan.backend:type_name -> tfplan.Backend - 8, // 7: tfplan.Backend.config:type_name -> tfplan.DynamicValue - 1, // 8: tfplan.Change.action:type_name -> tfplan.Action - 8, // 9: tfplan.Change.values:type_name -> tfplan.DynamicValue - 10, // 10: tfplan.Change.before_sensitive_paths:type_name -> tfplan.Path - 10, // 11: tfplan.Change.after_sensitive_paths:type_name -> tfplan.Path - 5, // 12: tfplan.ResourceInstanceChange.change:type_name -> tfplan.Change - 10, // 13: tfplan.ResourceInstanceChange.required_replace:type_name -> tfplan.Path - 2, // 14: tfplan.ResourceInstanceChange.action_reason:type_name -> tfplan.ResourceInstanceActionReason - 5, // 15: tfplan.OutputChange.change:type_name -> tfplan.Change - 13, // 16: tfplan.Path.steps:type_name -> tfplan.Path.Step - 8, // 17: tfplan.Plan.VariablesEntry.value:type_name -> tfplan.DynamicValue - 9, // 18: tfplan.Plan.ProviderHashesEntry.value:type_name -> tfplan.Hash - 8, // 19: tfplan.Path.Step.element_key:type_name -> tfplan.DynamicValue - 20, // [20:20] is the sub-list for method output_type - 20, // [20:20] is the sub-list for method input_type - 20, // [20:20] is the sub-list for extension type_name - 20, // [20:20] is the sub-list for extension extendee - 0, // [0:20] is the sub-list for field type_name + 4, // 5: tfplan.Plan.backend:type_name -> tfplan.Backend + 8, // 6: tfplan.Backend.config:type_name -> tfplan.DynamicValue + 1, // 7: tfplan.Change.action:type_name -> tfplan.Action + 8, // 8: tfplan.Change.values:type_name -> tfplan.DynamicValue + 9, // 9: tfplan.Change.before_sensitive_paths:type_name -> tfplan.Path + 9, // 10: tfplan.Change.after_sensitive_paths:type_name -> tfplan.Path + 5, // 11: tfplan.ResourceInstanceChange.change:type_name -> tfplan.Change + 9, // 12: tfplan.ResourceInstanceChange.required_replace:type_name -> tfplan.Path + 2, // 13: tfplan.ResourceInstanceChange.action_reason:type_name -> tfplan.ResourceInstanceActionReason + 5, // 14: tfplan.OutputChange.change:type_name -> tfplan.Change + 11, // 15: tfplan.Path.steps:type_name -> tfplan.Path.Step + 8, // 16: tfplan.Plan.VariablesEntry.value:type_name -> tfplan.DynamicValue + 8, // 17: tfplan.Path.Step.element_key:type_name -> tfplan.DynamicValue + 18, // [18:18] is the sub-list for method output_type + 18, // [18:18] is the sub-list for method input_type + 18, // [18:18] is the sub-list for extension type_name + 18, // [18:18] is the sub-list for extension extendee + 0, // [0:18] is the sub-list for field type_name } func init() { file_planfile_proto_init() } @@ -1263,18 +1182,6 @@ func file_planfile_proto_init() { } } file_planfile_proto_msgTypes[6].Exporter = func(v interface{}, i int) interface{} { - switch v := v.(*Hash); i { - case 0: - return &v.state - case 1: - return &v.sizeCache - case 2: - return &v.unknownFields - default: - return nil - } - } - file_planfile_proto_msgTypes[7].Exporter = func(v interface{}, i int) interface{} { switch v := v.(*Path); i { case 0: return &v.state @@ -1286,7 +1193,7 @@ func file_planfile_proto_init() { return nil } } - file_planfile_proto_msgTypes[10].Exporter = func(v interface{}, i int) interface{} { + file_planfile_proto_msgTypes[8].Exporter = func(v interface{}, i int) interface{} { switch v := v.(*Path_Step); i { case 0: return &v.state @@ -1299,7 +1206,7 @@ func file_planfile_proto_init() { } } } - file_planfile_proto_msgTypes[10].OneofWrappers = []interface{}{ + file_planfile_proto_msgTypes[8].OneofWrappers = []interface{}{ (*Path_Step_AttributeName)(nil), (*Path_Step_ElementKey)(nil), } @@ -1309,7 +1216,7 @@ func file_planfile_proto_init() { GoPackagePath: reflect.TypeOf(x{}).PkgPath(), RawDescriptor: file_planfile_proto_rawDesc, NumEnums: 3, - NumMessages: 11, + NumMessages: 9, NumExtensions: 0, NumServices: 0, }, diff --git a/internal/plans/internal/planproto/planfile.proto b/internal/plans/internal/planproto/planfile.proto index 1bbe7425e502..752abd77ac5a 100644 --- a/internal/plans/internal/planproto/planfile.proto +++ b/internal/plans/internal/planproto/planfile.proto @@ -58,10 +58,6 @@ message Plan { // The version string for the Terraform binary that created this plan. string terraform_version = 14; - // SHA256 digests of all of the provider plugin binaries that were used - // in the creation of this plan. - map provider_hashes = 15; - // Backend is a description of the backend configuration and other related // settings at the time the plan was created. Backend backend = 13; @@ -218,18 +214,6 @@ message DynamicValue { bytes msgpack = 1; } -// Hash represents a hash value. -// -// At present hashes always use the SHA256 algorithm. In future other hash -// algorithms may be used, possibly with a transitional period of including -// both as separate attributes of this type. Consumers must ignore attributes -// they don't support and fail if no supported attribute is present. The -// top-level format version will not be incremented for changes to the set of -// hash algorithms. -message Hash { - bytes sha256 = 1; -} - // Path represents a set of steps to traverse into a data structure. It is // used to refer to a sub-structure within a dynamic data structure presented // separately. diff --git a/internal/plans/plan.go b/internal/plans/plan.go index a96a056480e1..da824f24ab3e 100644 --- a/internal/plans/plan.go +++ b/internal/plans/plan.go @@ -34,7 +34,6 @@ type Plan struct { DriftedResources []*ResourceInstanceChangeSrc TargetAddrs []addrs.Targetable ForceReplaceAddrs []addrs.AbsResourceInstance - ProviderSHA256s map[string][]byte Backend Backend // PrevRunState and PriorState both describe the situation that the plan diff --git a/internal/plans/planfile/planfile_test.go b/internal/plans/planfile/planfile_test.go index 14d23c87a67b..13e456666ae4 100644 --- a/internal/plans/planfile/planfile_test.go +++ b/internal/plans/planfile/planfile_test.go @@ -52,7 +52,6 @@ func TestRoundtrip(t *testing.T) { Outputs: []*plans.OutputChangeSrc{}, }, DriftedResources: []*plans.ResourceInstanceChangeSrc{}, - ProviderSHA256s: map[string][]byte{}, VariableValues: map[string]plans.DynamicValue{ "foo": plans.DynamicValue([]byte("foo placeholder")), }, diff --git a/internal/plans/planfile/tfplan.go b/internal/plans/planfile/tfplan.go index 87d21822efc8..47f95a2a3260 100644 --- a/internal/plans/planfile/tfplan.go +++ b/internal/plans/planfile/tfplan.go @@ -57,8 +57,6 @@ func readTfplan(r io.Reader) (*plans.Plan, error) { Resources: []*plans.ResourceInstanceChangeSrc{}, }, DriftedResources: []*plans.ResourceInstanceChangeSrc{}, - - ProviderSHA256s: map[string][]byte{}, } switch rawPlan.UiMode { @@ -125,14 +123,6 @@ func readTfplan(r io.Reader) (*plans.Plan, error) { plan.ForceReplaceAddrs = append(plan.ForceReplaceAddrs, addr) } - for name, rawHashObj := range rawPlan.ProviderHashes { - if len(rawHashObj.Sha256) == 0 { - return nil, fmt.Errorf("no SHA256 hash for provider %q plugin", name) - } - - plan.ProviderSHA256s[name] = rawHashObj.Sha256 - } - for name, rawVal := range rawPlan.Variables { val, err := valueFromTfplan(rawVal) if err != nil { @@ -358,7 +348,6 @@ func writeTfplan(plan *plans.Plan, w io.Writer) error { rawPlan := &planproto.Plan{ Version: tfplanFormatVersion, TerraformVersion: version.String(), - ProviderHashes: map[string]*planproto.Hash{}, Variables: map[string]*planproto.DynamicValue{}, OutputChanges: []*planproto.OutputChange{}, @@ -426,12 +415,6 @@ func writeTfplan(plan *plans.Plan, w io.Writer) error { rawPlan.ForceReplaceAddrs = append(rawPlan.ForceReplaceAddrs, replaceAddr.String()) } - for name, hash := range plan.ProviderSHA256s { - rawPlan.ProviderHashes[name] = &planproto.Hash{ - Sha256: hash, - } - } - for name, val := range plan.VariableValues { rawPlan.Variables[name] = valueToTfplan(val) } diff --git a/internal/plans/planfile/tfplan_test.go b/internal/plans/planfile/tfplan_test.go index 7ab62de532d7..7d5be4dc5713 100644 --- a/internal/plans/planfile/tfplan_test.go +++ b/internal/plans/planfile/tfplan_test.go @@ -165,14 +165,6 @@ func TestTFPlanRoundTrip(t *testing.T) { Name: "woot", }.Absolute(addrs.RootModuleInstance), }, - ProviderSHA256s: map[string][]byte{ - "test": []byte{ - 0xba, 0x5e, 0x1e, 0x55, 0xb0, 0x1d, 0xfa, 0xce, - 0xef, 0xfe, 0xc7, 0xed, 0x1a, 0xbe, 0x11, 0xed, - 0x5c, 0xa1, 0xab, 0x1e, 0xda, 0x7a, 0xba, 0x5e, - 0x70, 0x7a, 0x11, 0xed, 0xb0, 0x07, 0xab, 0x1e, - }, - }, Backend: plans.Backend{ Type: "local", Config: mustNewDynamicValue( diff --git a/internal/terraform/context.go b/internal/terraform/context.go index e05200e1e527..2174b0fe0e78 100644 --- a/internal/terraform/context.go +++ b/internal/terraform/context.go @@ -4,10 +4,9 @@ import ( "context" "fmt" "log" - "strings" + "sort" "sync" - "github.com/apparentlymart/go-versions/versions" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/providers" @@ -16,8 +15,6 @@ import ( "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" - "github.com/hashicorp/terraform/internal/depsfile" - "github.com/hashicorp/terraform/internal/getproviders" _ "github.com/hashicorp/terraform/internal/logging" ) @@ -43,18 +40,6 @@ type ContextOpts struct { Providers map[addrs.Provider]providers.Factory Provisioners map[string]provisioners.Factory - // If non-nil, will apply as additional constraints on the provider - // plugins that will be requested from the provider resolver. - ProviderSHA256s map[string][]byte - - // If non-nil, will be verified to ensure that provider requirements from - // configuration can be satisfied by the set of locked dependencies. - LockedDependencies *depsfile.Locks - - // Set of providers to exclude from the requirements check process, as they - // are marked as in local development. - ProvidersInDevelopment map[addrs.Provider]struct{} - UIInput UIInput } @@ -88,9 +73,7 @@ type Context struct { // operations. meta *ContextMeta - plugins *contextPlugins - dependencyLocks *depsfile.Locks - providersInDevelopment map[addrs.Provider]struct{} + plugins *contextPlugins hooks []Hook sh *stopHook @@ -99,7 +82,6 @@ type Context struct { l sync.Mutex // Lock acquired during any task parallelSem Semaphore providerInputConfig map[string]map[string]cty.Value - providerSHA256s map[string][]byte runCond *sync.Cond runContext context.Context runContextCancel context.CancelFunc @@ -153,13 +135,10 @@ func NewContext(opts *ContextOpts) (*Context, tfdiags.Diagnostics) { meta: opts.Meta, uiInput: opts.UIInput, - plugins: plugins, - dependencyLocks: opts.LockedDependencies, - providersInDevelopment: opts.ProvidersInDevelopment, + plugins: plugins, parallelSem: NewSemaphore(par), providerInputConfig: make(map[string]map[string]cty.Value), - providerSHA256s: opts.ProviderSHA256s, sh: sh, }, diags } @@ -174,50 +153,6 @@ func (c *Context) Schemas(config *configs.Config, state *states.State) (*Schemas var diags tfdiags.Diagnostics - // If we have a configuration and a set of locked dependencies, verify that - // the provider requirements from the configuration can be satisfied by the - // locked dependencies. - if c.dependencyLocks != nil && config != nil { - reqs, providerDiags := config.ProviderRequirements() - diags = diags.Append(providerDiags) - - locked := c.dependencyLocks.AllProviders() - unmetReqs := make(getproviders.Requirements) - for provider, versionConstraints := range reqs { - // Builtin providers are not listed in the locks file - if provider.IsBuiltIn() { - continue - } - // Development providers must be excluded from this check - if _, ok := c.providersInDevelopment[provider]; ok { - continue - } - // If the required provider doesn't exist in the lock, or the - // locked version doesn't meet the constraints, mark the - // requirement unmet - acceptable := versions.MeetingConstraints(versionConstraints) - if lock, ok := locked[provider]; !ok || !acceptable.Has(lock.Version()) { - unmetReqs[provider] = versionConstraints - } - } - - if len(unmetReqs) > 0 { - var buf strings.Builder - for provider, versionConstraints := range unmetReqs { - fmt.Fprintf(&buf, "\n- %s", provider) - if len(versionConstraints) > 0 { - fmt.Fprintf(&buf, " (%s)", getproviders.VersionConstraintsString(versionConstraints)) - } - } - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Provider requirements cannot be satisfied by locked dependencies", - fmt.Sprintf("The following required providers are not installed:\n%s\n\nPlease run \"terraform init\".", buf.String()), - )) - return nil, diags - } - } - ret, err := loadSchemas(config, state, c.plugins) if err != nil { diags = diags.Append(tfdiags.Sourceless( @@ -381,3 +316,115 @@ func (c *Context) watchStop(walker *ContextGraphWalker) (chan struct{}, <-chan s return stop, wait } + +// checkConfigDependencies checks whether the recieving context is able to +// support the given configuration, returning error diagnostics if not. +// +// Currently this function checks whether the current Terraform CLI version +// matches the version requirements of all of the modules, and whether our +// plugin library contains all of the plugin names/addresses needed. +// +// This function does *not* check that external modules are installed (that's +// the responsibility of the configuration loader) and doesn't check that the +// plugins are of suitable versions to match any version constraints (which is +// the responsibility of the code which installed the plugins and then +// constructed the Providers/Provisioners maps passed in to NewContext). +// +// In most cases we should typically catch the problems this function detects +// before we reach this point, but this function can come into play in some +// unusual cases outside of the main workflow, and can avoid some +// potentially-more-confusing errors from later operations. +func (c *Context) checkConfigDependencies(config *configs.Config) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + // This checks the Terraform CLI version constraints specified in all of + // the modules. + diags = diags.Append(CheckCoreVersionRequirements(config)) + + // We only check that we have a factory for each required provider, and + // assume the caller already assured that any separately-installed + // plugins are of a suitable version, match expected checksums, etc. + providerReqs, hclDiags := config.ProviderRequirements() + diags = diags.Append(hclDiags) + if hclDiags.HasErrors() { + return diags + } + for providerAddr := range providerReqs { + if !c.plugins.HasProvider(providerAddr) { + if !providerAddr.IsBuiltIn() { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Missing required provider", + fmt.Sprintf( + "This configuration requires provider %s, but that provider isn't available. You may be able to install it automatically by running:\n terraform init", + providerAddr, + ), + )) + } else { + // Built-in providers can never be installed by "terraform init", + // so no point in confusing the user by suggesting that. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Missing required provider", + fmt.Sprintf( + "This configuration requires built-in provider %s, but that provider isn't available in this Terraform version.", + providerAddr, + ), + )) + } + } + } + + // Our handling of provisioners is much less sophisticated than providers + // because they are in many ways a legacy system. We need to go hunting + // for them more directly in the configuration. + config.DeepEach(func(modCfg *configs.Config) { + if modCfg == nil || modCfg.Module == nil { + return // should not happen, but we'll be robust + } + for _, rc := range modCfg.Module.ManagedResources { + if rc.Managed == nil { + continue // should not happen, but we'll be robust + } + for _, pc := range rc.Managed.Provisioners { + if !c.plugins.HasProvisioner(pc.Type) { + // This is not a very high-quality error, because really + // the caller of terraform.NewContext should've already + // done equivalent checks when doing plugin discovery. + // This is just to make sure we return a predictable + // error in a central place, rather than failing somewhere + // later in the non-deterministically-ordered graph walk. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Missing required provisioner plugin", + fmt.Sprintf( + "This configuration requires provisioner plugin %q, which isn't available. If you're intending to use an external provisioner plugin, you must install it manually into one of the plugin search directories before running Terraform.", + pc.Type, + ), + )) + } + } + } + }) + + // Because we were doing a lot of map iteration above, and we're only + // generating sourceless diagnostics anyway, our diagnostics will not be + // in a deterministic order. To ensure stable output when there are + // multiple errors to report, we'll sort these particular diagnostics + // so they are at least always consistent alone. This ordering is + // arbitrary and not a compatibility constraint. + sort.Slice(diags, func(i, j int) bool { + // Because these are sourcelss diagnostics and we know they are all + // errors, we know they'll only differ in their description fields. + descI := diags[i].Description() + descJ := diags[j].Description() + switch { + case descI.Summary != descJ.Summary: + return descI.Summary < descJ.Summary + default: + return descI.Detail < descJ.Detail + } + }) + + return diags +} diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 5610a445ba71..3f860ef1bd1f 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -55,10 +55,10 @@ func (c *Context) Plan(config *configs.Config, prevRunState *states.State, opts } } - moreDiags := CheckCoreVersionRequirements(config) + moreDiags := c.checkConfigDependencies(config) diags = diags.Append(moreDiags) - // If version constraints are not met then we'll bail early since otherwise - // we're likely to just see a bunch of other errors related to + // If required dependencies are not available then we'll bail early since + // otherwise we're likely to just see a bunch of other errors related to // incompatibilities, which could be overwhelming for the user. if diags.HasErrors() { return nil, diags @@ -161,7 +161,6 @@ The -target option is not for routine use, and is provided only for exceptional if plan != nil { plan.VariableValues = varVals plan.TargetAddrs = opts.Targets - plan.ProviderSHA256s = c.providerSHA256s } else if !diags.HasErrors() { panic("nil plan but no errors") } diff --git a/internal/terraform/context_plan_test.go b/internal/terraform/context_plan_test.go index 9cb4c8925573..cfd51da8cc43 100644 --- a/internal/terraform/context_plan_test.go +++ b/internal/terraform/context_plan_test.go @@ -33,9 +33,6 @@ func TestContext2Plan_basic(t *testing.T) { Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), }, - ProviderSHA256s: map[string][]byte{ - "aws": []byte("placeholder"), - }, }) plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) @@ -47,10 +44,6 @@ func TestContext2Plan_basic(t *testing.T) { t.Fatalf("wrong number of resources %d; want fewer than two\n%s", l, spew.Sdump(plan.Changes.Resources)) } - if !reflect.DeepEqual(plan.ProviderSHA256s, ctx.providerSHA256s) { - t.Errorf("wrong ProviderSHA256s %#v; want %#v", plan.ProviderSHA256s, ctx.providerSHA256s) - } - schema := p.GetProviderSchemaResponse.ResourceTypes["aws_instance"].Block ty := schema.ImpliedType() for _, r := range plan.Changes.Resources { diff --git a/internal/terraform/context_plugins.go b/internal/terraform/context_plugins.go index 4fbdf84d0a44..4b3071cf6d84 100644 --- a/internal/terraform/context_plugins.go +++ b/internal/terraform/context_plugins.go @@ -43,6 +43,11 @@ func (cp *contextPlugins) init() { cp.provisionerSchemas = make(map[string]*configschema.Block, len(cp.provisionerFactories)) } +func (cp *contextPlugins) HasProvider(addr addrs.Provider) bool { + _, ok := cp.providerFactories[addr] + return ok +} + func (cp *contextPlugins) NewProviderInstance(addr addrs.Provider) (providers.Interface, error) { f, ok := cp.providerFactories[addr] if !ok { @@ -53,6 +58,11 @@ func (cp *contextPlugins) NewProviderInstance(addr addrs.Provider) (providers.In } +func (cp *contextPlugins) HasProvisioner(typ string) bool { + _, ok := cp.provisionerFactories[typ] + return ok +} + func (cp *contextPlugins) NewProvisionerInstance(typ string) (provisioners.Interface, error) { f, ok := cp.provisionerFactories[typ] if !ok { diff --git a/internal/terraform/context_refresh_test.go b/internal/terraform/context_refresh_test.go index 49cd02e0ea5a..aa2239dbeddf 100644 --- a/internal/terraform/context_refresh_test.go +++ b/internal/terraform/context_refresh_test.go @@ -2,7 +2,6 @@ package terraform import ( "reflect" - "regexp" "sort" "strings" "sync" @@ -1051,8 +1050,8 @@ func TestContext2Refresh_unknownProvider(t *testing.T) { t.Fatal("successfully refreshed; want error") } - if !regexp.MustCompile(`failed to instantiate provider ".+"`).MatchString(diags.Err().Error()) { - t.Fatalf("wrong error: %s", diags.Err()) + if got, want := diags.Err().Error(), "Missing required provider"; !strings.Contains(got, want) { + t.Errorf("missing expected error\nwant substring: %s\ngot:\n%s", want, got) } } diff --git a/internal/terraform/context_test.go b/internal/terraform/context_test.go index 02addb4dbf68..9ef2603db4c3 100644 --- a/internal/terraform/context_test.go +++ b/internal/terraform/context_test.go @@ -15,12 +15,10 @@ import ( "github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp/cmpopts" "github.com/hashicorp/go-version" - "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configload" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/configs/hcl2shim" - "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" "github.com/hashicorp/terraform/internal/providers" @@ -122,184 +120,82 @@ func TestNewContextRequiredVersion(t *testing.T) { } } -func TestNewContext_lockedDependencies(t *testing.T) { - // TODO: Remove this test altogether once we've factored out the version - // and checksum verification to be exclusively the caller's responsibility. - t.Skip("only one step away from locked dependencies being the caller's responsibility") +func TestContext_missingPlugins(t *testing.T) { + ctx, diags := NewContext(&ContextOpts{}) + assertNoDiagnostics(t, diags) - configBeepGreaterThanOne := ` + configSrc := ` terraform { - required_providers { - beep = { - source = "example.com/foo/beep" - version = ">= 1.0.0" - } - } -} -` - configBeepLessThanOne := ` -terraform { - required_providers { - beep = { - source = "example.com/foo/beep" - version = "< 1.0.0" - } - } -} -` - configBuiltin := ` -terraform { - required_providers { - terraform = { - source = "terraform.io/builtin/terraform" + required_providers { + explicit = { + source = "example.com/foo/beep" + } + builtin = { + source = "terraform.io/builtin/nonexist" + } } - } -} -` - locksBeepGreaterThanOne := ` -provider "example.com/foo/beep" { - version = "1.0.0" - constraints = ">= 1.0.0" - hashes = [ - "h1:does-not-match", - ] -} -` - configBeepBoop := ` -terraform { - required_providers { - beep = { - source = "example.com/foo/beep" - version = "< 1.0.0" # different from locks - } - boop = { - source = "example.com/foo/boop" - version = ">= 2.0.0" - } - } } -` - locksBeepBoop := ` -provider "example.com/foo/beep" { - version = "1.0.0" - constraints = ">= 1.0.0" - hashes = [ - "h1:does-not-match", - ] -} -provider "example.com/foo/boop" { - version = "2.3.4" - constraints = ">= 2.0.0" - hashes = [ - "h1:does-not-match", - ] -} -` - beepAddr := addrs.MustParseProviderSourceString("example.com/foo/beep") - boopAddr := addrs.MustParseProviderSourceString("example.com/foo/boop") - - testCases := map[string]struct { - Config string - LockFile string - DevProviders []addrs.Provider - WantErr string - }{ - "dependencies met": { - Config: configBeepGreaterThanOne, - LockFile: locksBeepGreaterThanOne, - }, - "no locks given": { - Config: configBeepGreaterThanOne, - }, - "builtin provider with empty locks": { - Config: configBuiltin, - LockFile: `# This file is maintained automatically by "terraform init".`, - }, - "multiple providers, one in development": { - Config: configBeepBoop, - LockFile: locksBeepBoop, - DevProviders: []addrs.Provider{beepAddr}, - }, - "development provider with empty locks": { - Config: configBeepGreaterThanOne, - LockFile: `# This file is maintained automatically by "terraform init".`, - DevProviders: []addrs.Provider{beepAddr}, - }, - "multiple providers, one in development, one missing": { - Config: configBeepBoop, - LockFile: locksBeepGreaterThanOne, - DevProviders: []addrs.Provider{beepAddr}, - WantErr: `Provider requirements cannot be satisfied by locked dependencies: The following required providers are not installed: - -- example.com/foo/boop (>= 2.0.0) - -Please run "terraform init".`, - }, - "wrong provider version": { - Config: configBeepLessThanOne, - LockFile: locksBeepGreaterThanOne, - WantErr: `Provider requirements cannot be satisfied by locked dependencies: The following required providers are not installed: -- example.com/foo/beep (< 1.0.0) - -Please run "terraform init".`, - }, - "empty locks": { - Config: configBeepGreaterThanOne, - LockFile: `# This file is maintained automatically by "terraform init".`, - WantErr: `Provider requirements cannot be satisfied by locked dependencies: The following required providers are not installed: - -- example.com/foo/beep (>= 1.0.0) - -Please run "terraform init".`, - }, +resource "implicit_thing" "a" { + provisioner "nonexist" { } - for name, tc := range testCases { - t.Run(name, func(t *testing.T) { - var locks *depsfile.Locks - if tc.LockFile != "" { - var diags tfdiags.Diagnostics - locks, diags = depsfile.LoadLocksFromBytes([]byte(tc.LockFile), "test.lock.hcl") - if len(diags) > 0 { - t.Fatalf("unexpected error loading locks file: %s", diags.Err()) - } - } - devProviders := make(map[addrs.Provider]struct{}) - for _, provider := range tc.DevProviders { - devProviders[provider] = struct{}{} - } - opts := &ContextOpts{ - LockedDependencies: locks, - ProvidersInDevelopment: devProviders, - Providers: map[addrs.Provider]providers.Factory{ - beepAddr: testProviderFuncFixed(testProvider("beep")), - boopAddr: testProviderFuncFixed(testProvider("boop")), - addrs.NewBuiltInProvider("terraform"): testProviderFuncFixed(testProvider("terraform")), - }, - } +} - m := testModuleInline(t, map[string]string{ - "main.tf": tc.Config, - }) +resource "implicit_thing" "b" { + provider = implicit2 +} +` - c, diags := NewContext(opts) - if diags.HasErrors() { - t.Fatalf("unexpected NewContext error: %s", diags.Err()) - } + cfg := testModuleInline(t, map[string]string{ + "main.tf": configSrc, + }) - diags = c.Validate(m) - if tc.WantErr != "" { - if len(diags) == 0 { - t.Fatal("expected diags but none returned") - } - if got, want := diags.Err().Error(), tc.WantErr; got != want { - t.Errorf("wrong diags\n got: %s\nwant: %s", got, want) - } - } else { - if len(diags) > 0 { - t.Errorf("unexpected diags: %s", diags.Err()) - } - } + // Validate and Plan are the two entry points where we explicitly verify + // the available plugins match what the configuration needs. For other + // operations we typically fail more deeply in Terraform Core, with + // potentially-less-helpful error messages, because getting there would + // require doing some pretty weird things that aren't common enough to + // be worth the complexity to check for them. + + validateDiags := ctx.Validate(cfg) + _, planDiags := ctx.Plan(cfg, nil, DefaultPlanOpts) + + tests := map[string]tfdiags.Diagnostics{ + "validate": validateDiags, + "plan": planDiags, + } + + for testName, gotDiags := range tests { + t.Run(testName, func(t *testing.T) { + var wantDiags tfdiags.Diagnostics + wantDiags = wantDiags.Append( + tfdiags.Sourceless( + tfdiags.Error, + "Missing required provider", + "This configuration requires built-in provider terraform.io/builtin/nonexist, but that provider isn't available in this Terraform version.", + ), + tfdiags.Sourceless( + tfdiags.Error, + "Missing required provider", + "This configuration requires provider example.com/foo/beep, but that provider isn't available. You may be able to install it automatically by running:\n terraform init", + ), + tfdiags.Sourceless( + tfdiags.Error, + "Missing required provider", + "This configuration requires provider registry.terraform.io/hashicorp/implicit, but that provider isn't available. You may be able to install it automatically by running:\n terraform init", + ), + tfdiags.Sourceless( + tfdiags.Error, + "Missing required provider", + "This configuration requires provider registry.terraform.io/hashicorp/implicit2, but that provider isn't available. You may be able to install it automatically by running:\n terraform init", + ), + tfdiags.Sourceless( + tfdiags.Error, + "Missing required provisioner plugin", + `This configuration requires provisioner plugin "nonexist", which isn't available. If you're intending to use an external provisioner plugin, you must install it manually into one of the plugin search directories before running Terraform.`, + ), + ) + assertDiagnosticsMatch(t, gotDiags, wantDiags) }) } } @@ -779,9 +675,13 @@ func contextOptsForPlanViaFile(configSnap *configload.Snapshot, plan *plans.Plan return nil, nil, nil, err } - return &ContextOpts{ - ProviderSHA256s: plan.ProviderSHA256s, - }, config, plan, nil + // Note: This has grown rather silly over the course of ongoing refactoring, + // because ContextOpts is no longer actually responsible for carrying + // any information from a plan file and instead all of the information + // lives inside the config and plan objects. We continue to return a + // silly empty ContextOpts here just to keep all of the calling tests + // working. + return &ContextOpts{}, config, plan, nil } // legacyPlanComparisonString produces a string representation of the changes @@ -994,6 +894,24 @@ func assertNoErrors(t *testing.T, diags tfdiags.Diagnostics) { t.FailNow() } +// assertDiagnosticsMatch fails the test in progress (using t.Fatal) if the +// two sets of diagnostics don't match after being normalized using the +// "ForRPC" processing step, which eliminates the specific type information +// and HCL expression information of each diagnostic. +// +// assertDiagnosticsMatch sorts the two sets of diagnostics in the usual way +// before comparing them, though diagnostics only have a partial order so that +// will not totally normalize the ordering of all diagnostics sets. +func assertDiagnosticsMatch(t *testing.T, got, want tfdiags.Diagnostics) { + got = got.ForRPC() + want = want.ForRPC() + got.Sort() + want.Sort() + if diff := cmp.Diff(want, got); diff != "" { + t.Fatalf("wrong diagnostics\n%s", diff) + } +} + // logDiagnostics is a test helper that logs the given diagnostics to to the // given testing.T using t.Log, in a way that is hopefully useful in debugging // a test. It does not generate any errors or fail the test. See diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go index b079477bafee..fb54be420221 100644 --- a/internal/terraform/context_validate.go +++ b/internal/terraform/context_validate.go @@ -26,10 +26,10 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { var diags tfdiags.Diagnostics - moreDiags := CheckCoreVersionRequirements(config) + moreDiags := c.checkConfigDependencies(config) diags = diags.Append(moreDiags) - // If version constraints are not met then we'll bail early since otherwise - // we're likely to just see a bunch of other errors related to + // If required dependencies are not available then we'll bail early since + // otherwise we're likely to just see a bunch of other errors related to // incompatibilities, which could be overwhelming for the user. if diags.HasErrors() { return diags From 6a98e4720c5c2ef179c67d00ef771c2464ba4f7f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 29 Sep 2021 16:03:10 -0700 Subject: [PATCH 121/644] plans/planfile: Create takes most arguments via a struct type Previously the planfile.Create function had accumulated probably already too many positional arguments, and I'm intending to add another one in a subsequent commit and so this is preparation to make the callsites more readable (subjectively) and make it clearer how we can extend this function's arguments to include further components in a plan file. There's no difference in observable functionality here. This is just passing the same set of arguments in a slightly different way. --- internal/backend/local/backend_local_test.go | 8 ++++- internal/backend/local/backend_plan.go | 7 +++- internal/command/command_test.go | 7 +++- internal/plans/planfile/planfile_test.go | 7 +++- internal/plans/planfile/writer.go | 34 +++++++++++++++++--- internal/terraform/context_test.go | 7 +++- 6 files changed, 60 insertions(+), 10 deletions(-) diff --git a/internal/backend/local/backend_local_test.go b/internal/backend/local/backend_local_test.go index 13070c2d3c8d..32675e0949e4 100644 --- a/internal/backend/local/backend_local_test.go +++ b/internal/backend/local/backend_local_test.go @@ -132,7 +132,13 @@ func TestLocalRun_stalePlan(t *testing.T) { outDir := t.TempDir() defer os.RemoveAll(outDir) planPath := filepath.Join(outDir, "plan.tfplan") - if err := planfile.Create(planPath, configload.NewEmptySnapshot(), prevStateFile, stateFile, plan); err != nil { + planfileArgs := planfile.CreateArgs{ + ConfigSnapshot: configload.NewEmptySnapshot(), + PreviousRunStateFile: prevStateFile, + StateFile: stateFile, + Plan: plan, + } + if err := planfile.Create(planPath, planfileArgs); err != nil { t.Fatalf("unexpected error writing planfile: %s", err) } planFile, err := planfile.Open(planPath) diff --git a/internal/backend/local/backend_plan.go b/internal/backend/local/backend_plan.go index e25ab3ef6415..655ece1028e2 100644 --- a/internal/backend/local/backend_plan.go +++ b/internal/backend/local/backend_plan.go @@ -133,7 +133,12 @@ func (b *Local) opPlan( } log.Printf("[INFO] backend/local: writing plan output to: %s", path) - err := planfile.Create(path, configSnap, prevStateFile, plannedStateFile, plan) + err := planfile.Create(path, planfile.CreateArgs{ + ConfigSnapshot: configSnap, + PreviousRunStateFile: prevStateFile, + StateFile: plannedStateFile, + Plan: plan, + }) if err != nil { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, diff --git a/internal/command/command_test.go b/internal/command/command_test.go index 929bfb43975b..a0bc4710d6f9 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -242,7 +242,12 @@ func testPlanFile(t *testing.T, configSnap *configload.Snapshot, state *states.S } path := testTempFile(t) - err := planfile.Create(path, configSnap, prevStateFile, stateFile, plan) + err := planfile.Create(path, planfile.CreateArgs{ + ConfigSnapshot: configSnap, + PreviousRunStateFile: prevStateFile, + StateFile: stateFile, + Plan: plan, + }) if err != nil { t.Fatalf("failed to create temporary plan file: %s", err) } diff --git a/internal/plans/planfile/planfile_test.go b/internal/plans/planfile/planfile_test.go index 13e456666ae4..37e38080aec5 100644 --- a/internal/plans/planfile/planfile_test.go +++ b/internal/plans/planfile/planfile_test.go @@ -77,7 +77,12 @@ func TestRoundtrip(t *testing.T) { } planFn := filepath.Join(workDir, "tfplan") - err = Create(planFn, snapIn, prevStateFileIn, stateFileIn, planIn) + err = Create(planFn, CreateArgs{ + ConfigSnapshot: snapIn, + PreviousRunStateFile: prevStateFileIn, + StateFile: stateFileIn, + Plan: planIn, + }) if err != nil { t.Fatalf("failed to create plan file: %s", err) } diff --git a/internal/plans/planfile/writer.go b/internal/plans/planfile/writer.go index 358c4d785ee3..3be2516cb4fa 100644 --- a/internal/plans/planfile/writer.go +++ b/internal/plans/planfile/writer.go @@ -11,6 +11,30 @@ import ( "github.com/hashicorp/terraform/internal/states/statefile" ) +type CreateArgs struct { + // ConfigSnapshot is a snapshot of the configuration that the plan + // was created from. + ConfigSnapshot *configload.Snapshot + + // PreviousRunStateFile is a representation of the state snapshot we used + // as the original input when creating this plan, containing the same + // information as recorded at the end of the previous apply except for + // upgrading managed resource instance data to the provider's latest + // schema versions. + PreviousRunStateFile *statefile.File + + // BaseStateFile is a representation of the state snapshot we used to + // create the plan, which is the result of asking the providers to refresh + // all previously-stored objects to match the current situation in the + // remote system. (If this plan was created with refreshing disabled, + // this should be the same as PreviousRunStateFile.) + StateFile *statefile.File + + // Plan records the plan itself, which is the main artifact inside a + // saved plan file. + Plan *plans.Plan +} + // Create creates a new plan file with the given filename, overwriting any // file that might already exist there. // @@ -18,7 +42,7 @@ import ( // state file in addition to the plan itself, so that Terraform can detect // if the world has changed since the plan was created and thus refuse to // apply it. -func Create(filename string, configSnap *configload.Snapshot, prevStateFile, stateFile *statefile.File, plan *plans.Plan) error { +func Create(filename string, args CreateArgs) error { f, err := os.Create(filename) if err != nil { return err @@ -38,7 +62,7 @@ func Create(filename string, configSnap *configload.Snapshot, prevStateFile, sta if err != nil { return fmt.Errorf("failed to create tfplan file: %s", err) } - err = writeTfplan(plan, w) + err = writeTfplan(args.Plan, w) if err != nil { return fmt.Errorf("failed to write plan: %s", err) } @@ -54,7 +78,7 @@ func Create(filename string, configSnap *configload.Snapshot, prevStateFile, sta if err != nil { return fmt.Errorf("failed to create embedded tfstate file: %s", err) } - err = statefile.Write(stateFile, w) + err = statefile.Write(args.StateFile, w) if err != nil { return fmt.Errorf("failed to write state snapshot: %s", err) } @@ -70,7 +94,7 @@ func Create(filename string, configSnap *configload.Snapshot, prevStateFile, sta if err != nil { return fmt.Errorf("failed to create embedded tfstate-prev file: %s", err) } - err = statefile.Write(prevStateFile, w) + err = statefile.Write(args.PreviousRunStateFile, w) if err != nil { return fmt.Errorf("failed to write previous state snapshot: %s", err) } @@ -78,7 +102,7 @@ func Create(filename string, configSnap *configload.Snapshot, prevStateFile, sta // tfconfig directory { - err := writeConfigSnapshot(configSnap, zw) + err := writeConfigSnapshot(args.ConfigSnapshot, zw) if err != nil { return fmt.Errorf("failed to write config snapshot: %s", err) } diff --git a/internal/terraform/context_test.go b/internal/terraform/context_test.go index 9ef2603db4c3..e40a95058a99 100644 --- a/internal/terraform/context_test.go +++ b/internal/terraform/context_test.go @@ -655,7 +655,12 @@ func contextOptsForPlanViaFile(configSnap *configload.Snapshot, plan *plans.Plan } filename := filepath.Join(dir, "tfplan") - err = planfile.Create(filename, configSnap, prevStateFile, stateFile, plan) + err = planfile.Create(filename, planfile.CreateArgs{ + ConfigSnapshot: configSnap, + PreviousRunStateFile: prevStateFile, + StateFile: stateFile, + Plan: plan, + }) if err != nil { return nil, nil, nil, err } From 3f8559199806771940e6e74004a9b814040125c4 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 29 Sep 2021 16:13:20 -0700 Subject: [PATCH 122/644] depsfile: SaveLocksToBytes function In a future commit we'll use this to include dependency lock information in full fidelity inside a saved plan file. --- internal/depsfile/locks_file.go | 41 ++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 13 deletions(-) diff --git a/internal/depsfile/locks_file.go b/internal/depsfile/locks_file.go index add88ea8d0a2..e619e06703c6 100644 --- a/internal/depsfile/locks_file.go +++ b/internal/depsfile/locks_file.go @@ -43,6 +43,12 @@ func LoadLocksFromFile(filename string) (*Locks, tfdiags.Diagnostics) { // integration testing (avoiding creating temporary files on disk); if you // are writing non-test code, consider whether LoadLocksFromFile might be // more appropriate to call. +// +// It is valid to use this with dependency lock information recorded as part of +// a plan file, in which case the given filename will typically be a +// placeholder that will only be seen in the unusual case that the plan file +// contains an invalid lock file, which should only be possible if the user +// edited it directly (Terraform bugs notwithstanding). func LoadLocksFromBytes(src []byte, filename string) (*Locks, tfdiags.Diagnostics) { return loadLocks(func(parser *hclparse.Parser) (*hcl.File, hcl.Diagnostics) { return parser.ParseHCL(src, filename) @@ -80,6 +86,27 @@ func loadLocks(loadParse func(*hclparse.Parser) (*hcl.File, hcl.Diagnostics)) (* // temporary files may be temporarily created in the same directory as the // given filename during the operation. func SaveLocksToFile(locks *Locks, filename string) tfdiags.Diagnostics { + src, diags := SaveLocksToBytes(locks) + if diags.HasErrors() { + return diags + } + + err := replacefile.AtomicWriteFile(filename, src, 0644) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to update dependency lock file", + fmt.Sprintf("Error while writing new dependency lock information to %s: %s.", filename, err), + )) + return diags + } + + return diags +} + +// SaveLocksToBytes writes the given locks object into a byte array, +// using the same syntax that LoadLocksFromBytes expects to parse. +func SaveLocksToBytes(locks *Locks) ([]byte, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // In other uses of the "hclwrite" package we typically try to make @@ -131,19 +158,7 @@ func SaveLocksToFile(locks *Locks, filename string) tfdiags.Diagnostics { } } - newContent := f.Bytes() - - err := replacefile.AtomicWriteFile(filename, newContent, 0644) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Failed to update dependency lock file", - fmt.Sprintf("Error while writing new dependency lock information to %s: %s.", filename, err), - )) - return diags - } - - return diags + return f.Bytes(), diags } func decodeLocksFromHCL(locks *Locks, body hcl.Body) tfdiags.Diagnostics { From 702413702cfb8cd2fc365572639d874a4f9778d0 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 29 Sep 2021 17:03:38 -0700 Subject: [PATCH 123/644] plans/planfile: Include dependency locks in saved plan files We recently removed the legacy way we used to track the SHA256 hashes of individual provider executables as part of a plans.Plan, because these days we want to track the checksums of entire provider packages rather than just the executable. In order to achieve that new goal, we can save a copy of the dependency lock information inside the plan file. This follows our existing precedent of using exactly the same serialization formats we'd normally use for this information, and thus we can reuse the existing models and serializers and be confident we won't lose any detail in the round-trip. As of this commit there's not yet anything actually making use of this mechanism. In a subsequent commit we'll teach the main callers that write and read plan files to include and expect (respectively) dependency information, verifying that the available providers still match by the time we're applying the plan. --- internal/plans/planfile/planfile_test.go | 26 ++++++++++++++ internal/plans/planfile/reader.go | 46 ++++++++++++++++++++++++ internal/plans/planfile/writer.go | 27 ++++++++++++++ 3 files changed, 99 insertions(+) diff --git a/internal/plans/planfile/planfile_test.go b/internal/plans/planfile/planfile_test.go index 37e38080aec5..d5d1365c8eeb 100644 --- a/internal/plans/planfile/planfile_test.go +++ b/internal/plans/planfile/planfile_test.go @@ -7,7 +7,10 @@ import ( "github.com/google/go-cmp/cmp" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configload" + "github.com/hashicorp/terraform/internal/depsfile" + "github.com/hashicorp/terraform/internal/getproviders" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/statefile" @@ -71,6 +74,16 @@ func TestRoundtrip(t *testing.T) { PriorState: stateFileIn.State, } + locksIn := depsfile.NewLocks() + locksIn.SetProvider( + addrs.NewDefaultProvider("boop"), + getproviders.MustParseVersion("1.0.0"), + getproviders.MustParseVersionConstraints(">= 1.0.0"), + []getproviders.Hash{ + getproviders.MustParseHash("fake:hello"), + }, + ) + workDir, err := ioutil.TempDir("", "tf-planfile") if err != nil { t.Fatal(err) @@ -82,6 +95,7 @@ func TestRoundtrip(t *testing.T) { PreviousRunStateFile: prevStateFileIn, StateFile: stateFileIn, Plan: planIn, + DependencyLocks: locksIn, }) if err != nil { t.Fatalf("failed to create plan file: %s", err) @@ -141,4 +155,16 @@ func TestRoundtrip(t *testing.T) { t.Errorf("when reading config: %s", diags.Err()) } }) + + t.Run("ReadDependencyLocks", func(t *testing.T) { + locksOut, diags := pr.ReadDependencyLocks() + if diags.HasErrors() { + t.Fatalf("when reading config: %s", diags.Err()) + } + got := locksOut.AllProviders() + want := locksIn.AllProviders() + if diff := cmp.Diff(want, got, cmp.AllowUnexported(depsfile.ProviderLock{})); diff != "" { + t.Errorf("provider locks did not survive round-trip\n%s", diff) + } + }) } diff --git a/internal/plans/planfile/reader.go b/internal/plans/planfile/reader.go index 7175eda27499..ff6e129e0bac 100644 --- a/internal/plans/planfile/reader.go +++ b/internal/plans/planfile/reader.go @@ -8,6 +8,7 @@ import ( "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configload" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/states/statefile" "github.com/hashicorp/terraform/internal/tfdiags" @@ -15,6 +16,7 @@ import ( const tfstateFilename = "tfstate" const tfstatePreviousFilename = "tfstate-prev" +const dependencyLocksFilename = ".terraform.lock.hcl" // matches the conventional name in an input configuration // Reader is the main type used to read plan files. Create a Reader by calling // Open. @@ -190,6 +192,50 @@ func (r *Reader) ReadConfig() (*configs.Config, tfdiags.Diagnostics) { return config, diags } +// ReadDependencyLocks reads the dependency lock information embedded in +// the plan file. +// +// Some test codepaths create plan files without dependency lock information, +// but all main codepaths should populate this. If reading a file without +// the dependency information, this will return error diagnostics. +func (r *Reader) ReadDependencyLocks() (*depsfile.Locks, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + for _, file := range r.zip.File { + if file.Name == dependencyLocksFilename { + r, err := file.Open() + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to read dependency locks from plan file", + fmt.Sprintf("Couldn't read the dependency lock information embedded in the plan file: %s.", err), + )) + return nil, diags + } + src, err := ioutil.ReadAll(r) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to read dependency locks from plan file", + fmt.Sprintf("Couldn't read the dependency lock information embedded in the plan file: %s.", err), + )) + return nil, diags + } + locks, moreDiags := depsfile.LoadLocksFromBytes(src, "") + diags = diags.Append(moreDiags) + return locks, diags + } + } + + // If we fall out here then this is a file without dependency information. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Saved plan has no dependency lock information", + "The specified saved plan file does not include any dependency lock information. This is a bug in the previous run of Terraform that created this file.", + )) + return nil, diags +} + // Close closes the file, after which no other operations may be performed. func (r *Reader) Close() error { return r.zip.Close() diff --git a/internal/plans/planfile/writer.go b/internal/plans/planfile/writer.go index 3be2516cb4fa..bdf84c86db44 100644 --- a/internal/plans/planfile/writer.go +++ b/internal/plans/planfile/writer.go @@ -7,6 +7,7 @@ import ( "time" "github.com/hashicorp/terraform/internal/configs/configload" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/states/statefile" ) @@ -33,6 +34,11 @@ type CreateArgs struct { // Plan records the plan itself, which is the main artifact inside a // saved plan file. Plan *plans.Plan + + // DependencyLocks records the dependency lock information that we + // checked prior to creating the plan, so we can make sure that all of the + // same dependencies are still available when applying the plan. + DependencyLocks *depsfile.Locks } // Create creates a new plan file with the given filename, overwriting any @@ -108,5 +114,26 @@ func Create(filename string, args CreateArgs) error { } } + // .terraform.lock.hcl file, containing dependency lock information + if args.DependencyLocks != nil { // (this was a later addition, so not all callers set it, but main callers should) + src, diags := depsfile.SaveLocksToBytes(args.DependencyLocks) + if diags.HasErrors() { + return fmt.Errorf("failed to write embedded dependency lock file: %s", diags.Err().Error()) + } + + w, err := zw.CreateHeader(&zip.FileHeader{ + Name: dependencyLocksFilename, + Method: zip.Deflate, + Modified: time.Now(), + }) + if err != nil { + return fmt.Errorf("failed to create embedded dependency lock file: %s", err) + } + _, err = w.Write(src) + if err != nil { + return fmt.Errorf("failed to write embedded dependency lock file: %s", err) + } + } + return nil } From df578afd7e34ae32345d86840edd05b4c05559e8 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 29 Sep 2021 17:31:43 -0700 Subject: [PATCH 124/644] backend/local: Check dependency lock consistency before any operations In historical versions of Terraform the responsibility to check this was inside the terraform.NewContext function, along with various other assorted concerns that made that function particularly complicated. More recently, we reduced the responsibility of the "terraform" package only to instantiating particular named plugins, assuming that its caller is responsible for selecting appropriate versions of any providers that _are_ external. However, until this commit we were just assuming that "terraform init" had correctly selected appropriate plugins and recorded them in the lock file, and so nothing was dealing with the problem of ensuring that there haven't been any changes to the lock file or config since the most recent "terraform init" which would cause us to need to re-evaluate those decisions. Part of the game here is to slightly extend the role of the dependency locks object to also carry information about a subset of provider addresses whose lock entries we're intentionally disregarding as part of the various little edge-case features we have for overridding providers: dev_overrides, "unmanaged providers", and the testing overrides in our own unit tests. This is an in-memory-only annotation, never included in the serialized plan files on disk. I had originally intended to create a new package to encapsulate all of this plugin-selection logic, including both the version constraint checking here and also the handling of the provider factory functions, but as an interim step I've just made version constraint consistency checks the responsibility of the backend/local package, which means that we'll always catch problems as part of preparing for local operations, while not imposing these additional checks on commands that _don't_ run local operations, such as "terraform apply" when in remote operations mode. --- internal/backend/backend.go | 11 ++ internal/backend/local/backend_apply_test.go | 18 ++- internal/backend/local/backend_local.go | 71 +++++++++- internal/backend/local/backend_plan.go | 1 + internal/backend/local/backend_plan_test.go | 17 ++- .../backend/local/backend_refresh_test.go | 17 ++- internal/backend/remote/backend.go | 1 + internal/backend/remote/backend_apply_test.go | 19 ++- internal/backend/remote/backend_plan_test.go | 19 ++- internal/command/command_test.go | 2 + internal/command/import_test.go | 2 +- internal/command/meta_backend.go | 23 +++- internal/command/meta_dependencies.go | 35 ++++- internal/command/meta_providers.go | 8 +- internal/command/plan_test.go | 2 +- internal/configs/config.go | 85 ++++++++++++ internal/configs/config_test.go | 123 ++++++++++++++++++ internal/depsfile/locks.go | 56 ++++++++ 18 files changed, 469 insertions(+), 41 deletions(-) diff --git a/internal/backend/backend.go b/internal/backend/backend.go index d8b28b9435f4..9f1855eb291f 100644 --- a/internal/backend/backend.go +++ b/internal/backend/backend.go @@ -17,6 +17,7 @@ import ( "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configload" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" "github.com/hashicorp/terraform/internal/states" @@ -237,6 +238,16 @@ type Operation struct { // configuration from ConfigDir. ConfigLoader *configload.Loader + // DependencyLocks represents the locked dependencies associated with + // the configuration directory given in ConfigDir. + // + // Note that if field PlanFile is set then the plan file should contain + // its own dependency locks. The backend is responsible for correctly + // selecting between these two sets of locks depending on whether it + // will be using ConfigDir or PlanFile to get the configuration for + // this operation. + DependencyLocks *depsfile.Locks + // Hooks can be used to perform actions triggered by various events during // the operation's lifecycle. Hooks []terraform.Hook diff --git a/internal/backend/local/backend_apply_test.go b/internal/backend/local/backend_apply_test.go index 4ffc0fa0a871..1f9514ad5410 100644 --- a/internal/backend/local/backend_apply_test.go +++ b/internal/backend/local/backend_apply_test.go @@ -11,11 +11,13 @@ import ( "github.com/zclconf/go-cty/cty" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/providers" @@ -319,12 +321,18 @@ func testOperationApply(t *testing.T, configDir string) (*backend.Operation, fun streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + // Many of our tests use an overridden "test" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/test")) + return &backend.Operation{ - Type: backend.OperationTypeApply, - ConfigDir: configDir, - ConfigLoader: configLoader, - StateLocker: clistate.NewNoopLocker(), - View: view, + Type: backend.OperationTypeApply, + ConfigDir: configDir, + ConfigLoader: configLoader, + StateLocker: clistate.NewNoopLocker(), + View: view, + DependencyLocks: depLocks, }, configCleanup, done } diff --git a/internal/backend/local/backend_local.go b/internal/backend/local/backend_local.go index 5ce5929ee310..209757e43375 100644 --- a/internal/backend/local/backend_local.go +++ b/internal/backend/local/backend_local.go @@ -5,6 +5,7 @@ import ( "fmt" "log" "sort" + "strings" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/configs" @@ -83,7 +84,7 @@ func (b *Local) localRun(op *backend.Operation) (*backend.LocalRun, *configload. stateMeta = &m } log.Printf("[TRACE] backend/local: populating backend.LocalRun from plan file") - ret, configSnap, ctxDiags = b.localRunForPlanFile(op.PlanFile, ret, &coreOpts, stateMeta) + ret, configSnap, ctxDiags = b.localRunForPlanFile(op, op.PlanFile, ret, &coreOpts, stateMeta) if ctxDiags.HasErrors() { diags = diags.Append(ctxDiags) return nil, nil, nil, diags @@ -138,6 +139,32 @@ func (b *Local) localRunDirect(op *backend.Operation, run *backend.LocalRun, cor } run.Config = config + if errs := config.VerifyDependencySelections(op.DependencyLocks); len(errs) > 0 { + var buf strings.Builder + for _, err := range errs { + fmt.Fprintf(&buf, "\n - %s", err.Error()) + } + var suggestion string + switch { + case op.DependencyLocks == nil: + // If we get here then it suggests that there's a caller that we + // didn't yet update to populate DependencyLocks, which is a bug. + suggestion = "This run has no dependency lock information provided at all, which is a bug in Terraform; please report it!" + case op.DependencyLocks.Empty(): + suggestion = "To make the initial dependency selections that will initialize the dependency lock file, run:\n terraform init" + default: + suggestion = "To update the locked dependency selections to match a changed configuration, run:\n terraform init -upgrade" + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Inconsistent dependency lock file", + fmt.Sprintf( + "The following dependency selections recorded in the lock file are inconsistent with the current configuration:%s\n\n%s", + buf.String(), suggestion, + ), + )) + } + var rawVariables map[string]backend.UnparsedVariableValue if op.AllowUnsetVariables { // Rather than prompting for input, we'll just stub out the required @@ -181,7 +208,7 @@ func (b *Local) localRunDirect(op *backend.Operation, run *backend.LocalRun, cor return run, configSnap, diags } -func (b *Local) localRunForPlanFile(pf *planfile.Reader, run *backend.LocalRun, coreOpts *terraform.ContextOpts, currentStateMeta *statemgr.SnapshotMeta) (*backend.LocalRun, *configload.Snapshot, tfdiags.Diagnostics) { +func (b *Local) localRunForPlanFile(op *backend.Operation, pf *planfile.Reader, run *backend.LocalRun, coreOpts *terraform.ContextOpts, currentStateMeta *statemgr.SnapshotMeta) (*backend.LocalRun, *configload.Snapshot, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics const errSummary = "Invalid plan file" @@ -206,6 +233,46 @@ func (b *Local) localRunForPlanFile(pf *planfile.Reader, run *backend.LocalRun, } run.Config = config + // NOTE: We're intentionally comparing the current locks with the + // configuration snapshot, rather than the lock snapshot in the plan file, + // because it's the current locks which dictate our plugin selections + // in coreOpts below. However, we'll also separately check that the + // plan file has identical locked plugins below, and thus we're effectively + // checking consistency with both here. + if errs := config.VerifyDependencySelections(op.DependencyLocks); len(errs) > 0 { + var buf strings.Builder + for _, err := range errs { + fmt.Fprintf(&buf, "\n - %s", err.Error()) + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Inconsistent dependency lock file", + fmt.Sprintf( + "The following dependency selections recorded in the lock file are inconsistent with the configuration in the saved plan:%s\n\nA saved plan can be applied only to the same configuration it was created from. Create a new plan from the updated configuration.", + buf.String(), + ), + )) + } + + // This check is an important complement to the check above: the locked + // dependencies in the configuration must match the configuration, and + // the locked dependencies in the plan must match the locked dependencies + // in the configuration, and so transitively we ensure that the locked + // dependencies in the plan match the configuration too. However, this + // additionally catches any inconsistency between the two sets of locks + // even if they both happen to be valid per the current configuration, + // which is one of several ways we try to catch the mistake of applying + // a saved plan file in a different place than where we created it. + depLocksFromPlan, moreDiags := pf.ReadDependencyLocks() + diags = diags.Append(moreDiags) + if depLocksFromPlan != nil && !op.DependencyLocks.Equal(depLocksFromPlan) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Inconsistent dependency lock file", + "The given plan file was created with a different set of external dependency selections than the current configuration. A saved plan can be applied only to the same configuration it was created from.\n\nCreate a new plan from the updated configuration.", + )) + } + // A plan file also contains a snapshot of the prior state the changes // are intended to apply to. priorStateFile, err := pf.ReadStateFile() diff --git a/internal/backend/local/backend_plan.go b/internal/backend/local/backend_plan.go index 655ece1028e2..c721074b4a8e 100644 --- a/internal/backend/local/backend_plan.go +++ b/internal/backend/local/backend_plan.go @@ -138,6 +138,7 @@ func (b *Local) opPlan( PreviousRunStateFile: prevStateFile, StateFile: plannedStateFile, Plan: plan, + DependencyLocks: op.DependencyLocks, }) if err != nil { diags = diags.Append(tfdiags.Sourceless( diff --git a/internal/backend/local/backend_plan_test.go b/internal/backend/local/backend_plan_test.go index 2a9f3f8287b0..5121d45e70ed 100644 --- a/internal/backend/local/backend_plan_test.go +++ b/internal/backend/local/backend_plan_test.go @@ -13,6 +13,7 @@ import ( "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" @@ -716,12 +717,18 @@ func testOperationPlan(t *testing.T, configDir string) (*backend.Operation, func streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + // Many of our tests use an overridden "test" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/test")) + return &backend.Operation{ - Type: backend.OperationTypePlan, - ConfigDir: configDir, - ConfigLoader: configLoader, - StateLocker: clistate.NewNoopLocker(), - View: view, + Type: backend.OperationTypePlan, + ConfigDir: configDir, + ConfigLoader: configLoader, + StateLocker: clistate.NewNoopLocker(), + View: view, + DependencyLocks: depLocks, }, configCleanup, done } diff --git a/internal/backend/local/backend_refresh_test.go b/internal/backend/local/backend_refresh_test.go index 0e502267cc64..886c184181c2 100644 --- a/internal/backend/local/backend_refresh_test.go +++ b/internal/backend/local/backend_refresh_test.go @@ -12,6 +12,7 @@ import ( "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/states" @@ -260,12 +261,18 @@ func testOperationRefresh(t *testing.T, configDir string) (*backend.Operation, f streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + // Many of our tests use an overridden "test" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/test")) + return &backend.Operation{ - Type: backend.OperationTypeRefresh, - ConfigDir: configDir, - ConfigLoader: configLoader, - StateLocker: clistate.NewNoopLocker(), - View: view, + Type: backend.OperationTypeRefresh, + ConfigDir: configDir, + ConfigLoader: configLoader, + StateLocker: clistate.NewNoopLocker(), + View: view, + DependencyLocks: depLocks, }, configCleanup, done } diff --git a/internal/backend/remote/backend.go b/internal/backend/remote/backend.go index 5e09e7207d3f..e427befa0391 100644 --- a/internal/backend/remote/backend.go +++ b/internal/backend/remote/backend.go @@ -710,6 +710,7 @@ func (b *Remote) Operation(ctx context.Context, op *backend.Operation) (*backend // Record that we're forced to run operations locally to allow the // command package UI to operate correctly b.forceLocal = true + log.Printf("[DEBUG] Remote backend is delegating %s to the local backend", op.Type) return b.local.Operation(ctx, op) } diff --git a/internal/backend/remote/backend_apply_test.go b/internal/backend/remote/backend_apply_test.go index 4bc2a909f288..71c819b9e505 100644 --- a/internal/backend/remote/backend_apply_test.go +++ b/internal/backend/remote/backend_apply_test.go @@ -17,6 +17,7 @@ import ( "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" @@ -43,13 +44,19 @@ func testOperationApplyWithTimeout(t *testing.T, configDir string, timeout time. stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) operationView := views.NewOperation(arguments.ViewHuman, false, view) + // Many of our tests use an overridden "null" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/null")) + return &backend.Operation{ - ConfigDir: configDir, - ConfigLoader: configLoader, - PlanRefresh: true, - StateLocker: clistate.NewLocker(timeout, stateLockerView), - Type: backend.OperationTypeApply, - View: operationView, + ConfigDir: configDir, + ConfigLoader: configLoader, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypeApply, + View: operationView, + DependencyLocks: depLocks, }, configCleanup, done } diff --git a/internal/backend/remote/backend_plan_test.go b/internal/backend/remote/backend_plan_test.go index 6d4ced7b87a7..147c68e9dbe2 100644 --- a/internal/backend/remote/backend_plan_test.go +++ b/internal/backend/remote/backend_plan_test.go @@ -16,6 +16,7 @@ import ( "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" @@ -41,13 +42,19 @@ func testOperationPlanWithTimeout(t *testing.T, configDir string, timeout time.D stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) operationView := views.NewOperation(arguments.ViewHuman, false, view) + // Many of our tests use an overridden "null" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/null")) + return &backend.Operation{ - ConfigDir: configDir, - ConfigLoader: configLoader, - PlanRefresh: true, - StateLocker: clistate.NewLocker(timeout, stateLockerView), - Type: backend.OperationTypePlan, - View: operationView, + ConfigDir: configDir, + ConfigLoader: configLoader, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypePlan, + View: operationView, + DependencyLocks: depLocks, }, configCleanup, done } diff --git a/internal/command/command_test.go b/internal/command/command_test.go index a0bc4710d6f9..a9ba2a044e0a 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -29,6 +29,7 @@ import ( "github.com/hashicorp/terraform/internal/configs/configload" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/copy" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/getproviders" "github.com/hashicorp/terraform/internal/initwd" legacy "github.com/hashicorp/terraform/internal/legacy/terraform" @@ -247,6 +248,7 @@ func testPlanFile(t *testing.T, configSnap *configload.Snapshot, state *states.S PreviousRunStateFile: prevStateFile, StateFile: stateFile, Plan: plan, + DependencyLocks: depsfile.NewLocks(), }) if err != nil { t.Fatalf("failed to create temporary plan file: %s", err) diff --git a/internal/command/import_test.go b/internal/command/import_test.go index 1469ea81d224..091646ecc246 100644 --- a/internal/command/import_test.go +++ b/internal/command/import_test.go @@ -332,7 +332,7 @@ func TestImport_initializationErrorShouldUnlock(t *testing.T) { // specifically, it should fail due to a missing provider msg := strings.ReplaceAll(ui.ErrorWriter.String(), "\n", " ") - if want := `unavailable provider "registry.terraform.io/hashicorp/unknown"`; !strings.Contains(msg, want) { + if want := `provider registry.terraform.io/hashicorp/unknown: required by this configuration but no version is selected`; !strings.Contains(msg, want) { t.Errorf("incorrect message\nwant substring: %s\ngot:\n%s", want, msg) } diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index f467579ba973..5d2aa5ed3b91 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -355,13 +355,24 @@ func (m *Meta) Operation(b backend.Backend) *backend.Operation { stateLocker = clistate.NewLocker(m.stateLockTimeout, view) } + depLocks, diags := m.lockedDependencies() + if diags.HasErrors() { + // We can't actually report errors from here, but m.lockedDependencies + // should always have been called earlier to prepare the "ContextOpts" + // for the backend anyway, so we should never actually get here in + // a real situation. If we do get here then the backend will inevitably + // fail downstream somwhere if it tries to use the empty depLocks. + log.Printf("[WARN] Failed to load dependency locks while preparing backend operation (ignored): %s", diags.Err().Error()) + } + return &backend.Operation{ - PlanOutBackend: planOutBackend, - Targets: m.targets, - UIIn: m.UIInput(), - UIOut: m.Ui, - Workspace: workspace, - StateLocker: stateLocker, + PlanOutBackend: planOutBackend, + Targets: m.targets, + UIIn: m.UIInput(), + UIOut: m.Ui, + Workspace: workspace, + StateLocker: stateLocker, + DependencyLocks: depLocks, } } diff --git a/internal/command/meta_dependencies.go b/internal/command/meta_dependencies.go index efda3f10321d..1b0cb97f8df8 100644 --- a/internal/command/meta_dependencies.go +++ b/internal/command/meta_dependencies.go @@ -1,6 +1,7 @@ package command import ( + "log" "os" "github.com/hashicorp/terraform/internal/depsfile" @@ -48,10 +49,11 @@ func (m *Meta) lockedDependencies() (*depsfile.Locks, tfdiags.Diagnostics) { // promising to support two concurrent dependency installation processes. _, err := os.Stat(dependencyLockFilename) if os.IsNotExist(err) { - return depsfile.NewLocks(), nil + return m.annotateDependencyLocksWithOverrides(depsfile.NewLocks()), nil } - return depsfile.LoadLocksFromFile(dependencyLockFilename) + ret, diags := depsfile.LoadLocksFromFile(dependencyLockFilename) + return m.annotateDependencyLocksWithOverrides(ret), diags } // replaceLockedDependencies creates or overwrites the lock file in the @@ -60,3 +62,32 @@ func (m *Meta) lockedDependencies() (*depsfile.Locks, tfdiags.Diagnostics) { func (m *Meta) replaceLockedDependencies(new *depsfile.Locks) tfdiags.Diagnostics { return depsfile.SaveLocksToFile(new, dependencyLockFilename) } + +// annotateDependencyLocksWithOverrides modifies the given Locks object in-place +// to track as overridden any provider address that's subject to testing +// overrides, development overrides, or "unmanaged provider" status. +// +// This is just an implementation detail of the lockedDependencies method, +// not intended for use anywhere else. +func (m *Meta) annotateDependencyLocksWithOverrides(ret *depsfile.Locks) *depsfile.Locks { + if ret == nil { + return ret + } + + for addr := range m.ProviderDevOverrides { + log.Printf("[DEBUG] Provider %s is overridden by dev_overrides", addr) + ret.SetProviderOverridden(addr) + } + for addr := range m.UnmanagedProviders { + log.Printf("[DEBUG] Provider %s is overridden as an \"unmanaged provider\"", addr) + ret.SetProviderOverridden(addr) + } + if m.testingOverrides != nil { + for addr := range m.testingOverrides.Providers { + log.Printf("[DEBUG] Provider %s is overridden in Meta.testingOverrides", addr) + ret.SetProviderOverridden(addr) + } + } + + return ret +} diff --git a/internal/command/meta_providers.go b/internal/command/meta_providers.go index 84ccc89d87a4..ffe52ffde6c2 100644 --- a/internal/command/meta_providers.go +++ b/internal/command/meta_providers.go @@ -282,6 +282,12 @@ func (m *Meta) providerFactories() (map[addrs.Provider]providers.Factory, error) factories[provider] = providerFactoryError(thisErr) } + if locks.ProviderIsOverridden(provider) { + // Overridden providers we'll handle with the other separate + // loops below, for dev overrides etc. + continue + } + version := lock.Version() cached := cacheDir.ProviderVersion(provider, version) if cached == nil { @@ -313,8 +319,6 @@ func (m *Meta) providerFactories() (map[addrs.Provider]providers.Factory, error) factories[provider] = providerFactory(cached) } for provider, localDir := range devOverrideProviders { - // It's likely that providers in this map will conflict with providers - // in providerLocks factories[provider] = devOverrideProviderFactory(provider, localDir) } for provider, reattach := range unmanagedProviders { diff --git a/internal/command/plan_test.go b/internal/command/plan_test.go index 68f051f55532..84950d7e0d9c 100644 --- a/internal/command/plan_test.go +++ b/internal/command/plan_test.go @@ -1051,7 +1051,7 @@ func TestPlan_init_required(t *testing.T) { t.Fatalf("expected error, got success") } got := output.Stderr() - if !strings.Contains(got, "Error: Missing required provider") { + if !(strings.Contains(got, "terraform init") && strings.Contains(got, "provider registry.terraform.io/hashicorp/test: required by this configuration but no version is selected")) { t.Fatal("wrong error message in output:", got) } } diff --git a/internal/configs/config.go b/internal/configs/config.go index cc3f06e798b1..f38d3cd85daa 100644 --- a/internal/configs/config.go +++ b/internal/configs/config.go @@ -2,11 +2,13 @@ package configs import ( "fmt" + "log" "sort" version "github.com/hashicorp/go-version" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/getproviders" ) @@ -194,6 +196,89 @@ func (c *Config) EntersNewPackage() bool { return moduleSourceAddrEntersNewPackage(c.SourceAddr) } +// VerifyDependencySelections checks whether the given locked dependencies +// are acceptable for all of the version constraints reported in the +// configuration tree represented by the reciever. +// +// This function will errors only if any of the locked dependencies are out of +// range for corresponding constraints in the configuration. If there are +// multiple inconsistencies then it will attempt to describe as many of them +// as possible, rather than stopping at the first problem. +// +// It's typically the responsibility of "terraform init" to change the locked +// dependencies to conform with the configuration, and so +// VerifyDependencySelections is intended for other commands to check whether +// it did so correctly and to catch if anything has changed in configuration +// since the last "terraform init" which requires re-initialization. However, +// it's up to the caller to decide how to advise users recover from these +// errors, because the advise can vary depending on what operation the user +// is attempting. +func (c *Config) VerifyDependencySelections(depLocks *depsfile.Locks) []error { + var errs []error + + reqs, diags := c.ProviderRequirements() + if diags.HasErrors() { + // It should be very unusual to get here, but unfortunately we can + // end up here in some edge cases where the config loader doesn't + // process version constraint strings in exactly the same way as + // the requirements resolver. (See the addProviderRequirements method + // for more information.) + errs = append(errs, fmt.Errorf("failed to determine the configuration's provider requirements: %s", diags.Error())) + } + + for providerAddr, constraints := range reqs { + if !depsfile.ProviderIsLockable(providerAddr) { + continue // disregard builtin providers, and such + } + if depLocks != nil && depLocks.ProviderIsOverridden(providerAddr) { + // The "overridden" case is for unusual special situations like + // dev overrides, so we'll explicitly note it in the logs just in + // case we see bug reports with these active and it helps us + // understand why we ended up using the "wrong" plugin. + log.Printf("[DEBUG] Config.VerifyDependencySelections: skipping %s because it's overridden by a special configuration setting", providerAddr) + continue + } + + var lock *depsfile.ProviderLock + if depLocks != nil { // Should always be true in main code, but unfortunately sometimes not true in old tests that don't fill out arguments completely + lock = depLocks.Provider(providerAddr) + } + if lock == nil { + log.Printf("[TRACE] Config.VerifyDependencySelections: provider %s has no lock file entry to satisfy %q", providerAddr, getproviders.VersionConstraintsString(constraints)) + errs = append(errs, fmt.Errorf("provider %s: required by this configuration but no version is selected", providerAddr)) + continue + } + + selectedVersion := lock.Version() + allowedVersions := getproviders.MeetingConstraints(constraints) + log.Printf("[TRACE] Config.VerifyDependencySelections: provider %s has %s to satisfy %q", providerAddr, selectedVersion.String(), getproviders.VersionConstraintsString(constraints)) + if !allowedVersions.Has(selectedVersion) { + // The most likely cause of this is that the author of a module + // has changed its constraints, but this could also happen in + // some other unusual situations, such as the user directly + // editing the lock file to record something invalid. We'll + // distinguish those cases here in order to avoid the more + // specific error message potentially being a red herring in + // the edge-cases. + currentConstraints := getproviders.VersionConstraintsString(constraints) + lockedConstraints := getproviders.VersionConstraintsString(lock.VersionConstraints()) + switch { + case currentConstraints != lockedConstraints: + errs = append(errs, fmt.Errorf("provider %s: locked version selection %s doesn't match the updated version constraints %q", providerAddr, selectedVersion.String(), currentConstraints)) + default: + errs = append(errs, fmt.Errorf("provider %s: version constraints %q don't match the locked version selection %s", providerAddr, currentConstraints, selectedVersion.String())) + } + } + } + + // Return multiple errors in an arbitrary-but-deterministic order. + sort.Slice(errs, func(i, j int) bool { + return errs[i].Error() < errs[j].Error() + }) + + return errs +} + // ProviderRequirements searches the full tree of modules under the receiver // for both explicit and implicit dependencies on providers. // diff --git a/internal/configs/config_test.go b/internal/configs/config_test.go index 4677f3416a69..21c400a85a54 100644 --- a/internal/configs/config_test.go +++ b/internal/configs/config_test.go @@ -12,6 +12,7 @@ import ( "github.com/hashicorp/hcl/v2/hclsyntax" svchost "github.com/hashicorp/terraform-svchost" "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/getproviders" ) @@ -262,6 +263,128 @@ func TestConfigProviderRequirementsByModule(t *testing.T) { } } +func TestVerifyDependencySelections(t *testing.T) { + cfg, diags := testNestedModuleConfigFromDir(t, "testdata/provider-reqs") + // TODO: Version Constraint Deprecation. + // Once we've removed the version argument from provider configuration + // blocks, this can go back to expected 0 diagnostics. + // assertNoDiagnostics(t, diags) + assertDiagnosticCount(t, diags, 1) + assertDiagnosticSummary(t, diags, "Version constraints inside provider configuration blocks are deprecated") + + tlsProvider := addrs.NewProvider( + addrs.DefaultProviderRegistryHost, + "hashicorp", "tls", + ) + happycloudProvider := addrs.NewProvider( + svchost.Hostname("tf.example.com"), + "awesomecorp", "happycloud", + ) + nullProvider := addrs.NewDefaultProvider("null") + randomProvider := addrs.NewDefaultProvider("random") + impliedProvider := addrs.NewDefaultProvider("implied") + configuredProvider := addrs.NewDefaultProvider("configured") + grandchildProvider := addrs.NewDefaultProvider("grandchild") + + tests := map[string]struct { + PrepareLocks func(*depsfile.Locks) + WantErrs []string + }{ + "empty locks": { + func(*depsfile.Locks) { + // Intentionally blank + }, + []string{ + `provider registry.terraform.io/hashicorp/configured: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/grandchild: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/implied: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/null: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/random: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/tls: required by this configuration but no version is selected`, + `provider tf.example.com/awesomecorp/happycloud: required by this configuration but no version is selected`, + }, + }, + "suitable locks": { + func(locks *depsfile.Locks) { + locks.SetProvider(configuredProvider, getproviders.MustParseVersion("1.4.0"), nil, nil) + locks.SetProvider(grandchildProvider, getproviders.MustParseVersion("0.1.0"), nil, nil) + locks.SetProvider(impliedProvider, getproviders.MustParseVersion("0.2.0"), nil, nil) + locks.SetProvider(nullProvider, getproviders.MustParseVersion("2.0.1"), nil, nil) + locks.SetProvider(randomProvider, getproviders.MustParseVersion("1.2.2"), nil, nil) + locks.SetProvider(tlsProvider, getproviders.MustParseVersion("3.0.1"), nil, nil) + locks.SetProvider(happycloudProvider, getproviders.MustParseVersion("0.0.1"), nil, nil) + }, + nil, + }, + "null provider constraints changed": { + func(locks *depsfile.Locks) { + locks.SetProvider(configuredProvider, getproviders.MustParseVersion("1.4.0"), nil, nil) + locks.SetProvider(grandchildProvider, getproviders.MustParseVersion("0.1.0"), nil, nil) + locks.SetProvider(impliedProvider, getproviders.MustParseVersion("0.2.0"), nil, nil) + locks.SetProvider(nullProvider, getproviders.MustParseVersion("3.0.0"), nil, nil) + locks.SetProvider(randomProvider, getproviders.MustParseVersion("1.2.2"), nil, nil) + locks.SetProvider(tlsProvider, getproviders.MustParseVersion("3.0.1"), nil, nil) + locks.SetProvider(happycloudProvider, getproviders.MustParseVersion("0.0.1"), nil, nil) + }, + []string{ + `provider registry.terraform.io/hashicorp/null: locked version selection 3.0.0 doesn't match the updated version constraints "~> 2.0.0, 2.0.1"`, + }, + }, + "null provider lock changed": { + func(locks *depsfile.Locks) { + // In this case, we set the lock file version constraints to + // match the configuration, and so our error message changes + // to not assume the configuration changed anymore. + locks.SetProvider(nullProvider, getproviders.MustParseVersion("3.0.0"), getproviders.MustParseVersionConstraints("~> 2.0.0, 2.0.1"), nil) + + locks.SetProvider(configuredProvider, getproviders.MustParseVersion("1.4.0"), nil, nil) + locks.SetProvider(grandchildProvider, getproviders.MustParseVersion("0.1.0"), nil, nil) + locks.SetProvider(impliedProvider, getproviders.MustParseVersion("0.2.0"), nil, nil) + locks.SetProvider(randomProvider, getproviders.MustParseVersion("1.2.2"), nil, nil) + locks.SetProvider(tlsProvider, getproviders.MustParseVersion("3.0.1"), nil, nil) + locks.SetProvider(happycloudProvider, getproviders.MustParseVersion("0.0.1"), nil, nil) + }, + []string{ + `provider registry.terraform.io/hashicorp/null: version constraints "~> 2.0.0, 2.0.1" don't match the locked version selection 3.0.0`, + }, + }, + "overridden provider": { + func(locks *depsfile.Locks) { + locks.SetProviderOverridden(happycloudProvider) + }, + []string{ + // We still catch all of the other ones, because only happycloud was overridden + `provider registry.terraform.io/hashicorp/configured: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/grandchild: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/implied: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/null: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/random: required by this configuration but no version is selected`, + `provider registry.terraform.io/hashicorp/tls: required by this configuration but no version is selected`, + }, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + depLocks := depsfile.NewLocks() + test.PrepareLocks(depLocks) + gotErrs := cfg.VerifyDependencySelections(depLocks) + + var gotErrsStr []string + if gotErrs != nil { + gotErrsStr = make([]string, len(gotErrs)) + for i, err := range gotErrs { + gotErrsStr[i] = err.Error() + } + } + + if diff := cmp.Diff(test.WantErrs, gotErrsStr); diff != "" { + t.Errorf("wrong errors\n%s", diff) + } + }) + } +} + func TestConfigProviderForConfigAddr(t *testing.T) { cfg, diags := testModuleConfigFromDir("testdata/valid-modules/providers-fqns") assertNoDiagnostics(t, diags) diff --git a/internal/depsfile/locks.go b/internal/depsfile/locks.go index 751399070303..0dec32a1deb4 100644 --- a/internal/depsfile/locks.go +++ b/internal/depsfile/locks.go @@ -18,6 +18,20 @@ import ( type Locks struct { providers map[addrs.Provider]*ProviderLock + // overriddenProviders is a subset of providers which we might be tracking + // in field providers but whose lock information we're disregarding for + // this particular run due to some feature that forces Terraform to not + // use a normally-installed plugin for it. For example, the "provider dev + // overrides" feature means that we'll be using an arbitrary directory on + // disk as the package, regardless of what might be selected in "providers". + // + // overriddenProviders is an in-memory-only annotation, never stored as + // part of a lock file and thus not persistent between Terraform runs. + // The CLI layer is generally the one responsible for populating this, + // by calling SetProviderOverridden in response to CLI Configuration + // settings, environment variables, or whatever similar sources. + overriddenProviders map[addrs.Provider]struct{} + // TODO: In future we'll also have module locks, but the design of that // still needs some more work and we're deferring that to get the // provider locking capability out sooner, because it's more common to @@ -84,6 +98,48 @@ func (l *Locks) SetProvider(addr addrs.Provider, version getproviders.Version, c return new } +// SetProviderOverridden records that this particular Terraform process will +// not pay attention to the recorded lock entry for the given provider, and +// will instead access that provider's functionality in some other special +// way that isn't sensitive to provider version selections or checksums. +// +// This is an in-memory-only annotation which lives only inside a particular +// Locks object, and is never persisted as part of a saved lock file on disk. +// It's valid to still use other methods of the reciever to access +// already-stored lock information and to update lock information for an +// overridden provider, but some callers may need to use ProviderIsOverridden +// to selectively disregard stored lock information for overridden providers, +// depending on what they intended to use the lock information for. +func (l *Locks) SetProviderOverridden(addr addrs.Provider) { + if l.overriddenProviders == nil { + l.overriddenProviders = make(map[addrs.Provider]struct{}) + } + l.overriddenProviders[addr] = struct{}{} +} + +// ProviderIsOverridden returns true only if the given provider address was +// previously registered as overridden by calling SetProviderOverridden. +func (l *Locks) ProviderIsOverridden(addr addrs.Provider) bool { + _, ret := l.overriddenProviders[addr] + return ret +} + +// SetSameOverriddenProviders updates the receiver to mark as overridden all +// of the same providers already marked as overridden in the other given locks. +// +// This allows propagating override information between different lock objects, +// as if calling SetProviderOverridden for each address already overridden +// in the other given locks. If the reciever already has overridden providers, +// SetSameOverriddenProviders will preserve them. +func (l *Locks) SetSameOverriddenProviders(other *Locks) { + if other == nil { + return + } + for addr := range other.overriddenProviders { + l.SetProviderOverridden(addr) + } +} + // NewProviderLock creates a new ProviderLock object that isn't associated // with any Locks object. // From 9e0de1c46483f4bcacbe71b79925dde58408382c Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 1 Oct 2021 14:50:36 -0700 Subject: [PATCH 125/644] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f5b11e243e4a..15da0516165b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,9 @@ UPGRADE NOTES: * Terraform on macOS now requires macOS 10.13 High Sierra or later; Older macOS versions are no longer supported. * The `terraform graph` command no longer supports `-type=validate` and `-type=eval` options. The validate graph is always the same as the plan graph anyway, and the "eval" graph was just an implementation detail of the `terraform console` command. The default behavior of creating a plan graph should be a reasonable replacement for both of the removed graph modes. (Please note that `terraform graph` is not covered by the Terraform v1.0 compatibility promises, because its behavior inherently exposes Terraform Core implementation details, so we recommend it only for interactive debugging tasks and not for use in automation.) +* `terraform apply` with a previously-saved plan file will now verify that the provider plugin packages used to create the plan fully match the ones used during apply, using the same checksum scheme that Terraform normally uses for the dependency lock file. Previously Terraform was checking consistency of plugins from a plan file using a legacy mechanism which covered only the main plugin executable, not any other files that might be distributed alongside in the plugin package. + + This additional check should not affect typical plugins that conform to the expectation that a plugin package's contents are immutable once released, but may affect a hypothetical in-house plugin that intentionally modifies extra files in its package directory somehow between plan and apply. If you have such a plugin, you'll need to change its approach to store those files in some other location separate from the package directory. This is a minor compatibility break motivated by increasing the assurance that plugins have not been inadvertently or maliciously modified between plan and apply. NEW FEATURES: From 45dab1b956c4828a0b144ad1db9c1bc4564c53bf Mon Sep 17 00:00:00 2001 From: Ram Date: Sat, 2 Oct 2021 17:15:51 +0800 Subject: [PATCH 126/644] replace an with a --- website/docs/cli/commands/state/rm.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/state/rm.html.md b/website/docs/cli/commands/state/rm.html.md index 3cc9f297eac7..131c31a815f3 100644 --- a/website/docs/cli/commands/state/rm.html.md +++ b/website/docs/cli/commands/state/rm.html.md @@ -12,7 +12,7 @@ The main function of [Terraform state](/docs/language/state/index.html) is to track the bindings between resource instance addresses in your configuration and the remote objects they represent. Normally Terraform automatically updates the state in response to actions taken when applying a plan, such as -removing a binding for an remote object that has now been deleted. +removing a binding for a remote object that has now been deleted. You can use `terraform state rm` in the less common situation where you wish to remove a binding to an existing remote object without first destroying it, From 18d354223e5a4b039fdf2d10c2c7c6dba6269992 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 4 Oct 2021 14:21:16 -0400 Subject: [PATCH 127/644] objchange: fix ProposedNew from null objects The codepath for AllAttributesNull was not correct for any nested object types with collections, and should create single null values for the correct NestingMode rather than a single object with null attributes. Since there is no reason to descend into nested object types to create nullv alues, we can drop the AllAttributesNull function altogether and create null values as needed during ProposedNew. The corresponding AllBlockAttributesNull was only called internally in 1 location, and simply delegated to schema.EmptyValue. We can reduce the package surface area by dropping that function too and calling EmptyValue directly. --- internal/plans/objchange/all_null.go | 33 ------- internal/plans/objchange/objchange.go | 16 +++- internal/plans/objchange/objchange_test.go | 104 +++++++++++++++++++++ 3 files changed, 115 insertions(+), 38 deletions(-) delete mode 100644 internal/plans/objchange/all_null.go diff --git a/internal/plans/objchange/all_null.go b/internal/plans/objchange/all_null.go deleted file mode 100644 index fb7ec4cfb35c..000000000000 --- a/internal/plans/objchange/all_null.go +++ /dev/null @@ -1,33 +0,0 @@ -package objchange - -import ( - "github.com/hashicorp/terraform/internal/configs/configschema" - "github.com/zclconf/go-cty/cty" -) - -// AllBlockAttributesNull constructs a non-null cty.Value of the object type implied -// by the given schema that has all of its leaf attributes set to null and all -// of its nested block collections set to zero-length. -// -// This simulates what would result from decoding an empty configuration block -// with the given schema, except that it does not produce errors -func AllBlockAttributesNull(schema *configschema.Block) cty.Value { - // "All attributes null" happens to be the definition of EmptyValue for - // a Block, so we can just delegate to that. - return schema.EmptyValue() -} - -// AllAttributesNull returns a cty.Value of the object type implied by the given -// attriubutes that has all of its leaf attributes set to null. -func AllAttributesNull(attrs map[string]*configschema.Attribute) cty.Value { - newAttrs := make(map[string]cty.Value, len(attrs)) - - for name, attr := range attrs { - if attr.NestedType != nil { - newAttrs[name] = AllAttributesNull(attr.NestedType.Attributes) - } else { - newAttrs[name] = cty.NullVal(attr.Type) - } - } - return cty.ObjectVal(newAttrs) -} diff --git a/internal/plans/objchange/objchange.go b/internal/plans/objchange/objchange.go index 739d666480bc..63e8464510d9 100644 --- a/internal/plans/objchange/objchange.go +++ b/internal/plans/objchange/objchange.go @@ -37,7 +37,10 @@ func ProposedNew(schema *configschema.Block, prior, config cty.Value) cty.Value // similar to the result of decoding an empty configuration block, // which simplifies our handling of the top-level attributes/blocks // below by giving us one non-null level of object to pull values from. - prior = AllBlockAttributesNull(schema) + // + // "All attributes null" happens to be the definition of EmptyValue for + // a Block, so we can just delegate to that + prior = schema.EmptyValue() } return proposedNew(schema, prior, config) } @@ -258,12 +261,15 @@ func proposedNewNestedBlock(schema *configschema.NestedBlock, prior, config cty. } func proposedNewAttributes(attrs map[string]*configschema.Attribute, prior, config cty.Value) map[string]cty.Value { - if prior.IsNull() { - prior = AllAttributesNull(attrs) - } newAttrs := make(map[string]cty.Value, len(attrs)) for name, attr := range attrs { - priorV := prior.GetAttr(name) + var priorV cty.Value + if prior.IsNull() { + priorV = cty.NullVal(prior.Type().AttributeType(name)) + } else { + priorV = prior.GetAttr(name) + } + configV := config.GetAttr(name) var newV cty.Value switch { diff --git a/internal/plans/objchange/objchange_test.go b/internal/plans/objchange/objchange_test.go index b0021fb14b20..32a56320cf50 100644 --- a/internal/plans/objchange/objchange_test.go +++ b/internal/plans/objchange/objchange_test.go @@ -1536,6 +1536,110 @@ func TestProposedNew(t *testing.T) { }), }), }, + "prior null nested objects": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "single": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingSingle, + Attributes: map[string]*configschema.Attribute{ + "list": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "foo": { + Type: cty.String, + }, + }, + }, + Optional: true, + }, + }, + }, + Optional: true, + }, + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingMap, + Attributes: map[string]*configschema.Attribute{ + "map": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "foo": { + Type: cty.String, + }, + }, + }, + Optional: true, + }, + }, + }, + Optional: true, + }, + }, + }, + cty.NullVal(cty.Object(map[string]cty.Type{ + "single": cty.Object(map[string]cty.Type{ + "list": cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + }), + "map": cty.Map(cty.Object(map[string]cty.Type{ + "list": cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + })), + })), + cty.ObjectVal(map[string]cty.Value{ + "single": cty.ObjectVal(map[string]cty.Value{ + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("a"), + }), + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("b"), + }), + }), + }), + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("a"), + }), + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("b"), + }), + }), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "single": cty.ObjectVal(map[string]cty.Value{ + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("a"), + }), + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("b"), + }), + }), + }), + "map": cty.MapVal(map[string]cty.Value{ + "one": cty.ObjectVal(map[string]cty.Value{ + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("a"), + }), + cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("b"), + }), + }), + }), + }), + }), + }, } for name, test := range tests { From 58d85fcc2e21c2b68d4b0c391422f5b001be0a9b Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 5 Oct 2021 12:31:23 -0400 Subject: [PATCH 128/644] add test for planing unknown data source values --- internal/plans/objchange/objchange_test.go | 48 ++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/internal/plans/objchange/objchange_test.go b/internal/plans/objchange/objchange_test.go index 32a56320cf50..4c434d3e42ee 100644 --- a/internal/plans/objchange/objchange_test.go +++ b/internal/plans/objchange/objchange_test.go @@ -1640,6 +1640,54 @@ func TestProposedNew(t *testing.T) { }), }), }, + + // data sources are planned with an unknown value + "unknown prior nested objects": { + &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "list": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "list": { + NestedType: &configschema.Object{ + Nesting: configschema.NestingList, + Attributes: map[string]*configschema.Attribute{ + "foo": { + Type: cty.String, + }, + }, + }, + Computed: true, + }, + }, + }, + Computed: true, + }, + }, + }, + cty.UnknownVal(cty.Object(map[string]cty.Type{ + "List": cty.List(cty.Object(map[string]cty.Type{ + "list": cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + })), + })), + cty.NullVal(cty.Object(map[string]cty.Type{ + "List": cty.List(cty.Object(map[string]cty.Type{ + "list": cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + })), + })), + cty.UnknownVal(cty.Object(map[string]cty.Type{ + "List": cty.List(cty.Object(map[string]cty.Type{ + "list": cty.List(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + })), + })), + }, } for name, test := range tests { From d09510a8fbcb4121d5b67d160d3d1ee4811eac9f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 1 Oct 2021 14:51:06 -0700 Subject: [PATCH 129/644] command: Early error message for missing cache entries of locked providers In the original incarnation of Meta.providerFactories we were returning into a Meta.contextOpts whose signature didn't allow it to return an error directly, and so we had compromised by making the provider factory functions themselves return errors once called. Subsequent work made Meta.contextOpts need to return an error anyway, but at the time we neglected to update our handling of the providerFactories result, having it still defer the error handling until we finally instantiate a provider. Although that did ultimately get the expected result anyway, the error ended up being reported from deep in the guts of a Terraform Core graph walk, in whichever concurrently-visited graph node happened to try to instantiate the plugin first. This meant that the exact phrasing of the error message would vary between runs and the reporting codepath didn't have enough context to given an actionable suggestion on how to proceed. In this commit we make Meta.contextOpts pass through directly any error that Meta.providerFactories produces, and then make Meta.providerFactories produce a special error type so that Meta.Backend can ultimately return a user-friendly diagnostic message containing a specific suggestion to run "terraform init", along with a short explanation of what a provider plugin is. The reliance here on an implied contract between two functions that are not directly connected in the callstack is non-ideal, and so hopefully we'll revisit this further in future work on the overall architecture of the CLI layer. To try to make this robust in the meantime though, I wrote it to use the errors.As function to potentially unwrap a wrapped version of our special error type, in case one of the intervening layers is changed at some point to wrap the downstream error before returning it. --- internal/command/meta.go | 15 +------------- internal/command/meta_backend.go | 29 +++++++++++++++++++++++++- internal/command/meta_providers.go | 33 +++++++++++++++++++++++++++--- 3 files changed, 59 insertions(+), 18 deletions(-) diff --git a/internal/command/meta.go b/internal/command/meta.go index 0a4029ef0151..cd9387173f0d 100644 --- a/internal/command/meta.go +++ b/internal/command/meta.go @@ -461,20 +461,7 @@ func (m *Meta) contextOpts() (*terraform.ContextOpts, error) { } else { providerFactories, err := m.providerFactories() if err != nil { - // providerFactories can fail if the plugin selections file is - // invalid in some way, but we don't have any way to report that - // from here so we'll just behave as if no providers are available - // in that case. However, we will produce a warning in case this - // shows up unexpectedly and prompts a bug report. - // This situation shouldn't arise commonly in practice because - // the selections file is generated programmatically. - log.Printf("[WARN] Failed to determine selected providers: %s", err) - - // variable providerFactories may now be incomplete, which could - // lead to errors reported downstream from here. providerFactories - // tries to populate as many providers as possible even in an - // error case, so that operations not using problematic providers - // can still succeed. + return nil, err } opts.Providers = providerFactories opts.Provisioners = m.provisionerFactories() diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 5d2aa5ed3b91..3828708175ae 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -4,8 +4,10 @@ package command // exported and private. import ( + "bytes" "context" "encoding/json" + "errors" "fmt" "log" "path/filepath" @@ -105,7 +107,32 @@ func (m *Meta) Backend(opts *BackendOpts) (backend.Enhanced, tfdiags.Diagnostics // Set up the CLI opts we pass into backends that support it. cliOpts, err := m.backendCLIOpts() if err != nil { - diags = diags.Append(err) + if errs := providerPluginErrors(nil); errors.As(err, &errs) { + // This is a special type returned by m.providerFactories, which + // indicates one or more inconsistencies between the dependency + // lock file and the provider plugins actually available in the + // local cache directory. + var buf bytes.Buffer + for addr, err := range errs { + fmt.Fprintf(&buf, "\n - %s: %s", addr, err) + } + suggestion := "To download the plugins required for this configuration, run:\n terraform init" + if m.RunningInAutomation { + // Don't mention "terraform init" specifically if we're running in an automation wrapper + suggestion = "You must install the required plugins before running Terraform operations." + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Required plugins are not installed", + fmt.Sprintf( + "The installed provider plugins are not consistent with the packages selected in the dependency lock file:%s\n\nTerraform uses external plugins to integrate with a variety of different infrastructure services. %s", + buf.String(), suggestion, + ), + )) + } else { + // All other errors just get generic handling. + diags = diags.Append(err) + } return nil, diags } cliOpts.Validation = true diff --git a/internal/command/meta_providers.go b/internal/command/meta_providers.go index ffe52ffde6c2..c406e4745f23 100644 --- a/internal/command/meta_providers.go +++ b/internal/command/meta_providers.go @@ -1,6 +1,7 @@ package command import ( + "bytes" "errors" "fmt" "log" @@ -8,7 +9,6 @@ import ( "os/exec" "strings" - "github.com/hashicorp/go-multierror" plugin "github.com/hashicorp/go-plugin" "github.com/hashicorp/terraform/internal/addrs" @@ -236,7 +236,7 @@ func (m *Meta) providerFactories() (map[addrs.Provider]providers.Factory, error) // where appropriate and so that callers can potentially make use of the // partial result we return if e.g. they want to enumerate which providers // are available, or call into one of the providers that didn't fail. - var err error + errs := make(map[addrs.Provider]error) // For the providers from the lock file, we expect them to be already // available in the provider cache because "terraform init" should already @@ -274,7 +274,7 @@ func (m *Meta) providerFactories() (map[addrs.Provider]providers.Factory, error) } for provider, lock := range providerLocks { reportError := func(thisErr error) { - err = multierror.Append(err, thisErr) + errs[provider] = thisErr // We'll populate a provider factory that just echoes our error // again if called, which allows us to still report a helpful // error even if it gets detected downstream somewhere from the @@ -324,6 +324,11 @@ func (m *Meta) providerFactories() (map[addrs.Provider]providers.Factory, error) for provider, reattach := range unmanagedProviders { factories[provider] = unmanagedProviderFactory(provider, reattach) } + + var err error + if len(errs) > 0 { + err = providerPluginErrors(errs) + } return factories, err } @@ -475,3 +480,25 @@ func providerFactoryError(err error) providers.Factory { return nil, err } } + +// providerPluginErrors is an error implementation we can return from +// Meta.providerFactories to capture potentially multiple errors about the +// locally-cached plugins (or lack thereof) for particular external providers. +// +// Some functions closer to the UI layer can sniff for this error type in order +// to return a more helpful error message. +type providerPluginErrors map[addrs.Provider]error + +func (errs providerPluginErrors) Error() string { + if len(errs) == 1 { + for addr, err := range errs { + return fmt.Sprintf("%s: %s", addr, err) + } + } + var buf bytes.Buffer + fmt.Fprintf(&buf, "missing or corrupted provider plugins:") + for addr, err := range errs { + fmt.Fprintf(&buf, "\n - %s: %s", addr, err) + } + return buf.String() +} From 01b22f4b7688c9cf084214ef1dfe51ed7719fe42 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 1 Oct 2021 16:19:36 -0700 Subject: [PATCH 130/644] command/e2etest: TestProviderTampering We have various mechanisms that aim to ensure that the installed provider plugins are consistent with the lock file and that the lock file is consistent with the provider requirements, and we do have existing unit tests for them, but all of those cases mock our fake out at least part of the process and in the past that's caused us to miss usability regressions, where we still catch the error but do so at the wrong layer and thus generate error message lacking useful additional context. Here we'll add some new end-to-end tests to supplement the existing unit tests, making sure things work as expected when we assemble the system together as we would in a release. These tests cover a number of different ways in which the plugin selections can grow inconsistent. These new tests all run only when we're in a context where we're allowed to access the network, because they exercise the real plugin installer codepath. We could technically build this to use a local filesystem mirror or other such override to avoid that, but the point here is to make sure we see the expected behavior in the main case, and so it's worth the small additional cost of downloading the null provider from the real registry. --- .../command/e2etest/providers_tamper_test.go | 221 ++++++++++++++++++ .../provider-tampering-base.tf | 12 + 2 files changed, 233 insertions(+) create mode 100644 internal/command/e2etest/providers_tamper_test.go create mode 100644 internal/command/e2etest/testdata/provider-tampering-base/provider-tampering-base.tf diff --git a/internal/command/e2etest/providers_tamper_test.go b/internal/command/e2etest/providers_tamper_test.go new file mode 100644 index 000000000000..ac5612192050 --- /dev/null +++ b/internal/command/e2etest/providers_tamper_test.go @@ -0,0 +1,221 @@ +package e2etest + +import ( + "io/ioutil" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/hashicorp/terraform/internal/e2e" + "github.com/hashicorp/terraform/internal/getproviders" +) + +// TestProviderTampering tests various ways that the provider plugins in the +// local cache directory might be modified after an initial "terraform init", +// which other Terraform commands which use those plugins should catch and +// report early. +func TestProviderTampering(t *testing.T) { + // General setup: we'll do a one-off init of a test directory as our + // starting point, and then we'll clone that result for each test so + // that we can save the cost of a repeated re-init with the same + // provider. + t.Parallel() + + // This test reaches out to releases.hashicorp.com to download the + // null provider, so it can only run if network access is allowed. + skipIfCannotAccessNetwork(t) + + fixturePath := filepath.Join("testdata", "provider-tampering-base") + tf := e2e.NewBinary(terraformBin, fixturePath) + defer tf.Close() + + stdout, stderr, err := tf.Run("init") + if err != nil { + t.Fatalf("unexpected init error: %s\nstderr:\n%s", err, stderr) + } + if !strings.Contains(stdout, "Installing hashicorp/null v") { + t.Errorf("null provider download message is missing from init output:\n%s", stdout) + t.Logf("(this can happen if you have a copy of the plugin in one of the global plugin search dirs)") + } + + seedDir := tf.WorkDir() + const providerVersion = "3.1.0" // must match the version in the fixture config + pluginDir := ".terraform/providers/registry.terraform.io/hashicorp/null/" + providerVersion + "/" + getproviders.CurrentPlatform.String() + pluginExe := pluginDir + "/terraform-provider-null_v" + providerVersion + "_x5" + if getproviders.CurrentPlatform.OS == "windows" { + pluginExe += ".exe" // ugh + } + + t.Run("cache dir totally gone", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + err := os.RemoveAll(filepath.Join(workDir, ".terraform")) + if err != nil { + t.Fatal(err) + } + + _, stderr, err := tf.Run("plan") + if err == nil { + t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) + } + if want := `registry.terraform.io/hashicorp/null: there is no package for registry.terraform.io/hashicorp/null 3.1.0 cached in .terraform/providers`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + if want := `terraform init`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) + t.Run("null plugin package modified before plan", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + err := ioutil.WriteFile(filepath.Join(workDir, pluginExe), []byte("tamper"), 0600) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("plan") + if err == nil { + t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) + } + if want := `registry.terraform.io/hashicorp/null: the cached package for registry.terraform.io/hashicorp/null 3.1.0 (in .terraform/providers) does not match any of the checksums recorded in the dependency lock file`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + if want := `terraform init`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) + t.Run("version constraint changed in config before plan", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + err := ioutil.WriteFile(filepath.Join(workDir, "provider-tampering-base.tf"), []byte(` + terraform { + required_providers { + null = { + source = "hashicorp/null" + version = "1.0.0" + } + } + } + `), 0600) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("plan") + if err == nil { + t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) + } + if want := `provider registry.terraform.io/hashicorp/null: locked version selection 3.1.0 doesn't match the updated version constraints "1.0.0"`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + if want := `terraform init -upgrade`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) + t.Run("lock file modified before plan", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + // NOTE: We're just emptying out the lock file here because that's + // good enough for what we're trying to assert. The leaf codepath + // that generates this family of errors has some different variations + // of this error message for otehr sorts of inconsistency, but those + // are tested more thoroughly over in the "configs" package, which is + // ultimately responsible for that logic. + err := ioutil.WriteFile(filepath.Join(workDir, ".terraform.lock.hcl"), []byte(``), 0600) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("plan") + if err == nil { + t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) + } + if want := `provider registry.terraform.io/hashicorp/null: required by this configuration but no version is selected`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + if want := `terraform init`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) + t.Run("lock file modified after plan", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + _, stderr, err := tf.Run("plan", "-out", "tfplan") + if err != nil { + t.Fatalf("unexpected plan failure\nstderr:\n%s", stderr) + } + + err = os.Remove(filepath.Join(workDir, ".terraform.lock.hcl")) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("apply", "tfplan") + if err == nil { + t.Fatalf("unexpected apply success\nstdout:\n%s", stdout) + } + if want := `provider registry.terraform.io/hashicorp/null: required by this configuration but no version is selected`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + if want := `Create a new plan from the updated configuration.`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) + t.Run("plugin cache dir entirely removed after plan", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + _, stderr, err := tf.Run("plan", "-out", "tfplan") + if err != nil { + t.Fatalf("unexpected plan failure\nstderr:\n%s", stderr) + } + + err = os.RemoveAll(filepath.Join(workDir, ".terraform")) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("apply", "tfplan") + if err == nil { + t.Fatalf("unexpected apply success\nstdout:\n%s", stdout) + } + if want := `registry.terraform.io/hashicorp/null: there is no package for registry.terraform.io/hashicorp/null 3.1.0 cached in .terraform/providers`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) + t.Run("null plugin package modified after plan", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + _, stderr, err := tf.Run("plan", "-out", "tfplan") + if err != nil { + t.Fatalf("unexpected plan failure\nstderr:\n%s", stderr) + } + + err = ioutil.WriteFile(filepath.Join(workDir, pluginExe), []byte("tamper"), 0600) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("apply", "tfplan") + if err == nil { + t.Fatalf("unexpected apply success\nstdout:\n%s", stdout) + } + if want := `registry.terraform.io/hashicorp/null: the cached package for registry.terraform.io/hashicorp/null 3.1.0 (in .terraform/providers) does not match any of the checksums recorded in the dependency lock file`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + }) +} diff --git a/internal/command/e2etest/testdata/provider-tampering-base/provider-tampering-base.tf b/internal/command/e2etest/testdata/provider-tampering-base/provider-tampering-base.tf new file mode 100644 index 000000000000..87bd9ac20058 --- /dev/null +++ b/internal/command/e2etest/testdata/provider-tampering-base/provider-tampering-base.tf @@ -0,0 +1,12 @@ +terraform { + required_providers { + null = { + # Our version is intentionally fixed so that we have a fixed + # test case here, though we might have to update this in future + # if e.g. Terraform stops supporting plugin protocol 5, or if + # the null provider is yanked from the registry for some reason. + source = "hashicorp/null" + version = "3.1.0" + } + } +} From 44764ffdee24e2081f939ca14d1dfab2d2a33418 Mon Sep 17 00:00:00 2001 From: Jeff Escalante Date: Tue, 5 Oct 2021 16:31:02 -0400 Subject: [PATCH 131/644] fix broken logo in readme (#29705) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c11e38babf79..4f235995f237 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Terraform - Tutorials: [HashiCorp's Learn Platform](https://learn.hashicorp.com/terraform) - Certification Exam: [HashiCorp Certified: Terraform Associate](https://www.hashicorp.com/certification/#hashicorp-certified-terraform-associate) -Terraform +Terraform Terraform is a tool for building, changing, and versioning infrastructure safely and efficiently. Terraform can manage existing and popular service providers as well as custom in-house solutions. From bea7e3ebcebe86144d5d07acf7c0e222d3d2ab1f Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Tue, 5 Oct 2021 16:36:50 -0400 Subject: [PATCH 132/644] Backend State Migration: change variable names from one/two to source/destination (#29699) --- internal/command/meta_backend.go | 24 +-- internal/command/meta_backend_migrate.go | 190 +++++++++++------------ 2 files changed, 107 insertions(+), 107 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 3828708175ae..4d9b115d417a 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -753,10 +753,10 @@ func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.Local // Perform the migration err := m.backendMigrateState(&backendMigrateOpts{ - OneType: s.Backend.Type, - TwoType: "local", - One: b, - Two: localB, + SourceType: s.Backend.Type, + DestinationType: "local", + Source: b, + Destination: localB, }) if err != nil { diags = diags.Append(err) @@ -829,10 +829,10 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local if len(localStates) > 0 { // Perform the migration err = m.backendMigrateState(&backendMigrateOpts{ - OneType: "local", - TwoType: c.Type, - One: localB, - Two: b, + SourceType: "local", + DestinationType: c.Type, + Source: localB, + Destination: b, }) if err != nil { diags = diags.Append(err) @@ -944,10 +944,10 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista // Perform the migration err := m.backendMigrateState(&backendMigrateOpts{ - OneType: s.Backend.Type, - TwoType: c.Type, - One: oldB, - Two: b, + SourceType: s.Backend.Type, + DestinationType: c.Type, + Source: oldB, + Destination: b, }) if err != nil { diags = diags.Append(err) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 0021b5850a53..d868200f1bda 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -21,14 +21,14 @@ import ( ) type backendMigrateOpts struct { - OneType, TwoType string - One, Two backend.Backend + SourceType, DestinationType string + Source, Destination backend.Backend // Fields below are set internally when migrate is called - oneEnv string // source env - twoEnv string // dest env - force bool // if true, won't ask for confirmation + sourceWorkspace string + destinationWorkspace string + force bool // if true, won't ask for confirmation } // backendMigrateState handles migrating (copying) state from one backend @@ -43,45 +43,45 @@ type backendMigrateOpts struct { // // This will attempt to lock both states for the migration. func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { - log.Printf("[TRACE] backendMigrateState: need to migrate from %q to %q backend config", opts.OneType, opts.TwoType) + log.Printf("[TRACE] backendMigrateState: need to migrate from %q to %q backend config", opts.SourceType, opts.DestinationType) // We need to check what the named state status is. If we're converting // from multi-state to single-state for example, we need to handle that. - var oneSingle, twoSingle bool - oneStates, err := opts.One.Workspaces() + var sourceSingleState, destinationSingleState bool + sourceWorkspaces, err := opts.Source.Workspaces() if err == backend.ErrWorkspacesNotSupported { - oneSingle = true + sourceSingleState = true err = nil } if err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateLoadStates), opts.OneType, err) + errMigrateLoadStates), opts.SourceType, err) } - twoWorkspaces, err := opts.Two.Workspaces() + destinationWorkspaces, err := opts.Destination.Workspaces() if err == backend.ErrWorkspacesNotSupported { - twoSingle = true + destinationSingleState = true err = nil } if err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateLoadStates), opts.TwoType, err) + errMigrateLoadStates), opts.DestinationType, err) } // Set up defaults - opts.oneEnv = backend.DefaultStateName - opts.twoEnv = backend.DefaultStateName + opts.sourceWorkspace = backend.DefaultStateName + opts.destinationWorkspace = backend.DefaultStateName opts.force = m.forceInitCopy // Disregard remote Terraform version for the state source backend. If it's a // Terraform Cloud remote backend, we don't care about the remote version, // as we are migrating away and will not break a remote workspace. - m.ignoreRemoteBackendVersionConflict(opts.One) + m.ignoreRemoteBackendVersionConflict(opts.Source) - for _, twoWorkspace := range twoWorkspaces { + for _, workspace := range destinationWorkspaces { // Check the remote Terraform version for the state destination backend. If // it's a Terraform Cloud remote backend, we want to ensure that we don't // break the workspace by uploading an incompatible state file. - diags := m.remoteBackendVersionCheck(opts.Two, twoWorkspace) + diags := m.remoteBackendVersionCheck(opts.Destination, workspace) if diags.HasErrors() { return diags.Err() } @@ -92,20 +92,20 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { switch { // Single-state to single-state. This is the easiest case: we just // copy the default state directly. - case oneSingle && twoSingle: + case sourceSingleState && destinationSingleState: return m.backendMigrateState_s_s(opts) // Single-state to multi-state. This is easy since we just copy // the default state and ignore the rest in the destination. - case oneSingle && !twoSingle: + case sourceSingleState && !destinationSingleState: return m.backendMigrateState_s_s(opts) // Multi-state to single-state. If the source has more than the default // state this is complicated since we have to ask the user what to do. - case !oneSingle && twoSingle: + case !sourceSingleState && destinationSingleState: // If the source only has one state and it is the default, // treat it as if it doesn't support multi-state. - if len(oneStates) == 1 && oneStates[0] == backend.DefaultStateName { + if len(sourceWorkspaces) == 1 && sourceWorkspaces[0] == backend.DefaultStateName { return m.backendMigrateState_s_s(opts) } @@ -113,10 +113,10 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { // Multi-state to multi-state. We merge the states together (migrating // each from the source to the destination one by one). - case !oneSingle && !twoSingle: + case !sourceSingleState && !destinationSingleState: // If the source only has one state and it is the default, // treat it as if it doesn't support multi-state. - if len(oneStates) == 1 && oneStates[0] == backend.DefaultStateName { + if len(sourceWorkspaces) == 1 && sourceWorkspaces[0] == backend.DefaultStateName { return m.backendMigrateState_s_s(opts) } @@ -154,10 +154,10 @@ func (m *Meta) backendMigrateState_S_S(opts *backendMigrateOpts) error { Id: "backend-migrate-multistate-to-multistate", Query: fmt.Sprintf( "Do you want to migrate all workspaces to %q?", - opts.TwoType), + opts.DestinationType), Description: fmt.Sprintf( strings.TrimSpace(inputBackendMigrateMultiToMulti), - opts.OneType, opts.TwoType), + opts.SourceType, opts.DestinationType), }) if err != nil { return fmt.Errorf( @@ -169,20 +169,20 @@ func (m *Meta) backendMigrateState_S_S(opts *backendMigrateOpts) error { } // Read all the states - oneStates, err := opts.One.Workspaces() + sourceWorkspaces, err := opts.Source.Workspaces() if err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateLoadStates), opts.OneType, err) + errMigrateLoadStates), opts.SourceType, err) } // Sort the states so they're always copied alphabetically - sort.Strings(oneStates) + sort.Strings(sourceWorkspaces) // Go through each and migrate - for _, name := range oneStates { + for _, name := range sourceWorkspaces { // Copy the same names - opts.oneEnv = name - opts.twoEnv = name + opts.sourceWorkspace = name + opts.destinationWorkspace = name // Force it, we confirmed above opts.force = true @@ -190,7 +190,7 @@ func (m *Meta) backendMigrateState_S_S(opts *backendMigrateOpts) error { // Perform the migration if err := m.backendMigrateState_s_s(opts); err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateMulti), name, opts.OneType, opts.TwoType, err) + errMigrateMulti), name, opts.SourceType, opts.DestinationType, err) } } @@ -199,7 +199,7 @@ func (m *Meta) backendMigrateState_S_S(opts *backendMigrateOpts) error { // Multi-state to single state. func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { - log.Printf("[TRACE] backendMigrateState: target backend type %q does not support named workspaces", opts.TwoType) + log.Printf("[TRACE] backendMigrateState: destination backend type %q does not support named workspaces", opts.DestinationType) currentEnv, err := m.Workspace() if err != nil { @@ -215,10 +215,10 @@ func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { Query: fmt.Sprintf( "Destination state %q doesn't support workspaces.\n"+ "Do you want to copy only your current workspace?", - opts.TwoType), + opts.DestinationType), Description: fmt.Sprintf( strings.TrimSpace(inputBackendMigrateMultiToSingle), - opts.OneType, opts.TwoType, currentEnv), + opts.SourceType, opts.DestinationType, currentEnv), }) if err != nil { return fmt.Errorf( @@ -231,7 +231,7 @@ func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { } // Copy the default state - opts.oneEnv = currentEnv + opts.sourceWorkspace = currentEnv // now switch back to the default env so we can acccess the new backend m.SetWorkspace(backend.DefaultStateName) @@ -241,46 +241,46 @@ func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { // Single state to single state, assumed default state name. func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { - log.Printf("[TRACE] backendMigrateState: migrating %q workspace to %q workspace", opts.oneEnv, opts.twoEnv) + log.Printf("[TRACE] backendMigrateState: migrating %q workspace to %q workspace", opts.sourceWorkspace, opts.destinationWorkspace) - stateOne, err := opts.One.StateMgr(opts.oneEnv) + sourceState, err := opts.Source.StateMgr(opts.sourceWorkspace) if err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateSingleLoadDefault), opts.OneType, err) + errMigrateSingleLoadDefault), opts.SourceType, err) } - if err := stateOne.RefreshState(); err != nil { + if err := sourceState.RefreshState(); err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateSingleLoadDefault), opts.OneType, err) + errMigrateSingleLoadDefault), opts.SourceType, err) } // Do not migrate workspaces without state. - if stateOne.State().Empty() { + if sourceState.State().Empty() { log.Print("[TRACE] backendMigrateState: source workspace has empty state, so nothing to migrate") return nil } - stateTwo, err := opts.Two.StateMgr(opts.twoEnv) + destinationState, err := opts.Destination.StateMgr(opts.destinationWorkspace) if err == backend.ErrDefaultWorkspaceNotSupported { // If the backend doesn't support using the default state, we ask the user // for a new name and migrate the default state to the given named state. - stateTwo, err = func() (statemgr.Full, error) { - log.Print("[TRACE] backendMigrateState: target doesn't support a default workspace, so we must prompt for a new name") + destinationState, err = func() (statemgr.Full, error) { + log.Print("[TRACE] backendMigrateState: destination doesn't support a default workspace, so we must prompt for a new name") name, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "new-state-name", Query: fmt.Sprintf( "[reset][bold][yellow]The %q backend configuration only allows "+ "named workspaces![reset]", - opts.TwoType), + opts.DestinationType), Description: strings.TrimSpace(inputBackendNewWorkspaceName), }) if err != nil { return nil, fmt.Errorf("Error asking for new state name: %s", err) } - // Update the name of the target state. - opts.twoEnv = name + // Update the name of the destination state. + opts.destinationWorkspace = name - stateTwo, err := opts.Two.StateMgr(opts.twoEnv) + destinationState, err := opts.Destination.StateMgr(opts.destinationWorkspace) if err != nil { return nil, err } @@ -291,34 +291,34 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { // If the currently selected workspace is the default workspace, then set // the named workspace as the new selected workspace. if workspace == backend.DefaultStateName { - if err := m.SetWorkspace(opts.twoEnv); err != nil { + if err := m.SetWorkspace(opts.destinationWorkspace); err != nil { return nil, fmt.Errorf("Failed to set new workspace: %s", err) } } - return stateTwo, nil + return destinationState, nil }() } if err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateSingleLoadDefault), opts.TwoType, err) + errMigrateSingleLoadDefault), opts.DestinationType, err) } - if err := stateTwo.RefreshState(); err != nil { + if err := destinationState.RefreshState(); err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateSingleLoadDefault), opts.TwoType, err) + errMigrateSingleLoadDefault), opts.DestinationType, err) } // Check if we need migration at all. // This is before taking a lock, because they may also correspond to the same lock. - one := stateOne.State() - two := stateTwo.State() + source := sourceState.State() + destination := destinationState.State() // no reason to migrate if the state is already there - if one.Equal(two) { + if source.Equal(destination) { // Equal isn't identical; it doesn't check lineage. - sm1, _ := stateOne.(statemgr.PersistentMeta) - sm2, _ := stateTwo.(statemgr.PersistentMeta) - if one != nil && two != nil { + sm1, _ := sourceState.(statemgr.PersistentMeta) + sm2, _ := destinationState.(statemgr.PersistentMeta) + if source != nil && destination != nil { if sm1 == nil || sm2 == nil { log.Print("[TRACE] backendMigrateState: both source and destination workspaces have no state, so no migration is needed") return nil @@ -336,56 +336,56 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { view := views.NewStateLocker(arguments.ViewHuman, m.View) locker := clistate.NewLocker(m.stateLockTimeout, view) - lockerOne := locker.WithContext(lockCtx) - if diags := lockerOne.Lock(stateOne, "migration source state"); diags.HasErrors() { + lockerSource := locker.WithContext(lockCtx) + if diags := lockerSource.Lock(sourceState, "migration source state"); diags.HasErrors() { return diags.Err() } - defer lockerOne.Unlock() + defer lockerSource.Unlock() - lockerTwo := locker.WithContext(lockCtx) - if diags := lockerTwo.Lock(stateTwo, "migration destination state"); diags.HasErrors() { + lockerDestination := locker.WithContext(lockCtx) + if diags := lockerDestination.Lock(destinationState, "migration destination state"); diags.HasErrors() { return diags.Err() } - defer lockerTwo.Unlock() + defer lockerDestination.Unlock() // We now own a lock, so double check that we have the version // corresponding to the lock. log.Print("[TRACE] backendMigrateState: refreshing source workspace state") - if err := stateOne.RefreshState(); err != nil { + if err := sourceState.RefreshState(); err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateSingleLoadDefault), opts.OneType, err) + errMigrateSingleLoadDefault), opts.SourceType, err) } - log.Print("[TRACE] backendMigrateState: refreshing target workspace state") - if err := stateTwo.RefreshState(); err != nil { + log.Print("[TRACE] backendMigrateState: refreshing destination workspace state") + if err := destinationState.RefreshState(); err != nil { return fmt.Errorf(strings.TrimSpace( - errMigrateSingleLoadDefault), opts.OneType, err) + errMigrateSingleLoadDefault), opts.SourceType, err) } - one = stateOne.State() - two = stateTwo.State() + source = sourceState.State() + destination = destinationState.State() } var confirmFunc func(statemgr.Full, statemgr.Full, *backendMigrateOpts) (bool, error) switch { // No migration necessary - case one.Empty() && two.Empty(): + case source.Empty() && destination.Empty(): log.Print("[TRACE] backendMigrateState: both source and destination workspaces have empty state, so no migration is required") return nil // No migration necessary if we're inheriting state. - case one.Empty() && !two.Empty(): + case source.Empty() && !destination.Empty(): log.Print("[TRACE] backendMigrateState: source workspace has empty state, so no migration is required") return nil // We have existing state moving into no state. Ask the user if // they'd like to do this. - case !one.Empty() && two.Empty(): - log.Print("[TRACE] backendMigrateState: target workspace has empty state, so might copy source workspace state") + case !source.Empty() && destination.Empty(): + log.Print("[TRACE] backendMigrateState: destination workspace has empty state, so might copy source workspace state") confirmFunc = m.backendMigrateEmptyConfirm // Both states are non-empty, meaning we need to determine which // state should be used and update accordingly. - case !one.Empty() && !two.Empty(): + case !source.Empty() && !destination.Empty(): log.Print("[TRACE] backendMigrateState: both source and destination workspaces have states, so might overwrite destination with source") confirmFunc = m.backendMigrateNonEmptyConfirm } @@ -402,7 +402,7 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { } // Confirm with the user whether we want to copy state over - confirm, err := confirmFunc(stateOne, stateTwo, opts) + confirm, err := confirmFunc(sourceState, destinationState, opts) if err != nil { log.Print("[TRACE] backendMigrateState: error reading input, so aborting migration") return err @@ -417,36 +417,36 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { // includes preserving any lineage/serial information where possible, if // both managers support such metadata. log.Print("[TRACE] backendMigrateState: migration confirmed, so migrating") - if err := statemgr.Migrate(stateTwo, stateOne); err != nil { + if err := statemgr.Migrate(destinationState, sourceState); err != nil { return fmt.Errorf(strings.TrimSpace(errBackendStateCopy), - opts.OneType, opts.TwoType, err) + opts.SourceType, opts.DestinationType, err) } - if err := stateTwo.PersistState(); err != nil { + if err := destinationState.PersistState(); err != nil { return fmt.Errorf(strings.TrimSpace(errBackendStateCopy), - opts.OneType, opts.TwoType, err) + opts.SourceType, opts.DestinationType, err) } // And we're done. return nil } -func (m *Meta) backendMigrateEmptyConfirm(one, two statemgr.Full, opts *backendMigrateOpts) (bool, error) { +func (m *Meta) backendMigrateEmptyConfirm(source, destination statemgr.Full, opts *backendMigrateOpts) (bool, error) { inputOpts := &terraform.InputOpts{ Id: "backend-migrate-copy-to-empty", Query: "Do you want to copy existing state to the new backend?", Description: fmt.Sprintf( strings.TrimSpace(inputBackendMigrateEmpty), - opts.OneType, opts.TwoType), + opts.SourceType, opts.DestinationType), } return m.confirm(inputOpts) } func (m *Meta) backendMigrateNonEmptyConfirm( - stateOne, stateTwo statemgr.Full, opts *backendMigrateOpts) (bool, error) { + sourceState, destinationState statemgr.Full, opts *backendMigrateOpts) (bool, error) { // We need to grab both states so we can write them to a file - one := stateOne.State() - two := stateTwo.State() + source := sourceState.State() + destination := destinationState.State() // Save both to a temporary td, err := ioutil.TempDir("", "terraform") @@ -462,12 +462,12 @@ func (m *Meta) backendMigrateNonEmptyConfirm( } // Write the states - onePath := filepath.Join(td, fmt.Sprintf("1-%s.tfstate", opts.OneType)) - twoPath := filepath.Join(td, fmt.Sprintf("2-%s.tfstate", opts.TwoType)) - if err := saveHelper(opts.OneType, onePath, one); err != nil { + sourcePath := filepath.Join(td, fmt.Sprintf("1-%s.tfstate", opts.SourceType)) + destinationPath := filepath.Join(td, fmt.Sprintf("2-%s.tfstate", opts.DestinationType)) + if err := saveHelper(opts.SourceType, sourcePath, source); err != nil { return false, fmt.Errorf("Error saving temporary state: %s", err) } - if err := saveHelper(opts.TwoType, twoPath, two); err != nil { + if err := saveHelper(opts.DestinationType, destinationPath, destination); err != nil { return false, fmt.Errorf("Error saving temporary state: %s", err) } @@ -477,7 +477,7 @@ func (m *Meta) backendMigrateNonEmptyConfirm( Query: "Do you want to copy existing state to the new backend?", Description: fmt.Sprintf( strings.TrimSpace(inputBackendMigrateNonEmpty), - opts.OneType, opts.TwoType, onePath, twoPath), + opts.SourceType, opts.DestinationType, sourcePath, destinationPath), } // Confirm with the user that the copy should occur @@ -553,7 +553,7 @@ const inputBackendMigrateMultiToSingle = ` The existing %[1]q backend supports workspaces and you currently are using more than one. The newly configured %[2]q backend doesn't support workspaces. If you continue, Terraform will copy your current workspace %[3]q -to the default workspace in the target backend. Your existing workspaces in the +to the default workspace in the new backend. Your existing workspaces in the source backend won't be modified. If you want to switch workspaces, back them up, or cancel altogether, answer "no" and Terraform will abort. ` From b9f3dab03579a89225ed03c692f31902719948ae Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 1 Sep 2021 11:17:13 -0400 Subject: [PATCH 133/644] json-output: Release format version 1.0 --- internal/command/jsonplan/plan.go | 2 +- internal/command/jsonprovider/provider.go | 2 +- internal/command/jsonstate/state.go | 2 +- .../testdata/providers-schema/basic/output.json | 2 +- .../testdata/providers-schema/empty/output.json | 4 ++-- .../providers-schema/required/output.json | 2 +- .../testdata/show-json-sensitive/output.json | 4 ++-- .../testdata/show-json-state/basic/output.json | 2 +- .../testdata/show-json-state/empty/output.json | 4 ++-- .../show-json-state/modules/output.json | 2 +- .../sensitive-variables/output.json | 2 +- .../testdata/show-json/basic-create/output.json | 4 ++-- .../testdata/show-json/basic-delete/output.json | 4 ++-- .../testdata/show-json/basic-update/output.json | 4 ++-- .../testdata/show-json/drift/output.json | 4 ++-- .../show-json/module-depends-on/output.json | 2 +- .../testdata/show-json/modules/output.json | 4 ++-- .../testdata/show-json/moved-drift/output.json | 4 ++-- .../testdata/show-json/moved/output.json | 4 ++-- .../show-json/multi-resource-update/output.json | 4 ++-- .../show-json/nested-modules/output.json | 2 +- .../provider-version-no-config/output.json | 4 ++-- .../show-json/provider-version/output.json | 4 ++-- .../show-json/requires-replace/output.json | 4 ++-- .../show-json/sensitive-values/output.json | 4 ++-- .../incorrectmodulename/output.json | 2 +- .../validate-invalid/interpolation/output.json | 2 +- .../missing_defined_var/output.json | 2 +- .../validate-invalid/missing_quote/output.json | 2 +- .../validate-invalid/missing_var/output.json | 2 +- .../multiple_modules/output.json | 2 +- .../multiple_providers/output.json | 2 +- .../multiple_resources/output.json | 2 +- .../testdata/validate-invalid/output.json | 2 +- .../validate-invalid/outputs/output.json | 2 +- .../command/testdata/validate-valid/output.json | 2 +- internal/command/views/json_view.go | 2 +- internal/command/views/validate.go | 2 +- .../docs/cli/commands/providers/schema.html.md | 15 +++++++++++++-- website/docs/cli/commands/validate.html.md | 17 ++++++++++++----- website/docs/internals/json-format.html.md | 15 +++++++++++++-- .../docs/internals/machine-readable-ui.html.md | 13 ++++++++++++- 42 files changed, 103 insertions(+), 63 deletions(-) diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index c0b726422871..64d77c05a54e 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -22,7 +22,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "0.2" +const FormatVersion = "1.0" // Plan is the top-level representation of the json format of a plan. It includes // the complete config and current state. diff --git a/internal/command/jsonprovider/provider.go b/internal/command/jsonprovider/provider.go index b507bc242e9e..4487db4987ae 100644 --- a/internal/command/jsonprovider/provider.go +++ b/internal/command/jsonprovider/provider.go @@ -9,7 +9,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "0.2" +const FormatVersion = "1.0" // providers is the top-level object returned when exporting provider schemas type providers struct { diff --git a/internal/command/jsonstate/state.go b/internal/command/jsonstate/state.go index 341040d2d1c9..46532875c334 100644 --- a/internal/command/jsonstate/state.go +++ b/internal/command/jsonstate/state.go @@ -18,7 +18,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "0.2" +const FormatVersion = "1.0" // state is the top-level representation of the json format of a terraform // state. diff --git a/internal/command/testdata/providers-schema/basic/output.json b/internal/command/testdata/providers-schema/basic/output.json index f14786c3e31e..dfac55b38c35 100644 --- a/internal/command/testdata/providers-schema/basic/output.json +++ b/internal/command/testdata/providers-schema/basic/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "provider_schemas": { "registry.terraform.io/hashicorp/test": { "provider": { diff --git a/internal/command/testdata/providers-schema/empty/output.json b/internal/command/testdata/providers-schema/empty/output.json index 12d30d201356..381450cade5c 100644 --- a/internal/command/testdata/providers-schema/empty/output.json +++ b/internal/command/testdata/providers-schema/empty/output.json @@ -1,3 +1,3 @@ { - "format_version": "0.2" -} \ No newline at end of file + "format_version": "1.0" +} diff --git a/internal/command/testdata/providers-schema/required/output.json b/internal/command/testdata/providers-schema/required/output.json index f14786c3e31e..dfac55b38c35 100644 --- a/internal/command/testdata/providers-schema/required/output.json +++ b/internal/command/testdata/providers-schema/required/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "provider_schemas": { "registry.terraform.io/hashicorp/test": { "provider": { diff --git a/internal/command/testdata/show-json-sensitive/output.json b/internal/command/testdata/show-json-sensitive/output.json index 5f22c4ccf3a2..206fbb7f6e60 100644 --- a/internal/command/testdata/show-json-sensitive/output.json +++ b/internal/command/testdata/show-json-sensitive/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -66,7 +66,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json-state/basic/output.json b/internal/command/testdata/show-json-state/basic/output.json index 3087ad118050..229fa00e7262 100644 --- a/internal/command/testdata/show-json-state/basic/output.json +++ b/internal/command/testdata/show-json-state/basic/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.12.0", "values": { "root_module": { diff --git a/internal/command/testdata/show-json-state/empty/output.json b/internal/command/testdata/show-json-state/empty/output.json index 12d30d201356..381450cade5c 100644 --- a/internal/command/testdata/show-json-state/empty/output.json +++ b/internal/command/testdata/show-json-state/empty/output.json @@ -1,3 +1,3 @@ { - "format_version": "0.2" -} \ No newline at end of file + "format_version": "1.0" +} diff --git a/internal/command/testdata/show-json-state/modules/output.json b/internal/command/testdata/show-json-state/modules/output.json index eeee8f6cffbc..eba163bdbb52 100644 --- a/internal/command/testdata/show-json-state/modules/output.json +++ b/internal/command/testdata/show-json-state/modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.12.0", "values": { "outputs": { diff --git a/internal/command/testdata/show-json-state/sensitive-variables/output.json b/internal/command/testdata/show-json-state/sensitive-variables/output.json index b133aeef13bf..60503cd3ad80 100644 --- a/internal/command/testdata/show-json-state/sensitive-variables/output.json +++ b/internal/command/testdata/show-json-state/sensitive-variables/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.14.0", "values": { "root_module": { diff --git a/internal/command/testdata/show-json/basic-create/output.json b/internal/command/testdata/show-json/basic-create/output.json index 3474443ed386..d1b8aae5361b 100644 --- a/internal/command/testdata/show-json/basic-create/output.json +++ b/internal/command/testdata/show-json/basic-create/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-delete/output.json b/internal/command/testdata/show-json/basic-delete/output.json index ae6e67f760b3..e1779c04cc2a 100644 --- a/internal/command/testdata/show-json/basic-delete/output.json +++ b/internal/command/testdata/show-json/basic-delete/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -89,7 +89,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-update/output.json b/internal/command/testdata/show-json/basic-update/output.json index 2b8bc25e3034..e4b4731426a1 100644 --- a/internal/command/testdata/show-json/basic-update/output.json +++ b/internal/command/testdata/show-json/basic-update/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -68,7 +68,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/drift/output.json b/internal/command/testdata/show-json/drift/output.json index 79e702161576..2d5c071b4300 100644 --- a/internal/command/testdata/show-json/drift/output.json +++ b/internal/command/testdata/show-json/drift/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "resources": [ @@ -106,7 +106,7 @@ } ], "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/module-depends-on/output.json b/internal/command/testdata/show-json/module-depends-on/output.json index cc7ed679f0cc..d02efaa22f0d 100644 --- a/internal/command/testdata/show-json/module-depends-on/output.json +++ b/internal/command/testdata/show-json/module-depends-on/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.13.1-dev", "planned_values": { "root_module": { diff --git a/internal/command/testdata/show-json/modules/output.json b/internal/command/testdata/show-json/modules/output.json index 440bebbff891..4ed0ea45d692 100644 --- a/internal/command/testdata/show-json/modules/output.json +++ b/internal/command/testdata/show-json/modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "outputs": { "test": { @@ -74,7 +74,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/moved-drift/output.json b/internal/command/testdata/show-json/moved-drift/output.json index 0d151808fa87..ad6b0564135e 100644 --- a/internal/command/testdata/show-json/moved-drift/output.json +++ b/internal/command/testdata/show-json/moved-drift/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "resources": [ @@ -108,7 +108,7 @@ } ], "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/moved/output.json b/internal/command/testdata/show-json/moved/output.json index 3ce28198342e..3e74a4ddb4e4 100644 --- a/internal/command/testdata/show-json/moved/output.json +++ b/internal/command/testdata/show-json/moved/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "resources": [ @@ -46,7 +46,7 @@ } ], "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index 262b6194b9bf..6da29965e29c 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.13.0", "variables": { "test_var": { @@ -107,7 +107,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "terraform_version": "0.13.0", "values": { "outputs": { diff --git a/internal/command/testdata/show-json/nested-modules/output.json b/internal/command/testdata/show-json/nested-modules/output.json index 80e7ae3588e9..359ea9ae181c 100644 --- a/internal/command/testdata/show-json/nested-modules/output.json +++ b/internal/command/testdata/show-json/nested-modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "child_modules": [ diff --git a/internal/command/testdata/show-json/provider-version-no-config/output.json b/internal/command/testdata/show-json/provider-version-no-config/output.json index 64b93ec751c0..6a8b1f451dc0 100644 --- a/internal/command/testdata/show-json/provider-version-no-config/output.json +++ b/internal/command/testdata/show-json/provider-version-no-config/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/provider-version/output.json b/internal/command/testdata/show-json/provider-version/output.json index b5369806e933..11fd3bd64c15 100644 --- a/internal/command/testdata/show-json/provider-version/output.json +++ b/internal/command/testdata/show-json/provider-version/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "bar" @@ -57,7 +57,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/requires-replace/output.json b/internal/command/testdata/show-json/requires-replace/output.json index 077d900b13b0..e71df784f4f7 100644 --- a/internal/command/testdata/show-json/requires-replace/output.json +++ b/internal/command/testdata/show-json/requires-replace/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "planned_values": { "root_module": { "resources": [ @@ -48,7 +48,7 @@ } ], "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "root_module": { "resources": [ diff --git a/internal/command/testdata/show-json/sensitive-values/output.json b/internal/command/testdata/show-json/sensitive-values/output.json index 7cbc9ccf0e75..d7e4719c71f5 100644 --- a/internal/command/testdata/show-json/sensitive-values/output.json +++ b/internal/command/testdata/show-json/sensitive-values/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.2", + "format_version": "1.0", "variables": { "test_var": { "value": "boop" @@ -69,7 +69,7 @@ } }, "prior_state": { - "format_version": "0.2", + "format_version": "1.0", "values": { "outputs": { "test": { diff --git a/internal/command/testdata/validate-invalid/incorrectmodulename/output.json b/internal/command/testdata/validate-invalid/incorrectmodulename/output.json index 0c2ce68abd37..f144313fa455 100644 --- a/internal/command/testdata/validate-invalid/incorrectmodulename/output.json +++ b/internal/command/testdata/validate-invalid/incorrectmodulename/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 4, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/interpolation/output.json b/internal/command/testdata/validate-invalid/interpolation/output.json index 7845ec0f4e81..2843b19121fc 100644 --- a/internal/command/testdata/validate-invalid/interpolation/output.json +++ b/internal/command/testdata/validate-invalid/interpolation/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 2, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_defined_var/output.json b/internal/command/testdata/validate-invalid/missing_defined_var/output.json index c2a57c5e6a98..40258a98cd27 100644 --- a/internal/command/testdata/validate-invalid/missing_defined_var/output.json +++ b/internal/command/testdata/validate-invalid/missing_defined_var/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": true, "error_count": 0, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_quote/output.json b/internal/command/testdata/validate-invalid/missing_quote/output.json index cdf99d8b2a2b..87aeca8b7817 100644 --- a/internal/command/testdata/validate-invalid/missing_quote/output.json +++ b/internal/command/testdata/validate-invalid/missing_quote/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/missing_var/output.json b/internal/command/testdata/validate-invalid/missing_var/output.json index 2a4e0be71ebd..6f0b9d5d4c8d 100644 --- a/internal/command/testdata/validate-invalid/missing_var/output.json +++ b/internal/command/testdata/validate-invalid/missing_var/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_modules/output.json b/internal/command/testdata/validate-invalid/multiple_modules/output.json index 4cd6dfb9f0ad..1aeaf929a913 100644 --- a/internal/command/testdata/validate-invalid/multiple_modules/output.json +++ b/internal/command/testdata/validate-invalid/multiple_modules/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_providers/output.json b/internal/command/testdata/validate-invalid/multiple_providers/output.json index 63eb2d193820..309cf0ea7c34 100644 --- a/internal/command/testdata/validate-invalid/multiple_providers/output.json +++ b/internal/command/testdata/validate-invalid/multiple_providers/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/multiple_resources/output.json b/internal/command/testdata/validate-invalid/multiple_resources/output.json index 33d5052284e9..ded584e6846c 100644 --- a/internal/command/testdata/validate-invalid/multiple_resources/output.json +++ b/internal/command/testdata/validate-invalid/multiple_resources/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/output.json b/internal/command/testdata/validate-invalid/output.json index 663fe0153071..73254853932f 100644 --- a/internal/command/testdata/validate-invalid/output.json +++ b/internal/command/testdata/validate-invalid/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 1, "warning_count": 0, diff --git a/internal/command/testdata/validate-invalid/outputs/output.json b/internal/command/testdata/validate-invalid/outputs/output.json index d05ed4b77173..f774b458be4c 100644 --- a/internal/command/testdata/validate-invalid/outputs/output.json +++ b/internal/command/testdata/validate-invalid/outputs/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": false, "error_count": 2, "warning_count": 0, diff --git a/internal/command/testdata/validate-valid/output.json b/internal/command/testdata/validate-valid/output.json index c2a57c5e6a98..40258a98cd27 100644 --- a/internal/command/testdata/validate-valid/output.json +++ b/internal/command/testdata/validate-valid/output.json @@ -1,5 +1,5 @@ { - "format_version": "0.1", + "format_version": "1.0", "valid": true, "error_count": 0, "warning_count": 0, diff --git a/internal/command/views/json_view.go b/internal/command/views/json_view.go index e1c3db6d74e4..f92036d5c0d7 100644 --- a/internal/command/views/json_view.go +++ b/internal/command/views/json_view.go @@ -13,7 +13,7 @@ import ( // This version describes the schema of JSON UI messages. This version must be // updated after making any changes to this view, the jsonHook, or any of the // command/views/json package. -const JSON_UI_VERSION = "0.1.0" +const JSON_UI_VERSION = "1.0" func NewJSONView(view *View) *JSONView { log := hclog.New(&hclog.LoggerOptions{ diff --git a/internal/command/views/validate.go b/internal/command/views/validate.go index 1e597277a478..08ce913f82ce 100644 --- a/internal/command/views/validate.go +++ b/internal/command/views/validate.go @@ -81,7 +81,7 @@ func (v *ValidateJSON) Results(diags tfdiags.Diagnostics) int { // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. - const FormatVersion = "0.1" + const FormatVersion = "1.0" type Output struct { FormatVersion string `json:"format_version"` diff --git a/website/docs/cli/commands/providers/schema.html.md b/website/docs/cli/commands/providers/schema.html.md index e97e50f2305e..2a3dddc1338e 100644 --- a/website/docs/cli/commands/providers/schema.html.md +++ b/website/docs/cli/commands/providers/schema.html.md @@ -23,7 +23,18 @@ The list of available flags are: Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. --> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. +The output includes a `format_version` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). ## Format Summary @@ -41,7 +52,7 @@ The JSON output format consists of the following objects and sub-objects: ```javascript { - "format_version": "0.1", + "format_version": "1.0", // "provider_schemas" describes the provider schemas for all // providers throughout the configuration tree. diff --git a/website/docs/cli/commands/validate.html.md b/website/docs/cli/commands/validate.html.md index 583186e3d069..e81da01b27a4 100644 --- a/website/docs/cli/commands/validate.html.md +++ b/website/docs/cli/commands/validate.html.md @@ -57,11 +57,18 @@ to the JSON output setting. For that reason, external software consuming Terraform's output should be prepared to find data on stdout that _isn't_ valid JSON, which it should then treat as a generic error case. -**Note:** The output includes a `format_version` key, which currently has major -version zero to indicate that the format is experimental and subject to change. -A future version will assign a non-zero major version and make stronger -promises about compatibility. We do not anticipate any significant breaking -changes to the format before its first major version, however. +The output includes a `format_version` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). In the normal case, Terraform will print a JSON object to the standard output stream. The top-level JSON object will have the following properties: diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index aa4df209af18..cd4e2213a481 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -16,7 +16,18 @@ Since the format of plan files isn't suited for use with external tools (and lik Use `terraform show -json ` to generate a JSON representation of a plan or state file. See [the `terraform show` documentation](/docs/cli/commands/show.html) for more details. --> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. +The output includes a `format_version` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). ## Format Summary @@ -60,7 +71,7 @@ For ease of consumption by callers, the plan representation includes a partial r ```javascript { - "format_version": "0.2", + "format_version": "1.0", // "prior_state" is a representation of the state that the configuration is // being applied to, using the state representation described above. diff --git a/website/docs/internals/machine-readable-ui.html.md b/website/docs/internals/machine-readable-ui.html.md index 94427cc6d38e..35f06049b85f 100644 --- a/website/docs/internals/machine-readable-ui.html.md +++ b/website/docs/internals/machine-readable-ui.html.md @@ -14,7 +14,18 @@ By default, many Terraform commands display UI output as unstructured text, inte For long-running commands such as `plan`, `apply`, and `refresh`, the `-json` flag outputs a stream of JSON UI messages, one per line. These can be processed one message at a time, with integrating software filtering, combining, or modifying the output as desired. --> **Note:** The first message output has type `version`, and includes a `ui` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. +The first message output has type `version`, and includes a `ui` key, which as of Terraform 1.1.0 has +value `"1.0"`. The semantics of this version are: + +- We will increment the minor version, e.g. `"1.1"`, for backward-compatible + changes or additions. Ignore any object properties with unrecognized names to + remain forward-compatible with future minor versions. +- We will increment the major version, e.g. `"2.0"`, for changes that are not + backward-compatible. Reject any input which reports an unsupported major + version. + +We will introduce new major versions only within the bounds of +[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). ## Sample JSON Output From db1a97f9af1a8a67f3b9ebc296bb202cc538b011 Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 6 Oct 2021 16:36:49 +0000 Subject: [PATCH 134/644] Release v1.1.0-alpha20211006 --- version/version.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version/version.go b/version/version.go index 86f22153dde3..7cd6b8f0bab1 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "dev" +var Prerelease = "alpha20211006" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From d05fa3049ed5f52914848394fefc956e8eb0b9fd Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 6 Oct 2021 16:52:28 +0000 Subject: [PATCH 135/644] Cleanup after v1.1.0-alpha20211006 release --- version/version.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version/version.go b/version/version.go index 7cd6b8f0bab1..86f22153dde3 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "alpha20211006" +var Prerelease = "dev" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From ad9944e523f404cb9d54be8f69697e4512057abb Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 7 Oct 2021 16:48:56 -0400 Subject: [PATCH 136/644] test that providers are configured for calls Have the MockProvider ensure that Configure is always called before any methods that may require a configured provider. Ensure the MockProvider *Called fields are zeroed out when re-using the provider instance. --- internal/terraform/provider_mock.go | 25 +++++++++++++++++++++++++ internal/terraform/terraform_test.go | 17 +++++++++++++++++ 2 files changed, 42 insertions(+) diff --git a/internal/terraform/provider_mock.go b/internal/terraform/provider_mock.go index 47227759b21d..b6988f6eb644 100644 --- a/internal/terraform/provider_mock.go +++ b/internal/terraform/provider_mock.go @@ -297,6 +297,11 @@ func (p *MockProvider) ReadResource(r providers.ReadResourceRequest) (resp provi p.ReadResourceCalled = true p.ReadResourceRequest = r + if !p.ConfigureProviderCalled { + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("Configure not called before ReadResource %q", r.TypeName)) + return resp + } + if p.ReadResourceFn != nil { return p.ReadResourceFn(r) } @@ -330,6 +335,11 @@ func (p *MockProvider) PlanResourceChange(r providers.PlanResourceChangeRequest) p.Lock() defer p.Unlock() + if !p.ConfigureProviderCalled { + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("Configure not called before PlanResourceChange %q", r.TypeName)) + return resp + } + p.PlanResourceChangeCalled = true p.PlanResourceChangeRequest = r @@ -400,6 +410,11 @@ func (p *MockProvider) ApplyResourceChange(r providers.ApplyResourceChangeReques p.ApplyResourceChangeRequest = r p.Unlock() + if !p.ConfigureProviderCalled { + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("Configure not called before ApplyResourceChange %q", r.TypeName)) + return resp + } + if p.ApplyResourceChangeFn != nil { return p.ApplyResourceChangeFn(r) } @@ -460,6 +475,11 @@ func (p *MockProvider) ImportResourceState(r providers.ImportResourceStateReques p.Lock() defer p.Unlock() + if !p.ConfigureProviderCalled { + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("Configure not called before ImportResourceState %q", r.TypeName)) + return resp + } + p.ImportResourceStateCalled = true p.ImportResourceStateRequest = r if p.ImportResourceStateFn != nil { @@ -494,6 +514,11 @@ func (p *MockProvider) ReadDataSource(r providers.ReadDataSourceRequest) (resp p p.Lock() defer p.Unlock() + if !p.ConfigureProviderCalled { + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("Configure not called before ReadDataSource %q", r.TypeName)) + return resp + } + p.ReadDataSourceCalled = true p.ReadDataSourceRequest = r diff --git a/internal/terraform/terraform_test.go b/internal/terraform/terraform_test.go index 95ab317632a3..7eccb51c2b5f 100644 --- a/internal/terraform/terraform_test.go +++ b/internal/terraform/terraform_test.go @@ -166,6 +166,23 @@ func testSetResourceInstanceTainted(module *states.Module, resource, attrsJson, func testProviderFuncFixed(rp providers.Interface) providers.Factory { return func() (providers.Interface, error) { + if p, ok := rp.(*MockProvider); ok { + // make sure none of the methods were "called" on this new instance + p.GetProviderSchemaCalled = false + p.ValidateProviderConfigCalled = false + p.ValidateResourceConfigCalled = false + p.ValidateDataResourceConfigCalled = false + p.UpgradeResourceStateCalled = false + p.ConfigureProviderCalled = false + p.StopCalled = false + p.ReadResourceCalled = false + p.PlanResourceChangeCalled = false + p.ApplyResourceChangeCalled = false + p.ImportResourceStateCalled = false + p.ReadDataSourceCalled = false + p.CloseCalled = false + } + return rp, nil } } From 22b400b8dea4d44329699efe6fbb8e54b767ffd1 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 7 Oct 2021 16:51:24 -0400 Subject: [PATCH 137/644] skip refreshing deposed during destroy plan The destroy plan should not require a configured provider (the complete configuration is not evaluated, so they cannot be configured). Deposed instances were being refreshed during the destroy plan, because this instance type is only ever destroyed and shares the same implementation between plan and walkPlanDestroy. Skip refreshing during walkPlanDestroy. --- internal/terraform/context_apply2_test.go | 47 +++++++++++++++++++ .../node_resource_destroy_deposed.go | 7 ++- 2 files changed, 53 insertions(+), 1 deletion(-) diff --git a/internal/terraform/context_apply2_test.go b/internal/terraform/context_apply2_test.go index 82a48e2d7e56..c405f30aaff2 100644 --- a/internal/terraform/context_apply2_test.go +++ b/internal/terraform/context_apply2_test.go @@ -549,3 +549,50 @@ resource "test_object" "y" { } } } + +func TestContext2Apply_destroyWithDeposed(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` +resource "test_object" "x" { + test_string = "ok" + lifecycle { + create_before_destroy = true + } +}`, + }) + + p := simpleMockProvider() + + deposedKey := states.NewDeposedKey() + + state := states.NewState() + root := state.EnsureModule(addrs.RootModuleInstance) + root.SetResourceInstanceDeposed( + mustResourceInstanceAddr("test_object.x").Resource, + deposedKey, + &states.ResourceInstanceObjectSrc{ + Status: states.ObjectTainted, + AttrsJSON: []byte(`{"test_string":"deposed"}`), + }, + mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`), + ) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.DestroyMode, + }) + if diags.HasErrors() { + t.Fatalf("plan: %s", diags.Err()) + } + + _, diags = ctx.Apply(plan, m) + if diags.HasErrors() { + t.Fatalf("apply: %s", diags.Err()) + } + +} diff --git a/internal/terraform/node_resource_destroy_deposed.go b/internal/terraform/node_resource_destroy_deposed.go index ceb8739d5954..7d639d135c66 100644 --- a/internal/terraform/node_resource_destroy_deposed.go +++ b/internal/terraform/node_resource_destroy_deposed.go @@ -95,7 +95,12 @@ func (n *NodePlanDeposedResourceInstanceObject) Execute(ctx EvalContext, op walk return diags } - if !n.skipRefresh { + // We don't refresh during the planDestroy walk, since that is only adding + // the destroy changes to the plan and the provider will not be configured + // at this point. The other nodes use separate types for plan and destroy, + // while deposed instances are always a destroy operation, so the logic + // here is a bit overloaded. + if !n.skipRefresh && op != walkPlanDestroy { // Refresh this object even though it is going to be destroyed, in // case it's already been deleted outside of Terraform. If this is a // normal plan, providers expect a Read request to remove missing From 348c761bea08f1c9b94de23452560a58b1462cfc Mon Sep 17 00:00:00 2001 From: Megan Bang Date: Thu, 7 Oct 2021 16:28:47 -0500 Subject: [PATCH 138/644] add better error if credentials are invalid --- internal/backend/remote-state/gcs/backend.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/internal/backend/remote-state/gcs/backend.go b/internal/backend/remote-state/gcs/backend.go index af2a667eb184..44060049189e 100644 --- a/internal/backend/remote-state/gcs/backend.go +++ b/internal/backend/remote-state/gcs/backend.go @@ -141,6 +141,10 @@ func (b *Backend) configure(ctx context.Context) error { return fmt.Errorf("Error loading credentials: %s", err) } + if !strings.HasPrefix(contents, "{") { + return fmt.Errorf("contents of credentials are invalid") + } + credOptions = append(credOptions, option.WithCredentialsJSON([]byte(contents))) } From 81201d69a34973f108e3e624c3023cab27d52508 Mon Sep 17 00:00:00 2001 From: Megan Bang Date: Thu, 7 Oct 2021 16:33:21 -0500 Subject: [PATCH 139/644] check valid json --- internal/backend/remote-state/gcs/backend.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/internal/backend/remote-state/gcs/backend.go b/internal/backend/remote-state/gcs/backend.go index 44060049189e..bb13137cfb6e 100644 --- a/internal/backend/remote-state/gcs/backend.go +++ b/internal/backend/remote-state/gcs/backend.go @@ -4,6 +4,7 @@ package gcs import ( "context" "encoding/base64" + "encoding/json" "fmt" "os" "strings" @@ -141,7 +142,7 @@ func (b *Backend) configure(ctx context.Context) error { return fmt.Errorf("Error loading credentials: %s", err) } - if !strings.HasPrefix(contents, "{") { + if !json.Valid([]byte(contents)) { return fmt.Errorf("contents of credentials are invalid") } From 03f71c2f062233957c7d9b1543c5b75094f2d030 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 8 Oct 2021 08:41:58 -0400 Subject: [PATCH 140/644] fixup tests for MockProvider changes Resetting the *Called fields and enforcing configuration broke a few tests. --- internal/terraform/context_plan2_test.go | 15 ++++++++++++--- .../node_resource_destroy_deposed_test.go | 2 ++ .../terraform/node_resource_plan_orphan_test.go | 2 ++ internal/terraform/transform_import_state_test.go | 2 ++ 4 files changed, 18 insertions(+), 3 deletions(-) diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index b1034d7fb62e..9552a3ca7206 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -3,6 +3,7 @@ package terraform import ( "bytes" "errors" + "fmt" "strings" "testing" @@ -419,7 +420,12 @@ resource "test_object" "a" { }, }, } + + // This is called from the first instance of this provider, so we can't + // check p.ReadResourceCalled after plan. + readResourceCalled := false p.ReadResourceFn = func(req providers.ReadResourceRequest) (resp providers.ReadResourceResponse) { + readResourceCalled = true newVal, err := cty.Transform(req.PriorState, func(path cty.Path, v cty.Value) (cty.Value, error) { if len(path) == 1 && path[0] == (cty.GetAttrStep{Name: "arg"}) { return cty.StringVal("current"), nil @@ -435,7 +441,10 @@ resource "test_object" "a" { NewState: newVal, } } + + upgradeResourceStateCalled := false p.UpgradeResourceStateFn = func(req providers.UpgradeResourceStateRequest) (resp providers.UpgradeResourceStateResponse) { + upgradeResourceStateCalled = true t.Logf("UpgradeResourceState %s", req.RawStateJSON) // In the destroy-with-refresh codepath we end up calling @@ -479,10 +488,10 @@ resource "test_object" "a" { }) assertNoErrors(t, diags) - if !p.UpgradeResourceStateCalled { + if !upgradeResourceStateCalled { t.Errorf("Provider's UpgradeResourceState wasn't called; should've been") } - if !p.ReadResourceCalled { + if !readResourceCalled { t.Errorf("Provider's ReadResource wasn't called; should've been") } @@ -682,7 +691,7 @@ func TestContext2Plan_destroyNoProviderConfig(t *testing.T) { p.ValidateProviderConfigFn = func(req providers.ValidateProviderConfigRequest) (resp providers.ValidateProviderConfigResponse) { v := req.Config.GetAttr("test_string") if v.IsNull() || !v.IsKnown() || v.AsString() != "ok" { - resp.Diagnostics = resp.Diagnostics.Append(errors.New("invalid provider configuration")) + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("invalid provider configuration: %#v", req.Config)) } return resp } diff --git a/internal/terraform/node_resource_destroy_deposed_test.go b/internal/terraform/node_resource_destroy_deposed_test.go index 2a2fe9981b29..f173002a28df 100644 --- a/internal/terraform/node_resource_destroy_deposed_test.go +++ b/internal/terraform/node_resource_destroy_deposed_test.go @@ -26,6 +26,7 @@ func TestNodePlanDeposedResourceInstanceObject_Execute(t *testing.T) { ) p := testProvider("test") + p.ConfigureProvider(providers.ConfigureProviderRequest{}) p.UpgradeResourceStateResponse = &providers.UpgradeResourceStateResponse{ UpgradedState: cty.ObjectVal(map[string]cty.Value{ "id": cty.StringVal("bar"), @@ -106,6 +107,7 @@ func TestNodeDestroyDeposedResourceInstanceObject_Execute(t *testing.T) { } p := testProvider("test") + p.ConfigureProvider(providers.ConfigureProviderRequest{}) p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(schema) p.UpgradeResourceStateResponse = &providers.UpgradeResourceStateResponse{ diff --git a/internal/terraform/node_resource_plan_orphan_test.go b/internal/terraform/node_resource_plan_orphan_test.go index 3758fe399440..f46c7a7091c1 100644 --- a/internal/terraform/node_resource_plan_orphan_test.go +++ b/internal/terraform/node_resource_plan_orphan_test.go @@ -33,6 +33,7 @@ func TestNodeResourcePlanOrphanExecute(t *testing.T) { ) p := simpleMockProvider() + p.ConfigureProvider(providers.ConfigureProviderRequest{}) ctx := &MockEvalContext{ StateState: state.SyncWrapper(), RefreshStateState: state.DeepCopy().SyncWrapper(), @@ -93,6 +94,7 @@ func TestNodeResourcePlanOrphanExecute_alreadyDeleted(t *testing.T) { changes := plans.NewChanges() p := simpleMockProvider() + p.ConfigureProvider(providers.ConfigureProviderRequest{}) p.ReadResourceResponse = &providers.ReadResourceResponse{ NewState: cty.NullVal(p.GetProviderSchemaResponse.ResourceTypes["test_string"].Block.ImpliedType()), } diff --git a/internal/terraform/transform_import_state_test.go b/internal/terraform/transform_import_state_test.go index 6e3245bd7be2..919f09d84b8a 100644 --- a/internal/terraform/transform_import_state_test.go +++ b/internal/terraform/transform_import_state_test.go @@ -24,6 +24,7 @@ func TestGraphNodeImportStateExecute(t *testing.T) { }, }, } + provider.ConfigureProvider(providers.ConfigureProviderRequest{}) ctx := &MockEvalContext{ StateState: state.SyncWrapper(), @@ -64,6 +65,7 @@ func TestGraphNodeImportStateExecute(t *testing.T) { func TestGraphNodeImportStateSubExecute(t *testing.T) { state := states.NewState() provider := testProvider("aws") + provider.ConfigureProvider(providers.ConfigureProviderRequest{}) ctx := &MockEvalContext{ StateState: state.SyncWrapper(), ProviderProvider: provider, From 7dda3366a672507d8fcd480a22990271d6ee26ab Mon Sep 17 00:00:00 2001 From: megan07 Date: Fri, 8 Oct 2021 10:02:05 -0500 Subject: [PATCH 141/644] Update internal/backend/remote-state/gcs/backend.go Co-authored-by: appilon --- internal/backend/remote-state/gcs/backend.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/backend/remote-state/gcs/backend.go b/internal/backend/remote-state/gcs/backend.go index bb13137cfb6e..1f157779967e 100644 --- a/internal/backend/remote-state/gcs/backend.go +++ b/internal/backend/remote-state/gcs/backend.go @@ -143,7 +143,7 @@ func (b *Backend) configure(ctx context.Context) error { } if !json.Valid([]byte(contents)) { - return fmt.Errorf("contents of credentials are invalid") + return fmt.Errorf("contents of credentials are invalid json") } credOptions = append(credOptions, option.WithCredentialsJSON([]byte(contents))) From a036109bc19b67f8b0ccb3e18e386a8c1f94496a Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 8 Oct 2021 15:23:13 -0400 Subject: [PATCH 142/644] add comment about when we call ConfigureProvider --- internal/terraform/node_provider.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/internal/terraform/node_provider.go b/internal/terraform/node_provider.go index 33cad198abf8..2e611d5660e4 100644 --- a/internal/terraform/node_provider.go +++ b/internal/terraform/node_provider.go @@ -38,6 +38,9 @@ func (n *NodeApplyableProvider) Execute(ctx EvalContext, op walkOperation) (diag log.Printf("[TRACE] NodeApplyableProvider: validating configuration for %s", n.Addr) return diags.Append(n.ValidateProvider(ctx, provider)) case walkPlan, walkApply, walkDestroy: + // walkPlanDestroy is purposely skipped here, since the config is not + // evaluated, and the provider is not needed to create delete actions + // for all instances. log.Printf("[TRACE] NodeApplyableProvider: configuring %s", n.Addr) return diags.Append(n.ConfigureProvider(ctx, provider, false)) case walkImport: From 05954a328df269e0e31de86e078f06d97c4f8458 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 8 Oct 2021 15:53:08 -0400 Subject: [PATCH 143/644] udpate CI go version Since we have to specify the minor release for `.go-version`, make sure the CI version doesn't automatically udpate. --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index b9132f634ac8..e462189b31b7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -10,7 +10,7 @@ references: executors: go: docker: - - image: docker.mirror.hashicorp.services/cimg/go:1.17 + - image: docker.mirror.hashicorp.services/cimg/go:1.17.2 environment: CONSUL_VERSION: 1.7.2 GOMAXPROCS: 4 From 4c2dbec5b179a258da253f308723cc43c00ead7e Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 8 Oct 2021 15:54:02 -0400 Subject: [PATCH 144/644] update to go1.17.2 --- .go-version | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.go-version b/.go-version index 511a76e6faf8..06fb41b6322f 100644 --- a/.go-version +++ b/.go-version @@ -1 +1 @@ -1.17.1 +1.17.2 From 94ed6a0c846a9041ebb83d18c3a6d7005ca2252e Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 8 Oct 2021 15:54:13 -0400 Subject: [PATCH 145/644] update the go.mod format for go1.17.2 --- go.mod | 165 +++++++++++++++++++++++++++++---------------------------- 1 file changed, 84 insertions(+), 81 deletions(-) diff --git a/go.mod b/go.mod index bc3fae7b74e8..756e51bef18d 100644 --- a/go.mod +++ b/go.mod @@ -1,70 +1,33 @@ module github.com/hashicorp/terraform require ( - cloud.google.com/go v0.79.0 // indirect cloud.google.com/go/storage v1.10.0 github.com/Azure/azure-sdk-for-go v52.5.0+incompatible - github.com/Azure/go-autorest v14.2.0+incompatible // indirect github.com/Azure/go-autorest/autorest v0.11.18 - github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect - github.com/Azure/go-autorest/autorest/azure/cli v0.4.2 // indirect - github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect - github.com/Azure/go-autorest/autorest/to v0.4.0 // indirect - github.com/Azure/go-autorest/autorest/validation v0.3.1 // indirect - github.com/Azure/go-autorest/logger v0.2.1 // indirect - github.com/Azure/go-autorest/tracing v0.6.0 // indirect - github.com/Azure/go-ntlmssp v0.0.0-20200615164410-66371956d46c // indirect - github.com/BurntSushi/toml v0.3.1 // indirect - github.com/ChrisTrenkamp/goxpath v0.0.0-20190607011252-c5096ec8773d // indirect - github.com/Masterminds/goutils v1.1.0 // indirect - github.com/Masterminds/semver v1.5.0 // indirect - github.com/Masterminds/sprig v2.22.0+incompatible // indirect - github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af // indirect github.com/agext/levenshtein v1.2.2 github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70 github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible - github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e // indirect - github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0 // indirect github.com/apparentlymart/go-cidr v1.1.0 github.com/apparentlymart/go-dump v0.0.0-20190214190832-042adf3cf4a0 github.com/apparentlymart/go-shquot v0.0.1 - github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect github.com/apparentlymart/go-userdirs v0.0.0-20200915174352-b0c018a67c13 github.com/apparentlymart/go-versions v1.0.1 github.com/armon/circbuf v0.0.0-20190214190532-5111143e8da2 - github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da // indirect - github.com/armon/go-radix v1.0.0 // indirect github.com/aws/aws-sdk-go v1.40.25 - github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f // indirect - github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect github.com/bgentry/speakeasy v0.1.0 github.com/bmatcuk/doublestar v1.1.5 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e - github.com/coreos/go-semver v0.2.0 // indirect - github.com/coreos/go-systemd v0.0.0-20181012123002-c6f51f82210d // indirect github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f github.com/davecgh/go-spew v1.1.1 - github.com/dimchansky/utfbom v1.1.1 // indirect - github.com/dylanmei/iso8601 v0.1.0 // indirect github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 - github.com/fatih/color v1.9.0 // indirect - github.com/form3tech-oss/jwt-go v3.2.2+incompatible // indirect github.com/go-test/deep v1.0.3 - github.com/gofrs/uuid v3.3.0+incompatible // indirect - github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d // indirect - github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect github.com/golang/mock v1.5.0 github.com/golang/protobuf v1.4.3 github.com/google/go-cmp v0.5.5 - github.com/google/go-querystring v1.1.0 // indirect - github.com/google/gofuzz v1.0.0 // indirect github.com/google/uuid v1.2.0 - github.com/googleapis/gax-go/v2 v2.0.5 // indirect - github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d // indirect github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 github.com/gophercloud/utils v0.0.0-20200423144003-7c72efc7435d - github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 // indirect github.com/hashicorp/aws-sdk-go-base v0.7.1 github.com/hashicorp/consul/api v1.9.1 github.com/hashicorp/consul/sdk v0.8.0 @@ -74,40 +37,23 @@ require ( github.com/hashicorp/go-cleanhttp v0.5.2 github.com/hashicorp/go-getter v1.5.2 github.com/hashicorp/go-hclog v0.15.0 - github.com/hashicorp/go-immutable-radix v1.0.0 // indirect - github.com/hashicorp/go-msgpack v0.5.4 // indirect github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.1 github.com/hashicorp/go-retryablehttp v0.5.2 - github.com/hashicorp/go-rootcerts v1.0.2 // indirect - github.com/hashicorp/go-safetemp v1.0.0 // indirect - github.com/hashicorp/go-slug v0.4.1 // indirect github.com/hashicorp/go-tfe v0.15.0 github.com/hashicorp/go-uuid v1.0.1 github.com/hashicorp/go-version v1.2.1 - github.com/hashicorp/golang-lru v0.5.1 // indirect github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f github.com/hashicorp/hcl/v2 v2.10.1 - github.com/hashicorp/jsonapi v0.0.0-20210518035559-1e50d74c8db3 // indirect - github.com/hashicorp/serf v0.9.5 // indirect github.com/hashicorp/terraform-config-inspect v0.0.0-20210209133302-4fd17a0faac2 github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 - github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect - github.com/huandu/xstrings v1.3.2 // indirect - github.com/imdario/mergo v0.3.11 // indirect github.com/jmespath/go-jmespath v0.4.0 github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926 - github.com/json-iterator/go v1.1.7 // indirect - github.com/jstemmer/go-junit-report v0.9.1 // indirect - github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 - github.com/klauspost/compress v1.11.2 // indirect github.com/lib/pq v1.8.0 github.com/likexian/gokit v0.20.15 github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 - github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/masterzen/winrm v0.0.0-20200615185753-c42b5136ff88 - github.com/mattn/go-colorable v0.1.6 // indirect github.com/mattn/go-isatty v0.0.12 github.com/mattn/go-shellwords v1.0.4 github.com/mitchellh/cli v1.1.2 @@ -115,71 +61,128 @@ require ( github.com/mitchellh/copystructure v1.0.0 github.com/mitchellh/go-homedir v1.1.0 github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb - github.com/mitchellh/go-testing-interface v1.0.0 // indirect github.com/mitchellh/go-wordwrap v1.0.0 github.com/mitchellh/gox v1.0.1 - github.com/mitchellh/iochan v1.0.0 // indirect github.com/mitchellh/mapstructure v1.1.2 github.com/mitchellh/panicwrap v1.0.0 github.com/mitchellh/reflectwalk v1.0.1 - github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect - github.com/modern-go/reflect2 v1.0.1 // indirect - github.com/mozillazg/go-httpheader v0.3.0 // indirect github.com/nishanths/exhaustive v0.2.3 - github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect - github.com/oklog/run v1.0.0 // indirect github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db github.com/pkg/browser v0.0.0-20201207095918-0426ae3fba23 github.com/pkg/errors v0.9.1 github.com/posener/complete v1.2.3 - github.com/satori/go.uuid v1.2.0 // indirect - github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect - github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a // indirect github.com/spf13/afero v1.2.2 - github.com/spf13/pflag v1.0.3 // indirect github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.232 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag v1.0.233 github.com/tencentyun/cos-go-sdk-v5 v0.7.29 github.com/tombuildsstuff/giovanni v0.15.1 - github.com/ulikunitz/xz v0.5.8 // indirect - github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect - github.com/vmihailenco/tagparser v0.1.1 // indirect github.com/xanzy/ssh-agent v0.2.1 github.com/xlab/treeprint v0.0.0-20161029104018-1d6e34225557 github.com/zclconf/go-cty v1.9.1 github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b github.com/zclconf/go-cty-yaml v1.0.2 go.etcd.io/etcd v0.5.0-alpha.5.0.20210428180535-15715dcf1ace - go.opencensus.io v0.23.0 // indirect - go.uber.org/atomic v1.3.2 // indirect - go.uber.org/multierr v1.1.0 // indirect - go.uber.org/zap v1.10.0 // indirect golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2 - golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5 // indirect golang.org/x/mod v0.4.2 golang.org/x/net v0.0.0-20210614182718-04defd469f4e golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf golang.org/x/text v0.3.6 - golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect golang.org/x/tools v0.1.4 - golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/api v0.44.0-impersonate-preview - google.golang.org/appengine v1.6.7 // indirect - google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect google.golang.org/grpc v1.36.0 google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 google.golang.org/protobuf v1.25.0 - gopkg.in/inf.v0 v0.9.0 // indirect - gopkg.in/ini.v1 v1.42.0 // indirect - gopkg.in/yaml.v2 v2.3.0 // indirect honnef.co/go/tools v0.0.1-2020.1.4 k8s.io/api v0.0.0-20190620084959-7cf5895f2711 k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655 k8s.io/client-go v10.0.0+incompatible - k8s.io/klog v0.4.0 // indirect k8s.io/utils v0.0.0-20200411171748-3d5a2fe318e4 +) + +require ( + cloud.google.com/go v0.79.0 // indirect + github.com/Azure/go-autorest v14.2.0+incompatible // indirect + github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect + github.com/Azure/go-autorest/autorest/azure/cli v0.4.2 // indirect + github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect + github.com/Azure/go-autorest/autorest/to v0.4.0 // indirect + github.com/Azure/go-autorest/autorest/validation v0.3.1 // indirect + github.com/Azure/go-autorest/logger v0.2.1 // indirect + github.com/Azure/go-autorest/tracing v0.6.0 // indirect + github.com/Azure/go-ntlmssp v0.0.0-20200615164410-66371956d46c // indirect + github.com/BurntSushi/toml v0.3.1 // indirect + github.com/ChrisTrenkamp/goxpath v0.0.0-20190607011252-c5096ec8773d // indirect + github.com/Masterminds/goutils v1.1.0 // indirect + github.com/Masterminds/semver v1.5.0 // indirect + github.com/Masterminds/sprig v2.22.0+incompatible // indirect + github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af // indirect + github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e // indirect + github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0 // indirect + github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect + github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da // indirect + github.com/armon/go-radix v1.0.0 // indirect + github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f // indirect + github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect + github.com/coreos/go-semver v0.2.0 // indirect + github.com/coreos/go-systemd v0.0.0-20181012123002-c6f51f82210d // indirect + github.com/dimchansky/utfbom v1.1.1 // indirect + github.com/dylanmei/iso8601 v0.1.0 // indirect + github.com/fatih/color v1.9.0 // indirect + github.com/form3tech-oss/jwt-go v3.2.2+incompatible // indirect + github.com/gofrs/uuid v3.3.0+incompatible // indirect + github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d // indirect + github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect + github.com/google/go-querystring v1.1.0 // indirect + github.com/google/gofuzz v1.0.0 // indirect + github.com/googleapis/gax-go/v2 v2.0.5 // indirect + github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d // indirect + github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 // indirect + github.com/hashicorp/go-immutable-radix v1.0.0 // indirect + github.com/hashicorp/go-msgpack v0.5.4 // indirect + github.com/hashicorp/go-rootcerts v1.0.2 // indirect + github.com/hashicorp/go-safetemp v1.0.0 // indirect + github.com/hashicorp/go-slug v0.4.1 // indirect + github.com/hashicorp/golang-lru v0.5.1 // indirect + github.com/hashicorp/jsonapi v0.0.0-20210518035559-1e50d74c8db3 // indirect + github.com/hashicorp/serf v0.9.5 // indirect + github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect + github.com/huandu/xstrings v1.3.2 // indirect + github.com/imdario/mergo v0.3.11 // indirect + github.com/json-iterator/go v1.1.7 // indirect + github.com/jstemmer/go-junit-report v0.9.1 // indirect + github.com/jtolds/gls v4.2.1+incompatible // indirect + github.com/klauspost/compress v1.11.2 // indirect + github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect + github.com/mattn/go-colorable v0.1.6 // indirect + github.com/mitchellh/go-testing-interface v1.0.0 // indirect + github.com/mitchellh/iochan v1.0.0 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.1 // indirect + github.com/mozillazg/go-httpheader v0.3.0 // indirect + github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect + github.com/oklog/run v1.0.0 // indirect + github.com/satori/go.uuid v1.2.0 // indirect + github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect + github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a // indirect + github.com/spf13/pflag v1.0.3 // indirect + github.com/ulikunitz/xz v0.5.8 // indirect + github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect + github.com/vmihailenco/tagparser v0.1.1 // indirect + go.opencensus.io v0.23.0 // indirect + go.uber.org/atomic v1.3.2 // indirect + go.uber.org/multierr v1.1.0 // indirect + go.uber.org/zap v1.10.0 // indirect + golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5 // indirect + golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect + golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect + google.golang.org/appengine v1.6.7 // indirect + google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect + gopkg.in/inf.v0 v0.9.0 // indirect + gopkg.in/ini.v1 v1.42.0 // indirect + gopkg.in/yaml.v2 v2.3.0 // indirect + k8s.io/klog v0.4.0 // indirect sigs.k8s.io/yaml v1.1.0 // indirect ) From 3f4b680f1cb121568e6f6943b56ee754165857ee Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 6 Oct 2021 12:51:03 -0400 Subject: [PATCH 146/644] Check for nil change during apply Because NodeAbstractResourceInstance.readDiff can return a nil change, we must check for that in all callers. --- internal/terraform/node_resource_destroy.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/terraform/node_resource_destroy.go b/internal/terraform/node_resource_destroy.go index c4f4d4b015e5..8dd9e21b946e 100644 --- a/internal/terraform/node_resource_destroy.go +++ b/internal/terraform/node_resource_destroy.go @@ -166,7 +166,7 @@ func (n *NodeDestroyResourceInstance) managedResourceExecute(ctx EvalContext) (d changeApply, err = n.readDiff(ctx, providerSchema) diags = diags.Append(err) - if diags.HasErrors() { + if changeApply == nil || diags.HasErrors() { return diags } From 2e6b6e9a6b7d5802663d9eb6c578bf0900512600 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 11 Oct 2021 16:37:11 -0700 Subject: [PATCH 147/644] go.mod: go get google.golang.org/protobuf@v1.27.1 --- go.mod | 4 ++-- go.sum | 7 +++++-- internal/plans/internal/planproto/planfile.pb.go | 7 +------ internal/tfplugin5/tfplugin5.pb.go | 7 +------ internal/tfplugin6/tfplugin6.pb.go | 7 +------ 5 files changed, 10 insertions(+), 22 deletions(-) diff --git a/go.mod b/go.mod index 756e51bef18d..65282e52fa96 100644 --- a/go.mod +++ b/go.mod @@ -23,7 +23,7 @@ require ( github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 github.com/go-test/deep v1.0.3 github.com/golang/mock v1.5.0 - github.com/golang/protobuf v1.4.3 + github.com/golang/protobuf v1.5.0 github.com/google/go-cmp v0.5.5 github.com/google/uuid v1.2.0 github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 @@ -93,7 +93,7 @@ require ( google.golang.org/api v0.44.0-impersonate-preview google.golang.org/grpc v1.36.0 google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 - google.golang.org/protobuf v1.25.0 + google.golang.org/protobuf v1.27.1 honnef.co/go/tools v0.0.1-2020.1.4 k8s.io/api v0.0.0-20190620084959-7cf5895f2711 k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655 diff --git a/go.sum b/go.sum index b5c72603f3a3..7d2209ad1619 100644 --- a/go.sum +++ b/go.sum @@ -256,8 +256,9 @@ github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:W github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0= github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8= github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= -github.com/golang/protobuf v1.4.3 h1:JjCZWpVbqXDqFVmTfYWEVTMIYrL/NPdPSCHPJ0T/raM= github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= +github.com/golang/protobuf v1.5.0 h1:LUVKkCeviFUMKqHa4tXIIij/lbhnMbP7Fn5wKdKkRh4= +github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= github.com/google/btree v0.0.0-20160524151835-7d79101e329e/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0 h1:0udJVsspx3VBr5FwtLhQQtuAsVc79tTq0ocGIPAU6qo= @@ -1037,8 +1038,10 @@ google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2 google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU= google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4= -google.golang.org/protobuf v1.25.0 h1:Ejskq+SyPohKW+1uil0JJMtmHCgJPJ/qWTxr8qp+R4c= google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= +google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= +google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/internal/plans/internal/planproto/planfile.pb.go b/internal/plans/internal/planproto/planfile.pb.go index a8810e0d746a..756cfdabeb06 100644 --- a/internal/plans/internal/planproto/planfile.pb.go +++ b/internal/plans/internal/planproto/planfile.pb.go @@ -1,13 +1,12 @@ // Code generated by protoc-gen-go. DO NOT EDIT. // versions: -// protoc-gen-go v1.25.0 +// protoc-gen-go v1.27.1 // protoc v3.15.6 // source: planfile.proto package planproto import ( - proto "github.com/golang/protobuf/proto" protoreflect "google.golang.org/protobuf/reflect/protoreflect" protoimpl "google.golang.org/protobuf/runtime/protoimpl" reflect "reflect" @@ -21,10 +20,6 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// This is a compile-time assertion that a sufficiently up-to-date version -// of the legacy proto package is being used. -const _ = proto.ProtoPackageIsVersion4 - // Mode describes the planning mode that created the plan. type Mode int32 diff --git a/internal/tfplugin5/tfplugin5.pb.go b/internal/tfplugin5/tfplugin5.pb.go index d7db5a4f6448..ae5ec5e9b9ae 100644 --- a/internal/tfplugin5/tfplugin5.pb.go +++ b/internal/tfplugin5/tfplugin5.pb.go @@ -19,7 +19,7 @@ // Code generated by protoc-gen-go. DO NOT EDIT. // versions: -// protoc-gen-go v1.25.0 +// protoc-gen-go v1.27.1 // protoc v3.15.6 // source: tfplugin5.proto @@ -27,7 +27,6 @@ package tfplugin5 import ( context "context" - proto "github.com/golang/protobuf/proto" grpc "google.golang.org/grpc" codes "google.golang.org/grpc/codes" status "google.golang.org/grpc/status" @@ -44,10 +43,6 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// This is a compile-time assertion that a sufficiently up-to-date version -// of the legacy proto package is being used. -const _ = proto.ProtoPackageIsVersion4 - type StringKind int32 const ( diff --git a/internal/tfplugin6/tfplugin6.pb.go b/internal/tfplugin6/tfplugin6.pb.go index afd77a0eedbb..848aed807392 100644 --- a/internal/tfplugin6/tfplugin6.pb.go +++ b/internal/tfplugin6/tfplugin6.pb.go @@ -19,7 +19,7 @@ // Code generated by protoc-gen-go. DO NOT EDIT. // versions: -// protoc-gen-go v1.25.0 +// protoc-gen-go v1.27.1 // protoc v3.15.6 // source: tfplugin6.proto @@ -27,7 +27,6 @@ package tfplugin6 import ( context "context" - proto "github.com/golang/protobuf/proto" grpc "google.golang.org/grpc" codes "google.golang.org/grpc/codes" status "google.golang.org/grpc/status" @@ -44,10 +43,6 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// This is a compile-time assertion that a sufficiently up-to-date version -// of the legacy proto package is being used. -const _ = proto.ProtoPackageIsVersion4 - type StringKind int32 const ( From 2dd15caf871df59869fb3ec3eb828b530b455c6c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 8 Oct 2021 20:35:55 +0000 Subject: [PATCH 148/644] Bump github.com/hashicorp/go-plugin from 1.4.1 to 1.4.3 Bumps [github.com/hashicorp/go-plugin](https://github.com/hashicorp/go-plugin) from 1.4.1 to 1.4.3. - [Release notes](https://github.com/hashicorp/go-plugin/releases) - [Commits](https://github.com/hashicorp/go-plugin/compare/v1.4.1...v1.4.3) --- updated-dependencies: - dependency-name: github.com/hashicorp/go-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 65282e52fa96..87c8b4bbf5d4 100644 --- a/go.mod +++ b/go.mod @@ -38,7 +38,7 @@ require ( github.com/hashicorp/go-getter v1.5.2 github.com/hashicorp/go-hclog v0.15.0 github.com/hashicorp/go-multierror v1.1.1 - github.com/hashicorp/go-plugin v1.4.1 + github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.5.2 github.com/hashicorp/go-tfe v0.15.0 github.com/hashicorp/go-uuid v1.0.1 diff --git a/go.sum b/go.sum index 7d2209ad1619..e2505ab34d6a 100644 --- a/go.sum +++ b/go.sum @@ -359,8 +359,8 @@ github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHh github.com/hashicorp/go-multierror v1.1.0/go.mod h1:spPvp8C1qA32ftKqdAHm4hHTbPw+vmowP0z+KUhOZdA= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= -github.com/hashicorp/go-plugin v1.4.1 h1:6UltRQlLN9iZO513VveELp5xyaFxVD2+1OVylE+2E+w= -github.com/hashicorp/go-plugin v1.4.1/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ= +github.com/hashicorp/go-plugin v1.4.3 h1:DXmvivbWD5qdiBts9TpBC7BYL1Aia5sxbRgQB+v6UZM= +github.com/hashicorp/go-plugin v1.4.3/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ= github.com/hashicorp/go-retryablehttp v0.5.2 h1:AoISa4P4IsW0/m4T6St8Yw38gTl5GtBAgfkhYh1xAz4= github.com/hashicorp/go-retryablehttp v0.5.2/go.mod h1:9B5zBasrRhHXnJnui7y6sL7es7NDiJgTc6Er0maI1Xs= github.com/hashicorp/go-rootcerts v1.0.2 h1:jzhAVGtqPKbwpyCPELlgNWhE1znq+qwJtW5Oi2viEzc= From eec4a838e0a8ccd3192010903a21a1d818eeaa31 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 8 Oct 2021 20:35:14 +0000 Subject: [PATCH 149/644] Bump github.com/mitchellh/copystructure from 1.0.0 to 1.2.0 Bumps [github.com/mitchellh/copystructure](https://github.com/mitchellh/copystructure) from 1.0.0 to 1.2.0. - [Release notes](https://github.com/mitchellh/copystructure/releases) - [Commits](https://github.com/mitchellh/copystructure/compare/v1.0.0...v1.2.0) --- updated-dependencies: - dependency-name: github.com/mitchellh/copystructure dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- go.mod | 4 ++-- go.sum | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/go.mod b/go.mod index 87c8b4bbf5d4..d090111e0d76 100644 --- a/go.mod +++ b/go.mod @@ -58,14 +58,14 @@ require ( github.com/mattn/go-shellwords v1.0.4 github.com/mitchellh/cli v1.1.2 github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db - github.com/mitchellh/copystructure v1.0.0 + github.com/mitchellh/copystructure v1.2.0 github.com/mitchellh/go-homedir v1.1.0 github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb github.com/mitchellh/go-wordwrap v1.0.0 github.com/mitchellh/gox v1.0.1 github.com/mitchellh/mapstructure v1.1.2 github.com/mitchellh/panicwrap v1.0.0 - github.com/mitchellh/reflectwalk v1.0.1 + github.com/mitchellh/reflectwalk v1.0.2 github.com/nishanths/exhaustive v0.2.3 github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db github.com/pkg/browser v0.0.0-20201207095918-0426ae3fba23 diff --git a/go.sum b/go.sum index e2505ab34d6a..908cae84a14b 100644 --- a/go.sum +++ b/go.sum @@ -499,8 +499,9 @@ github.com/mitchellh/cli v1.1.2 h1:PvH+lL2B7IQ101xQL63Of8yFS2y+aDlsFcsqNc+u/Kw= github.com/mitchellh/cli v1.1.2/go.mod h1:6iaV0fGdElS6dPBx0EApTxHrcWvmJphyh2n8YBLPPZ4= github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db h1:62I3jR2EmQ4l5rM/4FEfDWcRD+abF5XlKShorW5LRoQ= github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db/go.mod h1:l0dey0ia/Uv7NcFFVbCLtqEBQbrT4OCwCSKTEv6enCw= -github.com/mitchellh/copystructure v1.0.0 h1:Laisrj+bAB6b/yJwB5Bt3ITZhGJdqmxquMKeZ+mmkFQ= github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw= +github.com/mitchellh/copystructure v1.2.0 h1:vpKXTN4ewci03Vljg/q9QvCGUDttBOGBIa15WveJJGw= +github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HKCj9FbZEVFJRxO9s= github.com/mitchellh/go-homedir v1.0.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= @@ -522,8 +523,8 @@ github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh github.com/mitchellh/panicwrap v1.0.0 h1:67zIyVakCIvcs69A0FGfZjBdPleaonSgGlXRSRlb6fE= github.com/mitchellh/panicwrap v1.0.0/go.mod h1:pKvZHwWrZowLUzftuFq7coarnxbBXU4aQh3N0BJOeeA= github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= -github.com/mitchellh/reflectwalk v1.0.1 h1:FVzMWA5RllMAKIdUSC8mdWo3XtwoecrH79BY70sEEpE= -github.com/mitchellh/reflectwalk v1.0.1/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= +github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ= +github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= From 55f0d063146eee6be5918587e5eff2fd42d01c2f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 12 Oct 2021 10:23:56 -0700 Subject: [PATCH 150/644] go.mod: go get github.com/lib/pq@v1.10.3 This is just a routine upgrade to the latest v1 release. --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index d090111e0d76..11b19549a46b 100644 --- a/go.mod +++ b/go.mod @@ -50,7 +50,7 @@ require ( github.com/jmespath/go-jmespath v0.4.0 github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926 github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 - github.com/lib/pq v1.8.0 + github.com/lib/pq v1.10.3 github.com/likexian/gokit v0.20.15 github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 github.com/masterzen/winrm v0.0.0-20200615185753-c42b5136ff88 diff --git a/go.sum b/go.sum index 908cae84a14b..dc15ae95e8a9 100644 --- a/go.sum +++ b/go.sum @@ -456,8 +456,8 @@ github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kylelemons/godebug v0.0.0-20170820004349-d65d576e9348/go.mod h1:B69LEHPfb2qLo0BaaOLcbitczOKLWTsrBG9LczfCD4k= github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= -github.com/lib/pq v1.8.0 h1:9xohqzkUwzR4Ga4ivdTcawVS89YSDVxXMa3xJX3cGzg= -github.com/lib/pq v1.8.0/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= +github.com/lib/pq v1.10.3 h1:v9QZf2Sn6AmjXtQeFpdoq/eaNtYP6IN+7lcrygsIAtg= +github.com/lib/pq v1.10.3/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= github.com/likexian/gokit v0.0.0-20190309162924-0a377eecf7aa/go.mod h1:QdfYv6y6qPA9pbBA2qXtoT8BMKha6UyNbxWGWl/9Jfk= github.com/likexian/gokit v0.0.0-20190418170008-ace88ad0983b/go.mod h1:KKqSnk/VVSW8kEyO2vVCXoanzEutKdlBAPohmGXkxCk= github.com/likexian/gokit v0.0.0-20190501133040-e77ea8b19cdc/go.mod h1:3kvONayqCaj+UgrRZGpgfXzHdMYCAO0KAt4/8n0L57Y= From 2fd5ca37674dd869bf784586556ec0ad4bc2d7eb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 12 Oct 2021 17:24:56 +0000 Subject: [PATCH 151/644] build(deps): bump honnef.co/go/tools from 0.0.1-2020.1.4 to 0.3.0-0.dev Bumps [honnef.co/go/tools](https://github.com/dominikh/go-tools) from 0.0.1-2020.1.4 to 0.3.0-0.dev. - [Release notes](https://github.com/dominikh/go-tools/releases) - [Commits](https://github.com/dominikh/go-tools/compare/v0.0.1-2020.1.4...v0.3.0-0.dev) --- updated-dependencies: - dependency-name: honnef.co/go/tools dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/go.mod b/go.mod index 11b19549a46b..db77246a2e02 100644 --- a/go.mod +++ b/go.mod @@ -94,7 +94,7 @@ require ( google.golang.org/grpc v1.36.0 google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 google.golang.org/protobuf v1.27.1 - honnef.co/go/tools v0.0.1-2020.1.4 + honnef.co/go/tools v0.3.0-0.dev k8s.io/api v0.0.0-20190620084959-7cf5895f2711 k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655 k8s.io/client-go v10.0.0+incompatible diff --git a/go.sum b/go.sum index dc15ae95e8a9..bc61ec030ba9 100644 --- a/go.sum +++ b/go.sum @@ -1074,8 +1074,9 @@ honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWh honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= -honnef.co/go/tools v0.0.1-2020.1.4 h1:UoveltGrhghAA7ePc+e+QYDHXrBps2PqFZiHkGR/xK8= honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= +honnef.co/go/tools v0.3.0-0.dev h1:6vzhjcOJu1nJRa2G8QLXf3DPeg601NuerY16vrb01GY= +honnef.co/go/tools v0.3.0-0.dev/go.mod h1:lPVVZ2BS5TfnjLyizF7o7hv7j9/L+8cZY2hLyjP9cGY= k8s.io/api v0.0.0-20190620084959-7cf5895f2711 h1:BblVYz/wE5WtBsD/Gvu54KyBUTJMflolzc5I2DTvh50= k8s.io/api v0.0.0-20190620084959-7cf5895f2711/go.mod h1:TBhBqb1AWbBQbW3XRusr7n7E4v2+5ZY8r8sAMnyFC5A= k8s.io/apimachinery v0.0.0-20190612205821-1799e75a0719/go.mod h1:I4A+glKBHiTgiEjQiCCQfCAIcIMFGt291SmsvcrFzJA= From 02ca4e970c44e2ec6cbe7dab6ab90f7866aacb38 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 12 Oct 2021 09:59:02 -0700 Subject: [PATCH 152/644] go.mod: replace github.com/dgrijalva/jwt-go with .../golang-jwt/jwt CVE-2020-26160 is a high-severity advisory reported against this module. The dgrijalva package is no longer maintained but our legacy etcv2 backend depends on it indirectly, via go.etcd.io/etcd/client. The golang-jwt package is the blessed successor of the original, and has a v3 line which is compatible with the v3 line of dgrijalva, and so through this replace we can get a fix for the advisory without other significant behavior change. We've preserved the etcdv2 backend as-is on a best-effort basis in order to support anyone who is already using it, but recommend that users switch to etcdv3 or to some other backend for ongoing use. We also have future plans to make state storage be a matter for provider plugins rather than built in to Terraform CLI, at which point this backend will either become obsolete or be factored out into its own plugin, at which point we can remove this "replace" directive and the associated dependency altogether. --- go.mod | 6 ++++++ go.sum | 5 ++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index db77246a2e02..dfcde125f7e5 100644 --- a/go.mod +++ b/go.mod @@ -192,4 +192,10 @@ replace github.com/golang/mock v1.5.0 => github.com/golang/mock v1.4.4 replace k8s.io/client-go => k8s.io/client-go v0.0.0-20190620085101-78d2af792bab +// github.com/dgrijalva/jwt-go is no longer maintained but is an indirect +// dependency of the old etcdv2 backend, and so we need to keep this working +// until that backend is removed. github.com/golang-jwt/jwt/v3 is a drop-in +// replacement that includes a fix for CVE-2020-26160. +replace github.com/dgrijalva/jwt-go => github.com/golang-jwt/jwt v3.2.1+incompatible + go 1.17 diff --git a/go.sum b/go.sum index bc61ec030ba9..bec4551f8e45 100644 --- a/go.sum +++ b/go.sum @@ -172,9 +172,6 @@ github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2/go.mod h1:J7Y8YcW2 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/dgrijalva/jwt-go v0.0.0-20160705203006-01aeca54ebda/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= -github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM= -github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= github.com/dimchansky/utfbom v1.1.0/go.mod h1:rO41eb7gLfo8SF1jd9F8HplJm1Fewwi4mQvIirEdv+8= github.com/dimchansky/utfbom v1.1.1 h1:vV6w1AhK4VMnhBno/TPVCoK9U/LP0PkLCS9tbxHdi/U= github.com/dimchansky/utfbom v1.1.1/go.mod h1:SxdoEBH5qIqFocHMyGOXVAybYJdr71b1Q/j0mACtrfE= @@ -226,6 +223,8 @@ github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7a github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d h1:3PaI8p3seN09VjbTYC/QWlUZdZ1qS1zGjy7LH2Wt07I= github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o= +github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c= +github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20160516000752-02826c3e7903/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= From 051629d74a508024f06fef640aba395e3ce4a911 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 12 Oct 2021 17:33:17 +0000 Subject: [PATCH 153/644] build(deps): bump github.com/agext/levenshtein from 1.2.2 to 1.2.3 Bumps [github.com/agext/levenshtein](https://github.com/agext/levenshtein) from 1.2.2 to 1.2.3. - [Release notes](https://github.com/agext/levenshtein/releases) - [Commits](https://github.com/agext/levenshtein/compare/v1.2.2...v1.2.3) --- updated-dependencies: - dependency-name: github.com/agext/levenshtein dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/go.mod b/go.mod index dfcde125f7e5..35b4b645a789 100644 --- a/go.mod +++ b/go.mod @@ -4,7 +4,7 @@ require ( cloud.google.com/go/storage v1.10.0 github.com/Azure/azure-sdk-for-go v52.5.0+incompatible github.com/Azure/go-autorest/autorest v0.11.18 - github.com/agext/levenshtein v1.2.2 + github.com/agext/levenshtein v1.2.3 github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70 github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible diff --git a/go.sum b/go.sum index bec4551f8e45..fa2a319b96f1 100644 --- a/go.sum +++ b/go.sum @@ -93,8 +93,9 @@ github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mo github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af h1:DBNMBMuMiWYu0b+8KMJuWmfCkcxl09JwdlqwDZZ6U14= github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af/go.mod h1:5Jv4cbFiHJMsVxt52+i0Ha45fjshj6wxYr1r19tB9bw= github.com/agext/levenshtein v1.2.1/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= -github.com/agext/levenshtein v1.2.2 h1:0S/Yg6LYmFJ5stwQeRp6EeOcCbj7xiqQSdNelsXvaqE= github.com/agext/levenshtein v1.2.2/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= +github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo= +github.com/agext/levenshtein v1.2.3/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a h1:APorzFpCcv6wtD5vmRWYqNm4N55kbepL7c7kTq9XI6A= From 656f03b250a8ce532c9ab6c7d9f75f6746b090d9 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 12 Oct 2021 13:47:47 -0400 Subject: [PATCH 154/644] fix test fixture had the instance in the wrong mod Make the state match the fixture config. The old test was not technically invalid, but because it caused multiple instances of the provider to be created, they were backed by the same MockProvider value resulting in the `*Called` fields interfering. --- internal/terraform/context_apply_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index a525ab52d19c..8bacd2d9184a 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -1543,8 +1543,8 @@ func TestContext2Apply_destroyModuleVarProviderConfig(t *testing.T) { p := testProvider("aws") p.PlanResourceChangeFn = testDiffFn state := states.NewState() - root := state.EnsureModule(addrs.RootModuleInstance) - root.SetResourceInstanceCurrent( + child := state.EnsureModule(addrs.RootModuleInstance.Child("child", addrs.NoKey)) + child.SetResourceInstanceCurrent( mustResourceInstanceAddr("aws_instance.foo").Resource, &states.ResourceInstanceObjectSrc{ Status: states.ObjectReady, From 903ae5edfd1ed00db91d233ed9823b5c8069ba23 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 12 Oct 2021 14:08:37 -0400 Subject: [PATCH 155/644] fix test fixtures with multiple providers Allow these to share the same backing MockProvider. --- internal/terraform/context_apply_test.go | 12 +++++++++--- internal/terraform/context_input_test.go | 4 +++- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index a525ab52d19c..06ff0de10be0 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -582,7 +582,9 @@ func TestContext2Apply_providerAlias(t *testing.T) { p.ApplyResourceChangeFn = testApplyFn ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { + return p, nil + }, }, }) @@ -616,7 +618,9 @@ func TestContext2Apply_providerAliasConfigure(t *testing.T) { ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("another"): testProviderFuncFixed(p2), + addrs.NewDefaultProvider("another"): func() (providers.Interface, error) { + return p2, nil + }, }, }) @@ -1554,7 +1558,9 @@ func TestContext2Apply_destroyModuleVarProviderConfig(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { + return p, nil + }, }, }) diff --git a/internal/terraform/context_input_test.go b/internal/terraform/context_input_test.go index 819856a6c7d6..a9ec11b38fc6 100644 --- a/internal/terraform/context_input_test.go +++ b/internal/terraform/context_input_test.go @@ -117,7 +117,9 @@ func TestContext2Input_providerMulti(t *testing.T) { ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { + return p, nil + }, }, UIInput: inp, }) From d76759a6a961b1b20886d6b6528436257117ecf4 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 12 Oct 2021 11:04:01 -0700 Subject: [PATCH 156/644] configs/configload: snapshotDir must be used via pointer A snapshotDir tracks its current position as part of its state, so we need to use it via pointer rather than value so that Readdirnames can actually update that position, or else we'll just get stuck at position zero. In practice this wasn't hurting anything because we only call Readdir once on our snapshots, to read the whole directory at once. Still nice to fix to avoid a gotcha for future maintenence, though. --- internal/configs/configload/loader_snapshot.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/internal/configs/configload/loader_snapshot.go b/internal/configs/configload/loader_snapshot.go index c1b54b8c2d6a..915665f833ba 100644 --- a/internal/configs/configload/loader_snapshot.go +++ b/internal/configs/configload/loader_snapshot.go @@ -258,7 +258,7 @@ func (fs snapshotFS) Open(name string) (afero.File, error) { filenames = append(filenames, n) } sort.Strings(filenames) - return snapshotDir{ + return &snapshotDir{ filenames: filenames, }, nil } @@ -310,7 +310,7 @@ func (fs snapshotFS) Stat(name string) (os.FileInfo, error) { if err != nil { return nil, err } - _, isDir := f.(snapshotDir) + _, isDir := f.(*snapshotDir) return snapshotFileInfo{ name: filepath.Base(name), isDir: isDir, @@ -377,9 +377,9 @@ type snapshotDir struct { at int } -var _ afero.File = snapshotDir{} +var _ afero.File = (*snapshotDir)(nil) -func (f snapshotDir) Readdir(count int) ([]os.FileInfo, error) { +func (f *snapshotDir) Readdir(count int) ([]os.FileInfo, error) { names, err := f.Readdirnames(count) if err != nil { return nil, err @@ -394,7 +394,7 @@ func (f snapshotDir) Readdir(count int) ([]os.FileInfo, error) { return ret, nil } -func (f snapshotDir) Readdirnames(count int) ([]string, error) { +func (f *snapshotDir) Readdirnames(count int) ([]string, error) { var outLen int names := f.filenames[f.at:] if count > 0 { From 965c0f3f919b006321339ca3358913f96b4cc046 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 12 Oct 2021 11:09:00 -0700 Subject: [PATCH 157/644] build: Run staticcheck with "go run" Running the tool this way ensures that we'll always run the version selected by our go.mod file, rather than whatever happened to be available in $GOPATH/bin on the system where we're running this. This change caused some contexts to now be using a newer version of staticcheck with additional checks, and so this commit also includes some changes to quiet the new warnings without any change in overall behavior. --- internal/lang/funcs/cidr_test.go | 2 +- internal/plugin/discovery/find.go | 4 +--- scripts/staticcheck.sh | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/internal/lang/funcs/cidr_test.go b/internal/lang/funcs/cidr_test.go index 5246531111e9..cb8d810a9392 100644 --- a/internal/lang/funcs/cidr_test.go +++ b/internal/lang/funcs/cidr_test.go @@ -246,7 +246,7 @@ func TestCidrSubnet(t *testing.T) { }, { // fractions are Not Ok cty.StringVal("10.256.0.0/8"), - cty.NumberFloatVal(2 / 3), + cty.NumberFloatVal(2.0 / 3.0), cty.NumberFloatVal(.75), cty.UnknownVal(cty.String), true, diff --git a/internal/plugin/discovery/find.go b/internal/plugin/discovery/find.go index f053312b00de..027a887ebf61 100644 --- a/internal/plugin/discovery/find.go +++ b/internal/plugin/discovery/find.go @@ -154,9 +154,7 @@ func ResolvePluginPaths(paths []string) PluginMetaSet { // Trim the .exe suffix used on Windows before we start wrangling // the remainder of the path. - if strings.HasSuffix(baseName, ".exe") { - baseName = baseName[:len(baseName)-4] - } + baseName = strings.TrimSuffix(baseName, ".exe") parts := strings.SplitN(baseName, "_v", 2) name := parts[0] diff --git a/scripts/staticcheck.sh b/scripts/staticcheck.sh index 66c47092f9f9..2dd08309a6f1 100755 --- a/scripts/staticcheck.sh +++ b/scripts/staticcheck.sh @@ -13,4 +13,4 @@ packages=$(go list ./... | egrep -v ${skip}) # We are skipping style-related checks, since terraform intentionally breaks # some of these. The goal here is to find issues that reduce code clarity, or # may result in bugs. -staticcheck -checks 'all,-ST*' ${packages} +go run honnef.co/go/tools/cmd/staticcheck -checks 'all,-ST*' ${packages} From 73b1263a869a00d1751ba38564b5c7e05d163467 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 12 Oct 2021 17:41:04 -0400 Subject: [PATCH 158/644] wrap multiple provider creations into a factory fn When a test uses multiple instances of the same provider, we may need to have separate objects to prevent overwriting of the MockProvider state. Create a completely new MockProvider in each factory function call rather than re-using the original provider value. --- internal/terraform/context_apply_test.go | 68 +++++++++++++++--------- internal/terraform/context_input_test.go | 32 ++++++++--- 2 files changed, 68 insertions(+), 32 deletions(-) diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 06ff0de10be0..09babdbe0a4a 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -577,14 +577,18 @@ func TestContext2Apply_refCount(t *testing.T) { func TestContext2Apply_providerAlias(t *testing.T) { m := testModule(t, "apply-provider-alias") - p := testProvider("aws") - p.PlanResourceChangeFn = testDiffFn - p.ApplyResourceChangeFn = testApplyFn + + // Each provider instance must be completely independent to ensure that we + // are verifying the correct state of each. + p := func() (providers.Interface, error) { + p := testProvider("aws") + p.PlanResourceChangeFn = testDiffFn + p.ApplyResourceChangeFn = testApplyFn + return p, nil + } ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { - return p, nil - }, + addrs.NewDefaultProvider("aws"): p, }, }) @@ -612,15 +616,18 @@ func TestContext2Apply_providerAlias(t *testing.T) { func TestContext2Apply_providerAliasConfigure(t *testing.T) { m := testModule(t, "apply-provider-alias-configure") - p2 := testProvider("another") - p2.ApplyResourceChangeFn = testApplyFn - p2.PlanResourceChangeFn = testDiffFn + // Each provider instance must be completely independent to ensure that we + // are verifying the correct state of each. + p := func() (providers.Interface, error) { + p := testProvider("another") + p.ApplyResourceChangeFn = testApplyFn + p.PlanResourceChangeFn = testDiffFn + return p, nil + } ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("another"): func() (providers.Interface, error) { - return p2, nil - }, + addrs.NewDefaultProvider("another"): p, }, }) @@ -633,17 +640,29 @@ func TestContext2Apply_providerAliasConfigure(t *testing.T) { // Configure to record calls AFTER Plan above var configCount int32 - p2.ConfigureProviderFn = func(req providers.ConfigureProviderRequest) (resp providers.ConfigureProviderResponse) { - atomic.AddInt32(&configCount, 1) + p = func() (providers.Interface, error) { + p := testProvider("another") + p.ApplyResourceChangeFn = testApplyFn + p.PlanResourceChangeFn = testDiffFn + p.ConfigureProviderFn = func(req providers.ConfigureProviderRequest) (resp providers.ConfigureProviderResponse) { + atomic.AddInt32(&configCount, 1) - foo := req.Config.GetAttr("foo").AsString() - if foo != "bar" { - resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("foo: %#v", foo)) - } + foo := req.Config.GetAttr("foo").AsString() + if foo != "bar" { + resp.Diagnostics = resp.Diagnostics.Append(fmt.Errorf("foo: %#v", foo)) + } - return + return + } + return p, nil } + ctx = testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("another"): p, + }, + }) + state, diags := ctx.Apply(plan, m) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) @@ -1544,8 +1563,11 @@ func TestContext2Apply_destroySkipsCBD(t *testing.T) { func TestContext2Apply_destroyModuleVarProviderConfig(t *testing.T) { m := testModule(t, "apply-destroy-mod-var-provider-config") - p := testProvider("aws") - p.PlanResourceChangeFn = testDiffFn + p := func() (providers.Interface, error) { + p := testProvider("aws") + p.PlanResourceChangeFn = testDiffFn + return p, nil + } state := states.NewState() root := state.EnsureModule(addrs.RootModuleInstance) root.SetResourceInstanceCurrent( @@ -1558,9 +1580,7 @@ func TestContext2Apply_destroyModuleVarProviderConfig(t *testing.T) { ) ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { - return p, nil - }, + addrs.NewDefaultProvider("aws"): p, }, }) diff --git a/internal/terraform/context_input_test.go b/internal/terraform/context_input_test.go index a9ec11b38fc6..5216efb5965f 100644 --- a/internal/terraform/context_input_test.go +++ b/internal/terraform/context_input_test.go @@ -85,8 +85,7 @@ func TestContext2Input_provider(t *testing.T) { func TestContext2Input_providerMulti(t *testing.T) { m := testModule(t, "input-provider-multi") - p := testProvider("aws") - p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + getProviderSchemaResponse := getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ Provider: &configschema.Block{ Attributes: map[string]*configschema.Attribute{ "foo": { @@ -108,6 +107,17 @@ func TestContext2Input_providerMulti(t *testing.T) { }, }) + // In order to update the provider to check only the configure calls during + // apply, we will need to inject a new factory function after plan. We must + // use a closure around the factory, because in order for the inputs to + // work during apply we need to maintain the same context value, preventing + // us from assigning a new Providers map. + providerFactory := func() (providers.Interface, error) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponse + return p, nil + } + inp := &MockUIInput{ InputReturnMap: map[string]string{ "provider.aws.foo": "bar", @@ -118,7 +128,7 @@ func TestContext2Input_providerMulti(t *testing.T) { ctx := testContext2(t, &ContextOpts{ Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("aws"): func() (providers.Interface, error) { - return p, nil + return providerFactory() }, }, UIInput: inp, @@ -134,12 +144,18 @@ func TestContext2Input_providerMulti(t *testing.T) { plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) assertNoErrors(t, diags) - p.ConfigureProviderFn = func(req providers.ConfigureProviderRequest) (resp providers.ConfigureProviderResponse) { - lock.Lock() - defer lock.Unlock() - actual = append(actual, req.Config.GetAttr("foo").AsString()) - return + providerFactory = func() (providers.Interface, error) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponse + p.ConfigureProviderFn = func(req providers.ConfigureProviderRequest) (resp providers.ConfigureProviderResponse) { + lock.Lock() + defer lock.Unlock() + actual = append(actual, req.Config.GetAttr("foo").AsString()) + return + } + return p, nil } + if _, diags := ctx.Apply(plan, m); diags.HasErrors() { t.Fatalf("apply errors: %s", diags.Err()) } From b0d10c985779955e0ff5bb4b4e04fecc1879de81 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 13 Oct 2021 08:34:23 +0000 Subject: [PATCH 159/644] build(deps): bump github.com/xanzy/ssh-agent from 0.2.1 to 0.3.1 Bumps [github.com/xanzy/ssh-agent](https://github.com/xanzy/ssh-agent) from 0.2.1 to 0.3.1. - [Release notes](https://github.com/xanzy/ssh-agent/releases) - [Commits](https://github.com/xanzy/ssh-agent/compare/v0.2.1...v0.3.1) --- updated-dependencies: - dependency-name: github.com/xanzy/ssh-agent dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- go.mod | 5 +++-- go.sum | 18 ++++++++++-------- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/go.mod b/go.mod index 35b4b645a789..3dd2135813ff 100644 --- a/go.mod +++ b/go.mod @@ -76,13 +76,13 @@ require ( github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag v1.0.233 github.com/tencentyun/cos-go-sdk-v5 v0.7.29 github.com/tombuildsstuff/giovanni v0.15.1 - github.com/xanzy/ssh-agent v0.2.1 + github.com/xanzy/ssh-agent v0.3.1 github.com/xlab/treeprint v0.0.0-20161029104018-1d6e34225557 github.com/zclconf/go-cty v1.9.1 github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b github.com/zclconf/go-cty-yaml v1.0.2 go.etcd.io/etcd v0.5.0-alpha.5.0.20210428180535-15715dcf1ace - golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2 + golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 golang.org/x/mod v0.4.2 golang.org/x/net v0.0.0-20210614182718-04defd469f4e golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 @@ -117,6 +117,7 @@ require ( github.com/Masterminds/goutils v1.1.0 // indirect github.com/Masterminds/semver v1.5.0 // indirect github.com/Masterminds/sprig v2.22.0+incompatible // indirect + github.com/Microsoft/go-winio v0.5.0 // indirect github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af // indirect github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e // indirect github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0 // indirect diff --git a/go.sum b/go.sum index fa2a319b96f1..bc0ba56870d8 100644 --- a/go.sum +++ b/go.sum @@ -86,6 +86,8 @@ github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3Q github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y= github.com/Masterminds/sprig v2.22.0+incompatible h1:z4yfnGrZ7netVz+0EDJ0Wi+5VZCSYp4Z0m2dk6cEM60= github.com/Masterminds/sprig v2.22.0+incompatible/go.mod h1:y6hNFY5UBTIWBxnzTeuNhlNS5hqE0NB0E6fgfo2Br3o= +github.com/Microsoft/go-winio v0.5.0 h1:Elr9Wn+sGKPlkaBvwu4mTrxtmOp3F3yV9qhaHbXGjwU= +github.com/Microsoft/go-winio v0.5.0/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpzfwIujj1a84= github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ= github.com/PuerkitoBio/purell v1.0.0/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= github.com/PuerkitoBio/urlesc v0.0.0-20160726150825-5bd2802263f2/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= @@ -444,7 +446,6 @@ github.com/kisielk/errcheck v1.2.0/go.mod h1:/BMXB+zMLi60iA8Vv6Ksmxu/1UDYcXs4uQL github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/klauspost/compress v1.11.2 h1:MiK62aErc3gIiVEtyzKfeOHgW7atJb5g/KNX5m3c2nQ= github.com/klauspost/compress v1.11.2/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= -github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= @@ -590,8 +591,9 @@ github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ= github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= -github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= +github.com/sirupsen/logrus v1.7.0 h1:ShrD1U9pZB12TX0cVy0DtePoCH97K8EtX+mg7ZARUtM= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a h1:JSvGDIbmil4Ui/dDdFBExb7/cmkNjyX5F97oglmvCDo= @@ -637,8 +639,8 @@ github.com/vmihailenco/msgpack/v4 v4.3.12 h1:07s4sz9IReOgdikxLTKNbBdqDMLsjPKXwvC github.com/vmihailenco/msgpack/v4 v4.3.12/go.mod h1:gborTTJjAo/GWTqqRjrLCn9pgNN+NXzzngzBKDPIqw4= github.com/vmihailenco/tagparser v0.1.1 h1:quXMXlA39OCbd2wAdTsGDlK9RkOk6Wuw+x37wVyIuWY= github.com/vmihailenco/tagparser v0.1.1/go.mod h1:OeAg3pn3UbLjkWt+rN9oFYB6u/cQgqMEUPoW2WPyhdI= -github.com/xanzy/ssh-agent v0.2.1 h1:TCbipTQL2JiiCprBWx9frJ2eJlCYT00NmctrHxVAr70= -github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4= +github.com/xanzy/ssh-agent v0.3.1 h1:AmzO1SSWxw73zxFZPRwaMN1MohDw8UyHnmuxyceTEGo= +github.com/xanzy/ssh-agent v0.3.1/go.mod h1:QIE4lCeL7nkC25x+yA3LBIYfwCc1TFziCtG7cBAac6w= github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2 h1:eY9dn8+vbi4tKz5Qo6v2eYzo7kUS51QINcR5jNpbZS8= github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU= github.com/xlab/treeprint v0.0.0-20161029104018-1d6e34225557 h1:Jpn2j6wHkC9wJv5iMfJhKqrZJx3TahFx+7sbZ7zQdxs= @@ -679,7 +681,6 @@ go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20181025213731-e84da0312774/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= -golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190222235706-ffb98f73852f/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190426145343-a29dc8fdc734/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= @@ -693,8 +694,8 @@ golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPh golang.org/x/crypto v0.0.0-20201002170205-7f63de1d35b0/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= -golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2 h1:It14KIkyBFYkHkwZ7k45minvA9aorojkyjGk9KJ5B/w= -golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= +golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI= +golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -811,7 +812,6 @@ golang.org/x/sys v0.0.0-20181026203630-95b1ffbd15a5/go.mod h1:STP8DvDyc/dI5b8T5h golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -853,12 +853,14 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20201201145000-ef89a241ccb3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210104204734-6f8348627aad/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210220050731-9a76102bfb43/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210305230114-8fe3ee5dd75b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= From 765bff1dd5dd1f906f959208f8b4d7bb2ca4870d Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 13 Oct 2021 10:53:27 -0700 Subject: [PATCH 160/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 15da0516165b..50108f71ad2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ ENHANCEMENTS: * config: Terraform now checks the syntax of and normalizes module source addresses (the `source` argument in `module` blocks) during configuration decoding rather than only at module installation time. This is largely just an internal refactoring, but a visible benefit of this change is that the `terraform init` messages about module downloading will now show the canonical module package address Terraform is downloading from, after interpreting the special shorthands for common cases like GitHub URLs. ([#28854](https://github.com/hashicorp/terraform/issues/28854)) * cli: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. ([#29605](https://github.com/hashicorp/terraform/issues/29605)) +* provisioner/remote-exec and provisioner/file: When using SSH agent authentication mode on Windows, Terraform can now detect and use [the Windows 10 built-in OpenSSH Client](https://devblogs.microsoft.com/powershell/using-the-openssh-beta-in-windows-10-fall-creators-update-and-windows-server-1709/)'s SSH Agent, when available, in addition to the existing support for the third-party solution [Pageant](https://documentation.help/PuTTY/pageant.html) that was already supported. [GH-29747] BUG FIXES: From 9b9b26a3cd9247c3c38aa2663c485150d3322af8 Mon Sep 17 00:00:00 2001 From: Megan Bang Date: Wed, 13 Oct 2021 13:51:07 -0500 Subject: [PATCH 161/644] update error message for invalid json --- internal/backend/remote-state/gcs/backend.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/backend/remote-state/gcs/backend.go b/internal/backend/remote-state/gcs/backend.go index 1f157779967e..0478a95ab119 100644 --- a/internal/backend/remote-state/gcs/backend.go +++ b/internal/backend/remote-state/gcs/backend.go @@ -143,7 +143,7 @@ func (b *Backend) configure(ctx context.Context) error { } if !json.Valid([]byte(contents)) { - return fmt.Errorf("contents of credentials are invalid json") + return fmt.Errorf("the string provided in credentials is neither valid json nor a valid file path") } credOptions = append(credOptions, option.WithCredentialsJSON([]byte(contents))) From bee7403f3ef64a38c4d0730157b4154eb9a09a12 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 13 Oct 2021 12:21:23 -0700 Subject: [PATCH 162/644] command/workspace_delete: Allow deleting a workspace with empty husks Previously we would reject attempts to delete a workspace if its state contained any resources at all, even if none of the resources had any resource instance objects associated with it. Nowadays there isn't any situation where the normal Terraform workflow will leave behind resource husks, and so this isn't as problematic as it might've been in the v0.12 era, but nonetheless what we actually care about for this check is whether there might be any remote objects that this state is tracking, and for that it's more precise to look for non-nil resource instance objects, rather than whole resources. This also includes some adjustments to our error messaging to give more information about the problem and to use terminology more consistent with how we currently talk about this situation in our documentation and elsewhere in the UI. We were also using the old State.HasResources method as part of some of our tests. I considered preserving it to avoid changing the behavior of those tests, but the new check seemed close enough to the intent of those tests that it wasn't worth maintaining this method that wouldn't be used in any main code anymore. I've therefore updated those tests to use the new HasResourceInstanceObjects method instead. --- internal/backend/local/backend_refresh.go | 4 +- internal/backend/remote/backend_apply_test.go | 6 +- internal/backend/testing.go | 12 +- internal/command/workspace_command.go | 9 -- internal/command/workspace_command_test.go | 13 +- internal/command/workspace_delete.go | 25 +++- internal/states/state.go | 90 ++++++++++++- internal/states/state_equal.go | 4 +- internal/states/state_test.go | 119 ++++++++++++++++++ internal/terraform/context_apply_test.go | 4 +- internal/terraform/node_data_destroy_test.go | 2 +- internal/terraform/transform_state.go | 4 +- 12 files changed, 255 insertions(+), 37 deletions(-) diff --git a/internal/backend/local/backend_refresh.go b/internal/backend/local/backend_refresh.go index 988a8b8f3759..ddbedaf19088 100644 --- a/internal/backend/local/backend_refresh.go +++ b/internal/backend/local/backend_refresh.go @@ -64,11 +64,11 @@ func (b *Local) opRefresh( // If we succeed then we'll overwrite this with the resulting state below, // but otherwise the resulting state is just the input state. runningOp.State = lr.InputState - if !runningOp.State.HasResources() { + if !runningOp.State.HasManagedResourceInstanceObjects() { diags = diags.Append(tfdiags.Sourceless( tfdiags.Warning, "Empty or non-existent state", - "There are currently no resources tracked in the state, so there is nothing to refresh.", + "There are currently no remote objects tracked in the state, so there is nothing to refresh.", )) } diff --git a/internal/backend/remote/backend_apply_test.go b/internal/backend/remote/backend_apply_test.go index 71c819b9e505..e15fe0bb37cf 100644 --- a/internal/backend/remote/backend_apply_test.go +++ b/internal/backend/remote/backend_apply_test.go @@ -1008,7 +1008,7 @@ func TestRemote_applyForceLocal(t *testing.T) { if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { t.Fatalf("expected plan summary in output: %s", output) } - if !run.State.HasResources() { + if !run.State.HasManagedResourceInstanceObjects() { t.Fatalf("expected resources in state") } } @@ -1071,7 +1071,7 @@ func TestRemote_applyWorkspaceWithoutOperations(t *testing.T) { if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { t.Fatalf("expected plan summary in output: %s", output) } - if !run.State.HasResources() { + if !run.State.HasManagedResourceInstanceObjects() { t.Fatalf("expected resources in state") } } @@ -1646,7 +1646,7 @@ func TestRemote_applyVersionCheck(t *testing.T) { output := b.CLI.(*cli.MockUi).OutputWriter.String() hasRemote := strings.Contains(output, "Running apply in the remote backend") hasSummary := strings.Contains(output, "1 added, 0 changed, 0 destroyed") - hasResources := run.State.HasResources() + hasResources := run.State.HasManagedResourceInstanceObjects() if !tc.forceLocal && tc.hasOperations { if !hasRemote { t.Errorf("missing remote backend header in output: %s", output) diff --git a/internal/backend/testing.go b/internal/backend/testing.go index 00a9c684e328..b4a76879b089 100644 --- a/internal/backend/testing.go +++ b/internal/backend/testing.go @@ -105,7 +105,7 @@ func TestBackendStates(t *testing.T, b Backend) { if err := foo.RefreshState(); err != nil { t.Fatalf("bad: %s", err) } - if v := foo.State(); v.HasResources() { + if v := foo.State(); v.HasManagedResourceInstanceObjects() { t.Fatalf("should be empty: %s", v) } @@ -116,7 +116,7 @@ func TestBackendStates(t *testing.T, b Backend) { if err := bar.RefreshState(); err != nil { t.Fatalf("bad: %s", err) } - if v := bar.State(); v.HasResources() { + if v := bar.State(); v.HasManagedResourceInstanceObjects() { t.Fatalf("should be empty: %s", v) } @@ -168,7 +168,7 @@ func TestBackendStates(t *testing.T, b Backend) { t.Fatal("error refreshing foo:", err) } fooState = foo.State() - if fooState.HasResources() { + if fooState.HasManagedResourceInstanceObjects() { t.Fatal("after writing a resource to bar, foo now has resources too") } @@ -181,7 +181,7 @@ func TestBackendStates(t *testing.T, b Backend) { t.Fatal("error refreshing foo:", err) } fooState = foo.State() - if fooState.HasResources() { + if fooState.HasManagedResourceInstanceObjects() { t.Fatal("after writing a resource to bar and re-reading foo, foo now has resources too") } @@ -194,7 +194,7 @@ func TestBackendStates(t *testing.T, b Backend) { t.Fatal("error refreshing bar:", err) } barState = bar.State() - if !barState.HasResources() { + if !barState.HasManagedResourceInstanceObjects() { t.Fatal("after writing a resource instance object to bar and re-reading it, the object has vanished") } } @@ -237,7 +237,7 @@ func TestBackendStates(t *testing.T, b Backend) { if err := foo.RefreshState(); err != nil { t.Fatalf("bad: %s", err) } - if v := foo.State(); v.HasResources() { + if v := foo.State(); v.HasManagedResourceInstanceObjects() { t.Fatalf("should be empty: %s", v) } // and delete it again diff --git a/internal/command/workspace_command.go b/internal/command/workspace_command.go index 993b2a878d6c..a0f5f542acbb 100644 --- a/internal/command/workspace_command.go +++ b/internal/command/workspace_command.go @@ -82,15 +82,6 @@ for this configuration. envDeleted = `[reset][green]Deleted workspace %q!` - envNotEmpty = ` -Workspace %[1]q is not empty. - -Deleting %[1]q can result in dangling resources: resources that -exist but are no longer manageable by Terraform. Please destroy -these resources first. If you want to delete this workspace -anyway and risk dangling resources, use the '-force' flag. -` - envWarnNotEmpty = `[reset][yellow]WARNING: %q was non-empty. The resources managed by the deleted workspace may still exist, but are no longer manageable by Terraform since the state has diff --git a/internal/command/workspace_command_test.go b/internal/command/workspace_command_test.go index 92a87c504e16..30096cb86889 100644 --- a/internal/command/workspace_command_test.go +++ b/internal/command/workspace_command_test.go @@ -391,10 +391,10 @@ func TestWorkspace_deleteWithState(t *testing.T) { // create a non-empty state originalState := &legacy.State{ Modules: []*legacy.ModuleState{ - &legacy.ModuleState{ + { Path: []string{"root"}, Resources: map[string]*legacy.ResourceState{ - "test_instance.foo": &legacy.ResourceState{ + "test_instance.foo": { Type: "test_instance", Primary: &legacy.InstanceState{ ID: "bar", @@ -414,7 +414,7 @@ func TestWorkspace_deleteWithState(t *testing.T) { t.Fatal(err) } - ui := new(cli.MockUi) + ui := cli.NewMockUi() view, _ := testView(t) delCmd := &WorkspaceDeleteCommand{ Meta: Meta{Ui: ui, View: view}, @@ -423,6 +423,13 @@ func TestWorkspace_deleteWithState(t *testing.T) { if code := delCmd.Run(args); code == 0 { t.Fatalf("expected failure without -force.\noutput: %s", ui.OutputWriter) } + gotStderr := ui.ErrorWriter.String() + if want, got := `Workspace "test" is currently tracking the following resource instances`, gotStderr; !strings.Contains(got, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, got) + } + if want, got := `- test_instance.foo`, gotStderr; !strings.Contains(got, want) { + t.Errorf("error message doesn't mention the remaining instance\nwant substring: %s\ngot:\n%s", want, got) + } ui = new(cli.MockUi) delCmd.Meta.Ui = ui diff --git a/internal/command/workspace_delete.go b/internal/command/workspace_delete.go index a29479e92554..5c826d9084e7 100644 --- a/internal/command/workspace_delete.go +++ b/internal/command/workspace_delete.go @@ -8,6 +8,7 @@ import ( "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/mitchellh/cli" "github.com/posener/complete" @@ -124,12 +125,32 @@ func (c *WorkspaceDeleteCommand) Run(args []string) int { return 1 } - hasResources := stateMgr.State().HasResources() + hasResources := stateMgr.State().HasManagedResourceInstanceObjects() if hasResources && !force { + // We'll collect a list of what's being managed here as extra context + // for the message. + var buf strings.Builder + for _, obj := range stateMgr.State().AllResourceInstanceObjectAddrs() { + if obj.DeposedKey == states.NotDeposed { + fmt.Fprintf(&buf, "\n - %s", obj.Instance.String()) + } else { + fmt.Fprintf(&buf, "\n - %s (deposed object %s)", obj.Instance.String(), obj.DeposedKey) + } + } + // We need to release the lock before exit stateLocker.Unlock() - c.Ui.Error(fmt.Sprintf(strings.TrimSpace(envNotEmpty), workspace)) + + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Workspace is not empty", + fmt.Sprintf( + "Workspace %q is currently tracking the following resource instances:%s\n\nDeleting this workspace would cause Terraform to lose track of any associated remote objects, which would then require you to delete them manually outside of Terraform. You should destroy these objects with Terraform before deleting the workspace.\n\nIf you want to delete this workspace anyway, and have Terraform forget about these managed objects, use the -force option to disable this safety check.", + workspace, buf.String(), + ), + )) + c.showDiagnostics(diags) return 1 } diff --git a/internal/states/state.go b/internal/states/state.go index 1c972d662e0f..28d962786d0c 100644 --- a/internal/states/state.go +++ b/internal/states/state.go @@ -151,15 +151,27 @@ func (s *State) EnsureModule(addr addrs.ModuleInstance) *Module { return ms } -// HasResources returns true if there is at least one resource (of any mode) -// present in the receiving state. -func (s *State) HasResources() bool { +// HasManagedResourceInstanceObjects returns true if there is at least one +// resource instance object (current or deposed) associated with a managed +// resource in the receiving state. +// +// A true result would suggest that just discarding this state without first +// destroying these objects could leave "dangling" objects in remote systems, +// no longer tracked by any Terraform state. +func (s *State) HasManagedResourceInstanceObjects() bool { if s == nil { return false } for _, ms := range s.Modules { - if len(ms.Resources) > 0 { - return true + for _, rs := range ms.Resources { + if rs.Addr.Resource.Mode != addrs.ManagedResourceMode { + continue + } + for _, is := range rs.Instances { + if is.Current != nil || len(is.Deposed) != 0 { + return true + } + } } } return false @@ -187,6 +199,74 @@ func (s *State) Resources(addr addrs.ConfigResource) []*Resource { return ret } +// AllManagedResourceInstanceObjectAddrs returns a set of addresses for all of +// the leaf resource instance objects associated with managed resources that +// are tracked in this state. +// +// This result is the set of objects that would be effectively "forgotten" +// (like "terraform state rm") if this state were totally discarded, such as +// by deleting a workspace. This function is intended only for reporting +// context in error messages, such as when we reject deleting a "non-empty" +// workspace as detected by s.HasManagedResourceInstanceObjects. +// +// The ordering of the result is meaningless but consistent. DeposedKey will +// be NotDeposed (the zero value of DeposedKey) for any "current" objects. +// This method is guaranteed to return at least one item if +// s.HasManagedResourceInstanceObjects returns true for the same state, and +// to return a zero-length slice if it returns false. +func (s *State) AllResourceInstanceObjectAddrs() []struct { + Instance addrs.AbsResourceInstance + DeposedKey DeposedKey +} { + if s == nil { + return nil + } + + // We use an unnamed return type here just because we currently have no + // general need to return pairs of instance address and deposed key aside + // from this method, and this method itself is only of marginal value + // when producing some error messages. + // + // If that need ends up arising more in future then it might make sense to + // name this as addrs.AbsResourceInstanceObject, although that would require + // moving DeposedKey into the addrs package too. + type ResourceInstanceObject = struct { + Instance addrs.AbsResourceInstance + DeposedKey DeposedKey + } + var ret []ResourceInstanceObject + + for _, ms := range s.Modules { + for _, rs := range ms.Resources { + if rs.Addr.Resource.Mode != addrs.ManagedResourceMode { + continue + } + + for instKey, is := range rs.Instances { + instAddr := rs.Addr.Instance(instKey) + if is.Current != nil { + ret = append(ret, ResourceInstanceObject{instAddr, NotDeposed}) + } + for deposedKey := range is.Deposed { + ret = append(ret, ResourceInstanceObject{instAddr, deposedKey}) + } + } + } + } + + sort.SliceStable(ret, func(i, j int) bool { + objI, objJ := ret[i], ret[j] + switch { + case !objI.Instance.Equal(objJ.Instance): + return objI.Instance.Less(objJ.Instance) + default: + return objI.DeposedKey < objJ.DeposedKey + } + }) + + return ret +} + // ResourceInstance returns the state for the resource instance with the given // address, or nil if no such resource is tracked in the state. func (s *State) ResourceInstance(addr addrs.AbsResourceInstance) *ResourceInstance { diff --git a/internal/states/state_equal.go b/internal/states/state_equal.go index 06658ef2684c..b37aba062768 100644 --- a/internal/states/state_equal.go +++ b/internal/states/state_equal.go @@ -34,10 +34,10 @@ func (s *State) ManagedResourcesEqual(other *State) bool { return true } if s == nil { - return !other.HasResources() + return !other.HasManagedResourceInstanceObjects() } if other == nil { - return !s.HasResources() + return !s.HasManagedResourceInstanceObjects() } // If we get here then both states are non-nil. diff --git a/internal/states/state_test.go b/internal/states/state_test.go index b4495c0cd04f..768772aebe44 100644 --- a/internal/states/state_test.go +++ b/internal/states/state_test.go @@ -294,6 +294,125 @@ func TestStateDeepCopy(t *testing.T) { } } +func TestStateHasResourceInstanceObjects(t *testing.T) { + providerConfig := addrs.AbsProviderConfig{ + Module: addrs.RootModule, + Provider: addrs.MustParseProviderSourceString("test/test"), + } + childModuleProviderConfig := addrs.AbsProviderConfig{ + Module: addrs.RootModule.Child("child"), + Provider: addrs.MustParseProviderSourceString("test/test"), + } + + tests := map[string]struct { + Setup func(ss *SyncState) + Want bool + }{ + "empty": { + func(ss *SyncState) {}, + false, + }, + "one current, ready object in root module": { + func(ss *SyncState) { + ss.SetResourceInstanceCurrent( + mustAbsResourceAddr("test.foo").Instance(addrs.NoKey), + &ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: ObjectReady, + }, + providerConfig, + ) + }, + true, + }, + "one current, ready object in child module": { + func(ss *SyncState) { + ss.SetResourceInstanceCurrent( + mustAbsResourceAddr("module.child.test.foo").Instance(addrs.NoKey), + &ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: ObjectReady, + }, + childModuleProviderConfig, + ) + }, + true, + }, + "one current, tainted object in root module": { + func(ss *SyncState) { + ss.SetResourceInstanceCurrent( + mustAbsResourceAddr("test.foo").Instance(addrs.NoKey), + &ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: ObjectTainted, + }, + providerConfig, + ) + }, + true, + }, + "one deposed, ready object in root module": { + func(ss *SyncState) { + ss.SetResourceInstanceDeposed( + mustAbsResourceAddr("test.foo").Instance(addrs.NoKey), + DeposedKey("uhoh"), + &ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: ObjectTainted, + }, + providerConfig, + ) + }, + true, + }, + "one empty resource husk in root module": { + func(ss *SyncState) { + // Current Terraform doesn't actually create resource husks + // as part of its everyday work, so this is a "should never + // happen" case but we'll test to make sure we're robust to + // it anyway, because this was a historical bug blocking + // "terraform workspace delete" and similar. + ss.SetResourceInstanceCurrent( + mustAbsResourceAddr("test.foo").Instance(addrs.NoKey), + &ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: ObjectTainted, + }, + providerConfig, + ) + s := ss.Lock() + delete(s.Modules[""].Resources["test.foo"].Instances, addrs.NoKey) + ss.Unlock() + }, + false, + }, + "one current data resource object in root module": { + func(ss *SyncState) { + ss.SetResourceInstanceCurrent( + mustAbsResourceAddr("data.test.foo").Instance(addrs.NoKey), + &ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: ObjectReady, + }, + providerConfig, + ) + }, + false, // data resources aren't managed resources, so they don't count + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + state := BuildState(test.Setup) + got := state.HasManagedResourceInstanceObjects() + if got != test.Want { + t.Errorf("wrong result\nstate content: (using legacy state string format; might not be comprehensive)\n%s\n\ngot: %t\nwant: %t", state, got, test.Want) + } + }) + } + +} + func TestState_MoveAbsResource(t *testing.T) { // Set up a starter state for the embedded tests, which should start from a copy of this state. state := NewState() diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 4f6a7df89904..28c5c788b502 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -5743,7 +5743,7 @@ func TestContext2Apply_destroyModuleWithAttrsReferencingResource(t *testing.T) { } //Test that things were destroyed - if state.HasResources() { + if state.HasManagedResourceInstanceObjects() { t.Fatal("expected empty state, got:", state) } } @@ -8661,7 +8661,7 @@ func TestContext2Apply_providerWithLocals(t *testing.T) { t.Fatalf("err: %s", diags.Err()) } - if state.HasResources() { + if state.HasManagedResourceInstanceObjects() { t.Fatal("expected no state, got:", state) } diff --git a/internal/terraform/node_data_destroy_test.go b/internal/terraform/node_data_destroy_test.go index 7f06b4d4b737..f399ee4183c4 100644 --- a/internal/terraform/node_data_destroy_test.go +++ b/internal/terraform/node_data_destroy_test.go @@ -42,7 +42,7 @@ func TestNodeDataDestroyExecute(t *testing.T) { } // verify resource removed from state - if state.HasResources() { + if state.HasManagedResourceInstanceObjects() { t.Fatal("resources still in state after NodeDataDestroy.Execute") } } diff --git a/internal/terraform/transform_state.go b/internal/terraform/transform_state.go index 098768ca6f94..1ca060a88aad 100644 --- a/internal/terraform/transform_state.go +++ b/internal/terraform/transform_state.go @@ -26,8 +26,8 @@ type StateTransformer struct { } func (t *StateTransformer) Transform(g *Graph) error { - if !t.State.HasResources() { - log.Printf("[TRACE] StateTransformer: state is empty, so nothing to do") + if t.State == nil { + log.Printf("[TRACE] StateTransformer: state is nil, so nothing to do") return nil } From c76f54781a2daa3c87ed496f294a206d93ae8f2a Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 13 Oct 2021 13:56:47 -0700 Subject: [PATCH 163/644] Update CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 50108f71ad2d..cf33fafda12d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,8 @@ NEW FEATURES: ENHANCEMENTS: * config: Terraform now checks the syntax of and normalizes module source addresses (the `source` argument in `module` blocks) during configuration decoding rather than only at module installation time. This is largely just an internal refactoring, but a visible benefit of this change is that the `terraform init` messages about module downloading will now show the canonical module package address Terraform is downloading from, after interpreting the special shorthands for common cases like GitHub URLs. ([#28854](https://github.com/hashicorp/terraform/issues/28854)) -* cli: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. ([#29605](https://github.com/hashicorp/terraform/issues/29605)) +* `terraform plan` and `terraform apply`: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. ([#29605](https://github.com/hashicorp/terraform/issues/29605)) +* `terraform workspace delete`: will now allow deleting a workspace whose state contains only data resource instances and output values, without running `terraform destroy` first. Previously the presence of data resources would require using `-force` to override the safety check guarding against accidentally forgetting about remote objects, but a data resource is not responsible for the management of its associated remote object(s) anyway. [GH-29754] * provisioner/remote-exec and provisioner/file: When using SSH agent authentication mode on Windows, Terraform can now detect and use [the Windows 10 built-in OpenSSH Client](https://devblogs.microsoft.com/powershell/using-the-openssh-beta-in-windows-10-fall-creators-update-and-windows-server-1709/)'s SSH Agent, when available, in addition to the existing support for the third-party solution [Pageant](https://documentation.help/PuTTY/pageant.html) that was already supported. [GH-29747] BUG FIXES: From 5ffa0839f9fe18087b9c51b100acb2fcd15c848d Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 13 Oct 2021 17:07:26 -0400 Subject: [PATCH 164/644] only check serial when applying the first plan Ensure that we still check for a stale plan even when it was created with no previous state. Create separate errors for incorrect lineage vs incorrect serial. To prevent confusion when applying a first plan multiple times, only report it as a stale plan rather than different lineage. --- internal/backend/local/backend_local.go | 29 ++++++++++++++++++------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/internal/backend/local/backend_local.go b/internal/backend/local/backend_local.go index 209757e43375..6082bfdf6c61 100644 --- a/internal/backend/local/backend_local.go +++ b/internal/backend/local/backend_local.go @@ -290,14 +290,27 @@ func (b *Local) localRunForPlanFile(op *backend.Operation, pf *planfile.Reader, // has changed since the plan was created. (All of the "real-world" // state manager implementations support this, but simpler test backends // may not.) - if currentStateMeta.Lineage != "" && priorStateFile.Lineage != "" { - if priorStateFile.Serial != currentStateMeta.Serial || priorStateFile.Lineage != currentStateMeta.Lineage { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Saved plan is stale", - "The given plan file can no longer be applied because the state was changed by another operation after the plan was created.", - )) - } + + // Because the plan always contains a state, even if it is empty, the + // first plan to be applied will have empty snapshot metadata. In this + // case we compare only the serial in order to provide a more correct + // error. + firstPlan := priorStateFile.Lineage == "" && priorStateFile.Serial == 0 + + switch { + case !firstPlan && priorStateFile.Lineage != currentStateMeta.Lineage: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Saved plan does not match the given state", + "The given plan file can not be applied because it was created from a different state lineage.", + )) + + case priorStateFile.Serial != currentStateMeta.Serial: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Saved plan is stale", + "The given plan file can no longer be applied because the state was changed by another operation after the plan was created.", + )) } } // When we're applying a saved plan, the input state is the "prior state" From 9c80574417f48d34313d7608ec56d48ee51f8bdd Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 13 Oct 2021 17:28:14 -0400 Subject: [PATCH 165/644] test planfile may need to have a specific lineage In order to test applying a plan from an existing state, we need to be able to inject the state meta into the planfile. --- internal/command/apply_test.go | 19 ++++++++++++++++--- internal/command/command_test.go | 10 ++++++++-- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/internal/command/apply_test.go b/internal/command/apply_test.go index 750c6b6bf336..b2306623cb11 100644 --- a/internal/command/apply_test.go +++ b/internal/command/apply_test.go @@ -710,7 +710,6 @@ func TestApply_plan(t *testing.T) { } func TestApply_plan_backup(t *testing.T) { - planPath := applyFixturePlanFile(t) statePath := testTempFile(t) backupPath := testTempFile(t) @@ -724,11 +723,17 @@ func TestApply_plan_backup(t *testing.T) { } // create a state file that needs to be backed up - err := statemgr.NewFilesystem(statePath).WriteState(states.NewState()) + fs := statemgr.NewFilesystem(statePath) + fs.StateSnapshotMeta() + err := fs.WriteState(states.NewState()) if err != nil { t.Fatal(err) } + // the plan file must contain the metadata from the prior state to be + // backed up + planPath := applyFixturePlanFileMatchState(t, fs.StateSnapshotMeta()) + args := []string{ "-state", statePath, "-backup", backupPath, @@ -2280,6 +2285,13 @@ func applyFixtureProvider() *terraform.MockProvider { // a single change to create the test_instance.foo that is included in the // "apply" test fixture, returning the location of that plan file. func applyFixturePlanFile(t *testing.T) string { + return applyFixturePlanFileMatchState(t, statemgr.SnapshotMeta{}) +} + +// applyFixturePlanFileMatchState creates a planfile like applyFixturePlanFile, +// but inserts the state meta information if that plan must match a preexisting +// state. +func applyFixturePlanFileMatchState(t *testing.T, stateMeta statemgr.SnapshotMeta) string { _, snap := testModuleWithSnapshot(t, "apply") plannedVal := cty.ObjectVal(map[string]cty.Value{ "id": cty.UnknownVal(cty.String), @@ -2310,11 +2322,12 @@ func applyFixturePlanFile(t *testing.T) string { After: plannedValRaw, }, }) - return testPlanFile( + return testPlanFileMatchState( t, snap, states.NewState(), plan, + stateMeta, ) } diff --git a/internal/command/command_test.go b/internal/command/command_test.go index a9ba2a044e0a..4b6fcf311c77 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -229,15 +229,21 @@ func testPlan(t *testing.T) *plans.Plan { } func testPlanFile(t *testing.T, configSnap *configload.Snapshot, state *states.State, plan *plans.Plan) string { + return testPlanFileMatchState(t, configSnap, state, plan, statemgr.SnapshotMeta{}) +} + +func testPlanFileMatchState(t *testing.T, configSnap *configload.Snapshot, state *states.State, plan *plans.Plan, stateMeta statemgr.SnapshotMeta) string { t.Helper() stateFile := &statefile.File{ - Lineage: "", + Lineage: stateMeta.Lineage, + Serial: stateMeta.Serial, State: state, TerraformVersion: version.SemVer, } prevStateFile := &statefile.File{ - Lineage: "", + Lineage: stateMeta.Lineage, + Serial: stateMeta.Serial, State: state, // we just assume no changes detected during refresh TerraformVersion: version.SemVer, } From 88bddd714328ed9409577d085cf773ac00c13dc7 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 13 Oct 2021 17:30:31 -0700 Subject: [PATCH 166/644] go.mod: go get go get golang.org/x/tools@v0.1.7 This also transitively upgrades golang.org/x/sys and golang.org/x/net, but there do not seem to be any significant changes compared to the commits we were previously using. --- go.mod | 6 +++--- go.sum | 10 +++++++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/go.mod b/go.mod index 3dd2135813ff..e4a2e970cef4 100644 --- a/go.mod +++ b/go.mod @@ -84,12 +84,12 @@ require ( go.etcd.io/etcd v0.5.0-alpha.5.0.20210428180535-15715dcf1ace golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 golang.org/x/mod v0.4.2 - golang.org/x/net v0.0.0-20210614182718-04defd469f4e + golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 - golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c + golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf golang.org/x/text v0.3.6 - golang.org/x/tools v0.1.4 + golang.org/x/tools v0.1.7 google.golang.org/api v0.44.0-impersonate-preview google.golang.org/grpc v1.36.0 google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 diff --git a/go.sum b/go.sum index bc0ba56870d8..6588616d1360 100644 --- a/go.sum +++ b/go.sum @@ -650,6 +650,7 @@ github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9de github.com/yuin/goldmark v1.1.32/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/zclconf/go-cty v1.0.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.1.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.2.0/go.mod h1:hOPWgoHbaTUnI5k4D2ld+GRpFJSCe6bCM7m1q/N4PQ8= @@ -777,8 +778,9 @@ golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= -golang.org/x/net v0.0.0-20210614182718-04defd469f4e h1:XpT3nA5TvE525Ne3hInMh6+GETgn27Zfm9dxsThnX2Q= golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI= +golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190402181905-9f3314589c9a/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -861,8 +863,9 @@ golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e h1:WUoyKPm6nCo1BnNUvPGnFG3T5DUVem42yDJZZ4CNxMA= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf h1:MZ2shdL+ZM/XzY3ZGOnh4Nlpnxz5GSOhOmtHo3iPU6M= @@ -935,8 +938,9 @@ golang.org/x/tools v0.0.0-20201201161351-ac6f37ff4c2a/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= -golang.org/x/tools v0.1.4 h1:cVngSRcfgyZCzys3KYOpCFa+4dqX/Oub9tAq00ttGVs= golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.7 h1:6j8CgantCy3yc8JGBqkDLMKWqZ0RDU2g1HVgacojGWQ= +golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= From 8946d7ff206dfe91c5d2efef7c91ed04c327c27f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 14 Oct 2021 00:52:36 +0000 Subject: [PATCH 167/644] build(deps): bump github.com/golang/protobuf from 1.5.0 to 1.5.2 Bumps [github.com/golang/protobuf](https://github.com/golang/protobuf) from 1.5.0 to 1.5.2. - [Release notes](https://github.com/golang/protobuf/releases) - [Commits](https://github.com/golang/protobuf/compare/v1.5.0...v1.5.2) --- updated-dependencies: - dependency-name: github.com/golang/protobuf dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/go.mod b/go.mod index e4a2e970cef4..eab2aac97c6d 100644 --- a/go.mod +++ b/go.mod @@ -23,7 +23,7 @@ require ( github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 github.com/go-test/deep v1.0.3 github.com/golang/mock v1.5.0 - github.com/golang/protobuf v1.5.0 + github.com/golang/protobuf v1.5.2 github.com/google/go-cmp v0.5.5 github.com/google/uuid v1.2.0 github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 diff --git a/go.sum b/go.sum index 6588616d1360..e14e6617a6a8 100644 --- a/go.sum +++ b/go.sum @@ -259,8 +259,9 @@ github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvq github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8= github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= -github.com/golang/protobuf v1.5.0 h1:LUVKkCeviFUMKqHa4tXIIij/lbhnMbP7Fn5wKdKkRh4= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= +github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/google/btree v0.0.0-20160524151835-7d79101e329e/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0 h1:0udJVsspx3VBr5FwtLhQQtuAsVc79tTq0ocGIPAU6qo= @@ -1047,6 +1048,7 @@ google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpAD google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGjtUeSXeh4= google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= google.golang.org/protobuf v1.27.1 h1:SnqbnDw1V7RiZcXPx5MEeqPv2s79L9i7BJUlG/+RurQ= google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= From 39779e70210a2e4fedfb5a6ef51ce1a084fd45f1 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 14 Oct 2021 09:33:54 -0700 Subject: [PATCH 168/644] backend/remote-state/cos: Don't use github.com/likexian/gokit We don't use this library anywhere else in Terraform, and this backend was using it only for trivial helpers that are easy to express inline anyway. The new direct code is also type-checkable, whereas these helper functions seem to be written using reflection. This gives us one fewer dependency to worry about and makes the test code for this backend follow a similar assertions style as the rest of this codebase. --- go.mod | 1 - go.sum | 8 --- .../backend/remote-state/cos/backend_state.go | 11 ++- .../backend/remote-state/cos/backend_test.go | 67 +++++++++++++------ 4 files changed, 57 insertions(+), 30 deletions(-) diff --git a/go.mod b/go.mod index eab2aac97c6d..60b751726eff 100644 --- a/go.mod +++ b/go.mod @@ -51,7 +51,6 @@ require ( github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926 github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 github.com/lib/pq v1.10.3 - github.com/likexian/gokit v0.20.15 github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 github.com/masterzen/winrm v0.0.0-20200615185753-c42b5136ff88 github.com/mattn/go-isatty v0.0.12 diff --git a/go.sum b/go.sum index e14e6617a6a8..7d2eaf9415b0 100644 --- a/go.sum +++ b/go.sum @@ -460,14 +460,6 @@ github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= github.com/lib/pq v1.10.3 h1:v9QZf2Sn6AmjXtQeFpdoq/eaNtYP6IN+7lcrygsIAtg= github.com/lib/pq v1.10.3/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= -github.com/likexian/gokit v0.0.0-20190309162924-0a377eecf7aa/go.mod h1:QdfYv6y6qPA9pbBA2qXtoT8BMKha6UyNbxWGWl/9Jfk= -github.com/likexian/gokit v0.0.0-20190418170008-ace88ad0983b/go.mod h1:KKqSnk/VVSW8kEyO2vVCXoanzEutKdlBAPohmGXkxCk= -github.com/likexian/gokit v0.0.0-20190501133040-e77ea8b19cdc/go.mod h1:3kvONayqCaj+UgrRZGpgfXzHdMYCAO0KAt4/8n0L57Y= -github.com/likexian/gokit v0.20.15 h1:DgtIqqTRFqtbiLJFzuRESwVrxWxfs8OlY6hnPYBa3BM= -github.com/likexian/gokit v0.20.15/go.mod h1:kn+nTv3tqh6yhor9BC4Lfiu58SmH8NmQ2PmEl+uM6nU= -github.com/likexian/simplejson-go v0.0.0-20190409170913-40473a74d76d/go.mod h1:Typ1BfnATYtZ/+/shXfFYLrovhFyuKvzwrdOnIDHlmg= -github.com/likexian/simplejson-go v0.0.0-20190419151922-c1f9f0b4f084/go.mod h1:U4O1vIJvIKwbMZKUJ62lppfdvkCdVd2nfMimHK81eec= -github.com/likexian/simplejson-go v0.0.0-20190502021454-d8787b4bfa0b/go.mod h1:3BWwtmKP9cXWwYCr5bkoVDEfLywacOv0s06OBEDpyt8= github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 h1:wnfcqULT+N2seWf6y4yHzmi7GD2kNx4Ute0qArktD48= github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82/go.mod h1:y54tfGmO3NKssKveTEFFzH8C/akrSOy/iW9qEAUDV84= github.com/mailru/easyjson v0.0.0-20160728113105-d5b7844b561a/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= diff --git a/internal/backend/remote-state/cos/backend_state.go b/internal/backend/remote-state/cos/backend_state.go index c9df2a6c1815..ab92cfb7c0e8 100644 --- a/internal/backend/remote-state/cos/backend_state.go +++ b/internal/backend/remote-state/cos/backend_state.go @@ -11,7 +11,6 @@ import ( "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statemgr" - "github.com/likexian/gokit/assert" ) // Define file suffix @@ -88,7 +87,15 @@ func (b *Backend) StateMgr(name string) (statemgr.Full, error) { return nil, err } - if !assert.IsContains(ws, name) { + exists := false + for _, candidate := range ws { + if candidate == name { + exists = true + break + } + } + + if !exists { log.Printf("[DEBUG] workspace %v not exists", name) // take a lock on this state while we write it diff --git a/internal/backend/remote-state/cos/backend_test.go b/internal/backend/remote-state/cos/backend_test.go index f527d4a5a5cd..eb9038ff35f7 100644 --- a/internal/backend/remote-state/cos/backend_test.go +++ b/internal/backend/remote-state/cos/backend_test.go @@ -9,7 +9,6 @@ import ( "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/states/remote" - "github.com/likexian/gokit/assert" ) const ( @@ -38,12 +37,18 @@ func TestStateFile(t *testing.T) { } for _, c := range cases { - b := &Backend{ - prefix: c.prefix, - key: c.key, - } - assert.Equal(t, b.stateFile(c.stateName), c.wantStateFile) - assert.Equal(t, b.lockFile(c.stateName), c.wantLockFile) + t.Run(fmt.Sprintf("%s %s %s", c.prefix, c.key, c.stateName), func(t *testing.T) { + b := &Backend{ + prefix: c.prefix, + key: c.key, + } + if got, want := b.stateFile(c.stateName), c.wantStateFile; got != want { + t.Errorf("wrong state file name\ngot: %s\nwant: %s", got, want) + } + if got, want := b.lockFile(c.stateName), c.wantLockFile; got != want { + t.Errorf("wrong lock file name\ngot: %s\nwant: %s", got, want) + } + }) } } @@ -56,10 +61,14 @@ func TestRemoteClient(t *testing.T) { defer teardownBackend(t, be) ss, err := be.StateMgr(backend.DefaultStateName) - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } rs, ok := ss.(*remote.State) - assert.True(t, ok) + if !ok { + t.Fatalf("wrong state manager type\ngot: %T\nwant: %T", ss, rs) + } remote.TestClient(t, rs.Client) } @@ -74,10 +83,14 @@ func TestRemoteClientWithPrefix(t *testing.T) { defer teardownBackend(t, be) ss, err := be.StateMgr(backend.DefaultStateName) - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } rs, ok := ss.(*remote.State) - assert.True(t, ok) + if !ok { + t.Fatalf("wrong state manager type\ngot: %T\nwant: %T", ss, rs) + } remote.TestClient(t, rs.Client) } @@ -91,10 +104,14 @@ func TestRemoteClientWithEncryption(t *testing.T) { defer teardownBackend(t, be) ss, err := be.StateMgr(backend.DefaultStateName) - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } rs, ok := ss.(*remote.State) - assert.True(t, ok) + if !ok { + t.Fatalf("wrong state manager type\ngot: %T\nwant: %T", ss, rs) + } remote.TestClient(t, rs.Client) } @@ -122,10 +139,14 @@ func TestRemoteLocks(t *testing.T) { } c0, err := remoteClient() - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } c1, err := remoteClient() - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } remote.TestRemoteLocks(t, c0, c1) } @@ -203,10 +224,14 @@ func setupBackend(t *testing.T, bucket, prefix, key string, encrypt bool) backen be := b.(*Backend) c, err := be.client("tencentcloud") - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } err = c.putBucket() - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } return b } @@ -215,10 +240,14 @@ func teardownBackend(t *testing.T, b backend.Backend) { t.Helper() c, err := b.(*Backend).client("tencentcloud") - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } err = c.deleteBucket(true) - assert.Nil(t, err) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } } func bucketName(t *testing.T) string { From 3c64b9b6048d5ad68564d708a0aa0e3ab1cc6436 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 14 Oct 2021 14:43:48 -0400 Subject: [PATCH 169/644] update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf33fafda12d..1bdc81a952ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,9 @@ ENHANCEMENTS: BUG FIXES: * core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) +* core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources [GH-29682] * cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) +* cli: Prevent applying a stale planfile when there was no previous state [GH-29755] ## Previous Releases From e111c103b80a45e3659833f7f070391becc472f0 Mon Sep 17 00:00:00 2001 From: Chris Griggs Date: Fri, 15 Oct 2021 10:55:07 -0700 Subject: [PATCH 170/644] [Website]Terraform Integration Program (#29763) * add new guide doc * update word doc * assign imange files * add fmting changes * formatting * some more changes * Fix Title * Update website/guides/terraform-integration-program.html.md We can remove, I was hoping to have "*Currently, pre-apply..." be in Bbold, but it looks like it doesnt render that way. So we can exclude the asterisk Co-authored-by: Jeff Escalante * Fix spacing and remove unused html paragraph * Update website/guides/terraform-integration-program.html.md Good changes, thanks for simplifying it. Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Agreed Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Agreed Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Agreed Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> * Adding suggested changes from PR. Removing example sentence. (Internal request) * Move note section above badge * Add spacing * Update website/guides/terraform-integration-program.html.md Approved Co-authored-by: Jeff Escalante Co-authored-by: Jeff Escalante Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- .../terraform-integration-program.html.md | 235 ++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 website/guides/terraform-integration-program.html.md diff --git a/website/guides/terraform-integration-program.html.md b/website/guides/terraform-integration-program.html.md new file mode 100644 index 000000000000..56dea778e79e --- /dev/null +++ b/website/guides/terraform-integration-program.html.md @@ -0,0 +1,235 @@ +--- +layout: "extend" +page_title: "Terraform Integration Program" +sidebar_current: "guides-terraform-integration-program" +description: The Terraform Integration Program allows prospect partners to create and publish Terraform integrations that have been verified by HashiCorp. +--- + +# Terraform Integration Program + +The Terraform Integration Program facilitates prospect partners in creating and publishing Terraform integrations that have been verified by HashiCorp. + +## Terraform Editions + +Terraform is an infrastructure as code (IaC) tool that allows you to build, change, and version infrastructure safely and efficiently. This includes low-level components such as compute instances, storage, and networking, as well as high-level components such as DNS entries, SaaS features, etc. Terraform can manage both existing service providers and custom in-house solutions. + +HashiCorp offers three editions of Terraform: Open Source, Terraform Cloud, and Terraform Enterprise. + +- [Terraform Open Source](https://www.terraform.io/) provides a consistent CLI workflow to manage hundreds of cloud services. Terraform codifies cloud APIs into declarative configuration files. +- [Terraform Cloud (TFC)](https://www.terraform.io/cloud) is a free to use, self-service SaaS platform that extends the capabilities of the open source Terraform CLI. It adds automation and collaboration features, and performs Terraform functionality remotely, making it ideal for collaborative and production environments. Terraform Cloud is available as a hosted service at https://app.terraform.io. Small teams can sign up for free to connect Terraform to version control, share variables, run Terraform in a stable remote environment, and securely store remote state. Paid tiers allow you to add more than five users, create teams with different levels of permissions, enforce policies before creating infrastructure, and collaborate more effectively. +- [Terraform Enterprise (TFE)](https://www.terraform.io/docs/enterprise/index.html) is our self-hosted distribution of Terraform Cloud with advanced security and compliance features. It offers enterprises a private instance that includes the advanced features available in Terraform Cloud. + +## Types of Terraform Integrations + +The Terraform ecosystem is designed to enable users to apply Terraform across different use cases and environments. The Terraform Integration Program current supports both workflow and integration partners (details below). Some partners can be both, depending on their use cases. + +- **Workflow Partners** build integrations for Terraform Cloud and/or Terraform Enterprise. Ideally, these partners are seeking to enable customers to use their existing platform within a Terraform Run. + +- **Infrastructure Partners** empower customers to leverage Terraform to manage resources exposed by their platform APIs. These are accessible to users of all Terraform editions. + +Our Workflow Partners typically have the following use cases: + +- **Code Scanning:** These partners provide tooling to review infrastructure as code configurations to prevent errors or security issues. +- **Cost Estimation:** These partners drive cost estimation of new deployment based on historical deployments. +- **Monitoring:** These partners provide performance visibility. +- **Zero Trust Security:** These partners help users create configurations to verify connections prior to providing access to an organization’s systems. +- **Audit:** These partners focus on maintaining code formatting, preventing security threats, and performing additional code analysis. +- **ITSM (Information Technology Service Management):** These partners focus on implementation, deployment, and delivery of IT workflows. +- **SSO (Single Sign On):** These partners focus on authentication for end users to securely sign on. +- **CI/CD:** These partners focus on continuous integration and continuous delivery/deployment. +- **VCS:** These partners focus on tracking and managing software code changes. + +Most workflow partners integrate with the Terraform workflow itself. Run tasks allow Terraform Cloud to execute tasks in external systems at specific points in the Terraform Cloud run lifecycle. This offers much more extensibility to Terraform Cloud customers, enabling them to integrate your services into the Terraform Cloud workflow. The beta release of this feature allows users to add and execute these tasks during the new pre-apply stage which exists in between the plan and apply stages. Eventually, we will open the entire workflow to Terraform Cloud users, including the pre-plan and post apply stages. Reference the [Terraform Cloud Integrations documentation](https://www.terraform.io/guides/terraform-integration-program.html#terraform-cloud-integrations) for more details. + +![Integration program diagram](/assets/images/docs/terraform-integration-program-diagram.png) + +Our Infrastructure Partners typically have the following use cases: + +- **Public Cloud:** These are large-scale, global cloud providers that offer a range of services including IaaS, SaaS, and PaaS. +- **Container Orchestration:** These partners help with container provisioning and deployment. +- **IaaS (Infrastructure-as-a-Service):** These are infrastructure and IaaS providers that offer solutions such as storage, networking, and virtualization. +- **Security & Authentication:** These are partners with authentication and security monitoring platforms. +- **Asset Management:** These partners offer asset management of key organization and IT resources, including software licenses, hardware assets, and cloud resources. +- **CI/CD:** These partners focus on continuous integration and continuous delivery/deployment. +- **Logging & Monitoring:** These partners offer the capability to configure and manage services such as loggers, metric tools, and monitoring services. +- **Utility:** These partners offer helper functionality, such as random value generation, file creation, http interactions, and time-based resources. +- **Cloud Automation:** These partners offer specialized cloud infrastructure automation management capabilities such as configuration management. +- **Data Management:** These partners focus on data center storage, backup, and recovery solutions. +- **Networking:** These partners integrate with network-specific hardware and virtualized products such as routing, switching, firewalls, and SD-WAN solutions. +- **VCS (Version Control Systems):** These partners focus on VCS (Version Control System) projects, teams, and repositories from within Terraform. +- **Comms & Messaging:** These partners integrate with communication, email, and messaging platforms. +- **Database:** These partners offer capabilities to provision and configure your database resources. +- **PaaS (Platform-as-a-Service):** These are platform and PaaS providers that offer a range of hardware, software, and application development tools. This category includes smaller-scale providers and those with more specialized offerings. +- **Web Services:** These partners focus on web hosting, web performance, CDN and DNS services. + +Infrastructure partners integrate by building and publishing a plugin called a Terraform [provider](https://www.terraform.io/docs/language/providers/index.html). Providers are executable binaries written in Go that communicate with Terraform Core over an RPC interface. The provider acts as a translation layer for transactions with external APIs, such as a public cloud service (AWS, GCP, Azure), a PaaS service (Heroku), a SaaS service (DNSimple, CloudFlare), or on-prem resources (vSphere). Providers work across Terraform OSS, Terraform Cloud and Terraform Enterprise. Refer to the [Terraform Provider Integrations documentation](https://www.terraform.io/guides/terraform-integration-program.html#terraform-provider-integrations) for more detail. + + + +## Terraform Provider Integrations + +You can follow the five steps. below to develop your provider alongside HashiCorp. This ensures that you can publish new versions with Terraform quickly and efficiently. + +![Provider Development Process](/assets/images/docs/provider-program-steps.png) + +1. **Prepare**: Develop integration using included resources +2. **Publish**: Publish provider to the Registry or plugin documentation +3. **Apply**: Apply to Technology Partnership Program +4. **Verify**: Verify integration with HashiCorp Alliances team +5. **Support**: Vendor provides ongoing maintenance and support + +We encourage you to follow the tasks associated with each step fully to streamline the development process and minimize rework. + +All providers integrate into and operate with Terraform exactly the same way. The table below is intended to help users understand who develops, and maintains a particular provider. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TierDescriptionNamespace
    Official providers are owned and maintained by HashiCorp hashicorp
    Verified providers are owned and maintained by third-party technology partners. Providers in this tier indicate HashiCorp has verified the authenticity of the Provider’s publisher, and that the partner is a member of the HashiCorp Technology Partner Program.Third-party organization, e.g. cisco/aci
    Community providers are published to the Terraform Registry by individual maintainers, groups of maintainers, or other members of the Terraform community.
    Maintainer’s individual or organization account, e.g. cyrilgdn/postgresql
    Archived Providers are Official or Verified Providers that are no longer maintained by HashiCorp or the community. This may occur if an API is deprecated or interest was low.hashicorp or third-party
    + + +### 1. Prepare +To get started with the Terraform provider development, we recommend reviewing and following the articles listed below. +#### Provider Development Kit + +a) Writing custom providers [guide](https://www.terraform.io/guides/writing-custom-terraform-providers.html) + +b) Creating a Terraform Provider for Just About Anything: [video](https://www.youtube.com/watch?v=noxwUVet5RE) + +c) Sample provider developed by [partner](http://container-solutions.com/write-terraform-provider-part-1/) + +d) Example provider for reference: [AWS](https://github.com/terraform-providers/terraform-provider-aws), [OPC](https://github.com/terraform-providers/terraform-provider-opc) + +e) Contributing to Terraform [guidelines](https://github.com/hashicorp/terraform/blob/master/.github/CONTRIBUTING.md) + +f) HashiCorp developer [forum](https://discuss.hashicorp.com/c/terraform-providers/tf-plugin-sdk/43) + +Please submit questions or suggestions about the Terraform SDK and provider development to the HashiCorp Terraform plugin SDK forum. If you are new to provider development and would like assistance, you can leverage one of the following development agencies that have developed Terraform providers in the past: + +| Partner | Email | Website | +|--------------------|:-----------------------------|:---------------------| +| Crest Data Systems | malhar@crestdatasys.com | www.crestdatasys.com | +| DigitalOnUs | hashicorp@digitalonus.com | www.digitalonus.com | +| Akava | bd@akava.io | www.akava.io | +| OpenCredo | hashicorp@opencredo.com | www.opencredo.com | + +#### Provider License + +All Terraform providers listed as Verified must contain one of the following open source licenses: + +- CDDL 1.0, 2.0 +- CPL 1.0 +- Eclipse Public License (EPL) 1.0 +- MPL 1.0, 1.1, 2.0 +- PSL 2.0 +- Ruby's Licensing +- AFL 2.1, 3.0 +- Apache License 2.0 +- Artistic License 1.0, 2.0 +- Apache Software License (ASL) 1.1 +- Boost Software License +- BSD, BSD 3-clause, "BSD-new" +- CC-BY +- Microsoft Public License (MS-PL) +- MIT +### 2. Publish + +After your provider is complete and ready to release, you can publish it the integration to the [Terraform Registry](https://registry.terraform.io/). This makes it publicly available for all Terraform users. + +Follow the [Terraform Registry publishing documentation](https://www.terraform.io/docs/registry/providers/publishing.html) and review the [provider publishing learn guide](https://learn.hashicorp.com/tutorials/terraform/provider-release-publish?in=terraform/providers). If your company has multiple products with separate providers, we recommend publishing them under the same Github organization to help with discoverability. + +Once completed, your provider will be visible in the Terraform Registry and available to use in Terraform. Please confirm that everything looks correct and that documentation is rendering properly. + +### 3. Apply + +After your provider is published, connect with HashiCorp Alliances to onboard your integration to the HashiCorp technology ecosystem or [apply to become a technology partner](https://www.hashicorp.com/ecosystem/become-a-partner/#technology). + +### 4. Verify + +Work with your HashiCorp Alliances representative to verify the plugin within the Registry and become listed as an HashiCorp technology partner integration on HashiCorp website. + +### 5. Support + +Getting a new provider built and published to the Terraform Registry is just the first step towards enabling your users with a quality Terraform integration. Once a verified provider has been published, on-going effort is required to maintain the provider. + +HashiCorp Terraform has an extremely wide community of users and contributors and we encourage everyone to report issues however small, as well as help resolve them when possible. We expect that all verified provider publishers will continue to maintain the provider and address any issues users report in a timely manner. This includes resolving all critical issues within 48 hours and all other issues within 5 business days. HashiCorp reserves the right to remove verified status from any integration that is no longer being maintained. + +Vendors who choose not to support their provider and prefer to make it a community-supported provider will no longer be listed as Verified. + +## Terraform Cloud Integrations + +Run tasks allow Terraform Cloud to execute tasks in external systems at specific points in the Terraform Cloud run lifecycle. The beta release of this feature allows users to add and execute these tasks during the new pre-apply stage that exists in between the plan and apply stages. Tasks are executed by sending an API payload to the external system. This payload contains a collection of run-related information and a callback URL which the external system can use to send updates back to Terraform Cloud. + +The external system can then use this run information and respond back to Terraform Cloud with a passed or failed status. Terraform Cloud uses this status response to determine if a run should proceed, based on the task's enforcement settings within a workspace. + +Partners who successfully complete the Terraform Cloud Integration Checklist obtain a Terraform Cloud badge. This signifies HashiCorp has verified the integration and the partner is a member of the HashiCorp Technology Partner Program. + +- Note: Currently, pre-apply is the only integration phase available at this time. As of September 2021, run tasks are available only as a beta feature, are subject to change, and not all customers will see this functionality in their Terraform Cloud organization since this is currently enabled by default for our business tier customers of Terraform Cloud. If you have a customer that is interested in run tasks and are not a current Terraform Cloud for Business customer, customers can [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSf3JJIkU05bKWov2wXa9c-QV524WNaHuGIk7xjHnwl5ceGw2A/viewform). + +![TFC Badge](/assets/images/docs/tfc-badge.png) + +The above badge will help drive visibility for the partner as well as provide better differentiation for joint customers. This badge will be available for partners to use at their digital properties (as per guidelines in the technology partner guide that partners receive when they join HashiCorp’s technology partner program). + +The Terraform Cloud Integration program has the following five steps. + +![RunTask Program Process](/assets/images/docs/runtask-program-steps.png) + +1. **Engage**: Sign up for the Technology Partner +Program +2. **Develop & Test**: Understand and build using the API integration for Run Tasks +3. **Review**: Review integration with HashiCorp Alliances team +4. **Release**: Provide documentation for your Integration +5. **Support**: Vendor provides ongoing maintanance and support + +### 1. Engage + +For partners who are new to working with Hashicorp, we recommend [signing up for our Technology Partner Program](https://www.hashicorp.com/go/tech-partner). To understand more about the program, check out our “[Become a Partner](https://www.hashicorp.com/partners/become-a-partner)” page. + +### 2. Develop & Test +Partners should build an integration using [Run Task APIs in Terraform Cloud](https://www.terraform.io/docs/cloud/api/run-tasks.html). To better understand how run Task enhances the workflow, see diagram listed below and check out our [announcement about Terraform run Task](https://www.hashicorp.com/blog/terraform-cloud-run-tasks-beta-now-available). [Snyk](https://docs.snyk.io/features/integrations/ci-cd-integrations/integrating-snyk-with-terraform-cloud), for example, created an integration to detect configuration anomalies in code while reducing risk to the infrastructure. For additional API resources, [click here](https://www.terraform.io/docs/cloud/api/index.html). +**Currently, pre-apply is the only integration phase available.** + +![RunTask Diagram](/assets/images/docs/runtask-diagram.png) + +### 3. Review + +Schedule time with your Partner Alliance manager to review your integration. The review should include enabling the integration on the partner’s platform and Terraform Cloud, explaining the use case for the integration, and a live demonstration of the functionality. If you are unable to engage with your Partner Alliances manager, you can also reach out to [technologypartners@hashicorp.com](technologypartners@hashicorp.com). + +### 4. Release + +We add new partners to the [Terraform Run Task page](https://www.terraform.io/docs/cloud/integrations/run-tasks/index.html#run-tasks-technology-partners) after the integration review and documentation is complete. On this page, you will provide a two-line summary about your integration(s). If you have multiple integrations, we highly recommend creating a summary that highlights all potential integration options. + +You must provide documentation that helps users get started with your integration. You also need to provide documentation for our support team, including points of contact, email address, FAQ and/or best practices. We want to ensure end users are able to reach the right contacts for internal HashiCorp support when working with customers. + +### 5. Support + +At HashiCorp, we view the release step to be the beginning of the journey. Getting the integration built is just the first step in enabling users to leverage it against their infrastructure. On-going effort is required to support and maintain it after you complete the initial development. + +We expect that partners will create a mechanism to track and resolve all critical issues as soon as possible (ideally within 48 hours) and all other issues within 5 business days. This is a requirement given the critical nature of Terraform Cloud to a customer’s operation. If you choose not to support your integration, we cannot consider it Verified and will not list it on the Terraform documentation website. + +-> Contact us at technologypartners@hashicorp.com with any questions or feedback. From 7d3074df46b3d3351424a3b44df590fdcbbc6aad Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 15 Oct 2021 17:01:32 -0700 Subject: [PATCH 171/644] go.mod: go get github.com/mitchellh/go-wordwrap@v1.0.1 --- go.mod | 2 +- go.sum | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/go.mod b/go.mod index 60b751726eff..646309e2a559 100644 --- a/go.mod +++ b/go.mod @@ -60,7 +60,7 @@ require ( github.com/mitchellh/copystructure v1.2.0 github.com/mitchellh/go-homedir v1.1.0 github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb - github.com/mitchellh/go-wordwrap v1.0.0 + github.com/mitchellh/go-wordwrap v1.0.1 github.com/mitchellh/gox v1.0.1 github.com/mitchellh/mapstructure v1.1.2 github.com/mitchellh/panicwrap v1.0.0 diff --git a/go.sum b/go.sum index 7d2eaf9415b0..bd8b487fba33 100644 --- a/go.sum +++ b/go.sum @@ -505,8 +505,9 @@ github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go. github.com/mitchellh/go-testing-interface v1.0.0 h1:fzU/JVNcaqHQEcVFAKeR41fkiLdIPrefOvVG1VZ96U0= github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= -github.com/mitchellh/go-wordwrap v1.0.0 h1:6GlHJ/LTGMrIJbwgdqdl2eEH8o+Exx/0m8ir9Gns0u4= github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= +github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0= +github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0= github.com/mitchellh/gox v1.0.1 h1:x0jD3dcHk9a9xPSDN6YEL4xL6Qz0dvNYm8yZqui5chI= github.com/mitchellh/gox v1.0.1/go.mod h1:ED6BioOGXMswlXa2zxfh/xdd5QhwYliBFn9V18Ap4z4= github.com/mitchellh/iochan v1.0.0 h1:C+X3KsSTLFVBr/tK1eYN/vs4rJcvsiLU338UhYPJWeY= From f32702c5c2369d59f279863cd2815f00add2bd23 Mon Sep 17 00:00:00 2001 From: Alex Khaerov Date: Mon, 18 Oct 2021 12:32:57 +0800 Subject: [PATCH 172/644] Support deprecated assume_role block --- internal/backend/remote-state/oss/backend.go | 140 +++++++++++++----- .../backend/remote-state/oss/backend_state.go | 17 +-- internal/backend/remote-state/oss/client.go | 30 ++-- 3 files changed, 127 insertions(+), 60 deletions(-) diff --git a/internal/backend/remote-state/oss/backend.go b/internal/backend/remote-state/oss/backend.go index 5a2b2880ce61..c4131060e84d 100644 --- a/internal/backend/remote-state/oss/backend.go +++ b/internal/backend/remote-state/oss/backend.go @@ -24,32 +24,84 @@ import ( "github.com/aliyun/aliyun-oss-go-sdk/oss" "github.com/aliyun/aliyun-tablestore-go-sdk/tablestore" "github.com/hashicorp/go-cleanhttp" + "github.com/jmespath/go-jmespath" + "github.com/mitchellh/go-homedir" + "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/legacy/helper/schema" "github.com/hashicorp/terraform/version" - "github.com/jmespath/go-jmespath" - "github.com/mitchellh/go-homedir" ) +// deprecated in favor to flatten parameters +func deprecatedAssumeRoleSchema() *schema.Schema { + return &schema.Schema{ + Type: schema.TypeSet, + Optional: true, + ConflictsWith: []string{"assume_role_role_arn", "assume_role_session_name", "assume_role_policy", "assume_role_session_expiration"}, + MaxItems: 1, + Deprecated: "use flatten assume_role_* instead", + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "role_arn": { + Type: schema.TypeString, + Required: true, + Description: "The ARN of a RAM role to assume prior to making API calls.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), + }, + "session_name": { + Type: schema.TypeString, + Optional: true, + Description: "The session name to use when assuming the role.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), + }, + "policy": { + Type: schema.TypeString, + Optional: true, + Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", + }, + "session_expiration": { + Type: schema.TypeInt, + Optional: true, + Description: "The time after which the established session for assuming role expires.", + ValidateFunc: func(v interface{}, k string) ([]string, []error) { + min := 900 + max := 3600 + value, ok := v.(int) + if !ok { + return nil, []error{fmt.Errorf("expected type of %s to be int", k)} + } + + if value < min || value > max { + return nil, []error{fmt.Errorf("expected %s to be in the range (%d - %d), got %d", k, min, max, v)} + } + + return nil, nil + }, + }, + }, + }, + } +} + // New creates a new backend for OSS remote state. func New() backend.Backend { s := &schema.Backend{ Schema: map[string]*schema.Schema{ - "access_key": &schema.Schema{ + "access_key": { Type: schema.TypeString, Optional: true, Description: "Alibaba Cloud Access Key ID", DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ACCESS_KEY", os.Getenv("ALICLOUD_ACCESS_KEY_ID")), }, - "secret_key": &schema.Schema{ + "secret_key": { Type: schema.TypeString, Optional: true, Description: "Alibaba Cloud Access Secret Key", DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_SECRET_KEY", os.Getenv("ALICLOUD_ACCESS_KEY_SECRET")), }, - "security_token": &schema.Schema{ + "security_token": { Type: schema.TypeString, Optional: true, Description: "Alibaba Cloud Security Token", @@ -63,7 +115,7 @@ func New() backend.Backend { Description: "The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.", }, - "region": &schema.Schema{ + "region": { Type: schema.TypeString, Optional: true, Description: "The region of the OSS bucket.", @@ -82,13 +134,13 @@ func New() backend.Backend { DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_OSS_ENDPOINT", os.Getenv("OSS_ENDPOINT")), }, - "bucket": &schema.Schema{ + "bucket": { Type: schema.TypeString, Required: true, Description: "The name of the OSS bucket", }, - "prefix": &schema.Schema{ + "prefix": { Type: schema.TypeString, Optional: true, Description: "The directory where state files will be saved inside the bucket", @@ -102,7 +154,7 @@ func New() backend.Backend { }, }, - "key": &schema.Schema{ + "key": { Type: schema.TypeString, Optional: true, Description: "The path of the state file inside the bucket", @@ -122,14 +174,14 @@ func New() backend.Backend { Default: "", }, - "encrypt": &schema.Schema{ + "encrypt": { Type: schema.TypeBool, Optional: true, Description: "Whether to enable server side encryption of the state file", Default: false, }, - "acl": &schema.Schema{ + "acl": { Type: schema.TypeString, Optional: true, Description: "Object ACL to be applied to the state file", @@ -158,27 +210,32 @@ func New() backend.Backend { Description: "This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable.", DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_PROFILE", ""), }, + "assume_role": deprecatedAssumeRoleSchema(), "assume_role_role_arn": { - Type: schema.TypeString, - Required: true, - Description: "The ARN of a RAM role to assume prior to making API calls.", - DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), + Type: schema.TypeString, + Optional: true, + ConflictsWith: []string{"assume_role"}, + Description: "The ARN of a RAM role to assume prior to making API calls.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), }, "assume_role_session_name": { - Type: schema.TypeString, - Optional: true, - Description: "The session name to use when assuming the role.", - DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), + Type: schema.TypeString, + Optional: true, + ConflictsWith: []string{"assume_role"}, + Description: "The session name to use when assuming the role.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), }, "assume_role_policy": { - Type: schema.TypeString, - Optional: true, - Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", + Type: schema.TypeString, + Optional: true, + ConflictsWith: []string{"assume_role"}, + Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", }, "assume_role_session_expiration": { - Type: schema.TypeInt, - Optional: true, - Description: "The time after which the established session for assuming role expires.", + Type: schema.TypeInt, + Optional: true, + ConflictsWith: []string{"assume_role"}, + Description: "The time after which the established session for assuming role expires.", ValidateFunc: func(v interface{}, k string) ([]string, []error) { min := 900 max := 3600 @@ -214,7 +271,6 @@ type Backend struct { stateKey string serverSideEncryption bool acl string - endpoint string otsEndpoint string otsTable string } @@ -260,13 +316,29 @@ func (b *Backend) configure(ctx context.Context) error { sessionExpiration = (int)(expiredSeconds.(float64)) } - roleArn = d.Get("assume_role_role_arn").(string) - sessionName = d.Get("assume_role_session_name").(string) + if v, ok := d.GetOk("assume_role"); ok { + // deprecated assume_role block + for _, v := range v.(*schema.Set).List() { + assumeRole := v.(map[string]interface{}) + if assumeRole["role_arn"].(string) != "" { + roleArn = assumeRole["role_arn"].(string) + } + if assumeRole["session_name"].(string) != "" { + sessionName = assumeRole["session_name"].(string) + } + policy = assumeRole["policy"].(string) + sessionExpiration = assumeRole["session_expiration"].(int) + } + } else { + roleArn = d.Get("assume_role_role_arn").(string) + sessionName = d.Get("assume_role_session_name").(string) + policy = d.Get("assume_role_policy").(string) + sessionExpiration = d.Get("assume_role_session_expiration").(int) + } + if sessionName == "" { sessionName = "terraform" } - policy = d.Get("assume_role_policy").(string) - sessionExpiration = d.Get("assume_role_session_expiration").(int) if sessionExpiration == 0 { if v := os.Getenv("ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION"); v != "" { if expiredSeconds, err := strconv.Atoi(v); err == nil { @@ -346,13 +418,13 @@ func (b *Backend) getOSSEndpointByRegion(access_key, secret_key, security_token, locationClient, err := location.NewClientWithOptions(region, getSdkConfig(), credentials.NewStsTokenCredential(access_key, secret_key, security_token)) if err != nil { - return nil, fmt.Errorf("Unable to initialize the location client: %#v", err) + return nil, fmt.Errorf("unable to initialize the location client: %#v", err) } locationClient.AppendUserAgent(TerraformUA, TerraformVersion) endpointsResponse, err := locationClient.DescribeEndpoints(args) if err != nil { - return nil, fmt.Errorf("Describe oss endpoint using region: %#v got an error: %#v.", region, err) + return nil, fmt.Errorf("describe oss endpoint using region: %#v got an error: %#v", region, err) } return endpointsResponse, nil } @@ -442,7 +514,7 @@ func (a *Invoker) Run(f func() error) error { catcher.RetryCount-- if catcher.RetryCount <= 0 { - return fmt.Errorf("Retry timeout and got an error: %#v.", err) + return fmt.Errorf("retry timeout and got an error: %#v", err) } else { time.Sleep(time.Duration(catcher.RetryWaitSeconds) * time.Second) return a.Run(f) @@ -552,7 +624,7 @@ func getAuthCredentialByEcsRoleName(ecsRoleName string) (accessKey, secretKey, t response := responses.NewCommonResponse() err = responses.Unmarshal(response, httpResponse, "") if err != nil { - err = fmt.Errorf("Unmarshal Ecs sts token response err : %s", err.Error()) + err = fmt.Errorf("unmarshal Ecs sts token response err : %s", err.Error()) return } diff --git a/internal/backend/remote-state/oss/backend_state.go b/internal/backend/remote-state/oss/backend_state.go index d91ed6c5c9bd..d08e1d133897 100644 --- a/internal/backend/remote-state/oss/backend_state.go +++ b/internal/backend/remote-state/oss/backend_state.go @@ -3,19 +3,18 @@ package oss import ( "errors" "fmt" + "log" + "path" "sort" "strings" "github.com/aliyun/aliyun-oss-go-sdk/oss" + "github.com/aliyun/aliyun-tablestore-go-sdk/tablestore" + "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statemgr" - - "log" - "path" - - "github.com/aliyun/aliyun-tablestore-go-sdk/tablestore" ) const ( @@ -43,7 +42,7 @@ func (b *Backend) remoteClient(name string) (*RemoteClient, error) { TableName: b.otsTable, }) if err != nil { - return client, fmt.Errorf("Error describing table store %s: %#v", b.otsTable, err) + return client, fmt.Errorf("error describing table store %s: %#v", b.otsTable, err) } } @@ -53,7 +52,7 @@ func (b *Backend) remoteClient(name string) (*RemoteClient, error) { func (b *Backend) Workspaces() ([]string, error) { bucket, err := b.ossClient.Bucket(b.bucketName) if err != nil { - return []string{""}, fmt.Errorf("Error getting bucket: %#v", err) + return []string{""}, fmt.Errorf("error getting bucket: %#v", err) } var options []oss.Option @@ -85,7 +84,7 @@ func (b *Backend) Workspaces() ([]string, error) { } else { options = append(options, oss.Marker(lastObj)) } - resp, err = bucket.ListObjects(options...) + bucket.ListObjects(options...) } else { break } @@ -135,7 +134,7 @@ func (b *Backend) StateMgr(name string) (statemgr.Full, error) { lockInfo.Operation = "init" lockId, err := client.Lock(lockInfo) if err != nil { - return nil, fmt.Errorf("Failed to lock OSS state: %s", err) + return nil, fmt.Errorf("failed to lock OSS state: %s", err) } // Local helper function so we can call it multiple places diff --git a/internal/backend/remote-state/oss/client.go b/internal/backend/remote-state/oss/client.go index ccf19576a200..78d835ae13eb 100644 --- a/internal/backend/remote-state/oss/client.go +++ b/internal/backend/remote-state/oss/client.go @@ -3,22 +3,21 @@ package oss import ( "bytes" "crypto/md5" + "encoding/hex" "encoding/json" "fmt" "io" - - "encoding/hex" "log" - "sync" "time" "github.com/aliyun/aliyun-oss-go-sdk/oss" "github.com/aliyun/aliyun-tablestore-go-sdk/tablestore" "github.com/hashicorp/go-multierror" uuid "github.com/hashicorp/go-uuid" + "github.com/pkg/errors" + "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statemgr" - "github.com/pkg/errors" ) const ( @@ -48,8 +47,6 @@ type RemoteClient struct { lockFile string serverSideEncryption bool acl string - info *statemgr.LockInfo - mu sync.Mutex otsTable string } @@ -99,7 +96,7 @@ func (c *RemoteClient) Get() (payload *remote.Payload, err error) { func (c *RemoteClient) Put(data []byte) error { bucket, err := c.ossClient.Bucket(c.bucketName) if err != nil { - return fmt.Errorf("Error getting bucket: %#v", err) + return fmt.Errorf("error getting bucket: %#v", err) } body := bytes.NewReader(data) @@ -116,7 +113,7 @@ func (c *RemoteClient) Put(data []byte) error { if body != nil { if err := bucket.PutObject(c.stateFile, body, options...); err != nil { - return fmt.Errorf("Failed to upload state %s: %#v", c.stateFile, err) + return fmt.Errorf("failed to upload state %s: %#v", c.stateFile, err) } } @@ -124,7 +121,7 @@ func (c *RemoteClient) Put(data []byte) error { if err := c.putMD5(sum[:]); err != nil { // if this errors out, we unfortunately have to error out altogether, // since the next Get will inevitably fail. - return fmt.Errorf("Failed to store state MD5: %s", err) + return fmt.Errorf("failed to store state MD5: %s", err) } return nil } @@ -132,13 +129,13 @@ func (c *RemoteClient) Put(data []byte) error { func (c *RemoteClient) Delete() error { bucket, err := c.ossClient.Bucket(c.bucketName) if err != nil { - return fmt.Errorf("Error getting bucket %s: %#v", c.bucketName, err) + return fmt.Errorf("error getting bucket %s: %#v", c.bucketName, err) } log.Printf("[DEBUG] Deleting remote state from OSS: %#v", c.stateFile) if err := bucket.DeleteObject(c.stateFile); err != nil { - return fmt.Errorf("Error deleting state %s: %#v", c.stateFile, err) + return fmt.Errorf("error deleting state %s: %#v", c.stateFile, err) } if err := c.deleteMD5(); err != nil { @@ -413,11 +410,11 @@ func (c *RemoteClient) lockPath() string { func (c *RemoteClient) getObj() (*remote.Payload, error) { bucket, err := c.ossClient.Bucket(c.bucketName) if err != nil { - return nil, fmt.Errorf("Error getting bucket %s: %#v", c.bucketName, err) + return nil, fmt.Errorf("error getting bucket %s: %#v", c.bucketName, err) } if exist, err := bucket.IsObjectExist(c.stateFile); err != nil { - return nil, fmt.Errorf("Estimating object %s is exist got an error: %#v", c.stateFile, err) + return nil, fmt.Errorf("estimating object %s is exist got an error: %#v", c.stateFile, err) } else if !exist { return nil, nil } @@ -425,12 +422,12 @@ func (c *RemoteClient) getObj() (*remote.Payload, error) { var options []oss.Option output, err := bucket.GetObject(c.stateFile, options...) if err != nil { - return nil, fmt.Errorf("Error getting object: %#v", err) + return nil, fmt.Errorf("error getting object: %#v", err) } buf := bytes.NewBuffer(nil) if _, err := io.Copy(buf, output); err != nil { - return nil, fmt.Errorf("Failed to read remote state: %s", err) + return nil, fmt.Errorf("failed to read remote state: %s", err) } sum := md5.Sum(buf.Bytes()) payload := &remote.Payload{ @@ -452,5 +449,4 @@ This may be caused by unusually long delays in OSS processing a previous state update. Please wait for a minute or two and try again. If this problem persists, and neither OSS nor TableStore are experiencing an outage, you may need to manually verify the remote state and update the Digest value stored in the -TableStore table to the following value: %x -` +TableStore table to the following value: %x` From 14f366dbf43131081e40ab156f991a2ac364da3b Mon Sep 17 00:00:00 2001 From: Alex Khaerov Date: Mon, 18 Oct 2021 12:54:40 +0800 Subject: [PATCH 173/644] Update documentation --- internal/backend/remote-state/oss/backend.go | 4 +- .../language/settings/backends/oss.html.md | 60 +++++++++++-------- 2 files changed, 38 insertions(+), 26 deletions(-) diff --git a/internal/backend/remote-state/oss/backend.go b/internal/backend/remote-state/oss/backend.go index c4131060e84d..236a5e7857c2 100644 --- a/internal/backend/remote-state/oss/backend.go +++ b/internal/backend/remote-state/oss/backend.go @@ -32,14 +32,14 @@ import ( "github.com/hashicorp/terraform/version" ) -// deprecated in favor to flatten parameters +// Deprecated in favor of flattening assume_role_* options func deprecatedAssumeRoleSchema() *schema.Schema { return &schema.Schema{ Type: schema.TypeSet, Optional: true, ConflictsWith: []string{"assume_role_role_arn", "assume_role_session_name", "assume_role_policy", "assume_role_session_expiration"}, MaxItems: 1, - Deprecated: "use flatten assume_role_* instead", + Deprecated: "use assume_role_* options instead", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "role_arn": { diff --git a/website/docs/language/settings/backends/oss.html.md b/website/docs/language/settings/backends/oss.html.md index 515095ceb533..92e0d3ab0520 100644 --- a/website/docs/language/settings/backends/oss.html.md +++ b/website/docs/language/settings/backends/oss.html.md @@ -77,29 +77,41 @@ data "terraform_remote_state" "network" { The following configuration options or environment variables are supported: - * `access_key` - (Optional) Alibaba Cloud access key. It supports environment variables `ALICLOUD_ACCESS_KEY` and `ALICLOUD_ACCESS_KEY_ID`. - * `secret_key` - (Optional) Alibaba Cloud secret access key. It supports environment variables `ALICLOUD_SECRET_KEY` and `ALICLOUD_ACCESS_KEY_SECRET`. - * `security_token` - (Optional) STS access token. It supports environment variable `ALICLOUD_SECURITY_TOKEN`. - * `ecs_role_name` - (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. - * `region` - (Optional) The region of the OSS bucket. It supports environment variables `ALICLOUD_REGION` and `ALICLOUD_DEFAULT_REGION`. - * `endpoint` - (Optional) A custom endpoint for the OSS API. It supports environment variables `ALICLOUD_OSS_ENDPOINT` and `OSS_ENDPOINT`. - * `bucket` - (Required) The name of the OSS bucket. - * `prefix` - (Opeional) The path directory of the state file will be stored. Default to "env:". - * `key` - (Optional) The name of the state file. Defaults to `terraform.tfstate`. - * `tablestore_endpoint` / `ALICLOUD_TABLESTORE_ENDPOINT` - (Optional) A custom endpoint for the TableStore API. - * `tablestore_table` - (Optional) A TableStore table for state locking and consistency. The table must have a primary key named `LockID` of type `String`. - * `encrypt` - (Optional) Whether to enable server side - encryption of the state file. If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file. - * `acl` - (Optional) [Object - ACL](https://www.alibabacloud.com/help/doc-detail/52284.htm) - to be applied to the state file. - * `shared_credentials_file` - (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the `ALICLOUD_SHARED_CREDENTIALS_FILE` environment variable. If this is not set and a profile is specified, `~/.aliyun/config.json` will be used. - * `profile` - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable. -* `assume_role_role_arn` - (Optional, Available in 0.12.6+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports environment variable `ALICLOUD_ASSUME_ROLE_ARN`. +* `access_key` - (Optional) Alibaba Cloud access key. It supports environment variables `ALICLOUD_ACCESS_KEY` and `ALICLOUD_ACCESS_KEY_ID`. +* `secret_key` - (Optional) Alibaba Cloud secret access key. It supports environment variables `ALICLOUD_SECRET_KEY` and `ALICLOUD_ACCESS_KEY_SECRET`. +* `security_token` - (Optional) STS access token. It supports environment variable `ALICLOUD_SECURITY_TOKEN`. +* `ecs_role_name` - (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. +* `region` - (Optional) The region of the OSS bucket. It supports environment variables `ALICLOUD_REGION` and `ALICLOUD_DEFAULT_REGION`. +* `endpoint` - (Optional) A custom endpoint for the OSS API. It supports environment variables `ALICLOUD_OSS_ENDPOINT` and `OSS_ENDPOINT`. +* `bucket` - (Required) The name of the OSS bucket. +* `prefix` - (Opeional) The path directory of the state file will be stored. Default to "env:". +* `key` - (Optional) The name of the state file. Defaults to `terraform.tfstate`. +* `tablestore_endpoint` / `ALICLOUD_TABLESTORE_ENDPOINT` - (Optional) A custom endpoint for the TableStore API. +* `tablestore_table` - (Optional) A TableStore table for state locking and consistency. The table must have a primary key named `LockID` of type `String`. +* `encrypt` - (Optional) Whether to enable server side + encryption of the state file. If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file. +* `acl` - (Optional) [Object + ACL](https://www.alibabacloud.com/help/doc-detail/52284.htm) + to be applied to the state file. +* `shared_credentials_file` - (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the `ALICLOUD_SHARED_CREDENTIALS_FILE` environment variable. If this is not set and a profile is specified, `~/.aliyun/config.json` will be used. +* `profile` - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable. +* `assume_role_role_arn` - (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable `ALICLOUD_ASSUME_ROLE_ARN`. Terraform executes configuration on account with provided credentials. -* `assume_role_policy` - (Optional, Available in 0.12.6+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary - security credentials. You cannot use this policy to grant permissions which exceed those of the role that is being assumed. -* `assume_role_session_name` - (Optional, Available in 0.12.6+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. -* `assume_role_session_expiration` - (Optional, Available in 0.12.6+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud use own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. +* `assume_role_policy` - (Optional, Available in 1.1.0+ A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. +* `assume_role_session_name` - (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. +* `assume_role_session_expiration` - (Optional, Available in 1.1.0+ The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. --> **Note:** If you want to store state in the custom OSS endpoint, you can specify a environment variable `OSS_ENDPOINT`, like "oss-cn-beijing-internal.aliyuncs.com" +* `assume_role` - (**Deprecated as of 1.1.0+**, Available in 0.12.6+) If provided with a role ARN, will attempt to assume this role using the supplied credentials. + + **Deprecated in favor of flattening assume_role_\* options** + + * `role_arn` - (Required) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable `ALICLOUD_ASSUME_ROLE_ARN`. + Terraform executes configuration on account with provided credentials. + + * `policy` - (Optional) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. + + * `session_name` - (Optional) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. + + * `session_expiration` - (Optional) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. + +-> **Note:** If you want to store state in the custom OSS endpoint, you can specify an environment variable `OSS_ENDPOINT`, like "oss-cn-beijing-internal.aliyuncs.com" From fb58f9e6d2e9609590af1417d090f9c0aeb29f7b Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 18 Oct 2021 16:54:31 -0400 Subject: [PATCH 174/644] cli: Fix flaky init cancel test There is a race between the MockSource and ShutdownCh which sometimes causes this test to fail. Add a HangingSource implementation of Source which hangs until the context is cancelled, so that there is always time for a user-initiated shutdown to trigger the cancellation code path under test. --- internal/command/init_test.go | 14 +++++------- internal/getproviders/hanging_source.go | 29 +++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 8 deletions(-) create mode 100644 internal/getproviders/hanging_source.go diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 2d96b27b4403..74d4b0f64d36 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -1372,14 +1372,12 @@ func TestInit_cancel(t *testing.T) { defer os.RemoveAll(td) defer testChdir(t, td)() - providerSource, closeSrc := newMockProviderSource(t, map[string][]string{ - "test": {"1.2.3", "1.2.4"}, - "test-beta": {"1.2.4"}, - "source": {"1.2.2", "1.2.3", "1.2.1"}, - }) - defer closeSrc() + // Use a provider source implementation which is designed to hang indefinitely, + // to avoid a race between the closed shutdown channel and the provider source + // operations. + providerSource := &getproviders.HangingSource{} - // our shutdown channel is pre-closed so init will exit as soon as it + // Our shutdown channel is pre-closed so init will exit as soon as it // starts a cancelable portion of the process. shutdownCh := make(chan struct{}) close(shutdownCh) @@ -1401,7 +1399,7 @@ func TestInit_cancel(t *testing.T) { args := []string{} if code := c.Run(args); code == 0 { - t.Fatalf("succeeded; wanted error") + t.Fatalf("succeeded; wanted error\n%s", ui.OutputWriter.String()) } // Currently the first operation that is cancelable is provider // installation, so our error message comes from there. If we diff --git a/internal/getproviders/hanging_source.go b/internal/getproviders/hanging_source.go new file mode 100644 index 000000000000..388b617013f2 --- /dev/null +++ b/internal/getproviders/hanging_source.go @@ -0,0 +1,29 @@ +package getproviders + +import ( + "context" + + "github.com/hashicorp/terraform/internal/addrs" +) + +// HangingSource is an implementation of Source which hangs until the given +// context is cancelled. This is useful only for unit tests of user-controlled +// cancels. +type HangingSource struct { +} + +var _ Source = (*HangingSource)(nil) + +func (s *HangingSource) AvailableVersions(ctx context.Context, provider addrs.Provider) (VersionList, Warnings, error) { + <-ctx.Done() + return nil, nil, nil +} + +func (s *HangingSource) PackageMeta(ctx context.Context, provider addrs.Provider, version Version, target Platform) (PackageMeta, error) { + <-ctx.Done() + return PackageMeta{}, nil +} + +func (s *HangingSource) ForDisplay(provider addrs.Provider) string { + return "hanging source" +} From c587384dfffd98eaadbdba9f406a0ed59aed6faf Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 18 Oct 2021 14:41:04 -0400 Subject: [PATCH 175/644] cli: Restore -lock and -lock-timeout init flags The -lock and -lock-timeout flags were removed prior to the release of 1.0 as they were thought to have no effect. This is not true in the case of state migrations when changing backends. This commit restores these flags, and adds test coverage for locking during backend state migration. Also update the help output describing other boolean flags, showing the argument as the user would type it rather than the default behavior. --- internal/command/init.go | 27 +++++++--- internal/command/init_test.go | 54 +++++++++++++++++++ .../.terraform/terraform.tfstate | 22 ++++++++ .../input.config | 1 + .../init-backend-migrate-while-locked/main.tf | 5 ++ 5 files changed, 102 insertions(+), 7 deletions(-) create mode 100644 internal/command/testdata/init-backend-migrate-while-locked/.terraform/terraform.tfstate create mode 100644 internal/command/testdata/init-backend-migrate-while-locked/input.config create mode 100644 internal/command/testdata/init-backend-migrate-while-locked/main.tf diff --git a/internal/command/init.go b/internal/command/init.go index 551a4d0b8a5a..8083b7513d32 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -44,6 +44,8 @@ func (c *InitCommand) Run(args []string) int { cmdFlags.StringVar(&flagFromModule, "from-module", "", "copy the source of the given module into the directory before init") cmdFlags.BoolVar(&flagGet, "get", true, "") cmdFlags.BoolVar(&c.forceInitCopy, "force-copy", false, "suppress prompts about copying state data") + cmdFlags.BoolVar(&c.Meta.stateLock, "lock", true, "lock state") + cmdFlags.DurationVar(&c.Meta.stateLockTimeout, "lock-timeout", 0, "lock timeout") cmdFlags.BoolVar(&c.reconfigure, "reconfigure", false, "reconfigure") cmdFlags.BoolVar(&c.migrateState, "migrate-state", false, "migrate state") cmdFlags.BoolVar(&flagUpgrade, "upgrade", false, "") @@ -932,6 +934,8 @@ func (c *InitCommand) AutocompleteFlags() complete.Flags { "-from-module": completePredictModuleSource, "-get": completePredictBoolean, "-input": completePredictBoolean, + "-lock": completePredictBoolean, + "-lock-timeout": complete.PredictAnything, "-no-color": complete.PredictNothing, "-plugin-dir": complete.PredictDirs(""), "-reconfigure": complete.PredictNothing, @@ -959,7 +963,8 @@ Usage: terraform [global options] init [options] Options: - -backend=true Configure the backend for this configuration. + -backend=false Disable backend initialization for this configuration + and use the previously initialized backend instead. -backend-config=path This can be either a path to an HCL file with key/value assignments (same format as terraform.tfvars) or a @@ -975,10 +980,17 @@ Options: -from-module=SOURCE Copy the contents of the given module into the target directory before initialization. - -get=true Download any modules for this configuration. + -get=false Disable downloading modules for this configuration. - -input=true Ask for input if necessary. If false, will error if - input was required. + -input=false Disable prompting for missing backend configuration + values. This will result in an error if the backend + configuration is not fully specified. + + -lock=false Don't hold a state lock during backend migration. + This is dangerous if others might concurrently run + commands against the same workspace. + + -lock-timeout=0s Duration to retry a state lock. -no-color If specified, output won't contain any color. @@ -993,9 +1005,10 @@ Options: -migrate-state Reconfigure the backend, and attempt to migrate any existing state. - -upgrade=false If installing modules (-get) or plugins, ignore - previously-downloaded objects and install the - latest version allowed within configured constraints. + -upgrade Install the latest module and provider versions + allowed within configured constraints, overriding the + default behavior of selecting exactly the version + recorded in the dependency lockfile. -lockfile=MODE Set a dependency lockfile mode. Currently only "readonly" is valid. diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 2d96b27b4403..c50e97ac9018 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -562,6 +562,60 @@ func TestInit_backendConfigFileChange(t *testing.T) { } } +func TestInit_backendMigrateWhileLocked(t *testing.T) { + // Create a temporary working directory that is empty + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-migrate-while-locked"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + providerSource, close := newMockProviderSource(t, map[string][]string{ + "hashicorp/test": {"1.2.3"}, + }) + defer close() + + ui := new(cli.MockUi) + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + ProviderSource: providerSource, + Ui: ui, + View: view, + }, + } + + // Create some state, so the backend has something to migrate from + f, err := os.Create("local-state.tfstate") + if err != nil { + t.Fatalf("err: %s", err) + } + err = writeStateForTesting(testState(), f) + f.Close() + if err != nil { + t.Fatalf("err: %s", err) + } + + // Lock the source state + unlock, err := testLockState(testDataDir, "local-state.tfstate") + if err != nil { + t.Fatal(err) + } + defer unlock() + + // Attempt to migrate + args := []string{"-backend-config", "input.config", "-migrate-state", "-force-copy"} + if code := c.Run(args); code == 0 { + t.Fatalf("expected nonzero exit code: %s", ui.OutputWriter.String()) + } + + // Disabling locking should work + args = []string{"-backend-config", "input.config", "-migrate-state", "-force-copy", "-lock=false"} + if code := c.Run(args); code != 0 { + t.Fatalf("expected zero exit code, got %d: %s", code, ui.ErrorWriter.String()) + } +} + func TestInit_backendConfigKV(t *testing.T) { // Create a temporary working directory that is empty td := tempDir(t) diff --git a/internal/command/testdata/init-backend-migrate-while-locked/.terraform/terraform.tfstate b/internal/command/testdata/init-backend-migrate-while-locked/.terraform/terraform.tfstate new file mode 100644 index 000000000000..073bd7a82237 --- /dev/null +++ b/internal/command/testdata/init-backend-migrate-while-locked/.terraform/terraform.tfstate @@ -0,0 +1,22 @@ +{ + "version": 3, + "serial": 0, + "lineage": "666f9301-7e65-4b19-ae23-71184bb19b03", + "backend": { + "type": "local", + "config": { + "path": "local-state.tfstate" + }, + "hash": 9073424445967744180 + }, + "modules": [ + { + "path": [ + "root" + ], + "outputs": {}, + "resources": {}, + "depends_on": [] + } + ] +} diff --git a/internal/command/testdata/init-backend-migrate-while-locked/input.config b/internal/command/testdata/init-backend-migrate-while-locked/input.config new file mode 100644 index 000000000000..6cd14f4a3d03 --- /dev/null +++ b/internal/command/testdata/init-backend-migrate-while-locked/input.config @@ -0,0 +1 @@ +path = "hello" diff --git a/internal/command/testdata/init-backend-migrate-while-locked/main.tf b/internal/command/testdata/init-backend-migrate-while-locked/main.tf new file mode 100644 index 000000000000..bea8e789f8bb --- /dev/null +++ b/internal/command/testdata/init-backend-migrate-while-locked/main.tf @@ -0,0 +1,5 @@ +terraform { + backend "local" { + path = "local-state.tfstate" + } +} From 7afaea4cf209e3598f9e17475643c99b961c23c2 Mon Sep 17 00:00:00 2001 From: xiaozhu36 Date: Wed, 20 Oct 2021 16:05:00 +0800 Subject: [PATCH 176/644] backend/oss: Fixes the nil pointer panic error when missing access key or secret key --- internal/backend/remote-state/oss/backend.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/internal/backend/remote-state/oss/backend.go b/internal/backend/remote-state/oss/backend.go index de08af37d68f..79534ed22f9a 100644 --- a/internal/backend/remote-state/oss/backend.go +++ b/internal/backend/remote-state/oss/backend.go @@ -319,7 +319,10 @@ func (b *Backend) configure(ctx context.Context) error { } if endpoint == "" { - endpointsResponse, _ := b.getOSSEndpointByRegion(accessKey, secretKey, securityToken, region) + endpointsResponse, err := b.getOSSEndpointByRegion(accessKey, secretKey, securityToken, region) + if err != nil { + return err + } for _, endpointItem := range endpointsResponse.Endpoints.Endpoint { if endpointItem.Type == "openAPI" { endpoint = endpointItem.Endpoint From 5b266dd5ca739b1438e2093aa644d3f02fcf1015 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 18 Oct 2021 15:08:35 -0700 Subject: [PATCH 177/644] command: Remove the experimental "terraform add" command We introduced this experiment to gather feedback, and the feedback we saw led to us deciding to do another round of design work before we move forward with something to meet this use-case. In addition to being experimental, this has only been included in alpha releases so far, and so on both counts it is not protected by the Terraform v1.0 Compatibility Promises. --- commands.go | 6 - internal/command/add.go | 369 ------ internal/command/add_test.go | 685 ----------- internal/command/arguments/add.go | 110 -- internal/command/arguments/add_test.go | 146 --- internal/command/command_test.go | 8 - internal/command/testdata/add/basic/main.tf | 14 - internal/command/testdata/add/module/main.tf | 17 - .../testdata/add/module/module/main.tf | 9 - internal/command/views/add.go | 562 --------- internal/command/views/add_test.go | 1018 ----------------- website/docs/cli/commands/add.html.md | 81 -- website/docs/cli/commands/index.html.md | 1 - website/layouts/docs.erb | 8 - 14 files changed, 3034 deletions(-) delete mode 100644 internal/command/add.go delete mode 100644 internal/command/add_test.go delete mode 100644 internal/command/arguments/add.go delete mode 100644 internal/command/arguments/add_test.go delete mode 100644 internal/command/testdata/add/basic/main.tf delete mode 100644 internal/command/testdata/add/module/main.tf delete mode 100644 internal/command/testdata/add/module/module/main.tf delete mode 100644 internal/command/views/add.go delete mode 100644 internal/command/views/add_test.go delete mode 100644 website/docs/cli/commands/add.html.md diff --git a/commands.go b/commands.go index 2c1cb90ee1ae..41c39066dd9f 100644 --- a/commands.go +++ b/commands.go @@ -109,12 +109,6 @@ func initCommands( // that to match. Commands = map[string]cli.CommandFactory{ - "add": func() (cli.Command, error) { - return &command.AddCommand{ - Meta: meta, - }, nil - }, - "apply": func() (cli.Command, error) { return &command.ApplyCommand{ Meta: meta, diff --git a/internal/command/add.go b/internal/command/add.go deleted file mode 100644 index 69f91b77304e..000000000000 --- a/internal/command/add.go +++ /dev/null @@ -1,369 +0,0 @@ -package command - -import ( - "fmt" - "os" - "path/filepath" - "strings" - - "github.com/hashicorp/hcl/v2" - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/backend" - "github.com/hashicorp/terraform/internal/command/arguments" - "github.com/hashicorp/terraform/internal/command/views" - "github.com/hashicorp/terraform/internal/configs" - "github.com/hashicorp/terraform/internal/states" - "github.com/hashicorp/terraform/internal/tfdiags" - "github.com/zclconf/go-cty/cty" -) - -// AddCommand is a Command implementation that generates resource configuration templates. -type AddCommand struct { - Meta -} - -func (c *AddCommand) Run(rawArgs []string) int { - // Parse and apply global view arguments - common, rawArgs := arguments.ParseView(rawArgs) - c.View.Configure(common) - - args, diags := arguments.ParseAdd(rawArgs) - view := views.NewAdd(args.ViewType, c.View, args) - if diags.HasErrors() { - view.Diagnostics(diags) - return 1 - } - - // In case the output configuration path is specified, we should ensure the - // target resource address doesn't exist in the module tree indicated by - // the existing configuration files. - if args.OutPath != "" { - // Ensure the directory to the path exists and is accessible. - outDir := filepath.Dir(args.OutPath) - if _, err := os.Stat(outDir); os.IsNotExist(err) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "The out path doesn't exist or is not accessible", - err.Error(), - )) - view.Diagnostics(diags) - return 1 - } - - config, loadDiags := c.loadConfig(outDir) - diags = diags.Append(loadDiags) - if diags.HasErrors() { - view.Diagnostics(diags) - return 1 - } - - if config != nil && config.Module != nil { - if rs, ok := config.Module.ManagedResources[args.Addr.ContainingResource().Config().String()]; ok { - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Resource already in configuration", - Detail: fmt.Sprintf("The resource %s is already in this configuration at %s. Resource names must be unique per type in each module.", args.Addr, rs.DeclRange), - Subject: &rs.DeclRange, - }) - c.View.Diagnostics(diags) - return 1 - } - } - } - - // Check for user-supplied plugin path - var err error - if c.pluginPath, err = c.loadPluginPath(); err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error loading plugin path", - err.Error(), - )) - view.Diagnostics(diags) - return 1 - } - - // Apply the state arguments to the meta object here because they are later - // used when initializing the backend. - c.Meta.applyStateArguments(args.State) - - // Load the backend - b, backendDiags := c.Backend(nil) - diags = diags.Append(backendDiags) - if backendDiags.HasErrors() { - view.Diagnostics(diags) - return 1 - } - - // We require a local backend - local, ok := b.(backend.Local) - if !ok { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Unsupported backend", - ErrUnsupportedLocalOp, - )) - view.Diagnostics(diags) - return 1 - } - - // This is a read-only command (until -import is implemented) - c.ignoreRemoteBackendVersionConflict(b) - - cwd, err := os.Getwd() - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error determining current working directory", - err.Error(), - )) - view.Diagnostics(diags) - return 1 - } - - // Build the operation - opReq := c.Operation(b) - opReq.AllowUnsetVariables = true - opReq.ConfigDir = cwd - opReq.ConfigLoader, err = c.initConfigLoader() - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error initializing config loader", - err.Error(), - )) - view.Diagnostics(diags) - return 1 - } - - // Get the context - lr, _, ctxDiags := local.LocalRun(opReq) - diags = diags.Append(ctxDiags) - if ctxDiags.HasErrors() { - view.Diagnostics(diags) - return 1 - } - - // Successfully creating the context can result in a lock, so ensure we release it - defer func() { - diags := opReq.StateLocker.Unlock() - if diags.HasErrors() { - c.showDiagnostics(diags) - } - }() - - // load the configuration to verify that the resource address doesn't - // already exist in the config. - var module *configs.Module - if args.Addr.Module.IsRoot() { - module = lr.Config.Module - } else { - // This is weird, but users can potentially specify non-existant module names - cfg := lr.Config.Root.Descendent(args.Addr.Module.Module()) - if cfg != nil { - module = cfg.Module - } - } - - // Get the schemas from the context - schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - view.Diagnostics(diags) - return 1 - } - - // Determine the correct provider config address. The provider-related - // variables may get updated below - absProviderConfig := args.Provider - var providerLocalName string - rs := args.Addr.Resource.Resource - - // If we are getting the values from state, get the AbsProviderConfig - // directly from state as well. - var resource *states.Resource - if args.FromState { - resource, moreDiags = c.getResource(b, args.Addr.ContainingResource()) - if moreDiags.HasErrors() { - diags = diags.Append(moreDiags) - c.View.Diagnostics(diags) - return 1 - } - absProviderConfig = &resource.ProviderConfig - } - - if absProviderConfig == nil { - ip := rs.ImpliedProvider() - if module != nil { - provider := module.ImpliedProviderForUnqualifiedType(ip) - providerLocalName = module.LocalNameForProvider(provider) - absProviderConfig = &addrs.AbsProviderConfig{ - Provider: provider, - Module: args.Addr.Module.Module(), - } - } else { - // lacking any configuration to query, we'll go with a default provider. - absProviderConfig = &addrs.AbsProviderConfig{ - Provider: addrs.NewDefaultProvider(ip), - } - providerLocalName = ip - } - } else { - if module != nil { - providerLocalName = module.LocalNameForProvider(absProviderConfig.Provider) - } else { - providerLocalName = absProviderConfig.Provider.Type - } - } - - localProviderConfig := addrs.LocalProviderConfig{ - LocalName: providerLocalName, - Alias: absProviderConfig.Alias, - } - - // Get the schemas from the context - if _, exists := schemas.Providers[absProviderConfig.Provider]; !exists { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Missing schema for provider", - fmt.Sprintf("No schema found for provider %s. Please verify that this provider exists in the configuration.", absProviderConfig.Provider.String()), - )) - c.View.Diagnostics(diags) - return 1 - } - - // Get the schema for the resource - schema, schemaVersion := schemas.ResourceTypeConfig(absProviderConfig.Provider, rs.Mode, rs.Type) - if schema == nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Missing resource schema from provider", - fmt.Sprintf("No resource schema found for %s.", rs.Type), - )) - c.View.Diagnostics(diags) - return 1 - } - - stateVal := cty.NilVal - // Now that we have the schema, we can decode the previously-acquired resource state - if args.FromState { - ri := resource.Instance(args.Addr.Resource.Key) - if ri.Current == nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "No state for resource", - fmt.Sprintf("There is no state found for the resource %s, so add cannot populate values.", rs.String()), - )) - c.View.Diagnostics(diags) - return 1 - } - - rio, err := ri.Current.Decode(schema.ImpliedType()) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error decoding state", - fmt.Sprintf("Error decoding state for resource %s: %s", rs.String(), err.Error()), - )) - c.View.Diagnostics(diags) - return 1 - } - - if ri.Current.SchemaVersion != schemaVersion { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Schema version mismatch", - fmt.Sprintf("schema version %d for %s in state does not match version %d from the provider", ri.Current.SchemaVersion, rs.String(), schemaVersion), - )) - c.View.Diagnostics(diags) - return 1 - } - - stateVal = rio.Value - } - - diags = diags.Append(view.Resource(args.Addr, schema, localProviderConfig, stateVal)) - c.View.Diagnostics(diags) - if diags.HasErrors() { - return 1 - } - return 0 -} - -func (c *AddCommand) Help() string { - helpText := ` -Usage: terraform [global options] add [options] ADDRESS - - Generates a blank resource template. With no additional options, Terraform - will write the result to standard output. - -Options: - - -from-state Fill the template with values from an existing resource - instance tracked in the state. By default, Terraform will - emit only placeholder values based on the resource type. - - -out=string Write the template to a file, instead of to standard - output. - - -optional Include optional arguments. By default, the result will - include only required arguments. - - -provider=provider Override the provider configuration for the resource, - using the absolute provider configuration address syntax. - - This is incompatible with -from-state, because in that - case Terraform will use the provider configuration already - selected in the state. -` - return strings.TrimSpace(helpText) -} - -func (c *AddCommand) Synopsis() string { - return "Generate a resource configuration template" -} - -func (c *AddCommand) getResource(b backend.Enhanced, addr addrs.AbsResource) (*states.Resource, tfdiags.Diagnostics) { - var diags tfdiags.Diagnostics - // Get the state - env, err := c.Workspace() - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error selecting workspace", - err.Error(), - )) - return nil, diags - } - - stateMgr, err := b.StateMgr(env) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error loading state", - fmt.Sprintf(errStateLoadingState, err), - )) - return nil, diags - } - - if err := stateMgr.RefreshState(); err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error refreshing state", - err.Error(), - )) - return nil, diags - } - - state := stateMgr.State() - if state == nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "No state", - "There is no state found for the current workspace, so add cannot populate values.", - )) - return nil, diags - } - - return state.Resource(addr), nil -} diff --git a/internal/command/add_test.go b/internal/command/add_test.go deleted file mode 100644 index 7afe5e754bc6..000000000000 --- a/internal/command/add_test.go +++ /dev/null @@ -1,685 +0,0 @@ -package command - -import ( - "fmt" - "os" - "path/filepath" - "strings" - "testing" - - "github.com/google/go-cmp/cmp" - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/configs/configschema" - "github.com/hashicorp/terraform/internal/providers" - "github.com/hashicorp/terraform/internal/states" - "github.com/mitchellh/cli" - "github.com/zclconf/go-cty/cty" -) - -// simple test cases with a simple resource schema -func TestAdd_basic(t *testing.T) { - td := tempDir(t) - testCopyDir(t, testFixturePath("add/basic"), td) - defer os.RemoveAll(td) - defer testChdir(t, td)() - - p := testProvider() - p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{ - ResourceTypes: map[string]providers.Schema{ - "test_instance": { - Block: &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Optional: true, Computed: true}, - "ami": {Type: cty.String, Optional: true, Description: "the ami to use"}, - "value": {Type: cty.String, Required: true, Description: "a value of a thing"}, - }, - }, - }, - }, - } - - overrides := &testingOverrides{ - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): providers.FactoryFixed(p), - addrs.NewProvider("registry.terraform.io", "happycorp", "test"): providers.FactoryFixed(p), - }, - } - - t.Run("basic", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - fmt.Println(output.Stderr()) - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - value = null # REQUIRED string -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("basic to file", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - outPath := "add.tf" - args := []string{fmt.Sprintf("-out=%s", outPath), "test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - fmt.Println(output.Stderr()) - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - value = null # REQUIRED string -} -` - result, err := os.ReadFile(outPath) - if err != nil { - t.Fatalf("error reading result file %s: %s", outPath, err.Error()) - } - // While the entire directory will get removed once the whole test suite - // is done, we remove this lest it gets in the way of another (not yet - // written) test. - os.Remove(outPath) - - if !cmp.Equal(expected, string(result)) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, string(result))) - } - }) - - t.Run("basic to existing file", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - outPath := "add.tf" - args := []string{fmt.Sprintf("-out=%s", outPath), "test_instance.new"} - c.Run(args) - args = []string{fmt.Sprintf("-out=%s", outPath), "test_instance.new2"} - code := c.Run(args) - output := done(t) - if code != 0 { - fmt.Println(output.Stderr()) - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - value = null # REQUIRED string -} -# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new2" { - value = null # REQUIRED string -} -` - result, err := os.ReadFile(outPath) - if err != nil { - t.Fatalf("error reading result file %s: %s", outPath, err.Error()) - } - // While the entire directory will get removed once the whole test suite - // is done, we remove this lest it gets in the way of another (not yet - // written) test. - os.Remove(outPath) - - if !cmp.Equal(expected, string(result)) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, string(result))) - } - }) - - t.Run("optionals", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"-optional", "test_instance.new"} - code := c.Run(args) - if code != 0 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - output := done(t) - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - ami = null # OPTIONAL string - id = null # OPTIONAL string - value = null # REQUIRED string -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("alternate provider for resource", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"-provider=provider[\"registry.terraform.io/happycorp/test\"].alias", "test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - // The provider happycorp/test has a localname "othertest" in the provider configuration. - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - provider = othertest.alias - - value = null # REQUIRED string -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("resource exists error", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - outPath := "add.tf" - args := []string{fmt.Sprintf("-out=%s", outPath), "test_instance.exists"} - code := c.Run(args) - if code != 1 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - output := done(t) - if !strings.Contains(output.Stderr(), "The resource test_instance.exists is already in this configuration") { - t.Fatalf("missing expected error message: %s", output.Stderr()) - } - }) - - t.Run("output existing resource to stdout", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"test_instance.exists"} - code := c.Run(args) - output := done(t) - if code != 0 { - fmt.Println(output.Stderr()) - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "exists" { - value = null # REQUIRED string -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("provider not in configuration", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"toast_instance.new"} - code := c.Run(args) - if code != 1 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - output := done(t) - if !strings.Contains(output.Stderr(), "No schema found for provider registry.terraform.io/hashicorp/toast.") { - t.Fatalf("missing expected error message: %s", output.Stderr()) - } - }) - - t.Run("no schema for resource", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"test_pet.meow"} - code := c.Run(args) - if code != 1 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - output := done(t) - if !strings.Contains(output.Stderr(), "No resource schema found for test_pet.") { - t.Fatalf("missing expected error message: %s", output.Stderr()) - } - }) -} - -func TestAdd(t *testing.T) { - td := tempDir(t) - testCopyDir(t, testFixturePath("add/module"), td) - defer os.RemoveAll(td) - defer testChdir(t, td)() - - // a simple hashicorp/test provider, and a more complex happycorp/test provider - p := testProvider() - p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{ - ResourceTypes: map[string]providers.Schema{ - "test_instance": { - Block: &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Required: true}, - }, - }, - }, - }, - } - - happycorp := testProvider() - happycorp.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{ - ResourceTypes: map[string]providers.Schema{ - "test_instance": { - Block: &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Optional: true, Computed: true}, - "ami": {Type: cty.String, Optional: true, Description: "the ami to use"}, - "value": {Type: cty.String, Required: true, Description: "a value of a thing"}, - "disks": { - NestedType: &configschema.Object{ - Nesting: configschema.NestingList, - Attributes: map[string]*configschema.Attribute{ - "size": {Type: cty.String, Optional: true}, - "mount_point": {Type: cty.String, Required: true}, - }, - }, - Optional: true, - }, - }, - BlockTypes: map[string]*configschema.NestedBlock{ - "network_interface": { - Nesting: configschema.NestingList, - MinItems: 1, - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "device_index": {Type: cty.String, Optional: true}, - "description": {Type: cty.String, Optional: true}, - }, - }, - }, - }, - }, - }, - }, - } - providerSource, psClose := newMockProviderSource(t, map[string][]string{ - "registry.terraform.io/happycorp/test": {"1.0.0"}, - "registry.terraform.io/hashicorp/test": {"1.0.0"}, - }) - defer psClose() - - overrides := &testingOverrides{ - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewProvider("registry.terraform.io", "happycorp", "test"): providers.FactoryFixed(happycorp), - addrs.NewDefaultProvider("test"): providers.FactoryFixed(p), - }, - } - - // the test fixture uses a module, so we need to run init. - m := Meta{ - testingOverrides: overrides, - ProviderSource: providerSource, - Ui: new(cli.MockUi), - } - - init := &InitCommand{ - Meta: m, - } - - code := init.Run([]string{}) - if code != 0 { - t.Fatal("init failed") - } - - t.Run("optional", func(t *testing.T) { - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"-optional", "test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - ami = null # OPTIONAL string - disks = [{ # OPTIONAL list of object - mount_point = null # REQUIRED string - size = null # OPTIONAL string - }] - id = null # OPTIONAL string - value = null # REQUIRED string - network_interface { # REQUIRED block - description = null # OPTIONAL string - device_index = null # OPTIONAL string - } -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - - }) - - t.Run("chooses correct provider for root module", func(t *testing.T) { - // in the root module of this test fixture, "test" is the local name for "happycorp/test" - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - value = null # REQUIRED string - network_interface { # REQUIRED block - } -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("chooses correct provider for child module", func(t *testing.T) { - // in the child module of this test fixture, "test" is a default "hashicorp/test" provider - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"module.child.test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - id = null # REQUIRED string -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("chooses correct provider for an unknown module", func(t *testing.T) { - // it's weird but ok to use a new/unknown module name; terraform will - // fall back on default providers (unless a -provider argument is - // supplied) - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - args := []string{"module.madeup.test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - id = null # REQUIRED string -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - }) -} - -func TestAdd_from_state(t *testing.T) { - td := tempDir(t) - testCopyDir(t, testFixturePath("add/basic"), td) - defer os.RemoveAll(td) - defer testChdir(t, td)() - - // write some state - testState := states.BuildState(func(s *states.SyncState) { - s.SetResourceInstanceCurrent( - addrs.Resource{ - Mode: addrs.ManagedResourceMode, - Type: "test_instance", - Name: "new", - }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), - &states.ResourceInstanceObjectSrc{ - AttrsJSON: []byte("{\"id\":\"bar\",\"ami\":\"ami-123456\",\"disks\":[{\"mount_point\":\"diska\",\"size\":null}],\"value\":\"bloop\"}"), - Status: states.ObjectReady, - Dependencies: []addrs.ConfigResource{}, - }, - mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`), - ) - }) - f, err := os.Create("terraform.tfstate") - if err != nil { - t.Fatalf("failed to create temporary state file: %s", err) - } - defer f.Close() - err = writeStateForTesting(testState, f) - if err != nil { - t.Fatalf("failed to write state file: %s", err) - } - - p := testProvider() - p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{ - ResourceTypes: map[string]providers.Schema{ - "test_instance": { - Block: &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Optional: true, Computed: true}, - "ami": {Type: cty.String, Optional: true, Description: "the ami to use"}, - "value": {Type: cty.String, Required: true, Description: "a value of a thing"}, - "disks": { - NestedType: &configschema.Object{ - Nesting: configschema.NestingList, - Attributes: map[string]*configschema.Attribute{ - "size": {Type: cty.String, Optional: true}, - "mount_point": {Type: cty.String, Required: true}, - }, - }, - Optional: true, - }, - }, - BlockTypes: map[string]*configschema.NestedBlock{ - "network_interface": { - Nesting: configschema.NestingList, - MinItems: 1, - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "device_index": {Type: cty.String, Optional: true}, - "description": {Type: cty.String, Optional: true}, - }, - }, - }, - }, - }, - }, - }, - } - overrides := &testingOverrides{ - Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): providers.FactoryFixed(p), - addrs.NewProvider("registry.terraform.io", "happycorp", "test"): providers.FactoryFixed(p), - }, - } - view, done := testView(t) - c := &AddCommand{ - Meta: Meta{ - testingOverrides: overrides, - View: view, - }, - } - - args := []string{"-from-state", "test_instance.new"} - code := c.Run(args) - output := done(t) - if code != 0 { - fmt.Println(output.Stderr()) - t.Fatalf("wrong exit status. Got %d, want 0", code) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "new" { - ami = "ami-123456" - disks = [ - { - mount_point = "diska" - size = null - }, - ] - id = "bar" - value = "bloop" -} -` - - if !cmp.Equal(output.Stdout(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, output.Stdout())) - } - - if _, err := os.Stat(filepath.Join(td, ".terraform.tfstate.lock.info")); !os.IsNotExist(err) { - t.Fatal("state left locked after add") - } -} diff --git a/internal/command/arguments/add.go b/internal/command/arguments/add.go deleted file mode 100644 index 18fa59f1ba41..000000000000 --- a/internal/command/arguments/add.go +++ /dev/null @@ -1,110 +0,0 @@ -package arguments - -import ( - "fmt" - - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/tfdiags" -) - -// Add represents the command-line arguments for the Add command. -type Add struct { - // Addr specifies which resource to generate configuration for. - Addr addrs.AbsResourceInstance - - // FromState specifies that the configuration should be populated with - // values from state. - FromState bool - - // OutPath contains an optional path to store the generated configuration. - OutPath string - - // Optional specifies whether or not to include optional attributes in the - // generated configuration. Defaults to false. - Optional bool - - // Provider specifies the provider for the target. - Provider *addrs.AbsProviderConfig - - // State from the common extended flags. - State *State - - // ViewType specifies which output format to use. ViewHuman is currently the - // only supported view type. - ViewType ViewType -} - -func ParseAdd(args []string) (*Add, tfdiags.Diagnostics) { - add := &Add{State: &State{}, ViewType: ViewHuman} - - var diags tfdiags.Diagnostics - var provider string - - cmdFlags := extendedFlagSet("add", add.State, nil, nil) - cmdFlags.BoolVar(&add.FromState, "from-state", false, "fill attribute values from a resource already managed by terraform") - cmdFlags.BoolVar(&add.Optional, "optional", false, "include optional attributes") - cmdFlags.StringVar(&add.OutPath, "out", "", "out") - cmdFlags.StringVar(&provider, "provider", "", "provider") - - if err := cmdFlags.Parse(args); err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Failed to parse command-line flags", - err.Error(), - )) - return add, diags - } - - args = cmdFlags.Args() - if len(args) != 1 { - //var adj string - adj := "few" - if len(args) > 1 { - adj = "many" - } - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - fmt.Sprintf("Too %s command line arguments", adj), - "Expected exactly one positional argument, giving the address of the resource to generate configuration for.", - )) - return add, diags - } - - // parse address from the argument - addr, addrDiags := addrs.ParseAbsResourceInstanceStr(args[0]) - if addrDiags.HasErrors() { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - fmt.Sprintf("Error parsing resource address: %s", args[0]), - "This command requires that the address argument specifies one resource instance.", - )) - return add, diags - } - add.Addr = addr - - if provider != "" { - if add.FromState { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Incompatible command-line options", - "Cannot use both -from-state and -provider. The provider will be determined from the resource's state.", - )) - return add, diags - } - - absProvider, providerDiags := addrs.ParseAbsProviderConfigStr(provider) - if providerDiags.HasErrors() { - // The diagnostics returned from ParseAbsProviderConfigStr are - // not always clear, so we wrap them in a single customized diagnostic. - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - fmt.Sprintf("Invalid provider string: %s", provider), - providerDiags.Err().Error(), - )) - return add, diags - } - add.Provider = &absProvider - } - - return add, diags -} diff --git a/internal/command/arguments/add_test.go b/internal/command/arguments/add_test.go deleted file mode 100644 index bc63255cd2a3..000000000000 --- a/internal/command/arguments/add_test.go +++ /dev/null @@ -1,146 +0,0 @@ -package arguments - -import ( - "testing" - - "github.com/google/go-cmp/cmp" - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/tfdiags" -) - -func TestParseAdd(t *testing.T) { - tests := map[string]struct { - args []string - want *Add - wantError string - }{ - "defaults": { - []string{"test_foo.bar"}, - &Add{ - Addr: mustResourceInstanceAddr("test_foo.bar"), - State: &State{Lock: true}, - ViewType: ViewHuman, - }, - ``, - }, - "some flags": { - []string{"-optional=true", "test_foo.bar"}, - &Add{ - Addr: mustResourceInstanceAddr("test_foo.bar"), - State: &State{Lock: true}, - Optional: true, - ViewType: ViewHuman, - }, - ``, - }, - "-from-state": { - []string{"-from-state", "module.foo.test_foo.baz"}, - &Add{ - Addr: mustResourceInstanceAddr("module.foo.test_foo.baz"), - State: &State{Lock: true}, - ViewType: ViewHuman, - FromState: true, - }, - ``, - }, - "-provider": { - []string{"-provider=provider[\"example.com/happycorp/test\"]", "test_foo.bar"}, - &Add{ - Addr: mustResourceInstanceAddr("test_foo.bar"), - State: &State{Lock: true}, - ViewType: ViewHuman, - Provider: &addrs.AbsProviderConfig{ - Provider: addrs.NewProvider("example.com", "happycorp", "test"), - }, - }, - ``, - }, - "state options from extended flag set": { - []string{"-state=local.tfstate", "test_foo.bar"}, - &Add{ - Addr: mustResourceInstanceAddr("test_foo.bar"), - State: &State{Lock: true, StatePath: "local.tfstate"}, - ViewType: ViewHuman, - }, - ``, - }, - - // Error cases - "missing required argument": { - nil, - &Add{ - ViewType: ViewHuman, - State: &State{Lock: true}, - }, - `Too few command line arguments`, - }, - "too many arguments": { - []string{"-from-state", "resource_foo.bar", "module.foo.resource_foo.baz"}, - &Add{ - ViewType: ViewHuman, - State: &State{Lock: true}, - FromState: true, - }, - `Too many command line arguments`, - }, - "invalid target address": { - []string{"definitely-not_a-VALID-resource"}, - &Add{ - ViewType: ViewHuman, - State: &State{Lock: true}, - }, - `Error parsing resource address: definitely-not_a-VALID-resource`, - }, - "invalid provider flag": { - []string{"-provider=/this/isn't/quite/correct", "resource_foo.bar"}, - &Add{ - Addr: mustResourceInstanceAddr("resource_foo.bar"), - ViewType: ViewHuman, - State: &State{Lock: true}, - }, - `Invalid provider string: /this/isn't/quite/correct`, - }, - "incompatible options": { - []string{"-from-state", "-provider=provider[\"example.com/happycorp/test\"]", "test_compute.bar"}, - &Add{ViewType: ViewHuman, - Addr: mustResourceInstanceAddr("test_compute.bar"), - State: &State{Lock: true}, - FromState: true, - }, - `Incompatible command-line options`, - }, - } - - for name, test := range tests { - t.Run(name, func(t *testing.T) { - got, diags := ParseAdd(test.args) - if test.wantError != "" { - if len(diags) != 1 { - t.Fatalf("got %d diagnostics; want exactly 1\n", len(diags)) - } - if diags[0].Severity() != tfdiags.Error { - t.Fatalf("got a warning; want an error\n%s", diags.ErrWithWarnings()) - } - if desc := diags[0].Description(); desc.Summary != test.wantError { - t.Fatalf("wrong error\ngot: %s\nwant: %s", desc.Summary, test.wantError) - } - } else { - if len(diags) != 0 { - t.Fatalf("got %d diagnostics; want none\n%s", len(diags), diags.Err().Error()) - } - } - - if diff := cmp.Diff(test.want, got); diff != "" { - t.Errorf("unexpected result\n%s", diff) - } - }) - } -} - -func mustResourceInstanceAddr(s string) addrs.AbsResourceInstance { - addr, diags := addrs.ParseAbsResourceInstanceStr(s) - if diags.HasErrors() { - panic(diags.Err()) - } - return addr -} diff --git a/internal/command/command_test.go b/internal/command/command_test.go index 4b6fcf311c77..5fab71f1fc64 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -1003,14 +1003,6 @@ func mustResourceAddr(s string) addrs.ConfigResource { return addr.Config() } -func mustProviderConfig(s string) addrs.AbsProviderConfig { - p, diags := addrs.ParseAbsProviderConfigStr(s) - if diags.HasErrors() { - panic(diags.Err()) - } - return p -} - // This map from provider type name to namespace is used by the fake registry // when called via LookupLegacyProvider. Providers not in this map will return // a 404 Not Found error. diff --git a/internal/command/testdata/add/basic/main.tf b/internal/command/testdata/add/basic/main.tf deleted file mode 100644 index ec661dbd9025..000000000000 --- a/internal/command/testdata/add/basic/main.tf +++ /dev/null @@ -1,14 +0,0 @@ -terraform { - required_providers { - test = { - source = "hashicorp/test" - } - othertest = { - source = "happycorp/test" - } - } -} - -resource "test_instance" "exists" { - // I exist! -} \ No newline at end of file diff --git a/internal/command/testdata/add/module/main.tf b/internal/command/testdata/add/module/main.tf deleted file mode 100644 index 11fca99237f5..000000000000 --- a/internal/command/testdata/add/module/main.tf +++ /dev/null @@ -1,17 +0,0 @@ -terraform { - required_providers { - // This is deliberately odd, so we can test that the correct happycorp - // provider is selected for any test_ resource added for this module - test = { - source = "happycorp/test" - } - } -} - -resource "test_instance" "exists" { - // I exist! -} - -module "child" { - source = "./module" -} \ No newline at end of file diff --git a/internal/command/testdata/add/module/module/main.tf b/internal/command/testdata/add/module/module/main.tf deleted file mode 100644 index 55210f20f31f..000000000000 --- a/internal/command/testdata/add/module/module/main.tf +++ /dev/null @@ -1,9 +0,0 @@ -terraform { - required_providers { - test = { - source = "hashicorp/test" - } - } -} - -resource "test_instance" "exists" {} \ No newline at end of file diff --git a/internal/command/views/add.go b/internal/command/views/add.go deleted file mode 100644 index c009fb463e7c..000000000000 --- a/internal/command/views/add.go +++ /dev/null @@ -1,562 +0,0 @@ -package views - -import ( - "fmt" - "os" - "sort" - "strings" - - "github.com/hashicorp/hcl/v2/hclwrite" - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/command/arguments" - "github.com/hashicorp/terraform/internal/configs/configschema" - "github.com/hashicorp/terraform/internal/lang/marks" - "github.com/hashicorp/terraform/internal/tfdiags" - "github.com/zclconf/go-cty/cty" -) - -// Add is the view interface for the "terraform add" command. -type Add interface { - Resource(addrs.AbsResourceInstance, *configschema.Block, addrs.LocalProviderConfig, cty.Value) error - Diagnostics(tfdiags.Diagnostics) -} - -// NewAdd returns an initialized Validate implementation. At this time, -// ViewHuman is the only implemented view type. -func NewAdd(vt arguments.ViewType, view *View, args *arguments.Add) Add { - return &addHuman{ - view: view, - optional: args.Optional, - outPath: args.OutPath, - } -} - -type addHuman struct { - view *View - optional bool - outPath string -} - -func (v *addHuman) Resource(addr addrs.AbsResourceInstance, schema *configschema.Block, pc addrs.LocalProviderConfig, stateVal cty.Value) error { - var buf strings.Builder - - buf.WriteString(`# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -`) - - buf.WriteString(fmt.Sprintf("resource %q %q {\n", addr.Resource.Resource.Type, addr.Resource.Resource.Name)) - - if pc.LocalName != addr.Resource.Resource.ImpliedProvider() || pc.Alias != "" { - buf.WriteString(strings.Repeat(" ", 2)) - buf.WriteString(fmt.Sprintf("provider = %s\n\n", pc.StringCompact())) - } - - if stateVal.RawEquals(cty.NilVal) { - if err := v.writeConfigAttributes(&buf, schema.Attributes, 2); err != nil { - return err - } - if err := v.writeConfigBlocks(&buf, schema.BlockTypes, 2); err != nil { - return err - } - } else { - if err := v.writeConfigAttributesFromExisting(&buf, stateVal, schema.Attributes, 2); err != nil { - return err - } - if err := v.writeConfigBlocksFromExisting(&buf, stateVal, schema.BlockTypes, 2); err != nil { - return err - } - } - - buf.WriteString("}") - - // The output better be valid HCL which can be parsed and formatted. - formatted := hclwrite.Format([]byte(buf.String())) - - var err error - if v.outPath == "" { - _, err = v.view.streams.Println(string(formatted)) - return err - } else { - // The Println call above adds this final newline automatically; we add it manually here. - formatted = append(formatted, '\n') - - f, err := os.OpenFile(v.outPath, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600) - if err != nil { - return err - } - defer f.Close() - _, err = f.Write(formatted) - return err - } -} - -func (v *addHuman) Diagnostics(diags tfdiags.Diagnostics) { - v.view.Diagnostics(diags) -} - -func (v *addHuman) writeConfigAttributes(buf *strings.Builder, attrs map[string]*configschema.Attribute, indent int) error { - if len(attrs) == 0 { - return nil - } - - // Get a list of sorted attribute names so the output will be consistent between runs. - keys := make([]string, 0, len(attrs)) - for k := range attrs { - keys = append(keys, k) - } - sort.Strings(keys) - - for i := range keys { - name := keys[i] - attrS := attrs[name] - if attrS.NestedType != nil { - if err := v.writeConfigNestedTypeAttribute(buf, name, attrS, indent); err != nil { - return err - } - continue - } - if attrS.Required { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = ", name)) - tok := hclwrite.TokensForValue(attrS.EmptyValue()) - if _, err := tok.WriteTo(buf); err != nil { - return err - } - writeAttrTypeConstraint(buf, attrS) - } else if attrS.Optional && v.optional { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = ", name)) - tok := hclwrite.TokensForValue(attrS.EmptyValue()) - if _, err := tok.WriteTo(buf); err != nil { - return err - } - writeAttrTypeConstraint(buf, attrS) - } - } - return nil -} - -func (v *addHuman) writeConfigAttributesFromExisting(buf *strings.Builder, stateVal cty.Value, attrs map[string]*configschema.Attribute, indent int) error { - if len(attrs) == 0 { - return nil - } - - // Get a list of sorted attribute names so the output will be consistent between runs. - keys := make([]string, 0, len(attrs)) - for k := range attrs { - keys = append(keys, k) - } - sort.Strings(keys) - - for i := range keys { - name := keys[i] - attrS := attrs[name] - if attrS.NestedType != nil { - if err := v.writeConfigNestedTypeAttributeFromExisting(buf, name, attrS, stateVal, indent); err != nil { - return err - } - continue - } - - // Exclude computed-only attributes - if attrS.Required || attrS.Optional { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = ", name)) - - var val cty.Value - if stateVal.Type().HasAttribute(name) { - val = stateVal.GetAttr(name) - } else { - val = attrS.EmptyValue() - } - if attrS.Sensitive || val.HasMark(marks.Sensitive) { - buf.WriteString("null # sensitive") - } else { - val, _ = val.Unmark() - tok := hclwrite.TokensForValue(val) - if _, err := tok.WriteTo(buf); err != nil { - return err - } - } - - buf.WriteString("\n") - } - } - return nil -} - -func (v *addHuman) writeConfigBlocks(buf *strings.Builder, blocks map[string]*configschema.NestedBlock, indent int) error { - if len(blocks) == 0 { - return nil - } - - // Get a list of sorted block names so the output will be consistent between runs. - names := make([]string, 0, len(blocks)) - for k := range blocks { - names = append(names, k) - } - sort.Strings(names) - - for i := range names { - name := names[i] - blockS := blocks[name] - if err := v.writeConfigNestedBlock(buf, name, blockS, indent); err != nil { - return err - } - } - return nil -} - -func (v *addHuman) writeConfigNestedBlock(buf *strings.Builder, name string, schema *configschema.NestedBlock, indent int) error { - if !v.optional && schema.MinItems == 0 { - return nil - } - - switch schema.Nesting { - case configschema.NestingSingle, configschema.NestingGroup: - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s {", name)) - writeBlockTypeConstraint(buf, schema) - if err := v.writeConfigAttributes(buf, schema.Attributes, indent+2); err != nil { - return err - } - if err := v.writeConfigBlocks(buf, schema.BlockTypes, indent+2); err != nil { - return err - } - buf.WriteString("}\n") - return nil - case configschema.NestingList, configschema.NestingSet: - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s {", name)) - writeBlockTypeConstraint(buf, schema) - if err := v.writeConfigAttributes(buf, schema.Attributes, indent+2); err != nil { - return err - } - if err := v.writeConfigBlocks(buf, schema.BlockTypes, indent+2); err != nil { - return err - } - buf.WriteString("}\n") - return nil - case configschema.NestingMap: - buf.WriteString(strings.Repeat(" ", indent)) - // we use an arbitrary placeholder key (block label) "key" - buf.WriteString(fmt.Sprintf("%s \"key\" {", name)) - writeBlockTypeConstraint(buf, schema) - if err := v.writeConfigAttributes(buf, schema.Attributes, indent+2); err != nil { - return err - } - if err := v.writeConfigBlocks(buf, schema.BlockTypes, indent+2); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("}\n") - return nil - default: - // This should not happen, the above should be exhaustive. - return fmt.Errorf("unsupported NestingMode %s", schema.Nesting.String()) - } -} - -func (v *addHuman) writeConfigNestedTypeAttribute(buf *strings.Builder, name string, schema *configschema.Attribute, indent int) error { - if !schema.Required && !v.optional { - return nil - } - - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = ", name)) - - switch schema.NestedType.Nesting { - case configschema.NestingSingle: - buf.WriteString("{") - writeAttrTypeConstraint(buf, schema) - if err := v.writeConfigAttributes(buf, schema.NestedType.Attributes, indent+2); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("}\n") - return nil - case configschema.NestingList, configschema.NestingSet: - buf.WriteString("[{") - writeAttrTypeConstraint(buf, schema) - if err := v.writeConfigAttributes(buf, schema.NestedType.Attributes, indent+2); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("}]\n") - return nil - case configschema.NestingMap: - buf.WriteString("{") - writeAttrTypeConstraint(buf, schema) - buf.WriteString(strings.Repeat(" ", indent+2)) - // we use an arbitrary placeholder key "key" - buf.WriteString("key = {\n") - if err := v.writeConfigAttributes(buf, schema.NestedType.Attributes, indent+4); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent+2)) - buf.WriteString("}\n") - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("}\n") - return nil - default: - // This should not happen, the above should be exhaustive. - return fmt.Errorf("unsupported NestingMode %s", schema.NestedType.Nesting.String()) - } -} - -func (v *addHuman) writeConfigBlocksFromExisting(buf *strings.Builder, stateVal cty.Value, blocks map[string]*configschema.NestedBlock, indent int) error { - if len(blocks) == 0 { - return nil - } - - // Get a list of sorted block names so the output will be consistent between runs. - names := make([]string, 0, len(blocks)) - for k := range blocks { - names = append(names, k) - } - sort.Strings(names) - - for _, name := range names { - blockS := blocks[name] - // This shouldn't happen in real usage; state always has all values (set - // to null as needed), but it protects against panics in tests (and any - // really weird and unlikely cases). - if !stateVal.Type().HasAttribute(name) { - continue - } - blockVal := stateVal.GetAttr(name) - if err := v.writeConfigNestedBlockFromExisting(buf, name, blockS, blockVal, indent); err != nil { - return err - } - } - - return nil -} - -func (v *addHuman) writeConfigNestedTypeAttributeFromExisting(buf *strings.Builder, name string, schema *configschema.Attribute, stateVal cty.Value, indent int) error { - switch schema.NestedType.Nesting { - case configschema.NestingSingle: - if schema.Sensitive || stateVal.HasMark(marks.Sensitive) { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = {} # sensitive\n", name)) - return nil - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = {\n", name)) - - // This shouldn't happen in real usage; state always has all values (set - // to null as needed), but it protects against panics in tests (and any - // really weird and unlikely cases). - if !stateVal.Type().HasAttribute(name) { - return nil - } - nestedVal := stateVal.GetAttr(name) - if err := v.writeConfigAttributesFromExisting(buf, nestedVal, schema.NestedType.Attributes, indent+2); err != nil { - return err - } - buf.WriteString("}\n") - return nil - - case configschema.NestingList, configschema.NestingSet: - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = [", name)) - - if schema.Sensitive || stateVal.HasMark(marks.Sensitive) { - buf.WriteString("] # sensitive\n") - return nil - } - - buf.WriteString("\n") - - listVals := ctyCollectionValues(stateVal.GetAttr(name)) - for i := range listVals { - buf.WriteString(strings.Repeat(" ", indent+2)) - - // The entire element is marked. - if listVals[i].HasMark(marks.Sensitive) { - buf.WriteString("{}, # sensitive\n") - continue - } - - buf.WriteString("{\n") - if err := v.writeConfigAttributesFromExisting(buf, listVals[i], schema.NestedType.Attributes, indent+4); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent+2)) - buf.WriteString("},\n") - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("]\n") - return nil - - case configschema.NestingMap: - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s = {", name)) - - if schema.Sensitive || stateVal.HasMark(marks.Sensitive) { - buf.WriteString(" } # sensitive\n") - return nil - } - - buf.WriteString("\n") - - vals := stateVal.GetAttr(name).AsValueMap() - keys := make([]string, 0, len(vals)) - for key := range vals { - keys = append(keys, key) - } - sort.Strings(keys) - for _, key := range keys { - buf.WriteString(strings.Repeat(" ", indent+2)) - buf.WriteString(fmt.Sprintf("%s = {", key)) - - // This entire value is marked - if vals[key].HasMark(marks.Sensitive) { - buf.WriteString("} # sensitive\n") - continue - } - - buf.WriteString("\n") - if err := v.writeConfigAttributesFromExisting(buf, vals[key], schema.NestedType.Attributes, indent+4); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent+2)) - buf.WriteString("}\n") - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("}\n") - return nil - - default: - // This should not happen, the above should be exhaustive. - return fmt.Errorf("unsupported NestingMode %s", schema.NestedType.Nesting.String()) - } -} - -func (v *addHuman) writeConfigNestedBlockFromExisting(buf *strings.Builder, name string, schema *configschema.NestedBlock, stateVal cty.Value, indent int) error { - switch schema.Nesting { - case configschema.NestingSingle, configschema.NestingGroup: - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s {", name)) - - // If the entire value is marked, don't print any nested attributes - if stateVal.HasMark(marks.Sensitive) { - buf.WriteString("} # sensitive\n") - return nil - } - buf.WriteString("\n") - if err := v.writeConfigAttributesFromExisting(buf, stateVal, schema.Attributes, indent+2); err != nil { - return err - } - if err := v.writeConfigBlocksFromExisting(buf, stateVal, schema.BlockTypes, indent+2); err != nil { - return err - } - buf.WriteString("}\n") - return nil - case configschema.NestingList, configschema.NestingSet: - if stateVal.HasMark(marks.Sensitive) { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s {} # sensitive\n", name)) - return nil - } - listVals := ctyCollectionValues(stateVal) - for i := range listVals { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s {\n", name)) - if err := v.writeConfigAttributesFromExisting(buf, listVals[i], schema.Attributes, indent+2); err != nil { - return err - } - if err := v.writeConfigBlocksFromExisting(buf, listVals[i], schema.BlockTypes, indent+2); err != nil { - return err - } - buf.WriteString("}\n") - } - return nil - case configschema.NestingMap: - // If the entire value is marked, don't print any nested attributes - if stateVal.HasMark(marks.Sensitive) { - buf.WriteString(fmt.Sprintf("%s {} # sensitive\n", name)) - return nil - } - - vals := stateVal.AsValueMap() - keys := make([]string, 0, len(vals)) - for key := range vals { - keys = append(keys, key) - } - sort.Strings(keys) - for _, key := range keys { - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString(fmt.Sprintf("%s %q {", name, key)) - // This entire map element is marked - if vals[key].HasMark(marks.Sensitive) { - buf.WriteString("} # sensitive\n") - return nil - } - buf.WriteString("\n") - - if err := v.writeConfigAttributesFromExisting(buf, vals[key], schema.Attributes, indent+2); err != nil { - return err - } - if err := v.writeConfigBlocksFromExisting(buf, vals[key], schema.BlockTypes, indent+2); err != nil { - return err - } - buf.WriteString(strings.Repeat(" ", indent)) - buf.WriteString("}\n") - } - return nil - default: - // This should not happen, the above should be exhaustive. - return fmt.Errorf("unsupported NestingMode %s", schema.Nesting.String()) - } -} - -func writeAttrTypeConstraint(buf *strings.Builder, schema *configschema.Attribute) { - if schema.Required { - buf.WriteString(" # REQUIRED ") - } else { - buf.WriteString(" # OPTIONAL ") - } - - if schema.NestedType != nil { - buf.WriteString(fmt.Sprintf("%s\n", schema.NestedType.ImpliedType().FriendlyName())) - } else { - buf.WriteString(fmt.Sprintf("%s\n", schema.Type.FriendlyName())) - } -} - -func writeBlockTypeConstraint(buf *strings.Builder, schema *configschema.NestedBlock) { - if schema.MinItems > 0 { - buf.WriteString(" # REQUIRED block\n") - } else { - buf.WriteString(" # OPTIONAL block\n") - } -} - -// copied from command/format/diff -func ctyCollectionValues(val cty.Value) []cty.Value { - if !val.IsKnown() || val.IsNull() { - return nil - } - - var len int - if val.IsMarked() { - val, _ = val.Unmark() - len = val.LengthInt() - } else { - len = val.LengthInt() - } - - ret := make([]cty.Value, 0, len) - for it := val.ElementIterator(); it.Next(); { - _, value := it.Element() - ret = append(ret, value) - } - - return ret -} diff --git a/internal/command/views/add_test.go b/internal/command/views/add_test.go deleted file mode 100644 index c0986e4daa41..000000000000 --- a/internal/command/views/add_test.go +++ /dev/null @@ -1,1018 +0,0 @@ -package views - -import ( - "strings" - "testing" - - "github.com/google/go-cmp/cmp" - "github.com/hashicorp/terraform/internal/addrs" - "github.com/hashicorp/terraform/internal/configs/configschema" - "github.com/hashicorp/terraform/internal/lang/marks" - "github.com/hashicorp/terraform/internal/terminal" - "github.com/zclconf/go-cty/cty" -) - -// The output is tested in greater detail in other tests; this suite focuses on -// details specific to the Resource function. -func TestAddResource(t *testing.T) { - t.Run("config only", func(t *testing.T) { - streams, done := terminal.StreamsForTesting(t) - v := addHuman{view: NewView(streams), optional: true} - err := v.Resource( - mustResourceInstanceAddr("test_instance.foo"), - addTestSchemaSensitive(configschema.NestingSingle), - addrs.NewDefaultLocalProviderConfig("mytest"), cty.NilVal, - ) - if err != nil { - t.Fatal(err.Error()) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "foo" { - provider = mytest - - ami = null # OPTIONAL string - disks = { # OPTIONAL object - mount_point = null # OPTIONAL string - size = null # OPTIONAL string - } - id = null # OPTIONAL string - root_block_device { # OPTIONAL block - volume_type = null # OPTIONAL string - } -} -` - output := done(t) - if output.Stdout() != expected { - t.Errorf("wrong result: %s", cmp.Diff(expected, output.Stdout())) - } - }) - - t.Run("from state", func(t *testing.T) { - streams, done := terminal.StreamsForTesting(t) - v := addHuman{view: NewView(streams), optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "ami": cty.StringVal("ami-123456789"), - "disks": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB"), - }), - }) - - err := v.Resource( - mustResourceInstanceAddr("test_instance.foo"), - addTestSchemaSensitive(configschema.NestingSingle), - addrs.NewDefaultLocalProviderConfig("mytest"), val, - ) - if err != nil { - t.Fatal(err.Error()) - } - - expected := `# NOTE: The "terraform add" command is currently experimental and offers only a -# starting point for your resource configuration, with some limitations. -# -# The behavior of this command may change in future based on feedback, possibly -# in incompatible ways. We don't recommend building automation around this -# command at this time. If you have feedback about this command, please open -# a feature request issue in the Terraform GitHub repository. -resource "test_instance" "foo" { - provider = mytest - - ami = "ami-123456789" - disks = {} # sensitive - id = null -} -` - output := done(t) - if output.Stdout() != expected { - t.Errorf("wrong result: %s", cmp.Diff(expected, output.Stdout())) - } - }) - -} - -func TestAdd_writeConfigAttributes(t *testing.T) { - tests := map[string]struct { - attrs map[string]*configschema.Attribute - expected string - }{ - "empty returns nil": { - map[string]*configschema.Attribute{}, - "", - }, - "attributes": { - map[string]*configschema.Attribute{ - "ami": { - Type: cty.Number, - Required: true, - }, - "boot_disk": { - Type: cty.String, - Optional: true, - }, - "password": { - Type: cty.String, - Optional: true, - Sensitive: true, // sensitivity is ignored when printing blank templates - }, - }, - `ami = null # REQUIRED number -boot_disk = null # OPTIONAL string -password = null # OPTIONAL string -`, - }, - "attributes with nested types": { - map[string]*configschema.Attribute{ - "ami": { - Type: cty.Number, - Required: true, - }, - "disks": { - NestedType: &configschema.Object{ - Nesting: configschema.NestingSingle, - Attributes: map[string]*configschema.Attribute{ - "size": { - Type: cty.Number, - Optional: true, - }, - "mount_point": { - Type: cty.String, - Required: true, - }, - }, - }, - Optional: true, - }, - }, - `ami = null # REQUIRED number -disks = { # OPTIONAL object - mount_point = null # REQUIRED string - size = null # OPTIONAL number -} -`, - }, - } - - v := addHuman{optional: true} - - for name, test := range tests { - t.Run(name, func(t *testing.T) { - var buf strings.Builder - if err := v.writeConfigAttributes(&buf, test.attrs, 0); err != nil { - t.Errorf("unexpected error") - } - if buf.String() != test.expected { - t.Errorf("wrong result: %s", cmp.Diff(test.expected, buf.String())) - } - }) - } -} - -func TestAdd_writeConfigAttributesFromExisting(t *testing.T) { - attrs := map[string]*configschema.Attribute{ - "ami": { - Type: cty.Number, - Required: true, - }, - "boot_disk": { - Type: cty.String, - Optional: true, - }, - "password": { - Type: cty.String, - Optional: true, - Sensitive: true, - }, - "disks": { - NestedType: &configschema.Object{ - Nesting: configschema.NestingSingle, - Attributes: map[string]*configschema.Attribute{ - "size": { - Type: cty.Number, - Optional: true, - }, - "mount_point": { - Type: cty.String, - Required: true, - }, - }, - }, - Optional: true, - }, - } - - tests := map[string]struct { - attrs map[string]*configschema.Attribute - val cty.Value - expected string - }{ - "empty returns nil": { - map[string]*configschema.Attribute{}, - cty.NilVal, - "", - }, - "mixed attributes": { - attrs, - cty.ObjectVal(map[string]cty.Value{ - "ami": cty.NumberIntVal(123456), - "boot_disk": cty.NullVal(cty.String), - "password": cty.StringVal("i am secret"), - "disks": cty.ObjectVal(map[string]cty.Value{ - "size": cty.NumberIntVal(50), - "mount_point": cty.NullVal(cty.String), - }), - }), - `ami = 123456 -boot_disk = null -disks = { - mount_point = null - size = 50 -} -password = null # sensitive -`, - }, - } - - v := addHuman{optional: true} - - for name, test := range tests { - t.Run(name, func(t *testing.T) { - var buf strings.Builder - if err := v.writeConfigAttributesFromExisting(&buf, test.val, test.attrs, 0); err != nil { - t.Errorf("unexpected error") - } - if buf.String() != test.expected { - t.Errorf("wrong result: %s", cmp.Diff(test.expected, buf.String())) - } - }) - } -} - -func TestAdd_writeConfigBlocks(t *testing.T) { - t.Run("NestingSingle", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigBlocks(&buf, schema.BlockTypes, 0) - - expected := `network_rules { # REQUIRED block - ip_address = null # OPTIONAL string -} -root_block_device { # OPTIONAL block - volume_type = null # OPTIONAL string -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Errorf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigBlocks(&buf, schema.BlockTypes, 0) - - expected := `network_rules { # REQUIRED block - ip_address = null # OPTIONAL string -} -root_block_device { # OPTIONAL block - volume_type = null # OPTIONAL string -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSet", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingSet) - var buf strings.Builder - v.writeConfigBlocks(&buf, schema.BlockTypes, 0) - - expected := `network_rules { # REQUIRED block - ip_address = null # OPTIONAL string -} -root_block_device { # OPTIONAL block - volume_type = null # OPTIONAL string -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigBlocks(&buf, schema.BlockTypes, 0) - - expected := `network_rules "key" { # REQUIRED block - ip_address = null # OPTIONAL string -} -root_block_device "key" { # OPTIONAL block - volume_type = null # OPTIONAL string -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) -} - -func TestAdd_writeConfigBlocksFromExisting(t *testing.T) { - - t.Run("NestingSingle", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - }) - schema := addTestSchema(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device { - volume_type = "foo" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Errorf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSingle_marked_attr", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo").Mark(marks.Sensitive), - }), - }) - schema := addTestSchema(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device { - volume_type = null # sensitive -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Errorf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSingle_entirely_marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - }).Mark(marks.Sensitive) - schema := addTestSchema(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device {} # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Errorf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.ListVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }), - }) - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device { - volume_type = "foo" -} -root_block_device { - volume_type = "bar" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList_marked_attr", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.ListVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo").Mark(marks.Sensitive), - }), - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }), - }) - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device { - volume_type = null # sensitive -} -root_block_device { - volume_type = "bar" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList_entirely_marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.ListVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }).Mark(marks.Sensitive), - }) - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device {} # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSet", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.SetVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }), - }) - schema := addTestSchema(configschema.NestingSet) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device { - volume_type = "bar" -} -root_block_device { - volume_type = "foo" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSet_marked", func(t *testing.T) { - v := addHuman{optional: true} - // In cty.Sets, the entire set ends up marked if any element is marked. - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.SetVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }).Mark(marks.Sensitive), - }) - schema := addTestSchema(configschema.NestingSet) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - // When the entire set of blocks is sensitive, we only print one block. - expected := `root_block_device {} # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.MapVal(map[string]cty.Value{ - "1": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - "2": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }), - }) - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device "1" { - volume_type = "foo" -} -root_block_device "2" { - volume_type = "bar" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap_marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.MapVal(map[string]cty.Value{ - "1": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo").Mark(marks.Sensitive), - }), - "2": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }), - }) - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device "1" { - volume_type = null # sensitive -} -root_block_device "2" { - volume_type = "bar" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap_entirely_marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.MapVal(map[string]cty.Value{ - "1": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - "2": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }), - }).Mark(marks.Sensitive), - }) - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device {} # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap_marked_elem", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "root_block_device": cty.MapVal(map[string]cty.Value{ - "1": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("foo"), - }), - "2": cty.ObjectVal(map[string]cty.Value{ - "volume_type": cty.StringVal("bar"), - }).Mark(marks.Sensitive), - }), - }) - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigBlocksFromExisting(&buf, val, schema.BlockTypes, 0) - - expected := `root_block_device "1" { - volume_type = "foo" -} -root_block_device "2" {} # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) -} - -func TestAdd_writeConfigNestedTypeAttribute(t *testing.T) { - t.Run("NestingSingle", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigNestedTypeAttribute(&buf, "disks", schema.Attributes["disks"], 0) - - expected := `disks = { # OPTIONAL object - mount_point = null # OPTIONAL string - size = null # OPTIONAL string -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigNestedTypeAttribute(&buf, "disks", schema.Attributes["disks"], 0) - - expected := `disks = [{ # OPTIONAL list of object - mount_point = null # OPTIONAL string - size = null # OPTIONAL string -}] -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSet", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingSet) - var buf strings.Builder - v.writeConfigNestedTypeAttribute(&buf, "disks", schema.Attributes["disks"], 0) - - expected := `disks = [{ # OPTIONAL set of object - mount_point = null # OPTIONAL string - size = null # OPTIONAL string -}] -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap", func(t *testing.T) { - v := addHuman{optional: true} - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigNestedTypeAttribute(&buf, "disks", schema.Attributes["disks"], 0) - - expected := `disks = { # OPTIONAL map of object - key = { - mount_point = null # OPTIONAL string - size = null # OPTIONAL string - } -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) -} - -func TestAdd_WriteConfigNestedTypeAttributeFromExisting(t *testing.T) { - t.Run("NestingSingle", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB"), - }), - }) - schema := addTestSchema(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = { - mount_point = "/mnt/foo" - size = "50GB" -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingSingle_sensitive", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB"), - }), - }) - schema := addTestSchemaSensitive(configschema.NestingSingle) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = {} # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.ListVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB"), - }), - cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/bar"), - "size": cty.StringVal("250GB"), - }), - }), - }) - - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = [ - { - mount_point = "/mnt/foo" - size = "50GB" - }, - { - mount_point = "/mnt/bar" - size = "250GB" - }, -] -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList - marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.ListVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB").Mark(marks.Sensitive), - }), - // This is an odd example, where the entire element is marked. - cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/bar"), - "size": cty.StringVal("250GB"), - }).Mark(marks.Sensitive), - }), - }) - - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = [ - { - mount_point = "/mnt/foo" - size = null # sensitive - }, - {}, # sensitive -] -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingList - entirely marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.ListVal([]cty.Value{ - cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB"), - }), - // This is an odd example, where the entire element is marked. - cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/bar"), - "size": cty.StringVal("250GB"), - }), - }), - }).Mark(marks.Sensitive) - - schema := addTestSchema(configschema.NestingList) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = [] # sensitive -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.MapVal(map[string]cty.Value{ - "foo": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB"), - }), - "bar": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/bar"), - "size": cty.StringVal("250GB"), - }), - }), - }) - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = { - bar = { - mount_point = "/mnt/bar" - size = "250GB" - } - foo = { - mount_point = "/mnt/foo" - size = "50GB" - } -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) - - t.Run("NestingMap - marked", func(t *testing.T) { - v := addHuman{optional: true} - val := cty.ObjectVal(map[string]cty.Value{ - "disks": cty.MapVal(map[string]cty.Value{ - "foo": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/foo"), - "size": cty.StringVal("50GB").Mark(marks.Sensitive), - }), - "bar": cty.ObjectVal(map[string]cty.Value{ - "mount_point": cty.StringVal("/mnt/bar"), - "size": cty.StringVal("250GB"), - }).Mark(marks.Sensitive), - }), - }) - schema := addTestSchema(configschema.NestingMap) - var buf strings.Builder - v.writeConfigNestedTypeAttributeFromExisting(&buf, "disks", schema.Attributes["disks"], val, 0) - - expected := `disks = { - bar = {} # sensitive - foo = { - mount_point = "/mnt/foo" - size = null # sensitive - } -} -` - - if !cmp.Equal(buf.String(), expected) { - t.Fatalf("wrong output:\n%s", cmp.Diff(expected, buf.String())) - } - }) -} - -func addTestSchema(nesting configschema.NestingMode) *configschema.Block { - return &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Optional: true, Computed: true}, - // Attributes which are neither optional nor required should not print. - "uuid": {Type: cty.String, Computed: true}, - "ami": {Type: cty.String, Optional: true}, - "disks": { - NestedType: &configschema.Object{ - Attributes: map[string]*configschema.Attribute{ - "mount_point": {Type: cty.String, Optional: true}, - "size": {Type: cty.String, Optional: true}, - }, - Nesting: nesting, - }, - }, - }, - BlockTypes: map[string]*configschema.NestedBlock{ - "root_block_device": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "volume_type": { - Type: cty.String, - Optional: true, - Computed: true, - }, - }, - }, - Nesting: nesting, - }, - "network_rules": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "ip_address": { - Type: cty.String, - Optional: true, - Computed: true, - }, - }, - }, - Nesting: nesting, - MinItems: 1, - }, - }, - } -} - -// addTestSchemaSensitive returns a schema with a sensitive NestedType and a -// NestedBlock with sensitive attributes. -func addTestSchemaSensitive(nesting configschema.NestingMode) *configschema.Block { - return &configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Optional: true, Computed: true}, - // Attributes which are neither optional nor required should not print. - "uuid": {Type: cty.String, Computed: true}, - "ami": {Type: cty.String, Optional: true}, - "disks": { - NestedType: &configschema.Object{ - Attributes: map[string]*configschema.Attribute{ - "mount_point": {Type: cty.String, Optional: true}, - "size": {Type: cty.String, Optional: true}, - }, - Nesting: nesting, - }, - Sensitive: true, - }, - }, - BlockTypes: map[string]*configschema.NestedBlock{ - "root_block_device": { - Block: configschema.Block{ - Attributes: map[string]*configschema.Attribute{ - "volume_type": { - Type: cty.String, - Optional: true, - Computed: true, - Sensitive: true, - }, - }, - }, - Nesting: nesting, - }, - }, - } -} - -func mustResourceInstanceAddr(s string) addrs.AbsResourceInstance { - addr, diags := addrs.ParseAbsResourceInstanceStr(s) - if diags.HasErrors() { - panic(diags.Err()) - } - return addr -} diff --git a/website/docs/cli/commands/add.html.md b/website/docs/cli/commands/add.html.md deleted file mode 100644 index 73364f06deee..000000000000 --- a/website/docs/cli/commands/add.html.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -layout: "docs" -page_title: "Command: add" -sidebar_current: "docs-commands-add" -description: |- - The `terraform add` command generates resource configuration templates. ---- - -# Command: add - -The `terraform add` command generates a starting point for the configuration -of a particular resource. - -~> **Warning:** This command is currently experimental. Its exact behavior and -command line arguments are likely to change in future releases based on -feedback. We don't recommend building automation around the current design of -this command, but it's safe to use directly in a development environment -setting. - -By default, Terraform will include only the subset of arguments that are marked -by the provider as being required, and will use `null` as a placeholder for -their values. You can then replace `null` with suitable expressions in order -to make the arguments valid. - -If you use the `-optional` option then Terraform will also include arguments -that the provider declares as optional. You can then either write a suitable -expression for each argument or remove the arguments you wish to leave unset. - -If you use the `-from-state` option then Terraform will instead generate a -configuration containing expressions which will produce the same values as -the corresponding resource instance object already tracked in the Terraform -state, if for example you've previously imported the object using -[`terraform import`](import.html). - --> **Note:** If you use `-from-state`, the result will not include expressions -for any values which are marked as sensitive in the state. If you want to -see those, you can inspect the state data directly using -`terraform state show ADDRESS`. - -## Usage - -Usage: `terraform add [options] ADDRESS` - -This command requires an address that points to a resource which does not -already exist in the configuration. Addresses are in -[resource addressing format](/docs/cli/state/resource-addressing.html). - -This command accepts the following options: - -* `-from-state` - Fill the template with values from an existing resource - instance already tracked in the state. By default, Terraform will emit only - placeholder values based on the resource type. - -* `-optional` - Include optional arguments. By default, the result will - include only required arguments. - -* `-out=FILENAME` - Write the template to a file, instead of to standard - output. - -* `-provider=provider` - Override the provider configuration for the resource, -using the absolute provider configuration address syntax. - - Absolute provider configuration syntax uses the full source address of - the provider, rather than a local name declared in the relevant module. - For example, to select the aliased provider configuration "us-east-1" - of the official AWS provider, use: - - ``` - -provider='provider["hashicorp/aws"].us-east-1' - ``` - - or, if you are using the Windows command prompt, use Windows-style escaping - for the quotes inside the address: - - ``` - -provider=provider[\"hashicorp/aws\"].us-east-1 - ``` - - This is incompatible with `-from-state`, because in that case Terraform - will use the provider configuration already selected in the state, which - is the provider configuration that most recently managed the object. diff --git a/website/docs/cli/commands/index.html.md b/website/docs/cli/commands/index.html.md index 1b01d60d1339..6fb5919a77ba 100644 --- a/website/docs/cli/commands/index.html.md +++ b/website/docs/cli/commands/index.html.md @@ -39,7 +39,6 @@ Main commands: destroy Destroy previously-created infrastructure All other commands: - add Generate a resource configuration template console Try Terraform expressions at an interactive command prompt fmt Reformat your configuration in the standard style force-unlock Release a stuck lock on the current workspace diff --git a/website/layouts/docs.erb b/website/layouts/docs.erb index da4f0f6c9176..602a490e565d 100644 --- a/website/layouts/docs.erb +++ b/website/layouts/docs.erb @@ -74,10 +74,6 @@ Overview -
  • - add -
    • -
  • console
    • @@ -361,10 +357,6 @@ Alphabetical List of Commands
      -
    • - add -
      • -
    • apply
      • From a1092ecd19171e085d6ade87e124ba8bd61f46a9 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 20 Oct 2021 06:44:03 -0700 Subject: [PATCH 178/644] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bdc81a952ba..bb600131030c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,12 +7,12 @@ UPGRADE NOTES: * `terraform apply` with a previously-saved plan file will now verify that the provider plugin packages used to create the plan fully match the ones used during apply, using the same checksum scheme that Terraform normally uses for the dependency lock file. Previously Terraform was checking consistency of plugins from a plan file using a legacy mechanism which covered only the main plugin executable, not any other files that might be distributed alongside in the plugin package. This additional check should not affect typical plugins that conform to the expectation that a plugin package's contents are immutable once released, but may affect a hypothetical in-house plugin that intentionally modifies extra files in its package directory somehow between plan and apply. If you have such a plugin, you'll need to change its approach to store those files in some other location separate from the package directory. This is a minor compatibility break motivated by increasing the assurance that plugins have not been inadvertently or maliciously modified between plan and apply. +* Earlier v1.1 alpha releases had an experimental new command `terraform add`. We've removed that feature and plan to reconsider it before offering an alternative in a later release. NEW FEATURES: * `terraform plan` and `terraform apply`: When Terraform plans to destroy a resource instance due to it no longer being declared in the configuration, the proposed plan output will now include a note hinting at what situation prompted that proposal, so you can more easily see what configuration change might avoid the object being destroyed. ([#29637](https://github.com/hashicorp/terraform/pull/29637)) * `terraform plan` and `terraform apply`: When Terraform automatically moves a singleton resource instance to index zero or vice-versa in response to adding or removing `count`, it'll report explicitly that it did so as part of the plan output. ([#29605](https://github.com/hashicorp/terraform/pull/29605)) -* `terraform add`: The (currently-experimental) `terraform add` generates a starting point for a particular resource configuration. ([#28874](https://github.com/hashicorp/terraform/issues/28874)) * config: a new `type()` function, available only in `terraform console`. ([#28501](https://github.com/hashicorp/terraform/issues/28501)) ENHANCEMENTS: From 4bb675059daa562414e6c367fe0dbcefe3492765 Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 20 Oct 2021 17:27:51 +0000 Subject: [PATCH 179/644] Release v1.1.0-alpha20211020 --- CHANGELOG.md | 8 ++++---- version/version.go | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bb600131030c..9ef9e1b46f13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,15 +19,15 @@ ENHANCEMENTS: * config: Terraform now checks the syntax of and normalizes module source addresses (the `source` argument in `module` blocks) during configuration decoding rather than only at module installation time. This is largely just an internal refactoring, but a visible benefit of this change is that the `terraform init` messages about module downloading will now show the canonical module package address Terraform is downloading from, after interpreting the special shorthands for common cases like GitHub URLs. ([#28854](https://github.com/hashicorp/terraform/issues/28854)) * `terraform plan` and `terraform apply`: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. ([#29605](https://github.com/hashicorp/terraform/issues/29605)) -* `terraform workspace delete`: will now allow deleting a workspace whose state contains only data resource instances and output values, without running `terraform destroy` first. Previously the presence of data resources would require using `-force` to override the safety check guarding against accidentally forgetting about remote objects, but a data resource is not responsible for the management of its associated remote object(s) anyway. [GH-29754] -* provisioner/remote-exec and provisioner/file: When using SSH agent authentication mode on Windows, Terraform can now detect and use [the Windows 10 built-in OpenSSH Client](https://devblogs.microsoft.com/powershell/using-the-openssh-beta-in-windows-10-fall-creators-update-and-windows-server-1709/)'s SSH Agent, when available, in addition to the existing support for the third-party solution [Pageant](https://documentation.help/PuTTY/pageant.html) that was already supported. [GH-29747] +* `terraform workspace delete`: will now allow deleting a workspace whose state contains only data resource instances and output values, without running `terraform destroy` first. Previously the presence of data resources would require using `-force` to override the safety check guarding against accidentally forgetting about remote objects, but a data resource is not responsible for the management of its associated remote object(s) anyway. ([#29754](https://github.com/hashicorp/terraform/issues/29754)) +* provisioner/remote-exec and provisioner/file: When using SSH agent authentication mode on Windows, Terraform can now detect and use [the Windows 10 built-in OpenSSH Client](https://devblogs.microsoft.com/powershell/using-the-openssh-beta-in-windows-10-fall-creators-update-and-windows-server-1709/)'s SSH Agent, when available, in addition to the existing support for the third-party solution [Pageant](https://documentation.help/PuTTY/pageant.html) that was already supported. ([#29747](https://github.com/hashicorp/terraform/issues/29747)) BUG FIXES: * core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) -* core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources [GH-29682] +* core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources ([#29682](https://github.com/hashicorp/terraform/issues/29682)) * cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) -* cli: Prevent applying a stale planfile when there was no previous state [GH-29755] +* cli: Prevent applying a stale planfile when there was no previous state ([#29755](https://github.com/hashicorp/terraform/issues/29755)) ## Previous Releases diff --git a/version/version.go b/version/version.go index 86f22153dde3..61d155e55235 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "dev" +var Prerelease = "alpha20211020" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From 00a1b7ffb9bfec468cbe45a244573b923376e382 Mon Sep 17 00:00:00 2001 From: hc-github-team-tf-core Date: Wed, 20 Oct 2021 17:42:49 +0000 Subject: [PATCH 180/644] Cleanup after v1.1.0-alpha20211020 release --- version/version.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version/version.go b/version/version.go index 61d155e55235..86f22153dde3 100644 --- a/version/version.go +++ b/version/version.go @@ -16,7 +16,7 @@ var Version = "1.1.0" // A pre-release marker for the version. If this is "" (empty string) // then it means that it is a final release. Otherwise, this is a pre-release // such as "dev" (in development), "beta", "rc1", etc. -var Prerelease = "alpha20211020" +var Prerelease = "dev" // SemVer is an instance of version.Version. This has the secondary // benefit of verifying during tests and init time that our version is a From 1190b95fe2ace17ddcc31891227aaf223d7fe1a9 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 21 Oct 2021 08:41:01 -0400 Subject: [PATCH 181/644] command/e2etest: Ensure init fixes missing cache We test that a deleted provider cache results in an error when running terraform plan, but previously did not test that running init (as instructed) would resolve the issue. This (failing) e2e test adds that step. --- internal/command/e2etest/providers_tamper_test.go | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/internal/command/e2etest/providers_tamper_test.go b/internal/command/e2etest/providers_tamper_test.go index ac5612192050..5335c66f9ba2 100644 --- a/internal/command/e2etest/providers_tamper_test.go +++ b/internal/command/e2etest/providers_tamper_test.go @@ -57,7 +57,7 @@ func TestProviderTampering(t *testing.T) { t.Fatal(err) } - _, stderr, err := tf.Run("plan") + stdout, stderr, err := tf.Run("plan") if err == nil { t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) } @@ -67,6 +67,16 @@ func TestProviderTampering(t *testing.T) { if want := `terraform init`; !strings.Contains(stderr, want) { t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) } + + // Running init as suggested resolves the problem + _, stderr, err = tf.Run("init") + if err != nil { + t.Fatalf("unexpected init error: %s\nstderr:\n%s", err, stderr) + } + _, stderr, err = tf.Run("plan") + if err != nil { + t.Fatalf("unexpected plan error: %s\nstderr:\n%s", err, stderr) + } }) t.Run("null plugin package modified before plan", func(t *testing.T) { tf := e2e.NewBinary(terraformBin, seedDir) From 39de3ebec71e51d5eb44923129b67be732f5d6d8 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 21 Oct 2021 08:44:26 -0400 Subject: [PATCH 182/644] cli: Fix init failure with deleted cache The init command needs to initialize a backend, in order to access state, in turn to derive provider requirements from state. The backend initialization step requires building provider factories, which previously would fail if a lockfile was present without a corresponding local provider cache. This commit ensures that in this situation only, errors with the provider factories are temporarily ignored. This allows us to continue to initialize the backend, fetch providers, and then report any errors as necessary. --- internal/command/init.go | 2 +- internal/command/meta.go | 8 +++--- internal/command/meta_backend.go | 44 ++++++++++++++++++-------------- 3 files changed, 29 insertions(+), 25 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index 8083b7513d32..8f8c5b829ee5 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -238,7 +238,7 @@ func (c *InitCommand) Run(args []string) int { // by a previous run, so we must still expect that "back" may be nil // in code that follows. var backDiags tfdiags.Diagnostics - back, backDiags = c.Backend(nil) + back, backDiags = c.Backend(&BackendOpts{Init: true}) if backDiags.HasErrors() { // This is fine. We'll proceed with no backend, then. back = nil diff --git a/internal/command/meta.go b/internal/command/meta.go index cd9387173f0d..6bfc2d8c71ec 100644 --- a/internal/command/meta.go +++ b/internal/command/meta.go @@ -459,10 +459,8 @@ func (m *Meta) contextOpts() (*terraform.ContextOpts, error) { opts.Providers = m.testingOverrides.Providers opts.Provisioners = m.testingOverrides.Provisioners } else { - providerFactories, err := m.providerFactories() - if err != nil { - return nil, err - } + var providerFactories map[addrs.Provider]providers.Factory + providerFactories, err = m.providerFactories() opts.Providers = providerFactories opts.Provisioners = m.provisionerFactories() } @@ -472,7 +470,7 @@ func (m *Meta) contextOpts() (*terraform.ContextOpts, error) { OriginalWorkingDir: m.WorkingDir.OriginalWorkingDir(), } - return &opts, nil + return &opts, err } // defaultFlagSet creates a default flag set for commands. diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 4d9b115d417a..2524ccb28d3e 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -112,28 +112,34 @@ func (m *Meta) Backend(opts *BackendOpts) (backend.Enhanced, tfdiags.Diagnostics // indicates one or more inconsistencies between the dependency // lock file and the provider plugins actually available in the // local cache directory. - var buf bytes.Buffer - for addr, err := range errs { - fmt.Fprintf(&buf, "\n - %s: %s", addr, err) - } - suggestion := "To download the plugins required for this configuration, run:\n terraform init" - if m.RunningInAutomation { - // Don't mention "terraform init" specifically if we're running in an automation wrapper - suggestion = "You must install the required plugins before running Terraform operations." + // + // If initialization is allowed, we ignore this error, as it may + // be resolved by the later step where providers are fetched. + if !opts.Init { + var buf bytes.Buffer + for addr, err := range errs { + fmt.Fprintf(&buf, "\n - %s: %s", addr, err) + } + suggestion := "To download the plugins required for this configuration, run:\n terraform init" + if m.RunningInAutomation { + // Don't mention "terraform init" specifically if we're running in an automation wrapper + suggestion = "You must install the required plugins before running Terraform operations." + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Required plugins are not installed", + fmt.Sprintf( + "The installed provider plugins are not consistent with the packages selected in the dependency lock file:%s\n\nTerraform uses external plugins to integrate with a variety of different infrastructure services. %s", + buf.String(), suggestion, + ), + )) + return nil, diags } - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Required plugins are not installed", - fmt.Sprintf( - "The installed provider plugins are not consistent with the packages selected in the dependency lock file:%s\n\nTerraform uses external plugins to integrate with a variety of different infrastructure services. %s", - buf.String(), suggestion, - ), - )) } else { // All other errors just get generic handling. diags = diags.Append(err) + return nil, diags } - return nil, diags } cliOpts.Validation = true @@ -337,7 +343,7 @@ func (m *Meta) BackendForPlan(settings plans.Backend) (backend.Enhanced, tfdiags // a backend that supports local CLI operations. func (m *Meta) backendCLIOpts() (*backend.CLIOpts, error) { contextOpts, err := m.contextOpts() - if err != nil { + if contextOpts == nil && err != nil { return nil, err } return &backend.CLIOpts{ @@ -350,7 +356,7 @@ func (m *Meta) backendCLIOpts() (*backend.CLIOpts, error) { ContextOpts: contextOpts, Input: m.Input(), RunningInAutomation: m.RunningInAutomation, - }, nil + }, err } // Operation initializes a new backend.Operation struct. From 6f1eceb0e21bfe75586440d1907b70b7861cbcd7 Mon Sep 17 00:00:00 2001 From: Alex Khaerov Date: Thu, 21 Oct 2021 21:42:13 +0800 Subject: [PATCH 183/644] Revert autoupdate --- internal/backend/remote-state/oss/backend_state.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/backend/remote-state/oss/backend_state.go b/internal/backend/remote-state/oss/backend_state.go index d08e1d133897..1d5c1ce46e8a 100644 --- a/internal/backend/remote-state/oss/backend_state.go +++ b/internal/backend/remote-state/oss/backend_state.go @@ -84,7 +84,7 @@ func (b *Backend) Workspaces() ([]string, error) { } else { options = append(options, oss.Marker(lastObj)) } - bucket.ListObjects(options...) + resp, err = bucket.ListObjects(options...) } else { break } From 172943152049d94532a0707535ffbe7640414679 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 21 Oct 2021 14:10:25 -0400 Subject: [PATCH 184/644] backend/remote: Fix version check when migrating When migrating state to an existing Terraform Cloud workspace using the remote backend, we check the remote version is compatible with the local one by default. This commit fixes two bugs in this code: - If using the "name" strategy for the remote backend, the list of destination workspaces is empty. This resulted in no version checking of the remote workspace, and we fell back to the string equality check. - The user-specified CLI flag `-ignore-remote-version` was not being applied for the state migration version checking. --- internal/command/meta_backend_migrate.go | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index d868200f1bda..15206bf8ae3c 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -77,13 +77,26 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { // as we are migrating away and will not break a remote workspace. m.ignoreRemoteBackendVersionConflict(opts.Source) - for _, workspace := range destinationWorkspaces { + // Disregard remote Terraform version if instructed to do so via CLI flag. + if m.ignoreRemoteVersion { + m.ignoreRemoteBackendVersionConflict(opts.Destination) + } else { // Check the remote Terraform version for the state destination backend. If // it's a Terraform Cloud remote backend, we want to ensure that we don't // break the workspace by uploading an incompatible state file. - diags := m.remoteBackendVersionCheck(opts.Destination, workspace) - if diags.HasErrors() { - return diags.Err() + for _, workspace := range destinationWorkspaces { + diags := m.remoteBackendVersionCheck(opts.Destination, workspace) + if diags.HasErrors() { + return diags.Err() + } + } + // If there are no specified destination workspaces, perform a remote + // backend version check with the default workspace. + if len(destinationWorkspaces) == 0 { + diags := m.remoteBackendVersionCheck(opts.Destination, backend.DefaultStateName) + if diags.HasErrors() { + return diags.Err() + } } } From 5ca21afa7593c0f0c26a0db491c0c3b6ead84b5f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Sat, 23 Oct 2021 07:28:42 -0700 Subject: [PATCH 185/644] Update CHANGELOG.md --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ef9e1b46f13..5b5849960729 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,6 @@ UPGRADE NOTES: * `terraform apply` with a previously-saved plan file will now verify that the provider plugin packages used to create the plan fully match the ones used during apply, using the same checksum scheme that Terraform normally uses for the dependency lock file. Previously Terraform was checking consistency of plugins from a plan file using a legacy mechanism which covered only the main plugin executable, not any other files that might be distributed alongside in the plugin package. This additional check should not affect typical plugins that conform to the expectation that a plugin package's contents are immutable once released, but may affect a hypothetical in-house plugin that intentionally modifies extra files in its package directory somehow between plan and apply. If you have such a plugin, you'll need to change its approach to store those files in some other location separate from the package directory. This is a minor compatibility break motivated by increasing the assurance that plugins have not been inadvertently or maliciously modified between plan and apply. -* Earlier v1.1 alpha releases had an experimental new command `terraform add`. We've removed that feature and plan to reconsider it before offering an alternative in a later release. NEW FEATURES: From d42d83572b6362b934ab2850e783474671b7d2a0 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 25 Oct 2021 11:28:02 -0400 Subject: [PATCH 186/644] cli: Fix backend init failure with deleted cache When an explicit backend is configured with a configuration which has not yet been initialized, running `terraform init` performs a state migration to fetch the remotely stored state in order to operate on it. Like the previous bug introduced by the recent provider diagnostics change, this code path was not correctly configured to enable init mode for the backend, which resulted in a fatal error during init when the cache dir is deleted. Setting the `Init` backend option allows this code path to continue without error when first initializing the backend for state migration. The new e2e test fails without this change. --- .../command/e2etest/providers_tamper_test.go | 44 +++++++++++++++++++ internal/command/meta_backend.go | 4 +- 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/internal/command/e2etest/providers_tamper_test.go b/internal/command/e2etest/providers_tamper_test.go index 5335c66f9ba2..03026354a5b5 100644 --- a/internal/command/e2etest/providers_tamper_test.go +++ b/internal/command/e2etest/providers_tamper_test.go @@ -78,6 +78,42 @@ func TestProviderTampering(t *testing.T) { t.Fatalf("unexpected plan error: %s\nstderr:\n%s", err, stderr) } }) + t.Run("cache dir totally gone, explicit backend", func(t *testing.T) { + tf := e2e.NewBinary(terraformBin, seedDir) + defer tf.Close() + workDir := tf.WorkDir() + + err := ioutil.WriteFile(filepath.Join(workDir, "backend.tf"), []byte(localBackendConfig), 0600) + if err != nil { + t.Fatal(err) + } + + err = os.RemoveAll(filepath.Join(workDir, ".terraform")) + if err != nil { + t.Fatal(err) + } + + stdout, stderr, err := tf.Run("plan") + if err == nil { + t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) + } + if want := `Initial configuration of the requested backend "local"`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + if want := `terraform init`; !strings.Contains(stderr, want) { + t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) + } + + // Running init as suggested resolves the problem + _, stderr, err = tf.Run("init") + if err != nil { + t.Fatalf("unexpected init error: %s\nstderr:\n%s", err, stderr) + } + _, stderr, err = tf.Run("plan") + if err != nil { + t.Fatalf("unexpected plan error: %s\nstderr:\n%s", err, stderr) + } + }) t.Run("null plugin package modified before plan", func(t *testing.T) { tf := e2e.NewBinary(terraformBin, seedDir) defer tf.Close() @@ -229,3 +265,11 @@ func TestProviderTampering(t *testing.T) { } }) } + +const localBackendConfig = ` +terraform { + backend "local" { + path = "terraform.tfstate" + } +} +` diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 2524ccb28d3e..71bf6035cca7 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -745,7 +745,7 @@ func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.Local m.Ui.Output(fmt.Sprintf(strings.TrimSpace(outputBackendMigrateLocal), s.Backend.Type)) // Grab a purely local backend to get the local state if it exists - localB, diags := m.Backend(&BackendOpts{ForceLocal: true}) + localB, diags := m.Backend(&BackendOpts{ForceLocal: true, Init: true}) if diags.HasErrors() { return nil, diags } @@ -799,7 +799,7 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local } // Grab a purely local backend to get the local state if it exists - localB, localBDiags := m.Backend(&BackendOpts{ForceLocal: true}) + localB, localBDiags := m.Backend(&BackendOpts{ForceLocal: true, Init: true}) if localBDiags.HasErrors() { diags = diags.Append(localBDiags) return nil, diags From ecb98e1c432d32522a98426a7695505ed108f651 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 25 Oct 2021 15:08:10 -0400 Subject: [PATCH 187/644] command/init: Fail if -input=false but required When running `terraform init` against a backend with multiple workspaces, none of which are the currently indicated local workspace, Terraform prompts the user to choose a workspace from the list. In automation, using the `-input=false` argument should disable asking for input, but previously would hang instead. --- internal/command/meta_backend.go | 4 ++++ internal/command/meta_backend_test.go | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 2524ccb28d3e..640f3bc34ab9 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -241,6 +241,10 @@ func (m *Meta) selectWorkspace(b backend.Backend) error { return m.SetWorkspace(workspaces[0]) } + if !m.input { + return fmt.Errorf("Currently selected workspace %q does not exist", workspace) + } + // Otherwise, ask the user to select a workspace from the list of existing workspaces. v, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "select-workspace", diff --git a/internal/command/meta_backend_test.go b/internal/command/meta_backend_test.go index be8fec9708e9..b9d8b9116674 100644 --- a/internal/command/meta_backend_test.go +++ b/internal/command/meta_backend_test.go @@ -6,6 +6,7 @@ import ( "path/filepath" "reflect" "sort" + "strings" "testing" "github.com/hashicorp/terraform/internal/addrs" @@ -867,6 +868,28 @@ func TestMetaBackend_initSelectedWorkspaceDoesNotExistAutoSelect(t *testing.T) { } } +// Initializing a backend which supports workspaces and does *not* have +// the currently selected workspace with input=false should fail. +func TestMetaBackend_initSelectedWorkspaceDoesNotExistInputFalse(t *testing.T) { + // Create a temporary working directory that is empty + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-selected-workspace-doesnt-exist-multi"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + // Setup the meta + m := testMetaBackend(t, nil) + m.input = false + + // Get the backend + _, diags := m.Backend(&BackendOpts{Init: true}) + + // Should fail immediately + if got, want := diags.ErrWithWarnings().Error(), `Currently selected workspace "bar" does not exist`; !strings.Contains(got, want) { + t.Fatalf("wrong error\ngot: %s\nwant: %s", got, want) + } +} + // Changing a configured backend, copying state func TestMetaBackend_configuredChangeCopy(t *testing.T) { // Create a temporary working directory that is empty From 1f08f7dba88babf865f2674fdcfba915ba23e11d Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Fri, 22 Oct 2021 16:42:17 -0500 Subject: [PATCH 188/644] Clarify the way the trim() function works and add some more examples --- website/docs/language/functions/trim.html.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/website/docs/language/functions/trim.html.md b/website/docs/language/functions/trim.html.md index 43f12f2afe50..10a0aeb279f7 100644 --- a/website/docs/language/functions/trim.html.md +++ b/website/docs/language/functions/trim.html.md @@ -3,20 +3,33 @@ layout: "language" page_title: "trim - Functions - Configuration Language" sidebar_current: "docs-funcs-string-trim" description: |- - The trim function removes the specified characters from the start and end of + The trim function removes the specified set of characters from the start and end of a given string. --- # `trim` Function -`trim` removes the specified characters from the start and end of the given +`trim` removes the specified set of characters from the start and end of the given string. +```hcl +trim(string, str_character_set) +``` + +Every occurrence of a character in the second argument is removed from the start +and end of the string specified in the first argument. + ## Examples ``` > trim("?!hello?!", "!?") -hello +"hello" + +> trim("foobar", "far") +"oob" + +> trim(" hello! world.! ", "! ") +"hello! world." ``` ## Related Functions From 622c4df14c09fd0a1599c54d00bdbe46453bd05e Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 26 Oct 2021 15:54:09 -0400 Subject: [PATCH 189/644] remove the use of panicwrap Stop using panicwrap, and execute terraform in the main process. --- go.mod | 1 - go.sum | 2 - internal/command/console_interactive.go | 5 +- internal/terminal/panicwrap_ugh.go | 78 ---------------------- main.go | 89 ++----------------------- main_test.go | 6 +- 6 files changed, 11 insertions(+), 170 deletions(-) delete mode 100644 internal/terminal/panicwrap_ugh.go diff --git a/go.mod b/go.mod index 646309e2a559..11095b76503a 100644 --- a/go.mod +++ b/go.mod @@ -63,7 +63,6 @@ require ( github.com/mitchellh/go-wordwrap v1.0.1 github.com/mitchellh/gox v1.0.1 github.com/mitchellh/mapstructure v1.1.2 - github.com/mitchellh/panicwrap v1.0.0 github.com/mitchellh/reflectwalk v1.0.2 github.com/nishanths/exhaustive v0.2.3 github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db diff --git a/go.sum b/go.sum index bd8b487fba33..0fb3794c260f 100644 --- a/go.sum +++ b/go.sum @@ -515,8 +515,6 @@ github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0Qu github.com/mitchellh/mapstructure v0.0.0-20160808181253-ca63d7c062ee/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE= github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= -github.com/mitchellh/panicwrap v1.0.0 h1:67zIyVakCIvcs69A0FGfZjBdPleaonSgGlXRSRlb6fE= -github.com/mitchellh/panicwrap v1.0.0/go.mod h1:pKvZHwWrZowLUzftuFq7coarnxbBXU4aQh3N0BJOeeA= github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ= github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= diff --git a/internal/command/console_interactive.go b/internal/command/console_interactive.go index c9d63245c2c2..15fde13b4675 100644 --- a/internal/command/console_interactive.go +++ b/internal/command/console_interactive.go @@ -10,7 +10,6 @@ import ( "fmt" "io" - "github.com/hashicorp/terraform/internal/helper/wrappedreadline" "github.com/hashicorp/terraform/internal/repl" "github.com/chzyer/readline" @@ -19,12 +18,12 @@ import ( func (c *ConsoleCommand) modeInteractive(session *repl.Session, ui cli.Ui) int { // Configure input - l, err := readline.NewEx(wrappedreadline.Override(&readline.Config{ + l, err := readline.NewEx(&readline.Config{ Prompt: "> ", InterruptPrompt: "^C", EOFPrompt: "exit", HistorySearchFold: true, - })) + }) if err != nil { c.Ui.Error(fmt.Sprintf( "Error initializing console: %s", diff --git a/internal/terminal/panicwrap_ugh.go b/internal/terminal/panicwrap_ugh.go deleted file mode 100644 index b17165b2c0a6..000000000000 --- a/internal/terminal/panicwrap_ugh.go +++ /dev/null @@ -1,78 +0,0 @@ -package terminal - -import "os" - -// This file has some annoying nonsense to, yet again, work around the -// panicwrap hack. -// -// Specifically, typically when we're running Terraform the stderr handle is -// not directly connected to the terminal but is instead a pipe into a parent -// process gathering up the output just in case a panic message appears. -// However, this package needs to know whether the _real_ stderr is connected -// to a terminal and what its width is. -// -// To work around that, we'll first initialize the terminal in the parent -// process, and then capture information about stderr into an environment -// variable so we can pass it down to the child process. The child process -// will then use the environment variable to pretend that the panicwrap pipe -// has the same characteristics as the terminal that it's indirectly writing -// to. -// -// This file has some helpers for implementing that awkward handshake, but the -// handshake itself is in package main, interspersed with all of the other -// panicwrap machinery. -// -// You might think that the code in helper/wrappedstreams could avoid this -// problem, but that package is broken on Windows: it always fails to recover -// the real stderr, and it also gets an incorrect result if the user was -// redirecting or piping stdout/stdin. So... we have this hack instead, which -// gets a correct result even on Windows and even with I/O redirection. - -// StateForAfterPanicWrap is part of the workaround for panicwrap that -// captures some characteristics of stderr that the caller can pass to the -// panicwrap child process somehow and then use ReinitInsidePanicWrap. -func (s *Streams) StateForAfterPanicWrap() *PrePanicwrapState { - return &PrePanicwrapState{ - StderrIsTerminal: s.Stderr.IsTerminal(), - StderrWidth: s.Stderr.Columns(), - } -} - -// ReinitInsidePanicwrap is part of the workaround for panicwrap that -// produces a Streams containing a potentially-lying Stderr that might -// claim to be a terminal even if it's actually a pipe connected to the -// parent process. -// -// That's an okay lie in practice because the parent process will copy any -// data it recieves via that pipe verbatim to the real stderr anyway. (The -// original call to Init in the parent process should've already done any -// necessary modesetting on the Stderr terminal, if any.) -// -// The state argument can be nil if we're not running in panicwrap mode, -// in which case this function behaves exactly the same as Init. -func ReinitInsidePanicwrap(state *PrePanicwrapState) (*Streams, error) { - ret, err := Init() - if err != nil { - return ret, err - } - if state != nil { - // A lying stderr, then. - ret.Stderr = &OutputStream{ - File: ret.Stderr.File, - isTerminal: func(f *os.File) bool { - return state.StderrIsTerminal - }, - getColumns: func(f *os.File) int { - return state.StderrWidth - }, - } - } - return ret, nil -} - -// PrePanicwrapState is a horrible thing we use to work around panicwrap, -// related to both Streams.StateForAfterPanicWrap and ReinitInsidePanicwrap. -type PrePanicwrapState struct { - StderrIsTerminal bool - StderrWidth int -} diff --git a/main.go b/main.go index 793db83c8866..99e2c58a3335 100644 --- a/main.go +++ b/main.go @@ -3,7 +3,6 @@ package main import ( "encoding/json" "fmt" - "io/ioutil" "log" "net" "os" @@ -24,7 +23,6 @@ import ( "github.com/mattn/go-shellwords" "github.com/mitchellh/cli" "github.com/mitchellh/colorstring" - "github.com/mitchellh/panicwrap" backendInit "github.com/hashicorp/terraform/internal/backend/init" ) @@ -35,12 +33,6 @@ const ( // The parent process will create a file to collect crash logs envTmpLogPath = "TF_TEMP_LOG_PATH" - - // Environment variable name used for smuggling true stderr terminal - // settings into a panicwrap child process. This is an implementation - // detail, subject to change in future, and should not ever be directly - // set by an end-user. - envTerminalPanicwrapWorkaround = "TF_PANICWRAP_STDERR" ) // ui wraps the primary output cli.Ui, and redirects Warn calls to Output @@ -54,67 +46,6 @@ func (u *ui) Warn(msg string) { u.Ui.Output(msg) } -func main() { - os.Exit(realMain()) -} - -func realMain() int { - var wrapConfig panicwrap.WrapConfig - - // don't re-exec terraform as a child process for easier debugging - if os.Getenv("TF_FORK") == "0" { - return wrappedMain() - } - - if !panicwrap.Wrapped(&wrapConfig) { - // We always send logs to a temporary file that we use in case - // there is a panic. Otherwise, we delete it. - logTempFile, err := ioutil.TempFile("", "terraform-log") - if err != nil { - fmt.Fprintf(os.Stderr, "Couldn't set up logging tempfile: %s", err) - return 1 - } - // Now that we have the file, close it and leave it for the wrapped - // process to write to. - logTempFile.Close() - defer os.Remove(logTempFile.Name()) - - // store the path in the environment for the wrapped executable - os.Setenv(envTmpLogPath, logTempFile.Name()) - - // We also need to do our terminal initialization before we fork, - // because the child process doesn't necessarily have access to - // the true stderr in order to initialize it. - streams, err := terminal.Init() - if err != nil { - fmt.Fprintf(os.Stderr, "Failed to initialize terminal: %s", err) - return 1 - } - - // We need the child process to behave _as if_ connected to the real - // stderr, even though panicwrap is about to add a pipe in the way, - // so we'll smuggle the true stderr information in an environment - // varible. - streamState := streams.StateForAfterPanicWrap() - os.Setenv(envTerminalPanicwrapWorkaround, fmt.Sprintf("%t:%d", streamState.StderrIsTerminal, streamState.StderrWidth)) - - // Create the configuration for panicwrap and wrap our executable - wrapConfig.Handler = logging.PanicHandler(logTempFile.Name()) - wrapConfig.IgnoreSignals = ignoreSignals - wrapConfig.ForwardSignals = forwardSignals - exitStatus, err := panicwrap.Wrap(&wrapConfig) - if err != nil { - fmt.Fprintf(os.Stderr, "Couldn't start Terraform: %s", err) - return 1 - } - - return exitStatus - } - - // Call the real main - return wrappedMain() -} - func init() { Ui = &ui{&cli.BasicUi{ Writer: os.Stdout, @@ -123,7 +54,11 @@ func init() { }} } -func wrappedMain() int { +func main() { + os.Exit(realMain()) +} + +func realMain() int { var err error tmpLogPath := os.Getenv(envTmpLogPath) @@ -145,19 +80,7 @@ func wrappedMain() int { log.Printf("[INFO] Go runtime version: %s", runtime.Version()) log.Printf("[INFO] CLI args: %#v", os.Args) - // This is the recieving end of our workaround to retain the metadata - // about the real stderr even though we're talking to it via the panicwrap - // pipe. See the call to StateForAfterPanicWrap above for the producer - // part of this. - var streamState *terminal.PrePanicwrapState - if raw := os.Getenv(envTerminalPanicwrapWorkaround); raw != "" { - streamState = &terminal.PrePanicwrapState{} - if _, err := fmt.Sscanf(raw, "%t:%d", &streamState.StderrIsTerminal, &streamState.StderrWidth); err != nil { - log.Printf("[WARN] %s is set but is incorrectly-formatted: %s", envTerminalPanicwrapWorkaround, err) - streamState = nil // leave it unset for a normal init, then - } - } - streams, err := terminal.ReinitInsidePanicwrap(streamState) + streams, err := terminal.Init() if err != nil { Ui.Error(fmt.Sprintf("Failed to configure the terminal: %s", err)) return 1 diff --git a/main_test.go b/main_test.go index 102ea44bb9ab..15a09f283c0e 100644 --- a/main_test.go +++ b/main_test.go @@ -130,7 +130,7 @@ func TestMain_cliArgsFromEnv(t *testing.T) { // Run it! os.Args = args testCommand.Args = nil - exit := wrappedMain() + exit := realMain() if (exit != 0) != tc.Err { t.Fatalf("bad: %d", exit) } @@ -237,7 +237,7 @@ func TestMain_cliArgsFromEnvAdvanced(t *testing.T) { // Run it! os.Args = args testCommand.Args = nil - exit := wrappedMain() + exit := realMain() if (exit != 0) != tc.Err { t.Fatalf("unexpected exit status %d; want 0", exit) } @@ -275,7 +275,7 @@ func TestMain_autoComplete(t *testing.T) { // Run it! os.Args = []string{"terraform", "terraform", "versio"} - exit := wrappedMain() + exit := realMain() if exit != 0 { t.Fatalf("unexpected exit status %d; want 0", exit) } From 42742c173df4c4472d5812f00f20ab31e47493ca Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 27 Oct 2021 10:28:19 -0400 Subject: [PATCH 190/644] remove wrapped streams and readline --- internal/command/console.go | 8 +- internal/command/console_interactive.go | 4 + .../helper/wrappedreadline/wrappedreadline.go | 77 ------------------- .../wrappedreadline/wrappedreadline_unix.go | 47 ----------- .../wrappedreadline_windows.go | 9 --- internal/helper/wrappedstreams/streams.go | 44 ----------- .../helper/wrappedstreams/streams_other.go | 22 ------ .../helper/wrappedstreams/streams_windows.go | 53 ------------- 8 files changed, 8 insertions(+), 256 deletions(-) delete mode 100644 internal/helper/wrappedreadline/wrappedreadline.go delete mode 100644 internal/helper/wrappedreadline/wrappedreadline_unix.go delete mode 100644 internal/helper/wrappedreadline/wrappedreadline_windows.go delete mode 100644 internal/helper/wrappedstreams/streams.go delete mode 100644 internal/helper/wrappedstreams/streams_other.go delete mode 100644 internal/helper/wrappedstreams/streams_windows.go diff --git a/internal/command/console.go b/internal/command/console.go index 3195988683b0..0a3471bd2562 100644 --- a/internal/command/console.go +++ b/internal/command/console.go @@ -3,11 +3,11 @@ package command import ( "bufio" "fmt" + "os" "strings" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" - "github.com/hashicorp/terraform/internal/helper/wrappedstreams" "github.com/hashicorp/terraform/internal/repl" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" @@ -113,8 +113,8 @@ func (c *ConsoleCommand) Run(args []string) int { // Set up the UI so we can output directly to stdout ui := &cli.BasicUi{ - Writer: wrappedstreams.Stdout(), - ErrorWriter: wrappedstreams.Stderr(), + Writer: os.Stdout, + ErrorWriter: os.Stderr, } evalOpts := &terraform.EvalOpts{} @@ -164,7 +164,7 @@ func (c *ConsoleCommand) Run(args []string) int { func (c *ConsoleCommand) modePiped(session *repl.Session, ui cli.Ui) int { var lastResult string - scanner := bufio.NewScanner(wrappedstreams.Stdin()) + scanner := bufio.NewScanner(os.Stdin) for scanner.Scan() { result, exit, diags := session.Handle(strings.TrimSpace(scanner.Text())) if diags.HasErrors() { diff --git a/internal/command/console_interactive.go b/internal/command/console_interactive.go index 15fde13b4675..32cc3a9efcce 100644 --- a/internal/command/console_interactive.go +++ b/internal/command/console_interactive.go @@ -9,6 +9,7 @@ package command import ( "fmt" "io" + "os" "github.com/hashicorp/terraform/internal/repl" @@ -23,6 +24,9 @@ func (c *ConsoleCommand) modeInteractive(session *repl.Session, ui cli.Ui) int { InterruptPrompt: "^C", EOFPrompt: "exit", HistorySearchFold: true, + Stdin: os.Stdin, + Stdout: os.Stdout, + Stderr: os.Stderr, }) if err != nil { c.Ui.Error(fmt.Sprintf( diff --git a/internal/helper/wrappedreadline/wrappedreadline.go b/internal/helper/wrappedreadline/wrappedreadline.go deleted file mode 100644 index 6d2ffd15f785..000000000000 --- a/internal/helper/wrappedreadline/wrappedreadline.go +++ /dev/null @@ -1,77 +0,0 @@ -// wrappedreadline is a package that has helpers for interacting with -// readline from a panicwrap executable. -// -// panicwrap overrides the standard file descriptors so that the child process -// no longer looks like a TTY. The helpers here access the extra file descriptors -// passed by panicwrap to fix that. -// -// panicwrap should be checked for with panicwrap.Wrapped before using this -// librar, since this library won't adapt if the binary is not wrapped. -package wrappedreadline - -import ( - "runtime" - - "github.com/chzyer/readline" - - "github.com/hashicorp/terraform/internal/helper/wrappedstreams" -) - -// Override overrides the values in readline.Config that need to be -// set with wrapped values. -func Override(cfg *readline.Config) *readline.Config { - cfg.Stdin = wrappedstreams.Stdin() - cfg.Stdout = wrappedstreams.Stdout() - cfg.Stderr = wrappedstreams.Stderr() - - cfg.FuncGetWidth = TerminalWidth - cfg.FuncIsTerminal = IsTerminal - - rm := RawMode{StdinFd: int(wrappedstreams.Stdin().Fd())} - cfg.FuncMakeRaw = rm.Enter - cfg.FuncExitRaw = rm.Exit - - return cfg -} - -// IsTerminal determines if this process is attached to a TTY. -func IsTerminal() bool { - // Windows is always a terminal - if runtime.GOOS == "windows" { - return true - } - - // Same implementation as readline but with our custom fds - return readline.IsTerminal(int(wrappedstreams.Stdin().Fd())) && - (readline.IsTerminal(int(wrappedstreams.Stdout().Fd())) || - readline.IsTerminal(int(wrappedstreams.Stderr().Fd()))) -} - -// TerminalWidth gets the terminal width in characters. -func TerminalWidth() int { - if runtime.GOOS == "windows" { - return readline.GetScreenWidth() - } - - return getWidth() -} - -// RawMode is a helper for entering and exiting raw mode. -type RawMode struct { - StdinFd int - - state *readline.State -} - -func (r *RawMode) Enter() (err error) { - r.state, err = readline.MakeRaw(r.StdinFd) - return err -} - -func (r *RawMode) Exit() error { - if r.state == nil { - return nil - } - - return readline.Restore(r.StdinFd, r.state) -} diff --git a/internal/helper/wrappedreadline/wrappedreadline_unix.go b/internal/helper/wrappedreadline/wrappedreadline_unix.go deleted file mode 100644 index 25657f8c3b0d..000000000000 --- a/internal/helper/wrappedreadline/wrappedreadline_unix.go +++ /dev/null @@ -1,47 +0,0 @@ -//go:build darwin || dragonfly || freebsd || (linux && !appengine) || netbsd || openbsd -// +build darwin dragonfly freebsd linux,!appengine netbsd openbsd - -package wrappedreadline - -import ( - "syscall" - "unsafe" - - "github.com/hashicorp/terraform/internal/helper/wrappedstreams" -) - -// getWidth impl for Unix -func getWidth() int { - stdoutFd := int(wrappedstreams.Stdout().Fd()) - stderrFd := int(wrappedstreams.Stderr().Fd()) - - w := getWidthFd(stdoutFd) - if w < 0 { - w = getWidthFd(stderrFd) - } - - return w -} - -type winsize struct { - Row uint16 - Col uint16 - Xpixel uint16 - Ypixel uint16 -} - -// get width of the terminal -func getWidthFd(stdoutFd int) int { - ws := &winsize{} - retCode, _, errno := syscall.Syscall(syscall.SYS_IOCTL, - uintptr(stdoutFd), - uintptr(syscall.TIOCGWINSZ), - uintptr(unsafe.Pointer(ws))) - - if int(retCode) == -1 { - _ = errno - return -1 - } - - return int(ws.Col) -} diff --git a/internal/helper/wrappedreadline/wrappedreadline_windows.go b/internal/helper/wrappedreadline/wrappedreadline_windows.go deleted file mode 100644 index b06a60bf8b6e..000000000000 --- a/internal/helper/wrappedreadline/wrappedreadline_windows.go +++ /dev/null @@ -1,9 +0,0 @@ -//go:build windows -// +build windows - -package wrappedreadline - -// getWidth impl for other -func getWidth() int { - return 0 -} diff --git a/internal/helper/wrappedstreams/streams.go b/internal/helper/wrappedstreams/streams.go deleted file mode 100644 index 1ccc4397395c..000000000000 --- a/internal/helper/wrappedstreams/streams.go +++ /dev/null @@ -1,44 +0,0 @@ -// Package wrappedstreams provides access to the standard OS streams -// (stdin, stdout, stderr) even if wrapped under panicwrap. -package wrappedstreams - -import ( - "os" - - "github.com/mitchellh/panicwrap" -) - -// Stdin returns the true stdin of the process. -func Stdin() *os.File { - stdin, _, _ := fds() - return stdin -} - -// Stdout returns the true stdout of the process. -func Stdout() *os.File { - _, stdout, _ := fds() - return stdout -} - -// Stderr returns the true stderr of the process. -func Stderr() *os.File { - _, _, stderr := fds() - return stderr -} - -func fds() (stdin, stdout, stderr *os.File) { - stdin, stdout, stderr = os.Stdin, os.Stdout, os.Stderr - if panicwrap.Wrapped(nil) { - initPlatform() - stdin, stdout, stderr = wrappedStdin, wrappedStdout, wrappedStderr - } - return -} - -// These are the wrapped standard streams. These are set up by the -// platform specific code in initPlatform. -var ( - wrappedStdin *os.File - wrappedStdout *os.File - wrappedStderr *os.File -) diff --git a/internal/helper/wrappedstreams/streams_other.go b/internal/helper/wrappedstreams/streams_other.go deleted file mode 100644 index 49dc0157c9a5..000000000000 --- a/internal/helper/wrappedstreams/streams_other.go +++ /dev/null @@ -1,22 +0,0 @@ -//go:build !windows -// +build !windows - -package wrappedstreams - -import ( - "os" - "sync" -) - -var initOnce sync.Once - -func initPlatform() { - // These must be initialized lazily, once it's been determined that this is - // a wrapped process. - initOnce.Do(func() { - // The standard streams are passed in via extra file descriptors. - wrappedStdin = os.NewFile(uintptr(3), "stdin") - wrappedStdout = os.NewFile(uintptr(4), "stdout") - wrappedStderr = os.NewFile(uintptr(5), "stderr") - }) -} diff --git a/internal/helper/wrappedstreams/streams_windows.go b/internal/helper/wrappedstreams/streams_windows.go deleted file mode 100644 index 0508cc8db406..000000000000 --- a/internal/helper/wrappedstreams/streams_windows.go +++ /dev/null @@ -1,53 +0,0 @@ -//go:build windows -// +build windows - -package wrappedstreams - -import ( - "log" - "os" - "syscall" -) - -func initPlatform() { - wrappedStdin = openConsole("CONIN$", os.Stdin) - wrappedStdout = openConsole("CONOUT$", os.Stdout) - wrappedStderr = wrappedStdout -} - -// openConsole opens a console handle, using a backup if it fails. -// This is used to get the exact console handle instead of the redirected -// handles from panicwrap. -func openConsole(name string, backup *os.File) *os.File { - // Convert to UTF16 - path, err := syscall.UTF16PtrFromString(name) - if err != nil { - log.Printf("[ERROR] wrappedstreams: %s", err) - return backup - } - - // Determine the share mode - var shareMode uint32 - switch name { - case "CONIN$": - shareMode = syscall.FILE_SHARE_READ - case "CONOUT$": - shareMode = syscall.FILE_SHARE_WRITE - } - - // Get the file - h, err := syscall.CreateFile( - path, - syscall.GENERIC_READ|syscall.GENERIC_WRITE, - shareMode, - nil, - syscall.OPEN_EXISTING, - 0, 0) - if err != nil { - log.Printf("[ERROR] wrappedstreams: %s", err) - return backup - } - - // Create the Go file - return os.NewFile(uintptr(h), name) -} From 3f31533f86a5b551d727c68547d722ecbf5f0792 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 27 Oct 2021 15:37:35 -0400 Subject: [PATCH 191/644] logging.PanicHandler can now be for internal use Repurpose logging.PanicHandler to recover internal panics and print a message to users similar to panicwrap. --- internal/logging/panic.go | 74 +++++++++------------------------- internal/logging/panic_test.go | 31 -------------- 2 files changed, 19 insertions(+), 86 deletions(-) diff --git a/internal/logging/panic.go b/internal/logging/panic.go index 211a1231dc0e..207b3a44468a 100644 --- a/internal/logging/panic.go +++ b/internal/logging/panic.go @@ -2,14 +2,12 @@ package logging import ( "fmt" - "io" - "io/ioutil" "os" + "runtime/debug" "strings" "sync" "github.com/hashicorp/go-hclog" - "github.com/mitchellh/panicwrap" ) // This output is shown if a panic happens. @@ -18,59 +16,33 @@ const panicOutput = ` !!!!!!!!!!!!!!!!!!!!!!!!!!! TERRAFORM CRASH !!!!!!!!!!!!!!!!!!!!!!!!!!!! Terraform crashed! This is always indicative of a bug within Terraform. -A crash log has been placed at %[1]q relative to your current -working directory. It would be immensely helpful if you could please -report the crash with Terraform[1] so that we can fix this. +Please report the crash with Terraform[1] so that we can fix this. -When reporting bugs, please include your terraform version. That -information is available on the first line of crash.log. You can also -get it by running 'terraform --version' on the command line. - -SECURITY WARNING: the %[1]q file that was created may contain -sensitive information that must be redacted before it is safe to share -on the issue tracker. +When reporting bugs, please include your terraform version, the stack trace +shown below, and any additional information which may help replicate the issue. [1]: https://github.com/hashicorp/terraform/issues !!!!!!!!!!!!!!!!!!!!!!!!!!! TERRAFORM CRASH !!!!!!!!!!!!!!!!!!!!!!!!!!!! ` -// panicHandler is what is called by panicwrap when a panic is encountered -// within Terraform. It is guaranteed to run after the resulting process has -// exited so we can take the log file, add in the panic, and store it -// somewhere locally. -func PanicHandler(tmpLogPath string) panicwrap.HandlerFunc { - return func(m string) { - // Create the crash log file where we'll write the logs - f, err := ioutil.TempFile(".", "crash.*.log") - if err != nil { - fmt.Fprintf(os.Stderr, "Failed to create crash log file: %s", err) - return - } - defer f.Close() - - tmpLog, err := os.Open(tmpLogPath) - if err != nil { - fmt.Fprintf(os.Stderr, "Failed to open log file %q: %v\n", tmpLogPath, err) - return - } - defer tmpLog.Close() - - // Copy the contents to the crash file. This will include - // the panic that just happened. - if _, err = io.Copy(f, tmpLog); err != nil { - fmt.Fprintf(os.Stderr, "Failed to write crash log: %s", err) - return - } +// PanicHandler is called to recover from an internal panic in Terraform, and +// is intended to replace the standard stack trace with a more user friendly +// error message. +// PanicHandler must be called as a defered function. +func PanicHandler() { + recovered := recover() + if recovered == nil { + return + } - // add the trace back to the log - f.WriteString("\n" + m) + fmt.Fprint(os.Stderr, panicOutput) + fmt.Fprint(os.Stderr, recovered) - // Tell the user a crash occurred in some helpful way that - // they'll hopefully notice. - fmt.Printf("\n\n") - fmt.Printf(panicOutput, f.Name()) - } + // When called from a deferred function, debug.PrintStack will include the + // full stack from the point of the pending panic. + debug.PrintStack() + os.Exit(2) } const pluginPanicOutput = ` @@ -181,13 +153,5 @@ func (l *logPanicWrapper) Debug(msg string, args ...interface{}) { l.panicRecorder(msg) } - // If we have logging turned on, we need to prevent panicwrap from seeing - // this as a core panic. This can be done by obfuscating the panic error - // line. - if panicPrefix { - colon := strings.Index(msg, ":") - msg = strings.ToUpper(msg[:colon]) + msg[colon:] - } - l.Logger.Debug(msg, args...) } diff --git a/internal/logging/panic_test.go b/internal/logging/panic_test.go index d2eb7a90bd67..e83a0ba5acbb 100644 --- a/internal/logging/panic_test.go +++ b/internal/logging/panic_test.go @@ -1,12 +1,9 @@ package logging import ( - "bytes" "fmt" "strings" "testing" - - "github.com/hashicorp/go-hclog" ) func TestPanicRecorder(t *testing.T) { @@ -52,31 +49,3 @@ func TestPanicLimit(t *testing.T) { } } } - -func TestLogPanicWrapper(t *testing.T) { - var buf bytes.Buffer - logger := hclog.NewInterceptLogger(&hclog.LoggerOptions{ - Name: "test", - Level: hclog.Debug, - Output: &buf, - DisableTime: true, - }) - - wrapped := (&logPanicWrapper{ - Logger: logger, - }).Named("test") - - wrapped.Debug("panic: invalid foo of bar") - wrapped.Debug("\tstack trace") - - expected := `[DEBUG] test.test: PANIC: invalid foo of bar -[DEBUG] test.test: stack trace -` - - got := buf.String() - - if expected != got { - t.Fatalf("Expected:\n%q\nGot:\n%q", expected, got) - } - -} From d03a037567b938169c2e5ec553cf706109b2697d Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 27 Oct 2021 16:33:35 -0400 Subject: [PATCH 192/644] insert panic handlers --- internal/backend/local/backend.go | 2 ++ internal/backend/local/backend_apply.go | 2 ++ internal/backend/local/backend_plan.go | 2 ++ internal/backend/local/backend_refresh.go | 2 ++ internal/backend/remote/backend.go | 2 ++ internal/backend/remote/backend_common.go | 3 +++ internal/backend/remote/backend_plan.go | 3 +++ internal/command/login.go | 2 ++ internal/logging/panic.go | 7 +++---- internal/terraform/context.go | 3 +++ internal/terraform/graph.go | 5 +++++ main.go | 2 ++ 12 files changed, 31 insertions(+), 4 deletions(-) diff --git a/internal/backend/local/backend.go b/internal/backend/local/backend.go index f5d07b20f039..dd6c9cc56f10 100644 --- a/internal/backend/local/backend.go +++ b/internal/backend/local/backend.go @@ -14,6 +14,7 @@ import ( "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/states/statemgr" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" @@ -313,6 +314,7 @@ func (b *Local) Operation(ctx context.Context, op *backend.Operation) (*backend. // Do it go func() { + defer logging.PanicHandler() defer done() defer stop() defer cancel() diff --git a/internal/backend/local/backend_apply.go b/internal/backend/local/backend_apply.go index 5b143a74f46d..897c36e400d0 100644 --- a/internal/backend/local/backend_apply.go +++ b/internal/backend/local/backend_apply.go @@ -7,6 +7,7 @@ import ( "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/statefile" @@ -156,6 +157,7 @@ func (b *Local) opApply( var applyDiags tfdiags.Diagnostics doneCh := make(chan struct{}) go func() { + defer logging.PanicHandler() defer close(doneCh) log.Printf("[INFO] backend/local: apply calling Apply") applyState, applyDiags = lr.Core.Apply(plan, lr.Config) diff --git a/internal/backend/local/backend_plan.go b/internal/backend/local/backend_plan.go index c721074b4a8e..b27f98c688a8 100644 --- a/internal/backend/local/backend_plan.go +++ b/internal/backend/local/backend_plan.go @@ -6,6 +6,7 @@ import ( "log" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" "github.com/hashicorp/terraform/internal/states/statefile" @@ -79,6 +80,7 @@ func (b *Local) opPlan( var planDiags tfdiags.Diagnostics doneCh := make(chan struct{}) go func() { + defer logging.PanicHandler() defer close(doneCh) log.Printf("[INFO] backend/local: plan calling Plan") plan, planDiags = lr.Core.Plan(lr.Config, lr.InputState, lr.PlanOpts) diff --git a/internal/backend/local/backend_refresh.go b/internal/backend/local/backend_refresh.go index ddbedaf19088..8ce3b6aff1a8 100644 --- a/internal/backend/local/backend_refresh.go +++ b/internal/backend/local/backend_refresh.go @@ -7,6 +7,7 @@ import ( "os" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/statemgr" "github.com/hashicorp/terraform/internal/tfdiags" @@ -77,6 +78,7 @@ func (b *Local) opRefresh( var refreshDiags tfdiags.Diagnostics doneCh := make(chan struct{}) go func() { + defer logging.PanicHandler() defer close(doneCh) newState, refreshDiags = lr.Core.Refresh(lr.Config, lr.InputState, lr.PlanOpts) log.Printf("[INFO] backend/local: refresh calling Refresh") diff --git a/internal/backend/remote/backend.go b/internal/backend/remote/backend.go index e427befa0391..bc4c03175b19 100644 --- a/internal/backend/remote/backend.go +++ b/internal/backend/remote/backend.go @@ -18,6 +18,7 @@ import ( "github.com/hashicorp/terraform-svchost/disco" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statemgr" "github.com/hashicorp/terraform/internal/terraform" @@ -755,6 +756,7 @@ func (b *Remote) Operation(ctx context.Context, op *backend.Operation) (*backend // Do it. go func() { + defer logging.PanicHandler() defer done() defer stop() defer cancel() diff --git a/internal/backend/remote/backend_common.go b/internal/backend/remote/backend_common.go index 845402199443..dc102f59449f 100644 --- a/internal/backend/remote/backend_common.go +++ b/internal/backend/remote/backend_common.go @@ -13,6 +13,7 @@ import ( tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/terraform" ) @@ -464,6 +465,8 @@ func (b *Remote) confirm(stopCtx context.Context, op *backend.Operation, opts *t result := make(chan error, 2) go func() { + defer logging.PanicHandler() + // Make sure we cancel doneCtx before we return // so the input command is also canceled. defer cancel() diff --git a/internal/backend/remote/backend_plan.go b/internal/backend/remote/backend_plan.go index 736c040b4d8b..ca74d18b6487 100644 --- a/internal/backend/remote/backend_plan.go +++ b/internal/backend/remote/backend_plan.go @@ -17,6 +17,7 @@ import ( tfe "github.com/hashicorp/go-tfe" version "github.com/hashicorp/go-version" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -319,6 +320,8 @@ in order to capture the filesystem context the remote workspace expects: // cancellable after that period, we attempt to cancel it. if lockTimeout := op.StateLocker.Timeout(); lockTimeout > 0 { go func() { + defer logging.PanicHandler() + select { case <-stopCtx.Done(): return diff --git a/internal/command/login.go b/internal/command/login.go index 4ede60ddb5c8..6b1d8bddd4d2 100644 --- a/internal/command/login.go +++ b/internal/command/login.go @@ -22,6 +22,7 @@ import ( "github.com/hashicorp/terraform-svchost/disco" "github.com/hashicorp/terraform/internal/command/cliconfig" "github.com/hashicorp/terraform/internal/httpclient" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" @@ -450,6 +451,7 @@ func (c *LoginCommand) interactiveGetTokenByCode(hostname svchost.Hostname, cred }), } go func() { + defer logging.PanicHandler() err := server.Serve(listener) if err != nil && err != http.ErrServerClosed { diags = diags.Append(tfdiags.Sourceless( diff --git a/internal/logging/panic.go b/internal/logging/panic.go index 207b3a44468a..9ae6252ca7e3 100644 --- a/internal/logging/panic.go +++ b/internal/logging/panic.go @@ -12,7 +12,6 @@ import ( // This output is shown if a panic happens. const panicOutput = ` - !!!!!!!!!!!!!!!!!!!!!!!!!!! TERRAFORM CRASH !!!!!!!!!!!!!!!!!!!!!!!!!!!! Terraform crashed! This is always indicative of a bug within Terraform. @@ -24,11 +23,11 @@ shown below, and any additional information which may help replicate the issue. [1]: https://github.com/hashicorp/terraform/issues !!!!!!!!!!!!!!!!!!!!!!!!!!! TERRAFORM CRASH !!!!!!!!!!!!!!!!!!!!!!!!!!!! + ` -// PanicHandler is called to recover from an internal panic in Terraform, and -// is intended to replace the standard stack trace with a more user friendly -// error message. +// PanicHandler is called to recover from an internal panic in Terraform, and +// augments the standard stack trace with a more user friendly error message. // PanicHandler must be called as a defered function. func PanicHandler() { recovered := recover() diff --git a/internal/terraform/context.go b/internal/terraform/context.go index 2174b0fe0e78..115f62276cba 100644 --- a/internal/terraform/context.go +++ b/internal/terraform/context.go @@ -9,6 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" "github.com/hashicorp/terraform/internal/states" @@ -264,6 +265,8 @@ func (c *Context) watchStop(walker *ContextGraphWalker) (chan struct{}, <-chan s done := c.runContext.Done() go func() { + defer logging.PanicHandler() + defer close(wait) // Wait for a stop or completion select { diff --git a/internal/terraform/graph.go b/internal/terraform/graph.go index 3d09f329b1c7..9e2f1955319f 100644 --- a/internal/terraform/graph.go +++ b/internal/terraform/graph.go @@ -4,6 +4,7 @@ import ( "log" "strings" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/hashicorp/terraform/internal/addrs" @@ -39,6 +40,10 @@ func (g *Graph) walk(walker GraphWalker) tfdiags.Diagnostics { // Walk the graph. walkFn := func(v dag.Vertex) (diags tfdiags.Diagnostics) { + // the walkFn is called asynchronously, and needs to be recovered + // separately in the case of a panic. + defer logging.PanicHandler() + log.Printf("[TRACE] vertex %q: starting visit (%T)", dag.VertexName(v), v) defer func() { diff --git a/main.go b/main.go index 99e2c58a3335..da5dfd9c96d5 100644 --- a/main.go +++ b/main.go @@ -59,6 +59,8 @@ func main() { } func realMain() int { + defer logging.PanicHandler() + var err error tmpLogPath := os.Getenv(envTmpLogPath) From f031fcaa970bced527ecb9a465d3167b3a3b1f56 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 27 Oct 2021 17:12:20 -0400 Subject: [PATCH 193/644] no need for TF_FORK=0 --- scripts/debug-terraform | 5 ----- 1 file changed, 5 deletions(-) diff --git a/scripts/debug-terraform b/scripts/debug-terraform index a057c0d3c32c..f2dfae08c55b 100755 --- a/scripts/debug-terraform +++ b/scripts/debug-terraform @@ -18,11 +18,6 @@ set -eu -# Make sure we're debugging the process where the code is actually running. -# (This also, as a side effect, causes raw logs to go directly to stderr, -# and panics to be expressed directly, since we lose the log/panic wrapper.) -export TF_FORK=0 - echo "Launching Terraform in a headless debug session" echo "Connect to it using: dlv connect 127.0.0.1:2345" echo "(Terraform takes a long time to build and launch in this mode; some logs will appear below)" From d2d2508f5cb500432e72c510d0cee4f75e2216d0 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 27 Oct 2021 17:13:00 -0400 Subject: [PATCH 194/644] write provider panics to error We no longer have to hide these from panicwrap --- main.go | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/main.go b/main.go index da5dfd9c96d5..38c7141ccbce 100644 --- a/main.go +++ b/main.go @@ -316,9 +316,7 @@ func realMain() int { // plugins crashing if exitCode != 0 { for _, panicLog := range logging.PluginPanics() { - // we don't write this to Error, or else panicwrap will think this - // process panicked - Ui.Info(panicLog) + Ui.Error(panicLog) } } From bd37f43daa6bdea3ed24a9d33a97e7bf468afbbf Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 28 Oct 2021 13:56:18 -0400 Subject: [PATCH 195/644] add note about calling PanicHandler first --- internal/logging/panic.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/internal/logging/panic.go b/internal/logging/panic.go index 9ae6252ca7e3..2bc763f9d1bd 100644 --- a/internal/logging/panic.go +++ b/internal/logging/panic.go @@ -28,7 +28,8 @@ shown below, and any additional information which may help replicate the issue. // PanicHandler is called to recover from an internal panic in Terraform, and // augments the standard stack trace with a more user friendly error message. -// PanicHandler must be called as a defered function. +// PanicHandler must be called as a defered function, and must be the first +// defer called at the start of a new goroutine. func PanicHandler() { recovered := recover() if recovered == nil { From 583e3a5f0b1978a73ba1b69c4d3ce963675a22c2 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 28 Oct 2021 15:34:02 -0400 Subject: [PATCH 196/644] use 11 for the panic exit code --- internal/logging/panic.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/internal/logging/panic.go b/internal/logging/panic.go index 2bc763f9d1bd..785cbfb6f0dd 100644 --- a/internal/logging/panic.go +++ b/internal/logging/panic.go @@ -42,7 +42,11 @@ func PanicHandler() { // When called from a deferred function, debug.PrintStack will include the // full stack from the point of the pending panic. debug.PrintStack() - os.Exit(2) + + // An exit code of 11 keeps us out of the way of the detailed exitcodes + // from plan, and also happens to be the same code as SIGSEGV which is + // roughly the same type of condition that causes most panics. + os.Exit(11) } const pluginPanicOutput = ` From ea8ad0b15ab495fa0fad679f2aae21dc8974ee9e Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 12 Aug 2021 14:30:24 -0500 Subject: [PATCH 197/644] Initial commit of 'cloud' package The cloud package intends to implement a new integration for Terraform Cloud/Enterprise. The purpose of this integration is to better support TFC users; it will shed some overly generic UX and architecture, behavior changes that are otherwise backwards incompatible in the remote backend, and technical debt - all of which are vestiges from before Terraform Cloud existed. This initial commit is largely a porting of the existing 'remote' backend, which will serve as an underlying implementation detail and not be a typical user-level backend. This is because to re-implement the literal backend interface is orthogonal to the purpose of this integration, and can always be migrated away from later. As this backend is considered an implementation detail, it will not be registered as a declarable backend. Within these changes it is, for easy of initial development and a clean diff. --- internal/backend/init/init.go | 6 +- internal/cloud/backend.go | 1049 +++++++++++ internal/cloud/backend_apply.go | 301 +++ internal/cloud/backend_apply_test.go | 1659 +++++++++++++++++ internal/cloud/backend_cli.go | 20 + internal/cloud/backend_colorize.go | 50 + internal/cloud/backend_common.go | 574 ++++++ internal/cloud/backend_context.go | 280 +++ internal/cloud/backend_context_test.go | 235 +++ internal/cloud/backend_mock.go | 1364 ++++++++++++++ internal/cloud/backend_plan.go | 439 +++++ internal/cloud/backend_plan_test.go | 1237 ++++++++++++ internal/cloud/backend_state.go | 182 ++ internal/cloud/backend_state_test.go | 59 + internal/cloud/backend_test.go | 723 +++++++ internal/cloud/remote_test.go | 25 + internal/cloud/testdata/apply-destroy/main.tf | 1 + .../cloud/testdata/apply-no-changes/main.tf | 1 + .../testdata/apply-policy-hard-failed/main.tf | 1 + .../testdata/apply-policy-passed/main.tf | 1 + .../testdata/apply-policy-soft-failed/main.tf | 1 + .../cloud/testdata/apply-variables/main.tf | 4 + .../cloud/testdata/apply-with-error/main.tf | 5 + internal/cloud/testdata/apply/main.tf | 1 + internal/cloud/testdata/empty/.gitignore | 0 .../testdata/plan-cost-estimation/main.tf | 1 + .../cloud/testdata/plan-long-line/main.tf | 5 + .../cloud/testdata/plan-no-changes/main.tf | 1 + .../testdata/plan-policy-hard-failed/main.tf | 1 + .../cloud/testdata/plan-policy-passed/main.tf | 1 + .../testdata/plan-policy-soft-failed/main.tf | 1 + .../cloud/testdata/plan-variables/main.tf | 4 + .../cloud/testdata/plan-with-error/main.tf | 5 + .../terraform/main.tf | 1 + internal/cloud/testdata/plan/main.tf | 1 + internal/cloud/testing.go | 299 +++ 36 files changed, 8537 insertions(+), 1 deletion(-) create mode 100644 internal/cloud/backend.go create mode 100644 internal/cloud/backend_apply.go create mode 100644 internal/cloud/backend_apply_test.go create mode 100644 internal/cloud/backend_cli.go create mode 100644 internal/cloud/backend_colorize.go create mode 100644 internal/cloud/backend_common.go create mode 100644 internal/cloud/backend_context.go create mode 100644 internal/cloud/backend_context_test.go create mode 100644 internal/cloud/backend_mock.go create mode 100644 internal/cloud/backend_plan.go create mode 100644 internal/cloud/backend_plan_test.go create mode 100644 internal/cloud/backend_state.go create mode 100644 internal/cloud/backend_state_test.go create mode 100644 internal/cloud/backend_test.go create mode 100644 internal/cloud/remote_test.go create mode 100644 internal/cloud/testdata/apply-destroy/main.tf create mode 100644 internal/cloud/testdata/apply-no-changes/main.tf create mode 100644 internal/cloud/testdata/apply-policy-hard-failed/main.tf create mode 100644 internal/cloud/testdata/apply-policy-passed/main.tf create mode 100644 internal/cloud/testdata/apply-policy-soft-failed/main.tf create mode 100644 internal/cloud/testdata/apply-variables/main.tf create mode 100644 internal/cloud/testdata/apply-with-error/main.tf create mode 100644 internal/cloud/testdata/apply/main.tf create mode 100644 internal/cloud/testdata/empty/.gitignore create mode 100644 internal/cloud/testdata/plan-cost-estimation/main.tf create mode 100644 internal/cloud/testdata/plan-long-line/main.tf create mode 100644 internal/cloud/testdata/plan-no-changes/main.tf create mode 100644 internal/cloud/testdata/plan-policy-hard-failed/main.tf create mode 100644 internal/cloud/testdata/plan-policy-passed/main.tf create mode 100644 internal/cloud/testdata/plan-policy-soft-failed/main.tf create mode 100644 internal/cloud/testdata/plan-variables/main.tf create mode 100644 internal/cloud/testdata/plan-with-error/main.tf create mode 100644 internal/cloud/testdata/plan-with-working-directory/terraform/main.tf create mode 100644 internal/cloud/testdata/plan/main.tf create mode 100644 internal/cloud/testing.go diff --git a/internal/backend/init/init.go b/internal/backend/init/init.go index 5abc8754d4f9..30a1ccfdde02 100644 --- a/internal/backend/init/init.go +++ b/internal/backend/init/init.go @@ -27,6 +27,7 @@ import ( backendPg "github.com/hashicorp/terraform/internal/backend/remote-state/pg" backendS3 "github.com/hashicorp/terraform/internal/backend/remote-state/s3" backendSwift "github.com/hashicorp/terraform/internal/backend/remote-state/swift" + backendCloud "github.com/hashicorp/terraform/internal/cloud" ) // backends is the list of available backends. This is a global variable @@ -49,7 +50,6 @@ func Init(services *disco.Disco) { defer backendsLock.Unlock() backends = map[string]backend.InitFn{ - // Enhanced backends. "local": func() backend.Backend { return backendLocal.New() }, "remote": func() backend.Backend { return backendRemote.New(services) }, @@ -70,6 +70,10 @@ func Init(services *disco.Disco) { "s3": func() backend.Backend { return backendS3.New() }, "swift": func() backend.Backend { return backendSwift.New() }, + // Terraform Cloud 'backend' + // This is an implementation detail only, used for the cloud package + "cloud": func() backend.Backend { return backendCloud.New(services) }, + // Deprecated backends. "azure": func() backend.Backend { return deprecateBackend( diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go new file mode 100644 index 000000000000..b6ae5e154157 --- /dev/null +++ b/internal/cloud/backend.go @@ -0,0 +1,1049 @@ +package cloud + +import ( + "context" + "fmt" + "log" + "net/http" + "net/url" + "os" + "sort" + "strings" + "sync" + "time" + + tfe "github.com/hashicorp/go-tfe" + version "github.com/hashicorp/go-version" + svchost "github.com/hashicorp/terraform-svchost" + "github.com/hashicorp/terraform-svchost/disco" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/states/remote" + "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" + tfversion "github.com/hashicorp/terraform/version" + "github.com/mitchellh/cli" + "github.com/mitchellh/colorstring" + "github.com/zclconf/go-cty/cty" + + backendLocal "github.com/hashicorp/terraform/internal/backend/local" +) + +const ( + defaultHostname = "app.terraform.io" + defaultParallelism = 10 + stateServiceID = "state.v2" + tfeServiceID = "tfe.v2.1" +) + +// Cloud is an implementation of EnhancedBackend in service of the Terraform Cloud/Enterprise +// integration for Terraform CLI. This backend is not intended to be surfaced at the user level and +// is instead an implementation detail of cloud.Cloud. +type Cloud struct { + // CLI and Colorize control the CLI output. If CLI is nil then no CLI + // output will be done. If CLIColor is nil then no coloring will be done. + CLI cli.Ui + CLIColor *colorstring.Colorize + + // ContextOpts are the base context options to set when initializing a + // new Terraform context. Many of these will be overridden or merged by + // Operation. See Operation for more details. + ContextOpts *terraform.ContextOpts + + // client is the Terraform Cloud/Enterprise API client. + client *tfe.Client + + // lastRetry is set to the last time a request was retried. + lastRetry time.Time + + // hostname of Terraform Cloud or Terraform Enterprise + hostname string + + // organization is the organization that contains the target workspaces. + organization string + + // workspace is used to map the default workspace to a TFC workspace. + workspace string + + // prefix is used to filter down a set of workspaces that use a single + // configuration. + prefix string + + // services is used for service discovery + services *disco.Disco + + // local allows local operations, where Terraform Cloud serves as a state storage backend. + local backend.Enhanced + + // forceLocal, if true, will force the use of the local backend. + forceLocal bool + + // opLock locks operations + opLock sync.Mutex + + // ignoreVersionConflict, if true, will disable the requirement that the + // local Terraform version matches the remote workspace's configured + // version. This will also cause VerifyWorkspaceTerraformVersion to return + // a warning diagnostic instead of an error. + ignoreVersionConflict bool +} + +var _ backend.Backend = (*Cloud)(nil) + +// New creates a new initialized cloud backend. +func New(services *disco.Disco) *Cloud { + return &Cloud{ + services: services, + } +} + +// ConfigSchema implements backend.Enhanced. +func (b *Cloud) ConfigSchema() *configschema.Block { + return &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "hostname": { + Type: cty.String, + Optional: true, + Description: schemaDescriptions["hostname"], + }, + "organization": { + Type: cty.String, + Required: true, + Description: schemaDescriptions["organization"], + }, + "token": { + Type: cty.String, + Optional: true, + Description: schemaDescriptions["token"], + }, + }, + + BlockTypes: map[string]*configschema.NestedBlock{ + "workspaces": { + Block: configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "name": { + Type: cty.String, + Optional: true, + Description: schemaDescriptions["name"], + }, + "prefix": { + Type: cty.String, + Optional: true, + Description: schemaDescriptions["prefix"], + }, + }, + }, + Nesting: configschema.NestingSingle, + }, + }, + } +} + +// PrepareConfig implements backend.Backend. +func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + if obj.IsNull() { + return obj, diags + } + + if val := obj.GetAttr("organization"); val.IsNull() || val.AsString() == "" { + diags = diags.Append(tfdiags.AttributeValue( + tfdiags.Error, + "Invalid organization value", + `The "organization" attribute value must not be empty.`, + cty.Path{cty.GetAttrStep{Name: "organization"}}, + )) + } + + var name, prefix string + if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { + if val := workspaces.GetAttr("name"); !val.IsNull() { + name = val.AsString() + } + if val := workspaces.GetAttr("prefix"); !val.IsNull() { + prefix = val.AsString() + } + } + + // Make sure that we have either a workspace name or a prefix. + if name == "" && prefix == "" { + diags = diags.Append(tfdiags.AttributeValue( + tfdiags.Error, + "Invalid workspaces configuration", + `Either workspace "name" or "prefix" is required.`, + cty.Path{cty.GetAttrStep{Name: "workspaces"}}, + )) + } + + // Make sure that only one of workspace name or a prefix is configured. + if name != "" && prefix != "" { + diags = diags.Append(tfdiags.AttributeValue( + tfdiags.Error, + "Invalid workspaces configuration", + `Only one of workspace "name" or "prefix" is allowed.`, + cty.Path{cty.GetAttrStep{Name: "workspaces"}}, + )) + } + + return obj, diags +} + +// Configure implements backend.Enhanced. +func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + if obj.IsNull() { + return diags + } + + // Get the hostname. + if val := obj.GetAttr("hostname"); !val.IsNull() && val.AsString() != "" { + b.hostname = val.AsString() + } else { + b.hostname = defaultHostname + } + + // Get the organization. + if val := obj.GetAttr("organization"); !val.IsNull() { + b.organization = val.AsString() + } + + // Get the workspaces configuration block and retrieve the + // default workspace name and prefix. + if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { + if val := workspaces.GetAttr("name"); !val.IsNull() { + b.workspace = val.AsString() + } + if val := workspaces.GetAttr("prefix"); !val.IsNull() { + b.prefix = val.AsString() + } + } + + // Determine if we are forced to use the local backend. + b.forceLocal = os.Getenv("TF_FORCE_LOCAL_BACKEND") != "" + + serviceID := tfeServiceID + if b.forceLocal { + serviceID = stateServiceID + } + + // Discover the service URL to confirm that it provides the Terraform Cloud/Enterprise API + // and to get the version constraints. + service, constraints, err := b.discover(serviceID) + + // First check any contraints we might have received. + if constraints != nil { + diags = diags.Append(b.checkConstraints(constraints)) + if diags.HasErrors() { + return diags + } + } + + // When we don't have any constraints errors, also check for discovery + // errors before we continue. + if err != nil { + diags = diags.Append(tfdiags.AttributeValue( + tfdiags.Error, + strings.ToUpper(err.Error()[:1])+err.Error()[1:], + "", // no description is needed here, the error is clear + cty.Path{cty.GetAttrStep{Name: "hostname"}}, + )) + return diags + } + + // Retrieve the token for this host as configured in the credentials + // section of the CLI Config File. + token, err := b.token() + if err != nil { + diags = diags.Append(tfdiags.AttributeValue( + tfdiags.Error, + strings.ToUpper(err.Error()[:1])+err.Error()[1:], + "", // no description is needed here, the error is clear + cty.Path{cty.GetAttrStep{Name: "hostname"}}, + )) + return diags + } + + // Get the token from the config if no token was configured for this + // host in credentials section of the CLI Config File. + if token == "" { + if val := obj.GetAttr("token"); !val.IsNull() { + token = val.AsString() + } + } + + // Return an error if we still don't have a token at this point. + if token == "" { + loginCommand := "terraform login" + if b.hostname != defaultHostname { + loginCommand = loginCommand + " " + b.hostname + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Required token could not be found", + fmt.Sprintf( + "Run the following command to generate a token for %s:\n %s", + b.hostname, + loginCommand, + ), + )) + return diags + } + + cfg := &tfe.Config{ + Address: service.String(), + BasePath: service.Path, + Token: token, + Headers: make(http.Header), + RetryLogHook: b.retryLogHook, + } + + // Set the version header to the current version. + cfg.Headers.Set(tfversion.Header, tfversion.Version) + + // Create the TFC/E API client. + b.client, err = tfe.NewClient(cfg) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to create the Terraform Enterprise client", + fmt.Sprintf( + `Encountered an unexpected error while creating the `+ + `Terraform Enterprise client: %s.`, err, + ), + )) + return diags + } + + // Check if the organization exists by reading its entitlements. + entitlements, err := b.client.Organizations.Entitlements(context.Background(), b.organization) + if err != nil { + if err == tfe.ErrResourceNotFound { + err = fmt.Errorf("organization %q at host %s not found.\n\n"+ + "Please ensure that the organization and hostname are correct "+ + "and that your API token for %s is valid.", + b.organization, b.hostname, b.hostname) + } + diags = diags.Append(tfdiags.AttributeValue( + tfdiags.Error, + fmt.Sprintf("Failed to read organization %q at host %s", b.organization, b.hostname), + fmt.Sprintf("Encountered an unexpected error while reading the "+ + "organization settings: %s", err), + cty.Path{cty.GetAttrStep{Name: "organization"}}, + )) + return diags + } + + // Configure a local backend for when we need to run operations locally. + b.local = backendLocal.NewWithBackend(b) + b.forceLocal = b.forceLocal || !entitlements.Operations + + // Enable retries for server errors as the backend is now fully configured. + b.client.RetryServerErrors(true) + + return diags +} + +// discover the TFC/E API service URL and version constraints. +func (b *Cloud) discover(serviceID string) (*url.URL, *disco.Constraints, error) { + hostname, err := svchost.ForComparison(b.hostname) + if err != nil { + return nil, nil, err + } + + host, err := b.services.Discover(hostname) + if err != nil { + return nil, nil, err + } + + service, err := host.ServiceURL(serviceID) + // Return the error, unless its a disco.ErrVersionNotSupported error. + if _, ok := err.(*disco.ErrVersionNotSupported); !ok && err != nil { + return nil, nil, err + } + + // We purposefully ignore the error and return the previous error, as + // checking for version constraints is considered optional. + constraints, _ := host.VersionConstraints(serviceID, "terraform") + + return service, constraints, err +} + +// checkConstraints checks service version constrains against our own +// version and returns rich and informational diagnostics in case any +// incompatibilities are detected. +func (b *Cloud) checkConstraints(c *disco.Constraints) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + if c == nil || c.Minimum == "" || c.Maximum == "" { + return diags + } + + // Generate a parsable constraints string. + excluding := "" + if len(c.Excluding) > 0 { + excluding = fmt.Sprintf(", != %s", strings.Join(c.Excluding, ", != ")) + } + constStr := fmt.Sprintf(">= %s%s, <= %s", c.Minimum, excluding, c.Maximum) + + // Create the constraints to check against. + constraints, err := version.NewConstraint(constStr) + if err != nil { + return diags.Append(checkConstraintsWarning(err)) + } + + // Create the version to check. + v, err := version.NewVersion(tfversion.Version) + if err != nil { + return diags.Append(checkConstraintsWarning(err)) + } + + // Return if we satisfy all constraints. + if constraints.Check(v) { + return diags + } + + // Find out what action (upgrade/downgrade) we should advice. + minimum, err := version.NewVersion(c.Minimum) + if err != nil { + return diags.Append(checkConstraintsWarning(err)) + } + + maximum, err := version.NewVersion(c.Maximum) + if err != nil { + return diags.Append(checkConstraintsWarning(err)) + } + + var excludes []*version.Version + for _, exclude := range c.Excluding { + v, err := version.NewVersion(exclude) + if err != nil { + return diags.Append(checkConstraintsWarning(err)) + } + excludes = append(excludes, v) + } + + // Sort all the excludes. + sort.Sort(version.Collection(excludes)) + + var action, toVersion string + switch { + case minimum.GreaterThan(v): + action = "upgrade" + toVersion = ">= " + minimum.String() + case maximum.LessThan(v): + action = "downgrade" + toVersion = "<= " + maximum.String() + case len(excludes) > 0: + // Get the latest excluded version. + action = "upgrade" + toVersion = "> " + excludes[len(excludes)-1].String() + } + + switch { + case len(excludes) == 1: + excluding = fmt.Sprintf(", excluding version %s", excludes[0].String()) + case len(excludes) > 1: + var vs []string + for _, v := range excludes { + vs = append(vs, v.String()) + } + excluding = fmt.Sprintf(", excluding versions %s", strings.Join(vs, ", ")) + default: + excluding = "" + } + + summary := fmt.Sprintf("Incompatible Terraform version v%s", v.String()) + details := fmt.Sprintf( + "The configured Terraform Enterprise backend is compatible with Terraform "+ + "versions >= %s, <= %s%s.", c.Minimum, c.Maximum, excluding, + ) + + if action != "" && toVersion != "" { + summary = fmt.Sprintf("Please %s Terraform to %s", action, toVersion) + details += fmt.Sprintf(" Please %s to a supported version and try again.", action) + } + + // Return the customized and informational error message. + return diags.Append(tfdiags.Sourceless(tfdiags.Error, summary, details)) +} + +// token returns the token for this host as configured in the credentials +// section of the CLI Config File. If no token was configured, an empty +// string will be returned instead. +func (b *Cloud) token() (string, error) { + hostname, err := svchost.ForComparison(b.hostname) + if err != nil { + return "", err + } + creds, err := b.services.CredentialsForHost(hostname) + if err != nil { + log.Printf("[WARN] Failed to get credentials for %s: %s (ignoring)", b.hostname, err) + return "", nil + } + if creds != nil { + return creds.Token(), nil + } + return "", nil +} + +// retryLogHook is invoked each time a request is retried allowing the +// backend to log any connection issues to prevent data loss. +func (b *Cloud) retryLogHook(attemptNum int, resp *http.Response) { + if b.CLI != nil { + // Ignore the first retry to make sure any delayed output will + // be written to the console before we start logging retries. + // + // The retry logic in the TFE client will retry both rate limited + // requests and server errors, but in the cloud backend we only + // care about server errors so we ignore rate limit (429) errors. + if attemptNum == 0 || (resp != nil && resp.StatusCode == 429) { + // Reset the last retry time. + b.lastRetry = time.Now() + return + } + + if attemptNum == 1 { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(initialRetryError))) + } else { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace( + fmt.Sprintf(repeatedRetryError, time.Since(b.lastRetry).Round(time.Second))))) + } + } +} + +// Workspaces implements backend.Enhanced. +func (b *Cloud) Workspaces() ([]string, error) { + if b.prefix == "" { + return nil, backend.ErrWorkspacesNotSupported + } + return b.workspaces() +} + +// workspaces returns a filtered list of remote workspace names. +func (b *Cloud) workspaces() ([]string, error) { + options := tfe.WorkspaceListOptions{} + switch { + case b.workspace != "": + options.Search = tfe.String(b.workspace) + case b.prefix != "": + options.Search = tfe.String(b.prefix) + } + + // Create a slice to contain all the names. + var names []string + + for { + wl, err := b.client.Workspaces.List(context.Background(), b.organization, options) + if err != nil { + return nil, err + } + + for _, w := range wl.Items { + if b.workspace != "" && w.Name == b.workspace { + names = append(names, backend.DefaultStateName) + continue + } + if b.prefix != "" && strings.HasPrefix(w.Name, b.prefix) { + names = append(names, strings.TrimPrefix(w.Name, b.prefix)) + } + } + + // Exit the loop when we've seen all pages. + if wl.CurrentPage >= wl.TotalPages { + break + } + + // Update the page number to get the next page. + options.PageNumber = wl.NextPage + } + + // Sort the result so we have consistent output. + sort.StringSlice(names).Sort() + + return names, nil +} + +// DeleteWorkspace implements backend.Enhanced. +func (b *Cloud) DeleteWorkspace(name string) error { + if b.workspace == "" && name == backend.DefaultStateName { + return backend.ErrDefaultWorkspaceNotSupported + } + if b.prefix == "" && name != backend.DefaultStateName { + return backend.ErrWorkspacesNotSupported + } + + // Configure the remote workspace name. + switch { + case name == backend.DefaultStateName: + name = b.workspace + case b.prefix != "" && !strings.HasPrefix(name, b.prefix): + name = b.prefix + name + } + + client := &remoteClient{ + client: b.client, + organization: b.organization, + workspace: &tfe.Workspace{ + Name: name, + }, + } + + return client.Delete() +} + +// StateMgr implements backend.Enhanced. +func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { + if b.workspace == "" && name == backend.DefaultStateName { + return nil, backend.ErrDefaultWorkspaceNotSupported + } + if b.prefix == "" && name != backend.DefaultStateName { + return nil, backend.ErrWorkspacesNotSupported + } + + // Configure the remote workspace name. + switch { + case name == backend.DefaultStateName: + name = b.workspace + case b.prefix != "" && !strings.HasPrefix(name, b.prefix): + name = b.prefix + name + } + + workspace, err := b.client.Workspaces.Read(context.Background(), b.organization, name) + if err != nil && err != tfe.ErrResourceNotFound { + return nil, fmt.Errorf("Failed to retrieve workspace %s: %v", name, err) + } + + if err == tfe.ErrResourceNotFound { + options := tfe.WorkspaceCreateOptions{ + Name: tfe.String(name), + } + + // We only set the Terraform Version for the new workspace if this is + // a release candidate or a final release. + if tfversion.Prerelease == "" || strings.HasPrefix(tfversion.Prerelease, "rc") { + options.TerraformVersion = tfe.String(tfversion.String()) + } + + workspace, err = b.client.Workspaces.Create(context.Background(), b.organization, options) + if err != nil { + return nil, fmt.Errorf("Error creating workspace %s: %v", name, err) + } + } + + // This is a fallback error check. Most code paths should use other + // mechanisms to check the version, then set the ignoreVersionConflict + // field to true. This check is only in place to ensure that we don't + // accidentally upgrade state with a new code path, and the version check + // logic is coarser and simpler. + if !b.ignoreVersionConflict { + wsv := workspace.TerraformVersion + // Explicitly ignore the pseudo-version "latest" here, as it will cause + // plan and apply to always fail. + if wsv != tfversion.String() && wsv != "latest" { + return nil, fmt.Errorf("Remote workspace Terraform version %q does not match local Terraform version %q", workspace.TerraformVersion, tfversion.String()) + } + } + + client := &remoteClient{ + client: b.client, + organization: b.organization, + workspace: workspace, + + // This is optionally set during Terraform Enterprise runs. + runID: os.Getenv("TFE_RUN_ID"), + } + + return &remote.State{Client: client}, nil +} + +// Operation implements backend.Enhanced. +func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend.RunningOperation, error) { + // Get the remote workspace name. + name := op.Workspace + switch { + case op.Workspace == backend.DefaultStateName: + name = b.workspace + case b.prefix != "" && !strings.HasPrefix(op.Workspace, b.prefix): + name = b.prefix + op.Workspace + } + + // Retrieve the workspace for this operation. + w, err := b.client.Workspaces.Read(ctx, b.organization, name) + if err != nil { + switch err { + case context.Canceled: + return nil, err + case tfe.ErrResourceNotFound: + return nil, fmt.Errorf( + "workspace %s not found\n\n"+ + "For security, Terraform Cloud returns '404 Not Found' responses for resources\n"+ + "for resources that a user doesn't have access to, in addition to resources that\n"+ + "do not exist. If the resource does exist, please check the permissions of the provided token.", + name, + ) + default: + return nil, fmt.Errorf( + "Terraform Cloud returned an unexpected error:\n\n%s", + err, + ) + } + } + + // Terraform remote version conflicts are not a concern for operations. We + // are in one of three states: + // + // - Running remotely, in which case the local version is irrelevant; + // - Workspace configured for local operations, in which case the remote + // version is meaningless; + // - Forcing local operations, which should only happen in the Terraform Cloud worker, in + // which case the Terraform versions by definition match. + b.IgnoreVersionConflict() + + // Check if we need to use the local backend to run the operation. + if b.forceLocal || !w.Operations { + // Record that we're forced to run operations locally to allow the + // command package UI to operate correctly + b.forceLocal = true + return b.local.Operation(ctx, op) + } + + // Set the remote workspace name. + op.Workspace = w.Name + + // Determine the function to call for our operation + var f func(context.Context, context.Context, *backend.Operation, *tfe.Workspace) (*tfe.Run, error) + switch op.Type { + case backend.OperationTypePlan: + f = b.opPlan + case backend.OperationTypeApply: + f = b.opApply + case backend.OperationTypeRefresh: + return nil, fmt.Errorf( + "\n\nThe \"refresh\" operation is not supported when using Terraform Cloud. " + + "Use \"terraform apply -refresh-only\" instead.") + default: + return nil, fmt.Errorf( + "\n\nTerraform Cloud does not support the %q operation.", op.Type) + } + + // Lock + b.opLock.Lock() + + // Build our running operation + // the runninCtx is only used to block until the operation returns. + runningCtx, done := context.WithCancel(context.Background()) + runningOp := &backend.RunningOperation{ + Context: runningCtx, + PlanEmpty: true, + } + + // stopCtx wraps the context passed in, and is used to signal a graceful Stop. + stopCtx, stop := context.WithCancel(ctx) + runningOp.Stop = stop + + // cancelCtx is used to cancel the operation immediately, usually + // indicating that the process is exiting. + cancelCtx, cancel := context.WithCancel(context.Background()) + runningOp.Cancel = cancel + + // Do it. + go func() { + defer done() + defer stop() + defer cancel() + + defer b.opLock.Unlock() + + r, opErr := f(stopCtx, cancelCtx, op, w) + if opErr != nil && opErr != context.Canceled { + var diags tfdiags.Diagnostics + diags = diags.Append(opErr) + op.ReportResult(runningOp, diags) + return + } + + if r == nil && opErr == context.Canceled { + runningOp.Result = backend.OperationFailure + return + } + + if r != nil { + // Retrieve the run to get its current status. + r, err := b.client.Runs.Read(cancelCtx, r.ID) + if err != nil { + var diags tfdiags.Diagnostics + diags = diags.Append(generalError("Failed to retrieve run", err)) + op.ReportResult(runningOp, diags) + return + } + + // Record if there are any changes. + runningOp.PlanEmpty = !r.HasChanges + + if opErr == context.Canceled { + if err := b.cancel(cancelCtx, op, r); err != nil { + var diags tfdiags.Diagnostics + diags = diags.Append(generalError("Failed to retrieve run", err)) + op.ReportResult(runningOp, diags) + return + } + } + + if r.Status == tfe.RunCanceled || r.Status == tfe.RunErrored { + runningOp.Result = backend.OperationFailure + } + } + }() + + // Return the running operation. + return runningOp, nil +} + +func (b *Cloud) cancel(cancelCtx context.Context, op *backend.Operation, r *tfe.Run) error { + if r.Actions.IsCancelable { + // Only ask if the remote operation should be canceled + // if the auto approve flag is not set. + if !op.AutoApprove { + v, err := op.UIIn.Input(cancelCtx, &terraform.InputOpts{ + Id: "cancel", + Query: "\nDo you want to cancel the remote operation?", + Description: "Only 'yes' will be accepted to cancel.", + }) + if err != nil { + return generalError("Failed asking to cancel", err) + } + if v != "yes" { + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(operationNotCanceled))) + } + return nil + } + } else { + if b.CLI != nil { + // Insert a blank line to separate the ouputs. + b.CLI.Output("") + } + } + + // Try to cancel the remote operation. + err := b.client.Runs.Cancel(cancelCtx, r.ID, tfe.RunCancelOptions{}) + if err != nil { + return generalError("Failed to cancel run", err) + } + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(operationCanceled))) + } + } + + return nil +} + +// IgnoreVersionConflict allows commands to disable the fall-back check that +// the local Terraform version matches the remote workspace's configured +// Terraform version. This should be called by commands where this check is +// unnecessary, such as those performing remote operations, or read-only +// operations. It will also be called if the user uses a command-line flag to +// override this check. +func (b *Cloud) IgnoreVersionConflict() { + b.ignoreVersionConflict = true +} + +// VerifyWorkspaceTerraformVersion compares the local Terraform version against +// the workspace's configured Terraform version. If they are equal, this means +// that there are no compatibility concerns, so it returns no diagnostics. +// +// If the versions differ, +func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + workspace, err := b.getRemoteWorkspace(context.Background(), workspaceName) + if err != nil { + // If the workspace doesn't exist, there can be no compatibility + // problem, so we can return. This is most likely to happen when + // migrating state from a local backend to a new workspace. + if err == tfe.ErrResourceNotFound { + return nil + } + + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Error looking up workspace", + fmt.Sprintf("Workspace read failed: %s", err), + )) + return diags + } + + // If the workspace has the pseudo-version "latest", all bets are off. We + // cannot reasonably determine what the intended Terraform version is, so + // we'll skip version verification. + if workspace.TerraformVersion == "latest" { + return nil + } + + // If the workspace has remote operations disabled, the remote Terraform + // version is effectively meaningless, so we'll skip version verification. + if workspace.Operations == false { + return nil + } + + remoteVersion, err := version.NewSemver(workspace.TerraformVersion) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Error looking up workspace", + fmt.Sprintf("Invalid Terraform version: %s", err), + )) + return diags + } + + v014 := version.Must(version.NewSemver("0.14.0")) + if tfversion.SemVer.LessThan(v014) || remoteVersion.LessThan(v014) { + // Versions of Terraform prior to 0.14.0 will refuse to load state files + // written by a newer version of Terraform, even if it is only a patch + // level difference. As a result we require an exact match. + if tfversion.SemVer.Equal(remoteVersion) { + return diags + } + } + if tfversion.SemVer.GreaterThanOrEqual(v014) && remoteVersion.GreaterThanOrEqual(v014) { + // Versions of Terraform after 0.14.0 should be compatible with each + // other. At the time this code was written, the only constraints we + // are aware of are: + // + // - 0.14.0 is guaranteed to be compatible with versions up to but not + // including 1.1.0 + v110 := version.Must(version.NewSemver("1.1.0")) + if tfversion.SemVer.LessThan(v110) && remoteVersion.LessThan(v110) { + return diags + } + // - Any new Terraform state version will require at least minor patch + // increment, so x.y.* will always be compatible with each other + tfvs := tfversion.SemVer.Segments64() + rwvs := remoteVersion.Segments64() + if len(tfvs) == 3 && len(rwvs) == 3 && tfvs[0] == rwvs[0] && tfvs[1] == rwvs[1] { + return diags + } + } + + // Even if ignoring version conflicts, it may still be useful to call this + // method and warn the user about a mismatch between the local and remote + // Terraform versions. + severity := tfdiags.Error + if b.ignoreVersionConflict { + severity = tfdiags.Warning + } + + suggestion := " If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." + if b.ignoreVersionConflict { + suggestion = "" + } + diags = diags.Append(tfdiags.Sourceless( + severity, + "Terraform version mismatch", + fmt.Sprintf( + "The local Terraform version (%s) does not match the configured version for remote workspace %s/%s (%s).%s", + tfversion.String(), + b.organization, + workspace.Name, + workspace.TerraformVersion, + suggestion, + ), + )) + + return diags +} + +func (b *Cloud) IsLocalOperations() bool { + return b.forceLocal +} + +// Colorize returns the Colorize structure that can be used for colorizing +// output. This is guaranteed to always return a non-nil value and so useful +// as a helper to wrap any potentially colored strings. +// +// TODO SvH: Rename this back to Colorize as soon as we can pass -no-color. +func (b *Cloud) cliColorize() *colorstring.Colorize { + if b.CLIColor != nil { + return b.CLIColor + } + + return &colorstring.Colorize{ + Colors: colorstring.DefaultColors, + Disable: true, + } +} + +func generalError(msg string, err error) error { + var diags tfdiags.Diagnostics + + if urlErr, ok := err.(*url.Error); ok { + err = urlErr.Err + } + + switch err { + case context.Canceled: + return err + case tfe.ErrResourceNotFound: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + fmt.Sprintf("%s: %v", msg, err), + "For security, Terraform Cloud returns '404 Not Found' responses for resources\n"+ + "for resources that a user doesn't have access to, in addition to resources that\n"+ + "do not exist. If the resource does exist, please check the permissions of the provided token.", + )) + return diags.Err() + default: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + fmt.Sprintf("%s: %v", msg, err), + `Terraform Cloud returned an unexpected error. Sometimes `+ + `this is caused by network connection problems, in which case you could retry `+ + `the command. If the issue persists please open a support ticket to get help `+ + `resolving the problem.`, + )) + return diags.Err() + } +} + +func checkConstraintsWarning(err error) tfdiags.Diagnostic { + return tfdiags.Sourceless( + tfdiags.Warning, + fmt.Sprintf("Failed to check version constraints: %v", err), + "Checking version constraints is considered optional, but this is an"+ + "unexpected error which should be reported.", + ) +} + +// The newline in this error is to make it look good in the CLI! +const initialRetryError = ` +[reset][yellow]There was an error connecting to Terraform Cloud. Please do not exit +Terraform to prevent data loss! Trying to restore the connection... +[reset] +` + +const repeatedRetryError = ` +[reset][yellow]Still trying to restore the connection... (%s elapsed)[reset] +` + +const operationCanceled = ` +[reset][red]The remote operation was successfully cancelled.[reset] +` + +const operationNotCanceled = ` +[reset][red]The remote operation was not cancelled.[reset] +` + +var schemaDescriptions = map[string]string{ + "hostname": "The Terraform Enterprise hostname to connect to. This optional argument defaults to app.terraform.io for use with Terraform Cloud.", + "organization": "The name of the organization containing the targeted workspace(s).", + "token": "The token used to authenticate with Terraform Cloud/Enterprise. Typically this argument should not be set,\n" + + "and 'terraform login' used instead; your credentials will then be fetched from your CLI configuration file or configured credential helper.", + "name": "A workspace name used to map the default workspace to a named remote workspace.\n" + + "When configured only the default workspace can be used. This option conflicts\n" + + "with \"prefix\"", + "prefix": "A prefix used to filter workspaces using a single configuration. New workspaces\n" + + "will automatically be prefixed with this prefix. If omitted only the default\n" + + "workspace can be used. This option conflicts with \"name\"", +} diff --git a/internal/cloud/backend_apply.go b/internal/cloud/backend_apply.go new file mode 100644 index 000000000000..e50f1ee60da8 --- /dev/null +++ b/internal/cloud/backend_apply.go @@ -0,0 +1,301 @@ +package cloud + +import ( + "bufio" + "context" + "fmt" + "io" + "log" + + tfe "github.com/hashicorp/go-tfe" + version "github.com/hashicorp/go-version" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operation, w *tfe.Workspace) (*tfe.Run, error) { + log.Printf("[INFO] cloud: starting Apply operation") + + var diags tfdiags.Diagnostics + + // We should remove the `CanUpdate` part of this test, but for now + // (to remain compatible with tfe.v2.1) we'll leave it in here. + if !w.Permissions.CanUpdate && !w.Permissions.CanQueueApply { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Insufficient rights to apply changes", + "The provided credentials have insufficient rights to apply changes. In order "+ + "to apply changes at least write permissions on the workspace are required.", + )) + return nil, diags.Err() + } + + if w.VCSRepo != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Apply not allowed for workspaces with a VCS connection", + "A workspace that is connected to a VCS requires the VCS-driven workflow "+ + "to ensure that the VCS remains the single source of truth.", + )) + return nil, diags.Err() + } + + if op.Parallelism != defaultParallelism { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Custom parallelism values are currently not supported", + `Terraform Cloud does not support setting a custom parallelism `+ + `value at this time.`, + )) + } + + if op.PlanFile != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Applying a saved plan is currently not supported", + `Terraform Cloud currently requires configuration to be present and `+ + `does not accept an existing saved plan as an argument at this time.`, + )) + } + + if b.hasExplicitVariableValues(op) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Run variables are currently not supported", + fmt.Sprintf( + "Terraform Cloud does not support setting run variables from command line arguments at this time. "+ + "Currently the only to way to pass variables is by "+ + "creating a '*.auto.tfvars' variables file. This file will automatically "+ + "be loaded when the workspace is configured to use "+ + "Terraform v0.10.0 or later.\n\nAdditionally you can also set variables on "+ + "the workspace in the web UI:\nhttps://%s/app/%s/%s/variables", + b.hostname, b.organization, op.Workspace, + ), + )) + } + + if !op.HasConfig() && op.PlanMode != plans.DestroyMode { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "No configuration files found", + `Apply requires configuration to be present. Applying without a configuration `+ + `would mark everything for destruction, which is normally not what is desired. `+ + `If you would like to destroy everything, please run 'terraform destroy' which `+ + `does not require any configuration files.`, + )) + } + + // For API versions prior to 2.3, RemoteAPIVersion will return an empty string, + // so if there's an error when parsing the RemoteAPIVersion, it's handled as + // equivalent to an API version < 2.3. + currentAPIVersion, parseErr := version.NewVersion(b.client.RemoteAPIVersion()) + + if !op.PlanRefresh { + desiredAPIVersion, _ := version.NewVersion("2.4") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Planning without refresh is not supported", + fmt.Sprintf( + `The host %s does not support the -refresh=false option for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + if op.PlanMode == plans.RefreshOnlyMode { + desiredAPIVersion, _ := version.NewVersion("2.4") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Refresh-only mode is not supported", + fmt.Sprintf( + `The host %s does not support -refresh-only mode for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + if len(op.ForceReplace) != 0 { + desiredAPIVersion, _ := version.NewVersion("2.4") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Planning resource replacements is not supported", + fmt.Sprintf( + `The host %s does not support the -replace option for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + if len(op.Targets) != 0 { + desiredAPIVersion, _ := version.NewVersion("2.3") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Resource targeting is not supported", + fmt.Sprintf( + `The host %s does not support the -target option for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + // Return if there are any errors. + if diags.HasErrors() { + return nil, diags.Err() + } + + // Run the plan phase. + r, err := b.plan(stopCtx, cancelCtx, op, w) + if err != nil { + return r, err + } + + // This check is also performed in the plan method to determine if + // the policies should be checked, but we need to check the values + // here again to determine if we are done and should return. + if !r.HasChanges || r.Status == tfe.RunCanceled || r.Status == tfe.RunErrored { + return r, nil + } + + // Retrieve the run to get its current status. + r, err = b.client.Runs.Read(stopCtx, r.ID) + if err != nil { + return r, generalError("Failed to retrieve run", err) + } + + // Return if the run cannot be confirmed. + if !w.AutoApply && !r.Actions.IsConfirmable { + return r, nil + } + + // Since we already checked the permissions before creating the run + // this should never happen. But it doesn't hurt to keep this in as + // a safeguard for any unexpected situations. + if !w.AutoApply && !r.Permissions.CanApply { + // Make sure we discard the run if possible. + if r.Actions.IsDiscardable { + err = b.client.Runs.Discard(stopCtx, r.ID, tfe.RunDiscardOptions{}) + if err != nil { + switch op.PlanMode { + case plans.DestroyMode: + return r, generalError("Failed to discard destroy", err) + default: + return r, generalError("Failed to discard apply", err) + } + } + } + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Insufficient rights to approve the pending changes", + fmt.Sprintf("There are pending changes, but the provided credentials have "+ + "insufficient rights to approve them. The run will be discarded to prevent "+ + "it from blocking the queue waiting for external approval. To queue a run "+ + "that can be approved by someone else, please use the 'Queue Plan' button in "+ + "the web UI:\nhttps://%s/app/%s/%s/runs", b.hostname, b.organization, op.Workspace), + )) + return r, diags.Err() + } + + mustConfirm := (op.UIIn != nil && op.UIOut != nil) && !op.AutoApprove + + if !w.AutoApply { + if mustConfirm { + opts := &terraform.InputOpts{Id: "approve"} + + if op.PlanMode == plans.DestroyMode { + opts.Query = "\nDo you really want to destroy all resources in workspace \"" + op.Workspace + "\"?" + opts.Description = "Terraform will destroy all your managed infrastructure, as shown above.\n" + + "There is no undo. Only 'yes' will be accepted to confirm." + } else { + opts.Query = "\nDo you want to perform these actions in workspace \"" + op.Workspace + "\"?" + opts.Description = "Terraform will perform the actions described above.\n" + + "Only 'yes' will be accepted to approve." + } + + err = b.confirm(stopCtx, op, opts, r, "yes") + if err != nil && err != errRunApproved { + return r, err + } + } + + if err != errRunApproved { + if err = b.client.Runs.Apply(stopCtx, r.ID, tfe.RunApplyOptions{}); err != nil { + return r, generalError("Failed to approve the apply command", err) + } + } + } + + // If we don't need to ask for confirmation, insert a blank + // line to separate the ouputs. + if w.AutoApply || !mustConfirm { + if b.CLI != nil { + b.CLI.Output("") + } + } + + r, err = b.waitForRun(stopCtx, cancelCtx, op, "apply", r, w) + if err != nil { + return r, err + } + + logs, err := b.client.Applies.Logs(stopCtx, r.Apply.ID) + if err != nil { + return r, generalError("Failed to retrieve logs", err) + } + reader := bufio.NewReaderSize(logs, 64*1024) + + if b.CLI != nil { + skip := 0 + for next := true; next; { + var l, line []byte + + for isPrefix := true; isPrefix; { + l, isPrefix, err = reader.ReadLine() + if err != nil { + if err != io.EOF { + return r, generalError("Failed to read logs", err) + } + next = false + } + line = append(line, l...) + } + + // Skip the first 3 lines to prevent duplicate output. + if skip < 3 { + skip++ + continue + } + + if next || len(line) > 0 { + b.CLI.Output(b.Colorize().Color(string(line))) + } + } + } + + return r, nil +} + +const applyDefaultHeader = ` +[reset][yellow]Running apply in Terraform Cloud. Output will stream here. Pressing Ctrl-C +will cancel the remote apply if it's still pending. If the apply started it +will stop streaming the logs, but will not stop the apply running remotely.[reset] + +Preparing the remote apply... +` diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go new file mode 100644 index 000000000000..140dafa8a426 --- /dev/null +++ b/internal/cloud/backend_apply_test.go @@ -0,0 +1,1659 @@ +package cloud + +import ( + "context" + "os" + "os/signal" + "strings" + "syscall" + "testing" + "time" + + "github.com/google/go-cmp/cmp" + tfe "github.com/hashicorp/go-tfe" + version "github.com/hashicorp/go-version" + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/command/arguments" + "github.com/hashicorp/terraform/internal/command/clistate" + "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/initwd" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/plans/planfile" + "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terminal" + "github.com/hashicorp/terraform/internal/terraform" + tfversion "github.com/hashicorp/terraform/version" + "github.com/mitchellh/cli" +) + +func testOperationApply(t *testing.T, configDir string) (*backend.Operation, func(), func(*testing.T) *terminal.TestOutput) { + t.Helper() + + return testOperationApplyWithTimeout(t, configDir, 0) +} + +func testOperationApplyWithTimeout(t *testing.T, configDir string, timeout time.Duration) (*backend.Operation, func(), func(*testing.T) *terminal.TestOutput) { + t.Helper() + + _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) + + streams, done := terminal.StreamsForTesting(t) + view := views.NewView(streams) + stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) + operationView := views.NewOperation(arguments.ViewHuman, false, view) + + return &backend.Operation{ + ConfigDir: configDir, + ConfigLoader: configLoader, + Parallelism: defaultParallelism, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypeApply, + View: operationView, + }, configCleanup, done +} + +func TestCloud_applyBasic(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } + + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + // An error suggests that the state was not unlocked after apply + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state after apply: %s", err.Error()) + } +} + +func TestCloud_applyCanceled(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + // Stop the run to simulate a Ctrl-C. + run.Stop() + + <-run.Done() + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state after cancelling apply: %s", err.Error()) + } +} + +func TestCloud_applyWithoutPermissions(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + // Create a named workspace without permissions. + w, err := b.client.Workspaces.Create( + context.Background(), + b.organization, + tfe.WorkspaceCreateOptions{ + Name: tfe.String(b.prefix + "prod"), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + w.Permissions.CanQueueApply = false + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + op.UIOut = b.CLI + op.Workspace = "prod" + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Insufficient rights to apply changes") { + t.Fatalf("expected a permissions error, got: %v", errOutput) + } +} + +func TestCloud_applyWithVCS(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + // Create a named workspace with a VCS. + _, err := b.client.Workspaces.Create( + context.Background(), + b.organization, + tfe.WorkspaceCreateOptions{ + Name: tfe.String(b.prefix + "prod"), + VCSRepo: &tfe.VCSRepoOptions{}, + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + op.Workspace = "prod" + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "not allowed for workspaces with a VCS") { + t.Fatalf("expected a VCS error, got: %v", errOutput) + } +} + +func TestCloud_applyWithParallelism(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + op.Parallelism = 3 + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "parallelism values are currently not supported") { + t.Fatalf("expected a parallelism error, got: %v", errOutput) + } +} + +func TestCloud_applyWithPlan(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + op.PlanFile = &planfile.Reader{} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "saved plan is currently not supported") { + t.Fatalf("expected a saved plan error, got: %v", errOutput) + } +} + +func TestCloud_applyWithoutRefresh(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + op.PlanRefresh = false + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected plan to be non-empty") + } + + // We should find a run inside the mock client that has refresh set + // to false. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff(false, run.Refresh); diff != "" { + t.Errorf("wrong Refresh setting in the created run\n%s", diff) + } + } +} + +func TestCloud_applyWithoutRefreshIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + b.client.SetFakeRemoteAPIVersion("2.3") + + op.PlanRefresh = false + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Planning without refresh is not supported") { + t.Fatalf("expected a not supported error, got: %v", errOutput) + } +} + +func TestCloud_applyWithRefreshOnly(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + op.PlanMode = plans.RefreshOnlyMode + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected plan to be non-empty") + } + + // We should find a run inside the mock client that has refresh-only set + // to true. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff(true, run.RefreshOnly); diff != "" { + t.Errorf("wrong RefreshOnly setting in the created run\n%s", diff) + } + } +} + +func TestCloud_applyWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + b.client.SetFakeRemoteAPIVersion("2.3") + + op.PlanMode = plans.RefreshOnlyMode + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Refresh-only mode is not supported") { + t.Fatalf("expected a not supported error, got: %v", errOutput) + } +} + +func TestCloud_applyWithTarget(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") + + op.Targets = []addrs.Targetable{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatal("expected apply operation to succeed") + } + if run.PlanEmpty { + t.Fatalf("expected plan to be non-empty") + } + + // We should find a run inside the mock client that has the same + // target address we requested above. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff([]string{"null_resource.foo"}, run.TargetAddrs); diff != "" { + t.Errorf("wrong TargetAddrs in the created run\n%s", diff) + } + } +} + +func TestCloud_applyWithTargetIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + // Set the tfe client's RemoteAPIVersion to an empty string, to mimic + // API versions prior to 2.3. + b.client.SetFakeRemoteAPIVersion("") + + addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") + + op.Targets = []addrs.Targetable{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Resource targeting is not supported") { + t.Fatalf("expected a targeting error, got: %v", errOutput) + } +} + +func TestCloud_applyWithReplace(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") + + op.ForceReplace = []addrs.AbsResourceInstance{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatal("expected plan operation to succeed") + } + if run.PlanEmpty { + t.Fatalf("expected plan to be non-empty") + } + + // We should find a run inside the mock client that has the same + // refresh address we requested above. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff([]string{"null_resource.foo"}, run.ReplaceAddrs); diff != "" { + t.Errorf("wrong ReplaceAddrs in the created run\n%s", diff) + } + } +} + +func TestCloud_applyWithReplaceIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + b.client.SetFakeRemoteAPIVersion("2.3") + + addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") + + op.ForceReplace = []addrs.AbsResourceInstance{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Planning resource replacements is not supported") { + t.Fatalf("expected a not supported error, got: %v", errOutput) + } +} + +func TestCloud_applyWithVariables(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-variables") + defer configCleanup() + + op.Variables = testVariables(terraform.ValueFromNamedFile, "foo", "bar") + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "variables are currently not supported") { + t.Fatalf("expected a variables error, got: %v", errOutput) + } +} + +func TestCloud_applyNoConfig(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/empty") + defer configCleanup() + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "configuration files found") { + t.Fatalf("expected configuration files error, got: %v", errOutput) + } + + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + // An error suggests that the state was not unlocked after apply + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state after failed apply: %s", err.Error()) + } +} + +func TestCloud_applyNoChanges(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-no-changes") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "No changes. Infrastructure is up-to-date.") { + t.Fatalf("expected no changes in plan summery: %s", output) + } + if !strings.Contains(output, "Sentinel Result: true") { + t.Fatalf("expected policy check result in output: %s", output) + } +} + +func TestCloud_applyNoApprove(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + input := testInput(t, map[string]string{ + "approve": "no", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Apply discarded") { + t.Fatalf("expected an apply discarded error, got: %v", errOutput) + } +} + +func TestCloud_applyAutoApprove(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "no", + }) + + op.AutoApprove = true + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) != 1 { + t.Fatalf("expected an unused answer, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyApprovedExternally(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "wait-for-external-update", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + ctx := context.Background() + + run, err := b.Operation(ctx, op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + // Wait 50 milliseconds to make sure the run started. + time.Sleep(50 * time.Millisecond) + + wl, err := b.client.Workspaces.List( + ctx, + b.organization, + tfe.WorkspaceListOptions{ + ListOptions: tfe.ListOptions{PageNumber: 2, PageSize: 10}, + }, + ) + if err != nil { + t.Fatalf("unexpected error listing workspaces: %v", err) + } + if len(wl.Items) != 1 { + t.Fatalf("expected 1 workspace, got %d workspaces", len(wl.Items)) + } + + rl, err := b.client.Runs.List(ctx, wl.Items[0].ID, tfe.RunListOptions{}) + if err != nil { + t.Fatalf("unexpected error listing runs: %v", err) + } + if len(rl.Items) != 1 { + t.Fatalf("expected 1 run, got %d runs", len(rl.Items)) + } + + err = b.client.Runs.Apply(context.Background(), rl.Items[0].ID, tfe.RunApplyOptions{}) + if err != nil { + t.Fatalf("unexpected error approving run: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "approved using the UI or API") { + t.Fatalf("expected external approval in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyDiscardedExternally(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "wait-for-external-update", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + ctx := context.Background() + + run, err := b.Operation(ctx, op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + // Wait 50 milliseconds to make sure the run started. + time.Sleep(50 * time.Millisecond) + + wl, err := b.client.Workspaces.List( + ctx, + b.organization, + tfe.WorkspaceListOptions{ + ListOptions: tfe.ListOptions{PageNumber: 2, PageSize: 10}, + }, + ) + if err != nil { + t.Fatalf("unexpected error listing workspaces: %v", err) + } + if len(wl.Items) != 1 { + t.Fatalf("expected 1 workspace, got %d workspaces", len(wl.Items)) + } + + rl, err := b.client.Runs.List(ctx, wl.Items[0].ID, tfe.RunListOptions{}) + if err != nil { + t.Fatalf("unexpected error listing runs: %v", err) + } + if len(rl.Items) != 1 { + t.Fatalf("expected 1 run, got %d runs", len(rl.Items)) + } + + err = b.client.Runs.Discard(context.Background(), rl.Items[0].ID, tfe.RunDiscardOptions{}) + if err != nil { + t.Fatalf("unexpected error discarding run: %v", err) + } + + <-run.Done() + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "discarded using the UI or API") { + t.Fatalf("expected external discard output: %s", output) + } + if strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("unexpected apply summery in output: %s", output) + } +} + +func TestCloud_applyWithAutoApply(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + // Create a named workspace that auto applies. + _, err := b.client.Workspaces.Create( + context.Background(), + b.organization, + tfe.WorkspaceCreateOptions{ + AutoApply: tfe.Bool(true), + Name: tfe.String(b.prefix + "prod"), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = "prod" + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) != 1 { + t.Fatalf("expected an unused answer, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyForceLocal(t *testing.T) { + // Set TF_FORCE_LOCAL_BACKEND so the cloud backend will use + // the local backend with itself as embedded backend. + if err := os.Setenv("TF_FORCE_LOCAL_BACKEND", "1"); err != nil { + t.Fatalf("error setting environment variable TF_FORCE_LOCAL_BACKEND: %v", err) + } + defer os.Unsetenv("TF_FORCE_LOCAL_BACKEND") + + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + streams, done := terminal.StreamsForTesting(t) + view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + op.View = view + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) + } + if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } + if !run.State.HasResources() { + t.Fatalf("expected resources in state") + } +} + +func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + ctx := context.Background() + + // Create a named workspace that doesn't allow operations. + _, err := b.client.Workspaces.Create( + ctx, + b.organization, + tfe.WorkspaceCreateOptions{ + Name: tfe.String(b.prefix + "no-operations"), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = "no-operations" + + streams, done := terminal.StreamsForTesting(t) + view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + op.View = view + + run, err := b.Operation(ctx, op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) + } + if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } + if !run.State.HasResources() { + t.Fatalf("expected resources in state") + } +} + +func TestCloud_applyLockTimeout(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + ctx := context.Background() + + // Retrieve the workspace used to run this operation in. + w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspace) + if err != nil { + t.Fatalf("error retrieving workspace: %v", err) + } + + // Create a new configuration version. + c, err := b.client.ConfigurationVersions.Create(ctx, w.ID, tfe.ConfigurationVersionCreateOptions{}) + if err != nil { + t.Fatalf("error creating configuration version: %v", err) + } + + // Create a pending run to block this run. + _, err = b.client.Runs.Create(ctx, tfe.RunCreateOptions{ + ConfigurationVersion: c, + Workspace: w, + }) + if err != nil { + t.Fatalf("error creating pending run: %v", err) + } + + op, configCleanup, done := testOperationApplyWithTimeout(t, "./testdata/apply", 50*time.Millisecond) + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "cancel": "yes", + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + _, err = b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + sigint := make(chan os.Signal, 1) + signal.Notify(sigint, syscall.SIGINT) + select { + case <-sigint: + // Stop redirecting SIGINT signals. + signal.Stop(sigint) + case <-time.After(200 * time.Millisecond): + t.Fatalf("expected lock timeout after 50 milliseconds, waited 200 milliseconds") + } + + if len(input.answers) != 2 { + t.Fatalf("expected unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "Lock timeout exceeded") { + t.Fatalf("expected lock timout error in output: %s", output) + } + if strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("unexpected plan summery in output: %s", output) + } + if strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("unexpected apply summery in output: %s", output) + } +} + +func TestCloud_applyDestroy(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-destroy") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.PlanMode = plans.DestroyMode + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "0 to add, 0 to change, 1 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "0 added, 0 changed, 1 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyDestroyNoConfig(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op, configCleanup, done := testOperationApply(t, "./testdata/empty") + defer configCleanup() + defer done(t) + + op.PlanMode = plans.DestroyMode + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } +} + +func TestCloud_applyPolicyPass(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-passed") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: true") { + t.Fatalf("expected policy check result in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyPolicyHardFail(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-hard-failed") + defer configCleanup() + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + viewOutput := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + if len(input.answers) != 1 { + t.Fatalf("expected an unused answers, got: %v", input.answers) + } + + errOutput := viewOutput.Stderr() + if !strings.Contains(errOutput, "hard failed") { + t.Fatalf("expected a policy check error, got: %v", errOutput) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: false") { + t.Fatalf("expected policy check result in output: %s", output) + } + if strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("unexpected apply summery in output: %s", output) + } +} + +func TestCloud_applyPolicySoftFail(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-soft-failed") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "override": "override", + "approve": "yes", + }) + + op.AutoApprove = false + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) > 0 { + t.Fatalf("expected no unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: false") { + t.Fatalf("expected policy check result in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-soft-failed") + defer configCleanup() + + input := testInput(t, map[string]string{}) + + op.AutoApprove = true + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + viewOutput := done(t) + if run.Result != backend.OperationSuccess { + t.Fatal("expected apply operation to success due to auto-approve") + } + + if run.PlanEmpty { + t.Fatalf("expected plan to not be empty, plan opertion completed without error") + } + + if len(input.answers) != 0 { + t.Fatalf("expected no answers, got: %v", input.answers) + } + + errOutput := viewOutput.Stderr() + if strings.Contains(errOutput, "soft failed") { + t.Fatalf("expected no policy check errors, instead got: %v", errOutput) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Sentinel Result: false") { + t.Fatalf("expected policy check to be false, insead got: %s", output) + } + if !strings.Contains(output, "Apply complete!") { + t.Fatalf("expected apply to be complete, instead got: %s", output) + } + + if !strings.Contains(output, "Resources: 1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected resources, instead got: %s", output) + } +} + +func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + // Create a named workspace that auto applies. + _, err := b.client.Workspaces.Create( + context.Background(), + b.organization, + tfe.WorkspaceCreateOptions{ + AutoApply: tfe.Bool(true), + Name: tfe.String(b.prefix + "prod"), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-soft-failed") + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "override": "override", + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = "prod" + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + if len(input.answers) != 1 { + t.Fatalf("expected an unused answer, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summery in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: false") { + t.Fatalf("expected policy check result in output: %s", output) + } + if !strings.Contains(output, "1 added, 0 changed, 0 destroyed") { + t.Fatalf("expected apply summery in output: %s", output) + } +} + +func TestCloud_applyWithRemoteError(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationApply(t, "./testdata/apply-with-error") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result == backend.OperationSuccess { + t.Fatal("expected apply operation to fail") + } + if run.Result.ExitStatus() != 1 { + t.Fatalf("expected exit code 1, got %d", run.Result.ExitStatus()) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "null_resource.foo: 1 error") { + t.Fatalf("expected apply error in output: %s", output) + } +} + +func TestCloud_applyVersionCheck(t *testing.T) { + testCases := map[string]struct { + localVersion string + remoteVersion string + forceLocal bool + hasOperations bool + wantErr string + }{ + "versions can be different for remote apply": { + localVersion: "0.14.0", + remoteVersion: "0.13.5", + hasOperations: true, + }, + "versions can be different for local apply": { + localVersion: "0.14.0", + remoteVersion: "0.13.5", + hasOperations: false, + }, + "force local with remote operations and different versions is acceptable": { + localVersion: "0.14.0", + remoteVersion: "0.14.0-acme-provider-bundle", + forceLocal: true, + hasOperations: true, + }, + "no error if versions are identical": { + localVersion: "0.14.0", + remoteVersion: "0.14.0", + forceLocal: true, + hasOperations: true, + }, + "no error if force local but workspace has remote operations disabled": { + localVersion: "0.14.0", + remoteVersion: "0.13.5", + forceLocal: true, + hasOperations: false, + }, + } + + for name, tc := range testCases { + t.Run(name, func(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + // SETUP: Save original local version state and restore afterwards + p := tfversion.Prerelease + v := tfversion.Version + s := tfversion.SemVer + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + tfversion.SemVer = s + }() + + // SETUP: Set local version for the test case + tfversion.Prerelease = "" + tfversion.Version = tc.localVersion + tfversion.SemVer = version.Must(version.NewSemver(tc.localVersion)) + + // SETUP: Set force local for the test case + b.forceLocal = tc.forceLocal + + ctx := context.Background() + + // SETUP: set the operations and Terraform Version fields on the + // remote workspace + _, err := b.client.Workspaces.Update( + ctx, + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + Operations: tfe.Bool(tc.hasOperations), + TerraformVersion: tfe.String(tc.remoteVersion), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + + // RUN: prepare the apply operation and run it + op, configCleanup, done := testOperationApply(t, "./testdata/apply") + defer configCleanup() + + streams, done := terminal.StreamsForTesting(t) + view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + op.View = view + + input := testInput(t, map[string]string{ + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(ctx, op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + // RUN: wait for completion + <-run.Done() + output := done(t) + + if tc.wantErr != "" { + // ASSERT: if the test case wants an error, check for failure + // and the error message + if run.Result != backend.OperationFailure { + t.Fatalf("expected run to fail, but result was %#v", run.Result) + } + errOutput := output.Stderr() + if !strings.Contains(errOutput, tc.wantErr) { + t.Fatalf("missing error %q\noutput: %s", tc.wantErr, errOutput) + } + } else { + // ASSERT: otherwise, check for success and appropriate output + // based on whether the run should be local or remote + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + output := b.CLI.(*cli.MockUi).OutputWriter.String() + hasRemote := strings.Contains(output, "Running apply in Terraform Cloud") + hasSummary := strings.Contains(output, "1 added, 0 changed, 0 destroyed") + hasResources := run.State.HasResources() + if !tc.forceLocal && tc.hasOperations { + if !hasRemote { + t.Errorf("missing TFC header in output: %s", output) + } + if !hasSummary { + t.Errorf("expected apply summary in output: %s", output) + } + } else { + if hasRemote { + t.Errorf("unexpected TFC header in output: %s", output) + } + if !hasResources { + t.Errorf("expected resources in state") + } + } + } + }) + } +} diff --git a/internal/cloud/backend_cli.go b/internal/cloud/backend_cli.go new file mode 100644 index 000000000000..8dac9bf3e143 --- /dev/null +++ b/internal/cloud/backend_cli.go @@ -0,0 +1,20 @@ +package cloud + +import ( + "github.com/hashicorp/terraform/internal/backend" +) + +// CLIInit implements backend.CLI +func (b *Cloud) CLIInit(opts *backend.CLIOpts) error { + if cli, ok := b.local.(backend.CLI); ok { + if err := cli.CLIInit(opts); err != nil { + return err + } + } + + b.CLI = opts.CLI + b.CLIColor = opts.CLIColor + b.ContextOpts = opts.ContextOpts + + return nil +} diff --git a/internal/cloud/backend_colorize.go b/internal/cloud/backend_colorize.go new file mode 100644 index 000000000000..6fb3c98c3bdf --- /dev/null +++ b/internal/cloud/backend_colorize.go @@ -0,0 +1,50 @@ +package cloud + +import ( + "regexp" + + "github.com/mitchellh/colorstring" +) + +// TODO SvH: This file should be deleted and the type cliColorize should be +// renamed back to Colorize as soon as we can pass -no-color to the backend. + +// colorsRe is used to find ANSI escaped color codes. +var colorsRe = regexp.MustCompile("\033\\[\\d{1,3}m") + +// Colorer is the interface that must be implemented to colorize strings. +type Colorer interface { + Color(v string) string +} + +// Colorize is used to print output when the -no-color flag is used. It will +// strip all ANSI escaped color codes which are set while the operation was +// executed in Terraform Enterprise. +// +// When Terraform Enterprise supports run specific variables, this code can be +// removed as we can then pass the CLI flag to the backend and prevent the color +// codes from being written to the output. +type Colorize struct { + cliColor *colorstring.Colorize +} + +// Color will strip all ANSI escaped color codes and return a uncolored string. +func (c *Colorize) Color(v string) string { + return colorsRe.ReplaceAllString(c.cliColor.Color(v), "") +} + +// Colorize returns the Colorize structure that can be used for colorizing +// output. This is guaranteed to always return a non-nil value and so is useful +// as a helper to wrap any potentially colored strings. +func (b *Cloud) Colorize() Colorer { + if b.CLIColor != nil && !b.CLIColor.Disable { + return b.CLIColor + } + if b.CLIColor != nil { + return &Colorize{cliColor: b.CLIColor} + } + return &Colorize{cliColor: &colorstring.Colorize{ + Colors: colorstring.DefaultColors, + Disable: true, + }} +} diff --git a/internal/cloud/backend_common.go b/internal/cloud/backend_common.go new file mode 100644 index 000000000000..92f28a1dd1a0 --- /dev/null +++ b/internal/cloud/backend_common.go @@ -0,0 +1,574 @@ +package cloud + +import ( + "bufio" + "context" + "errors" + "fmt" + "io" + "math" + "strconv" + "strings" + "time" + + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/terraform" +) + +var ( + errApplyDiscarded = errors.New("Apply discarded.") + errDestroyDiscarded = errors.New("Destroy discarded.") + errRunApproved = errors.New("approved using the UI or API") + errRunDiscarded = errors.New("discarded using the UI or API") + errRunOverridden = errors.New("overridden using the UI or API") +) + +var ( + backoffMin = 1000.0 + backoffMax = 3000.0 + + runPollInterval = 3 * time.Second +) + +// backoff will perform exponential backoff based on the iteration and +// limited by the provided min and max (in milliseconds) durations. +func backoff(min, max float64, iter int) time.Duration { + backoff := math.Pow(2, float64(iter)/5) * min + if backoff > max { + backoff = max + } + return time.Duration(backoff) * time.Millisecond +} + +func (b *Cloud) waitForRun(stopCtx, cancelCtx context.Context, op *backend.Operation, opType string, r *tfe.Run, w *tfe.Workspace) (*tfe.Run, error) { + started := time.Now() + updated := started + for i := 0; ; i++ { + select { + case <-stopCtx.Done(): + return r, stopCtx.Err() + case <-cancelCtx.Done(): + return r, cancelCtx.Err() + case <-time.After(backoff(backoffMin, backoffMax, i)): + // Timer up, show status + } + + // Retrieve the run to get its current status. + r, err := b.client.Runs.Read(stopCtx, r.ID) + if err != nil { + return r, generalError("Failed to retrieve run", err) + } + + // Return if the run is no longer pending. + if r.Status != tfe.RunPending && r.Status != tfe.RunConfirmed { + if i == 0 && opType == "plan" && b.CLI != nil { + b.CLI.Output(b.Colorize().Color(fmt.Sprintf("Waiting for the %s to start...\n", opType))) + } + if i > 0 && b.CLI != nil { + // Insert a blank line to separate the ouputs. + b.CLI.Output("") + } + return r, nil + } + + // Check if 30 seconds have passed since the last update. + current := time.Now() + if b.CLI != nil && (i == 0 || current.Sub(updated).Seconds() > 30) { + updated = current + position := 0 + elapsed := "" + + // Calculate and set the elapsed time. + if i > 0 { + elapsed = fmt.Sprintf( + " (%s elapsed)", current.Sub(started).Truncate(30*time.Second)) + } + + // Retrieve the workspace used to run this operation in. + w, err = b.client.Workspaces.Read(stopCtx, b.organization, w.Name) + if err != nil { + return nil, generalError("Failed to retrieve workspace", err) + } + + // If the workspace is locked the run will not be queued and we can + // update the status without making any expensive calls. + if w.Locked && w.CurrentRun != nil { + cr, err := b.client.Runs.Read(stopCtx, w.CurrentRun.ID) + if err != nil { + return r, generalError("Failed to retrieve current run", err) + } + if cr.Status == tfe.RunPending { + b.CLI.Output(b.Colorize().Color( + "Waiting for the manually locked workspace to be unlocked..." + elapsed)) + continue + } + } + + // Skip checking the workspace queue when we are the current run. + if w.CurrentRun == nil || w.CurrentRun.ID != r.ID { + found := false + options := tfe.RunListOptions{} + runlist: + for { + rl, err := b.client.Runs.List(stopCtx, w.ID, options) + if err != nil { + return r, generalError("Failed to retrieve run list", err) + } + + // Loop through all runs to calculate the workspace queue position. + for _, item := range rl.Items { + if !found { + if r.ID == item.ID { + found = true + } + continue + } + + // If the run is in a final state, ignore it and continue. + switch item.Status { + case tfe.RunApplied, tfe.RunCanceled, tfe.RunDiscarded, tfe.RunErrored: + continue + case tfe.RunPlanned: + if op.Type == backend.OperationTypePlan { + continue + } + } + + // Increase the workspace queue position. + position++ + + // Stop searching when we reached the current run. + if w.CurrentRun != nil && w.CurrentRun.ID == item.ID { + break runlist + } + } + + // Exit the loop when we've seen all pages. + if rl.CurrentPage >= rl.TotalPages { + break + } + + // Update the page number to get the next page. + options.PageNumber = rl.NextPage + } + + if position > 0 { + b.CLI.Output(b.Colorize().Color(fmt.Sprintf( + "Waiting for %d run(s) to finish before being queued...%s", + position, + elapsed, + ))) + continue + } + } + + options := tfe.RunQueueOptions{} + search: + for { + rq, err := b.client.Organizations.RunQueue(stopCtx, b.organization, options) + if err != nil { + return r, generalError("Failed to retrieve queue", err) + } + + // Search through all queued items to find our run. + for _, item := range rq.Items { + if r.ID == item.ID { + position = item.PositionInQueue + break search + } + } + + // Exit the loop when we've seen all pages. + if rq.CurrentPage >= rq.TotalPages { + break + } + + // Update the page number to get the next page. + options.PageNumber = rq.NextPage + } + + if position > 0 { + c, err := b.client.Organizations.Capacity(stopCtx, b.organization) + if err != nil { + return r, generalError("Failed to retrieve capacity", err) + } + b.CLI.Output(b.Colorize().Color(fmt.Sprintf( + "Waiting for %d queued run(s) to finish before starting...%s", + position-c.Running, + elapsed, + ))) + continue + } + + b.CLI.Output(b.Colorize().Color(fmt.Sprintf( + "Waiting for the %s to start...%s", opType, elapsed))) + } + } +} + +// hasExplicitVariableValues is a best-effort check to determine whether the +// user has provided -var or -var-file arguments to a remote operation. +// +// The results may be inaccurate if the configuration is invalid or if +// individual variable values are invalid. That's okay because we only use this +// result to hint the user to set variables a different way. It's always the +// remote system's responsibility to do final validation of the input. +func (b *Cloud) hasExplicitVariableValues(op *backend.Operation) bool { + // Load the configuration using the caller-provided configuration loader. + config, _, configDiags := op.ConfigLoader.LoadConfigWithSnapshot(op.ConfigDir) + if configDiags.HasErrors() { + // If we can't load the configuration then we'll assume no explicit + // variable values just to let the remote operation start and let + // the remote system return the same set of configuration errors. + return false + } + + // We're intentionally ignoring the diagnostics here because validation + // of the variable values is the responsibilty of the remote system. Our + // goal here is just to make a best effort count of how many variable + // values are coming from -var or -var-file CLI arguments so that we can + // hint the user that those are not supported for remote operations. + variables, _ := backend.ParseVariableValues(op.Variables, config.Module.Variables) + + // Check for explicitly-defined (-var and -var-file) variables, which the + // Terraform Cloud currently does not support. All other source types are okay, + // because they are implicit from the execution context anyway and so + // their final values will come from the _remote_ execution context. + for _, v := range variables { + switch v.SourceType { + case terraform.ValueFromCLIArg, terraform.ValueFromNamedFile: + return true + } + } + + return false +} + +func (b *Cloud) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Operation, r *tfe.Run) error { + if r.CostEstimate == nil { + return nil + } + + msgPrefix := "Cost estimation" + started := time.Now() + updated := started + for i := 0; ; i++ { + select { + case <-stopCtx.Done(): + return stopCtx.Err() + case <-cancelCtx.Done(): + return cancelCtx.Err() + case <-time.After(backoff(backoffMin, backoffMax, i)): + } + + // Retrieve the cost estimate to get its current status. + ce, err := b.client.CostEstimates.Read(stopCtx, r.CostEstimate.ID) + if err != nil { + return generalError("Failed to retrieve cost estimate", err) + } + + // If the run is canceled or errored, but the cost-estimate still has + // no result, there is nothing further to render. + if ce.Status != tfe.CostEstimateFinished { + if r.Status == tfe.RunCanceled || r.Status == tfe.RunErrored { + return nil + } + } + + // checking if i == 0 so as to avoid printing this starting horizontal-rule + // every retry, and that it only prints it on the first (i=0) attempt. + if b.CLI != nil && i == 0 { + b.CLI.Output("\n------------------------------------------------------------------------\n") + } + + switch ce.Status { + case tfe.CostEstimateFinished: + delta, err := strconv.ParseFloat(ce.DeltaMonthlyCost, 64) + if err != nil { + return generalError("Unexpected error", err) + } + + sign := "+" + if delta < 0 { + sign = "-" + } + + deltaRepr := strings.Replace(ce.DeltaMonthlyCost, "-", "", 1) + + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color(fmt.Sprintf("Resources: %d of %d estimated", ce.MatchedResourcesCount, ce.ResourcesCount))) + b.CLI.Output(b.Colorize().Color(fmt.Sprintf(" $%s/mo %s$%s", ce.ProposedMonthlyCost, sign, deltaRepr))) + + if len(r.PolicyChecks) == 0 && r.HasChanges && op.Type == backend.OperationTypeApply { + b.CLI.Output("\n------------------------------------------------------------------------") + } + } + + return nil + case tfe.CostEstimatePending, tfe.CostEstimateQueued: + // Check if 30 seconds have passed since the last update. + current := time.Now() + if b.CLI != nil && (i == 0 || current.Sub(updated).Seconds() > 30) { + updated = current + elapsed := "" + + // Calculate and set the elapsed time. + if i > 0 { + elapsed = fmt.Sprintf( + " (%s elapsed)", current.Sub(started).Truncate(30*time.Second)) + } + b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color("Waiting for cost estimate to complete..." + elapsed + "\n")) + } + continue + case tfe.CostEstimateSkippedDueToTargeting: + b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output("Not available for this plan, because it was created with the -target option.") + b.CLI.Output("\n------------------------------------------------------------------------") + return nil + case tfe.CostEstimateErrored: + b.CLI.Output(msgPrefix + " errored.\n") + b.CLI.Output("\n------------------------------------------------------------------------") + return nil + case tfe.CostEstimateCanceled: + return fmt.Errorf(msgPrefix + " canceled.") + default: + return fmt.Errorf("Unknown or unexpected cost estimate state: %s", ce.Status) + } + } +} + +func (b *Cloud) checkPolicy(stopCtx, cancelCtx context.Context, op *backend.Operation, r *tfe.Run) error { + if b.CLI != nil { + b.CLI.Output("\n------------------------------------------------------------------------\n") + } + for i, pc := range r.PolicyChecks { + // Read the policy check logs. This is a blocking call that will only + // return once the policy check is complete. + logs, err := b.client.PolicyChecks.Logs(stopCtx, pc.ID) + if err != nil { + return generalError("Failed to retrieve policy check logs", err) + } + reader := bufio.NewReaderSize(logs, 64*1024) + + // Retrieve the policy check to get its current status. + pc, err := b.client.PolicyChecks.Read(stopCtx, pc.ID) + if err != nil { + return generalError("Failed to retrieve policy check", err) + } + + // If the run is canceled or errored, but the policy check still has + // no result, there is nothing further to render. + if r.Status == tfe.RunCanceled || r.Status == tfe.RunErrored { + switch pc.Status { + case tfe.PolicyPending, tfe.PolicyQueued, tfe.PolicyUnreachable: + continue + } + } + + var msgPrefix string + switch pc.Scope { + case tfe.PolicyScopeOrganization: + msgPrefix = "Organization policy check" + case tfe.PolicyScopeWorkspace: + msgPrefix = "Workspace policy check" + default: + msgPrefix = fmt.Sprintf("Unknown policy check (%s)", pc.Scope) + } + + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + } + + if b.CLI != nil { + for next := true; next; { + var l, line []byte + + for isPrefix := true; isPrefix; { + l, isPrefix, err = reader.ReadLine() + if err != nil { + if err != io.EOF { + return generalError("Failed to read logs", err) + } + next = false + } + line = append(line, l...) + } + + if next || len(line) > 0 { + b.CLI.Output(b.Colorize().Color(string(line))) + } + } + } + + switch pc.Status { + case tfe.PolicyPasses: + if (r.HasChanges && op.Type == backend.OperationTypeApply || i < len(r.PolicyChecks)-1) && b.CLI != nil { + b.CLI.Output("\n------------------------------------------------------------------------") + } + continue + case tfe.PolicyErrored: + return fmt.Errorf(msgPrefix + " errored.") + case tfe.PolicyHardFailed: + return fmt.Errorf(msgPrefix + " hard failed.") + case tfe.PolicySoftFailed: + runUrl := fmt.Sprintf(runHeader, b.hostname, b.organization, op.Workspace, r.ID) + + if op.Type == backend.OperationTypePlan || op.UIOut == nil || op.UIIn == nil || + !pc.Actions.IsOverridable || !pc.Permissions.CanOverride { + return fmt.Errorf(msgPrefix + " soft failed.\n" + runUrl) + } + + if op.AutoApprove { + if _, err = b.client.PolicyChecks.Override(stopCtx, pc.ID); err != nil { + return generalError(fmt.Sprintf("Failed to override policy check.\n%s", runUrl), err) + } + } else { + opts := &terraform.InputOpts{ + Id: "override", + Query: "\nDo you want to override the soft failed policy check?", + Description: "Only 'override' will be accepted to override.", + } + err = b.confirm(stopCtx, op, opts, r, "override") + if err != nil && err != errRunOverridden { + return fmt.Errorf( + fmt.Sprintf("Failed to override: %s\n%s\n", err.Error(), runUrl), + ) + } + + if err != errRunOverridden { + if _, err = b.client.PolicyChecks.Override(stopCtx, pc.ID); err != nil { + return generalError(fmt.Sprintf("Failed to override policy check.\n%s", runUrl), err) + } + } else { + b.CLI.Output(fmt.Sprintf("The run needs to be manually overridden or discarded.\n%s\n", runUrl)) + } + } + + if b.CLI != nil { + b.CLI.Output("------------------------------------------------------------------------") + } + default: + return fmt.Errorf("Unknown or unexpected policy state: %s", pc.Status) + } + } + + return nil +} + +func (b *Cloud) confirm(stopCtx context.Context, op *backend.Operation, opts *terraform.InputOpts, r *tfe.Run, keyword string) error { + doneCtx, cancel := context.WithCancel(stopCtx) + result := make(chan error, 2) + + go func() { + // Make sure we cancel doneCtx before we return + // so the input command is also canceled. + defer cancel() + + for { + select { + case <-doneCtx.Done(): + return + case <-stopCtx.Done(): + return + case <-time.After(runPollInterval): + // Retrieve the run again to get its current status. + r, err := b.client.Runs.Read(stopCtx, r.ID) + if err != nil { + result <- generalError("Failed to retrieve run", err) + return + } + + switch keyword { + case "override": + if r.Status != tfe.RunPolicyOverride { + if r.Status == tfe.RunDiscarded { + err = errRunDiscarded + } else { + err = errRunOverridden + } + } + case "yes": + if !r.Actions.IsConfirmable { + if r.Status == tfe.RunDiscarded { + err = errRunDiscarded + } else { + err = errRunApproved + } + } + } + + if err != nil { + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color( + fmt.Sprintf("[reset][yellow]%s[reset]", err.Error()))) + } + + if err == errRunDiscarded { + err = errApplyDiscarded + if op.PlanMode == plans.DestroyMode { + err = errDestroyDiscarded + } + } + + result <- err + return + } + } + } + }() + + result <- func() error { + v, err := op.UIIn.Input(doneCtx, opts) + if err != nil && err != context.Canceled && stopCtx.Err() != context.Canceled { + return fmt.Errorf("Error asking %s: %v", opts.Id, err) + } + + // We return the error of our parent channel as we don't + // care about the error of the doneCtx which is only used + // within this function. So if the doneCtx was canceled + // because stopCtx was canceled, this will properly return + // a context.Canceled error and otherwise it returns nil. + if doneCtx.Err() == context.Canceled || stopCtx.Err() == context.Canceled { + return stopCtx.Err() + } + + // Make sure we cancel the context here so the loop that + // checks for external changes to the run is ended before + // we start to make changes ourselves. + cancel() + + if v != keyword { + // Retrieve the run again to get its current status. + r, err = b.client.Runs.Read(stopCtx, r.ID) + if err != nil { + return generalError("Failed to retrieve run", err) + } + + // Make sure we discard the run if possible. + if r.Actions.IsDiscardable { + err = b.client.Runs.Discard(stopCtx, r.ID, tfe.RunDiscardOptions{}) + if err != nil { + if op.PlanMode == plans.DestroyMode { + return generalError("Failed to discard destroy", err) + } + return generalError("Failed to discard apply", err) + } + } + + // Even if the run was discarded successfully, we still + // return an error as the apply command was canceled. + if op.PlanMode == plans.DestroyMode { + return errDestroyDiscarded + } + return errApplyDiscarded + } + + return nil + }() + + return <-result +} diff --git a/internal/cloud/backend_context.go b/internal/cloud/backend_context.go new file mode 100644 index 000000000000..55f9aba54075 --- /dev/null +++ b/internal/cloud/backend_context.go @@ -0,0 +1,280 @@ +package cloud + +import ( + "context" + "fmt" + "log" + "strings" + + "github.com/hashicorp/errwrap" + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/hcl/v2" + "github.com/hashicorp/hcl/v2/hclsyntax" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/zclconf/go-cty/cty" +) + +// Context implements backend.Enhanced. +func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Full, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + op.StateLocker = op.StateLocker.WithContext(context.Background()) + + // Get the remote workspace name. + remoteWorkspaceName := b.getRemoteWorkspaceName(op.Workspace) + + // Get the latest state. + log.Printf("[TRACE] cloud: requesting state manager for workspace %q", remoteWorkspaceName) + stateMgr, err := b.StateMgr(op.Workspace) + if err != nil { + diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + return nil, nil, diags + } + + log.Printf("[TRACE] cloud: requesting state lock for workspace %q", remoteWorkspaceName) + if diags := op.StateLocker.Lock(stateMgr, op.Type.String()); diags.HasErrors() { + return nil, nil, diags + } + + defer func() { + // If we're returning with errors, and thus not producing a valid + // context, we'll want to avoid leaving the remote workspace locked. + if diags.HasErrors() { + diags = diags.Append(op.StateLocker.Unlock()) + } + }() + + log.Printf("[TRACE] cloud: reading remote state for workspace %q", remoteWorkspaceName) + if err := stateMgr.RefreshState(); err != nil { + diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + return nil, nil, diags + } + + // Initialize our context options + var opts terraform.ContextOpts + if v := b.ContextOpts; v != nil { + opts = *v + } + + // Copy set options from the operation + opts.PlanMode = op.PlanMode + opts.Targets = op.Targets + opts.UIInput = op.UIIn + + // Load the latest state. If we enter contextFromPlanFile below then the + // state snapshot in the plan file must match this, or else it'll return + // error diagnostics. + log.Printf("[TRACE] cloud: retrieving remote state snapshot for workspace %q", remoteWorkspaceName) + opts.State = stateMgr.State() + + log.Printf("[TRACE] cloud: loading configuration for the current working directory") + config, configDiags := op.ConfigLoader.LoadConfig(op.ConfigDir) + diags = diags.Append(configDiags) + if configDiags.HasErrors() { + return nil, nil, diags + } + opts.Config = config + + // The underlying API expects us to use the opaque workspace id to request + // variables, so we'll need to look that up using our organization name + // and workspace name. + remoteWorkspaceID, err := b.getRemoteWorkspaceID(context.Background(), op.Workspace) + if err != nil { + diags = diags.Append(errwrap.Wrapf("Error finding remote workspace: {{err}}", err)) + return nil, nil, diags + } + + log.Printf("[TRACE] cloud: retrieving variables from workspace %s/%s (%s)", remoteWorkspaceName, b.organization, remoteWorkspaceID) + tfeVariables, err := b.client.Variables.List(context.Background(), remoteWorkspaceID, tfe.VariableListOptions{}) + if err != nil && err != tfe.ErrResourceNotFound { + diags = diags.Append(errwrap.Wrapf("Error loading variables: {{err}}", err)) + return nil, nil, diags + } + + if op.AllowUnsetVariables { + // If we're not going to use the variables in an operation we'll be + // more lax about them, stubbing out any unset ones as unknown. + // This gives us enough information to produce a consistent context, + // but not enough information to run a real operation (plan, apply, etc) + opts.Variables = stubAllVariables(op.Variables, config.Module.Variables) + } else { + if tfeVariables != nil { + if op.Variables == nil { + op.Variables = make(map[string]backend.UnparsedVariableValue) + } + for _, v := range tfeVariables.Items { + if v.Category == tfe.CategoryTerraform { + op.Variables[v.Key] = &remoteStoredVariableValue{ + definition: v, + } + } + } + } + + if op.Variables != nil { + variables, varDiags := backend.ParseVariableValues(op.Variables, config.Module.Variables) + diags = diags.Append(varDiags) + if diags.HasErrors() { + return nil, nil, diags + } + opts.Variables = variables + } + } + + tfCtx, ctxDiags := terraform.NewContext(&opts) + diags = diags.Append(ctxDiags) + + log.Printf("[TRACE] cloud: finished building terraform.Context") + + return tfCtx, stateMgr, diags +} + +func (b *Cloud) getRemoteWorkspaceName(localWorkspaceName string) string { + switch { + case localWorkspaceName == backend.DefaultStateName: + // The default workspace name is a special case, for when the backend + // is configured to with to an exact remote workspace rather than with + // a remote workspace _prefix_. + return b.workspace + case b.prefix != "" && !strings.HasPrefix(localWorkspaceName, b.prefix): + return b.prefix + localWorkspaceName + default: + return localWorkspaceName + } +} + +func (b *Cloud) getRemoteWorkspace(ctx context.Context, localWorkspaceName string) (*tfe.Workspace, error) { + remoteWorkspaceName := b.getRemoteWorkspaceName(localWorkspaceName) + + log.Printf("[TRACE] cloud: looking up workspace for %s/%s", b.organization, remoteWorkspaceName) + remoteWorkspace, err := b.client.Workspaces.Read(ctx, b.organization, remoteWorkspaceName) + if err != nil { + return nil, err + } + + return remoteWorkspace, nil +} + +func (b *Cloud) getRemoteWorkspaceID(ctx context.Context, localWorkspaceName string) (string, error) { + remoteWorkspace, err := b.getRemoteWorkspace(ctx, localWorkspaceName) + if err != nil { + return "", err + } + + return remoteWorkspace.ID, nil +} + +func stubAllVariables(vv map[string]backend.UnparsedVariableValue, decls map[string]*configs.Variable) terraform.InputValues { + ret := make(terraform.InputValues, len(decls)) + + for name, cfg := range decls { + raw, exists := vv[name] + if !exists { + ret[name] = &terraform.InputValue{ + Value: cty.UnknownVal(cfg.Type), + SourceType: terraform.ValueFromConfig, + } + continue + } + + val, diags := raw.ParseVariableValue(cfg.ParsingMode) + if diags.HasErrors() { + ret[name] = &terraform.InputValue{ + Value: cty.UnknownVal(cfg.Type), + SourceType: terraform.ValueFromConfig, + } + continue + } + ret[name] = val + } + + return ret +} + +// remoteStoredVariableValue is a backend.UnparsedVariableValue implementation +// that translates from the go-tfe representation of stored variables into +// the Terraform Core backend representation of variables. +type remoteStoredVariableValue struct { + definition *tfe.Variable +} + +var _ backend.UnparsedVariableValue = (*remoteStoredVariableValue)(nil) + +func (v *remoteStoredVariableValue) ParseVariableValue(mode configs.VariableParsingMode) (*terraform.InputValue, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + var val cty.Value + + switch { + case v.definition.Sensitive: + // If it's marked as sensitive then it's not available for use in + // local operations. We'll use an unknown value as a placeholder for + // it so that operations that don't need it might still work, but + // we'll also produce a warning about it to add context for any + // errors that might result here. + val = cty.DynamicVal + if !v.definition.HCL { + // If it's not marked as HCL then we at least know that the + // value must be a string, so we'll set that in case it allows + // us to do some more precise type checking. + val = cty.UnknownVal(cty.String) + } + + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Warning, + fmt.Sprintf("Value for var.%s unavailable", v.definition.Key), + fmt.Sprintf("The value of variable %q is marked as sensitive in the remote workspace. This operation always runs locally, so the value for that variable is not available.", v.definition.Key), + )) + + case v.definition.HCL: + // If the variable value is marked as being in HCL syntax, we need to + // parse it the same way as it would be interpreted in a .tfvars + // file because that is how it would get passed to Terraform CLI for + // a remote operation and we want to mimic that result as closely as + // possible. + var exprDiags hcl.Diagnostics + expr, exprDiags := hclsyntax.ParseExpression([]byte(v.definition.Value), "", hcl.Pos{Line: 1, Column: 1}) + if expr != nil { + var moreDiags hcl.Diagnostics + val, moreDiags = expr.Value(nil) + exprDiags = append(exprDiags, moreDiags...) + } else { + // We'll have already put some errors in exprDiags above, so we'll + // just stub out the value here. + val = cty.DynamicVal + } + + // We don't have sufficient context to return decent error messages + // for syntax errors in the remote values, so we'll just return a + // generic message instead for now. + // (More complete error messages will still result from true remote + // operations, because they'll run on the remote system where we've + // materialized the values into a tfvars file we can report from.) + if exprDiags.HasErrors() { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + fmt.Sprintf("Invalid expression for var.%s", v.definition.Key), + fmt.Sprintf("The value of variable %q is marked in the remote workspace as being specified in HCL syntax, but the given value is not valid HCL. Stored variable values must be valid literal expressions and may not contain references to other variables or calls to functions.", v.definition.Key), + )) + } + + default: + // A variable value _not_ marked as HCL is always be a string, given + // literally. + val = cty.StringVal(v.definition.Value) + } + + return &terraform.InputValue{ + Value: val, + + // We mark these as "from input" with the rationale that entering + // variable values into the Terraform Cloud or Enterprise UI is, + // roughly speaking, a similar idea to entering variable values at + // the interactive CLI prompts. It's not a perfect correspondance, + // but it's closer than the other options. + SourceType: terraform.ValueFromInput, + }, diags +} diff --git a/internal/cloud/backend_context_test.go b/internal/cloud/backend_context_test.go new file mode 100644 index 000000000000..264d10a71c4c --- /dev/null +++ b/internal/cloud/backend_context_test.go @@ -0,0 +1,235 @@ +package cloud + +import ( + "context" + "testing" + + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/command/arguments" + "github.com/hashicorp/terraform/internal/command/clistate" + "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/initwd" + "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terminal" + "github.com/zclconf/go-cty/cty" +) + +func TestRemoteStoredVariableValue(t *testing.T) { + tests := map[string]struct { + Def *tfe.Variable + Want cty.Value + WantError string + }{ + "string literal": { + &tfe.Variable{ + Key: "test", + Value: "foo", + HCL: false, + Sensitive: false, + }, + cty.StringVal("foo"), + ``, + }, + "string HCL": { + &tfe.Variable{ + Key: "test", + Value: `"foo"`, + HCL: true, + Sensitive: false, + }, + cty.StringVal("foo"), + ``, + }, + "list HCL": { + &tfe.Variable{ + Key: "test", + Value: `[]`, + HCL: true, + Sensitive: false, + }, + cty.EmptyTupleVal, + ``, + }, + "null HCL": { + &tfe.Variable{ + Key: "test", + Value: `null`, + HCL: true, + Sensitive: false, + }, + cty.NullVal(cty.DynamicPseudoType), + ``, + }, + "literal sensitive": { + &tfe.Variable{ + Key: "test", + HCL: false, + Sensitive: true, + }, + cty.UnknownVal(cty.String), + ``, + }, + "HCL sensitive": { + &tfe.Variable{ + Key: "test", + HCL: true, + Sensitive: true, + }, + cty.DynamicVal, + ``, + }, + "HCL computation": { + // This (stored expressions containing computation) is not a case + // we intentionally supported, but it became possible for remote + // operations in Terraform 0.12 (due to Terraform Cloud/Enterprise + // just writing the HCL verbatim into generated `.tfvars` files). + // We support it here for consistency, and we continue to support + // it in both places for backward-compatibility. In practice, + // there's little reason to do computation in a stored variable + // value because references are not supported. + &tfe.Variable{ + Key: "test", + Value: `[for v in ["a"] : v]`, + HCL: true, + Sensitive: false, + }, + cty.TupleVal([]cty.Value{cty.StringVal("a")}), + ``, + }, + "HCL syntax error": { + &tfe.Variable{ + Key: "test", + Value: `[`, + HCL: true, + Sensitive: false, + }, + cty.DynamicVal, + `Invalid expression for var.test: The value of variable "test" is marked in the remote workspace as being specified in HCL syntax, but the given value is not valid HCL. Stored variable values must be valid literal expressions and may not contain references to other variables or calls to functions.`, + }, + "HCL with references": { + &tfe.Variable{ + Key: "test", + Value: `foo.bar`, + HCL: true, + Sensitive: false, + }, + cty.DynamicVal, + `Invalid expression for var.test: The value of variable "test" is marked in the remote workspace as being specified in HCL syntax, but the given value is not valid HCL. Stored variable values must be valid literal expressions and may not contain references to other variables or calls to functions.`, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + v := &remoteStoredVariableValue{ + definition: test.Def, + } + // This ParseVariableValue implementation ignores the parsing mode, + // so we'll just always parse literal here. (The parsing mode is + // selected by the remote server, not by our local configuration.) + gotIV, diags := v.ParseVariableValue(configs.VariableParseLiteral) + if test.WantError != "" { + if !diags.HasErrors() { + t.Fatalf("missing expected error\ngot: \nwant: %s", test.WantError) + } + errStr := diags.Err().Error() + if errStr != test.WantError { + t.Fatalf("wrong error\ngot: %s\nwant: %s", errStr, test.WantError) + } + } else { + if diags.HasErrors() { + t.Fatalf("unexpected error\ngot: %s\nwant: ", diags.Err().Error()) + } + got := gotIV.Value + if !test.Want.RawEquals(got) { + t.Errorf("wrong result\ngot: %#v\nwant: %#v", got, test.Want) + } + } + }) + } +} + +func TestRemoteContextWithVars(t *testing.T) { + catTerraform := tfe.CategoryTerraform + catEnv := tfe.CategoryEnv + + tests := map[string]struct { + Opts *tfe.VariableCreateOptions + WantError string + }{ + "Terraform variable": { + &tfe.VariableCreateOptions{ + Category: &catTerraform, + }, + `Value for undeclared variable: A variable named "key" was assigned a value, but the root module does not declare a variable of that name. To use this value, add a "variable" block to the configuration.`, + }, + "environment variable": { + &tfe.VariableCreateOptions{ + Category: &catEnv, + }, + ``, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + configDir := "./testdata/empty" + + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) + defer configCleanup() + + workspaceID, err := b.getRemoteWorkspaceID(context.Background(), backend.DefaultStateName) + if err != nil { + t.Fatal(err) + } + + streams, _ := terminal.StreamsForTesting(t) + view := views.NewStateLocker(arguments.ViewHuman, views.NewView(streams)) + + op := &backend.Operation{ + ConfigDir: configDir, + ConfigLoader: configLoader, + StateLocker: clistate.NewLocker(0, view), + Workspace: backend.DefaultStateName, + } + + v := test.Opts + if v.Key == nil { + key := "key" + v.Key = &key + } + b.client.Variables.Create(context.TODO(), workspaceID, *v) + + _, _, diags := b.Context(op) + + if test.WantError != "" { + if !diags.HasErrors() { + t.Fatalf("missing expected error\ngot: \nwant: %s", test.WantError) + } + errStr := diags.Err().Error() + if errStr != test.WantError { + t.Fatalf("wrong error\ngot: %s\nwant: %s", errStr, test.WantError) + } + // When Context() returns an error, it should unlock the state, + // so re-locking it is expected to succeed. + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state: %s", err.Error()) + } + } else { + if diags.HasErrors() { + t.Fatalf("unexpected error\ngot: %s\nwant: ", diags.Err().Error()) + } + // When Context() succeeds, this should fail w/ "workspace already locked" + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err == nil { + t.Fatal("unexpected success locking state after Context") + } + } + }) + } +} diff --git a/internal/cloud/backend_mock.go b/internal/cloud/backend_mock.go new file mode 100644 index 000000000000..0ee036bc56e5 --- /dev/null +++ b/internal/cloud/backend_mock.go @@ -0,0 +1,1364 @@ +package cloud + +import ( + "bytes" + "context" + "encoding/base64" + "errors" + "fmt" + "io" + "io/ioutil" + "math/rand" + "os" + "path/filepath" + "strings" + "sync" + "time" + + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/terraform" + tfversion "github.com/hashicorp/terraform/version" + "github.com/mitchellh/copystructure" +) + +type mockClient struct { + Applies *mockApplies + ConfigurationVersions *mockConfigurationVersions + CostEstimates *mockCostEstimates + Organizations *mockOrganizations + Plans *mockPlans + PolicyChecks *mockPolicyChecks + Runs *mockRuns + StateVersions *mockStateVersions + Variables *mockVariables + Workspaces *mockWorkspaces +} + +func newMockClient() *mockClient { + c := &mockClient{} + c.Applies = newMockApplies(c) + c.ConfigurationVersions = newMockConfigurationVersions(c) + c.CostEstimates = newMockCostEstimates(c) + c.Organizations = newMockOrganizations(c) + c.Plans = newMockPlans(c) + c.PolicyChecks = newMockPolicyChecks(c) + c.Runs = newMockRuns(c) + c.StateVersions = newMockStateVersions(c) + c.Variables = newMockVariables(c) + c.Workspaces = newMockWorkspaces(c) + return c +} + +type mockApplies struct { + client *mockClient + applies map[string]*tfe.Apply + logs map[string]string +} + +func newMockApplies(client *mockClient) *mockApplies { + return &mockApplies{ + client: client, + applies: make(map[string]*tfe.Apply), + logs: make(map[string]string), + } +} + +// create is a helper function to create a mock apply that uses the configured +// working directory to find the logfile. +func (m *mockApplies) create(cvID, workspaceID string) (*tfe.Apply, error) { + c, ok := m.client.ConfigurationVersions.configVersions[cvID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + if c.Speculative { + // Speculative means its plan-only so we don't create a Apply. + return nil, nil + } + + id := generateID("apply-") + url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) + + a := &tfe.Apply{ + ID: id, + LogReadURL: url, + Status: tfe.ApplyPending, + } + + w, ok := m.client.Workspaces.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if w.AutoApply { + a.Status = tfe.ApplyRunning + } + + m.logs[url] = filepath.Join( + m.client.ConfigurationVersions.uploadPaths[cvID], + w.WorkingDirectory, + "apply.log", + ) + m.applies[a.ID] = a + + return a, nil +} + +func (m *mockApplies) Read(ctx context.Context, applyID string) (*tfe.Apply, error) { + a, ok := m.applies[applyID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + // Together with the mockLogReader this allows testing queued runs. + if a.Status == tfe.ApplyRunning { + a.Status = tfe.ApplyFinished + } + return a, nil +} + +func (m *mockApplies) Logs(ctx context.Context, applyID string) (io.Reader, error) { + a, err := m.Read(ctx, applyID) + if err != nil { + return nil, err + } + + logfile, ok := m.logs[a.LogReadURL] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return bytes.NewBufferString("logfile does not exist"), nil + } + + logs, err := ioutil.ReadFile(logfile) + if err != nil { + return nil, err + } + + done := func() (bool, error) { + a, err := m.Read(ctx, applyID) + if err != nil { + return false, err + } + if a.Status != tfe.ApplyFinished { + return false, nil + } + return true, nil + } + + return &mockLogReader{ + done: done, + logs: bytes.NewBuffer(logs), + }, nil +} + +type mockConfigurationVersions struct { + client *mockClient + configVersions map[string]*tfe.ConfigurationVersion + uploadPaths map[string]string + uploadURLs map[string]*tfe.ConfigurationVersion +} + +func newMockConfigurationVersions(client *mockClient) *mockConfigurationVersions { + return &mockConfigurationVersions{ + client: client, + configVersions: make(map[string]*tfe.ConfigurationVersion), + uploadPaths: make(map[string]string), + uploadURLs: make(map[string]*tfe.ConfigurationVersion), + } +} + +func (m *mockConfigurationVersions) List(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionListOptions) (*tfe.ConfigurationVersionList, error) { + cvl := &tfe.ConfigurationVersionList{} + for _, cv := range m.configVersions { + cvl.Items = append(cvl.Items, cv) + } + + cvl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 1, + PreviousPage: 1, + TotalPages: 1, + TotalCount: len(cvl.Items), + } + + return cvl, nil +} + +func (m *mockConfigurationVersions) Create(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionCreateOptions) (*tfe.ConfigurationVersion, error) { + id := generateID("cv-") + url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) + + cv := &tfe.ConfigurationVersion{ + ID: id, + Status: tfe.ConfigurationPending, + UploadURL: url, + } + + m.configVersions[cv.ID] = cv + m.uploadURLs[url] = cv + + return cv, nil +} + +func (m *mockConfigurationVersions) Read(ctx context.Context, cvID string) (*tfe.ConfigurationVersion, error) { + cv, ok := m.configVersions[cvID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return cv, nil +} + +func (m *mockConfigurationVersions) Upload(ctx context.Context, url, path string) error { + cv, ok := m.uploadURLs[url] + if !ok { + return errors.New("404 not found") + } + m.uploadPaths[cv.ID] = path + cv.Status = tfe.ConfigurationUploaded + return nil +} + +type mockCostEstimates struct { + client *mockClient + estimations map[string]*tfe.CostEstimate + logs map[string]string +} + +func newMockCostEstimates(client *mockClient) *mockCostEstimates { + return &mockCostEstimates{ + client: client, + estimations: make(map[string]*tfe.CostEstimate), + logs: make(map[string]string), + } +} + +// create is a helper function to create a mock cost estimation that uses the +// configured working directory to find the logfile. +func (m *mockCostEstimates) create(cvID, workspaceID string) (*tfe.CostEstimate, error) { + id := generateID("ce-") + + ce := &tfe.CostEstimate{ + ID: id, + MatchedResourcesCount: 1, + ResourcesCount: 1, + DeltaMonthlyCost: "0.00", + ProposedMonthlyCost: "0.00", + Status: tfe.CostEstimateFinished, + } + + w, ok := m.client.Workspaces.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + logfile := filepath.Join( + m.client.ConfigurationVersions.uploadPaths[cvID], + w.WorkingDirectory, + "cost-estimate.log", + ) + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return nil, nil + } + + m.logs[ce.ID] = logfile + m.estimations[ce.ID] = ce + + return ce, nil +} + +func (m *mockCostEstimates) Read(ctx context.Context, costEstimateID string) (*tfe.CostEstimate, error) { + ce, ok := m.estimations[costEstimateID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return ce, nil +} + +func (m *mockCostEstimates) Logs(ctx context.Context, costEstimateID string) (io.Reader, error) { + ce, ok := m.estimations[costEstimateID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + logfile, ok := m.logs[ce.ID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return bytes.NewBufferString("logfile does not exist"), nil + } + + logs, err := ioutil.ReadFile(logfile) + if err != nil { + return nil, err + } + + ce.Status = tfe.CostEstimateFinished + + return bytes.NewBuffer(logs), nil +} + +// mockInput is a mock implementation of terraform.UIInput. +type mockInput struct { + answers map[string]string +} + +func (m *mockInput) Input(ctx context.Context, opts *terraform.InputOpts) (string, error) { + v, ok := m.answers[opts.Id] + if !ok { + return "", fmt.Errorf("unexpected input request in test: %s", opts.Id) + } + if v == "wait-for-external-update" { + select { + case <-ctx.Done(): + case <-time.After(time.Minute): + } + } + delete(m.answers, opts.Id) + return v, nil +} + +type mockOrganizations struct { + client *mockClient + organizations map[string]*tfe.Organization +} + +func newMockOrganizations(client *mockClient) *mockOrganizations { + return &mockOrganizations{ + client: client, + organizations: make(map[string]*tfe.Organization), + } +} + +func (m *mockOrganizations) List(ctx context.Context, options tfe.OrganizationListOptions) (*tfe.OrganizationList, error) { + orgl := &tfe.OrganizationList{} + for _, org := range m.organizations { + orgl.Items = append(orgl.Items, org) + } + + orgl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 1, + PreviousPage: 1, + TotalPages: 1, + TotalCount: len(orgl.Items), + } + + return orgl, nil +} + +// mockLogReader is a mock logreader that enables testing queued runs. +type mockLogReader struct { + done func() (bool, error) + logs *bytes.Buffer +} + +func (m *mockLogReader) Read(l []byte) (int, error) { + for { + if written, err := m.read(l); err != io.ErrNoProgress { + return written, err + } + time.Sleep(1 * time.Millisecond) + } +} + +func (m *mockLogReader) read(l []byte) (int, error) { + done, err := m.done() + if err != nil { + return 0, err + } + if !done { + return 0, io.ErrNoProgress + } + return m.logs.Read(l) +} + +func (m *mockOrganizations) Create(ctx context.Context, options tfe.OrganizationCreateOptions) (*tfe.Organization, error) { + org := &tfe.Organization{Name: *options.Name} + m.organizations[org.Name] = org + return org, nil +} + +func (m *mockOrganizations) Read(ctx context.Context, name string) (*tfe.Organization, error) { + org, ok := m.organizations[name] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return org, nil +} + +func (m *mockOrganizations) Update(ctx context.Context, name string, options tfe.OrganizationUpdateOptions) (*tfe.Organization, error) { + org, ok := m.organizations[name] + if !ok { + return nil, tfe.ErrResourceNotFound + } + org.Name = *options.Name + return org, nil + +} + +func (m *mockOrganizations) Delete(ctx context.Context, name string) error { + delete(m.organizations, name) + return nil +} + +func (m *mockOrganizations) Capacity(ctx context.Context, name string) (*tfe.Capacity, error) { + var pending, running int + for _, r := range m.client.Runs.runs { + if r.Status == tfe.RunPending { + pending++ + continue + } + running++ + } + return &tfe.Capacity{Pending: pending, Running: running}, nil +} + +func (m *mockOrganizations) Entitlements(ctx context.Context, name string) (*tfe.Entitlements, error) { + return &tfe.Entitlements{ + Operations: true, + PrivateModuleRegistry: true, + Sentinel: true, + StateStorage: true, + Teams: true, + VCSIntegrations: true, + }, nil +} + +func (m *mockOrganizations) RunQueue(ctx context.Context, name string, options tfe.RunQueueOptions) (*tfe.RunQueue, error) { + rq := &tfe.RunQueue{} + + for _, r := range m.client.Runs.runs { + rq.Items = append(rq.Items, r) + } + + rq.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 1, + PreviousPage: 1, + TotalPages: 1, + TotalCount: len(rq.Items), + } + + return rq, nil +} + +type mockPlans struct { + client *mockClient + logs map[string]string + planOutputs map[string]string + plans map[string]*tfe.Plan +} + +func newMockPlans(client *mockClient) *mockPlans { + return &mockPlans{ + client: client, + logs: make(map[string]string), + planOutputs: make(map[string]string), + plans: make(map[string]*tfe.Plan), + } +} + +// create is a helper function to create a mock plan that uses the configured +// working directory to find the logfile. +func (m *mockPlans) create(cvID, workspaceID string) (*tfe.Plan, error) { + id := generateID("plan-") + url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) + + p := &tfe.Plan{ + ID: id, + LogReadURL: url, + Status: tfe.PlanPending, + } + + w, ok := m.client.Workspaces.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + m.logs[url] = filepath.Join( + m.client.ConfigurationVersions.uploadPaths[cvID], + w.WorkingDirectory, + "plan.log", + ) + m.plans[p.ID] = p + + return p, nil +} + +func (m *mockPlans) Read(ctx context.Context, planID string) (*tfe.Plan, error) { + p, ok := m.plans[planID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + // Together with the mockLogReader this allows testing queued runs. + if p.Status == tfe.PlanRunning { + p.Status = tfe.PlanFinished + } + return p, nil +} + +func (m *mockPlans) Logs(ctx context.Context, planID string) (io.Reader, error) { + p, err := m.Read(ctx, planID) + if err != nil { + return nil, err + } + + logfile, ok := m.logs[p.LogReadURL] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return bytes.NewBufferString("logfile does not exist"), nil + } + + logs, err := ioutil.ReadFile(logfile) + if err != nil { + return nil, err + } + + done := func() (bool, error) { + p, err := m.Read(ctx, planID) + if err != nil { + return false, err + } + if p.Status != tfe.PlanFinished { + return false, nil + } + return true, nil + } + + return &mockLogReader{ + done: done, + logs: bytes.NewBuffer(logs), + }, nil +} + +func (m *mockPlans) JSONOutput(ctx context.Context, planID string) ([]byte, error) { + planOutput, ok := m.planOutputs[planID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + return []byte(planOutput), nil +} + +type mockPolicyChecks struct { + client *mockClient + checks map[string]*tfe.PolicyCheck + logs map[string]string +} + +func newMockPolicyChecks(client *mockClient) *mockPolicyChecks { + return &mockPolicyChecks{ + client: client, + checks: make(map[string]*tfe.PolicyCheck), + logs: make(map[string]string), + } +} + +// create is a helper function to create a mock policy check that uses the +// configured working directory to find the logfile. +func (m *mockPolicyChecks) create(cvID, workspaceID string) (*tfe.PolicyCheck, error) { + id := generateID("pc-") + + pc := &tfe.PolicyCheck{ + ID: id, + Actions: &tfe.PolicyActions{}, + Permissions: &tfe.PolicyPermissions{}, + Scope: tfe.PolicyScopeOrganization, + Status: tfe.PolicyPending, + } + + w, ok := m.client.Workspaces.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + logfile := filepath.Join( + m.client.ConfigurationVersions.uploadPaths[cvID], + w.WorkingDirectory, + "policy.log", + ) + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return nil, nil + } + + m.logs[pc.ID] = logfile + m.checks[pc.ID] = pc + + return pc, nil +} + +func (m *mockPolicyChecks) List(ctx context.Context, runID string, options tfe.PolicyCheckListOptions) (*tfe.PolicyCheckList, error) { + _, ok := m.client.Runs.runs[runID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + pcl := &tfe.PolicyCheckList{} + for _, pc := range m.checks { + pcl.Items = append(pcl.Items, pc) + } + + pcl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 1, + PreviousPage: 1, + TotalPages: 1, + TotalCount: len(pcl.Items), + } + + return pcl, nil +} + +func (m *mockPolicyChecks) Read(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { + pc, ok := m.checks[policyCheckID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + logfile, ok := m.logs[pc.ID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return nil, fmt.Errorf("logfile does not exist") + } + + logs, err := ioutil.ReadFile(logfile) + if err != nil { + return nil, err + } + + switch { + case bytes.Contains(logs, []byte("Sentinel Result: true")): + pc.Status = tfe.PolicyPasses + case bytes.Contains(logs, []byte("Sentinel Result: false")): + switch { + case bytes.Contains(logs, []byte("hard-mandatory")): + pc.Status = tfe.PolicyHardFailed + case bytes.Contains(logs, []byte("soft-mandatory")): + pc.Actions.IsOverridable = true + pc.Permissions.CanOverride = true + pc.Status = tfe.PolicySoftFailed + } + default: + // As this is an unexpected state, we say the policy errored. + pc.Status = tfe.PolicyErrored + } + + return pc, nil +} + +func (m *mockPolicyChecks) Override(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { + pc, ok := m.checks[policyCheckID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + pc.Status = tfe.PolicyOverridden + return pc, nil +} + +func (m *mockPolicyChecks) Logs(ctx context.Context, policyCheckID string) (io.Reader, error) { + pc, ok := m.checks[policyCheckID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + logfile, ok := m.logs[pc.ID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if _, err := os.Stat(logfile); os.IsNotExist(err) { + return bytes.NewBufferString("logfile does not exist"), nil + } + + logs, err := ioutil.ReadFile(logfile) + if err != nil { + return nil, err + } + + switch { + case bytes.Contains(logs, []byte("Sentinel Result: true")): + pc.Status = tfe.PolicyPasses + case bytes.Contains(logs, []byte("Sentinel Result: false")): + switch { + case bytes.Contains(logs, []byte("hard-mandatory")): + pc.Status = tfe.PolicyHardFailed + case bytes.Contains(logs, []byte("soft-mandatory")): + pc.Actions.IsOverridable = true + pc.Permissions.CanOverride = true + pc.Status = tfe.PolicySoftFailed + } + default: + // As this is an unexpected state, we say the policy errored. + pc.Status = tfe.PolicyErrored + } + + return bytes.NewBuffer(logs), nil +} + +type mockRuns struct { + sync.Mutex + + client *mockClient + runs map[string]*tfe.Run + workspaces map[string][]*tfe.Run + + // If modifyNewRun is non-nil, the create method will call it just before + // saving a new run in the runs map, so that a calling test can mimic + // side-effects that a real server might apply in certain situations. + modifyNewRun func(client *mockClient, options tfe.RunCreateOptions, run *tfe.Run) +} + +func newMockRuns(client *mockClient) *mockRuns { + return &mockRuns{ + client: client, + runs: make(map[string]*tfe.Run), + workspaces: make(map[string][]*tfe.Run), + } +} + +func (m *mockRuns) List(ctx context.Context, workspaceID string, options tfe.RunListOptions) (*tfe.RunList, error) { + m.Lock() + defer m.Unlock() + + w, ok := m.client.Workspaces.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + rl := &tfe.RunList{} + for _, run := range m.workspaces[w.ID] { + rc, err := copystructure.Copy(run) + if err != nil { + panic(err) + } + rl.Items = append(rl.Items, rc.(*tfe.Run)) + } + + rl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 1, + PreviousPage: 1, + TotalPages: 1, + TotalCount: len(rl.Items), + } + + return rl, nil +} + +func (m *mockRuns) Create(ctx context.Context, options tfe.RunCreateOptions) (*tfe.Run, error) { + m.Lock() + defer m.Unlock() + + a, err := m.client.Applies.create(options.ConfigurationVersion.ID, options.Workspace.ID) + if err != nil { + return nil, err + } + + ce, err := m.client.CostEstimates.create(options.ConfigurationVersion.ID, options.Workspace.ID) + if err != nil { + return nil, err + } + + p, err := m.client.Plans.create(options.ConfigurationVersion.ID, options.Workspace.ID) + if err != nil { + return nil, err + } + + pc, err := m.client.PolicyChecks.create(options.ConfigurationVersion.ID, options.Workspace.ID) + if err != nil { + return nil, err + } + + r := &tfe.Run{ + ID: generateID("run-"), + Actions: &tfe.RunActions{IsCancelable: true}, + Apply: a, + CostEstimate: ce, + HasChanges: false, + Permissions: &tfe.RunPermissions{}, + Plan: p, + ReplaceAddrs: options.ReplaceAddrs, + Status: tfe.RunPending, + TargetAddrs: options.TargetAddrs, + } + + if options.Message != nil { + r.Message = *options.Message + } + + if pc != nil { + r.PolicyChecks = []*tfe.PolicyCheck{pc} + } + + if options.IsDestroy != nil { + r.IsDestroy = *options.IsDestroy + } + + if options.Refresh != nil { + r.Refresh = *options.Refresh + } + + if options.RefreshOnly != nil { + r.RefreshOnly = *options.RefreshOnly + } + + w, ok := m.client.Workspaces.workspaceIDs[options.Workspace.ID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + if w.CurrentRun == nil { + w.CurrentRun = r + } + + if m.modifyNewRun != nil { + // caller-provided callback may modify the run in-place to mimic + // side-effects that a real server might take in some situations. + m.modifyNewRun(m.client, options, r) + } + + m.runs[r.ID] = r + m.workspaces[options.Workspace.ID] = append(m.workspaces[options.Workspace.ID], r) + + return r, nil +} + +func (m *mockRuns) Read(ctx context.Context, runID string) (*tfe.Run, error) { + return m.ReadWithOptions(ctx, runID, nil) +} + +func (m *mockRuns) ReadWithOptions(ctx context.Context, runID string, _ *tfe.RunReadOptions) (*tfe.Run, error) { + m.Lock() + defer m.Unlock() + + r, ok := m.runs[runID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + pending := false + for _, r := range m.runs { + if r.ID != runID && r.Status == tfe.RunPending { + pending = true + break + } + } + + if !pending && r.Status == tfe.RunPending { + // Only update the status if there are no other pending runs. + r.Status = tfe.RunPlanning + r.Plan.Status = tfe.PlanRunning + } + + logs, _ := ioutil.ReadFile(m.client.Plans.logs[r.Plan.LogReadURL]) + if r.Status == tfe.RunPlanning && r.Plan.Status == tfe.PlanFinished { + if r.IsDestroy || bytes.Contains(logs, []byte("1 to add, 0 to change, 0 to destroy")) { + r.Actions.IsCancelable = false + r.Actions.IsConfirmable = true + r.HasChanges = true + r.Permissions.CanApply = true + } + + if bytes.Contains(logs, []byte("null_resource.foo: 1 error")) { + r.Actions.IsCancelable = false + r.HasChanges = false + r.Status = tfe.RunErrored + } + } + + // we must return a copy for the client + rc, err := copystructure.Copy(r) + if err != nil { + panic(err) + } + + return rc.(*tfe.Run), nil +} + +func (m *mockRuns) Apply(ctx context.Context, runID string, options tfe.RunApplyOptions) error { + m.Lock() + defer m.Unlock() + + r, ok := m.runs[runID] + if !ok { + return tfe.ErrResourceNotFound + } + if r.Status != tfe.RunPending { + // Only update the status if the run is not pending anymore. + r.Status = tfe.RunApplying + r.Actions.IsConfirmable = false + r.Apply.Status = tfe.ApplyRunning + } + return nil +} + +func (m *mockRuns) Cancel(ctx context.Context, runID string, options tfe.RunCancelOptions) error { + panic("not implemented") +} + +func (m *mockRuns) ForceCancel(ctx context.Context, runID string, options tfe.RunForceCancelOptions) error { + panic("not implemented") +} + +func (m *mockRuns) Discard(ctx context.Context, runID string, options tfe.RunDiscardOptions) error { + m.Lock() + defer m.Unlock() + + r, ok := m.runs[runID] + if !ok { + return tfe.ErrResourceNotFound + } + r.Status = tfe.RunDiscarded + r.Actions.IsConfirmable = false + return nil +} + +type mockStateVersions struct { + client *mockClient + states map[string][]byte + stateVersions map[string]*tfe.StateVersion + workspaces map[string][]string +} + +func newMockStateVersions(client *mockClient) *mockStateVersions { + return &mockStateVersions{ + client: client, + states: make(map[string][]byte), + stateVersions: make(map[string]*tfe.StateVersion), + workspaces: make(map[string][]string), + } +} + +func (m *mockStateVersions) List(ctx context.Context, options tfe.StateVersionListOptions) (*tfe.StateVersionList, error) { + svl := &tfe.StateVersionList{} + for _, sv := range m.stateVersions { + svl.Items = append(svl.Items, sv) + } + + svl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 1, + PreviousPage: 1, + TotalPages: 1, + TotalCount: len(svl.Items), + } + + return svl, nil +} + +func (m *mockStateVersions) Create(ctx context.Context, workspaceID string, options tfe.StateVersionCreateOptions) (*tfe.StateVersion, error) { + id := generateID("sv-") + runID := os.Getenv("TFE_RUN_ID") + url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) + + if runID != "" && (options.Run == nil || runID != options.Run.ID) { + return nil, fmt.Errorf("option.Run.ID does not contain the ID exported by TFE_RUN_ID") + } + + sv := &tfe.StateVersion{ + ID: id, + DownloadURL: url, + Serial: *options.Serial, + } + + state, err := base64.StdEncoding.DecodeString(*options.State) + if err != nil { + return nil, err + } + + m.states[sv.DownloadURL] = state + m.stateVersions[sv.ID] = sv + m.workspaces[workspaceID] = append(m.workspaces[workspaceID], sv.ID) + + return sv, nil +} + +func (m *mockStateVersions) Read(ctx context.Context, svID string) (*tfe.StateVersion, error) { + return m.ReadWithOptions(ctx, svID, nil) +} + +func (m *mockStateVersions) ReadWithOptions(ctx context.Context, svID string, options *tfe.StateVersionReadOptions) (*tfe.StateVersion, error) { + sv, ok := m.stateVersions[svID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return sv, nil +} + +func (m *mockStateVersions) Current(ctx context.Context, workspaceID string) (*tfe.StateVersion, error) { + return m.CurrentWithOptions(ctx, workspaceID, nil) +} + +func (m *mockStateVersions) CurrentWithOptions(ctx context.Context, workspaceID string, options *tfe.StateVersionCurrentOptions) (*tfe.StateVersion, error) { + w, ok := m.client.Workspaces.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + svs, ok := m.workspaces[w.ID] + if !ok || len(svs) == 0 { + return nil, tfe.ErrResourceNotFound + } + + sv, ok := m.stateVersions[svs[len(svs)-1]] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + return sv, nil +} + +func (m *mockStateVersions) Download(ctx context.Context, url string) ([]byte, error) { + state, ok := m.states[url] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return state, nil +} + +type mockVariables struct { + client *mockClient + workspaces map[string]*tfe.VariableList +} + +var _ tfe.Variables = (*mockVariables)(nil) + +func newMockVariables(client *mockClient) *mockVariables { + return &mockVariables{ + client: client, + workspaces: make(map[string]*tfe.VariableList), + } +} + +func (m *mockVariables) List(ctx context.Context, workspaceID string, options tfe.VariableListOptions) (*tfe.VariableList, error) { + vl := m.workspaces[workspaceID] + return vl, nil +} + +func (m *mockVariables) Create(ctx context.Context, workspaceID string, options tfe.VariableCreateOptions) (*tfe.Variable, error) { + v := &tfe.Variable{ + ID: generateID("var-"), + Key: *options.Key, + Category: *options.Category, + } + if options.Value != nil { + v.Value = *options.Value + } + if options.HCL != nil { + v.HCL = *options.HCL + } + if options.Sensitive != nil { + v.Sensitive = *options.Sensitive + } + + workspace := workspaceID + + if m.workspaces[workspace] == nil { + m.workspaces[workspace] = &tfe.VariableList{} + } + + vl := m.workspaces[workspace] + vl.Items = append(vl.Items, v) + + return v, nil +} + +func (m *mockVariables) Read(ctx context.Context, workspaceID string, variableID string) (*tfe.Variable, error) { + panic("not implemented") +} + +func (m *mockVariables) Update(ctx context.Context, workspaceID string, variableID string, options tfe.VariableUpdateOptions) (*tfe.Variable, error) { + panic("not implemented") +} + +func (m *mockVariables) Delete(ctx context.Context, workspaceID string, variableID string) error { + panic("not implemented") +} + +type mockWorkspaces struct { + client *mockClient + workspaceIDs map[string]*tfe.Workspace + workspaceNames map[string]*tfe.Workspace +} + +func newMockWorkspaces(client *mockClient) *mockWorkspaces { + return &mockWorkspaces{ + client: client, + workspaceIDs: make(map[string]*tfe.Workspace), + workspaceNames: make(map[string]*tfe.Workspace), + } +} + +func (m *mockWorkspaces) List(ctx context.Context, organization string, options tfe.WorkspaceListOptions) (*tfe.WorkspaceList, error) { + dummyWorkspaces := 10 + wl := &tfe.WorkspaceList{} + + // Get the prefix from the search options. + prefix := "" + if options.Search != nil { + prefix = *options.Search + } + + // Get all the workspaces that match the prefix. + var ws []*tfe.Workspace + for _, w := range m.workspaceIDs { + if strings.HasPrefix(w.Name, prefix) { + ws = append(ws, w) + } + } + + // Return an empty result if we have no matches. + if len(ws) == 0 { + wl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + } + return wl, nil + } + + // Return dummy workspaces for the first page to test pagination. + if options.PageNumber <= 1 { + for i := 0; i < dummyWorkspaces; i++ { + wl.Items = append(wl.Items, &tfe.Workspace{ + ID: generateID("ws-"), + Name: fmt.Sprintf("dummy-workspace-%d", i), + }) + } + + wl.Pagination = &tfe.Pagination{ + CurrentPage: 1, + NextPage: 2, + TotalPages: 2, + TotalCount: len(wl.Items) + len(ws), + } + + return wl, nil + } + + // Return the actual workspaces that matched as the second page. + wl.Items = ws + wl.Pagination = &tfe.Pagination{ + CurrentPage: 2, + PreviousPage: 1, + TotalPages: 2, + TotalCount: len(wl.Items) + dummyWorkspaces, + } + + return wl, nil +} + +func (m *mockWorkspaces) Create(ctx context.Context, organization string, options tfe.WorkspaceCreateOptions) (*tfe.Workspace, error) { + if strings.HasSuffix(*options.Name, "no-operations") { + options.Operations = tfe.Bool(false) + } else if options.Operations == nil { + options.Operations = tfe.Bool(true) + } + w := &tfe.Workspace{ + ID: generateID("ws-"), + Name: *options.Name, + Operations: *options.Operations, + Permissions: &tfe.WorkspacePermissions{ + CanQueueApply: true, + CanQueueRun: true, + }, + } + if options.AutoApply != nil { + w.AutoApply = *options.AutoApply + } + if options.VCSRepo != nil { + w.VCSRepo = &tfe.VCSRepo{} + } + if options.TerraformVersion != nil { + w.TerraformVersion = *options.TerraformVersion + } else { + w.TerraformVersion = tfversion.String() + } + m.workspaceIDs[w.ID] = w + m.workspaceNames[w.Name] = w + return w, nil +} + +func (m *mockWorkspaces) Read(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { + // custom error for TestCloud_plan500 in backend_plan_test.go + if workspace == "network-error" { + return nil, errors.New("I'm a little teacup") + } + + w, ok := m.workspaceNames[workspace] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return w, nil +} + +func (m *mockWorkspaces) ReadByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return w, nil +} + +func (m *mockWorkspaces) Update(ctx context.Context, organization, workspace string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { + w, ok := m.workspaceNames[workspace] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if options.Operations != nil { + w.Operations = *options.Operations + } + if options.Name != nil { + w.Name = *options.Name + } + if options.TerraformVersion != nil { + w.TerraformVersion = *options.TerraformVersion + } + if options.WorkingDirectory != nil { + w.WorkingDirectory = *options.WorkingDirectory + } + + delete(m.workspaceNames, workspace) + m.workspaceNames[w.Name] = w + + return w, nil +} + +func (m *mockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + + if options.Name != nil { + w.Name = *options.Name + } + if options.TerraformVersion != nil { + w.TerraformVersion = *options.TerraformVersion + } + if options.WorkingDirectory != nil { + w.WorkingDirectory = *options.WorkingDirectory + } + + delete(m.workspaceNames, w.Name) + m.workspaceNames[w.Name] = w + + return w, nil +} + +func (m *mockWorkspaces) Delete(ctx context.Context, organization, workspace string) error { + if w, ok := m.workspaceNames[workspace]; ok { + delete(m.workspaceIDs, w.ID) + } + delete(m.workspaceNames, workspace) + return nil +} + +func (m *mockWorkspaces) DeleteByID(ctx context.Context, workspaceID string) error { + if w, ok := m.workspaceIDs[workspaceID]; ok { + delete(m.workspaceIDs, w.Name) + } + delete(m.workspaceIDs, workspaceID) + return nil +} + +func (m *mockWorkspaces) RemoveVCSConnection(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { + w, ok := m.workspaceNames[workspace] + if !ok { + return nil, tfe.ErrResourceNotFound + } + w.VCSRepo = nil + return w, nil +} + +func (m *mockWorkspaces) RemoveVCSConnectionByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + w.VCSRepo = nil + return w, nil +} + +func (m *mockWorkspaces) Lock(ctx context.Context, workspaceID string, options tfe.WorkspaceLockOptions) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + if w.Locked { + return nil, tfe.ErrWorkspaceLocked + } + w.Locked = true + return w, nil +} + +func (m *mockWorkspaces) Unlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + if !w.Locked { + return nil, tfe.ErrWorkspaceNotLocked + } + w.Locked = false + return w, nil +} + +func (m *mockWorkspaces) ForceUnlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + if !w.Locked { + return nil, tfe.ErrWorkspaceNotLocked + } + w.Locked = false + return w, nil +} + +func (m *mockWorkspaces) AssignSSHKey(ctx context.Context, workspaceID string, options tfe.WorkspaceAssignSSHKeyOptions) (*tfe.Workspace, error) { + panic("not implemented") +} + +func (m *mockWorkspaces) UnassignSSHKey(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { + panic("not implemented") +} + +func (m *mockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string) (*tfe.WorkspaceList, error) { + panic("not implemented") +} + +func (m *mockWorkspaces) AddRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceAddRemoteStateConsumersOptions) error { + panic("not implemented") +} + +func (m *mockWorkspaces) RemoveRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceRemoveRemoteStateConsumersOptions) error { + panic("not implemented") +} + +func (m *mockWorkspaces) UpdateRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateRemoteStateConsumersOptions) error { + panic("not implemented") +} + +func (m *mockWorkspaces) Readme(ctx context.Context, workspaceID string) (io.Reader, error) { + panic("not implemented") +} + +const alphanumeric = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" + +func generateID(s string) string { + b := make([]byte, 16) + for i := range b { + b[i] = alphanumeric[rand.Intn(len(alphanumeric))] + } + return s + string(b) +} diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go new file mode 100644 index 000000000000..025b3677664f --- /dev/null +++ b/internal/cloud/backend_plan.go @@ -0,0 +1,439 @@ +package cloud + +import ( + "bufio" + "context" + "errors" + "fmt" + "io" + "io/ioutil" + "log" + "os" + "path/filepath" + "strings" + "syscall" + "time" + + tfe "github.com/hashicorp/go-tfe" + version "github.com/hashicorp/go-version" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +var planConfigurationVersionsPollInterval = 500 * time.Millisecond + +func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation, w *tfe.Workspace) (*tfe.Run, error) { + log.Printf("[INFO] cloud: starting Plan operation") + + var diags tfdiags.Diagnostics + + if !w.Permissions.CanQueueRun { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Insufficient rights to generate a plan", + "The provided credentials have insufficient rights to generate a plan. In order "+ + "to generate plans, at least plan permissions on the workspace are required.", + )) + return nil, diags.Err() + } + + if op.Parallelism != defaultParallelism { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Custom parallelism values are currently not supported", + `Terraform Cloud does not support setting a custom parallelism `+ + `value at this time.`, + )) + } + + if op.PlanFile != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Displaying a saved plan is currently not supported", + `Terraform Cloud currently requires configuration to be present and `+ + `does not accept an existing saved plan as an argument at this time.`, + )) + } + + if op.PlanOutPath != "" { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Saving a generated plan is currently not supported", + `Terraform Cloud does not support saving the generated execution `+ + `plan locally at this time.`, + )) + } + + if b.hasExplicitVariableValues(op) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Run variables are currently not supported", + fmt.Sprintf( + "Terraform Cloud does not support setting run variables from command line arguments at this time. "+ + "Currently the only to way to pass variables is by "+ + "creating a '*.auto.tfvars' variables file. This file will automatically "+ + "be loaded when the workspace is configured to use "+ + "Terraform v0.10.0 or later.\n\nAdditionally you can also set variables on "+ + "the workspace in the web UI:\nhttps://%s/app/%s/%s/variables", + b.hostname, b.organization, op.Workspace, + ), + )) + } + + if !op.HasConfig() && op.PlanMode != plans.DestroyMode { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "No configuration files found", + `Plan requires configuration to be present. Planning without a configuration `+ + `would mark everything for destruction, which is normally not what is desired. `+ + `If you would like to destroy everything, please run plan with the "-destroy" `+ + `flag or create a single empty configuration file. Otherwise, please create `+ + `a Terraform configuration file in the path being executed and try again.`, + )) + } + + // For API versions prior to 2.3, RemoteAPIVersion will return an empty string, + // so if there's an error when parsing the RemoteAPIVersion, it's handled as + // equivalent to an API version < 2.3. + currentAPIVersion, parseErr := version.NewVersion(b.client.RemoteAPIVersion()) + + if len(op.Targets) != 0 { + desiredAPIVersion, _ := version.NewVersion("2.3") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Resource targeting is not supported", + fmt.Sprintf( + `The host %s does not support the -target option for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + if !op.PlanRefresh { + desiredAPIVersion, _ := version.NewVersion("2.4") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Planning without refresh is not supported", + fmt.Sprintf( + `The host %s does not support the -refresh=false option for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + if len(op.ForceReplace) != 0 { + desiredAPIVersion, _ := version.NewVersion("2.4") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Planning resource replacements is not supported", + fmt.Sprintf( + `The host %s does not support the -replace option for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + if op.PlanMode == plans.RefreshOnlyMode { + desiredAPIVersion, _ := version.NewVersion("2.4") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Refresh-only mode is not supported", + fmt.Sprintf( + `The host %s does not support -refresh-only mode for `+ + `remote plans.`, + b.hostname, + ), + )) + } + } + + // Return if there are any errors. + if diags.HasErrors() { + return nil, diags.Err() + } + + return b.plan(stopCtx, cancelCtx, op, w) +} + +func (b *Cloud) plan(stopCtx, cancelCtx context.Context, op *backend.Operation, w *tfe.Workspace) (*tfe.Run, error) { + if b.CLI != nil { + header := planDefaultHeader + if op.Type == backend.OperationTypeApply { + header = applyDefaultHeader + } + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(header) + "\n")) + } + + configOptions := tfe.ConfigurationVersionCreateOptions{ + AutoQueueRuns: tfe.Bool(false), + Speculative: tfe.Bool(op.Type == backend.OperationTypePlan), + } + + cv, err := b.client.ConfigurationVersions.Create(stopCtx, w.ID, configOptions) + if err != nil { + return nil, generalError("Failed to create configuration version", err) + } + + var configDir string + if op.ConfigDir != "" { + // De-normalize the configuration directory path. + configDir, err = filepath.Abs(op.ConfigDir) + if err != nil { + return nil, generalError( + "Failed to get absolute path of the configuration directory: %v", err) + } + + // Make sure to take the working directory into account by removing + // the working directory from the current path. This will result in + // a path that points to the expected root of the workspace. + configDir = filepath.Clean(strings.TrimSuffix( + filepath.Clean(configDir), + filepath.Clean(w.WorkingDirectory), + )) + + // If the workspace has a subdirectory as its working directory then + // our configDir will be some parent directory of the current working + // directory. Users are likely to find that surprising, so we'll + // produce an explicit message about it to be transparent about what + // we are doing and why. + if w.WorkingDirectory != "" && filepath.Base(configDir) != w.WorkingDirectory { + if b.CLI != nil { + b.CLI.Output(fmt.Sprintf(strings.TrimSpace(` +The remote workspace is configured to work with configuration at +%s relative to the target repository. + +Terraform will upload the contents of the following directory, +excluding files or directories as defined by a .terraformignore file +at %s/.terraformignore (if it is present), +in order to capture the filesystem context the remote workspace expects: + %s +`), w.WorkingDirectory, configDir, configDir) + "\n") + } + } + + } else { + // We did a check earlier to make sure we either have a config dir, + // or the plan is run with -destroy. So this else clause will only + // be executed when we are destroying and doesn't need the config. + configDir, err = ioutil.TempDir("", "tf") + if err != nil { + return nil, generalError("Failed to create temporary directory", err) + } + defer os.RemoveAll(configDir) + + // Make sure the configured working directory exists. + err = os.MkdirAll(filepath.Join(configDir, w.WorkingDirectory), 0700) + if err != nil { + return nil, generalError( + "Failed to create temporary working directory", err) + } + } + + err = b.client.ConfigurationVersions.Upload(stopCtx, cv.UploadURL, configDir) + if err != nil { + return nil, generalError("Failed to upload configuration files", err) + } + + uploaded := false + for i := 0; i < 60 && !uploaded; i++ { + select { + case <-stopCtx.Done(): + return nil, context.Canceled + case <-cancelCtx.Done(): + return nil, context.Canceled + case <-time.After(planConfigurationVersionsPollInterval): + cv, err = b.client.ConfigurationVersions.Read(stopCtx, cv.ID) + if err != nil { + return nil, generalError("Failed to retrieve configuration version", err) + } + + if cv.Status == tfe.ConfigurationUploaded { + uploaded = true + } + } + } + + if !uploaded { + return nil, generalError( + "Failed to upload configuration files", errors.New("operation timed out")) + } + + runOptions := tfe.RunCreateOptions{ + ConfigurationVersion: cv, + Refresh: tfe.Bool(op.PlanRefresh), + Workspace: w, + } + + switch op.PlanMode { + case plans.NormalMode: + // okay, but we don't need to do anything special for this + case plans.RefreshOnlyMode: + runOptions.RefreshOnly = tfe.Bool(true) + case plans.DestroyMode: + runOptions.IsDestroy = tfe.Bool(true) + default: + // Shouldn't get here because we should update this for each new + // plan mode we add, mapping it to the corresponding RunCreateOptions + // field. + return nil, generalError( + "Invalid plan mode", + fmt.Errorf("Terraform Cloud doesn't support %s", op.PlanMode), + ) + } + + if len(op.Targets) != 0 { + runOptions.TargetAddrs = make([]string, 0, len(op.Targets)) + for _, addr := range op.Targets { + runOptions.TargetAddrs = append(runOptions.TargetAddrs, addr.String()) + } + } + + if len(op.ForceReplace) != 0 { + runOptions.ReplaceAddrs = make([]string, 0, len(op.ForceReplace)) + for _, addr := range op.ForceReplace { + runOptions.ReplaceAddrs = append(runOptions.ReplaceAddrs, addr.String()) + } + } + + r, err := b.client.Runs.Create(stopCtx, runOptions) + if err != nil { + return r, generalError("Failed to create run", err) + } + + // When the lock timeout is set, if the run is still pending and + // cancellable after that period, we attempt to cancel it. + if lockTimeout := op.StateLocker.Timeout(); lockTimeout > 0 { + go func() { + select { + case <-stopCtx.Done(): + return + case <-cancelCtx.Done(): + return + case <-time.After(lockTimeout): + // Retrieve the run to get its current status. + r, err := b.client.Runs.Read(cancelCtx, r.ID) + if err != nil { + log.Printf("[ERROR] error reading run: %v", err) + return + } + + if r.Status == tfe.RunPending && r.Actions.IsCancelable { + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(lockTimeoutErr))) + } + + // We abuse the auto aprove flag to indicate that we do not + // want to ask if the remote operation should be canceled. + op.AutoApprove = true + + p, err := os.FindProcess(os.Getpid()) + if err != nil { + log.Printf("[ERROR] error searching process ID: %v", err) + return + } + p.Signal(syscall.SIGINT) + } + } + }() + } + + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(fmt.Sprintf( + runHeader, b.hostname, b.organization, op.Workspace, r.ID)) + "\n")) + } + + r, err = b.waitForRun(stopCtx, cancelCtx, op, "plan", r, w) + if err != nil { + return r, err + } + + logs, err := b.client.Plans.Logs(stopCtx, r.Plan.ID) + if err != nil { + return r, generalError("Failed to retrieve logs", err) + } + reader := bufio.NewReaderSize(logs, 64*1024) + + if b.CLI != nil { + for next := true; next; { + var l, line []byte + + for isPrefix := true; isPrefix; { + l, isPrefix, err = reader.ReadLine() + if err != nil { + if err != io.EOF { + return r, generalError("Failed to read logs", err) + } + next = false + } + line = append(line, l...) + } + + if next || len(line) > 0 { + b.CLI.Output(b.Colorize().Color(string(line))) + } + } + } + + // Retrieve the run to get its current status. + r, err = b.client.Runs.Read(stopCtx, r.ID) + if err != nil { + return r, generalError("Failed to retrieve run", err) + } + + // If the run is canceled or errored, we still continue to the + // cost-estimation and policy check phases to ensure we render any + // results available. In the case of a hard-failed policy check, the + // status of the run will be "errored", but there is still policy + // information which should be shown. + + // Show any cost estimation output. + if r.CostEstimate != nil { + err = b.costEstimate(stopCtx, cancelCtx, op, r) + if err != nil { + return r, err + } + } + + // Check any configured sentinel policies. + if len(r.PolicyChecks) > 0 { + err = b.checkPolicy(stopCtx, cancelCtx, op, r) + if err != nil { + return r, err + } + } + + return r, nil +} + +const planDefaultHeader = ` +[reset][yellow]Running plan in Terraform Cloud. Output will stream here. Pressing Ctrl-C +will stop streaming the logs, but will not stop the plan running remotely.[reset] + +Preparing the remote plan... +` + +const runHeader = ` +[reset][yellow]To view this run in a browser, visit: +https://%s/app/%s/%s/runs/%s[reset] +` + +// The newline in this error is to make it look good in the CLI! +const lockTimeoutErr = ` +[reset][red]Lock timeout exceeded, sending interrupt to cancel the remote operation. +[reset] +` diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go new file mode 100644 index 000000000000..790c8cc030c1 --- /dev/null +++ b/internal/cloud/backend_plan_test.go @@ -0,0 +1,1237 @@ +package cloud + +import ( + "context" + "os" + "os/signal" + "strings" + "syscall" + "testing" + "time" + + "github.com/google/go-cmp/cmp" + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/command/arguments" + "github.com/hashicorp/terraform/internal/command/clistate" + "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/initwd" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/plans/planfile" + "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terminal" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/mitchellh/cli" +) + +func testOperationPlan(t *testing.T, configDir string) (*backend.Operation, func(), func(*testing.T) *terminal.TestOutput) { + t.Helper() + + return testOperationPlanWithTimeout(t, configDir, 0) +} + +func testOperationPlanWithTimeout(t *testing.T, configDir string, timeout time.Duration) (*backend.Operation, func(), func(*testing.T) *terminal.TestOutput) { + t.Helper() + + _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) + + streams, done := terminal.StreamsForTesting(t) + view := views.NewView(streams) + stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) + operationView := views.NewOperation(arguments.ViewHuman, false, view) + + return &backend.Operation{ + ConfigDir: configDir, + ConfigLoader: configLoader, + Parallelism: defaultParallelism, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypePlan, + View: operationView, + }, configCleanup, done +} + +func TestCloud_planBasic(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatal("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } + + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + // An error suggests that the state was not unlocked after the operation finished + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state after successful plan: %s", err.Error()) + } +} + +func TestCloud_planCanceled(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + // Stop the run to simulate a Ctrl-C. + run.Stop() + + <-run.Done() + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + + stateMgr, _ := b.StateMgr(backend.DefaultStateName) + // An error suggests that the state was not unlocked after the operation finished + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state after cancelled plan: %s", err.Error()) + } +} + +func TestCloud_planLongLine(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-long-line") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatal("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planWithoutPermissions(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + // Create a named workspace without permissions. + w, err := b.client.Workspaces.Create( + context.Background(), + b.organization, + tfe.WorkspaceCreateOptions{ + Name: tfe.String(b.prefix + "prod"), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + w.Permissions.CanQueueRun = false + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + op.Workspace = "prod" + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Insufficient rights to generate a plan") { + t.Fatalf("expected a permissions error, got: %v", errOutput) + } +} + +func TestCloud_planWithParallelism(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + op.Parallelism = 3 + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "parallelism values are currently not supported") { + t.Fatalf("expected a parallelism error, got: %v", errOutput) + } +} + +func TestCloud_planWithPlan(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + op.PlanFile = &planfile.Reader{} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "saved plan is currently not supported") { + t.Fatalf("expected a saved plan error, got: %v", errOutput) + } +} + +func TestCloud_planWithPath(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + op.PlanOutPath = "./testdata/plan" + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "generated plan is currently not supported") { + t.Fatalf("expected a generated plan error, got: %v", errOutput) + } +} + +func TestCloud_planWithoutRefresh(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.PlanRefresh = false + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatal("expected a non-empty plan") + } + + // We should find a run inside the mock client that has refresh set + // to false. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff(false, run.Refresh); diff != "" { + t.Errorf("wrong Refresh setting in the created run\n%s", diff) + } + } +} + +func TestCloud_planWithoutRefreshIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + b.client.SetFakeRemoteAPIVersion("2.3") + + op.PlanRefresh = false + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Planning without refresh is not supported") { + t.Fatalf("expected not supported error, got: %v", errOutput) + } +} + +func TestCloud_planWithRefreshOnly(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.PlanMode = plans.RefreshOnlyMode + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatal("expected a non-empty plan") + } + + // We should find a run inside the mock client that has refresh-only set + // to true. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff(true, run.RefreshOnly); diff != "" { + t.Errorf("wrong RefreshOnly setting in the created run\n%s", diff) + } + } +} + +func TestCloud_planWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + b.client.SetFakeRemoteAPIVersion("2.3") + + op.PlanMode = plans.RefreshOnlyMode + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Refresh-only mode is not supported") { + t.Fatalf("expected not supported error, got: %v", errOutput) + } +} + +func TestCloud_planWithTarget(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + // When the backend code creates a new run, we'll tweak it so that it + // has a cost estimation object with the "skipped_due_to_targeting" status, + // emulating how a real server is expected to behave in that case. + b.client.Runs.(*mockRuns).modifyNewRun = func(client *mockClient, options tfe.RunCreateOptions, run *tfe.Run) { + const fakeID = "fake" + // This is the cost estimate object embedded in the run itself which + // the backend will use to learn the ID to request from the cost + // estimates endpoint. It's pending to simulate what a freshly-created + // run is likely to look like. + run.CostEstimate = &tfe.CostEstimate{ + ID: fakeID, + Status: "pending", + } + // The backend will then use the main cost estimation API to retrieve + // the same ID indicated in the object above, where we'll then return + // the status "skipped_due_to_targeting" to trigger the special skip + // message in the backend output. + client.CostEstimates.estimations[fakeID] = &tfe.CostEstimate{ + ID: fakeID, + Status: "skipped_due_to_targeting", + } + } + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") + + op.Targets = []addrs.Targetable{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatal("expected plan operation to succeed") + } + if run.PlanEmpty { + t.Fatalf("expected plan to be non-empty") + } + + // testBackendDefault above attached a "mock UI" to our backend, so we + // can retrieve its non-error output via the OutputWriter in-memory buffer. + gotOutput := b.CLI.(*cli.MockUi).OutputWriter.String() + if wantOutput := "Not available for this plan, because it was created with the -target option."; !strings.Contains(gotOutput, wantOutput) { + t.Errorf("missing message about skipped cost estimation\ngot:\n%s\nwant substring: %s", gotOutput, wantOutput) + } + + // We should find a run inside the mock client that has the same + // target address we requested above. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff([]string{"null_resource.foo"}, run.TargetAddrs); diff != "" { + t.Errorf("wrong TargetAddrs in the created run\n%s", diff) + } + } +} + +func TestCloud_planWithTargetIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + // Set the tfe client's RemoteAPIVersion to an empty string, to mimic + // API versions prior to 2.3. + b.client.SetFakeRemoteAPIVersion("") + + addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") + + op.Targets = []addrs.Targetable{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Resource targeting is not supported") { + t.Fatalf("expected a targeting error, got: %v", errOutput) + } +} + +func TestCloud_planWithReplace(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") + + op.ForceReplace = []addrs.AbsResourceInstance{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatal("expected plan operation to succeed") + } + if run.PlanEmpty { + t.Fatalf("expected plan to be non-empty") + } + + // We should find a run inside the mock client that has the same + // refresh address we requested above. + runsAPI := b.client.Runs.(*mockRuns) + if got, want := len(runsAPI.runs), 1; got != want { + t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) + } + for _, run := range runsAPI.runs { + if diff := cmp.Diff([]string{"null_resource.foo"}, run.ReplaceAddrs); diff != "" { + t.Errorf("wrong ReplaceAddrs in the created run\n%s", diff) + } + } +} + +func TestCloud_planWithReplaceIncompatibleAPIVersion(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + + b.client.SetFakeRemoteAPIVersion("2.3") + + addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") + + op.ForceReplace = []addrs.AbsResourceInstance{addr} + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "Planning resource replacements is not supported") { + t.Fatalf("expected not supported error, got: %v", errOutput) + } +} + +func TestCloud_planWithVariables(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-variables") + defer configCleanup() + + op.Variables = testVariables(terraform.ValueFromCLIArg, "foo", "bar") + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "variables are currently not supported") { + t.Fatalf("expected a variables error, got: %v", errOutput) + } +} + +func TestCloud_planNoConfig(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/empty") + defer configCleanup() + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + output := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := output.Stderr() + if !strings.Contains(errOutput, "configuration files found") { + t.Fatalf("expected configuration files error, got: %v", errOutput) + } +} + +func TestCloud_planNoChanges(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-no-changes") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "No changes. Infrastructure is up-to-date.") { + t.Fatalf("expected no changes in plan summary: %s", output) + } + if !strings.Contains(output, "Sentinel Result: true") { + t.Fatalf("expected policy check result in output: %s", output) + } +} + +func TestCloud_planForceLocal(t *testing.T) { + // Set TF_FORCE_LOCAL_BACKEND so the cloud backend will use + // the local backend with itself as embedded backend. + if err := os.Setenv("TF_FORCE_LOCAL_BACKEND", "1"); err != nil { + t.Fatalf("error setting environment variable TF_FORCE_LOCAL_BACKEND: %v", err) + } + defer os.Unsetenv("TF_FORCE_LOCAL_BACKEND") + + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + streams, done := terminal.StreamsForTesting(t) + view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + op.View = view + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) + } + if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planWithoutOperationsEntitlement(t *testing.T) { + b, bCleanup := testBackendNoOperations(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + streams, done := terminal.StreamsForTesting(t) + view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + op.View = view + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) + } + if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + ctx := context.Background() + + // Create a named workspace that doesn't allow operations. + _, err := b.client.Workspaces.Create( + ctx, + b.organization, + tfe.WorkspaceCreateOptions{ + Name: tfe.String(b.prefix + "no-operations"), + }, + ) + if err != nil { + t.Fatalf("error creating named workspace: %v", err) + } + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.Workspace = "no-operations" + + streams, done := terminal.StreamsForTesting(t) + view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) + op.View = view + + run, err := b.Operation(ctx, op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) + } + if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planLockTimeout(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + ctx := context.Background() + + // Retrieve the workspace used to run this operation in. + w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspace) + if err != nil { + t.Fatalf("error retrieving workspace: %v", err) + } + + // Create a new configuration version. + c, err := b.client.ConfigurationVersions.Create(ctx, w.ID, tfe.ConfigurationVersionCreateOptions{}) + if err != nil { + t.Fatalf("error creating configuration version: %v", err) + } + + // Create a pending run to block this run. + _, err = b.client.Runs.Create(ctx, tfe.RunCreateOptions{ + ConfigurationVersion: c, + Workspace: w, + }) + if err != nil { + t.Fatalf("error creating pending run: %v", err) + } + + op, configCleanup, done := testOperationPlanWithTimeout(t, "./testdata/plan", 50) + defer configCleanup() + defer done(t) + + input := testInput(t, map[string]string{ + "cancel": "yes", + "approve": "yes", + }) + + op.UIIn = input + op.UIOut = b.CLI + op.Workspace = backend.DefaultStateName + + _, err = b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + sigint := make(chan os.Signal, 1) + signal.Notify(sigint, syscall.SIGINT) + select { + case <-sigint: + // Stop redirecting SIGINT signals. + signal.Stop(sigint) + case <-time.After(200 * time.Millisecond): + t.Fatalf("expected lock timeout after 50 milliseconds, waited 200 milliseconds") + } + + if len(input.answers) != 2 { + t.Fatalf("expected unused answers, got: %v", input.answers) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "Lock timeout exceeded") { + t.Fatalf("expected lock timout error in output: %s", output) + } + if strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("unexpected plan summary in output: %s", output) + } +} + +func TestCloud_planDestroy(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.PlanMode = plans.DestroyMode + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } +} + +func TestCloud_planDestroyNoConfig(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/empty") + defer configCleanup() + defer done(t) + + op.PlanMode = plans.DestroyMode + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } +} + +func TestCloud_planWithWorkingDirectory(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + options := tfe.WorkspaceUpdateOptions{ + WorkingDirectory: tfe.String("terraform"), + } + + // Configure the workspace to use a custom working directory. + _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspace, options) + if err != nil { + t.Fatalf("error configuring working directory: %v", err) + } + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-with-working-directory/terraform") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "The remote workspace is configured to work with configuration") { + t.Fatalf("expected working directory warning: %s", output) + } + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planWithWorkingDirectoryFromCurrentPath(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + options := tfe.WorkspaceUpdateOptions{ + WorkingDirectory: tfe.String("terraform"), + } + + // Configure the workspace to use a custom working directory. + _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspace, options) + if err != nil { + t.Fatalf("error configuring working directory: %v", err) + } + + wd, err := os.Getwd() + if err != nil { + t.Fatalf("error getting current working directory: %v", err) + } + + // We need to change into the configuration directory to make sure + // the logic to upload the correct slug is working as expected. + if err := os.Chdir("./testdata/plan-with-working-directory/terraform"); err != nil { + t.Fatalf("error changing directory: %v", err) + } + defer os.Chdir(wd) // Make sure we change back again when were done. + + // For this test we need to give our current directory instead of the + // full path to the configuration as we already changed directories. + op, configCleanup, done := testOperationPlan(t, ".") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planCostEstimation(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-cost-estimation") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "Resources: 1 of 1 estimated") { + t.Fatalf("expected cost estimate result in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planPolicyPass(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-passed") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + if run.PlanEmpty { + t.Fatalf("expected a non-empty plan") + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: true") { + t.Fatalf("expected policy check result in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planPolicyHardFail(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-hard-failed") + defer configCleanup() + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + viewOutput := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := viewOutput.Stderr() + if !strings.Contains(errOutput, "hard failed") { + t.Fatalf("expected a policy check error, got: %v", errOutput) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: false") { + t.Fatalf("expected policy check result in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planPolicySoftFail(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-soft-failed") + defer configCleanup() + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + viewOutput := done(t) + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if !run.PlanEmpty { + t.Fatalf("expected plan to be empty") + } + + errOutput := viewOutput.Stderr() + if !strings.Contains(errOutput, "soft failed") { + t.Fatalf("expected a policy check error, got: %v", errOutput) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "Sentinel Result: false") { + t.Fatalf("expected policy check result in output: %s", output) + } + if !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { + t.Fatalf("expected plan summary in output: %s", output) + } +} + +func TestCloud_planWithRemoteError(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan-with-error") + defer configCleanup() + defer done(t) + + op.Workspace = backend.DefaultStateName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result == backend.OperationSuccess { + t.Fatal("expected plan operation to fail") + } + if run.Result.ExitStatus() != 1 { + t.Fatalf("expected exit code 1, got %d", run.Result.ExitStatus()) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("expected TFC header in output: %s", output) + } + if !strings.Contains(output, "null_resource.foo: 1 error") { + t.Fatalf("expected plan error in output: %s", output) + } +} + +func TestCloud_planOtherError(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + op.Workspace = "network-error" // custom error response in backend_mock.go + + _, err := b.Operation(context.Background(), op) + if err == nil { + t.Errorf("expected error, got success") + } + + if !strings.Contains(err.Error(), + "Terraform Cloud returned an unexpected error:\n\nI'm a little teacup") { + t.Fatalf("expected error message, got: %s", err.Error()) + } +} diff --git a/internal/cloud/backend_state.go b/internal/cloud/backend_state.go new file mode 100644 index 000000000000..055a808e519d --- /dev/null +++ b/internal/cloud/backend_state.go @@ -0,0 +1,182 @@ +package cloud + +import ( + "bytes" + "context" + "crypto/md5" + "encoding/base64" + "fmt" + + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/states/remote" + "github.com/hashicorp/terraform/internal/states/statefile" + "github.com/hashicorp/terraform/internal/states/statemgr" +) + +type remoteClient struct { + client *tfe.Client + lockInfo *statemgr.LockInfo + organization string + runID string + stateUploadErr bool + workspace *tfe.Workspace + forcePush bool +} + +// Get the remote state. +func (r *remoteClient) Get() (*remote.Payload, error) { + ctx := context.Background() + + sv, err := r.client.StateVersions.Current(ctx, r.workspace.ID) + if err != nil { + if err == tfe.ErrResourceNotFound { + // If no state exists, then return nil. + return nil, nil + } + return nil, fmt.Errorf("Error retrieving state: %v", err) + } + + state, err := r.client.StateVersions.Download(ctx, sv.DownloadURL) + if err != nil { + return nil, fmt.Errorf("Error downloading state: %v", err) + } + + // If the state is empty, then return nil. + if len(state) == 0 { + return nil, nil + } + + // Get the MD5 checksum of the state. + sum := md5.Sum(state) + + return &remote.Payload{ + Data: state, + MD5: sum[:], + }, nil +} + +// Put the remote state. +func (r *remoteClient) Put(state []byte) error { + ctx := context.Background() + + // Read the raw state into a Terraform state. + stateFile, err := statefile.Read(bytes.NewReader(state)) + if err != nil { + return fmt.Errorf("Error reading state: %s", err) + } + + options := tfe.StateVersionCreateOptions{ + Lineage: tfe.String(stateFile.Lineage), + Serial: tfe.Int64(int64(stateFile.Serial)), + MD5: tfe.String(fmt.Sprintf("%x", md5.Sum(state))), + State: tfe.String(base64.StdEncoding.EncodeToString(state)), + Force: tfe.Bool(r.forcePush), + } + + // If we have a run ID, make sure to add it to the options + // so the state will be properly associated with the run. + if r.runID != "" { + options.Run = &tfe.Run{ID: r.runID} + } + + // Create the new state. + _, err = r.client.StateVersions.Create(ctx, r.workspace.ID, options) + if err != nil { + r.stateUploadErr = true + return fmt.Errorf("Error uploading state: %v", err) + } + + return nil +} + +// Delete the remote state. +func (r *remoteClient) Delete() error { + err := r.client.Workspaces.Delete(context.Background(), r.organization, r.workspace.Name) + if err != nil && err != tfe.ErrResourceNotFound { + return fmt.Errorf("Error deleting workspace %s: %v", r.workspace.Name, err) + } + + return nil +} + +// EnableForcePush to allow the remote client to overwrite state +// by implementing remote.ClientForcePusher +func (r *remoteClient) EnableForcePush() { + r.forcePush = true +} + +// Lock the remote state. +func (r *remoteClient) Lock(info *statemgr.LockInfo) (string, error) { + ctx := context.Background() + + lockErr := &statemgr.LockError{Info: r.lockInfo} + + // Lock the workspace. + _, err := r.client.Workspaces.Lock(ctx, r.workspace.ID, tfe.WorkspaceLockOptions{ + Reason: tfe.String("Locked by Terraform"), + }) + if err != nil { + if err == tfe.ErrWorkspaceLocked { + lockErr.Info = info + err = fmt.Errorf("%s (lock ID: \"%s/%s\")", err, r.organization, r.workspace.Name) + } + lockErr.Err = err + return "", lockErr + } + + r.lockInfo = info + + return r.lockInfo.ID, nil +} + +// Unlock the remote state. +func (r *remoteClient) Unlock(id string) error { + ctx := context.Background() + + // We first check if there was an error while uploading the latest + // state. If so, we will not unlock the workspace to prevent any + // changes from being applied until the correct state is uploaded. + if r.stateUploadErr { + return nil + } + + lockErr := &statemgr.LockError{Info: r.lockInfo} + + // With lock info this should be treated as a normal unlock. + if r.lockInfo != nil { + // Verify the expected lock ID. + if r.lockInfo.ID != id { + lockErr.Err = fmt.Errorf("lock ID does not match existing lock") + return lockErr + } + + // Unlock the workspace. + _, err := r.client.Workspaces.Unlock(ctx, r.workspace.ID) + if err != nil { + lockErr.Err = err + return lockErr + } + + return nil + } + + // Verify the optional force-unlock lock ID. + if r.organization+"/"+r.workspace.Name != id { + lockErr.Err = fmt.Errorf( + "lock ID %q does not match existing lock ID \"%s/%s\"", + id, + r.organization, + r.workspace.Name, + ) + return lockErr + } + + // Force unlock the workspace. + _, err := r.client.Workspaces.ForceUnlock(ctx, r.workspace.ID) + if err != nil { + lockErr.Err = err + return lockErr + } + + return nil +} diff --git a/internal/cloud/backend_state_test.go b/internal/cloud/backend_state_test.go new file mode 100644 index 000000000000..dc2a45723687 --- /dev/null +++ b/internal/cloud/backend_state_test.go @@ -0,0 +1,59 @@ +package cloud + +import ( + "bytes" + "os" + "testing" + + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/states/remote" + "github.com/hashicorp/terraform/internal/states/statefile" +) + +func TestRemoteClient_impl(t *testing.T) { + var _ remote.Client = new(remoteClient) +} + +func TestRemoteClient(t *testing.T) { + client := testRemoteClient(t) + remote.TestClient(t, client) +} + +func TestRemoteClient_stateLock(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + s1, err := b.StateMgr(backend.DefaultStateName) + if err != nil { + t.Fatalf("expected no error, got %v", err) + } + + s2, err := b.StateMgr(backend.DefaultStateName) + if err != nil { + t.Fatalf("expected no error, got %v", err) + } + + remote.TestRemoteLocks(t, s1.(*remote.State).Client, s2.(*remote.State).Client) +} + +func TestRemoteClient_withRunID(t *testing.T) { + // Set the TFE_RUN_ID environment variable before creating the client! + if err := os.Setenv("TFE_RUN_ID", generateID("run-")); err != nil { + t.Fatalf("error setting env var TFE_RUN_ID: %v", err) + } + + // Create a new test client. + client := testRemoteClient(t) + + // Create a new empty state. + sf := statefile.New(states.NewState(), "", 0) + var buf bytes.Buffer + statefile.Write(sf, &buf) + + // Store the new state to verify (this will be done + // by the mock that is used) that the run ID is set. + if err := client.Put(buf.Bytes()); err != nil { + t.Fatalf("expected no error, got %v", err) + } +} diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go new file mode 100644 index 000000000000..7862ad0a362c --- /dev/null +++ b/internal/cloud/backend_test.go @@ -0,0 +1,723 @@ +package cloud + +import ( + "context" + "fmt" + "reflect" + "strings" + "testing" + + tfe "github.com/hashicorp/go-tfe" + version "github.com/hashicorp/go-version" + "github.com/hashicorp/terraform-svchost/disco" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/tfdiags" + tfversion "github.com/hashicorp/terraform/version" + "github.com/zclconf/go-cty/cty" + + backendLocal "github.com/hashicorp/terraform/internal/backend/local" +) + +func TestCloud(t *testing.T) { + var _ backend.Enhanced = New(nil) + var _ backend.CLI = New(nil) +} + +func TestCloud_backendDefault(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + backend.TestBackendStates(t, b) + backend.TestBackendStateLocks(t, b, b) + backend.TestBackendStateForceUnlock(t, b, b) +} + +func TestCloud_backendNoDefault(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + backend.TestBackendStates(t, b) +} + +func TestCloud_config(t *testing.T) { + cases := map[string]struct { + config cty.Value + confErr string + valErr string + }{ + "with_a_nonexisting_organization": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("nonexisting"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + confErr: "organization \"nonexisting\" at host app.terraform.io not found", + }, + "with_an_unknown_host": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.StringVal("nonexisting.local"), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + confErr: "Failed to request discovery document", + }, + // localhost advertises TFE services, but has no token in the credentials + "without_a_token": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.StringVal("localhost"), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + confErr: "terraform login localhost", + }, + "with_a_name": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + }, + "with_a_prefix": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.StringVal("my-app-"), + }), + }), + }, + "without_either_a_name_and_a_prefix": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.NullVal(cty.String), + }), + }), + valErr: `Either workspace "name" or "prefix" is required`, + }, + "with_both_a_name_and_a_prefix": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.StringVal("my-app-"), + }), + }), + valErr: `Only one of workspace "name" or "prefix" is allowed`, + }, + "null config": { + config: cty.NullVal(cty.EmptyObject), + }, + } + + for name, tc := range cases { + s := testServer(t) + b := New(testDisco(s)) + + // Validate + _, valDiags := b.PrepareConfig(tc.config) + if (valDiags.Err() != nil || tc.valErr != "") && + (valDiags.Err() == nil || !strings.Contains(valDiags.Err().Error(), tc.valErr)) { + t.Fatalf("%s: unexpected validation result: %v", name, valDiags.Err()) + } + + // Configure + confDiags := b.Configure(tc.config) + if (confDiags.Err() != nil || tc.confErr != "") && + (confDiags.Err() == nil || !strings.Contains(confDiags.Err().Error(), tc.confErr)) { + t.Fatalf("%s: unexpected configure result: %v", name, confDiags.Err()) + } + } +} + +func TestCloud_versionConstraints(t *testing.T) { + cases := map[string]struct { + config cty.Value + prerelease string + version string + result string + }{ + "compatible version": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + version: "0.11.1", + }, + "version too old": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + version: "0.0.1", + result: "upgrade Terraform to >= 0.1.0", + }, + "version too new": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + version: "10.0.1", + result: "downgrade Terraform to <= 10.0.0", + }, + } + + // Save and restore the actual version. + p := tfversion.Prerelease + v := tfversion.Version + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + }() + + for name, tc := range cases { + s := testServer(t) + b := New(testDisco(s)) + + // Set the version for this test. + tfversion.Prerelease = tc.prerelease + tfversion.Version = tc.version + + // Validate + _, valDiags := b.PrepareConfig(tc.config) + if valDiags.HasErrors() { + t.Fatalf("%s: unexpected validation result: %v", name, valDiags.Err()) + } + + // Configure + confDiags := b.Configure(tc.config) + if (confDiags.Err() != nil || tc.result != "") && + (confDiags.Err() == nil || !strings.Contains(confDiags.Err().Error(), tc.result)) { + t.Fatalf("%s: unexpected configure result: %v", name, confDiags.Err()) + } + } +} + +func TestCloud_localBackend(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + local, ok := b.local.(*backendLocal.Local) + if !ok { + t.Fatalf("expected b.local to be \"*local.Local\", got: %T", b.local) + } + + cloud, ok := local.Backend.(*Cloud) + if !ok { + t.Fatalf("expected local.Backend to be *cloud.Cloud, got: %T", cloud) + } +} + +func TestCloud_addAndRemoveWorkspacesDefault(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + if _, err := b.Workspaces(); err != backend.ErrWorkspacesNotSupported { + t.Fatalf("expected error %v, got %v", backend.ErrWorkspacesNotSupported, err) + } + + if _, err := b.StateMgr(backend.DefaultStateName); err != nil { + t.Fatalf("expected no error, got %v", err) + } + + if _, err := b.StateMgr("prod"); err != backend.ErrWorkspacesNotSupported { + t.Fatalf("expected error %v, got %v", backend.ErrWorkspacesNotSupported, err) + } + + if err := b.DeleteWorkspace(backend.DefaultStateName); err != nil { + t.Fatalf("expected no error, got %v", err) + } + + if err := b.DeleteWorkspace("prod"); err != backend.ErrWorkspacesNotSupported { + t.Fatalf("expected error %v, got %v", backend.ErrWorkspacesNotSupported, err) + } +} + +func TestCloud_addAndRemoveWorkspacesNoDefault(t *testing.T) { + b, bCleanup := testBackendNoDefault(t) + defer bCleanup() + + states, err := b.Workspaces() + if err != nil { + t.Fatal(err) + } + + expectedWorkspaces := []string(nil) + if !reflect.DeepEqual(states, expectedWorkspaces) { + t.Fatalf("expected states %#+v, got %#+v", expectedWorkspaces, states) + } + + if _, err := b.StateMgr(backend.DefaultStateName); err != backend.ErrDefaultWorkspaceNotSupported { + t.Fatalf("expected error %v, got %v", backend.ErrDefaultWorkspaceNotSupported, err) + } + + expectedA := "test_A" + if _, err := b.StateMgr(expectedA); err != nil { + t.Fatal(err) + } + + states, err = b.Workspaces() + if err != nil { + t.Fatal(err) + } + + expectedWorkspaces = append(expectedWorkspaces, expectedA) + if !reflect.DeepEqual(states, expectedWorkspaces) { + t.Fatalf("expected %#+v, got %#+v", expectedWorkspaces, states) + } + + expectedB := "test_B" + if _, err := b.StateMgr(expectedB); err != nil { + t.Fatal(err) + } + + states, err = b.Workspaces() + if err != nil { + t.Fatal(err) + } + + expectedWorkspaces = append(expectedWorkspaces, expectedB) + if !reflect.DeepEqual(states, expectedWorkspaces) { + t.Fatalf("expected %#+v, got %#+v", expectedWorkspaces, states) + } + + if err := b.DeleteWorkspace(backend.DefaultStateName); err != backend.ErrDefaultWorkspaceNotSupported { + t.Fatalf("expected error %v, got %v", backend.ErrDefaultWorkspaceNotSupported, err) + } + + if err := b.DeleteWorkspace(expectedA); err != nil { + t.Fatal(err) + } + + states, err = b.Workspaces() + if err != nil { + t.Fatal(err) + } + + expectedWorkspaces = []string{expectedB} + if !reflect.DeepEqual(states, expectedWorkspaces) { + t.Fatalf("expected %#+v got %#+v", expectedWorkspaces, states) + } + + if err := b.DeleteWorkspace(expectedB); err != nil { + t.Fatal(err) + } + + states, err = b.Workspaces() + if err != nil { + t.Fatal(err) + } + + expectedWorkspaces = []string(nil) + if !reflect.DeepEqual(states, expectedWorkspaces) { + t.Fatalf("expected %#+v, got %#+v", expectedWorkspaces, states) + } +} + +func TestCloud_checkConstraints(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + cases := map[string]struct { + constraints *disco.Constraints + prerelease string + version string + result string + }{ + "compatible version": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Maximum: "0.11.11", + }, + version: "0.11.1", + result: "", + }, + "version too old": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Maximum: "0.11.11", + }, + version: "0.10.1", + result: "upgrade Terraform to >= 0.11.0", + }, + "version too new": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Maximum: "0.11.11", + }, + version: "0.12.0", + result: "downgrade Terraform to <= 0.11.11", + }, + "version excluded - ordered": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Excluding: []string{"0.11.7", "0.11.8"}, + Maximum: "0.11.11", + }, + version: "0.11.7", + result: "upgrade Terraform to > 0.11.8", + }, + "version excluded - unordered": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Excluding: []string{"0.11.8", "0.11.6"}, + Maximum: "0.11.11", + }, + version: "0.11.6", + result: "upgrade Terraform to > 0.11.8", + }, + "list versions": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Maximum: "0.11.11", + }, + version: "0.10.1", + result: "versions >= 0.11.0, <= 0.11.11.", + }, + "list exclusion": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Excluding: []string{"0.11.6"}, + Maximum: "0.11.11", + }, + version: "0.11.6", + result: "excluding version 0.11.6.", + }, + "list exclusions": { + constraints: &disco.Constraints{ + Minimum: "0.11.0", + Excluding: []string{"0.11.8", "0.11.6"}, + Maximum: "0.11.11", + }, + version: "0.11.6", + result: "excluding versions 0.11.6, 0.11.8.", + }, + } + + // Save and restore the actual version. + p := tfversion.Prerelease + v := tfversion.Version + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + }() + + for name, tc := range cases { + // Set the version for this test. + tfversion.Prerelease = tc.prerelease + tfversion.Version = tc.version + + // Check the constraints. + diags := b.checkConstraints(tc.constraints) + if (diags.Err() != nil || tc.result != "") && + (diags.Err() == nil || !strings.Contains(diags.Err().Error(), tc.result)) { + t.Fatalf("%s: unexpected constraints result: %v", name, diags.Err()) + } + } +} + +func TestCloud_StateMgr_versionCheck(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + // Some fixed versions for testing with. This logic is a simple string + // comparison, so we don't need many test cases. + v0135 := version.Must(version.NewSemver("0.13.5")) + v0140 := version.Must(version.NewSemver("0.14.0")) + + // Save original local version state and restore afterwards + p := tfversion.Prerelease + v := tfversion.Version + s := tfversion.SemVer + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + tfversion.SemVer = s + }() + + // For this test, the local Terraform version is set to 0.14.0 + tfversion.Prerelease = "" + tfversion.Version = v0140.String() + tfversion.SemVer = v0140 + + // Update the mock remote workspace Terraform version to match the local + // Terraform version + if _, err := b.client.Workspaces.Update( + context.Background(), + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + TerraformVersion: tfe.String(v0140.String()), + }, + ); err != nil { + t.Fatalf("error: %v", err) + } + + // This should succeed + if _, err := b.StateMgr(backend.DefaultStateName); err != nil { + t.Fatalf("expected no error, got %v", err) + } + + // Now change the remote workspace to a different Terraform version + if _, err := b.client.Workspaces.Update( + context.Background(), + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + TerraformVersion: tfe.String(v0135.String()), + }, + ); err != nil { + t.Fatalf("error: %v", err) + } + + // This should fail + want := `Remote workspace Terraform version "0.13.5" does not match local Terraform version "0.14.0"` + if _, err := b.StateMgr(backend.DefaultStateName); err.Error() != want { + t.Fatalf("wrong error\n got: %v\nwant: %v", err.Error(), want) + } +} + +func TestCloud_StateMgr_versionCheckLatest(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + v0140 := version.Must(version.NewSemver("0.14.0")) + + // Save original local version state and restore afterwards + p := tfversion.Prerelease + v := tfversion.Version + s := tfversion.SemVer + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + tfversion.SemVer = s + }() + + // For this test, the local Terraform version is set to 0.14.0 + tfversion.Prerelease = "" + tfversion.Version = v0140.String() + tfversion.SemVer = v0140 + + // Update the remote workspace to the pseudo-version "latest" + if _, err := b.client.Workspaces.Update( + context.Background(), + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + TerraformVersion: tfe.String("latest"), + }, + ); err != nil { + t.Fatalf("error: %v", err) + } + + // This should succeed despite not being a string match + if _, err := b.StateMgr(backend.DefaultStateName); err != nil { + t.Fatalf("expected no error, got %v", err) + } +} + +func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { + testCases := []struct { + local string + remote string + operations bool + wantErr bool + }{ + {"0.13.5", "0.13.5", true, false}, + {"0.14.0", "0.13.5", true, true}, + {"0.14.0", "0.13.5", false, false}, + {"0.14.0", "0.14.1", true, false}, + {"0.14.0", "1.0.99", true, false}, + {"0.14.0", "1.1.0", true, true}, + {"1.2.0", "1.2.99", true, false}, + {"1.2.0", "1.3.0", true, true}, + {"0.15.0", "latest", true, false}, + } + for _, tc := range testCases { + t.Run(fmt.Sprintf("local %s, remote %s", tc.local, tc.remote), func(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + local := version.Must(version.NewSemver(tc.local)) + + // Save original local version state and restore afterwards + p := tfversion.Prerelease + v := tfversion.Version + s := tfversion.SemVer + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + tfversion.SemVer = s + }() + + // Override local version as specified + tfversion.Prerelease = "" + tfversion.Version = local.String() + tfversion.SemVer = local + + // Update the mock remote workspace Terraform version to the + // specified remote version + if _, err := b.client.Workspaces.Update( + context.Background(), + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + Operations: tfe.Bool(tc.operations), + TerraformVersion: tfe.String(tc.remote), + }, + ); err != nil { + t.Fatalf("error: %v", err) + } + + diags := b.VerifyWorkspaceTerraformVersion(backend.DefaultStateName) + if tc.wantErr { + if len(diags) != 1 { + t.Fatal("expected diag, but none returned") + } + if got := diags.Err().Error(); !strings.Contains(got, "Terraform version mismatch") { + t.Fatalf("unexpected error: %s", got) + } + } else { + if len(diags) != 0 { + t.Fatalf("unexpected diags: %s", diags.Err()) + } + } + }) + } +} + +func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + // Attempting to check the version against a workspace which doesn't exist + // should result in no errors + diags := b.VerifyWorkspaceTerraformVersion("invalid-workspace") + if len(diags) != 0 { + t.Fatalf("unexpected error: %s", diags.Err()) + } + + // Use a special workspace ID to trigger a 500 error, which should result + // in a failed check + diags = b.VerifyWorkspaceTerraformVersion("network-error") + if len(diags) != 1 { + t.Fatal("expected diag, but none returned") + } + if got := diags.Err().Error(); !strings.Contains(got, "Error looking up workspace: Workspace read failed") { + t.Fatalf("unexpected error: %s", got) + } + + // Update the mock remote workspace Terraform version to an invalid version + if _, err := b.client.Workspaces.Update( + context.Background(), + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + TerraformVersion: tfe.String("1.0.cheetarah"), + }, + ); err != nil { + t.Fatalf("error: %v", err) + } + diags = b.VerifyWorkspaceTerraformVersion(backend.DefaultStateName) + + if len(diags) != 1 { + t.Fatal("expected diag, but none returned") + } + if got := diags.Err().Error(); !strings.Contains(got, "Error looking up workspace: Invalid Terraform version") { + t.Fatalf("unexpected error: %s", got) + } +} + +func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + // If the ignore flag is set, the behaviour changes + b.IgnoreVersionConflict() + + // Different local & remote versions to cause an error + local := version.Must(version.NewSemver("0.14.0")) + remote := version.Must(version.NewSemver("0.13.5")) + + // Save original local version state and restore afterwards + p := tfversion.Prerelease + v := tfversion.Version + s := tfversion.SemVer + defer func() { + tfversion.Prerelease = p + tfversion.Version = v + tfversion.SemVer = s + }() + + // Override local version as specified + tfversion.Prerelease = "" + tfversion.Version = local.String() + tfversion.SemVer = local + + // Update the mock remote workspace Terraform version to the + // specified remote version + if _, err := b.client.Workspaces.Update( + context.Background(), + b.organization, + b.workspace, + tfe.WorkspaceUpdateOptions{ + TerraformVersion: tfe.String(remote.String()), + }, + ); err != nil { + t.Fatalf("error: %v", err) + } + + diags := b.VerifyWorkspaceTerraformVersion(backend.DefaultStateName) + if len(diags) != 1 { + t.Fatal("expected diag, but none returned") + } + + if got, want := diags[0].Severity(), tfdiags.Warning; got != want { + t.Errorf("wrong severity: got %#v, want %#v", got, want) + } + if got, want := diags[0].Description().Summary, "Terraform version mismatch"; got != want { + t.Errorf("wrong summary: got %s, want %s", got, want) + } + wantDetail := "The local Terraform version (0.14.0) does not match the configured version for remote workspace hashicorp/prod (0.13.5)." + if got := diags[0].Description().Detail; got != wantDetail { + t.Errorf("wrong summary: got %s, want %s", got, wantDetail) + } +} diff --git a/internal/cloud/remote_test.go b/internal/cloud/remote_test.go new file mode 100644 index 000000000000..b0c44d60a830 --- /dev/null +++ b/internal/cloud/remote_test.go @@ -0,0 +1,25 @@ +package cloud + +import ( + "flag" + "os" + "testing" + "time" + + _ "github.com/hashicorp/terraform/internal/logging" +) + +func TestMain(m *testing.M) { + flag.Parse() + + // Make sure TF_FORCE_LOCAL_BACKEND is unset + os.Unsetenv("TF_FORCE_LOCAL_BACKEND") + + // Reduce delays to make tests run faster + backoffMin = 1.0 + backoffMax = 1.0 + planConfigurationVersionsPollInterval = 1 * time.Millisecond + runPollInterval = 1 * time.Millisecond + + os.Exit(m.Run()) +} diff --git a/internal/cloud/testdata/apply-destroy/main.tf b/internal/cloud/testdata/apply-destroy/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/apply-destroy/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/apply-no-changes/main.tf b/internal/cloud/testdata/apply-no-changes/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/apply-no-changes/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/apply-policy-hard-failed/main.tf b/internal/cloud/testdata/apply-policy-hard-failed/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/apply-policy-hard-failed/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/apply-policy-passed/main.tf b/internal/cloud/testdata/apply-policy-passed/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/apply-policy-passed/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/apply-policy-soft-failed/main.tf b/internal/cloud/testdata/apply-policy-soft-failed/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/apply-policy-soft-failed/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/apply-variables/main.tf b/internal/cloud/testdata/apply-variables/main.tf new file mode 100644 index 000000000000..955e8b4c09af --- /dev/null +++ b/internal/cloud/testdata/apply-variables/main.tf @@ -0,0 +1,4 @@ +variable "foo" {} +variable "bar" {} + +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/apply-with-error/main.tf b/internal/cloud/testdata/apply-with-error/main.tf new file mode 100644 index 000000000000..bc45f28f5637 --- /dev/null +++ b/internal/cloud/testdata/apply-with-error/main.tf @@ -0,0 +1,5 @@ +resource "null_resource" "foo" { + triggers { + random = "${guid()}" + } +} diff --git a/internal/cloud/testdata/apply/main.tf b/internal/cloud/testdata/apply/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/apply/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/empty/.gitignore b/internal/cloud/testdata/empty/.gitignore new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/internal/cloud/testdata/plan-cost-estimation/main.tf b/internal/cloud/testdata/plan-cost-estimation/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan-cost-estimation/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan-long-line/main.tf b/internal/cloud/testdata/plan-long-line/main.tf new file mode 100644 index 000000000000..0a8d623a9d67 --- /dev/null +++ b/internal/cloud/testdata/plan-long-line/main.tf @@ -0,0 +1,5 @@ +resource "null_resource" "foo" { + triggers { + long_line = "[{'_id':'5c5ab0ed7de45e993ffb9eeb','index':0,'guid':'e734d772-6b5a-4cb0-805c-91cd5e560e20','isActive':false,'balance':'$1,472.03','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Darlene','last':'Garza'},'company':'GEEKOSIS','email':'darlene.garza@geekosis.io','phone':'+1 (850) 506-3347','address':'165 Kiely Place, Como, New Mexico, 4335','about':'Officia ullamco et sunt magna voluptate culpa cupidatat ea tempor laboris cupidatat ea anim laboris. Minim enim quis enim esse laborum est veniam. Lorem excepteur elit Lorem cupidatat elit ea anim irure fugiat fugiat sunt mollit. Consectetur ad nulla dolor amet esse occaecat aliquip sit. Magna sit elit adipisicing ut reprehenderit anim exercitation sit quis ea pariatur Lorem magna dolore.','registered':'Wednesday, March 11, 2015 12:58 PM','latitude':'20.729127','longitude':'-127.343593','tags':['minim','in','deserunt','occaecat','fugiat'],'greeting':'Hello, Darlene! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eda9117d15f1c1f112','index':1,'guid':'f0d1eed2-c6a9-4535-8800-d4bd53fe7eee','isActive':true,'balance':'$2,901.90','picture':'http://placehold.it/32x32','age':28,'eyeColor':'brown','name':{'first':'Flora','last':'Short'},'company':'SIGNITY','email':'flora.short@signity.me','phone':'+1 (840) 520-2666','address':'636 Johnson Avenue, Gerber, Wisconsin, 9139','about':'Veniam dolore deserunt Lorem aliqua qui eiusmod. Amet tempor fugiat duis incididunt amet adipisicing. Id ea nisi veniam eiusmod.','registered':'Wednesday, May 2, 2018 5:59 AM','latitude':'-63.267612','longitude':'4.224102','tags':['veniam','incididunt','id','aliqua','reprehenderit'],'greeting':'Hello, Flora! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed83fd574d8041fa16','index':2,'guid':'29499a07-414a-436f-ba62-6634ca16bdcc','isActive':true,'balance':'$2,781.28','picture':'http://placehold.it/32x32','age':22,'eyeColor':'green','name':{'first':'Trevino','last':'Marks'},'company':'KEGULAR','email':'trevino.marks@kegular.com','phone':'+1 (843) 571-2269','address':'200 Alabama Avenue, Grenelefe, Florida, 7963','about':'Occaecat nisi exercitation Lorem mollit laborum magna adipisicing culpa dolor proident dolore. Non consequat ea amet et id mollit incididunt minim anim amet nostrud labore tempor. Proident eu sint commodo nisi consequat voluptate do fugiat proident. Laboris eiusmod veniam non et elit nulla nisi labore incididunt Lorem consequat consectetur voluptate.','registered':'Saturday, January 25, 2014 5:56 AM','latitude':'65.044005','longitude':'-127.454864','tags':['anim','duis','velit','pariatur','enim'],'greeting':'Hello, Trevino! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed784eb6e350ff0a07','index':3,'guid':'40ed47e2-1747-4665-ab59-cdb3630a7642','isActive':true,'balance':'$2,000.78','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Solis','last':'Mckinney'},'company':'QABOOS','email':'solis.mckinney@qaboos.org','phone':'+1 (924) 405-2560','address':'712 Herkimer Court, Klondike, Ohio, 8133','about':'Minim ad anim minim tempor mollit magna tempor et non commodo amet. Nisi cupidatat labore culpa consectetur exercitation laborum adipisicing fugiat officia adipisicing consequat non. Qui voluptate tempor laboris exercitation qui non adipisicing occaecat voluptate sunt do nostrud velit. Consequat tempor officia laboris tempor irure cupidatat aliquip voluptate nostrud velit ex nulla tempor laboris. Qui pariatur pariatur enim aliquip velit. Officia mollit ullamco laboris velit velit eiusmod enim amet incididunt consectetur sunt.','registered':'Wednesday, April 12, 2017 6:59 AM','latitude':'-25.055596','longitude':'-140.126525','tags':['ipsum','adipisicing','amet','nulla','dolore'],'greeting':'Hello, Solis! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed02ce1ea9a2155d51','index':4,'guid':'1b5fb7d3-3b9a-4382-81b5-9ab01a27e74b','isActive':true,'balance':'$1,373.67','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Janell','last':'Battle'},'company':'GEEKMOSIS','email':'janell.battle@geekmosis.net','phone':'+1 (810) 591-3014','address':'517 Onderdonk Avenue, Shrewsbury, District Of Columbia, 2335','about':'Reprehenderit ad proident do anim qui officia magna magna duis cillum esse minim est. Excepteur ipsum anim ad laboris. In occaecat dolore nulla ea Lorem tempor et culpa in sint. Officia eu eu incididunt sit amet. Culpa duis id reprehenderit ut anim sit sunt. Duis dolore proident velit incididunt adipisicing pariatur fugiat incididunt eiusmod eu veniam irure.','registered':'Thursday, February 8, 2018 1:44 AM','latitude':'-33.254864','longitude':'-154.145885','tags':['aute','deserunt','ipsum','eiusmod','laborum'],'greeting':'Hello, Janell! You have 5 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edab58604bd7d3dd1c','index':5,'guid':'6354c035-af22-44c9-8be9-b2ea9decc24d','isActive':true,'balance':'$3,535.68','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Combs','last':'Kirby'},'company':'LUXURIA','email':'combs.kirby@luxuria.name','phone':'+1 (900) 498-3266','address':'377 Kingsland Avenue, Ruckersville, Maine, 9916','about':'Lorem duis ipsum pariatur aliquip sunt. Commodo esse laborum incididunt mollit quis est laboris ea ea quis fugiat. Enim elit ullamco velit et fugiat veniam irure deserunt aliqua ad irure veniam.','registered':'Tuesday, February 21, 2017 4:04 PM','latitude':'-70.20591','longitude':'162.546871','tags':['reprehenderit','est','enim','aute','ad'],'greeting':'Hello, Combs! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edf7fafeffc6357c51','index':6,'guid':'02523e0b-cc90-4309-b6b2-f493dc6076f6','isActive':false,'balance':'$3,754.30','picture':'http://placehold.it/32x32','age':29,'eyeColor':'green','name':{'first':'Macias','last':'Calderon'},'company':'AMTAP','email':'macias.calderon@amtap.us','phone':'+1 (996) 569-3667','address':'305 Royce Street, Glidden, Iowa, 9248','about':'Exercitation nulla deserunt pariatur adipisicing. In commodo deserunt incididunt ut velit minim qui ut quis. Labore elit ullamco eiusmod voluptate in eu do est fugiat aute mollit deserunt. Eu duis proident velit fugiat velit ut. Ut non esse amet laborum nisi tempor in nulla.','registered':'Thursday, October 23, 2014 10:28 PM','latitude':'32.371629','longitude':'60.155135','tags':['commodo','elit','velit','excepteur','aliqua'],'greeting':'Hello, Macias! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed0e8a6109e7fabf17','index':7,'guid':'675ff6b6-197b-4154-9775-813d661df822','isActive':false,'balance':'$2,850.62','picture':'http://placehold.it/32x32','age':37,'eyeColor':'green','name':{'first':'Stefanie','last':'Rivers'},'company':'RECRITUBE','email':'stefanie.rivers@recritube.biz','phone':'+1 (994) 591-3551','address':'995 Campus Road, Abrams, Virginia, 3251','about':'Esse aute non laborum Lorem nulla irure. Veniam elit aute ut et dolor non deserunt laboris tempor. Ipsum quis cupidatat laborum laboris voluptate esse duis eiusmod excepteur consectetur commodo ullamco qui occaecat. Culpa velit cillum occaecat minim nisi.','registered':'Thursday, June 9, 2016 3:40 PM','latitude':'-18.526825','longitude':'149.670782','tags':['occaecat','sunt','reprehenderit','ipsum','magna'],'greeting':'Hello, Stefanie! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edf7d9bc2db4e476e3','index':8,'guid':'adaefc55-f6ea-4bd1-a147-0e31c3ce7a21','isActive':true,'balance':'$2,555.13','picture':'http://placehold.it/32x32','age':20,'eyeColor':'blue','name':{'first':'Hillary','last':'Lancaster'},'company':'OLUCORE','email':'hillary.lancaster@olucore.ca','phone':'+1 (964) 474-3018','address':'232 Berriman Street, Kaka, Massachusetts, 6792','about':'Veniam ad laboris quis reprehenderit aliquip nisi sunt excepteur ea aute laborum excepteur incididunt. Nisi exercitation aliquip do culpa commodo ex officia ut enim mollit in deserunt in amet. Anim eu deserunt dolore non cupidatat ut enim incididunt aute dolore voluptate. Do cillum mollit laborum non incididunt occaecat aute voluptate nisi irure.','registered':'Thursday, June 4, 2015 9:45 PM','latitude':'88.075919','longitude':'-148.951368','tags':['reprehenderit','veniam','ad','aute','anim'],'greeting':'Hello, Hillary! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed7b7192ad6a0f267c','index':9,'guid':'0ca9b8ea-f671-474e-be26-4a49cae4838a','isActive':true,'balance':'$3,684.51','picture':'http://placehold.it/32x32','age':40,'eyeColor':'brown','name':{'first':'Jill','last':'Conner'},'company':'EXOZENT','email':'jill.conner@exozent.info','phone':'+1 (887) 467-2168','address':'751 Thames Street, Juarez, American Samoa, 8386','about':'Enim voluptate et non est in magna laborum aliqua enim aliqua est non nostrud. Tempor est nulla ipsum consectetur esse nostrud est id. Consequat do voluptate cupidatat eu fugiat et fugiat velit id. Sint dolore ad qui tempor anim eu amet consectetur do elit aute adipisicing consequat ex.','registered':'Sunday, October 22, 2017 7:35 AM','latitude':'84.384911','longitude':'40.305648','tags':['tempor','sint','irure','et','ex'],'greeting':'Hello, Jill! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed713fe676575aa72b','index':10,'guid':'c28023cf-cc57-4c2e-8d91-dfbe6bafadcd','isActive':false,'balance':'$2,792.45','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Hurley','last':'George'},'company':'ZAJ','email':'hurley.george@zaj.tv','phone':'+1 (984) 547-3284','address':'727 Minna Street, Lacomb, Colorado, 2557','about':'Ex velit cupidatat veniam culpa. Eiusmod ut fugiat adipisicing incididunt consectetur exercitation Lorem exercitation ex. Incididunt anim aute incididunt fugiat cupidatat qui eu non reprehenderit. Eiusmod dolor nisi culpa excepteur ut velit minim dolor voluptate amet commodo culpa in.','registered':'Thursday, February 16, 2017 6:41 AM','latitude':'25.989949','longitude':'10.200053','tags':['minim','ut','sunt','consequat','ullamco'],'greeting':'Hello, Hurley! You have 8 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1e56732746c70d8b','index':11,'guid':'e9766f13-766c-4450-b4d2-8b04580f60b7','isActive':true,'balance':'$3,874.26','picture':'http://placehold.it/32x32','age':35,'eyeColor':'green','name':{'first':'Leticia','last':'Pace'},'company':'HONOTRON','email':'leticia.pace@honotron.co.uk','phone':'+1 (974) 536-3322','address':'365 Goodwin Place, Savage, Nevada, 9191','about':'Nisi Lorem aliqua esse eiusmod magna. Ad minim incididunt proident ut Lorem cupidatat qui velit aliqua ullamco et ipsum in. Aliquip elit consectetur pariatur esse exercitation et officia quis. Occaecat tempor proident cillum anim ad commodo velit ut voluptate. Tempor et occaecat sit sint aliquip tempor nulla velit magna nisi proident exercitation Lorem id.','registered':'Saturday, August 4, 2018 5:05 AM','latitude':'70.620386','longitude':'-86.335813','tags':['occaecat','velit','labore','laboris','esse'],'greeting':'Hello, Leticia! You have 8 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed941337fe42f47426','index':12,'guid':'6d390762-17ea-4b58-9a36-b0c9a8748a42','isActive':true,'balance':'$1,049.61','picture':'http://placehold.it/32x32','age':38,'eyeColor':'green','name':{'first':'Rose','last':'Humphrey'},'company':'MYOPIUM','email':'rose.humphrey@myopium.io','phone':'+1 (828) 426-3086','address':'389 Sapphire Street, Saticoy, Marshall Islands, 1423','about':'Aliquip enim excepteur adipisicing ex. Consequat aliqua consequat nostrud do occaecat deserunt excepteur sit et ipsum sunt dolor eu. Dolore laborum commodo excepteur tempor ad adipisicing proident excepteur magna non Lorem proident consequat aute. Fugiat minim consequat occaecat voluptate esse velit officia laboris nostrud nisi ut voluptate.','registered':'Monday, April 16, 2018 12:38 PM','latitude':'-47.083742','longitude':'109.022423','tags':['aute','non','sit','adipisicing','mollit'],'greeting':'Hello, Rose! You have 9 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd0c02fc3fdc01a40','index':13,'guid':'07755618-6fdf-4b33-af50-364c18909227','isActive':true,'balance':'$1,823.61','picture':'http://placehold.it/32x32','age':36,'eyeColor':'green','name':{'first':'Judith','last':'Hale'},'company':'COLLAIRE','email':'judith.hale@collaire.me','phone':'+1 (922) 508-2843','address':'193 Coffey Street, Castleton, North Dakota, 3638','about':'Minim non ullamco ad anim nostrud dolore nostrud veniam consequat id eiusmod veniam laboris. Lorem irure esse mollit non velit aute id cupidatat est mollit occaecat magna excepteur. Adipisicing tempor nisi sit aliquip tempor pariatur tempor eu consectetur nulla amet nulla. Quis nisi nisi ea incididunt culpa et do. Esse officia eu pariatur velit sunt quis proident amet consectetur consequat. Nisi excepteur culpa nulla sit dolor deserunt excepteur dolor consequat elit cillum tempor Lorem.','registered':'Wednesday, August 24, 2016 12:29 AM','latitude':'-80.15514','longitude':'39.91007','tags':['consectetur','incididunt','aliquip','dolor','consequat'],'greeting':'Hello, Judith! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edb3e1e29caa4f728b','index':14,'guid':'2c6617a2-e7a9-4ff7-a8b9-e99554fe70fe','isActive':true,'balance':'$1,971.00','picture':'http://placehold.it/32x32','age':39,'eyeColor':'blue','name':{'first':'Estes','last':'Sweet'},'company':'GEEKKO','email':'estes.sweet@geekko.com','phone':'+1 (866) 448-3032','address':'847 Cove Lane, Kula, Mississippi, 9178','about':'Veniam consectetur occaecat est excepteur consequat ipsum cillum sit consectetur. Ut cupidatat et reprehenderit dolore enim do cillum qui pariatur ad laborum incididunt esse. Fugiat sunt dolor veniam laboris ipsum deserunt proident reprehenderit laboris non nostrud. Magna excepteur sint magna laborum tempor sit exercitation ipsum labore est ullamco ullamco. Cillum voluptate cillum ea laborum Lorem. Excepteur sint ut nisi est esse non. Minim excepteur ullamco velit nisi ut in elit exercitation ut dolore.','registered':'Sunday, August 12, 2018 5:06 PM','latitude':'-9.57771','longitude':'-159.94577','tags':['culpa','dolor','velit','anim','pariatur'],'greeting':'Hello, Estes! You have 7 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edbcf088c6fd593091','index':15,'guid':'2cc79958-1b40-4e2c-907a-433903fd3da9','isActive':false,'balance':'$3,751.53','picture':'http://placehold.it/32x32','age':34,'eyeColor':'brown','name':{'first':'Kemp','last':'Spence'},'company':'EXOBLUE','email':'kemp.spence@exoblue.org','phone':'+1 (864) 487-2992','address':'217 Clay Street, Monument, North Carolina, 1460','about':'Nostrud duis cillum sint non commodo dolor aute aliqua adipisicing ad nulla non excepteur proident. Fugiat labore elit tempor cillum veniam reprehenderit laboris consectetur dolore amet qui cupidatat. Amet aliqua elit anim et consequat commodo excepteur officia anim aliqua ea eu labore cillum. Et ex dolor duis dolore commodo veniam et nisi.','registered':'Monday, October 29, 2018 5:23 AM','latitude':'-70.304222','longitude':'83.582371','tags':['velit','duis','consequat','incididunt','duis'],'greeting':'Hello, Kemp! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed6400479feb3de505','index':16,'guid':'91ccae6d-a3ea-43cf-bb00-3f2729256cc9','isActive':false,'balance':'$2,477.79','picture':'http://placehold.it/32x32','age':40,'eyeColor':'blue','name':{'first':'Ronda','last':'Burris'},'company':'EQUITOX','email':'ronda.burris@equitox.net','phone':'+1 (817) 553-3228','address':'708 Lawton Street, Deputy, Wyoming, 8598','about':'Excepteur voluptate aliquip consequat cillum est duis sit cillum eu eiusmod et laborum ullamco. Et minim reprehenderit aute voluptate amet ullamco. Amet sit enim ad irure deserunt nostrud anim veniam consequat dolor commodo. Consequat do occaecat do exercitation ullamco dolor ut. Id laboris consequat est dolor dolore tempor ullamco anim do ut nulla deserunt labore. Mollit ex Lorem ullamco mollit.','registered':'Monday, April 23, 2018 5:27 PM','latitude':'-31.227208','longitude':'0.63785','tags':['ipsum','magna','consectetur','sit','irure'],'greeting':'Hello, Ronda! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eddbeab2e53e04d563','index':17,'guid':'a86d4eb6-6bd8-48c2-a8fc-1c933c835852','isActive':false,'balance':'$3,709.03','picture':'http://placehold.it/32x32','age':37,'eyeColor':'blue','name':{'first':'Rosario','last':'Dillard'},'company':'BARKARAMA','email':'rosario.dillard@barkarama.name','phone':'+1 (933) 525-3898','address':'730 Chauncey Street, Forbestown, South Carolina, 6894','about':'Est eu fugiat aliquip ea ad qui ad mollit ad tempor voluptate et incididunt reprehenderit. Incididunt fugiat commodo minim adipisicing culpa consectetur duis eu ut commodo consequat voluptate labore. Nostrud irure labore adipisicing irure quis magna consequat dolor Lorem sint enim. Sint excepteur eu dolore elit ut do mollit sunt enim est. Labore id nostrud sint Lorem esse nostrud.','registered':'Friday, December 25, 2015 8:59 PM','latitude':'37.440827','longitude':'44.580474','tags':['Lorem','sit','ipsum','ea','ut'],'greeting':'Hello, Rosario! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eddf8e9b9c031d04e8','index':18,'guid':'a96f997c-daf8-40d4-92e1-be07e2cf0f60','isActive':false,'balance':'$1,878.37','picture':'http://placehold.it/32x32','age':37,'eyeColor':'brown','name':{'first':'Sondra','last':'Gonzales'},'company':'XUMONK','email':'sondra.gonzales@xumonk.us','phone':'+1 (838) 560-2255','address':'230 Cox Place, Geyserville, Georgia, 6805','about':'Laborum sunt voluptate ea laboris nostrud. Amet deserunt aliqua Lorem voluptate velit deserunt occaecat minim ullamco. Lorem occaecat sit labore adipisicing ad magna mollit labore ullamco proident. Ea velit do proident fugiat esse commodo ex nostrud eu mollit pariatur. Labore laborum qui voluptate quis proident reprehenderit tempor dolore duis deserunt esse aliqua aliquip. Non veniam enim pariatur cupidatat ipsum dolore est reprehenderit. Non exercitation adipisicing proident magna elit occaecat non magna.','registered':'Sunday, June 26, 2016 4:02 AM','latitude':'62.247742','longitude':'-44.90666','tags':['ea','aute','in','voluptate','magna'],'greeting':'Hello, Sondra! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed2c1bcd06781f677e','index':19,'guid':'6ac47a16-eed4-4460-92ee-e0dd33c1fbb5','isActive':false,'balance':'$3,730.64','picture':'http://placehold.it/32x32','age':20,'eyeColor':'brown','name':{'first':'Anastasia','last':'Vega'},'company':'FIREWAX','email':'anastasia.vega@firewax.biz','phone':'+1 (867) 493-3698','address':'803 Arlington Avenue, Rosburg, Northern Mariana Islands, 8769','about':'Sint ex nisi tempor sunt voluptate non et eiusmod irure. Aute reprehenderit dolor mollit aliqua Lorem voluptate occaecat. Sint laboris deserunt Lorem incididunt nulla cupidatat do.','registered':'Friday, March 18, 2016 12:02 PM','latitude':'-32.010216','longitude':'-87.874753','tags':['aliquip','mollit','mollit','ad','laborum'],'greeting':'Hello, Anastasia! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed727fd645854bbf43','index':20,'guid':'67bd8cdb-ce6b-455c-944c-a80e17c6fa75','isActive':true,'balance':'$2,868.06','picture':'http://placehold.it/32x32','age':29,'eyeColor':'green','name':{'first':'Lucinda','last':'Cox'},'company':'ENDIPINE','email':'lucinda.cox@endipine.ca','phone':'+1 (990) 428-3002','address':'412 Thatford Avenue, Lafferty, New Jersey, 5271','about':'Esse nulla sunt ut consequat aute mollit. Est occaecat sunt nisi irure id anim est commodo. Elit mollit amet dolore sunt adipisicing ea laborum quis ea reprehenderit non consequat dolore. Minim sunt occaecat quis aute commodo dolore quis commodo proident. Sunt sint duis ullamco sit ea esse Lorem. Consequat pariatur eiusmod laboris adipisicing labore in laboris adipisicing adipisicing consequat aute ea et.','registered':'Friday, May 1, 2015 10:16 PM','latitude':'-14.200957','longitude':'-82.211386','tags':['do','sit','qui','officia','aliquip'],'greeting':'Hello, Lucinda! You have 9 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed5a97284eb2cbd3a8','index':21,'guid':'f9fc999d-515c-4fc4-b339-76300e1b4bf2','isActive':true,'balance':'$1,172.57','picture':'http://placehold.it/32x32','age':35,'eyeColor':'brown','name':{'first':'Conrad','last':'Bradley'},'company':'FUELWORKS','email':'conrad.bradley@fuelworks.info','phone':'+1 (956) 561-3226','address':'685 Fenimore Street, Esmont, Maryland, 7523','about':'Labore reprehenderit anim nisi sunt do nisi in. Est anim cillum id minim exercitation ullamco voluptate ipsum eu. Elit culpa consequat reprehenderit laborum in eu. Laboris amet voluptate laboris qui voluptate duis minim reprehenderit. Commodo sunt irure dolore sunt occaecat velit nisi eu minim minim.','registered':'Wednesday, January 18, 2017 11:13 PM','latitude':'31.665993','longitude':'38.868968','tags':['excepteur','exercitation','est','nisi','mollit'],'greeting':'Hello, Conrad! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edc4eaf6f760c38218','index':22,'guid':'8794ef5f-da2f-46f0-a755-c18a16409fd5','isActive':false,'balance':'$3,594.73','picture':'http://placehold.it/32x32','age':27,'eyeColor':'blue','name':{'first':'Marquez','last':'Vargas'},'company':'MALATHION','email':'marquez.vargas@malathion.tv','phone':'+1 (976) 438-3126','address':'296 Hall Street, National, Texas, 2067','about':'Proident cillum aute minim fugiat sunt aliqua non occaecat est duis id id tempor. Qui deserunt nisi amet pariatur proident eu laboris esse adipisicing magna. Anim anim mollit aute non magna nisi aute magna labore ullamco reprehenderit voluptate et ad. Proident adipisicing aute eiusmod nostrud nostrud deserunt culpa. Elit eu ullamco nisi aliqua dolor sint pariatur excepteur sit consectetur tempor. Consequat Lorem ullamco commodo veniam qui sint magna. Sit mollit ad aliquip est id eu officia id adipisicing duis ad.','registered':'Tuesday, November 17, 2015 6:16 PM','latitude':'-36.443667','longitude':'22.336776','tags':['aliquip','veniam','ipsum','Lorem','ex'],'greeting':'Hello, Marquez! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edd7c718518ee0466a','index':23,'guid':'ad8781a2-059e-4288-9879-309d53a99bf5','isActive':true,'balance':'$3,570.68','picture':'http://placehold.it/32x32','age':21,'eyeColor':'brown','name':{'first':'Snider','last':'Frost'},'company':'ZILODYNE','email':'snider.frost@zilodyne.co.uk','phone':'+1 (913) 485-3275','address':'721 Lincoln Road, Richmond, Utah, 672','about':'Minim enim Lorem esse incididunt do reprehenderit velit laborum ullamco. In aute eiusmod esse aliqua et labore tempor sunt ex mollit veniam tempor. Nulla elit cillum qui ullamco dolore amet deserunt magna amet laborum.','registered':'Saturday, August 23, 2014 12:58 AM','latitude':'-88.682554','longitude':'74.063179','tags':['nulla','ea','sint','aliquip','duis'],'greeting':'Hello, Snider! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edf026fece8e2c0970','index':24,'guid':'1b7d81e1-1dba-4322-bb1a-eaa6a24cccea','isActive':false,'balance':'$2,037.91','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Snyder','last':'Fletcher'},'company':'COMTEST','email':'snyder.fletcher@comtest.io','phone':'+1 (830) 538-3860','address':'221 Lewis Place, Zortman, Idaho, 572','about':'Elit anim enim esse dolore exercitation. Laboris esse sint adipisicing fugiat sint do occaecat ut voluptate sint nulla. Ad sint ut reprehenderit nostrud irure id consectetur officia velit consequat.','registered':'Sunday, January 1, 2017 1:13 AM','latitude':'-54.742604','longitude':'69.534932','tags':['exercitation','commodo','in','id','aliqua'],'greeting':'Hello, Snyder! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed4b9a7f83da6d2dfd','index':25,'guid':'0b2cc6b6-0044-4b1c-aa31-bd72963457a0','isActive':false,'balance':'$1,152.76','picture':'http://placehold.it/32x32','age':27,'eyeColor':'blue','name':{'first':'Regina','last':'James'},'company':'TELPOD','email':'regina.james@telpod.me','phone':'+1 (989) 455-3228','address':'688 Essex Street, Clayville, Alabama, 2772','about':'Eiusmod elit culpa reprehenderit ea veniam. Officia irure culpa duis aute ut. Irure duis cillum officia ea pariatur velit ut dolor incididunt reprehenderit ex elit laborum. Est pariatur veniam ad irure. Labore velit sunt esse laboris aliqua velit deserunt deserunt sit. Elit eiusmod ad laboris aliquip minim irure excepteur enim quis. Quis incididunt adipisicing ut magna cupidatat sit amet culpa.','registered':'Tuesday, April 25, 2017 10:16 PM','latitude':'-75.088027','longitude':'47.209828','tags':['elit','nisi','est','voluptate','proident'],'greeting':'Hello, Regina! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed10884f32f779f2bf','index':26,'guid':'1f6fb522-0002-46ff-8dac-451247f28168','isActive':true,'balance':'$1,948.79','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Collins','last':'Mcpherson'},'company':'DIGIGEN','email':'collins.mcpherson@digigen.com','phone':'+1 (991) 519-2334','address':'317 Merit Court, Sanford, Michigan, 6468','about':'Magna qui culpa dolor officia labore mollit ex excepteur duis eiusmod. Ea cupidatat ex ipsum mollit do minim duis. Nisi eiusmod minim tempor id esse commodo sunt sunt ullamco ut do laborum ullamco magna. Aliquip laborum dolor officia officia eu nostrud velit minim est anim. Ex elit laborum sunt magna exercitation nisi cillum sunt aute qui ea ullamco. Cupidatat ea sunt aute dolor duis nisi Lorem ullamco eiusmod. Sit ea velit ad veniam aliqua ad elit cupidatat ut magna in.','registered':'Friday, June 10, 2016 4:38 PM','latitude':'25.513996','longitude':'14.911124','tags':['exercitation','non','sit','velit','officia'],'greeting':'Hello, Collins! You have 5 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed8a575110efb15c6c','index':27,'guid':'2a904c82-068b-4ded-9ae6-cfeb6d7e62c9','isActive':true,'balance':'$3,427.91','picture':'http://placehold.it/32x32','age':24,'eyeColor':'green','name':{'first':'Mckay','last':'Barrera'},'company':'COMVEYER','email':'mckay.barrera@comveyer.org','phone':'+1 (853) 470-2560','address':'907 Glenwood Road, Churchill, Oregon, 8583','about':'In voluptate esse dolore enim sint quis dolor do exercitation sint et labore nisi. Eiusmod tempor exercitation dolore elit sit velit sint et. Sit magna adipisicing eiusmod do anim velit deserunt laboris ad ea pariatur. Irure nisi anim mollit elit commodo nulla. Aute eiusmod sit nulla eiusmod. Eiusmod est officia commodo mollit laboris do deserunt eu do nisi amet. Proident ad duis eiusmod laboris Lorem ut culpa pariatur Lorem reprehenderit minim aliquip irure sunt.','registered':'Saturday, December 19, 2015 2:49 PM','latitude':'-55.243287','longitude':'138.035406','tags':['non','quis','laboris','enim','nisi'],'greeting':'Hello, Mckay! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edcd49ab6a73ff7f32','index':28,'guid':'5d3e0dae-3f58-437f-b12d-de24667a904d','isActive':true,'balance':'$3,270.52','picture':'http://placehold.it/32x32','age':35,'eyeColor':'blue','name':{'first':'Mabel','last':'Leonard'},'company':'QUADEEBO','email':'mabel.leonard@quadeebo.net','phone':'+1 (805) 432-2356','address':'965 Underhill Avenue, Falconaire, Minnesota, 4450','about':'Cupidatat amet sunt est ipsum occaecat sit fugiat excepteur Lorem Lorem ex ea ipsum. Ad incididunt est irure magna excepteur occaecat nostrud. Minim dolor id anim ipsum qui nostrud ullamco aute ex Lorem magna deserunt excepteur Lorem.','registered':'Saturday, March 28, 2015 5:55 AM','latitude':'27.388359','longitude':'156.408728','tags':['quis','velit','deserunt','dolore','sit'],'greeting':'Hello, Mabel! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edde16ac2dc2fbb6c1','index':29,'guid':'d50c2233-70fc-4748-8ebf-02d45ac2a446','isActive':false,'balance':'$3,100.70','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Pace','last':'Duke'},'company':'SEQUITUR','email':'pace.duke@sequitur.name','phone':'+1 (983) 568-3119','address':'895 Melrose Street, Reno, Connecticut, 6259','about':'Ex veniam aliquip exercitation mollit elit est minim veniam aliqua labore deserunt. Dolor sunt sint cillum Lorem nisi ea irure cupidatat. Velit ut culpa cupidatat consequat cillum. Sint voluptate quis laboris qui incididunt do elit Lorem qui ullamco ut eu pariatur occaecat.','registered':'Saturday, August 18, 2018 2:18 PM','latitude':'31.930443','longitude':'-129.494784','tags':['culpa','est','nostrud','quis','aliquip'],'greeting':'Hello, Pace! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edb908d85642ba77e8','index':30,'guid':'3edb6e42-367a-403d-a511-eb78bcc11f60','isActive':true,'balance':'$1,912.07','picture':'http://placehold.it/32x32','age':24,'eyeColor':'green','name':{'first':'Cohen','last':'Morrison'},'company':'POWERNET','email':'cohen.morrison@powernet.us','phone':'+1 (888) 597-2141','address':'565 Troutman Street, Idledale, West Virginia, 3196','about':'Ullamco voluptate duis commodo amet occaecat consequat et occaecat dolore nulla eu. Do aliqua sunt deserunt occaecat laboris labore voluptate cupidatat ullamco exercitation aliquip elit voluptate anim. Occaecat deserunt in labore cillum aute deserunt ea excepteur laboris sunt. Officia irure sint incididunt labore sint ipsum ullamco ea elit. Fugiat nostrud sunt ut officia mollit proident sunt dolor fugiat esse tempor do.','registered':'Friday, January 1, 2016 5:42 AM','latitude':'-20.01215','longitude':'26.361552','tags':['consectetur','sunt','nulla','reprehenderit','dolore'],'greeting':'Hello, Cohen! You have 10 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed91c77aa25a64a757','index':31,'guid':'8999a97b-0035-4f19-b555-91dd69aaa9b8','isActive':false,'balance':'$3,097.67','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Stout','last':'Valdez'},'company':'UPLINX','email':'stout.valdez@uplinx.biz','phone':'+1 (854) 480-3633','address':'880 Chestnut Avenue, Lowgap, Hawaii, 1537','about':'Cupidatat enim dolore non voluptate. Aliqua ut non Lorem in exercitation reprehenderit voluptate. Excepteur deserunt tempor laboris quis.','registered':'Wednesday, March 16, 2016 6:53 AM','latitude':'50.328393','longitude':'-25.990308','tags':['ea','fugiat','duis','consectetur','enim'],'greeting':'Hello, Stout! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed0f52176c8c3e1bed','index':32,'guid':'743abcbd-1fab-4aed-8cb7-3c935eb64c74','isActive':false,'balance':'$1,118.54','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Ortega','last':'Joseph'},'company':'APEXIA','email':'ortega.joseph@apexia.ca','phone':'+1 (872) 596-3024','address':'304 Canda Avenue, Mulino, New York, 8721','about':'Ipsum elit id cupidatat minim nisi minim. Ea ex amet ea ipsum Lorem deserunt. Occaecat cupidatat magna cillum aliquip sint id quis amet nostrud officia enim laborum. Aliqua deserunt amet commodo laboris labore mollit est. Officia voluptate Lorem esse mollit aliquip laboris cupidatat minim et. Labore esse incididunt officia nostrud pariatur reprehenderit.','registered':'Tuesday, January 31, 2017 6:06 AM','latitude':'43.861714','longitude':'33.771783','tags':['ut','Lorem','esse','quis','fugiat'],'greeting':'Hello, Ortega! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed2c00cdd101b6cd52','index':33,'guid':'4f6f99cf-f692-4d03-b23a-26f2b27273bd','isActive':true,'balance':'$1,682.91','picture':'http://placehold.it/32x32','age':20,'eyeColor':'blue','name':{'first':'Sampson','last':'Taylor'},'company':'GEOFORMA','email':'sampson.taylor@geoforma.info','phone':'+1 (911) 482-2993','address':'582 Kent Street, Umapine, Virgin Islands, 5300','about':'Voluptate laboris occaecat laboris tempor cillum quis cupidatat qui pariatur. Lorem minim commodo mollit adipisicing Lorem ut dolor consectetur ipsum. Sint sit voluptate labore aliqua ex labore velit. Ullamco tempor consectetur voluptate deserunt voluptate minim enim. Cillum commodo duis reprehenderit eu duis.','registered':'Thursday, November 9, 2017 11:24 PM','latitude':'24.949379','longitude':'155.034468','tags':['Lorem','cupidatat','elit','reprehenderit','commodo'],'greeting':'Hello, Sampson! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed4b7210ba0bc0d508','index':34,'guid':'73fd415f-f8cf-43e0-a86c-e725d000abd4','isActive':false,'balance':'$1,289.37','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Shari','last':'Melendez'},'company':'DIGIPRINT','email':'shari.melendez@digiprint.tv','phone':'+1 (914) 475-3995','address':'950 Wolf Place, Enetai, Alaska, 693','about':'Dolor incididunt et est commodo aliquip labore ad ullamco. Velit ex cillum nulla elit ex esse. Consectetur mollit fugiat cillum proident elit sunt non officia cillum ex laboris sint eu. Esse nulla eu officia in Lorem sint minim esse velit. Est Lorem ipsum enim aute. Elit minim eiusmod officia reprehenderit officia ut irure Lorem.','registered':'Wednesday, August 23, 2017 11:12 PM','latitude':'-70.347863','longitude':'94.812072','tags':['ea','ex','fugiat','duis','eu'],'greeting':'Hello, Shari! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed85ac364619d892ef','index':35,'guid':'c1905f34-14ff-4bd8-b683-02cac4d52623','isActive':false,'balance':'$2,538.50','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Santiago','last':'Joyner'},'company':'BRAINCLIP','email':'santiago.joyner@brainclip.co.uk','phone':'+1 (835) 405-2676','address':'554 Rose Street, Muir, Kentucky, 7752','about':'Quis culpa dolore fugiat magna culpa non deserunt consectetur elit. Id cupidatat occaecat duis irure ullamco elit in labore magna pariatur cillum est. Mollit dolore velit ipsum anim aliqua culpa sint. Occaecat aute anim ut sunt eu.','registered':'Thursday, January 18, 2018 4:49 PM','latitude':'57.057918','longitude':'-50.472596','tags':['ullamco','ullamco','sunt','voluptate','irure'],'greeting':'Hello, Santiago! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1763f56b1121fa88','index':36,'guid':'a7f50659-4ae3-4f3e-a9d8-087e05334b51','isActive':false,'balance':'$1,435.16','picture':'http://placehold.it/32x32','age':37,'eyeColor':'blue','name':{'first':'Adeline','last':'Hoffman'},'company':'BITREX','email':'adeline.hoffman@bitrex.io','phone':'+1 (823) 488-3201','address':'221 Corbin Place, Edmund, Palau, 193','about':'Magna ullamco consectetur velit adipisicing cillum ea. Est qui incididunt est ullamco ex aute exercitation irure. Cupidatat consectetur proident qui fugiat do. Labore magna aliqua consectetur fugiat. Excepteur deserunt sit qui dolor fugiat aute sunt anim ipsum magna ea commodo qui. Minim eu adipisicing ut irure excepteur eiusmod aliqua. Voluptate nisi ad consequat qui.','registered':'Tuesday, June 14, 2016 9:26 AM','latitude':'-53.123355','longitude':'88.180776','tags':['non','est','commodo','ut','aliquip'],'greeting':'Hello, Adeline! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed945d079f63e3185e','index':37,'guid':'1f4619e0-9289-4bea-a9db-a75f4cba1138','isActive':true,'balance':'$2,019.54','picture':'http://placehold.it/32x32','age':36,'eyeColor':'blue','name':{'first':'Porter','last':'Morse'},'company':'COMVOY','email':'porter.morse@comvoy.me','phone':'+1 (933) 562-3220','address':'416 India Street, Bourg, Rhode Island, 2266','about':'Et sint anim et sunt. Non mollit sunt cillum veniam sunt sint amet non mollit. Fugiat ea ullamco pariatur deserunt ex do minim irure irure.','registered':'Saturday, July 16, 2016 10:03 PM','latitude':'-81.782545','longitude':'69.783509','tags':['irure','consequat','veniam','nulla','velit'],'greeting':'Hello, Porter! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed411dd0f06c66bba6','index':38,'guid':'93c900f0-54c0-4c4c-b21d-d59d8d7c6177','isActive':true,'balance':'$3,764.84','picture':'http://placehold.it/32x32','age':26,'eyeColor':'green','name':{'first':'Fitzgerald','last':'Logan'},'company':'UTARIAN','email':'fitzgerald.logan@utarian.com','phone':'+1 (815) 461-2709','address':'498 Logan Street, Tonopah, Arkansas, 6652','about':'Quis Lorem sit est et dolor est esse in veniam. Mollit anim nostrud laboris consequat voluptate qui ad ipsum sint laborum exercitation quis ipsum. Incididunt cupidatat esse ea amet deserunt consequat eu proident duis adipisicing pariatur. Amet deserunt mollit aliquip mollit consequat sunt quis labore laboris quis. Magna cillum fugiat anim velit Lorem duis. Lorem duis amet veniam occaecat est excepteur ut ea velit esse non pariatur. Do veniam quis eu consequat ad duis incididunt minim dolore sit non minim adipisicing et.','registered':'Wednesday, August 9, 2017 9:20 PM','latitude':'24.480657','longitude':'-108.693421','tags':['dolore','ad','occaecat','quis','labore'],'greeting':'Hello, Fitzgerald! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edbb6f14559d8a7b28','index':39,'guid':'9434f48b-70a0-4161-8d06-c53bf8b9df94','isActive':true,'balance':'$3,713.47','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Mcconnell','last':'Nash'},'company':'TETAK','email':'mcconnell.nash@tetak.org','phone':'+1 (956) 477-3586','address':'853 Turnbull Avenue, Clarence, Missouri, 1599','about':'Culpa excepteur minim anim magna dolor dolore ad ex eu. In cupidatat cillum elit dolore in est minim dolore consectetur reprehenderit voluptate laborum. Deserunt id velit ad dolor mollit.','registered':'Saturday, November 10, 2018 9:27 AM','latitude':'1.691589','longitude':'143.704377','tags':['ut','deserunt','sit','cupidatat','ea'],'greeting':'Hello, Mcconnell! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed1a87ea0390733ffa','index':40,'guid':'ec8a55f7-7114-4787-b1ff-4e631731bc2c','isActive':true,'balance':'$2,200.71','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Kitty','last':'Meyers'},'company':'FIBEROX','email':'kitty.meyers@fiberox.net','phone':'+1 (864) 458-3826','address':'537 Georgia Avenue, Thermal, Illinois, 7930','about':'Non excepteur laboris Lorem magna adipisicing exercitation. Anim esse in pariatur minim ipsum qui voluptate irure. Pariatur Lorem pariatur esse commodo aute adipisicing anim commodo. Exercitation nostrud aliqua duis et amet amet tempor.','registered':'Tuesday, September 13, 2016 8:16 PM','latitude':'19.59506','longitude':'-57.814297','tags':['duis','ullamco','velit','sint','consequat'],'greeting':'Hello, Kitty! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed4dc76717bf1217b3','index':41,'guid':'40521cde-f835-4620-902b-af7abf185d8d','isActive':false,'balance':'$2,907.02','picture':'http://placehold.it/32x32','age':26,'eyeColor':'green','name':{'first':'Klein','last':'Goodwin'},'company':'PLASTO','email':'klein.goodwin@plasto.name','phone':'+1 (950) 563-3104','address':'764 Devoe Street, Lindcove, Oklahoma, 458','about':'Amet aliqua magna ea veniam non aliquip irure esse id ipsum cillum sint tempor dolor. Ullamco deserunt fugiat amet pariatur culpa nostrud commodo commodo. Ad occaecat magna adipisicing voluptate. Minim ad adipisicing cupidatat elit nostrud eu irure. Cupidatat occaecat aute magna consectetur dolore anim et. Ex voluptate velit exercitation laborum ad ullamco ad. Aliquip nulla ipsum dolore cillum qui nostrud eu adipisicing amet tempor do.','registered':'Tuesday, February 13, 2018 3:56 PM','latitude':'-27.168725','longitude':'-29.499285','tags':['minim','labore','do','deserunt','dolor'],'greeting':'Hello, Klein! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1ac77396b29aee9e','index':42,'guid':'7cfc03e3-30e9-4ae1-a1f5-f6c3223ca770','isActive':true,'balance':'$2,986.47','picture':'http://placehold.it/32x32','age':22,'eyeColor':'brown','name':{'first':'Isabelle','last':'Bishop'},'company':'GEEKNET','email':'isabelle.bishop@geeknet.us','phone':'+1 (908) 418-2642','address':'729 Willmohr Street, Aguila, Montana, 7510','about':'In nulla commodo nostrud sint. Elit et occaecat et aliqua aliquip magna esse commodo duis Lorem dolor magna enim deserunt. Ipsum pariatur reprehenderit ipsum adipisicing mollit incididunt ut. Sunt in consequat ex ut minim non qui anim labore. Deserunt minim voluptate in nulla occaecat.','registered':'Monday, September 15, 2014 6:22 AM','latitude':'-81.686947','longitude':'38.409291','tags':['proident','est','aliqua','veniam','anim'],'greeting':'Hello, Isabelle! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edb3a070c9469a4893','index':43,'guid':'3dec76b4-0b55-4765-a2fd-b8dbd9c82f8f','isActive':true,'balance':'$2,501.24','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Josefina','last':'Turner'},'company':'COMSTAR','email':'josefina.turner@comstar.biz','phone':'+1 (908) 566-3029','address':'606 Schenck Place, Brutus, Vermont, 8681','about':'Enim consectetur pariatur sint dolor nostrud est deserunt nulla quis pariatur sit. Ad aute incididunt nisi excepteur duis est velit voluptate ullamco occaecat magna reprehenderit aliquip. Proident deserunt consectetur non et exercitation elit dolore enim aliqua incididunt anim amet. Ex esse sint commodo minim aliqua ut irure. Proident ex culpa voluptate fugiat nisi. Sint commodo laboris excepteur minim ipsum labore tempor quis magna.','registered':'Saturday, December 31, 2016 6:38 AM','latitude':'35.275088','longitude':'24.30485','tags':['minim','ut','irure','Lorem','veniam'],'greeting':'Hello, Josefina! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1aa7d74128ee3d0f','index':44,'guid':'10599279-c367-46c4-9f7a-744c2e4bf6c9','isActive':true,'balance':'$1,753.06','picture':'http://placehold.it/32x32','age':27,'eyeColor':'blue','name':{'first':'Lily','last':'Haynes'},'company':'KIOSK','email':'lily.haynes@kiosk.ca','phone':'+1 (872) 451-2301','address':'509 Balfour Place, Grazierville, New Hampshire, 2750','about':'Nisi aliquip occaecat nostrud do sint qui nisi officia Lorem. Ad et et laboris nisi dolore aliqua eu. Aliqua veniam quis eu pariatur incididunt mollit id deserunt officia eiusmod. Consequat adipisicing do nisi voluptate eiusmod minim pariatur minim nisi nostrud culpa cupidatat. Irure consectetur id consequat adipisicing ullamco occaecat do. Ex proident ea quis nulla incididunt sunt excepteur incididunt. Aliquip minim nostrud non anim Lorem.','registered':'Tuesday, November 20, 2018 9:28 AM','latitude':'-12.677798','longitude':'114.506787','tags':['culpa','amet','elit','officia','irure'],'greeting':'Hello, Lily! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed74c76f2e84e201ce','index':45,'guid':'ec0a68d4-629e-46c9-9af7-f6ea867f02ba','isActive':true,'balance':'$1,477.93','picture':'http://placehold.it/32x32','age':23,'eyeColor':'green','name':{'first':'Shauna','last':'Pitts'},'company':'SPACEWAX','email':'shauna.pitts@spacewax.info','phone':'+1 (841) 406-2360','address':'348 Tabor Court, Westwood, Puerto Rico, 8297','about':'Aliquip irure officia magna ea magna mollit ea non amet deserunt. Veniam mollit labore culpa magna aliqua quis consequat est consectetur ea reprehenderit nostrud consequat aliqua. Mollit do ipsum mollit eiusmod.','registered':'Thursday, October 2, 2014 2:48 AM','latitude':'-55.17388','longitude':'-13.370494','tags':['anim','consectetur','cillum','veniam','duis'],'greeting':'Hello, Shauna! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed419e718484b16722','index':46,'guid':'b2d6101d-5646-43f4-8207-284494e5a990','isActive':false,'balance':'$2,006.96','picture':'http://placehold.it/32x32','age':27,'eyeColor':'brown','name':{'first':'Lawrence','last':'Boyer'},'company':'SKYPLEX','email':'lawrence.boyer@skyplex.tv','phone':'+1 (953) 548-2618','address':'464 Pilling Street, Blandburg, Arizona, 5531','about':'Culpa sit minim pariatur mollit cupidatat sunt duis. Nisi ea proident veniam exercitation adipisicing Lorem aliquip amet dolor voluptate in nisi. Non commodo anim sunt est fugiat laborum nisi aliqua non Lorem exercitation dolor. Laboris dolore do minim ut eiusmod enim magna cillum laborum consectetur aliquip minim enim Lorem. Veniam ex veniam occaecat aliquip elit aliquip est eiusmod minim minim adipisicing.','registered':'Wednesday, July 30, 2014 2:17 AM','latitude':'-78.681255','longitude':'139.960626','tags':['consequat','Lorem','incididunt','dolor','esse'],'greeting':'Hello, Lawrence! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed08a9024998292c70','index':47,'guid':'277de142-ebeb-4828-906a-7fd8bc0a738a','isActive':true,'balance':'$1,273.19','picture':'http://placehold.it/32x32','age':27,'eyeColor':'brown','name':{'first':'Sonya','last':'Stafford'},'company':'AQUACINE','email':'sonya.stafford@aquacine.co.uk','phone':'+1 (824) 581-3927','address':'641 Bowery Street, Hillsboro, Delaware, 7893','about':'Culpa labore ex reprehenderit mollit cupidatat dolore et ut quis in. Sint esse culpa enim culpa tempor exercitation veniam minim consectetur. Sunt est laboris minim quis incididunt exercitation laboris cupidatat fugiat ad. Deserunt ipsum do dolor cillum excepteur incididunt.','registered':'Thursday, March 26, 2015 1:10 PM','latitude':'-84.750592','longitude':'165.493533','tags':['minim','officia','dolore','ipsum','est'],'greeting':'Hello, Sonya! You have 8 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd5037f2c79ecde68','index':48,'guid':'2dc6532f-9a26-49aa-b444-8923896db89c','isActive':false,'balance':'$3,168.93','picture':'http://placehold.it/32x32','age':36,'eyeColor':'brown','name':{'first':'Marguerite','last':'Stuart'},'company':'ACCUFARM','email':'marguerite.stuart@accufarm.io','phone':'+1 (848) 535-2253','address':'301 Menahan Street, Sunnyside, Nebraska, 4809','about':'Deserunt sint labore voluptate amet anim culpa nostrud adipisicing enim cupidatat ullamco exercitation fugiat est. Magna dolor aute incididunt ea ad adipisicing. Do cupidatat ut officia officia culpa sit do.','registered':'Thursday, May 8, 2014 1:25 PM','latitude':'21.82277','longitude':'-7.368347','tags':['labore','nulla','ullamco','irure','adipisicing'],'greeting':'Hello, Marguerite! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edb26d315635818dae','index':49,'guid':'083a5eda-0a70-4f89-87f7-2cd386c0f22a','isActive':false,'balance':'$2,576.25','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Louella','last':'Holloway'},'company':'BEDDER','email':'louella.holloway@bedder.me','phone':'+1 (801) 425-3761','address':'545 Lafayette Avenue, Caledonia, Louisiana, 2816','about':'Qui exercitation occaecat dolore mollit. Fugiat cupidatat proident culpa fugiat quis. In cupidatat commodo elit ea enim occaecat esse exercitation nostrud occaecat veniam laboris fugiat. Nisi sunt reprehenderit aliqua reprehenderit tempor id dolore ullamco pariatur reprehenderit et eu ex pariatur.','registered':'Wednesday, November 5, 2014 1:10 AM','latitude':'36.385637','longitude':'77.949423','tags':['eu','irure','velit','non','aliquip'],'greeting':'Hello, Louella! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed77cd60a1abc1ecce','index':50,'guid':'2887c3c1-3eba-4237-a0db-1977eed94554','isActive':true,'balance':'$1,633.51','picture':'http://placehold.it/32x32','age':22,'eyeColor':'green','name':{'first':'Bates','last':'Carrillo'},'company':'ZOMBOID','email':'bates.carrillo@zomboid.com','phone':'+1 (934) 405-2006','address':'330 Howard Alley, Troy, Kansas, 4881','about':'Voluptate esse est ullamco anim tempor ea reprehenderit. Occaecat pariatur deserunt cillum laboris labore id exercitation esse ipsum ipsum ex aliquip. Sunt non elit est ea occaecat. Magna deserunt commodo aliqua ipsum est cillum dolor nisi. Ex duis est tempor tempor laboris do do quis id magna. Dolor do est elit eu laborum ullamco culpa consequat velit eiusmod tempor.','registered':'Saturday, May 28, 2016 3:56 AM','latitude':'83.310134','longitude':'-105.862836','tags':['est','commodo','ea','commodo','sunt'],'greeting':'Hello, Bates! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed5ec0ec299b471fb5','index':51,'guid':'512b5e67-f785-492e-9d94-e43ef8b399b8','isActive':false,'balance':'$3,032.22','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Floyd','last':'Yang'},'company':'FRENEX','email':'floyd.yang@frenex.org','phone':'+1 (924) 566-3304','address':'418 Quay Street, Chumuckla, Guam, 7743','about':'Irure sit velit exercitation dolore est nisi incididunt ut quis consectetur incididunt est dolor. Aute nisi enim esse aliquip enim culpa commodo consectetur. Duis laborum magna ad duis ipsum aliqua eiusmod cillum. Consectetur et duis eiusmod irure ad est nisi incididunt eiusmod labore. Pariatur proident in Lorem adipisicing mollit proident excepteur nulla do nostrud mollit eiusmod. Duis ad dolore irure fugiat anim laboris ipsum et sit duis ipsum voluptate. Lorem non aute exercitation qui ullamco officia minim sint pariatur ut dolor.','registered':'Wednesday, January 18, 2017 2:01 AM','latitude':'45.888721','longitude':'-41.232793','tags':['elit','in','esse','ea','officia'],'greeting':'Hello, Floyd! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed51e26ca89e5caf49','index':52,'guid':'4e0907f6-facc-46df-8952-73561a53fe33','isActive':true,'balance':'$3,767.41','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Gardner','last':'Carey'},'company':'KLUGGER','email':'gardner.carey@klugger.net','phone':'+1 (876) 481-3502','address':'131 Utica Avenue, Cannondale, Federated States Of Micronesia, 610','about':'Amet ad pariatur excepteur anim ex officia commodo proident aliqua occaecat consequat Lorem officia sit. Id minim velit nisi laboris nisi nulla incididunt eiusmod velit. Deserunt labore quis et tempor. Et labore exercitation laborum officia ullamco nostrud adipisicing laboris esse laborum aute anim elit. Sunt ad officia tempor esse et quis aliquip irure pariatur laborum id quis ex. Eu consequat nisi deserunt id eu proident ex minim aute nulla tempor ex.','registered':'Friday, February 21, 2014 6:42 AM','latitude':'-54.740231','longitude':'15.01484','tags':['commodo','laboris','occaecat','aliquip','adipisicing'],'greeting':'Hello, Gardner! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed52e3c9407105093a','index':53,'guid':'1d3b9e7a-1bc3-40ea-b808-1c33f0d48c70','isActive':true,'balance':'$1,113.30','picture':'http://placehold.it/32x32','age':26,'eyeColor':'blue','name':{'first':'Herman','last':'Rogers'},'company':'TALENDULA','email':'herman.rogers@talendula.name','phone':'+1 (818) 521-2005','address':'541 Norman Avenue, Winfred, Tennessee, 447','about':'Culpa ex laborum non ad ullamco officia. Nisi mollit mollit voluptate sit sint ullamco. Lorem exercitation nulla anim eiusmod deserunt magna sint. Officia sunt eiusmod aliqua reprehenderit sunt mollit sit cupidatat sint.','registered':'Wednesday, July 11, 2018 1:05 AM','latitude':'-20.708105','longitude':'-151.294563','tags':['exercitation','minim','officia','qui','enim'],'greeting':'Hello, Herman! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edfcb123d545b6edb4','index':54,'guid':'c0e0c669-4eed-43ee-bdd0-78fe6e9ca4d5','isActive':true,'balance':'$3,309.64','picture':'http://placehold.it/32x32','age':22,'eyeColor':'green','name':{'first':'Whitley','last':'Stark'},'company':'MUSAPHICS','email':'whitley.stark@musaphics.us','phone':'+1 (803) 476-2151','address':'548 Cobek Court, Chamizal, Indiana, 204','about':'Adipisicing veniam dolor ex sint sit id eu voluptate. Excepteur veniam proident exercitation id eu et sunt pariatur. Qui occaecat culpa aliqua nisi excepteur minim veniam. Est duis nulla laborum excepteur cillum pariatur sint incididunt. Velit commodo eu incididunt voluptate. Amet laboris laboris id adipisicing labore eiusmod consequat minim cillum et.','registered':'Thursday, March 27, 2014 9:10 AM','latitude':'71.219596','longitude':'51.012855','tags':['reprehenderit','mollit','laborum','voluptate','aliquip'],'greeting':'Hello, Whitley! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed81510dfc61602fcf','index':55,'guid':'7ec5c24d-f169-4399-a2a3-300c0f45e52e','isActive':false,'balance':'$3,721.04','picture':'http://placehold.it/32x32','age':23,'eyeColor':'green','name':{'first':'Gretchen','last':'Wade'},'company':'EWEVILLE','email':'gretchen.wade@eweville.biz','phone':'+1 (977) 598-3700','address':'721 Colonial Road, Brookfield, South Dakota, 3888','about':'Fugiat consequat sint ut ut et ullamco eiusmod deserunt pariatur. Veniam eiusmod esse fugiat mollit. Proident laboris minim qui do ipsum excepteur exercitation irure anim. Aliqua labore quis eu fugiat dolore ullamco velit Lorem voluptate ipsum nostrud eiusmod laborum proident.','registered':'Friday, October 12, 2018 10:59 AM','latitude':'41.937653','longitude':'63.378531','tags':['aute','cillum','ea','ex','aute'],'greeting':'Hello, Gretchen! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edf78f77d4a7d557bb','index':56,'guid':'8718ada7-6fd0-49ef-a405-29850503948b','isActive':false,'balance':'$3,341.33','picture':'http://placehold.it/32x32','age':32,'eyeColor':'blue','name':{'first':'Naomi','last':'Frye'},'company':'MAZUDA','email':'naomi.frye@mazuda.ca','phone':'+1 (825) 427-2255','address':'741 Coyle Street, Comptche, Pennsylvania, 8441','about':'Aliqua fugiat laborum quis ullamco cupidatat sit dolor nulla dolore. Do Lorem et ipsum culpa irure sit do dolor qui sit laboris aliqua. Ex consectetur irure in veniam reprehenderit amet do elit eiusmod est magna.','registered':'Thursday, January 9, 2014 7:18 AM','latitude':'41.078645','longitude':'-50.241966','tags':['do','aliquip','eiusmod','velit','id'],'greeting':'Hello, Naomi! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edbf45db2e072a48b4','index':57,'guid':'c158ebf7-fb8b-4ea8-adbf-8c51c6486715','isActive':true,'balance':'$2,811.55','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Lamb','last':'Johns'},'company':'DOGTOWN','email':'lamb.johns@dogtown.info','phone':'+1 (946) 530-3057','address':'559 Malbone Street, Kennedyville, California, 2052','about':'Eiusmod dolor labore cillum ad veniam elit voluptate voluptate pariatur est cupidatat. Laboris ut qui in cillum sunt dolore ut enim. Minim nostrud ex qui quis reprehenderit magna ipsum cupidatat irure minim laboris veniam irure. Fugiat velit deserunt aliquip in esse proident excepteur labore reprehenderit excepteur sunt in cupidatat exercitation. Ex pariatur irure mollit tempor non magna ex.','registered':'Friday, April 21, 2017 1:51 AM','latitude':'-61.403599','longitude':'-93.447102','tags':['aliquip','tempor','sint','enim','ipsum'],'greeting':'Hello, Lamb! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edbb9c88190cb59cf2','index':58,'guid':'f0de5ac5-eb28-491b-81c5-76d447c9055e','isActive':true,'balance':'$1,611.99','picture':'http://placehold.it/32x32','age':37,'eyeColor':'brown','name':{'first':'Lynette','last':'Cleveland'},'company':'ARTWORLDS','email':'lynette.cleveland@artworlds.tv','phone':'+1 (889) 596-3723','address':'439 Montauk Avenue, Felt, New Mexico, 9681','about':'Incididunt aliquip est aliquip est ullamco do consectetur dolor. Lorem mollit mollit dolor et ipsum ut qui veniam aute ea. Adipisicing reprehenderit culpa velit laborum adipisicing amet consectetur velit nisi. Ut qui proident ad cillum excepteur adipisicing quis labore. Duis velit culpa et excepteur eiusmod ex labore in nisi nostrud. Et ullamco minim excepteur ut enim reprehenderit consequat eiusmod laboris Lorem commodo exercitation qui laborum.','registered':'Wednesday, August 26, 2015 12:53 PM','latitude':'49.861336','longitude':'86.865926','tags':['reprehenderit','minim','in','minim','nostrud'],'greeting':'Hello, Lynette! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed5b760ddde7295fa8','index':59,'guid':'f8180d3f-c5c0-48b2-966e-a0b2a80f8e84','isActive':true,'balance':'$3,376.75','picture':'http://placehold.it/32x32','age':32,'eyeColor':'green','name':{'first':'Obrien','last':'Page'},'company':'GLASSTEP','email':'obrien.page@glasstep.co.uk','phone':'+1 (902) 583-3086','address':'183 Ridgewood Avenue, Vicksburg, Wisconsin, 7430','about':'Aute excepteur cillum exercitation duis Lorem irure labore elit. Labore magna cupidatat velit consectetur minim do Lorem in excepteur commodo ea consequat ullamco laborum. Ut in id occaecat eu quis duis id ea deserunt veniam.','registered':'Wednesday, March 29, 2017 12:13 AM','latitude':'-40.156154','longitude':'72.76301','tags':['excepteur','non','anim','nulla','anim'],'greeting':'Hello, Obrien! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed52985d3d8901d653','index':60,'guid':'d2e14fa1-8c54-4bcb-8a58-eb2e6f8d0e45','isActive':true,'balance':'$1,659.47','picture':'http://placehold.it/32x32','age':33,'eyeColor':'brown','name':{'first':'Knowles','last':'Goodman'},'company':'CENTREE','email':'knowles.goodman@centree.io','phone':'+1 (862) 563-3692','address':'504 Lott Street, Allensworth, Florida, 7148','about':'Do aliquip voluptate aliqua nostrud. Eu dolore ex occaecat pariatur aute laborum aute nulla aute amet. Excepteur sit laboris ad non anim ut officia ut ad exercitation officia dolore laboris. Esse voluptate minim deserunt nostrud exercitation laborum voluptate exercitation id laborum fugiat proident cupidatat proident. Nulla nostrud est sint adipisicing incididunt exercitation dolor sit et elit tempor occaecat sint culpa. Pariatur occaecat laboris pariatur laboris ad pariatur in cillum fugiat est fugiat. Proident eu id irure excepteur esse aute cillum adipisicing.','registered':'Wednesday, October 15, 2014 6:17 PM','latitude':'-15.73863','longitude':'87.422009','tags':['consequat','sint','tempor','veniam','culpa'],'greeting':'Hello, Knowles! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0eda00b73bdb7ea54e9','index':61,'guid':'c8a064db-0ec6-4832-9820-7280a0333709','isActive':true,'balance':'$3,701.14','picture':'http://placehold.it/32x32','age':35,'eyeColor':'brown','name':{'first':'Shepherd','last':'Todd'},'company':'ECRATIC','email':'shepherd.todd@ecratic.me','phone':'+1 (881) 444-3389','address':'450 Frank Court, Temperanceville, Ohio, 7006','about':'Voluptate cillum ad fugiat velit adipisicing sint consequat veniam Lorem reprehenderit. Cillum sit non deserunt consequat. Amet sunt pariatur non mollit ullamco proident sint dolore anim elit cupidatat anim do ullamco. Lorem Lorem incididunt ea elit consequat laboris enim duis quis Lorem id aute veniam consequat. Cillum veniam cillum sint qui Lorem fugiat culpa consequat. Est sint duis ut qui fugiat. Laborum pariatur velit et sunt mollit eiusmod excepteur culpa ex et officia.','registered':'Tuesday, October 10, 2017 2:01 AM','latitude':'82.951563','longitude':'-4.866954','tags':['eu','qui','proident','esse','ex'],'greeting':'Hello, Shepherd! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed0e51d1a7e2d9e559','index':62,'guid':'739c3d38-200d-4531-84d8-4e7c39ae5b8c','isActive':true,'balance':'$3,679.01','picture':'http://placehold.it/32x32','age':31,'eyeColor':'brown','name':{'first':'Rosalyn','last':'Heath'},'company':'ZAYA','email':'rosalyn.heath@zaya.com','phone':'+1 (865) 403-3520','address':'303 Henderson Walk, Hoehne, District Of Columbia, 4306','about':'Sint occaecat nulla mollit sint fugiat eu proident dolor labore consequat. Occaecat tempor excepteur do fugiat incididunt Lorem in ullamco dolore laborum. Cillum mollit aliquip excepteur aliquip sint sunt minim non irure irure. Cillum fugiat aliqua enim dolore. Nulla culpa culpa nostrud ad. Eiusmod culpa proident proident non est cupidatat eu sunt sit incididunt id nisi.','registered':'Wednesday, April 22, 2015 12:35 PM','latitude':'33.628504','longitude':'110.772802','tags':['consequat','ut','ex','labore','consectetur'],'greeting':'Hello, Rosalyn! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd5274c01d353d0c5','index':63,'guid':'8815fe55-8af1-4708-a62a-d554dbd74a4a','isActive':true,'balance':'$2,126.01','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Queen','last':'Harper'},'company':'TRI@TRIBALOG','email':'queen.harper@tri@tribalog.org','phone':'+1 (903) 592-3145','address':'926 Heath Place, Wawona, Maine, 7340','about':'Laborum cupidatat commodo aliquip reprehenderit. Excepteur eu labore duis minim minim voluptate aute nostrud deserunt ut velit ullamco. Adipisicing nisi occaecat laborum proident. Id reprehenderit eiusmod cupidatat qui aute consequat amet enim commodo duis non ipsum. Amet ut aliqua magna qui proident mollit aute.','registered':'Saturday, April 9, 2016 5:12 AM','latitude':'51.814216','longitude':'177.348115','tags':['cillum','ut','dolor','do','nisi'],'greeting':'Hello, Queen! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed126298b6ce62ed56','index':64,'guid':'001c87fe-182f-450f-903b-2e29a9bb0322','isActive':true,'balance':'$3,578.29','picture':'http://placehold.it/32x32','age':20,'eyeColor':'green','name':{'first':'Pauline','last':'Mills'},'company':'CRUSTATIA','email':'pauline.mills@crustatia.net','phone':'+1 (984) 582-3899','address':'899 Revere Place, Welch, Iowa, 216','about':'Tempor eu exercitation ut id. Deserunt ex reprehenderit veniam nisi. Aute laborum veniam velit dolore ut deserunt Lorem sit esse quis dolor ex do nisi. In dolor tempor officia id. Velit nisi culpa nostrud laborum officia incididunt laborum velit non quis id exercitation exercitation. Anim elit ullamco in enim Lorem culpa aliqua Lorem.','registered':'Monday, June 2, 2014 2:03 PM','latitude':'56.427576','longitude':'172.183669','tags':['pariatur','pariatur','pariatur','fugiat','Lorem'],'greeting':'Hello, Pauline! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed3e332ad9e8a178d8','index':65,'guid':'5ad7292b-feef-4a7e-b485-142cadfbe8ea','isActive':false,'balance':'$3,916.54','picture':'http://placehold.it/32x32','age':22,'eyeColor':'brown','name':{'first':'Garrett','last':'Richmond'},'company':'XYQAG','email':'garrett.richmond@xyqag.name','phone':'+1 (952) 584-3794','address':'233 Grove Street, Summerfield, Virginia, 4735','about':'Nostrud quis pariatur occaecat laborum laboris aliqua ut fugiat dolor. Commodo tempor excepteur enim nostrud Lorem. Aute elit nulla labore ad pariatur cupidatat Lorem qui cupidatat velit deserunt excepteur esse. Excepteur nulla et nostrud quis labore est veniam enim nisi laboris ut enim. Ea esse nulla anim excepteur reprehenderit deserunt voluptate minim qui labore adipisicing amet eu enim.','registered':'Wednesday, March 5, 2014 4:35 PM','latitude':'68.665041','longitude':'148.799524','tags':['irure','reprehenderit','minim','ea','do'],'greeting':'Hello, Garrett! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed541aa2ec47466ace','index':66,'guid':'9cda6f3c-c9ab-451c-bb19-2e4c8463d011','isActive':true,'balance':'$3,352.52','picture':'http://placehold.it/32x32','age':30,'eyeColor':'brown','name':{'first':'Cobb','last':'Whitley'},'company':'UNIA','email':'cobb.whitley@unia.us','phone':'+1 (888) 490-3342','address':'864 Belmont Avenue, Needmore, Massachusetts, 8286','about':'Nisi aliquip fugiat ipsum nisi ullamco minim pariatur labore. Sint labore anim do ad ad esse eu nostrud nulla commodo anim. Cillum anim enim duis cillum non do nisi aliquip veniam voluptate commodo aliqua laborum. Exercitation in do eu qui sint aliquip. Esse adipisicing deserunt deserunt qui anim aliqua occaecat et nostrud elit ea in anim cillum. Tempor mollit proident tempor sunt est sint laborum ullamco incididunt non. Velit aliqua sunt excepteur nisi qui eiusmod ipsum dolore aliquip velit ullamco ullamco.','registered':'Friday, May 23, 2014 7:11 PM','latitude':'-32.950581','longitude':'147.772494','tags':['mollit','adipisicing','irure','ad','minim'],'greeting':'Hello, Cobb! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed8186c3d6f34c2be3','index':67,'guid':'fee98f6d-d68a-4189-8180-b6cb337e537e','isActive':false,'balance':'$1,698.42','picture':'http://placehold.it/32x32','age':20,'eyeColor':'blue','name':{'first':'Brennan','last':'Tyler'},'company':'PODUNK','email':'brennan.tyler@podunk.biz','phone':'+1 (867) 498-2727','address':'599 Harkness Avenue, Gorst, American Samoa, 322','about':'Reprehenderit id sit qui id qui aute ea sit magna in qui proident. Excepteur ad nostrud do nostrud in incididunt voluptate adipisicing sint anim. Ullamco consequat minim nulla irure ex est irure reprehenderit deserunt voluptate dolore anim sunt. Occaecat dolore voluptate voluptate elit commodo nulla laborum ad do irure.','registered':'Friday, February 9, 2018 5:40 PM','latitude':'11.150893','longitude':'-85.298004','tags':['quis','minim','deserunt','cillum','laboris'],'greeting':'Hello, Brennan! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed075c9c4f7439818d','index':68,'guid':'1ef76b18-6b8d-4c3c-aca3-9fa2b43f0242','isActive':false,'balance':'$2,091.17','picture':'http://placehold.it/32x32','age':26,'eyeColor':'brown','name':{'first':'Neal','last':'Stephenson'},'company':'OTHERSIDE','email':'neal.stephenson@otherside.ca','phone':'+1 (820) 496-3344','address':'867 Wilson Street, Kidder, Colorado, 4599','about':'Do laboris enim proident in qui velit adipisicing magna anim. Amet proident non exercitation ipsum aliqua excepteur nostrud. Enim esse non sit in nostrud deserunt id laborum cillum deserunt consequat. Anim velit exercitation qui sit voluptate. Irure duis non veniam velit mollit exercitation id exercitation.','registered':'Thursday, November 13, 2014 11:00 PM','latitude':'54.809693','longitude':'1.877241','tags':['anim','duis','in','officia','sint'],'greeting':'Hello, Neal! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0eda0a2dc24db64b638','index':69,'guid':'194744fd-089b-40b6-a290-98a6ec30a415','isActive':false,'balance':'$3,191.67','picture':'http://placehold.it/32x32','age':24,'eyeColor':'brown','name':{'first':'Shields','last':'Hubbard'},'company':'MIRACULA','email':'shields.hubbard@miracula.info','phone':'+1 (885) 582-2001','address':'529 Eagle Street, Guilford, Nevada, 1460','about':'Eiusmod exercitation ut incididunt veniam commodo culpa ullamco mollit id adipisicing exercitation ad sint. Nostrud excepteur amet aliqua mollit incididunt laborum voluptate id anim. Nulla sint laboris dolor esse cupidatat laborum ex sint. Ex non sunt sit nulla.','registered':'Monday, February 13, 2017 6:22 AM','latitude':'-69.145209','longitude':'-40.69755','tags':['tempor','enim','qui','velit','elit'],'greeting':'Hello, Shields! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edf939c130177e074d','index':70,'guid':'303b176c-7803-4ed2-a35f-3e3c831793ef','isActive':false,'balance':'$2,359.09','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Coleen','last':'Knight'},'company':'BLEEKO','email':'coleen.knight@bleeko.tv','phone':'+1 (867) 423-3146','address':'527 Broadway , Bonanza, Marshall Islands, 4988','about':'Laboris nulla pariatur laborum ad aute excepteur sunt pariatur exercitation. Do nostrud qui ipsum ullamco et sint do Lorem cillum ullamco do. Exercitation labore excepteur commodo incididunt eiusmod proident consectetur adipisicing nostrud aute voluptate laboris. Commodo anim proident eiusmod pariatur est ea laborum incididunt qui tempor reprehenderit ullamco id. Eiusmod commodo nisi consectetur ut qui quis aliqua sit minim nostrud sunt laborum eiusmod adipisicing.','registered':'Sunday, May 6, 2018 8:03 AM','latitude':'70.729041','longitude':'113.052761','tags':['Lorem','ullamco','nulla','ullamco','commodo'],'greeting':'Hello, Coleen! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edae8b1ce688b61223','index':71,'guid':'7d6f3b1a-c367-4068-9e8e-1717d513ece3','isActive':false,'balance':'$2,911.07','picture':'http://placehold.it/32x32','age':21,'eyeColor':'brown','name':{'first':'Clark','last':'Ryan'},'company':'ECLIPSENT','email':'clark.ryan@eclipsent.co.uk','phone':'+1 (938) 562-2740','address':'500 Lewis Avenue, Rockbridge, North Dakota, 5133','about':'Adipisicing exercitation officia sit excepteur excepteur sunt sint amet. Aliqua ipsum sint laboris eiusmod esse culpa elit sunt. Dolore est consectetur est quis quis magna. Aliquip nostrud dolore ex pariatur. Anim nostrud duis exercitation ut magna magna culpa. Nisi irure id mollit labore non sit mollit occaecat Lorem est ipsum. Nulla est fugiat cillum nisi aliqua consectetur amet nulla nostrud esse.','registered':'Friday, July 24, 2015 9:28 AM','latitude':'-68.055815','longitude':'-50.926966','tags':['deserunt','ad','ad','ut','id'],'greeting':'Hello, Clark! You have 7 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed5d1e8df45d8ab4db','index':72,'guid':'ce85db37-7d04-4f4c-a4b0-78003533e5c6','isActive':false,'balance':'$1,127.43','picture':'http://placehold.it/32x32','age':21,'eyeColor':'green','name':{'first':'Dillon','last':'Hooper'},'company':'MEDESIGN','email':'dillon.hooper@medesign.io','phone':'+1 (929) 600-3797','address':'652 Mill Avenue, Elliston, Mississippi, 2958','about':'Dolore culpa qui exercitation nostrud do. Irure duis in ad ipsum aliqua aliquip nulla sit veniam officia quis occaecat est. Magna qui eiusmod pariatur aliquip minim commodo. Qui ex dolor excepteur consequat eiusmod occaecat. In officia ipsum do Lorem excepteur proident pariatur labore.','registered':'Monday, May 26, 2014 2:38 AM','latitude':'-36.032189','longitude':'86.865529','tags':['non','ut','ex','Lorem','quis'],'greeting':'Hello, Dillon! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edb84814579c3121b3','index':73,'guid':'d7303901-5186-4595-a759-22306f67d0a3','isActive':true,'balance':'$2,326.59','picture':'http://placehold.it/32x32','age':33,'eyeColor':'green','name':{'first':'Moreno','last':'Hull'},'company':'ZEAM','email':'moreno.hull@zeam.me','phone':'+1 (984) 586-3738','address':'265 Pine Street, Talpa, North Carolina, 6041','about':'Fugiat exercitation est ullamco anim. Exercitation proident id sunt culpa Lorem amet. Consectetur anim consectetur pariatur consequat consectetur amet excepteur voluptate ea velit duis eiusmod proident. In sint laborum cupidatat ea amet ex. Reprehenderit amet sunt dolor ullamco est ex deserunt.','registered':'Wednesday, January 24, 2018 8:52 PM','latitude':'84.956857','longitude':'113.210051','tags':['est','excepteur','anim','Lorem','dolor'],'greeting':'Hello, Moreno! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eda4eb9dcb92c82d06','index':74,'guid':'8ee28651-802e-4523-b676-c713f6e874b8','isActive':true,'balance':'$3,783.97','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Tracie','last':'Price'},'company':'ICOLOGY','email':'tracie.price@icology.com','phone':'+1 (897) 403-3768','address':'487 Sheffield Avenue, Vallonia, Wyoming, 276','about':'Voluptate laboris laborum aute ex sint voluptate officia proident. Sit esse nostrud cupidatat in veniam sit duis est. Do mollit elit exercitation aliqua id irure ex. Lorem reprehenderit do ullamco sint ea ad nisi ad ut.','registered':'Saturday, December 10, 2016 9:44 AM','latitude':'77.770464','longitude':'151.392903','tags':['incididunt','labore','aliquip','anim','minim'],'greeting':'Hello, Tracie! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed68ab1a55d1c35e6c','index':75,'guid':'deedd26a-8928-4064-9666-5c59ea8144b4','isActive':true,'balance':'$2,848.08','picture':'http://placehold.it/32x32','age':32,'eyeColor':'brown','name':{'first':'Montgomery','last':'Bruce'},'company':'CYTREK','email':'montgomery.bruce@cytrek.org','phone':'+1 (824) 414-2731','address':'397 Beach Place, Ellerslie, South Carolina, 967','about':'Mollit minim excepteur magna velit cillum excepteur exercitation anim id labore deserunt do. Fugiat ex et id ad. Duis excepteur laboris est nulla do id irure quis eiusmod do esse ut culpa in.','registered':'Tuesday, August 25, 2015 6:42 AM','latitude':'79.722631','longitude':'-7.516885','tags':['Lorem','sint','voluptate','proident','incididunt'],'greeting':'Hello, Montgomery! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd90e0abb1cc2b0aa','index':76,'guid':'a072159d-12db-4747-9c2a-e2486a53d043','isActive':false,'balance':'$2,723.54','picture':'http://placehold.it/32x32','age':40,'eyeColor':'green','name':{'first':'Zelma','last':'Salinas'},'company':'IMAGEFLOW','email':'zelma.salinas@imageflow.net','phone':'+1 (964) 555-3856','address':'584 Reeve Place, Nord, Georgia, 7473','about':'Aliqua proident excepteur duis cupidatat cillum amet esse esse consectetur ea. Officia sunt consequat nostrud minim enim dolore dolor duis cillum. Esse labore veniam sint laborum excepteur sint tempor do ad cupidatat aliquip laboris elit id. Velit reprehenderit ullamco velit ullamco adipisicing velit esse irure velit et.','registered':'Thursday, February 25, 2016 8:18 PM','latitude':'-32.880524','longitude':'115.180489','tags':['id','nulla','reprehenderit','consequat','reprehenderit'],'greeting':'Hello, Zelma! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed98d836c8da283bb2','index':77,'guid':'838bebad-cc20-44e9-9eb7-902a8ca25efb','isActive':false,'balance':'$3,488.91','picture':'http://placehold.it/32x32','age':20,'eyeColor':'green','name':{'first':'Shaw','last':'Parsons'},'company':'PEARLESEX','email':'shaw.parsons@pearlesex.name','phone':'+1 (912) 567-3580','address':'606 Ocean Avenue, Tyro, Northern Mariana Islands, 3367','about':'Laborum labore occaecat culpa pariatur nisi non adipisicing esse consectetur officia officia. Deserunt velit eu enim consectetur ut cillum aliqua occaecat dolor qui esse. Incididunt ad est ex eu culpa anim aliquip laborum. Aliqua consectetur velit exercitation magna minim nulla do ut excepteur enim aliquip et. Nostrud enim sunt amet amet proident aliqua velit dolore. Consectetur ipsum fugiat proident id est reprehenderit tempor irure commodo. Sit excepteur fugiat occaecat nulla Lorem et cillum.','registered':'Thursday, April 19, 2018 1:41 AM','latitude':'69.715573','longitude':'-118.481237','tags':['laboris','adipisicing','magna','voluptate','id'],'greeting':'Hello, Shaw! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed1101734633c6ebba','index':78,'guid':'8fd0c52a-9d74-4984-a608-d612ecd8ddf0','isActive':true,'balance':'$3,820.02','picture':'http://placehold.it/32x32','age':39,'eyeColor':'brown','name':{'first':'Jaime','last':'Beard'},'company':'IZZBY','email':'jaime.beard@izzby.us','phone':'+1 (820) 412-3806','address':'362 Hudson Avenue, Delco, New Jersey, 5684','about':'Ut cupidatat veniam nulla magna commodo sit duis veniam consectetur cupidatat elit quis tempor. Duis officia ullamco proident sunt non mollit excepteur. Nisi ex amet laboris proident duis reprehenderit et est aliqua mollit amet ad. Enim eu elit excepteur eu exercitation duis consequat culpa. Adipisicing reprehenderit duis Lorem reprehenderit dolor aliqua incididunt eiusmod consequat ad occaecat fugiat do laborum. Qui ad aliquip ex do sunt. Fugiat non ut fugiat eu.','registered':'Sunday, March 9, 2014 3:41 PM','latitude':'17.926318','longitude':'108.985996','tags':['ut','voluptate','veniam','non','commodo'],'greeting':'Hello, Jaime! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edcd125a89dcf18e0d','index':79,'guid':'eccaa4ca-0fa7-4b00-a1e3-fe7953403894','isActive':true,'balance':'$1,521.33','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Terra','last':'Sullivan'},'company':'ZANITY','email':'terra.sullivan@zanity.biz','phone':'+1 (995) 498-2714','address':'346 Congress Street, Tuttle, Maryland, 3152','about':'Incididunt enim veniam ut veniam quis dolore pariatur culpa ex. Cillum laboris dolor exercitation officia. Officia irure magna aliqua veniam officia ullamco culpa. Cillum enim velit ea sint sint officia labore ea adipisicing culpa laboris. Anim aute sint commodo culpa ex quis minim ut laborum.','registered':'Sunday, June 1, 2014 5:38 AM','latitude':'-4.655435','longitude':'5.851803','tags':['anim','non','anim','laborum','pariatur'],'greeting':'Hello, Terra! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed9b9fc3041a674c87','index':80,'guid':'9f95fa36-4e45-4c3f-9362-3d4d809bf57f','isActive':true,'balance':'$3,403.16','picture':'http://placehold.it/32x32','age':39,'eyeColor':'brown','name':{'first':'Sharpe','last':'Berger'},'company':'ZILLAN','email':'sharpe.berger@zillan.ca','phone':'+1 (913) 498-3005','address':'277 Bragg Street, Faywood, Texas, 6487','about':'Dolor duis id aute ea veniam amet ullamco id. Culpa deserunt irure mollit tempor dolore veniam culpa officia culpa laborum eiusmod. Ullamco tempor qui aliqua cupidatat veniam cillum eu ut ex minim eu in. Quis exercitation anim eiusmod tempor esse mollit exercitation cillum ipsum reprehenderit. Sint voluptate ipsum officia sint magna nulla tempor eiusmod eiusmod veniam. Consectetur non ad veniam exercitation voluptate non nostrud.','registered':'Tuesday, June 27, 2017 12:58 AM','latitude':'-0.54085','longitude':'106.258693','tags':['proident','eiusmod','commodo','excepteur','pariatur'],'greeting':'Hello, Sharpe! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed1a1866757bf675e0','index':81,'guid':'1b944a01-01d3-4846-94e3-630f4d0e51a3','isActive':true,'balance':'$2,038.61','picture':'http://placehold.it/32x32','age':28,'eyeColor':'brown','name':{'first':'Blanchard','last':'Ewing'},'company':'CONJURICA','email':'blanchard.ewing@conjurica.info','phone':'+1 (859) 593-3212','address':'252 Beaver Street, Kiskimere, Utah, 3255','about':'Labore magna aute adipisicing ut dolor sit ea. Officia culpa aute occaecat sit ex ullamco aliquip ad sit culpa. Ex in enim dolore ex est sit. Do irure nulla magna sint aliquip in duis aute. Magna ullamco sit labore ea tempor voluptate.','registered':'Monday, May 4, 2015 10:50 AM','latitude':'76.207595','longitude':'0.672563','tags':['proident','pariatur','officia','in','culpa'],'greeting':'Hello, Blanchard! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed987d82f4e22d939c','index':82,'guid':'97a90aee-3cee-4678-819e-24fb94279dc1','isActive':false,'balance':'$1,201.55','picture':'http://placehold.it/32x32','age':28,'eyeColor':'blue','name':{'first':'Wells','last':'Solomon'},'company':'CORPULSE','email':'wells.solomon@corpulse.tv','phone':'+1 (840) 539-3349','address':'159 Radde Place, Linganore, Idaho, 230','about':'Consequat dolore mollit sit irure cupidatat commodo. Incididunt cillum reprehenderit ullamco sit proident cupidatat occaecat reprehenderit officia. Ad anim Lorem elit in officia minim proident nisi commodo eiusmod ea Lorem dolore voluptate. Dolor aliquip est commodo Lorem dolor ut aliquip ut. Sit anim officia dolore excepteur aute enim cillum.','registered':'Friday, January 6, 2017 1:59 PM','latitude':'70.020883','longitude':'14.503588','tags':['mollit','aute','officia','nostrud','laboris'],'greeting':'Hello, Wells! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eddf7a904ea0d0bc2a','index':83,'guid':'fe639a0c-7517-43e6-b0da-cd9ca5b9e267','isActive':false,'balance':'$3,664.47','picture':'http://placehold.it/32x32','age':33,'eyeColor':'blue','name':{'first':'Natalia','last':'Brown'},'company':'SYNTAC','email':'natalia.brown@syntac.co.uk','phone':'+1 (952) 595-3513','address':'332 Lenox Road, Springville, Alabama, 8406','about':'Nulla consequat officia commodo ea sunt irure anim velit aliquip aliquip. Labore ullamco occaecat proident voluptate cillum labore minim nostrud excepteur. Qui fugiat nostrud cillum fugiat ullamco id commodo aliqua voluptate mollit id id laboris. Cillum qui duis duis sit adipisicing elit ut aliqua eu. Anim nisi aliqua sit mollit.','registered':'Sunday, July 30, 2017 1:02 PM','latitude':'31.937613','longitude':'-9.957927','tags':['magna','adipisicing','exercitation','tempor','consectetur'],'greeting':'Hello, Natalia! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed8823fa385cad4aa3','index':84,'guid':'5cf280da-f5f0-4cc6-9063-e9d5863c8c89','isActive':false,'balance':'$1,624.17','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Greene','last':'Waller'},'company':'ISOTRACK','email':'greene.waller@isotrack.io','phone':'+1 (838) 406-3608','address':'362 Albemarle Road, Gardiner, Michigan, 2764','about':'Ut nisi sit sint nulla dolor magna. Culpa occaecat adipisicing veniam proident excepteur tempor quis ex. Fugiat tempor laborum dolor adipisicing irure anim cupidatat ut exercitation ex sit. Cupidatat exercitation commodo sunt ex irure fugiat eu esse do ullamco mollit dolore cupidatat. Cupidatat magna incididunt officia dolore esse voluptate deserunt in laborum dolor. Sit fugiat Lorem eu ullamco. Laboris veniam quis cillum tempor ex fugiat cillum cupidatat.','registered':'Sunday, June 10, 2018 10:32 PM','latitude':'0.256921','longitude':'-96.141941','tags':['magna','dolore','deserunt','aliquip','cillum'],'greeting':'Hello, Greene! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eda7c905c2d24c7d31','index':85,'guid':'aa30a9fb-8a16-48eb-8bb7-1307d1e1f191','isActive':false,'balance':'$1,974.04','picture':'http://placehold.it/32x32','age':36,'eyeColor':'green','name':{'first':'Carlene','last':'Hanson'},'company':'DIGIRANG','email':'carlene.hanson@digirang.me','phone':'+1 (981) 417-3209','address':'435 Clark Street, Choctaw, Oregon, 9888','about':'Amet labore esse cillum irure laborum consectetur occaecat non aliquip aliquip proident. Nisi magna nulla officia duis labore aute nulla laborum duis tempor minim. Velit elit reprehenderit nisi exercitation officia incididunt amet cupidatat excepteur proident consectetur.','registered':'Thursday, April 20, 2017 6:13 AM','latitude':'68.529086','longitude':'68.802409','tags':['pariatur','nulla','qui','amet','labore'],'greeting':'Hello, Carlene! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed6fbee12ce9e55dbf','index':86,'guid':'0fce89aa-3310-48df-862a-68bd3d776644','isActive':false,'balance':'$3,909.64','picture':'http://placehold.it/32x32','age':40,'eyeColor':'brown','name':{'first':'Doris','last':'Collins'},'company':'ZIORE','email':'doris.collins@ziore.com','phone':'+1 (914) 405-2360','address':'301 Lorraine Street, Stouchsburg, Minnesota, 7476','about':'Nisi deserunt aliquip et deserunt ipsum ad consectetur est non ullamco. Dolore do ut voluptate do eiusmod. Culpa ad in eiusmod nisi cillum do. Officia magna cillum sint aliqua reprehenderit amet est ipsum. Eiusmod deserunt commodo proident consequat. Amet minim dolor consequat aliquip aliquip culpa non exercitation non.','registered':'Wednesday, February 25, 2015 9:15 PM','latitude':'-57.364906','longitude':'130.766587','tags':['nulla','deserunt','cillum','eiusmod','adipisicing'],'greeting':'Hello, Doris! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edede9402476c398c0','index':87,'guid':'60cf0aa6-bc6d-4305-8842-d27e6af1306f','isActive':false,'balance':'$2,817.53','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Cline','last':'Hayden'},'company':'ECRAZE','email':'cline.hayden@ecraze.org','phone':'+1 (965) 507-2138','address':'352 Rutland Road, Ebro, Connecticut, 1196','about':'Dolor eiusmod enim anim sit enim ea tempor. Tempor amet consectetur aliquip culpa do ex excepteur deserunt. Dolor commodo veniam culpa sint. Commodo consectetur pariatur irure nisi deserunt cillum est dolor ipsum ea.','registered':'Thursday, September 29, 2016 5:58 AM','latitude':'62.50713','longitude':'86.247286','tags':['enim','tempor','anim','veniam','proident'],'greeting':'Hello, Cline! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edeb72f151994a551b','index':88,'guid':'dbb49c62-86b1-409f-b8b8-f609c709d2a8','isActive':false,'balance':'$3,122.56','picture':'http://placehold.it/32x32','age':39,'eyeColor':'green','name':{'first':'Janelle','last':'Rutledge'},'company':'TERRAGEN','email':'janelle.rutledge@terragen.net','phone':'+1 (914) 581-3749','address':'170 Falmouth Street, Alderpoint, West Virginia, 642','about':'Laboris proident cillum sunt qui ea sunt. Officia adipisicing exercitation dolore magna reprehenderit amet anim id. Laboris commodo sit irure irure. Excepteur est mollit fugiat incididunt consectetur veniam irure ea mollit. Cillum enim consequat sunt sunt nisi incididunt tempor enim.','registered':'Monday, February 16, 2015 5:46 AM','latitude':'-46.392023','longitude':'32.054562','tags':['eu','eu','nisi','labore','deserunt'],'greeting':'Hello, Janelle! You have 9 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edc9c2604846ff9a0d','index':89,'guid':'c4d7a365-f1d3-4584-b78e-008394c219f7','isActive':true,'balance':'$1,807.19','picture':'http://placehold.it/32x32','age':24,'eyeColor':'green','name':{'first':'Abby','last':'Lopez'},'company':'GRAINSPOT','email':'abby.lopez@grainspot.name','phone':'+1 (917) 442-3955','address':'488 Kensington Walk, Winston, Hawaii, 9109','about':'Incididunt deserunt Lorem proident magna tempor enim quis duis eu ut adipisicing in. Ex mollit non irure aliqua officia. Fugiat id ipsum consequat irure id ullamco culpa quis nulla enim aliquip consequat et. Dolor ut anim velit irure consequat cillum eu. Aute occaecat laborum est aliqua.','registered':'Sunday, April 1, 2018 11:28 PM','latitude':'-10.177041','longitude':'-165.756718','tags':['est','laborum','culpa','non','quis'],'greeting':'Hello, Abby! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed03237438b158af9e','index':90,'guid':'36c4a19f-2d00-4e40-bd49-155fd2ce0a6c','isActive':false,'balance':'$2,757.86','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Whitney','last':'Sheppard'},'company':'ANACHO','email':'whitney.sheppard@anacho.us','phone':'+1 (922) 437-2383','address':'951 Beekman Place, Homeworth, New York, 6088','about':'Sint minim nisi minim non minim aliqua pariatur ullamco do sint qui labore. Aute elit reprehenderit ad do fugiat est amet. In incididunt tempor commodo cillum tempor est labore anim.','registered':'Tuesday, September 13, 2016 6:43 PM','latitude':'-49.732527','longitude':'-171.846715','tags':['exercitation','veniam','sunt','est','proident'],'greeting':'Hello, Whitney! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edb99dd3aa53d2cb7f','index':91,'guid':'17afd430-f37f-4d55-958c-72f35cdb5997','isActive':false,'balance':'$3,683.86','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Ilene','last':'Blackwell'},'company':'ENQUILITY','email':'ilene.blackwell@enquility.biz','phone':'+1 (817) 555-2616','address':'950 Varanda Place, Belgreen, Virgin Islands, 1765','about':'Id eiusmod deserunt eiusmod adipisicing adipisicing est enim pariatur esse duis. Qui velit duis irure magna consectetur dolore reprehenderit. Cillum dolore minim consectetur irure non qui velit cillum veniam adipisicing incididunt. Deserunt veniam excepteur veniam velit aliquip labore quis exercitation magna do non dolor. Aliquip occaecat minim adipisicing deserunt fugiat nulla occaecat proident irure consectetur eiusmod irure. Enim Lorem deserunt amet Lorem commodo eiusmod reprehenderit occaecat adipisicing dolor voluptate cillum.','registered':'Thursday, February 1, 2018 8:39 AM','latitude':'57.393644','longitude':'-3.704258','tags':['adipisicing','dolor','commodo','Lorem','Lorem'],'greeting':'Hello, Ilene! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed353f4deb62c3342a','index':92,'guid':'9953e285-2095-4f1c-978b-9ece2a867e9d','isActive':false,'balance':'$1,202.44','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Dawson','last':'Herman'},'company':'BITENDREX','email':'dawson.herman@bitendrex.ca','phone':'+1 (843) 522-2655','address':'471 Channel Avenue, Denio, Alaska, 5040','about':'Nisi occaecat mollit reprehenderit nisi minim Lorem mollit. Ea proident irure cillum quis. Deserunt consectetur consectetur consequat quis enim minim ea ipsum proident nisi ad non aliquip. Veniam aute minim consequat irure voluptate aute amet excepteur exercitation cillum duis quis adipisicing nostrud.','registered':'Tuesday, December 8, 2015 5:40 PM','latitude':'-55.602721','longitude':'-26.683234','tags':['qui','dolor','deserunt','eiusmod','labore'],'greeting':'Hello, Dawson! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd5464bc50a5310ad','index':93,'guid':'724b2434-4dbd-417d-aa07-6065715f434f','isActive':false,'balance':'$1,595.98','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Alice','last':'Christian'},'company':'ZENOLUX','email':'alice.christian@zenolux.info','phone':'+1 (954) 466-2650','address':'875 Gerritsen Avenue, Townsend, Kentucky, 6568','about':'Nulla labore occaecat ex culpa magna. Commodo occaecat et in consequat cillum laborum magna adipisicing excepteur. Do ut Lorem esse voluptate officia ea aliquip proident amet veniam minim nulla adipisicing. Enim consectetur incididunt laborum voluptate tempor deserunt non laboris. Aliquip deserunt aute irure dolore magna anim aliquip sint magna Lorem. Officia laboris nulla officia sint labore nisi. Do Lorem id in est esse adipisicing id fugiat enim esse laborum.','registered':'Wednesday, October 3, 2018 9:26 PM','latitude':'-88.790637','longitude':'138.817328','tags':['duis','ea','magna','ea','incididunt'],'greeting':'Hello, Alice! You have 8 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0eda01886247b6a4f3d','index':94,'guid':'17c9f4d3-7d72-44e3-8f7c-08d7de920f46','isActive':false,'balance':'$3,173.29','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Schwartz','last':'Mccormick'},'company':'EVIDENDS','email':'schwartz.mccormick@evidends.tv','phone':'+1 (924) 531-2802','address':'160 Midwood Street, Indio, Palau, 4241','about':'Anim reprehenderit et et adipisicing voluptate consequat elit. Sint Lorem laboris Lorem minim nostrud aute reprehenderit elit aute quis nulla. Officia aute eiusmod mollit cillum eu aliquip non enim ea occaecat quis fugiat occaecat officia. Eiusmod culpa exercitation dolor aliqua enim occaecat nisi cupidatat duis ex dolore id. Id consequat aliqua cupidatat ut. Sit nisi est sunt culpa ullamco excepteur sunt pariatur incididunt amet. Ut tempor duis velit eu ut id culpa aute anim occaecat labore.','registered':'Thursday, March 2, 2017 5:57 PM','latitude':'38.618587','longitude':'-165.142529','tags':['ad','reprehenderit','magna','elit','mollit'],'greeting':'Hello, Schwartz! You have 10 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed51be4df456ec2bc9','index':95,'guid':'44f68f65-959b-4ec2-bd2a-1f30035f76fc','isActive':false,'balance':'$3,242.24','picture':'http://placehold.it/32x32','age':39,'eyeColor':'blue','name':{'first':'Bonita','last':'Stevens'},'company':'SLOFAST','email':'bonita.stevens@slofast.co.uk','phone':'+1 (886) 473-2105','address':'459 Bushwick Court, Kilbourne, Rhode Island, 9450','about':'Consequat reprehenderit qui reprehenderit nisi sit est in qui aliquip amet. Ex deserunt cupidatat amet cillum eiusmod irure anim in amet proident voluptate. Ad officia culpa in non incididunt do.','registered':'Saturday, August 22, 2015 5:23 AM','latitude':'60.013542','longitude':'58.242132','tags':['aute','adipisicing','in','cillum','officia'],'greeting':'Hello, Bonita! You have 5 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed50a55e3587993f68','index':96,'guid':'652e434f-221e-4899-af12-38dca5c9621d','isActive':false,'balance':'$2,720.06','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Charmaine','last':'Jackson'},'company':'FLUM','email':'charmaine.jackson@flum.io','phone':'+1 (947) 573-2692','address':'788 Windsor Place, Highland, Arkansas, 8869','about':'Dolore reprehenderit irure excepteur eu reprehenderit sint Lorem ut amet in. Consequat anim elit sunt aliquip incididunt. Culpa consequat do exercitation dolor enim dolor sunt sit excepteur ad anim. Dolor aute elit velit mollit minim eu.','registered':'Wednesday, April 6, 2016 7:54 PM','latitude':'25.756553','longitude':'-5.482531','tags':['amet','sint','consequat','est','ex'],'greeting':'Hello, Charmaine! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed213621949bbdd5d3','index':97,'guid':'7d7d93d8-3e37-4b4a-9fa2-591fb7d153ce','isActive':true,'balance':'$1,370.63','picture':'http://placehold.it/32x32','age':36,'eyeColor':'brown','name':{'first':'Petersen','last':'Cooley'},'company':'ROTODYNE','email':'petersen.cooley@rotodyne.me','phone':'+1 (929) 563-3339','address':'338 Pioneer Street, Carbonville, Missouri, 3030','about':'Cillum elit dolore labore aute. Cillum ea incididunt cupidatat consequat sint eu mollit. Excepteur commodo eiusmod ex Lorem enim velit minim.','registered':'Friday, December 8, 2017 5:53 AM','latitude':'-10.576254','longitude':'-111.176861','tags':['veniam','eu','eiusmod','dolore','voluptate'],'greeting':'Hello, Petersen! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed3e938138d58ed453','index':98,'guid':'d6fea4a3-03f6-46ee-90b9-8ec51a585e29','isActive':true,'balance':'$1,216.54','picture':'http://placehold.it/32x32','age':39,'eyeColor':'blue','name':{'first':'Rosanne','last':'Terry'},'company':'EXTREMO','email':'rosanne.terry@extremo.com','phone':'+1 (812) 496-2691','address':'368 Rockaway Avenue, Gloucester, Illinois, 7913','about':'Duis et nostrud duis quis minim eiusmod culpa do ea ad pariatur tempor. Velit veniam aliqua aliquip est enim ex et culpa dolor ullamco culpa officia. Eu id occaecat aute cillum aute sit aute laboris ipsum voluptate ex. Amet tempor minim tempor Lorem quis dolore. Pariatur consequat dolore nulla veniam dolor exercitation consequat nulla laboris incididunt do. Dolore do tempor deserunt exercitation incididunt officia incididunt ut do reprehenderit do eiusmod nulla.','registered':'Sunday, August 6, 2017 12:46 PM','latitude':'-43.257964','longitude':'-45.147686','tags':['et','incididunt','esse','commodo','ipsum'],'greeting':'Hello, Rosanne! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed632b1a1d65501d6b','index':99,'guid':'bf8c6ac1-ee18-48ee-ae94-ea515a53c951','isActive':true,'balance':'$2,905.58','picture':'http://placehold.it/32x32','age':21,'eyeColor':'blue','name':{'first':'Irene','last':'Castro'},'company':'POLARIA','email':'irene.castro@polaria.org','phone':'+1 (818) 417-3761','address':'901 Dupont Street, Sperryville, Oklahoma, 953','about':'Pariatur minim laboris aliqua dolor aliquip consequat ea do duis voluptate id Lorem. In reprehenderit et adipisicing anim elit incididunt velit in laborum laborum. Qui minim magna et amet sit do voluptate reprehenderit ea sit sint velit.','registered':'Tuesday, August 18, 2015 10:48 AM','latitude':'-7.004055','longitude':'116.052433','tags':['sit','proident','enim','ullamco','non'],'greeting':'Hello, Irene! You have 10 unread messages.','favoriteFruit':'apple'}]" + } +} diff --git a/internal/cloud/testdata/plan-no-changes/main.tf b/internal/cloud/testdata/plan-no-changes/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan-no-changes/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan-policy-hard-failed/main.tf b/internal/cloud/testdata/plan-policy-hard-failed/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan-policy-hard-failed/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan-policy-passed/main.tf b/internal/cloud/testdata/plan-policy-passed/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan-policy-passed/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan-policy-soft-failed/main.tf b/internal/cloud/testdata/plan-policy-soft-failed/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan-policy-soft-failed/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan-variables/main.tf b/internal/cloud/testdata/plan-variables/main.tf new file mode 100644 index 000000000000..955e8b4c09af --- /dev/null +++ b/internal/cloud/testdata/plan-variables/main.tf @@ -0,0 +1,4 @@ +variable "foo" {} +variable "bar" {} + +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan-with-error/main.tf b/internal/cloud/testdata/plan-with-error/main.tf new file mode 100644 index 000000000000..bc45f28f5637 --- /dev/null +++ b/internal/cloud/testdata/plan-with-error/main.tf @@ -0,0 +1,5 @@ +resource "null_resource" "foo" { + triggers { + random = "${guid()}" + } +} diff --git a/internal/cloud/testdata/plan-with-working-directory/terraform/main.tf b/internal/cloud/testdata/plan-with-working-directory/terraform/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan-with-working-directory/terraform/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testdata/plan/main.tf b/internal/cloud/testdata/plan/main.tf new file mode 100644 index 000000000000..3911a2a9b2db --- /dev/null +++ b/internal/cloud/testdata/plan/main.tf @@ -0,0 +1 @@ +resource "null_resource" "foo" {} diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go new file mode 100644 index 000000000000..73668b2b0330 --- /dev/null +++ b/internal/cloud/testing.go @@ -0,0 +1,299 @@ +package cloud + +import ( + "context" + "fmt" + "io" + "net/http" + "net/http/httptest" + "path" + "testing" + + tfe "github.com/hashicorp/go-tfe" + svchost "github.com/hashicorp/terraform-svchost" + "github.com/hashicorp/terraform-svchost/auth" + "github.com/hashicorp/terraform-svchost/disco" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/httpclient" + "github.com/hashicorp/terraform/internal/providers" + "github.com/hashicorp/terraform/internal/states/remote" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/hashicorp/terraform/version" + "github.com/mitchellh/cli" + "github.com/zclconf/go-cty/cty" + + backendLocal "github.com/hashicorp/terraform/internal/backend/local" +) + +const ( + testCred = "test-auth-token" +) + +var ( + tfeHost = svchost.Hostname(defaultHostname) + credsSrc = auth.StaticCredentialsSource(map[svchost.Hostname]map[string]interface{}{ + tfeHost: {"token": testCred}, + }) +) + +func testInput(t *testing.T, answers map[string]string) *mockInput { + return &mockInput{answers: answers} +} + +func testBackendDefault(t *testing.T) (*Cloud, func()) { + obj := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }) + return testBackend(t, obj) +} + +func testBackendNoDefault(t *testing.T) (*Cloud, func()) { + obj := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.StringVal("my-app-"), + }), + }) + return testBackend(t, obj) +} + +func testBackendNoOperations(t *testing.T) (*Cloud, func()) { + obj := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("no-operations"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }) + return testBackend(t, obj) +} + +func testRemoteClient(t *testing.T) remote.Client { + b, bCleanup := testBackendDefault(t) + defer bCleanup() + + raw, err := b.StateMgr(backend.DefaultStateName) + if err != nil { + t.Fatalf("error: %v", err) + } + + return raw.(*remote.State).Client +} + +func testBackend(t *testing.T, obj cty.Value) (*Cloud, func()) { + s := testServer(t) + b := New(testDisco(s)) + + // Configure the backend so the client is created. + newObj, valDiags := b.PrepareConfig(obj) + if len(valDiags) != 0 { + t.Fatal(valDiags.ErrWithWarnings()) + } + obj = newObj + + confDiags := b.Configure(obj) + if len(confDiags) != 0 { + t.Fatal(confDiags.ErrWithWarnings()) + } + + // Get a new mock client. + mc := newMockClient() + + // Replace the services we use with our mock services. + b.CLI = cli.NewMockUi() + b.client.Applies = mc.Applies + b.client.ConfigurationVersions = mc.ConfigurationVersions + b.client.CostEstimates = mc.CostEstimates + b.client.Organizations = mc.Organizations + b.client.Plans = mc.Plans + b.client.PolicyChecks = mc.PolicyChecks + b.client.Runs = mc.Runs + b.client.StateVersions = mc.StateVersions + b.client.Variables = mc.Variables + b.client.Workspaces = mc.Workspaces + + // Set local to a local test backend. + b.local = testLocalBackend(t, b) + + ctx := context.Background() + + // Create the organization. + _, err := b.client.Organizations.Create(ctx, tfe.OrganizationCreateOptions{ + Name: tfe.String(b.organization), + }) + if err != nil { + t.Fatalf("error: %v", err) + } + + // Create the default workspace if required. + if b.workspace != "" { + _, err = b.client.Workspaces.Create(ctx, b.organization, tfe.WorkspaceCreateOptions{ + Name: tfe.String(b.workspace), + }) + if err != nil { + t.Fatalf("error: %v", err) + } + } + + return b, s.Close +} + +func testLocalBackend(t *testing.T, cloud *Cloud) backend.Enhanced { + b := backendLocal.NewWithBackend(cloud) + + // Add a test provider to the local backend. + p := backendLocal.TestLocalProvider(t, b, "null", &terraform.ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "null_resource": { + Attributes: map[string]*configschema.Attribute{ + "id": {Type: cty.String, Computed: true}, + }, + }, + }, + }) + p.ApplyResourceChangeResponse = &providers.ApplyResourceChangeResponse{NewState: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("yes"), + })} + + return b +} + +// testServer returns a *httptest.Server used for local testing. +func testServer(t *testing.T) *httptest.Server { + mux := http.NewServeMux() + + // Respond to service discovery calls. + mux.HandleFunc("/well-known/terraform.json", func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + io.WriteString(w, `{ + "state.v2": "/api/v2/", + "tfe.v2.1": "/api/v2/", + "versions.v1": "/v1/versions/" +}`) + }) + + // Respond to service version constraints calls. + mux.HandleFunc("/v1/versions/", func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + io.WriteString(w, fmt.Sprintf(`{ + "service": "%s", + "product": "terraform", + "minimum": "0.1.0", + "maximum": "10.0.0" +}`, path.Base(r.URL.Path))) + }) + + // Respond to pings to get the API version header. + mux.HandleFunc("/api/v2/ping", func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + w.Header().Set("TFP-API-Version", "2.4") + }) + + // Respond to the initial query to read the hashicorp org entitlements. + mux.HandleFunc("/api/v2/organizations/hashicorp/entitlement-set", func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/vnd.api+json") + io.WriteString(w, `{ + "data": { + "id": "org-GExadygjSbKP8hsY", + "type": "entitlement-sets", + "attributes": { + "operations": true, + "private-module-registry": true, + "sentinel": true, + "state-storage": true, + "teams": true, + "vcs-integrations": true + } + } +}`) + }) + + // Respond to the initial query to read the no-operations org entitlements. + mux.HandleFunc("/api/v2/organizations/no-operations/entitlement-set", func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/vnd.api+json") + io.WriteString(w, `{ + "data": { + "id": "org-ufxa3y8jSbKP8hsT", + "type": "entitlement-sets", + "attributes": { + "operations": false, + "private-module-registry": true, + "sentinel": true, + "state-storage": true, + "teams": true, + "vcs-integrations": true + } + } +}`) + }) + + // All tests that are assumed to pass will use the hashicorp organization, + // so for all other organization requests we will return a 404. + mux.HandleFunc("/api/v2/organizations/", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(404) + io.WriteString(w, `{ + "errors": [ + { + "status": "404", + "title": "not found" + } + ] +}`) + }) + + return httptest.NewServer(mux) +} + +// testDisco returns a *disco.Disco mapping app.terraform.io and +// localhost to a local test server. +func testDisco(s *httptest.Server) *disco.Disco { + services := map[string]interface{}{ + "state.v2": fmt.Sprintf("%s/api/v2/", s.URL), + "tfe.v2.1": fmt.Sprintf("%s/api/v2/", s.URL), + "versions.v1": fmt.Sprintf("%s/v1/versions/", s.URL), + } + d := disco.NewWithCredentialsSource(credsSrc) + d.SetUserAgent(httpclient.TerraformUserAgent(version.String())) + + d.ForceHostServices(svchost.Hostname(defaultHostname), services) + d.ForceHostServices(svchost.Hostname("localhost"), services) + return d +} + +type unparsedVariableValue struct { + value string + source terraform.ValueSourceType +} + +func (v *unparsedVariableValue) ParseVariableValue(mode configs.VariableParsingMode) (*terraform.InputValue, tfdiags.Diagnostics) { + return &terraform.InputValue{ + Value: cty.StringVal(v.value), + SourceType: v.source, + }, tfdiags.Diagnostics{} +} + +// testVariable returns a backend.UnparsedVariableValue used for testing. +func testVariables(s terraform.ValueSourceType, vs ...string) map[string]backend.UnparsedVariableValue { + vars := make(map[string]backend.UnparsedVariableValue, len(vs)) + for _, v := range vs { + vars[v] = &unparsedVariableValue{ + value: v, + source: s, + } + } + return vars +} From a5f063625a189bd8e3e1a40e57bc63ff68349c49 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 20 Aug 2021 22:12:29 -0500 Subject: [PATCH 198/644] Replace generic host error messages for feature support --- internal/cloud/backend_apply.go | 8 ++++---- internal/cloud/backend_plan.go | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/internal/cloud/backend_apply.go b/internal/cloud/backend_apply.go index e50f1ee60da8..b52719593500 100644 --- a/internal/cloud/backend_apply.go +++ b/internal/cloud/backend_apply.go @@ -100,7 +100,7 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio tfdiags.Error, "Planning without refresh is not supported", fmt.Sprintf( - `The host %s does not support the -refresh=false option for `+ + `The Terraform Enterprise installation at %s does not support the -refresh=false option for `+ `remote plans.`, b.hostname, ), @@ -116,7 +116,7 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio tfdiags.Error, "Refresh-only mode is not supported", fmt.Sprintf( - `The host %s does not support -refresh-only mode for `+ + `The Terraform Enterprise installation at %s does not support -refresh-only mode for `+ `remote plans.`, b.hostname, ), @@ -132,7 +132,7 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio tfdiags.Error, "Planning resource replacements is not supported", fmt.Sprintf( - `The host %s does not support the -replace option for `+ + `The Terraform Enterprise installation at %s does not support the -replace option for `+ `remote plans.`, b.hostname, ), @@ -148,7 +148,7 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio tfdiags.Error, "Resource targeting is not supported", fmt.Sprintf( - `The host %s does not support the -target option for `+ + `The Terraform Enterprise installation at %s does not support the -target option for `+ `remote plans.`, b.hostname, ), diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 025b3677664f..3e3916b36ca5 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -106,7 +106,7 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation tfdiags.Error, "Resource targeting is not supported", fmt.Sprintf( - `The host %s does not support the -target option for `+ + `The Terraform Enterprise installation at %s does not support the -target option for `+ `remote plans.`, b.hostname, ), @@ -122,7 +122,7 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation tfdiags.Error, "Planning without refresh is not supported", fmt.Sprintf( - `The host %s does not support the -refresh=false option for `+ + `The Terraform Enterprise installation at %s does not support the -refresh=false option for `+ `remote plans.`, b.hostname, ), @@ -138,7 +138,7 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation tfdiags.Error, "Planning resource replacements is not supported", fmt.Sprintf( - `The host %s does not support the -replace option for `+ + `The Terraform Enterprise installation at %s does not support the -replace option for `+ `remote plans.`, b.hostname, ), @@ -154,7 +154,7 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation tfdiags.Error, "Refresh-only mode is not supported", fmt.Sprintf( - `The host %s does not support -refresh-only mode for `+ + `The Terraform Enterprise installation at %s does not support -refresh-only mode for `+ `remote plans.`, b.hostname, ), From a4c24e314719a08f859d309f37ea35c7f95c075f Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 24 Aug 2021 14:28:12 -0500 Subject: [PATCH 199/644] Add cloud {} configuration block for Terraform Cloud This is a replacement declaration for using Terraform Cloud as a remote backend, leaving the literal backend as an implementation detail and not a user-level concept. --- internal/command/console.go | 2 +- internal/command/graph.go | 2 +- internal/command/import.go | 2 +- internal/command/init.go | 33 +++++++++++++++++-- internal/command/meta_backend.go | 26 +++++++++------ internal/command/meta_backend_migrate.go | 8 ++--- internal/command/meta_config.go | 6 ++++ internal/command/output.go | 2 +- internal/command/providers.go | 2 +- internal/command/providers_schema.go | 2 +- internal/command/show.go | 2 +- internal/command/state_list.go | 2 +- internal/command/state_meta.go | 2 +- internal/command/state_pull.go | 2 +- internal/command/state_push.go | 2 +- internal/command/state_show.go | 2 +- internal/command/taint.go | 2 +- internal/command/untaint.go | 2 +- internal/command/workspace_delete.go | 2 +- internal/command/workspace_list.go | 2 +- internal/command/workspace_new.go | 2 +- internal/command/workspace_select.go | 2 +- internal/configs/cloud.go | 27 +++++++++++++++ internal/configs/module.go | 25 ++++++++++++++ internal/configs/parser_config.go | 10 ++++++ .../nested-cloud-warning/child/child.tf | 6 ++++ .../testdata/nested-cloud-warning/root.tf | 3 ++ .../configs/testdata/valid-files/cloud.tf | 10 ++++++ 28 files changed, 155 insertions(+), 35 deletions(-) create mode 100644 internal/configs/cloud.go create mode 100644 internal/configs/testdata/nested-cloud-warning/child/child.tf create mode 100644 internal/configs/testdata/nested-cloud-warning/root.tf create mode 100644 internal/configs/testdata/valid-files/cloud.tf diff --git a/internal/command/console.go b/internal/command/console.go index 3195988683b0..a29007128ff5 100644 --- a/internal/command/console.go +++ b/internal/command/console.go @@ -72,7 +72,7 @@ func (c *ConsoleCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // Build the operation opReq := c.Operation(b) diff --git a/internal/command/graph.go b/internal/command/graph.go index 87880a855732..4fe742804928 100644 --- a/internal/command/graph.go +++ b/internal/command/graph.go @@ -88,7 +88,7 @@ func (c *GraphCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // Build the operation opReq := c.Operation(b) diff --git a/internal/command/import.go b/internal/command/import.go index 7fc61a2f0c9d..a576a29e4047 100644 --- a/internal/command/import.go +++ b/internal/command/import.go @@ -204,7 +204,7 @@ func (c *ImportCommand) Run(args []string) int { opReq.View = views.NewOperation(arguments.ViewHuman, c.RunningInAutomation, c.View) // Check remote Terraform version is compatible - remoteVersionDiags := c.remoteBackendVersionCheck(b, opReq.Workspace) + remoteVersionDiags := c.remoteVersionCheck(b, opReq.Workspace) diags = diags.Append(remoteVersionDiags) c.showDiagnostics(diags) if diags.HasErrors() { diff --git a/internal/command/init.go b/internal/command/init.go index 8f8c5b829ee5..8591f0c53a99 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -209,8 +209,20 @@ func (c *InitCommand) Run(args []string) int { } var back backend.Backend - if flagBackend { + switch { + case config.Module.CloudConfig != nil: + be, backendOutput, backendDiags := c.initCloud(config.Module) + diags = diags.Append(backendDiags) + if backendDiags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } + if backendOutput { + header = true + } + back = be + case flagBackend: be, backendOutput, backendDiags := c.initBackend(config.Module, flagConfigExtra) diags = diags.Append(backendDiags) if backendDiags.HasErrors() { @@ -221,7 +233,7 @@ func (c *InitCommand) Run(args []string) int { header = true } back = be - } else { + default: // load the previously-stored backend config be, backendDiags := c.Meta.backendFromState() diags = diags.Append(backendDiags) @@ -251,7 +263,7 @@ func (c *InitCommand) Run(args []string) int { // on a previous run) we'll use the current state as a potential source // of provider dependencies. if back != nil { - c.ignoreRemoteBackendVersionConflict(back) + c.ignoreRemoteVersionConflict(back) workspace, err := c.Workspace() if err != nil { c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err)) @@ -337,6 +349,21 @@ func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrad return true, diags } +func (c *InitCommand) initCloud(root *configs.Module) (be backend.Backend, output bool, diags tfdiags.Diagnostics) { + c.Ui.Output(c.Colorize().Color("\n[reset][bold]Initializing Terraform Cloud...")) + + backendConfig := root.CloudConfig.ToBackendConfig() + + opts := &BackendOpts{ + Config: &backendConfig, + Init: true, + } + + back, backDiags := c.Backend(opts) + diags = diags.Append(backDiags) + return back, true, diags +} + func (c *InitCommand) initBackend(root *configs.Module, extraConfig rawFlags) (be backend.Backend, output bool, diags tfdiags.Diagnostics) { c.Ui.Output(c.Colorize().Color("\n[reset][bold]Initializing the backend...")) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 042e7cfff980..58cafdd4ff2f 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -17,7 +17,6 @@ import ( "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hcldec" "github.com/hashicorp/terraform/internal/backend" - remoteBackend "github.com/hashicorp/terraform/internal/backend/remote" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" @@ -55,6 +54,13 @@ type BackendOpts struct { ForceLocal bool } +// BackendWithRemoteTerraformVersion is a shared interface between the 'remote' and 'cloud' backends +// for simplified type checking when calling functions common to those particular backends. +type BackendWithRemoteTerraformVersion interface { + IgnoreVersionConflict() + VerifyWorkspaceTerraformVersion(workspace string) tfdiags.Diagnostics +} + // Backend initializes and returns the backend for this CLI session. // // The backend is used to perform the actual Terraform operations. This @@ -1168,32 +1174,32 @@ func (m *Meta) backendInitFromConfig(c *configs.Backend) (backend.Backend, cty.V return b, configVal, diags } -// Helper method to ignore remote backend version conflicts. Only call this +// Helper method to ignore remote/cloud backend version conflicts. Only call this // for commands which cannot accidentally upgrade remote state files. -func (m *Meta) ignoreRemoteBackendVersionConflict(b backend.Backend) { - if rb, ok := b.(*remoteBackend.Remote); ok { - rb.IgnoreVersionConflict() +func (m *Meta) ignoreRemoteVersionConflict(b backend.Backend) { + if back, ok := b.(BackendWithRemoteTerraformVersion); ok { + back.IgnoreVersionConflict() } } // Helper method to check the local Terraform version against the configured // version in the remote workspace, returning diagnostics if they conflict. -func (m *Meta) remoteBackendVersionCheck(b backend.Backend, workspace string) tfdiags.Diagnostics { +func (m *Meta) remoteVersionCheck(b backend.Backend, workspace string) tfdiags.Diagnostics { var diags tfdiags.Diagnostics - if rb, ok := b.(*remoteBackend.Remote); ok { + if back, ok := b.(BackendWithRemoteTerraformVersion); ok { // Allow user override based on command-line flag if m.ignoreRemoteVersion { - rb.IgnoreVersionConflict() + back.IgnoreVersionConflict() } // If the override is set, this check will return a warning instead of // an error - versionDiags := rb.VerifyWorkspaceTerraformVersion(workspace) + versionDiags := back.VerifyWorkspaceTerraformVersion(workspace) diags = diags.Append(versionDiags) // If there are no errors resulting from this check, we do not need to // check again if !diags.HasErrors() { - rb.IgnoreVersionConflict() + back.IgnoreVersionConflict() } } diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 15206bf8ae3c..e998b0ffdf00 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -75,17 +75,17 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { // Disregard remote Terraform version for the state source backend. If it's a // Terraform Cloud remote backend, we don't care about the remote version, // as we are migrating away and will not break a remote workspace. - m.ignoreRemoteBackendVersionConflict(opts.Source) + m.ignoreRemoteVersionConflict(opts.Source) // Disregard remote Terraform version if instructed to do so via CLI flag. if m.ignoreRemoteVersion { - m.ignoreRemoteBackendVersionConflict(opts.Destination) + m.ignoreRemoteVersionConflict(opts.Destination) } else { // Check the remote Terraform version for the state destination backend. If // it's a Terraform Cloud remote backend, we want to ensure that we don't // break the workspace by uploading an incompatible state file. for _, workspace := range destinationWorkspaces { - diags := m.remoteBackendVersionCheck(opts.Destination, workspace) + diags := m.remoteVersionCheck(opts.Destination, workspace) if diags.HasErrors() { return diags.Err() } @@ -93,7 +93,7 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { // If there are no specified destination workspaces, perform a remote // backend version check with the default workspace. if len(destinationWorkspaces) == 0 { - diags := m.remoteBackendVersionCheck(opts.Destination, backend.DefaultStateName) + diags := m.remoteVersionCheck(opts.Destination, backend.DefaultStateName) if diags.HasErrors() { return diags.Err() } diff --git a/internal/command/meta_config.go b/internal/command/meta_config.go index 439df6b9130b..6913db594449 100644 --- a/internal/command/meta_config.go +++ b/internal/command/meta_config.go @@ -136,6 +136,12 @@ func (m *Meta) loadBackendConfig(rootDir string) (*configs.Backend, tfdiags.Diag if diags.HasErrors() { return nil, diags } + + if mod.CloudConfig != nil { + backendConfig := mod.CloudConfig.ToBackendConfig() + return &backendConfig, nil + } + return mod.Backend, nil } diff --git a/internal/command/output.go b/internal/command/output.go index 3594fe33d333..0f23a6109f43 100644 --- a/internal/command/output.go +++ b/internal/command/output.go @@ -67,7 +67,7 @@ func (c *OutputCommand) Outputs(statePath string) (map[string]*states.OutputValu } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) env, err := c.Workspace() if err != nil { diff --git a/internal/command/providers.go b/internal/command/providers.go index 31fd79594856..5bc0d4e6c387 100644 --- a/internal/command/providers.go +++ b/internal/command/providers.go @@ -83,7 +83,7 @@ func (c *ProvidersCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // Get the state env, err := c.Workspace() diff --git a/internal/command/providers_schema.go b/internal/command/providers_schema.go index 372564f12217..b4d61ec76428 100644 --- a/internal/command/providers_schema.go +++ b/internal/command/providers_schema.go @@ -68,7 +68,7 @@ func (c *ProvidersSchemaCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // we expect that the config dir is the cwd cwd, err := os.Getwd() diff --git a/internal/command/show.go b/internal/command/show.go index 9886768cad91..6ae66beeb520 100644 --- a/internal/command/show.go +++ b/internal/command/show.go @@ -70,7 +70,7 @@ func (c *ShowCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // the show command expects the config dir to always be the cwd cwd, err := os.Getwd() diff --git a/internal/command/state_list.go b/internal/command/state_list.go index ebd318bc88c6..54358b28d702 100644 --- a/internal/command/state_list.go +++ b/internal/command/state_list.go @@ -41,7 +41,7 @@ func (c *StateListCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // Get the state env, err := c.Workspace() diff --git a/internal/command/state_meta.go b/internal/command/state_meta.go index fa04245a6c37..17959f5ff90f 100644 --- a/internal/command/state_meta.go +++ b/internal/command/state_meta.go @@ -43,7 +43,7 @@ func (c *StateMeta) State() (statemgr.Full, error) { } // Check remote Terraform version is compatible - remoteVersionDiags := c.remoteBackendVersionCheck(b, workspace) + remoteVersionDiags := c.remoteVersionCheck(b, workspace) c.showDiagnostics(remoteVersionDiags) if remoteVersionDiags.HasErrors() { return nil, fmt.Errorf("Error checking remote Terraform version") diff --git a/internal/command/state_pull.go b/internal/command/state_pull.go index 0616df2d4f9f..8ce16ff57bc5 100644 --- a/internal/command/state_pull.go +++ b/internal/command/state_pull.go @@ -31,7 +31,7 @@ func (c *StatePullCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // Get the state manager for the current workspace env, err := c.Workspace() diff --git a/internal/command/state_push.go b/internal/command/state_push.go index 117611e944e6..eb0ea1679654 100644 --- a/internal/command/state_push.go +++ b/internal/command/state_push.go @@ -80,7 +80,7 @@ func (c *StatePushCommand) Run(args []string) int { } // Check remote Terraform version is compatible - remoteVersionDiags := c.remoteBackendVersionCheck(b, workspace) + remoteVersionDiags := c.remoteVersionCheck(b, workspace) c.showDiagnostics(remoteVersionDiags) if remoteVersionDiags.HasErrors() { return 1 diff --git a/internal/command/state_show.go b/internal/command/state_show.go index e95eca70fe66..7ee86624dfbc 100644 --- a/internal/command/state_show.go +++ b/internal/command/state_show.go @@ -54,7 +54,7 @@ func (c *StateShowCommand) Run(args []string) int { } // This is a read-only command - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) // Check if the address can be parsed addr, addrDiags := addrs.ParseAbsResourceInstanceStr(args[0]) diff --git a/internal/command/taint.go b/internal/command/taint.go index 46e92d6d64eb..f2fbbb1efba9 100644 --- a/internal/command/taint.go +++ b/internal/command/taint.go @@ -102,7 +102,7 @@ func (c *TaintCommand) Run(args []string) int { } // Check remote Terraform version is compatible - remoteVersionDiags := c.remoteBackendVersionCheck(b, workspace) + remoteVersionDiags := c.remoteVersionCheck(b, workspace) diags = diags.Append(remoteVersionDiags) c.showDiagnostics(diags) if diags.HasErrors() { diff --git a/internal/command/untaint.go b/internal/command/untaint.go index 98f203560596..ba290a8a47a9 100644 --- a/internal/command/untaint.go +++ b/internal/command/untaint.go @@ -67,7 +67,7 @@ func (c *UntaintCommand) Run(args []string) int { } // Check remote Terraform version is compatible - remoteVersionDiags := c.remoteBackendVersionCheck(b, workspace) + remoteVersionDiags := c.remoteVersionCheck(b, workspace) diags = diags.Append(remoteVersionDiags) c.showDiagnostics(diags) if diags.HasErrors() { diff --git a/internal/command/workspace_delete.go b/internal/command/workspace_delete.go index 5c826d9084e7..654aac581dd6 100644 --- a/internal/command/workspace_delete.go +++ b/internal/command/workspace_delete.go @@ -68,7 +68,7 @@ func (c *WorkspaceDeleteCommand) Run(args []string) int { } // This command will not write state - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) workspaces, err := b.Workspaces() if err != nil { diff --git a/internal/command/workspace_list.go b/internal/command/workspace_list.go index aac6bc97d83a..7b43bc34627d 100644 --- a/internal/command/workspace_list.go +++ b/internal/command/workspace_list.go @@ -52,7 +52,7 @@ func (c *WorkspaceListCommand) Run(args []string) int { } // This command will not write state - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) states, err := b.Workspaces() if err != nil { diff --git a/internal/command/workspace_new.go b/internal/command/workspace_new.go index 1d7b2898c068..41e657bef5da 100644 --- a/internal/command/workspace_new.go +++ b/internal/command/workspace_new.go @@ -83,7 +83,7 @@ func (c *WorkspaceNewCommand) Run(args []string) int { } // This command will not write state - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) workspaces, err := b.Workspaces() if err != nil { diff --git a/internal/command/workspace_select.go b/internal/command/workspace_select.go index 645a9c2bcb1d..1f98ec55e0a2 100644 --- a/internal/command/workspace_select.go +++ b/internal/command/workspace_select.go @@ -68,7 +68,7 @@ func (c *WorkspaceSelectCommand) Run(args []string) int { } // This command will not write state - c.ignoreRemoteBackendVersionConflict(b) + c.ignoreRemoteVersionConflict(b) name := args[0] if !validWorkspaceName(name) { diff --git a/internal/configs/cloud.go b/internal/configs/cloud.go new file mode 100644 index 000000000000..1ed6482e1664 --- /dev/null +++ b/internal/configs/cloud.go @@ -0,0 +1,27 @@ +package configs + +import ( + "github.com/hashicorp/hcl/v2" +) + +// Cloud represents a "cloud" block inside a "terraform" block in a module +// or file. +type CloudConfig struct { + Config hcl.Body + + DeclRange hcl.Range +} + +func decodeCloudBlock(block *hcl.Block) (*CloudConfig, hcl.Diagnostics) { + return &CloudConfig{ + Config: block.Body, + DeclRange: block.DefRange, + }, nil +} + +func (c *CloudConfig) ToBackendConfig() Backend { + return Backend{ + Type: "cloud", + Config: c.Config, + } +} diff --git a/internal/configs/module.go b/internal/configs/module.go index 18676de9d85d..ff98676304d1 100644 --- a/internal/configs/module.go +++ b/internal/configs/module.go @@ -29,6 +29,7 @@ type Module struct { ActiveExperiments experiments.Set Backend *Backend + CloudConfig *CloudConfig ProviderConfigs map[string]*Provider ProviderRequirements *RequiredProviders ProviderLocalNames map[addrs.Provider]string @@ -63,6 +64,7 @@ type File struct { ActiveExperiments experiments.Set Backends []*Backend + CloudConfigs []*CloudConfig ProviderConfigs []*Provider ProviderMetas []*ProviderMeta RequiredProviders []*RequiredProviders @@ -190,6 +192,29 @@ func (m *Module) appendFile(file *File) hcl.Diagnostics { m.Backend = b } + for _, c := range file.CloudConfigs { + if m.CloudConfig != nil { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Duplicate Terraform Cloud configurations", + Detail: fmt.Sprintf("A module may have only one 'cloud' block configuring Terraform Cloud. Terraform Cloud was previously configured at %s.", m.CloudConfig.DeclRange), + Subject: &c.DeclRange, + }) + continue + } + + m.CloudConfig = c + } + + if m.Backend != nil && m.CloudConfig != nil { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Both a backend and Terraform Cloud configuration are present", + Detail: fmt.Sprintf("A module may declare either one 'cloud' block configuring Terraform Cloud OR one 'backend' block configuring a state backend. Terraform Cloud is configured at %s; a backend is configured at %s. Remove the backend block to configure Terraform Cloud.", m.CloudConfig.DeclRange, m.Backend.DeclRange), + Subject: &m.Backend.DeclRange, + }) + } + for _, pc := range file.ProviderConfigs { key := pc.moduleUniqueKey() if existing, exists := m.ProviderConfigs[key]; exists { diff --git a/internal/configs/parser_config.go b/internal/configs/parser_config.go index 4be14501d7f4..caebb89118af 100644 --- a/internal/configs/parser_config.go +++ b/internal/configs/parser_config.go @@ -72,6 +72,13 @@ func (p *Parser) loadConfigFile(path string, override bool) (*File, hcl.Diagnost file.Backends = append(file.Backends, backendCfg) } + case "cloud": + cloudCfg, cfgDiags := decodeCloudBlock(innerBlock) + diags = append(diags, cfgDiags...) + if cloudCfg != nil { + file.CloudConfigs = append(file.CloudConfigs, cloudCfg) + } + case "required_providers": reqs, reqsDiags := decodeRequiredProvidersBlock(innerBlock) diags = append(diags, reqsDiags...) @@ -261,6 +268,9 @@ var terraformBlockSchema = &hcl.BodySchema{ Type: "backend", LabelNames: []string{"type"}, }, + { + Type: "cloud", + }, { Type: "required_providers", }, diff --git a/internal/configs/testdata/nested-cloud-warning/child/child.tf b/internal/configs/testdata/nested-cloud-warning/child/child.tf new file mode 100644 index 000000000000..540b92170739 --- /dev/null +++ b/internal/configs/testdata/nested-cloud-warning/child/child.tf @@ -0,0 +1,6 @@ +terraform { + # Only the root module can declare a Cloud configuration. Terraform should emit a warning + # about this child module Cloud declaration. + cloud { + } +} diff --git a/internal/configs/testdata/nested-cloud-warning/root.tf b/internal/configs/testdata/nested-cloud-warning/root.tf new file mode 100644 index 000000000000..1f95749fa7ea --- /dev/null +++ b/internal/configs/testdata/nested-cloud-warning/root.tf @@ -0,0 +1,3 @@ +module "child" { + source = "./child" +} diff --git a/internal/configs/testdata/valid-files/cloud.tf b/internal/configs/testdata/valid-files/cloud.tf new file mode 100644 index 000000000000..91985fcad9d1 --- /dev/null +++ b/internal/configs/testdata/valid-files/cloud.tf @@ -0,0 +1,10 @@ + +terraform { + cloud { + foo = "bar" + + baz { + bar = "foo" + } + } +} From fccc873a3d714cfc1a1ec7e1e4f2392d645b57b6 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 24 Aug 2021 14:34:34 -0500 Subject: [PATCH 200/644] Remove ability to declare a 'cloud' backend With the alternative block introduced in 7bf9b2c7b, this removes the ability to explicitly declare the 'cloud' backend. The literal backend interface is an implementation detail and no longer a user-level concept when using Terraform Cloud. --- internal/command/init.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/internal/command/init.go b/internal/command/init.go index 8591f0c53a99..d88ec181ef37 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -371,6 +371,16 @@ func (c *InitCommand) initBackend(root *configs.Module, extraConfig rawFlags) (b var backendConfigOverride hcl.Body if root.Backend != nil { backendType := root.Backend.Type + if backendType == "cloud" { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Unsupported backend type", + Detail: fmt.Sprintf("There is no explicit backend type named %q. To configure Terraform Cloud, declare a 'cloud' block instead.", backendType), + Subject: &root.Backend.TypeRange, + }) + return nil, true, diags + } + bf := backendInit.Backend(backendType) if bf == nil { diags = diags.Append(&hcl.Diagnostic{ From 07b3d015d1c5952c999a89b802cd54f50cf6bdbc Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 25 Aug 2021 22:16:57 -0500 Subject: [PATCH 201/644] Defer cloud block overrides This restriction is temporary. Overrides should be allowed, but have the added complexity of needing to also override a 'backend' block, so this work is being deferred for now. --- internal/configs/module.go | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/internal/configs/module.go b/internal/configs/module.go index ff98676304d1..b75cc7fd57f2 100644 --- a/internal/configs/module.go +++ b/internal/configs/module.go @@ -392,6 +392,18 @@ func (m *Module) mergeFile(file *File) hcl.Diagnostics { } } + // TODO: This restriction is temporary. Overrides should be allowed, but have the added + // complexity of needing to also override a 'backend' block, so this work is being deferred + // for now. + for _, m := range file.CloudConfigs { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Cannot override 'cloud' configuration", + Detail: "Terraform Cloud configuration blocks can appear only in normal files, not in override files.", + Subject: m.DeclRange.Ptr(), + }) + } + for _, pc := range file.ProviderConfigs { key := pc.moduleUniqueKey() existing, exists := m.ProviderConfigs[key] From 18d54c11290fc1300fe3419fd577c14068e922e6 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 27 Aug 2021 12:13:41 -0500 Subject: [PATCH 202/644] Allow cloud block overrides These changes allow cloud blocks to be overridden by backend blocks and vice versa; the logic follows the current backend behavior of a block overriding a preceding block in full, with no merges. --- internal/configs/module.go | 26 +++-- internal/configs/module_test.go | 103 ++++++++++++++++++ .../override-cloud-duplicates/main.tf | 14 +++ .../override-cloud-duplicates/override.tf | 11 ++ .../override-backend-no-base/main.tf | 7 ++ .../override-backend-no-base/override.tf | 5 + .../override-backend-with-cloud/main.tf | 13 +++ .../override-backend-with-cloud/override.tf | 5 + .../valid-modules/override-backend/main.tf | 13 +++ .../override-backend/override.tf | 5 + .../override-cloud-no-base/main.tf | 7 ++ .../override-cloud-no-base/override.tf | 5 + .../valid-modules/override-cloud/main.tf | 14 +++ .../valid-modules/override-cloud/override.tf | 5 + 14 files changed, 223 insertions(+), 10 deletions(-) create mode 100644 internal/configs/testdata/invalid-modules/override-cloud-duplicates/main.tf create mode 100644 internal/configs/testdata/invalid-modules/override-cloud-duplicates/override.tf create mode 100644 internal/configs/testdata/valid-modules/override-backend-no-base/main.tf create mode 100644 internal/configs/testdata/valid-modules/override-backend-no-base/override.tf create mode 100644 internal/configs/testdata/valid-modules/override-backend-with-cloud/main.tf create mode 100644 internal/configs/testdata/valid-modules/override-backend-with-cloud/override.tf create mode 100644 internal/configs/testdata/valid-modules/override-backend/main.tf create mode 100644 internal/configs/testdata/valid-modules/override-backend/override.tf create mode 100644 internal/configs/testdata/valid-modules/override-cloud-no-base/main.tf create mode 100644 internal/configs/testdata/valid-modules/override-cloud-no-base/override.tf create mode 100644 internal/configs/testdata/valid-modules/override-cloud/main.tf create mode 100644 internal/configs/testdata/valid-modules/override-cloud/override.tf diff --git a/internal/configs/module.go b/internal/configs/module.go index b75cc7fd57f2..c2088b9fde9c 100644 --- a/internal/configs/module.go +++ b/internal/configs/module.go @@ -379,6 +379,7 @@ func (m *Module) mergeFile(file *File) hcl.Diagnostics { if len(file.Backends) != 0 { switch len(file.Backends) { case 1: + m.CloudConfig = nil // A backend block is mutually exclusive with a cloud one, and overwrites any cloud config m.Backend = file.Backends[0] default: // An override file with multiple backends is still invalid, even @@ -392,16 +393,21 @@ func (m *Module) mergeFile(file *File) hcl.Diagnostics { } } - // TODO: This restriction is temporary. Overrides should be allowed, but have the added - // complexity of needing to also override a 'backend' block, so this work is being deferred - // for now. - for _, m := range file.CloudConfigs { - diags = append(diags, &hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Cannot override 'cloud' configuration", - Detail: "Terraform Cloud configuration blocks can appear only in normal files, not in override files.", - Subject: m.DeclRange.Ptr(), - }) + if len(file.CloudConfigs) != 0 { + switch len(file.CloudConfigs) { + case 1: + m.Backend = nil // A cloud block is mutually exclusive with a backend one, and overwrites any backend + m.CloudConfig = file.CloudConfigs[0] + default: + // An override file with multiple cloud blocks is still invalid, even + // though it can override cloud/backend blocks from _other_ files. + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Duplicate Terraform Cloud configurations", + Detail: fmt.Sprintf("A module may have only one 'cloud' block configuring Terraform Cloud. Terraform Cloud was previously configured at %s.", file.CloudConfigs[0].DeclRange), + Subject: &file.CloudConfigs[1].DeclRange, + }) + } } for _, pc := range file.ProviderConfigs { diff --git a/internal/configs/module_test.go b/internal/configs/module_test.go index 394eaff1c247..3eea93d37db8 100644 --- a/internal/configs/module_test.go +++ b/internal/configs/module_test.go @@ -5,6 +5,7 @@ import ( "testing" "github.com/hashicorp/terraform/internal/addrs" + "github.com/zclconf/go-cty/cty" ) // TestNewModule_provider_fqns exercises module.gatherProviderLocalNames() @@ -309,3 +310,105 @@ func TestImpliedProviderForUnqualifiedType(t *testing.T) { } } } + +func TestModule_backend_override(t *testing.T) { + mod, diags := testModuleFromDir("testdata/valid-modules/override-backend") + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + gotType := mod.Backend.Type + wantType := "bar" + + if gotType != wantType { + t.Errorf("wrong result for backend type: got %#v, want %#v\n", gotType, wantType) + } + + attrs, _ := mod.Backend.Config.JustAttributes() + + gotAttr, diags := attrs["path"].Expr.Value(nil) + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + wantAttr := cty.StringVal("CHANGED/relative/path/to/terraform.tfstate") + + if !gotAttr.RawEquals(wantAttr) { + t.Errorf("wrong result for backend 'path': got %#v, want %#v\n", gotAttr, wantAttr) + } +} + +// Unlike most other overrides, backend blocks do not require a base configuration in a primary +// configuration file, as an omitted backend there implies the local backend. +func TestModule_backend_override_no_base(t *testing.T) { + mod, diags := testModuleFromDir("testdata/valid-modules/override-backend-no-base") + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + if mod.Backend == nil { + t.Errorf("expected module Backend not to be nil") + } +} + +func TestModule_cloud_override_backend(t *testing.T) { + mod, diags := testModuleFromDir("testdata/valid-modules/override-backend-with-cloud") + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + if mod.Backend != nil { + t.Errorf("expected module Backend to be nil") + } + + if mod.CloudConfig == nil { + t.Errorf("expected module CloudConfig not to be nil") + } +} + +// Unlike most other overrides, cloud blocks do not require a base configuration in a primary +// configuration file, as an omitted backend there implies the local backend and cloud blocks +// override backends. +func TestModule_cloud_override_no_base(t *testing.T) { + mod, diags := testModuleFromDir("testdata/valid-modules/override-cloud-no-base") + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + if mod.CloudConfig == nil { + t.Errorf("expected module CloudConfig not to be nil") + } +} + +func TestModule_cloud_override(t *testing.T) { + mod, diags := testModuleFromDir("testdata/valid-modules/override-cloud") + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + attrs, _ := mod.CloudConfig.Config.JustAttributes() + + gotAttr, diags := attrs["organization"].Expr.Value(nil) + if diags.HasErrors() { + t.Fatal(diags.Error()) + } + + wantAttr := cty.StringVal("CHANGED") + + if !gotAttr.RawEquals(wantAttr) { + t.Errorf("wrong result for Cloud 'organization': got %#v, want %#v\n", gotAttr, wantAttr) + } + + // The override should have completely replaced the cloud block in the primary file, no merging + if attrs["should_not_be_present_with_override"] != nil { + t.Errorf("expected 'should_not_be_present_with_override' attribute to be nil") + } +} + +func TestModule_cloud_duplicate_overrides(t *testing.T) { + _, diags := testModuleFromDir("testdata/invalid-modules/override-cloud-duplicates") + want := `Duplicate Terraform Cloud configurations` + if got := diags.Error(); !strings.Contains(got, want) { + t.Fatalf("expected module error to contain %q\nerror was:\n%s", want, got) + } +} diff --git a/internal/configs/testdata/invalid-modules/override-cloud-duplicates/main.tf b/internal/configs/testdata/invalid-modules/override-cloud-duplicates/main.tf new file mode 100644 index 000000000000..2de9a58dd38c --- /dev/null +++ b/internal/configs/testdata/invalid-modules/override-cloud-duplicates/main.tf @@ -0,0 +1,14 @@ +terraform { + cloud { + organization = "foo" + should_not_be_present_with_override = true + } +} + +resource "aws_instance" "web" { + ami = "ami-1234" + security_groups = [ + "foo", + "bar", + ] +} diff --git a/internal/configs/testdata/invalid-modules/override-cloud-duplicates/override.tf b/internal/configs/testdata/invalid-modules/override-cloud-duplicates/override.tf new file mode 100644 index 000000000000..17ef011509fd --- /dev/null +++ b/internal/configs/testdata/invalid-modules/override-cloud-duplicates/override.tf @@ -0,0 +1,11 @@ +terraform { + cloud { + organization = "foo" + } +} + +terraform { + cloud { + organization = "bar" + } +} diff --git a/internal/configs/testdata/valid-modules/override-backend-no-base/main.tf b/internal/configs/testdata/valid-modules/override-backend-no-base/main.tf new file mode 100644 index 000000000000..7bb1380e65fd --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-backend-no-base/main.tf @@ -0,0 +1,7 @@ +resource "aws_instance" "web" { + ami = "ami-1234" + security_groups = [ + "foo", + "bar", + ] +} diff --git a/internal/configs/testdata/valid-modules/override-backend-no-base/override.tf b/internal/configs/testdata/valid-modules/override-backend-no-base/override.tf new file mode 100644 index 000000000000..d57fade63e8c --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-backend-no-base/override.tf @@ -0,0 +1,5 @@ +terraform { + backend "bar" { + path = "CHANGED/relative/path/to/terraform.tfstate" + } +} diff --git a/internal/configs/testdata/valid-modules/override-backend-with-cloud/main.tf b/internal/configs/testdata/valid-modules/override-backend-with-cloud/main.tf new file mode 100644 index 000000000000..56fb72f3295c --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-backend-with-cloud/main.tf @@ -0,0 +1,13 @@ +terraform { + backend "foo" { + path = "relative/path/to/terraform.tfstate" + } +} + +resource "aws_instance" "web" { + ami = "ami-1234" + security_groups = [ + "foo", + "bar", + ] +} diff --git a/internal/configs/testdata/valid-modules/override-backend-with-cloud/override.tf b/internal/configs/testdata/valid-modules/override-backend-with-cloud/override.tf new file mode 100644 index 000000000000..51ae925fb988 --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-backend-with-cloud/override.tf @@ -0,0 +1,5 @@ +terraform { + cloud { + organization = "foo" + } +} diff --git a/internal/configs/testdata/valid-modules/override-backend/main.tf b/internal/configs/testdata/valid-modules/override-backend/main.tf new file mode 100644 index 000000000000..56fb72f3295c --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-backend/main.tf @@ -0,0 +1,13 @@ +terraform { + backend "foo" { + path = "relative/path/to/terraform.tfstate" + } +} + +resource "aws_instance" "web" { + ami = "ami-1234" + security_groups = [ + "foo", + "bar", + ] +} diff --git a/internal/configs/testdata/valid-modules/override-backend/override.tf b/internal/configs/testdata/valid-modules/override-backend/override.tf new file mode 100644 index 000000000000..d57fade63e8c --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-backend/override.tf @@ -0,0 +1,5 @@ +terraform { + backend "bar" { + path = "CHANGED/relative/path/to/terraform.tfstate" + } +} diff --git a/internal/configs/testdata/valid-modules/override-cloud-no-base/main.tf b/internal/configs/testdata/valid-modules/override-cloud-no-base/main.tf new file mode 100644 index 000000000000..7bb1380e65fd --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-cloud-no-base/main.tf @@ -0,0 +1,7 @@ +resource "aws_instance" "web" { + ami = "ami-1234" + security_groups = [ + "foo", + "bar", + ] +} diff --git a/internal/configs/testdata/valid-modules/override-cloud-no-base/override.tf b/internal/configs/testdata/valid-modules/override-cloud-no-base/override.tf new file mode 100644 index 000000000000..51ae925fb988 --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-cloud-no-base/override.tf @@ -0,0 +1,5 @@ +terraform { + cloud { + organization = "foo" + } +} diff --git a/internal/configs/testdata/valid-modules/override-cloud/main.tf b/internal/configs/testdata/valid-modules/override-cloud/main.tf new file mode 100644 index 000000000000..2de9a58dd38c --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-cloud/main.tf @@ -0,0 +1,14 @@ +terraform { + cloud { + organization = "foo" + should_not_be_present_with_override = true + } +} + +resource "aws_instance" "web" { + ami = "ami-1234" + security_groups = [ + "foo", + "bar", + ] +} diff --git a/internal/configs/testdata/valid-modules/override-cloud/override.tf b/internal/configs/testdata/valid-modules/override-cloud/override.tf new file mode 100644 index 000000000000..a4a7752ca599 --- /dev/null +++ b/internal/configs/testdata/valid-modules/override-cloud/override.tf @@ -0,0 +1,5 @@ +terraform { + cloud { + organization = "CHANGED" + } +} From f4758803fe572c428796fb9ae9c6fcaf8512ad2b Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 30 Aug 2021 15:27:58 -0700 Subject: [PATCH 203/644] cloud: Backend implements new version of the backend.Local interface This makes the new backend compatible with the new terraform.Context API, which has changed in main. --- internal/cloud/backend.go | 2 ++ internal/cloud/backend_context.go | 32 +++++++++++++++----------- internal/cloud/backend_context_test.go | 2 +- 3 files changed, 21 insertions(+), 15 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index b6ae5e154157..2a05496895e9 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -90,6 +90,8 @@ type Cloud struct { } var _ backend.Backend = (*Cloud)(nil) +var _ backend.Enhanced = (*Cloud)(nil) +var _ backend.Local = (*Cloud)(nil) // New creates a new initialized cloud backend. func New(services *disco.Disco) *Cloud { diff --git a/internal/cloud/backend_context.go b/internal/cloud/backend_context.go index 55f9aba54075..a564a6d3a718 100644 --- a/internal/cloud/backend_context.go +++ b/internal/cloud/backend_context.go @@ -6,7 +6,6 @@ import ( "log" "strings" - "github.com/hashicorp/errwrap" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hclsyntax" @@ -18,9 +17,15 @@ import ( "github.com/zclconf/go-cty/cty" ) -// Context implements backend.Enhanced. -func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Full, tfdiags.Diagnostics) { +// LocalRun implements backend.Local +func (b *Cloud) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Full, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics + ret := &backend.LocalRun{ + PlanOpts: &terraform.PlanOpts{ + Mode: op.PlanMode, + Targets: op.Targets, + }, + } op.StateLocker = op.StateLocker.WithContext(context.Background()) @@ -31,7 +36,7 @@ func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Ful log.Printf("[TRACE] cloud: requesting state manager for workspace %q", remoteWorkspaceName) stateMgr, err := b.StateMgr(op.Workspace) if err != nil { - diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading state: %w", err)) return nil, nil, diags } @@ -50,7 +55,7 @@ func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Ful log.Printf("[TRACE] cloud: reading remote state for workspace %q", remoteWorkspaceName) if err := stateMgr.RefreshState(); err != nil { - diags = diags.Append(errwrap.Wrapf("Error loading state: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading state: %w", err)) return nil, nil, diags } @@ -61,15 +66,13 @@ func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Ful } // Copy set options from the operation - opts.PlanMode = op.PlanMode - opts.Targets = op.Targets opts.UIInput = op.UIIn // Load the latest state. If we enter contextFromPlanFile below then the // state snapshot in the plan file must match this, or else it'll return // error diagnostics. log.Printf("[TRACE] cloud: retrieving remote state snapshot for workspace %q", remoteWorkspaceName) - opts.State = stateMgr.State() + ret.InputState = stateMgr.State() log.Printf("[TRACE] cloud: loading configuration for the current working directory") config, configDiags := op.ConfigLoader.LoadConfig(op.ConfigDir) @@ -77,21 +80,21 @@ func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Ful if configDiags.HasErrors() { return nil, nil, diags } - opts.Config = config + ret.Config = config // The underlying API expects us to use the opaque workspace id to request // variables, so we'll need to look that up using our organization name // and workspace name. remoteWorkspaceID, err := b.getRemoteWorkspaceID(context.Background(), op.Workspace) if err != nil { - diags = diags.Append(errwrap.Wrapf("Error finding remote workspace: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error finding remote workspace: %w", err)) return nil, nil, diags } log.Printf("[TRACE] cloud: retrieving variables from workspace %s/%s (%s)", remoteWorkspaceName, b.organization, remoteWorkspaceID) tfeVariables, err := b.client.Variables.List(context.Background(), remoteWorkspaceID, tfe.VariableListOptions{}) if err != nil && err != tfe.ErrResourceNotFound { - diags = diags.Append(errwrap.Wrapf("Error loading variables: {{err}}", err)) + diags = diags.Append(fmt.Errorf("error loading variables: %w", err)) return nil, nil, diags } @@ -100,7 +103,7 @@ func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Ful // more lax about them, stubbing out any unset ones as unknown. // This gives us enough information to produce a consistent context, // but not enough information to run a real operation (plan, apply, etc) - opts.Variables = stubAllVariables(op.Variables, config.Module.Variables) + ret.PlanOpts.SetVariables = stubAllVariables(op.Variables, config.Module.Variables) } else { if tfeVariables != nil { if op.Variables == nil { @@ -121,16 +124,17 @@ func (b *Cloud) Context(op *backend.Operation) (*terraform.Context, statemgr.Ful if diags.HasErrors() { return nil, nil, diags } - opts.Variables = variables + ret.PlanOpts.SetVariables = variables } } tfCtx, ctxDiags := terraform.NewContext(&opts) diags = diags.Append(ctxDiags) + ret.Core = tfCtx log.Printf("[TRACE] cloud: finished building terraform.Context") - return tfCtx, stateMgr, diags + return ret, stateMgr, diags } func (b *Cloud) getRemoteWorkspaceName(localWorkspaceName string) string { diff --git a/internal/cloud/backend_context_test.go b/internal/cloud/backend_context_test.go index 264d10a71c4c..683ad98ebaa2 100644 --- a/internal/cloud/backend_context_test.go +++ b/internal/cloud/backend_context_test.go @@ -204,7 +204,7 @@ func TestRemoteContextWithVars(t *testing.T) { } b.client.Variables.Create(context.TODO(), workspaceID, *v) - _, _, diags := b.Context(op) + _, _, diags := b.LocalRun(op) if test.WantError != "" { if !diags.HasErrors() { From 85f37f1aa54d82abb58cf53cb714534894d0a87c Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 30 Aug 2021 22:03:51 -0500 Subject: [PATCH 204/644] Add missing log mocks I missed adding these in the original porting commit from the remote backend, because *.log is added to gitignore. --- .../cloud/testdata/apply-destroy/apply.log | 7 ++++++ .../cloud/testdata/apply-destroy/plan.log | 22 ++++++++++++++++++ .../cloud/testdata/apply-no-changes/plan.log | 17 ++++++++++++++ .../testdata/apply-no-changes/policy.log | 12 ++++++++++ .../apply-policy-hard-failed/plan.log | 21 +++++++++++++++++ .../apply-policy-hard-failed/policy.log | 12 ++++++++++ .../testdata/apply-policy-passed/apply.log | 7 ++++++ .../testdata/apply-policy-passed/plan.log | 21 +++++++++++++++++ .../testdata/apply-policy-passed/policy.log | 12 ++++++++++ .../apply-policy-soft-failed/apply.log | 7 ++++++ .../apply-policy-soft-failed/plan.log | 21 +++++++++++++++++ .../apply-policy-soft-failed/policy.log | 12 ++++++++++ .../cloud/testdata/apply-variables/apply.log | 7 ++++++ .../cloud/testdata/apply-variables/plan.log | 21 +++++++++++++++++ .../cloud/testdata/apply-with-error/plan.log | 10 ++++++++ internal/cloud/testdata/apply/apply.log | 7 ++++++ internal/cloud/testdata/apply/plan.log | 21 +++++++++++++++++ .../testdata/plan-cost-estimation/ce.log | 6 +++++ .../plan-cost-estimation/cost-estimate.log | 5 ++++ .../testdata/plan-cost-estimation/plan.log | 20 ++++++++++++++++ .../cloud/testdata/plan-long-line/plan.log | 23 +++++++++++++++++++ .../cloud/testdata/plan-no-changes/plan.log | 17 ++++++++++++++ .../cloud/testdata/plan-no-changes/policy.log | 12 ++++++++++ .../testdata/plan-policy-hard-failed/plan.log | 21 +++++++++++++++++ .../plan-policy-hard-failed/policy.log | 12 ++++++++++ .../testdata/plan-policy-passed/plan.log | 21 +++++++++++++++++ .../testdata/plan-policy-passed/policy.log | 12 ++++++++++ .../testdata/plan-policy-soft-failed/plan.log | 21 +++++++++++++++++ .../plan-policy-soft-failed/policy.log | 12 ++++++++++ .../cloud/testdata/plan-variables/plan.log | 21 +++++++++++++++++ .../cloud/testdata/plan-with-error/plan.log | 10 ++++++++ .../terraform/plan.log | 21 +++++++++++++++++ internal/cloud/testdata/plan/plan.log | 21 +++++++++++++++++ 33 files changed, 492 insertions(+) create mode 100644 internal/cloud/testdata/apply-destroy/apply.log create mode 100644 internal/cloud/testdata/apply-destroy/plan.log create mode 100644 internal/cloud/testdata/apply-no-changes/plan.log create mode 100644 internal/cloud/testdata/apply-no-changes/policy.log create mode 100644 internal/cloud/testdata/apply-policy-hard-failed/plan.log create mode 100644 internal/cloud/testdata/apply-policy-hard-failed/policy.log create mode 100644 internal/cloud/testdata/apply-policy-passed/apply.log create mode 100644 internal/cloud/testdata/apply-policy-passed/plan.log create mode 100644 internal/cloud/testdata/apply-policy-passed/policy.log create mode 100644 internal/cloud/testdata/apply-policy-soft-failed/apply.log create mode 100644 internal/cloud/testdata/apply-policy-soft-failed/plan.log create mode 100644 internal/cloud/testdata/apply-policy-soft-failed/policy.log create mode 100644 internal/cloud/testdata/apply-variables/apply.log create mode 100644 internal/cloud/testdata/apply-variables/plan.log create mode 100644 internal/cloud/testdata/apply-with-error/plan.log create mode 100644 internal/cloud/testdata/apply/apply.log create mode 100644 internal/cloud/testdata/apply/plan.log create mode 100644 internal/cloud/testdata/plan-cost-estimation/ce.log create mode 100644 internal/cloud/testdata/plan-cost-estimation/cost-estimate.log create mode 100644 internal/cloud/testdata/plan-cost-estimation/plan.log create mode 100644 internal/cloud/testdata/plan-long-line/plan.log create mode 100644 internal/cloud/testdata/plan-no-changes/plan.log create mode 100644 internal/cloud/testdata/plan-no-changes/policy.log create mode 100644 internal/cloud/testdata/plan-policy-hard-failed/plan.log create mode 100644 internal/cloud/testdata/plan-policy-hard-failed/policy.log create mode 100644 internal/cloud/testdata/plan-policy-passed/plan.log create mode 100644 internal/cloud/testdata/plan-policy-passed/policy.log create mode 100644 internal/cloud/testdata/plan-policy-soft-failed/plan.log create mode 100644 internal/cloud/testdata/plan-policy-soft-failed/policy.log create mode 100644 internal/cloud/testdata/plan-variables/plan.log create mode 100644 internal/cloud/testdata/plan-with-error/plan.log create mode 100644 internal/cloud/testdata/plan-with-working-directory/terraform/plan.log create mode 100644 internal/cloud/testdata/plan/plan.log diff --git a/internal/cloud/testdata/apply-destroy/apply.log b/internal/cloud/testdata/apply-destroy/apply.log new file mode 100644 index 000000000000..d126547d95cf --- /dev/null +++ b/internal/cloud/testdata/apply-destroy/apply.log @@ -0,0 +1,7 @@ +Terraform v0.11.10 + +Initializing plugins and modules... +null_resource.hello: Destroying... (ID: 8657651096157629581) +null_resource.hello: Destruction complete after 0s + +Apply complete! Resources: 0 added, 0 changed, 1 destroyed. diff --git a/internal/cloud/testdata/apply-destroy/plan.log b/internal/cloud/testdata/apply-destroy/plan.log new file mode 100644 index 000000000000..1d38d4168923 --- /dev/null +++ b/internal/cloud/testdata/apply-destroy/plan.log @@ -0,0 +1,22 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +null_resource.hello: Refreshing state... (ID: 8657651096157629581) + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + - destroy + +Terraform will perform the following actions: + + - null_resource.hello + + +Plan: 0 to add, 0 to change, 1 to destroy. diff --git a/internal/cloud/testdata/apply-no-changes/plan.log b/internal/cloud/testdata/apply-no-changes/plan.log new file mode 100644 index 000000000000..70416815133f --- /dev/null +++ b/internal/cloud/testdata/apply-no-changes/plan.log @@ -0,0 +1,17 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +null_resource.hello: Refreshing state... (ID: 8657651096157629581) + +------------------------------------------------------------------------ + +No changes. Infrastructure is up-to-date. + +This means that Terraform did not detect any differences between your +configuration and real physical resources that exist. As a result, no +actions need to be performed. diff --git a/internal/cloud/testdata/apply-no-changes/policy.log b/internal/cloud/testdata/apply-no-changes/policy.log new file mode 100644 index 000000000000..b0cb1e598592 --- /dev/null +++ b/internal/cloud/testdata/apply-no-changes/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: true + +This result means that Sentinel policies returned true and the protected +behavior is allowed by Sentinel policies. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: true + +TRUE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/apply-policy-hard-failed/plan.log b/internal/cloud/testdata/apply-policy-hard-failed/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/apply-policy-hard-failed/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/apply-policy-hard-failed/policy.log b/internal/cloud/testdata/apply-policy-hard-failed/policy.log new file mode 100644 index 000000000000..5d6e6935b937 --- /dev/null +++ b/internal/cloud/testdata/apply-policy-hard-failed/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: false + +Sentinel evaluated to false because one or more Sentinel policies evaluated +to false. This false was not due to an undefined value or runtime error. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (hard-mandatory) + +Result: false + +FALSE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/apply-policy-passed/apply.log b/internal/cloud/testdata/apply-policy-passed/apply.log new file mode 100644 index 000000000000..901994838f22 --- /dev/null +++ b/internal/cloud/testdata/apply-policy-passed/apply.log @@ -0,0 +1,7 @@ +Terraform v0.11.10 + +Initializing plugins and modules... +null_resource.hello: Creating... +null_resource.hello: Creation complete after 0s (ID: 8657651096157629581) + +Apply complete! Resources: 1 added, 0 changed, 0 destroyed. diff --git a/internal/cloud/testdata/apply-policy-passed/plan.log b/internal/cloud/testdata/apply-policy-passed/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/apply-policy-passed/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/apply-policy-passed/policy.log b/internal/cloud/testdata/apply-policy-passed/policy.log new file mode 100644 index 000000000000..b0cb1e598592 --- /dev/null +++ b/internal/cloud/testdata/apply-policy-passed/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: true + +This result means that Sentinel policies returned true and the protected +behavior is allowed by Sentinel policies. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: true + +TRUE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/apply-policy-soft-failed/apply.log b/internal/cloud/testdata/apply-policy-soft-failed/apply.log new file mode 100644 index 000000000000..901994838f22 --- /dev/null +++ b/internal/cloud/testdata/apply-policy-soft-failed/apply.log @@ -0,0 +1,7 @@ +Terraform v0.11.10 + +Initializing plugins and modules... +null_resource.hello: Creating... +null_resource.hello: Creation complete after 0s (ID: 8657651096157629581) + +Apply complete! Resources: 1 added, 0 changed, 0 destroyed. diff --git a/internal/cloud/testdata/apply-policy-soft-failed/plan.log b/internal/cloud/testdata/apply-policy-soft-failed/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/apply-policy-soft-failed/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/apply-policy-soft-failed/policy.log b/internal/cloud/testdata/apply-policy-soft-failed/policy.log new file mode 100644 index 000000000000..3e4ebedf6179 --- /dev/null +++ b/internal/cloud/testdata/apply-policy-soft-failed/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: false + +Sentinel evaluated to false because one or more Sentinel policies evaluated +to false. This false was not due to an undefined value or runtime error. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: false + +FALSE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/apply-variables/apply.log b/internal/cloud/testdata/apply-variables/apply.log new file mode 100644 index 000000000000..901994838f22 --- /dev/null +++ b/internal/cloud/testdata/apply-variables/apply.log @@ -0,0 +1,7 @@ +Terraform v0.11.10 + +Initializing plugins and modules... +null_resource.hello: Creating... +null_resource.hello: Creation complete after 0s (ID: 8657651096157629581) + +Apply complete! Resources: 1 added, 0 changed, 0 destroyed. diff --git a/internal/cloud/testdata/apply-variables/plan.log b/internal/cloud/testdata/apply-variables/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/apply-variables/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/apply-with-error/plan.log b/internal/cloud/testdata/apply-with-error/plan.log new file mode 100644 index 000000000000..4344a3722905 --- /dev/null +++ b/internal/cloud/testdata/apply-with-error/plan.log @@ -0,0 +1,10 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... + +Error: null_resource.foo: 1 error(s) occurred: + +* null_resource.foo: 1:3: unknown function called: guid in: + +${guid()} diff --git a/internal/cloud/testdata/apply/apply.log b/internal/cloud/testdata/apply/apply.log new file mode 100644 index 000000000000..901994838f22 --- /dev/null +++ b/internal/cloud/testdata/apply/apply.log @@ -0,0 +1,7 @@ +Terraform v0.11.10 + +Initializing plugins and modules... +null_resource.hello: Creating... +null_resource.hello: Creation complete after 0s (ID: 8657651096157629581) + +Apply complete! Resources: 1 added, 0 changed, 0 destroyed. diff --git a/internal/cloud/testdata/apply/plan.log b/internal/cloud/testdata/apply/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/apply/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-cost-estimation/ce.log b/internal/cloud/testdata/plan-cost-estimation/ce.log new file mode 100644 index 000000000000..e51fef1edc67 --- /dev/null +++ b/internal/cloud/testdata/plan-cost-estimation/ce.log @@ -0,0 +1,6 @@ ++---------+------+-----+-------------+----------------------+ +| PRODUCT | NAME | SKU | DESCRIPTION | DELTA | ++---------+------+-----+-------------+----------------------+ ++---------+------+-----+-------------+----------------------+ +| TOTAL | $0.000 USD / 720 HRS | ++---------+------+-----+-------------+----------------------+ diff --git a/internal/cloud/testdata/plan-cost-estimation/cost-estimate.log b/internal/cloud/testdata/plan-cost-estimation/cost-estimate.log new file mode 100644 index 000000000000..67a50928cec2 --- /dev/null +++ b/internal/cloud/testdata/plan-cost-estimation/cost-estimate.log @@ -0,0 +1,5 @@ +Cost estimation: + +Waiting for cost estimation to complete... +Resources: 1 of 1 estimated + $25.488/mo +$25.488 \ No newline at end of file diff --git a/internal/cloud/testdata/plan-cost-estimation/plan.log b/internal/cloud/testdata/plan-cost-estimation/plan.log new file mode 100644 index 000000000000..fae287f4529e --- /dev/null +++ b/internal/cloud/testdata/plan-cost-estimation/plan.log @@ -0,0 +1,20 @@ +Terraform v0.12.9 +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-long-line/plan.log b/internal/cloud/testdata/plan-long-line/plan.log new file mode 100644 index 000000000000..f34ed170c9a2 --- /dev/null +++ b/internal/cloud/testdata/plan-long-line/plan.log @@ -0,0 +1,23 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + triggers.%: "1" + triggers.long_line: "[{'_id':'5c5ab0ed7de45e993ffb9eeb','index':0,'guid':'e734d772-6b5a-4cb0-805c-91cd5e560e20','isActive':false,'balance':'$1,472.03','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Darlene','last':'Garza'},'company':'GEEKOSIS','email':'darlene.garza@geekosis.io','phone':'+1 (850) 506-3347','address':'165 Kiely Place, Como, New Mexico, 4335','about':'Officia ullamco et sunt magna voluptate culpa cupidatat ea tempor laboris cupidatat ea anim laboris. Minim enim quis enim esse laborum est veniam. Lorem excepteur elit Lorem cupidatat elit ea anim irure fugiat fugiat sunt mollit. Consectetur ad nulla dolor amet esse occaecat aliquip sit. Magna sit elit adipisicing ut reprehenderit anim exercitation sit quis ea pariatur Lorem magna dolore.','registered':'Wednesday, March 11, 2015 12:58 PM','latitude':'20.729127','longitude':'-127.343593','tags':['minim','in','deserunt','occaecat','fugiat'],'greeting':'Hello, Darlene! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eda9117d15f1c1f112','index':1,'guid':'f0d1eed2-c6a9-4535-8800-d4bd53fe7eee','isActive':true,'balance':'$2,901.90','picture':'http://placehold.it/32x32','age':28,'eyeColor':'brown','name':{'first':'Flora','last':'Short'},'company':'SIGNITY','email':'flora.short@signity.me','phone':'+1 (840) 520-2666','address':'636 Johnson Avenue, Gerber, Wisconsin, 9139','about':'Veniam dolore deserunt Lorem aliqua qui eiusmod. Amet tempor fugiat duis incididunt amet adipisicing. Id ea nisi veniam eiusmod.','registered':'Wednesday, May 2, 2018 5:59 AM','latitude':'-63.267612','longitude':'4.224102','tags':['veniam','incididunt','id','aliqua','reprehenderit'],'greeting':'Hello, Flora! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed83fd574d8041fa16','index':2,'guid':'29499a07-414a-436f-ba62-6634ca16bdcc','isActive':true,'balance':'$2,781.28','picture':'http://placehold.it/32x32','age':22,'eyeColor':'green','name':{'first':'Trevino','last':'Marks'},'company':'KEGULAR','email':'trevino.marks@kegular.com','phone':'+1 (843) 571-2269','address':'200 Alabama Avenue, Grenelefe, Florida, 7963','about':'Occaecat nisi exercitation Lorem mollit laborum magna adipisicing culpa dolor proident dolore. Non consequat ea amet et id mollit incididunt minim anim amet nostrud labore tempor. Proident eu sint commodo nisi consequat voluptate do fugiat proident. Laboris eiusmod veniam non et elit nulla nisi labore incididunt Lorem consequat consectetur voluptate.','registered':'Saturday, January 25, 2014 5:56 AM','latitude':'65.044005','longitude':'-127.454864','tags':['anim','duis','velit','pariatur','enim'],'greeting':'Hello, Trevino! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed784eb6e350ff0a07','index':3,'guid':'40ed47e2-1747-4665-ab59-cdb3630a7642','isActive':true,'balance':'$2,000.78','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Solis','last':'Mckinney'},'company':'QABOOS','email':'solis.mckinney@qaboos.org','phone':'+1 (924) 405-2560','address':'712 Herkimer Court, Klondike, Ohio, 8133','about':'Minim ad anim minim tempor mollit magna tempor et non commodo amet. Nisi cupidatat labore culpa consectetur exercitation laborum adipisicing fugiat officia adipisicing consequat non. Qui voluptate tempor laboris exercitation qui non adipisicing occaecat voluptate sunt do nostrud velit. Consequat tempor officia laboris tempor irure cupidatat aliquip voluptate nostrud velit ex nulla tempor laboris. Qui pariatur pariatur enim aliquip velit. Officia mollit ullamco laboris velit velit eiusmod enim amet incididunt consectetur sunt.','registered':'Wednesday, April 12, 2017 6:59 AM','latitude':'-25.055596','longitude':'-140.126525','tags':['ipsum','adipisicing','amet','nulla','dolore'],'greeting':'Hello, Solis! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed02ce1ea9a2155d51','index':4,'guid':'1b5fb7d3-3b9a-4382-81b5-9ab01a27e74b','isActive':true,'balance':'$1,373.67','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Janell','last':'Battle'},'company':'GEEKMOSIS','email':'janell.battle@geekmosis.net','phone':'+1 (810) 591-3014','address':'517 Onderdonk Avenue, Shrewsbury, District Of Columbia, 2335','about':'Reprehenderit ad proident do anim qui officia magna magna duis cillum esse minim est. Excepteur ipsum anim ad laboris. In occaecat dolore nulla ea Lorem tempor et culpa in sint. Officia eu eu incididunt sit amet. Culpa duis id reprehenderit ut anim sit sunt. Duis dolore proident velit incididunt adipisicing pariatur fugiat incididunt eiusmod eu veniam irure.','registered':'Thursday, February 8, 2018 1:44 AM','latitude':'-33.254864','longitude':'-154.145885','tags':['aute','deserunt','ipsum','eiusmod','laborum'],'greeting':'Hello, Janell! You have 5 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edab58604bd7d3dd1c','index':5,'guid':'6354c035-af22-44c9-8be9-b2ea9decc24d','isActive':true,'balance':'$3,535.68','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Combs','last':'Kirby'},'company':'LUXURIA','email':'combs.kirby@luxuria.name','phone':'+1 (900) 498-3266','address':'377 Kingsland Avenue, Ruckersville, Maine, 9916','about':'Lorem duis ipsum pariatur aliquip sunt. Commodo esse laborum incididunt mollit quis est laboris ea ea quis fugiat. Enim elit ullamco velit et fugiat veniam irure deserunt aliqua ad irure veniam.','registered':'Tuesday, February 21, 2017 4:04 PM','latitude':'-70.20591','longitude':'162.546871','tags':['reprehenderit','est','enim','aute','ad'],'greeting':'Hello, Combs! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edf7fafeffc6357c51','index':6,'guid':'02523e0b-cc90-4309-b6b2-f493dc6076f6','isActive':false,'balance':'$3,754.30','picture':'http://placehold.it/32x32','age':29,'eyeColor':'green','name':{'first':'Macias','last':'Calderon'},'company':'AMTAP','email':'macias.calderon@amtap.us','phone':'+1 (996) 569-3667','address':'305 Royce Street, Glidden, Iowa, 9248','about':'Exercitation nulla deserunt pariatur adipisicing. In commodo deserunt incididunt ut velit minim qui ut quis. Labore elit ullamco eiusmod voluptate in eu do est fugiat aute mollit deserunt. Eu duis proident velit fugiat velit ut. Ut non esse amet laborum nisi tempor in nulla.','registered':'Thursday, October 23, 2014 10:28 PM','latitude':'32.371629','longitude':'60.155135','tags':['commodo','elit','velit','excepteur','aliqua'],'greeting':'Hello, Macias! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed0e8a6109e7fabf17','index':7,'guid':'675ff6b6-197b-4154-9775-813d661df822','isActive':false,'balance':'$2,850.62','picture':'http://placehold.it/32x32','age':37,'eyeColor':'green','name':{'first':'Stefanie','last':'Rivers'},'company':'RECRITUBE','email':'stefanie.rivers@recritube.biz','phone':'+1 (994) 591-3551','address':'995 Campus Road, Abrams, Virginia, 3251','about':'Esse aute non laborum Lorem nulla irure. Veniam elit aute ut et dolor non deserunt laboris tempor. Ipsum quis cupidatat laborum laboris voluptate esse duis eiusmod excepteur consectetur commodo ullamco qui occaecat. Culpa velit cillum occaecat minim nisi.','registered':'Thursday, June 9, 2016 3:40 PM','latitude':'-18.526825','longitude':'149.670782','tags':['occaecat','sunt','reprehenderit','ipsum','magna'],'greeting':'Hello, Stefanie! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edf7d9bc2db4e476e3','index':8,'guid':'adaefc55-f6ea-4bd1-a147-0e31c3ce7a21','isActive':true,'balance':'$2,555.13','picture':'http://placehold.it/32x32','age':20,'eyeColor':'blue','name':{'first':'Hillary','last':'Lancaster'},'company':'OLUCORE','email':'hillary.lancaster@olucore.ca','phone':'+1 (964) 474-3018','address':'232 Berriman Street, Kaka, Massachusetts, 6792','about':'Veniam ad laboris quis reprehenderit aliquip nisi sunt excepteur ea aute laborum excepteur incididunt. Nisi exercitation aliquip do culpa commodo ex officia ut enim mollit in deserunt in amet. Anim eu deserunt dolore non cupidatat ut enim incididunt aute dolore voluptate. Do cillum mollit laborum non incididunt occaecat aute voluptate nisi irure.','registered':'Thursday, June 4, 2015 9:45 PM','latitude':'88.075919','longitude':'-148.951368','tags':['reprehenderit','veniam','ad','aute','anim'],'greeting':'Hello, Hillary! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed7b7192ad6a0f267c','index':9,'guid':'0ca9b8ea-f671-474e-be26-4a49cae4838a','isActive':true,'balance':'$3,684.51','picture':'http://placehold.it/32x32','age':40,'eyeColor':'brown','name':{'first':'Jill','last':'Conner'},'company':'EXOZENT','email':'jill.conner@exozent.info','phone':'+1 (887) 467-2168','address':'751 Thames Street, Juarez, American Samoa, 8386','about':'Enim voluptate et non est in magna laborum aliqua enim aliqua est non nostrud. Tempor est nulla ipsum consectetur esse nostrud est id. Consequat do voluptate cupidatat eu fugiat et fugiat velit id. Sint dolore ad qui tempor anim eu amet consectetur do elit aute adipisicing consequat ex.','registered':'Sunday, October 22, 2017 7:35 AM','latitude':'84.384911','longitude':'40.305648','tags':['tempor','sint','irure','et','ex'],'greeting':'Hello, Jill! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed713fe676575aa72b','index':10,'guid':'c28023cf-cc57-4c2e-8d91-dfbe6bafadcd','isActive':false,'balance':'$2,792.45','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Hurley','last':'George'},'company':'ZAJ','email':'hurley.george@zaj.tv','phone':'+1 (984) 547-3284','address':'727 Minna Street, Lacomb, Colorado, 2557','about':'Ex velit cupidatat veniam culpa. Eiusmod ut fugiat adipisicing incididunt consectetur exercitation Lorem exercitation ex. Incididunt anim aute incididunt fugiat cupidatat qui eu non reprehenderit. Eiusmod dolor nisi culpa excepteur ut velit minim dolor voluptate amet commodo culpa in.','registered':'Thursday, February 16, 2017 6:41 AM','latitude':'25.989949','longitude':'10.200053','tags':['minim','ut','sunt','consequat','ullamco'],'greeting':'Hello, Hurley! You have 8 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1e56732746c70d8b','index':11,'guid':'e9766f13-766c-4450-b4d2-8b04580f60b7','isActive':true,'balance':'$3,874.26','picture':'http://placehold.it/32x32','age':35,'eyeColor':'green','name':{'first':'Leticia','last':'Pace'},'company':'HONOTRON','email':'leticia.pace@honotron.co.uk','phone':'+1 (974) 536-3322','address':'365 Goodwin Place, Savage, Nevada, 9191','about':'Nisi Lorem aliqua esse eiusmod magna. Ad minim incididunt proident ut Lorem cupidatat qui velit aliqua ullamco et ipsum in. Aliquip elit consectetur pariatur esse exercitation et officia quis. Occaecat tempor proident cillum anim ad commodo velit ut voluptate. Tempor et occaecat sit sint aliquip tempor nulla velit magna nisi proident exercitation Lorem id.','registered':'Saturday, August 4, 2018 5:05 AM','latitude':'70.620386','longitude':'-86.335813','tags':['occaecat','velit','labore','laboris','esse'],'greeting':'Hello, Leticia! You have 8 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed941337fe42f47426','index':12,'guid':'6d390762-17ea-4b58-9a36-b0c9a8748a42','isActive':true,'balance':'$1,049.61','picture':'http://placehold.it/32x32','age':38,'eyeColor':'green','name':{'first':'Rose','last':'Humphrey'},'company':'MYOPIUM','email':'rose.humphrey@myopium.io','phone':'+1 (828) 426-3086','address':'389 Sapphire Street, Saticoy, Marshall Islands, 1423','about':'Aliquip enim excepteur adipisicing ex. Consequat aliqua consequat nostrud do occaecat deserunt excepteur sit et ipsum sunt dolor eu. Dolore laborum commodo excepteur tempor ad adipisicing proident excepteur magna non Lorem proident consequat aute. Fugiat minim consequat occaecat voluptate esse velit officia laboris nostrud nisi ut voluptate.','registered':'Monday, April 16, 2018 12:38 PM','latitude':'-47.083742','longitude':'109.022423','tags':['aute','non','sit','adipisicing','mollit'],'greeting':'Hello, Rose! You have 9 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd0c02fc3fdc01a40','index':13,'guid':'07755618-6fdf-4b33-af50-364c18909227','isActive':true,'balance':'$1,823.61','picture':'http://placehold.it/32x32','age':36,'eyeColor':'green','name':{'first':'Judith','last':'Hale'},'company':'COLLAIRE','email':'judith.hale@collaire.me','phone':'+1 (922) 508-2843','address':'193 Coffey Street, Castleton, North Dakota, 3638','about':'Minim non ullamco ad anim nostrud dolore nostrud veniam consequat id eiusmod veniam laboris. Lorem irure esse mollit non velit aute id cupidatat est mollit occaecat magna excepteur. Adipisicing tempor nisi sit aliquip tempor pariatur tempor eu consectetur nulla amet nulla. Quis nisi nisi ea incididunt culpa et do. Esse officia eu pariatur velit sunt quis proident amet consectetur consequat. Nisi excepteur culpa nulla sit dolor deserunt excepteur dolor consequat elit cillum tempor Lorem.','registered':'Wednesday, August 24, 2016 12:29 AM','latitude':'-80.15514','longitude':'39.91007','tags':['consectetur','incididunt','aliquip','dolor','consequat'],'greeting':'Hello, Judith! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edb3e1e29caa4f728b','index':14,'guid':'2c6617a2-e7a9-4ff7-a8b9-e99554fe70fe','isActive':true,'balance':'$1,971.00','picture':'http://placehold.it/32x32','age':39,'eyeColor':'blue','name':{'first':'Estes','last':'Sweet'},'company':'GEEKKO','email':'estes.sweet@geekko.com','phone':'+1 (866) 448-3032','address':'847 Cove Lane, Kula, Mississippi, 9178','about':'Veniam consectetur occaecat est excepteur consequat ipsum cillum sit consectetur. Ut cupidatat et reprehenderit dolore enim do cillum qui pariatur ad laborum incididunt esse. Fugiat sunt dolor veniam laboris ipsum deserunt proident reprehenderit laboris non nostrud. Magna excepteur sint magna laborum tempor sit exercitation ipsum labore est ullamco ullamco. Cillum voluptate cillum ea laborum Lorem. Excepteur sint ut nisi est esse non. Minim excepteur ullamco velit nisi ut in elit exercitation ut dolore.','registered':'Sunday, August 12, 2018 5:06 PM','latitude':'-9.57771','longitude':'-159.94577','tags':['culpa','dolor','velit','anim','pariatur'],'greeting':'Hello, Estes! You have 7 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edbcf088c6fd593091','index':15,'guid':'2cc79958-1b40-4e2c-907a-433903fd3da9','isActive':false,'balance':'$3,751.53','picture':'http://placehold.it/32x32','age':34,'eyeColor':'brown','name':{'first':'Kemp','last':'Spence'},'company':'EXOBLUE','email':'kemp.spence@exoblue.org','phone':'+1 (864) 487-2992','address':'217 Clay Street, Monument, North Carolina, 1460','about':'Nostrud duis cillum sint non commodo dolor aute aliqua adipisicing ad nulla non excepteur proident. Fugiat labore elit tempor cillum veniam reprehenderit laboris consectetur dolore amet qui cupidatat. Amet aliqua elit anim et consequat commodo excepteur officia anim aliqua ea eu labore cillum. Et ex dolor duis dolore commodo veniam et nisi.','registered':'Monday, October 29, 2018 5:23 AM','latitude':'-70.304222','longitude':'83.582371','tags':['velit','duis','consequat','incididunt','duis'],'greeting':'Hello, Kemp! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed6400479feb3de505','index':16,'guid':'91ccae6d-a3ea-43cf-bb00-3f2729256cc9','isActive':false,'balance':'$2,477.79','picture':'http://placehold.it/32x32','age':40,'eyeColor':'blue','name':{'first':'Ronda','last':'Burris'},'company':'EQUITOX','email':'ronda.burris@equitox.net','phone':'+1 (817) 553-3228','address':'708 Lawton Street, Deputy, Wyoming, 8598','about':'Excepteur voluptate aliquip consequat cillum est duis sit cillum eu eiusmod et laborum ullamco. Et minim reprehenderit aute voluptate amet ullamco. Amet sit enim ad irure deserunt nostrud anim veniam consequat dolor commodo. Consequat do occaecat do exercitation ullamco dolor ut. Id laboris consequat est dolor dolore tempor ullamco anim do ut nulla deserunt labore. Mollit ex Lorem ullamco mollit.','registered':'Monday, April 23, 2018 5:27 PM','latitude':'-31.227208','longitude':'0.63785','tags':['ipsum','magna','consectetur','sit','irure'],'greeting':'Hello, Ronda! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eddbeab2e53e04d563','index':17,'guid':'a86d4eb6-6bd8-48c2-a8fc-1c933c835852','isActive':false,'balance':'$3,709.03','picture':'http://placehold.it/32x32','age':37,'eyeColor':'blue','name':{'first':'Rosario','last':'Dillard'},'company':'BARKARAMA','email':'rosario.dillard@barkarama.name','phone':'+1 (933) 525-3898','address':'730 Chauncey Street, Forbestown, South Carolina, 6894','about':'Est eu fugiat aliquip ea ad qui ad mollit ad tempor voluptate et incididunt reprehenderit. Incididunt fugiat commodo minim adipisicing culpa consectetur duis eu ut commodo consequat voluptate labore. Nostrud irure labore adipisicing irure quis magna consequat dolor Lorem sint enim. Sint excepteur eu dolore elit ut do mollit sunt enim est. Labore id nostrud sint Lorem esse nostrud.','registered':'Friday, December 25, 2015 8:59 PM','latitude':'37.440827','longitude':'44.580474','tags':['Lorem','sit','ipsum','ea','ut'],'greeting':'Hello, Rosario! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eddf8e9b9c031d04e8','index':18,'guid':'a96f997c-daf8-40d4-92e1-be07e2cf0f60','isActive':false,'balance':'$1,878.37','picture':'http://placehold.it/32x32','age':37,'eyeColor':'brown','name':{'first':'Sondra','last':'Gonzales'},'company':'XUMONK','email':'sondra.gonzales@xumonk.us','phone':'+1 (838) 560-2255','address':'230 Cox Place, Geyserville, Georgia, 6805','about':'Laborum sunt voluptate ea laboris nostrud. Amet deserunt aliqua Lorem voluptate velit deserunt occaecat minim ullamco. Lorem occaecat sit labore adipisicing ad magna mollit labore ullamco proident. Ea velit do proident fugiat esse commodo ex nostrud eu mollit pariatur. Labore laborum qui voluptate quis proident reprehenderit tempor dolore duis deserunt esse aliqua aliquip. Non veniam enim pariatur cupidatat ipsum dolore est reprehenderit. Non exercitation adipisicing proident magna elit occaecat non magna.','registered':'Sunday, June 26, 2016 4:02 AM','latitude':'62.247742','longitude':'-44.90666','tags':['ea','aute','in','voluptate','magna'],'greeting':'Hello, Sondra! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed2c1bcd06781f677e','index':19,'guid':'6ac47a16-eed4-4460-92ee-e0dd33c1fbb5','isActive':false,'balance':'$3,730.64','picture':'http://placehold.it/32x32','age':20,'eyeColor':'brown','name':{'first':'Anastasia','last':'Vega'},'company':'FIREWAX','email':'anastasia.vega@firewax.biz','phone':'+1 (867) 493-3698','address':'803 Arlington Avenue, Rosburg, Northern Mariana Islands, 8769','about':'Sint ex nisi tempor sunt voluptate non et eiusmod irure. Aute reprehenderit dolor mollit aliqua Lorem voluptate occaecat. Sint laboris deserunt Lorem incididunt nulla cupidatat do.','registered':'Friday, March 18, 2016 12:02 PM','latitude':'-32.010216','longitude':'-87.874753','tags':['aliquip','mollit','mollit','ad','laborum'],'greeting':'Hello, Anastasia! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed727fd645854bbf43','index':20,'guid':'67bd8cdb-ce6b-455c-944c-a80e17c6fa75','isActive':true,'balance':'$2,868.06','picture':'http://placehold.it/32x32','age':29,'eyeColor':'green','name':{'first':'Lucinda','last':'Cox'},'company':'ENDIPINE','email':'lucinda.cox@endipine.ca','phone':'+1 (990) 428-3002','address':'412 Thatford Avenue, Lafferty, New Jersey, 5271','about':'Esse nulla sunt ut consequat aute mollit. Est occaecat sunt nisi irure id anim est commodo. Elit mollit amet dolore sunt adipisicing ea laborum quis ea reprehenderit non consequat dolore. Minim sunt occaecat quis aute commodo dolore quis commodo proident. Sunt sint duis ullamco sit ea esse Lorem. Consequat pariatur eiusmod laboris adipisicing labore in laboris adipisicing adipisicing consequat aute ea et.','registered':'Friday, May 1, 2015 10:16 PM','latitude':'-14.200957','longitude':'-82.211386','tags':['do','sit','qui','officia','aliquip'],'greeting':'Hello, Lucinda! You have 9 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed5a97284eb2cbd3a8','index':21,'guid':'f9fc999d-515c-4fc4-b339-76300e1b4bf2','isActive':true,'balance':'$1,172.57','picture':'http://placehold.it/32x32','age':35,'eyeColor':'brown','name':{'first':'Conrad','last':'Bradley'},'company':'FUELWORKS','email':'conrad.bradley@fuelworks.info','phone':'+1 (956) 561-3226','address':'685 Fenimore Street, Esmont, Maryland, 7523','about':'Labore reprehenderit anim nisi sunt do nisi in. Est anim cillum id minim exercitation ullamco voluptate ipsum eu. Elit culpa consequat reprehenderit laborum in eu. Laboris amet voluptate laboris qui voluptate duis minim reprehenderit. Commodo sunt irure dolore sunt occaecat velit nisi eu minim minim.','registered':'Wednesday, January 18, 2017 11:13 PM','latitude':'31.665993','longitude':'38.868968','tags':['excepteur','exercitation','est','nisi','mollit'],'greeting':'Hello, Conrad! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edc4eaf6f760c38218','index':22,'guid':'8794ef5f-da2f-46f0-a755-c18a16409fd5','isActive':false,'balance':'$3,594.73','picture':'http://placehold.it/32x32','age':27,'eyeColor':'blue','name':{'first':'Marquez','last':'Vargas'},'company':'MALATHION','email':'marquez.vargas@malathion.tv','phone':'+1 (976) 438-3126','address':'296 Hall Street, National, Texas, 2067','about':'Proident cillum aute minim fugiat sunt aliqua non occaecat est duis id id tempor. Qui deserunt nisi amet pariatur proident eu laboris esse adipisicing magna. Anim anim mollit aute non magna nisi aute magna labore ullamco reprehenderit voluptate et ad. Proident adipisicing aute eiusmod nostrud nostrud deserunt culpa. Elit eu ullamco nisi aliqua dolor sint pariatur excepteur sit consectetur tempor. Consequat Lorem ullamco commodo veniam qui sint magna. Sit mollit ad aliquip est id eu officia id adipisicing duis ad.','registered':'Tuesday, November 17, 2015 6:16 PM','latitude':'-36.443667','longitude':'22.336776','tags':['aliquip','veniam','ipsum','Lorem','ex'],'greeting':'Hello, Marquez! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edd7c718518ee0466a','index':23,'guid':'ad8781a2-059e-4288-9879-309d53a99bf5','isActive':true,'balance':'$3,570.68','picture':'http://placehold.it/32x32','age':21,'eyeColor':'brown','name':{'first':'Snider','last':'Frost'},'company':'ZILODYNE','email':'snider.frost@zilodyne.co.uk','phone':'+1 (913) 485-3275','address':'721 Lincoln Road, Richmond, Utah, 672','about':'Minim enim Lorem esse incididunt do reprehenderit velit laborum ullamco. In aute eiusmod esse aliqua et labore tempor sunt ex mollit veniam tempor. Nulla elit cillum qui ullamco dolore amet deserunt magna amet laborum.','registered':'Saturday, August 23, 2014 12:58 AM','latitude':'-88.682554','longitude':'74.063179','tags':['nulla','ea','sint','aliquip','duis'],'greeting':'Hello, Snider! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edf026fece8e2c0970','index':24,'guid':'1b7d81e1-1dba-4322-bb1a-eaa6a24cccea','isActive':false,'balance':'$2,037.91','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Snyder','last':'Fletcher'},'company':'COMTEST','email':'snyder.fletcher@comtest.io','phone':'+1 (830) 538-3860','address':'221 Lewis Place, Zortman, Idaho, 572','about':'Elit anim enim esse dolore exercitation. Laboris esse sint adipisicing fugiat sint do occaecat ut voluptate sint nulla. Ad sint ut reprehenderit nostrud irure id consectetur officia velit consequat.','registered':'Sunday, January 1, 2017 1:13 AM','latitude':'-54.742604','longitude':'69.534932','tags':['exercitation','commodo','in','id','aliqua'],'greeting':'Hello, Snyder! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed4b9a7f83da6d2dfd','index':25,'guid':'0b2cc6b6-0044-4b1c-aa31-bd72963457a0','isActive':false,'balance':'$1,152.76','picture':'http://placehold.it/32x32','age':27,'eyeColor':'blue','name':{'first':'Regina','last':'James'},'company':'TELPOD','email':'regina.james@telpod.me','phone':'+1 (989) 455-3228','address':'688 Essex Street, Clayville, Alabama, 2772','about':'Eiusmod elit culpa reprehenderit ea veniam. Officia irure culpa duis aute ut. Irure duis cillum officia ea pariatur velit ut dolor incididunt reprehenderit ex elit laborum. Est pariatur veniam ad irure. Labore velit sunt esse laboris aliqua velit deserunt deserunt sit. Elit eiusmod ad laboris aliquip minim irure excepteur enim quis. Quis incididunt adipisicing ut magna cupidatat sit amet culpa.','registered':'Tuesday, April 25, 2017 10:16 PM','latitude':'-75.088027','longitude':'47.209828','tags':['elit','nisi','est','voluptate','proident'],'greeting':'Hello, Regina! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed10884f32f779f2bf','index':26,'guid':'1f6fb522-0002-46ff-8dac-451247f28168','isActive':true,'balance':'$1,948.79','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Collins','last':'Mcpherson'},'company':'DIGIGEN','email':'collins.mcpherson@digigen.com','phone':'+1 (991) 519-2334','address':'317 Merit Court, Sanford, Michigan, 6468','about':'Magna qui culpa dolor officia labore mollit ex excepteur duis eiusmod. Ea cupidatat ex ipsum mollit do minim duis. Nisi eiusmod minim tempor id esse commodo sunt sunt ullamco ut do laborum ullamco magna. Aliquip laborum dolor officia officia eu nostrud velit minim est anim. Ex elit laborum sunt magna exercitation nisi cillum sunt aute qui ea ullamco. Cupidatat ea sunt aute dolor duis nisi Lorem ullamco eiusmod. Sit ea velit ad veniam aliqua ad elit cupidatat ut magna in.','registered':'Friday, June 10, 2016 4:38 PM','latitude':'25.513996','longitude':'14.911124','tags':['exercitation','non','sit','velit','officia'],'greeting':'Hello, Collins! You have 5 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed8a575110efb15c6c','index':27,'guid':'2a904c82-068b-4ded-9ae6-cfeb6d7e62c9','isActive':true,'balance':'$3,427.91','picture':'http://placehold.it/32x32','age':24,'eyeColor':'green','name':{'first':'Mckay','last':'Barrera'},'company':'COMVEYER','email':'mckay.barrera@comveyer.org','phone':'+1 (853) 470-2560','address':'907 Glenwood Road, Churchill, Oregon, 8583','about':'In voluptate esse dolore enim sint quis dolor do exercitation sint et labore nisi. Eiusmod tempor exercitation dolore elit sit velit sint et. Sit magna adipisicing eiusmod do anim velit deserunt laboris ad ea pariatur. Irure nisi anim mollit elit commodo nulla. Aute eiusmod sit nulla eiusmod. Eiusmod est officia commodo mollit laboris do deserunt eu do nisi amet. Proident ad duis eiusmod laboris Lorem ut culpa pariatur Lorem reprehenderit minim aliquip irure sunt.','registered':'Saturday, December 19, 2015 2:49 PM','latitude':'-55.243287','longitude':'138.035406','tags':['non','quis','laboris','enim','nisi'],'greeting':'Hello, Mckay! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edcd49ab6a73ff7f32','index':28,'guid':'5d3e0dae-3f58-437f-b12d-de24667a904d','isActive':true,'balance':'$3,270.52','picture':'http://placehold.it/32x32','age':35,'eyeColor':'blue','name':{'first':'Mabel','last':'Leonard'},'company':'QUADEEBO','email':'mabel.leonard@quadeebo.net','phone':'+1 (805) 432-2356','address':'965 Underhill Avenue, Falconaire, Minnesota, 4450','about':'Cupidatat amet sunt est ipsum occaecat sit fugiat excepteur Lorem Lorem ex ea ipsum. Ad incididunt est irure magna excepteur occaecat nostrud. Minim dolor id anim ipsum qui nostrud ullamco aute ex Lorem magna deserunt excepteur Lorem.','registered':'Saturday, March 28, 2015 5:55 AM','latitude':'27.388359','longitude':'156.408728','tags':['quis','velit','deserunt','dolore','sit'],'greeting':'Hello, Mabel! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edde16ac2dc2fbb6c1','index':29,'guid':'d50c2233-70fc-4748-8ebf-02d45ac2a446','isActive':false,'balance':'$3,100.70','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Pace','last':'Duke'},'company':'SEQUITUR','email':'pace.duke@sequitur.name','phone':'+1 (983) 568-3119','address':'895 Melrose Street, Reno, Connecticut, 6259','about':'Ex veniam aliquip exercitation mollit elit est minim veniam aliqua labore deserunt. Dolor sunt sint cillum Lorem nisi ea irure cupidatat. Velit ut culpa cupidatat consequat cillum. Sint voluptate quis laboris qui incididunt do elit Lorem qui ullamco ut eu pariatur occaecat.','registered':'Saturday, August 18, 2018 2:18 PM','latitude':'31.930443','longitude':'-129.494784','tags':['culpa','est','nostrud','quis','aliquip'],'greeting':'Hello, Pace! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edb908d85642ba77e8','index':30,'guid':'3edb6e42-367a-403d-a511-eb78bcc11f60','isActive':true,'balance':'$1,912.07','picture':'http://placehold.it/32x32','age':24,'eyeColor':'green','name':{'first':'Cohen','last':'Morrison'},'company':'POWERNET','email':'cohen.morrison@powernet.us','phone':'+1 (888) 597-2141','address':'565 Troutman Street, Idledale, West Virginia, 3196','about':'Ullamco voluptate duis commodo amet occaecat consequat et occaecat dolore nulla eu. Do aliqua sunt deserunt occaecat laboris labore voluptate cupidatat ullamco exercitation aliquip elit voluptate anim. Occaecat deserunt in labore cillum aute deserunt ea excepteur laboris sunt. Officia irure sint incididunt labore sint ipsum ullamco ea elit. Fugiat nostrud sunt ut officia mollit proident sunt dolor fugiat esse tempor do.','registered':'Friday, January 1, 2016 5:42 AM','latitude':'-20.01215','longitude':'26.361552','tags':['consectetur','sunt','nulla','reprehenderit','dolore'],'greeting':'Hello, Cohen! You have 10 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed91c77aa25a64a757','index':31,'guid':'8999a97b-0035-4f19-b555-91dd69aaa9b8','isActive':false,'balance':'$3,097.67','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Stout','last':'Valdez'},'company':'UPLINX','email':'stout.valdez@uplinx.biz','phone':'+1 (854) 480-3633','address':'880 Chestnut Avenue, Lowgap, Hawaii, 1537','about':'Cupidatat enim dolore non voluptate. Aliqua ut non Lorem in exercitation reprehenderit voluptate. Excepteur deserunt tempor laboris quis.','registered':'Wednesday, March 16, 2016 6:53 AM','latitude':'50.328393','longitude':'-25.990308','tags':['ea','fugiat','duis','consectetur','enim'],'greeting':'Hello, Stout! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed0f52176c8c3e1bed','index':32,'guid':'743abcbd-1fab-4aed-8cb7-3c935eb64c74','isActive':false,'balance':'$1,118.54','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Ortega','last':'Joseph'},'company':'APEXIA','email':'ortega.joseph@apexia.ca','phone':'+1 (872) 596-3024','address':'304 Canda Avenue, Mulino, New York, 8721','about':'Ipsum elit id cupidatat minim nisi minim. Ea ex amet ea ipsum Lorem deserunt. Occaecat cupidatat magna cillum aliquip sint id quis amet nostrud officia enim laborum. Aliqua deserunt amet commodo laboris labore mollit est. Officia voluptate Lorem esse mollit aliquip laboris cupidatat minim et. Labore esse incididunt officia nostrud pariatur reprehenderit.','registered':'Tuesday, January 31, 2017 6:06 AM','latitude':'43.861714','longitude':'33.771783','tags':['ut','Lorem','esse','quis','fugiat'],'greeting':'Hello, Ortega! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed2c00cdd101b6cd52','index':33,'guid':'4f6f99cf-f692-4d03-b23a-26f2b27273bd','isActive':true,'balance':'$1,682.91','picture':'http://placehold.it/32x32','age':20,'eyeColor':'blue','name':{'first':'Sampson','last':'Taylor'},'company':'GEOFORMA','email':'sampson.taylor@geoforma.info','phone':'+1 (911) 482-2993','address':'582 Kent Street, Umapine, Virgin Islands, 5300','about':'Voluptate laboris occaecat laboris tempor cillum quis cupidatat qui pariatur. Lorem minim commodo mollit adipisicing Lorem ut dolor consectetur ipsum. Sint sit voluptate labore aliqua ex labore velit. Ullamco tempor consectetur voluptate deserunt voluptate minim enim. Cillum commodo duis reprehenderit eu duis.','registered':'Thursday, November 9, 2017 11:24 PM','latitude':'24.949379','longitude':'155.034468','tags':['Lorem','cupidatat','elit','reprehenderit','commodo'],'greeting':'Hello, Sampson! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed4b7210ba0bc0d508','index':34,'guid':'73fd415f-f8cf-43e0-a86c-e725d000abd4','isActive':false,'balance':'$1,289.37','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Shari','last':'Melendez'},'company':'DIGIPRINT','email':'shari.melendez@digiprint.tv','phone':'+1 (914) 475-3995','address':'950 Wolf Place, Enetai, Alaska, 693','about':'Dolor incididunt et est commodo aliquip labore ad ullamco. Velit ex cillum nulla elit ex esse. Consectetur mollit fugiat cillum proident elit sunt non officia cillum ex laboris sint eu. Esse nulla eu officia in Lorem sint minim esse velit. Est Lorem ipsum enim aute. Elit minim eiusmod officia reprehenderit officia ut irure Lorem.','registered':'Wednesday, August 23, 2017 11:12 PM','latitude':'-70.347863','longitude':'94.812072','tags':['ea','ex','fugiat','duis','eu'],'greeting':'Hello, Shari! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed85ac364619d892ef','index':35,'guid':'c1905f34-14ff-4bd8-b683-02cac4d52623','isActive':false,'balance':'$2,538.50','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Santiago','last':'Joyner'},'company':'BRAINCLIP','email':'santiago.joyner@brainclip.co.uk','phone':'+1 (835) 405-2676','address':'554 Rose Street, Muir, Kentucky, 7752','about':'Quis culpa dolore fugiat magna culpa non deserunt consectetur elit. Id cupidatat occaecat duis irure ullamco elit in labore magna pariatur cillum est. Mollit dolore velit ipsum anim aliqua culpa sint. Occaecat aute anim ut sunt eu.','registered':'Thursday, January 18, 2018 4:49 PM','latitude':'57.057918','longitude':'-50.472596','tags':['ullamco','ullamco','sunt','voluptate','irure'],'greeting':'Hello, Santiago! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1763f56b1121fa88','index':36,'guid':'a7f50659-4ae3-4f3e-a9d8-087e05334b51','isActive':false,'balance':'$1,435.16','picture':'http://placehold.it/32x32','age':37,'eyeColor':'blue','name':{'first':'Adeline','last':'Hoffman'},'company':'BITREX','email':'adeline.hoffman@bitrex.io','phone':'+1 (823) 488-3201','address':'221 Corbin Place, Edmund, Palau, 193','about':'Magna ullamco consectetur velit adipisicing cillum ea. Est qui incididunt est ullamco ex aute exercitation irure. Cupidatat consectetur proident qui fugiat do. Labore magna aliqua consectetur fugiat. Excepteur deserunt sit qui dolor fugiat aute sunt anim ipsum magna ea commodo qui. Minim eu adipisicing ut irure excepteur eiusmod aliqua. Voluptate nisi ad consequat qui.','registered':'Tuesday, June 14, 2016 9:26 AM','latitude':'-53.123355','longitude':'88.180776','tags':['non','est','commodo','ut','aliquip'],'greeting':'Hello, Adeline! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed945d079f63e3185e','index':37,'guid':'1f4619e0-9289-4bea-a9db-a75f4cba1138','isActive':true,'balance':'$2,019.54','picture':'http://placehold.it/32x32','age':36,'eyeColor':'blue','name':{'first':'Porter','last':'Morse'},'company':'COMVOY','email':'porter.morse@comvoy.me','phone':'+1 (933) 562-3220','address':'416 India Street, Bourg, Rhode Island, 2266','about':'Et sint anim et sunt. Non mollit sunt cillum veniam sunt sint amet non mollit. Fugiat ea ullamco pariatur deserunt ex do minim irure irure.','registered':'Saturday, July 16, 2016 10:03 PM','latitude':'-81.782545','longitude':'69.783509','tags':['irure','consequat','veniam','nulla','velit'],'greeting':'Hello, Porter! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed411dd0f06c66bba6','index':38,'guid':'93c900f0-54c0-4c4c-b21d-d59d8d7c6177','isActive':true,'balance':'$3,764.84','picture':'http://placehold.it/32x32','age':26,'eyeColor':'green','name':{'first':'Fitzgerald','last':'Logan'},'company':'UTARIAN','email':'fitzgerald.logan@utarian.com','phone':'+1 (815) 461-2709','address':'498 Logan Street, Tonopah, Arkansas, 6652','about':'Quis Lorem sit est et dolor est esse in veniam. Mollit anim nostrud laboris consequat voluptate qui ad ipsum sint laborum exercitation quis ipsum. Incididunt cupidatat esse ea amet deserunt consequat eu proident duis adipisicing pariatur. Amet deserunt mollit aliquip mollit consequat sunt quis labore laboris quis. Magna cillum fugiat anim velit Lorem duis. Lorem duis amet veniam occaecat est excepteur ut ea velit esse non pariatur. Do veniam quis eu consequat ad duis incididunt minim dolore sit non minim adipisicing et.','registered':'Wednesday, August 9, 2017 9:20 PM','latitude':'24.480657','longitude':'-108.693421','tags':['dolore','ad','occaecat','quis','labore'],'greeting':'Hello, Fitzgerald! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edbb6f14559d8a7b28','index':39,'guid':'9434f48b-70a0-4161-8d06-c53bf8b9df94','isActive':true,'balance':'$3,713.47','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Mcconnell','last':'Nash'},'company':'TETAK','email':'mcconnell.nash@tetak.org','phone':'+1 (956) 477-3586','address':'853 Turnbull Avenue, Clarence, Missouri, 1599','about':'Culpa excepteur minim anim magna dolor dolore ad ex eu. In cupidatat cillum elit dolore in est minim dolore consectetur reprehenderit voluptate laborum. Deserunt id velit ad dolor mollit.','registered':'Saturday, November 10, 2018 9:27 AM','latitude':'1.691589','longitude':'143.704377','tags':['ut','deserunt','sit','cupidatat','ea'],'greeting':'Hello, Mcconnell! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed1a87ea0390733ffa','index':40,'guid':'ec8a55f7-7114-4787-b1ff-4e631731bc2c','isActive':true,'balance':'$2,200.71','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Kitty','last':'Meyers'},'company':'FIBEROX','email':'kitty.meyers@fiberox.net','phone':'+1 (864) 458-3826','address':'537 Georgia Avenue, Thermal, Illinois, 7930','about':'Non excepteur laboris Lorem magna adipisicing exercitation. Anim esse in pariatur minim ipsum qui voluptate irure. Pariatur Lorem pariatur esse commodo aute adipisicing anim commodo. Exercitation nostrud aliqua duis et amet amet tempor.','registered':'Tuesday, September 13, 2016 8:16 PM','latitude':'19.59506','longitude':'-57.814297','tags':['duis','ullamco','velit','sint','consequat'],'greeting':'Hello, Kitty! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed4dc76717bf1217b3','index':41,'guid':'40521cde-f835-4620-902b-af7abf185d8d','isActive':false,'balance':'$2,907.02','picture':'http://placehold.it/32x32','age':26,'eyeColor':'green','name':{'first':'Klein','last':'Goodwin'},'company':'PLASTO','email':'klein.goodwin@plasto.name','phone':'+1 (950) 563-3104','address':'764 Devoe Street, Lindcove, Oklahoma, 458','about':'Amet aliqua magna ea veniam non aliquip irure esse id ipsum cillum sint tempor dolor. Ullamco deserunt fugiat amet pariatur culpa nostrud commodo commodo. Ad occaecat magna adipisicing voluptate. Minim ad adipisicing cupidatat elit nostrud eu irure. Cupidatat occaecat aute magna consectetur dolore anim et. Ex voluptate velit exercitation laborum ad ullamco ad. Aliquip nulla ipsum dolore cillum qui nostrud eu adipisicing amet tempor do.','registered':'Tuesday, February 13, 2018 3:56 PM','latitude':'-27.168725','longitude':'-29.499285','tags':['minim','labore','do','deserunt','dolor'],'greeting':'Hello, Klein! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1ac77396b29aee9e','index':42,'guid':'7cfc03e3-30e9-4ae1-a1f5-f6c3223ca770','isActive':true,'balance':'$2,986.47','picture':'http://placehold.it/32x32','age':22,'eyeColor':'brown','name':{'first':'Isabelle','last':'Bishop'},'company':'GEEKNET','email':'isabelle.bishop@geeknet.us','phone':'+1 (908) 418-2642','address':'729 Willmohr Street, Aguila, Montana, 7510','about':'In nulla commodo nostrud sint. Elit et occaecat et aliqua aliquip magna esse commodo duis Lorem dolor magna enim deserunt. Ipsum pariatur reprehenderit ipsum adipisicing mollit incididunt ut. Sunt in consequat ex ut minim non qui anim labore. Deserunt minim voluptate in nulla occaecat.','registered':'Monday, September 15, 2014 6:22 AM','latitude':'-81.686947','longitude':'38.409291','tags':['proident','est','aliqua','veniam','anim'],'greeting':'Hello, Isabelle! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edb3a070c9469a4893','index':43,'guid':'3dec76b4-0b55-4765-a2fd-b8dbd9c82f8f','isActive':true,'balance':'$2,501.24','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Josefina','last':'Turner'},'company':'COMSTAR','email':'josefina.turner@comstar.biz','phone':'+1 (908) 566-3029','address':'606 Schenck Place, Brutus, Vermont, 8681','about':'Enim consectetur pariatur sint dolor nostrud est deserunt nulla quis pariatur sit. Ad aute incididunt nisi excepteur duis est velit voluptate ullamco occaecat magna reprehenderit aliquip. Proident deserunt consectetur non et exercitation elit dolore enim aliqua incididunt anim amet. Ex esse sint commodo minim aliqua ut irure. Proident ex culpa voluptate fugiat nisi. Sint commodo laboris excepteur minim ipsum labore tempor quis magna.','registered':'Saturday, December 31, 2016 6:38 AM','latitude':'35.275088','longitude':'24.30485','tags':['minim','ut','irure','Lorem','veniam'],'greeting':'Hello, Josefina! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed1aa7d74128ee3d0f','index':44,'guid':'10599279-c367-46c4-9f7a-744c2e4bf6c9','isActive':true,'balance':'$1,753.06','picture':'http://placehold.it/32x32','age':27,'eyeColor':'blue','name':{'first':'Lily','last':'Haynes'},'company':'KIOSK','email':'lily.haynes@kiosk.ca','phone':'+1 (872) 451-2301','address':'509 Balfour Place, Grazierville, New Hampshire, 2750','about':'Nisi aliquip occaecat nostrud do sint qui nisi officia Lorem. Ad et et laboris nisi dolore aliqua eu. Aliqua veniam quis eu pariatur incididunt mollit id deserunt officia eiusmod. Consequat adipisicing do nisi voluptate eiusmod minim pariatur minim nisi nostrud culpa cupidatat. Irure consectetur id consequat adipisicing ullamco occaecat do. Ex proident ea quis nulla incididunt sunt excepteur incididunt. Aliquip minim nostrud non anim Lorem.','registered':'Tuesday, November 20, 2018 9:28 AM','latitude':'-12.677798','longitude':'114.506787','tags':['culpa','amet','elit','officia','irure'],'greeting':'Hello, Lily! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed74c76f2e84e201ce','index':45,'guid':'ec0a68d4-629e-46c9-9af7-f6ea867f02ba','isActive':true,'balance':'$1,477.93','picture':'http://placehold.it/32x32','age':23,'eyeColor':'green','name':{'first':'Shauna','last':'Pitts'},'company':'SPACEWAX','email':'shauna.pitts@spacewax.info','phone':'+1 (841) 406-2360','address':'348 Tabor Court, Westwood, Puerto Rico, 8297','about':'Aliquip irure officia magna ea magna mollit ea non amet deserunt. Veniam mollit labore culpa magna aliqua quis consequat est consectetur ea reprehenderit nostrud consequat aliqua. Mollit do ipsum mollit eiusmod.','registered':'Thursday, October 2, 2014 2:48 AM','latitude':'-55.17388','longitude':'-13.370494','tags':['anim','consectetur','cillum','veniam','duis'],'greeting':'Hello, Shauna! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed419e718484b16722','index':46,'guid':'b2d6101d-5646-43f4-8207-284494e5a990','isActive':false,'balance':'$2,006.96','picture':'http://placehold.it/32x32','age':27,'eyeColor':'brown','name':{'first':'Lawrence','last':'Boyer'},'company':'SKYPLEX','email':'lawrence.boyer@skyplex.tv','phone':'+1 (953) 548-2618','address':'464 Pilling Street, Blandburg, Arizona, 5531','about':'Culpa sit minim pariatur mollit cupidatat sunt duis. Nisi ea proident veniam exercitation adipisicing Lorem aliquip amet dolor voluptate in nisi. Non commodo anim sunt est fugiat laborum nisi aliqua non Lorem exercitation dolor. Laboris dolore do minim ut eiusmod enim magna cillum laborum consectetur aliquip minim enim Lorem. Veniam ex veniam occaecat aliquip elit aliquip est eiusmod minim minim adipisicing.','registered':'Wednesday, July 30, 2014 2:17 AM','latitude':'-78.681255','longitude':'139.960626','tags':['consequat','Lorem','incididunt','dolor','esse'],'greeting':'Hello, Lawrence! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed08a9024998292c70','index':47,'guid':'277de142-ebeb-4828-906a-7fd8bc0a738a','isActive':true,'balance':'$1,273.19','picture':'http://placehold.it/32x32','age':27,'eyeColor':'brown','name':{'first':'Sonya','last':'Stafford'},'company':'AQUACINE','email':'sonya.stafford@aquacine.co.uk','phone':'+1 (824) 581-3927','address':'641 Bowery Street, Hillsboro, Delaware, 7893','about':'Culpa labore ex reprehenderit mollit cupidatat dolore et ut quis in. Sint esse culpa enim culpa tempor exercitation veniam minim consectetur. Sunt est laboris minim quis incididunt exercitation laboris cupidatat fugiat ad. Deserunt ipsum do dolor cillum excepteur incididunt.','registered':'Thursday, March 26, 2015 1:10 PM','latitude':'-84.750592','longitude':'165.493533','tags':['minim','officia','dolore','ipsum','est'],'greeting':'Hello, Sonya! You have 8 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd5037f2c79ecde68','index':48,'guid':'2dc6532f-9a26-49aa-b444-8923896db89c','isActive':false,'balance':'$3,168.93','picture':'http://placehold.it/32x32','age':36,'eyeColor':'brown','name':{'first':'Marguerite','last':'Stuart'},'company':'ACCUFARM','email':'marguerite.stuart@accufarm.io','phone':'+1 (848) 535-2253','address':'301 Menahan Street, Sunnyside, Nebraska, 4809','about':'Deserunt sint labore voluptate amet anim culpa nostrud adipisicing enim cupidatat ullamco exercitation fugiat est. Magna dolor aute incididunt ea ad adipisicing. Do cupidatat ut officia officia culpa sit do.','registered':'Thursday, May 8, 2014 1:25 PM','latitude':'21.82277','longitude':'-7.368347','tags':['labore','nulla','ullamco','irure','adipisicing'],'greeting':'Hello, Marguerite! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edb26d315635818dae','index':49,'guid':'083a5eda-0a70-4f89-87f7-2cd386c0f22a','isActive':false,'balance':'$2,576.25','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Louella','last':'Holloway'},'company':'BEDDER','email':'louella.holloway@bedder.me','phone':'+1 (801) 425-3761','address':'545 Lafayette Avenue, Caledonia, Louisiana, 2816','about':'Qui exercitation occaecat dolore mollit. Fugiat cupidatat proident culpa fugiat quis. In cupidatat commodo elit ea enim occaecat esse exercitation nostrud occaecat veniam laboris fugiat. Nisi sunt reprehenderit aliqua reprehenderit tempor id dolore ullamco pariatur reprehenderit et eu ex pariatur.','registered':'Wednesday, November 5, 2014 1:10 AM','latitude':'36.385637','longitude':'77.949423','tags':['eu','irure','velit','non','aliquip'],'greeting':'Hello, Louella! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed77cd60a1abc1ecce','index':50,'guid':'2887c3c1-3eba-4237-a0db-1977eed94554','isActive':true,'balance':'$1,633.51','picture':'http://placehold.it/32x32','age':22,'eyeColor':'green','name':{'first':'Bates','last':'Carrillo'},'company':'ZOMBOID','email':'bates.carrillo@zomboid.com','phone':'+1 (934) 405-2006','address':'330 Howard Alley, Troy, Kansas, 4881','about':'Voluptate esse est ullamco anim tempor ea reprehenderit. Occaecat pariatur deserunt cillum laboris labore id exercitation esse ipsum ipsum ex aliquip. Sunt non elit est ea occaecat. Magna deserunt commodo aliqua ipsum est cillum dolor nisi. Ex duis est tempor tempor laboris do do quis id magna. Dolor do est elit eu laborum ullamco culpa consequat velit eiusmod tempor.','registered':'Saturday, May 28, 2016 3:56 AM','latitude':'83.310134','longitude':'-105.862836','tags':['est','commodo','ea','commodo','sunt'],'greeting':'Hello, Bates! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed5ec0ec299b471fb5','index':51,'guid':'512b5e67-f785-492e-9d94-e43ef8b399b8','isActive':false,'balance':'$3,032.22','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Floyd','last':'Yang'},'company':'FRENEX','email':'floyd.yang@frenex.org','phone':'+1 (924) 566-3304','address':'418 Quay Street, Chumuckla, Guam, 7743','about':'Irure sit velit exercitation dolore est nisi incididunt ut quis consectetur incididunt est dolor. Aute nisi enim esse aliquip enim culpa commodo consectetur. Duis laborum magna ad duis ipsum aliqua eiusmod cillum. Consectetur et duis eiusmod irure ad est nisi incididunt eiusmod labore. Pariatur proident in Lorem adipisicing mollit proident excepteur nulla do nostrud mollit eiusmod. Duis ad dolore irure fugiat anim laboris ipsum et sit duis ipsum voluptate. Lorem non aute exercitation qui ullamco officia minim sint pariatur ut dolor.','registered':'Wednesday, January 18, 2017 2:01 AM','latitude':'45.888721','longitude':'-41.232793','tags':['elit','in','esse','ea','officia'],'greeting':'Hello, Floyd! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed51e26ca89e5caf49','index':52,'guid':'4e0907f6-facc-46df-8952-73561a53fe33','isActive':true,'balance':'$3,767.41','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Gardner','last':'Carey'},'company':'KLUGGER','email':'gardner.carey@klugger.net','phone':'+1 (876) 481-3502','address':'131 Utica Avenue, Cannondale, Federated States Of Micronesia, 610','about':'Amet ad pariatur excepteur anim ex officia commodo proident aliqua occaecat consequat Lorem officia sit. Id minim velit nisi laboris nisi nulla incididunt eiusmod velit. Deserunt labore quis et tempor. Et labore exercitation laborum officia ullamco nostrud adipisicing laboris esse laborum aute anim elit. Sunt ad officia tempor esse et quis aliquip irure pariatur laborum id quis ex. Eu consequat nisi deserunt id eu proident ex minim aute nulla tempor ex.','registered':'Friday, February 21, 2014 6:42 AM','latitude':'-54.740231','longitude':'15.01484','tags':['commodo','laboris','occaecat','aliquip','adipisicing'],'greeting':'Hello, Gardner! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed52e3c9407105093a','index':53,'guid':'1d3b9e7a-1bc3-40ea-b808-1c33f0d48c70','isActive':true,'balance':'$1,113.30','picture':'http://placehold.it/32x32','age':26,'eyeColor':'blue','name':{'first':'Herman','last':'Rogers'},'company':'TALENDULA','email':'herman.rogers@talendula.name','phone':'+1 (818) 521-2005','address':'541 Norman Avenue, Winfred, Tennessee, 447','about':'Culpa ex laborum non ad ullamco officia. Nisi mollit mollit voluptate sit sint ullamco. Lorem exercitation nulla anim eiusmod deserunt magna sint. Officia sunt eiusmod aliqua reprehenderit sunt mollit sit cupidatat sint.','registered':'Wednesday, July 11, 2018 1:05 AM','latitude':'-20.708105','longitude':'-151.294563','tags':['exercitation','minim','officia','qui','enim'],'greeting':'Hello, Herman! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edfcb123d545b6edb4','index':54,'guid':'c0e0c669-4eed-43ee-bdd0-78fe6e9ca4d5','isActive':true,'balance':'$3,309.64','picture':'http://placehold.it/32x32','age':22,'eyeColor':'green','name':{'first':'Whitley','last':'Stark'},'company':'MUSAPHICS','email':'whitley.stark@musaphics.us','phone':'+1 (803) 476-2151','address':'548 Cobek Court, Chamizal, Indiana, 204','about':'Adipisicing veniam dolor ex sint sit id eu voluptate. Excepteur veniam proident exercitation id eu et sunt pariatur. Qui occaecat culpa aliqua nisi excepteur minim veniam. Est duis nulla laborum excepteur cillum pariatur sint incididunt. Velit commodo eu incididunt voluptate. Amet laboris laboris id adipisicing labore eiusmod consequat minim cillum et.','registered':'Thursday, March 27, 2014 9:10 AM','latitude':'71.219596','longitude':'51.012855','tags':['reprehenderit','mollit','laborum','voluptate','aliquip'],'greeting':'Hello, Whitley! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed81510dfc61602fcf','index':55,'guid':'7ec5c24d-f169-4399-a2a3-300c0f45e52e','isActive':false,'balance':'$3,721.04','picture':'http://placehold.it/32x32','age':23,'eyeColor':'green','name':{'first':'Gretchen','last':'Wade'},'company':'EWEVILLE','email':'gretchen.wade@eweville.biz','phone':'+1 (977) 598-3700','address':'721 Colonial Road, Brookfield, South Dakota, 3888','about':'Fugiat consequat sint ut ut et ullamco eiusmod deserunt pariatur. Veniam eiusmod esse fugiat mollit. Proident laboris minim qui do ipsum excepteur exercitation irure anim. Aliqua labore quis eu fugiat dolore ullamco velit Lorem voluptate ipsum nostrud eiusmod laborum proident.','registered':'Friday, October 12, 2018 10:59 AM','latitude':'41.937653','longitude':'63.378531','tags':['aute','cillum','ea','ex','aute'],'greeting':'Hello, Gretchen! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edf78f77d4a7d557bb','index':56,'guid':'8718ada7-6fd0-49ef-a405-29850503948b','isActive':false,'balance':'$3,341.33','picture':'http://placehold.it/32x32','age':32,'eyeColor':'blue','name':{'first':'Naomi','last':'Frye'},'company':'MAZUDA','email':'naomi.frye@mazuda.ca','phone':'+1 (825) 427-2255','address':'741 Coyle Street, Comptche, Pennsylvania, 8441','about':'Aliqua fugiat laborum quis ullamco cupidatat sit dolor nulla dolore. Do Lorem et ipsum culpa irure sit do dolor qui sit laboris aliqua. Ex consectetur irure in veniam reprehenderit amet do elit eiusmod est magna.','registered':'Thursday, January 9, 2014 7:18 AM','latitude':'41.078645','longitude':'-50.241966','tags':['do','aliquip','eiusmod','velit','id'],'greeting':'Hello, Naomi! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edbf45db2e072a48b4','index':57,'guid':'c158ebf7-fb8b-4ea8-adbf-8c51c6486715','isActive':true,'balance':'$2,811.55','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Lamb','last':'Johns'},'company':'DOGTOWN','email':'lamb.johns@dogtown.info','phone':'+1 (946) 530-3057','address':'559 Malbone Street, Kennedyville, California, 2052','about':'Eiusmod dolor labore cillum ad veniam elit voluptate voluptate pariatur est cupidatat. Laboris ut qui in cillum sunt dolore ut enim. Minim nostrud ex qui quis reprehenderit magna ipsum cupidatat irure minim laboris veniam irure. Fugiat velit deserunt aliquip in esse proident excepteur labore reprehenderit excepteur sunt in cupidatat exercitation. Ex pariatur irure mollit tempor non magna ex.','registered':'Friday, April 21, 2017 1:51 AM','latitude':'-61.403599','longitude':'-93.447102','tags':['aliquip','tempor','sint','enim','ipsum'],'greeting':'Hello, Lamb! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edbb9c88190cb59cf2','index':58,'guid':'f0de5ac5-eb28-491b-81c5-76d447c9055e','isActive':true,'balance':'$1,611.99','picture':'http://placehold.it/32x32','age':37,'eyeColor':'brown','name':{'first':'Lynette','last':'Cleveland'},'company':'ARTWORLDS','email':'lynette.cleveland@artworlds.tv','phone':'+1 (889) 596-3723','address':'439 Montauk Avenue, Felt, New Mexico, 9681','about':'Incididunt aliquip est aliquip est ullamco do consectetur dolor. Lorem mollit mollit dolor et ipsum ut qui veniam aute ea. Adipisicing reprehenderit culpa velit laborum adipisicing amet consectetur velit nisi. Ut qui proident ad cillum excepteur adipisicing quis labore. Duis velit culpa et excepteur eiusmod ex labore in nisi nostrud. Et ullamco minim excepteur ut enim reprehenderit consequat eiusmod laboris Lorem commodo exercitation qui laborum.','registered':'Wednesday, August 26, 2015 12:53 PM','latitude':'49.861336','longitude':'86.865926','tags':['reprehenderit','minim','in','minim','nostrud'],'greeting':'Hello, Lynette! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed5b760ddde7295fa8','index':59,'guid':'f8180d3f-c5c0-48b2-966e-a0b2a80f8e84','isActive':true,'balance':'$3,376.75','picture':'http://placehold.it/32x32','age':32,'eyeColor':'green','name':{'first':'Obrien','last':'Page'},'company':'GLASSTEP','email':'obrien.page@glasstep.co.uk','phone':'+1 (902) 583-3086','address':'183 Ridgewood Avenue, Vicksburg, Wisconsin, 7430','about':'Aute excepteur cillum exercitation duis Lorem irure labore elit. Labore magna cupidatat velit consectetur minim do Lorem in excepteur commodo ea consequat ullamco laborum. Ut in id occaecat eu quis duis id ea deserunt veniam.','registered':'Wednesday, March 29, 2017 12:13 AM','latitude':'-40.156154','longitude':'72.76301','tags':['excepteur','non','anim','nulla','anim'],'greeting':'Hello, Obrien! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed52985d3d8901d653','index':60,'guid':'d2e14fa1-8c54-4bcb-8a58-eb2e6f8d0e45','isActive':true,'balance':'$1,659.47','picture':'http://placehold.it/32x32','age':33,'eyeColor':'brown','name':{'first':'Knowles','last':'Goodman'},'company':'CENTREE','email':'knowles.goodman@centree.io','phone':'+1 (862) 563-3692','address':'504 Lott Street, Allensworth, Florida, 7148','about':'Do aliquip voluptate aliqua nostrud. Eu dolore ex occaecat pariatur aute laborum aute nulla aute amet. Excepteur sit laboris ad non anim ut officia ut ad exercitation officia dolore laboris. Esse voluptate minim deserunt nostrud exercitation laborum voluptate exercitation id laborum fugiat proident cupidatat proident. Nulla nostrud est sint adipisicing incididunt exercitation dolor sit et elit tempor occaecat sint culpa. Pariatur occaecat laboris pariatur laboris ad pariatur in cillum fugiat est fugiat. Proident eu id irure excepteur esse aute cillum adipisicing.','registered':'Wednesday, October 15, 2014 6:17 PM','latitude':'-15.73863','longitude':'87.422009','tags':['consequat','sint','tempor','veniam','culpa'],'greeting':'Hello, Knowles! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0eda00b73bdb7ea54e9','index':61,'guid':'c8a064db-0ec6-4832-9820-7280a0333709','isActive':true,'balance':'$3,701.14','picture':'http://placehold.it/32x32','age':35,'eyeColor':'brown','name':{'first':'Shepherd','last':'Todd'},'company':'ECRATIC','email':'shepherd.todd@ecratic.me','phone':'+1 (881) 444-3389','address':'450 Frank Court, Temperanceville, Ohio, 7006','about':'Voluptate cillum ad fugiat velit adipisicing sint consequat veniam Lorem reprehenderit. Cillum sit non deserunt consequat. Amet sunt pariatur non mollit ullamco proident sint dolore anim elit cupidatat anim do ullamco. Lorem Lorem incididunt ea elit consequat laboris enim duis quis Lorem id aute veniam consequat. Cillum veniam cillum sint qui Lorem fugiat culpa consequat. Est sint duis ut qui fugiat. Laborum pariatur velit et sunt mollit eiusmod excepteur culpa ex et officia.','registered':'Tuesday, October 10, 2017 2:01 AM','latitude':'82.951563','longitude':'-4.866954','tags':['eu','qui','proident','esse','ex'],'greeting':'Hello, Shepherd! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed0e51d1a7e2d9e559','index':62,'guid':'739c3d38-200d-4531-84d8-4e7c39ae5b8c','isActive':true,'balance':'$3,679.01','picture':'http://placehold.it/32x32','age':31,'eyeColor':'brown','name':{'first':'Rosalyn','last':'Heath'},'company':'ZAYA','email':'rosalyn.heath@zaya.com','phone':'+1 (865) 403-3520','address':'303 Henderson Walk, Hoehne, District Of Columbia, 4306','about':'Sint occaecat nulla mollit sint fugiat eu proident dolor labore consequat. Occaecat tempor excepteur do fugiat incididunt Lorem in ullamco dolore laborum. Cillum mollit aliquip excepteur aliquip sint sunt minim non irure irure. Cillum fugiat aliqua enim dolore. Nulla culpa culpa nostrud ad. Eiusmod culpa proident proident non est cupidatat eu sunt sit incididunt id nisi.','registered':'Wednesday, April 22, 2015 12:35 PM','latitude':'33.628504','longitude':'110.772802','tags':['consequat','ut','ex','labore','consectetur'],'greeting':'Hello, Rosalyn! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd5274c01d353d0c5','index':63,'guid':'8815fe55-8af1-4708-a62a-d554dbd74a4a','isActive':true,'balance':'$2,126.01','picture':'http://placehold.it/32x32','age':30,'eyeColor':'blue','name':{'first':'Queen','last':'Harper'},'company':'TRI@TRIBALOG','email':'queen.harper@tri@tribalog.org','phone':'+1 (903) 592-3145','address':'926 Heath Place, Wawona, Maine, 7340','about':'Laborum cupidatat commodo aliquip reprehenderit. Excepteur eu labore duis minim minim voluptate aute nostrud deserunt ut velit ullamco. Adipisicing nisi occaecat laborum proident. Id reprehenderit eiusmod cupidatat qui aute consequat amet enim commodo duis non ipsum. Amet ut aliqua magna qui proident mollit aute.','registered':'Saturday, April 9, 2016 5:12 AM','latitude':'51.814216','longitude':'177.348115','tags':['cillum','ut','dolor','do','nisi'],'greeting':'Hello, Queen! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed126298b6ce62ed56','index':64,'guid':'001c87fe-182f-450f-903b-2e29a9bb0322','isActive':true,'balance':'$3,578.29','picture':'http://placehold.it/32x32','age':20,'eyeColor':'green','name':{'first':'Pauline','last':'Mills'},'company':'CRUSTATIA','email':'pauline.mills@crustatia.net','phone':'+1 (984) 582-3899','address':'899 Revere Place, Welch, Iowa, 216','about':'Tempor eu exercitation ut id. Deserunt ex reprehenderit veniam nisi. Aute laborum veniam velit dolore ut deserunt Lorem sit esse quis dolor ex do nisi. In dolor tempor officia id. Velit nisi culpa nostrud laborum officia incididunt laborum velit non quis id exercitation exercitation. Anim elit ullamco in enim Lorem culpa aliqua Lorem.','registered':'Monday, June 2, 2014 2:03 PM','latitude':'56.427576','longitude':'172.183669','tags':['pariatur','pariatur','pariatur','fugiat','Lorem'],'greeting':'Hello, Pauline! You have 8 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed3e332ad9e8a178d8','index':65,'guid':'5ad7292b-feef-4a7e-b485-142cadfbe8ea','isActive':false,'balance':'$3,916.54','picture':'http://placehold.it/32x32','age':22,'eyeColor':'brown','name':{'first':'Garrett','last':'Richmond'},'company':'XYQAG','email':'garrett.richmond@xyqag.name','phone':'+1 (952) 584-3794','address':'233 Grove Street, Summerfield, Virginia, 4735','about':'Nostrud quis pariatur occaecat laborum laboris aliqua ut fugiat dolor. Commodo tempor excepteur enim nostrud Lorem. Aute elit nulla labore ad pariatur cupidatat Lorem qui cupidatat velit deserunt excepteur esse. Excepteur nulla et nostrud quis labore est veniam enim nisi laboris ut enim. Ea esse nulla anim excepteur reprehenderit deserunt voluptate minim qui labore adipisicing amet eu enim.','registered':'Wednesday, March 5, 2014 4:35 PM','latitude':'68.665041','longitude':'148.799524','tags':['irure','reprehenderit','minim','ea','do'],'greeting':'Hello, Garrett! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed541aa2ec47466ace','index':66,'guid':'9cda6f3c-c9ab-451c-bb19-2e4c8463d011','isActive':true,'balance':'$3,352.52','picture':'http://placehold.it/32x32','age':30,'eyeColor':'brown','name':{'first':'Cobb','last':'Whitley'},'company':'UNIA','email':'cobb.whitley@unia.us','phone':'+1 (888) 490-3342','address':'864 Belmont Avenue, Needmore, Massachusetts, 8286','about':'Nisi aliquip fugiat ipsum nisi ullamco minim pariatur labore. Sint labore anim do ad ad esse eu nostrud nulla commodo anim. Cillum anim enim duis cillum non do nisi aliquip veniam voluptate commodo aliqua laborum. Exercitation in do eu qui sint aliquip. Esse adipisicing deserunt deserunt qui anim aliqua occaecat et nostrud elit ea in anim cillum. Tempor mollit proident tempor sunt est sint laborum ullamco incididunt non. Velit aliqua sunt excepteur nisi qui eiusmod ipsum dolore aliquip velit ullamco ullamco.','registered':'Friday, May 23, 2014 7:11 PM','latitude':'-32.950581','longitude':'147.772494','tags':['mollit','adipisicing','irure','ad','minim'],'greeting':'Hello, Cobb! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed8186c3d6f34c2be3','index':67,'guid':'fee98f6d-d68a-4189-8180-b6cb337e537e','isActive':false,'balance':'$1,698.42','picture':'http://placehold.it/32x32','age':20,'eyeColor':'blue','name':{'first':'Brennan','last':'Tyler'},'company':'PODUNK','email':'brennan.tyler@podunk.biz','phone':'+1 (867) 498-2727','address':'599 Harkness Avenue, Gorst, American Samoa, 322','about':'Reprehenderit id sit qui id qui aute ea sit magna in qui proident. Excepteur ad nostrud do nostrud in incididunt voluptate adipisicing sint anim. Ullamco consequat minim nulla irure ex est irure reprehenderit deserunt voluptate dolore anim sunt. Occaecat dolore voluptate voluptate elit commodo nulla laborum ad do irure.','registered':'Friday, February 9, 2018 5:40 PM','latitude':'11.150893','longitude':'-85.298004','tags':['quis','minim','deserunt','cillum','laboris'],'greeting':'Hello, Brennan! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed075c9c4f7439818d','index':68,'guid':'1ef76b18-6b8d-4c3c-aca3-9fa2b43f0242','isActive':false,'balance':'$2,091.17','picture':'http://placehold.it/32x32','age':26,'eyeColor':'brown','name':{'first':'Neal','last':'Stephenson'},'company':'OTHERSIDE','email':'neal.stephenson@otherside.ca','phone':'+1 (820) 496-3344','address':'867 Wilson Street, Kidder, Colorado, 4599','about':'Do laboris enim proident in qui velit adipisicing magna anim. Amet proident non exercitation ipsum aliqua excepteur nostrud. Enim esse non sit in nostrud deserunt id laborum cillum deserunt consequat. Anim velit exercitation qui sit voluptate. Irure duis non veniam velit mollit exercitation id exercitation.','registered':'Thursday, November 13, 2014 11:00 PM','latitude':'54.809693','longitude':'1.877241','tags':['anim','duis','in','officia','sint'],'greeting':'Hello, Neal! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0eda0a2dc24db64b638','index':69,'guid':'194744fd-089b-40b6-a290-98a6ec30a415','isActive':false,'balance':'$3,191.67','picture':'http://placehold.it/32x32','age':24,'eyeColor':'brown','name':{'first':'Shields','last':'Hubbard'},'company':'MIRACULA','email':'shields.hubbard@miracula.info','phone':'+1 (885) 582-2001','address':'529 Eagle Street, Guilford, Nevada, 1460','about':'Eiusmod exercitation ut incididunt veniam commodo culpa ullamco mollit id adipisicing exercitation ad sint. Nostrud excepteur amet aliqua mollit incididunt laborum voluptate id anim. Nulla sint laboris dolor esse cupidatat laborum ex sint. Ex non sunt sit nulla.','registered':'Monday, February 13, 2017 6:22 AM','latitude':'-69.145209','longitude':'-40.69755','tags':['tempor','enim','qui','velit','elit'],'greeting':'Hello, Shields! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edf939c130177e074d','index':70,'guid':'303b176c-7803-4ed2-a35f-3e3c831793ef','isActive':false,'balance':'$2,359.09','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Coleen','last':'Knight'},'company':'BLEEKO','email':'coleen.knight@bleeko.tv','phone':'+1 (867) 423-3146','address':'527 Broadway , Bonanza, Marshall Islands, 4988','about':'Laboris nulla pariatur laborum ad aute excepteur sunt pariatur exercitation. Do nostrud qui ipsum ullamco et sint do Lorem cillum ullamco do. Exercitation labore excepteur commodo incididunt eiusmod proident consectetur adipisicing nostrud aute voluptate laboris. Commodo anim proident eiusmod pariatur est ea laborum incididunt qui tempor reprehenderit ullamco id. Eiusmod commodo nisi consectetur ut qui quis aliqua sit minim nostrud sunt laborum eiusmod adipisicing.','registered':'Sunday, May 6, 2018 8:03 AM','latitude':'70.729041','longitude':'113.052761','tags':['Lorem','ullamco','nulla','ullamco','commodo'],'greeting':'Hello, Coleen! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edae8b1ce688b61223','index':71,'guid':'7d6f3b1a-c367-4068-9e8e-1717d513ece3','isActive':false,'balance':'$2,911.07','picture':'http://placehold.it/32x32','age':21,'eyeColor':'brown','name':{'first':'Clark','last':'Ryan'},'company':'ECLIPSENT','email':'clark.ryan@eclipsent.co.uk','phone':'+1 (938) 562-2740','address':'500 Lewis Avenue, Rockbridge, North Dakota, 5133','about':'Adipisicing exercitation officia sit excepteur excepteur sunt sint amet. Aliqua ipsum sint laboris eiusmod esse culpa elit sunt. Dolore est consectetur est quis quis magna. Aliquip nostrud dolore ex pariatur. Anim nostrud duis exercitation ut magna magna culpa. Nisi irure id mollit labore non sit mollit occaecat Lorem est ipsum. Nulla est fugiat cillum nisi aliqua consectetur amet nulla nostrud esse.','registered':'Friday, July 24, 2015 9:28 AM','latitude':'-68.055815','longitude':'-50.926966','tags':['deserunt','ad','ad','ut','id'],'greeting':'Hello, Clark! You have 7 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed5d1e8df45d8ab4db','index':72,'guid':'ce85db37-7d04-4f4c-a4b0-78003533e5c6','isActive':false,'balance':'$1,127.43','picture':'http://placehold.it/32x32','age':21,'eyeColor':'green','name':{'first':'Dillon','last':'Hooper'},'company':'MEDESIGN','email':'dillon.hooper@medesign.io','phone':'+1 (929) 600-3797','address':'652 Mill Avenue, Elliston, Mississippi, 2958','about':'Dolore culpa qui exercitation nostrud do. Irure duis in ad ipsum aliqua aliquip nulla sit veniam officia quis occaecat est. Magna qui eiusmod pariatur aliquip minim commodo. Qui ex dolor excepteur consequat eiusmod occaecat. In officia ipsum do Lorem excepteur proident pariatur labore.','registered':'Monday, May 26, 2014 2:38 AM','latitude':'-36.032189','longitude':'86.865529','tags':['non','ut','ex','Lorem','quis'],'greeting':'Hello, Dillon! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edb84814579c3121b3','index':73,'guid':'d7303901-5186-4595-a759-22306f67d0a3','isActive':true,'balance':'$2,326.59','picture':'http://placehold.it/32x32','age':33,'eyeColor':'green','name':{'first':'Moreno','last':'Hull'},'company':'ZEAM','email':'moreno.hull@zeam.me','phone':'+1 (984) 586-3738','address':'265 Pine Street, Talpa, North Carolina, 6041','about':'Fugiat exercitation est ullamco anim. Exercitation proident id sunt culpa Lorem amet. Consectetur anim consectetur pariatur consequat consectetur amet excepteur voluptate ea velit duis eiusmod proident. In sint laborum cupidatat ea amet ex. Reprehenderit amet sunt dolor ullamco est ex deserunt.','registered':'Wednesday, January 24, 2018 8:52 PM','latitude':'84.956857','longitude':'113.210051','tags':['est','excepteur','anim','Lorem','dolor'],'greeting':'Hello, Moreno! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eda4eb9dcb92c82d06','index':74,'guid':'8ee28651-802e-4523-b676-c713f6e874b8','isActive':true,'balance':'$3,783.97','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Tracie','last':'Price'},'company':'ICOLOGY','email':'tracie.price@icology.com','phone':'+1 (897) 403-3768','address':'487 Sheffield Avenue, Vallonia, Wyoming, 276','about':'Voluptate laboris laborum aute ex sint voluptate officia proident. Sit esse nostrud cupidatat in veniam sit duis est. Do mollit elit exercitation aliqua id irure ex. Lorem reprehenderit do ullamco sint ea ad nisi ad ut.','registered':'Saturday, December 10, 2016 9:44 AM','latitude':'77.770464','longitude':'151.392903','tags':['incididunt','labore','aliquip','anim','minim'],'greeting':'Hello, Tracie! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed68ab1a55d1c35e6c','index':75,'guid':'deedd26a-8928-4064-9666-5c59ea8144b4','isActive':true,'balance':'$2,848.08','picture':'http://placehold.it/32x32','age':32,'eyeColor':'brown','name':{'first':'Montgomery','last':'Bruce'},'company':'CYTREK','email':'montgomery.bruce@cytrek.org','phone':'+1 (824) 414-2731','address':'397 Beach Place, Ellerslie, South Carolina, 967','about':'Mollit minim excepteur magna velit cillum excepteur exercitation anim id labore deserunt do. Fugiat ex et id ad. Duis excepteur laboris est nulla do id irure quis eiusmod do esse ut culpa in.','registered':'Tuesday, August 25, 2015 6:42 AM','latitude':'79.722631','longitude':'-7.516885','tags':['Lorem','sint','voluptate','proident','incididunt'],'greeting':'Hello, Montgomery! You have 6 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd90e0abb1cc2b0aa','index':76,'guid':'a072159d-12db-4747-9c2a-e2486a53d043','isActive':false,'balance':'$2,723.54','picture':'http://placehold.it/32x32','age':40,'eyeColor':'green','name':{'first':'Zelma','last':'Salinas'},'company':'IMAGEFLOW','email':'zelma.salinas@imageflow.net','phone':'+1 (964) 555-3856','address':'584 Reeve Place, Nord, Georgia, 7473','about':'Aliqua proident excepteur duis cupidatat cillum amet esse esse consectetur ea. Officia sunt consequat nostrud minim enim dolore dolor duis cillum. Esse labore veniam sint laborum excepteur sint tempor do ad cupidatat aliquip laboris elit id. Velit reprehenderit ullamco velit ullamco adipisicing velit esse irure velit et.','registered':'Thursday, February 25, 2016 8:18 PM','latitude':'-32.880524','longitude':'115.180489','tags':['id','nulla','reprehenderit','consequat','reprehenderit'],'greeting':'Hello, Zelma! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed98d836c8da283bb2','index':77,'guid':'838bebad-cc20-44e9-9eb7-902a8ca25efb','isActive':false,'balance':'$3,488.91','picture':'http://placehold.it/32x32','age':20,'eyeColor':'green','name':{'first':'Shaw','last':'Parsons'},'company':'PEARLESEX','email':'shaw.parsons@pearlesex.name','phone':'+1 (912) 567-3580','address':'606 Ocean Avenue, Tyro, Northern Mariana Islands, 3367','about':'Laborum labore occaecat culpa pariatur nisi non adipisicing esse consectetur officia officia. Deserunt velit eu enim consectetur ut cillum aliqua occaecat dolor qui esse. Incididunt ad est ex eu culpa anim aliquip laborum. Aliqua consectetur velit exercitation magna minim nulla do ut excepteur enim aliquip et. Nostrud enim sunt amet amet proident aliqua velit dolore. Consectetur ipsum fugiat proident id est reprehenderit tempor irure commodo. Sit excepteur fugiat occaecat nulla Lorem et cillum.','registered':'Thursday, April 19, 2018 1:41 AM','latitude':'69.715573','longitude':'-118.481237','tags':['laboris','adipisicing','magna','voluptate','id'],'greeting':'Hello, Shaw! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed1101734633c6ebba','index':78,'guid':'8fd0c52a-9d74-4984-a608-d612ecd8ddf0','isActive':true,'balance':'$3,820.02','picture':'http://placehold.it/32x32','age':39,'eyeColor':'brown','name':{'first':'Jaime','last':'Beard'},'company':'IZZBY','email':'jaime.beard@izzby.us','phone':'+1 (820) 412-3806','address':'362 Hudson Avenue, Delco, New Jersey, 5684','about':'Ut cupidatat veniam nulla magna commodo sit duis veniam consectetur cupidatat elit quis tempor. Duis officia ullamco proident sunt non mollit excepteur. Nisi ex amet laboris proident duis reprehenderit et est aliqua mollit amet ad. Enim eu elit excepteur eu exercitation duis consequat culpa. Adipisicing reprehenderit duis Lorem reprehenderit dolor aliqua incididunt eiusmod consequat ad occaecat fugiat do laborum. Qui ad aliquip ex do sunt. Fugiat non ut fugiat eu.','registered':'Sunday, March 9, 2014 3:41 PM','latitude':'17.926318','longitude':'108.985996','tags':['ut','voluptate','veniam','non','commodo'],'greeting':'Hello, Jaime! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edcd125a89dcf18e0d','index':79,'guid':'eccaa4ca-0fa7-4b00-a1e3-fe7953403894','isActive':true,'balance':'$1,521.33','picture':'http://placehold.it/32x32','age':30,'eyeColor':'green','name':{'first':'Terra','last':'Sullivan'},'company':'ZANITY','email':'terra.sullivan@zanity.biz','phone':'+1 (995) 498-2714','address':'346 Congress Street, Tuttle, Maryland, 3152','about':'Incididunt enim veniam ut veniam quis dolore pariatur culpa ex. Cillum laboris dolor exercitation officia. Officia irure magna aliqua veniam officia ullamco culpa. Cillum enim velit ea sint sint officia labore ea adipisicing culpa laboris. Anim aute sint commodo culpa ex quis minim ut laborum.','registered':'Sunday, June 1, 2014 5:38 AM','latitude':'-4.655435','longitude':'5.851803','tags':['anim','non','anim','laborum','pariatur'],'greeting':'Hello, Terra! You have 5 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed9b9fc3041a674c87','index':80,'guid':'9f95fa36-4e45-4c3f-9362-3d4d809bf57f','isActive':true,'balance':'$3,403.16','picture':'http://placehold.it/32x32','age':39,'eyeColor':'brown','name':{'first':'Sharpe','last':'Berger'},'company':'ZILLAN','email':'sharpe.berger@zillan.ca','phone':'+1 (913) 498-3005','address':'277 Bragg Street, Faywood, Texas, 6487','about':'Dolor duis id aute ea veniam amet ullamco id. Culpa deserunt irure mollit tempor dolore veniam culpa officia culpa laborum eiusmod. Ullamco tempor qui aliqua cupidatat veniam cillum eu ut ex minim eu in. Quis exercitation anim eiusmod tempor esse mollit exercitation cillum ipsum reprehenderit. Sint voluptate ipsum officia sint magna nulla tempor eiusmod eiusmod veniam. Consectetur non ad veniam exercitation voluptate non nostrud.','registered':'Tuesday, June 27, 2017 12:58 AM','latitude':'-0.54085','longitude':'106.258693','tags':['proident','eiusmod','commodo','excepteur','pariatur'],'greeting':'Hello, Sharpe! You have 5 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed1a1866757bf675e0','index':81,'guid':'1b944a01-01d3-4846-94e3-630f4d0e51a3','isActive':true,'balance':'$2,038.61','picture':'http://placehold.it/32x32','age':28,'eyeColor':'brown','name':{'first':'Blanchard','last':'Ewing'},'company':'CONJURICA','email':'blanchard.ewing@conjurica.info','phone':'+1 (859) 593-3212','address':'252 Beaver Street, Kiskimere, Utah, 3255','about':'Labore magna aute adipisicing ut dolor sit ea. Officia culpa aute occaecat sit ex ullamco aliquip ad sit culpa. Ex in enim dolore ex est sit. Do irure nulla magna sint aliquip in duis aute. Magna ullamco sit labore ea tempor voluptate.','registered':'Monday, May 4, 2015 10:50 AM','latitude':'76.207595','longitude':'0.672563','tags':['proident','pariatur','officia','in','culpa'],'greeting':'Hello, Blanchard! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed987d82f4e22d939c','index':82,'guid':'97a90aee-3cee-4678-819e-24fb94279dc1','isActive':false,'balance':'$1,201.55','picture':'http://placehold.it/32x32','age':28,'eyeColor':'blue','name':{'first':'Wells','last':'Solomon'},'company':'CORPULSE','email':'wells.solomon@corpulse.tv','phone':'+1 (840) 539-3349','address':'159 Radde Place, Linganore, Idaho, 230','about':'Consequat dolore mollit sit irure cupidatat commodo. Incididunt cillum reprehenderit ullamco sit proident cupidatat occaecat reprehenderit officia. Ad anim Lorem elit in officia minim proident nisi commodo eiusmod ea Lorem dolore voluptate. Dolor aliquip est commodo Lorem dolor ut aliquip ut. Sit anim officia dolore excepteur aute enim cillum.','registered':'Friday, January 6, 2017 1:59 PM','latitude':'70.020883','longitude':'14.503588','tags':['mollit','aute','officia','nostrud','laboris'],'greeting':'Hello, Wells! You have 7 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eddf7a904ea0d0bc2a','index':83,'guid':'fe639a0c-7517-43e6-b0da-cd9ca5b9e267','isActive':false,'balance':'$3,664.47','picture':'http://placehold.it/32x32','age':33,'eyeColor':'blue','name':{'first':'Natalia','last':'Brown'},'company':'SYNTAC','email':'natalia.brown@syntac.co.uk','phone':'+1 (952) 595-3513','address':'332 Lenox Road, Springville, Alabama, 8406','about':'Nulla consequat officia commodo ea sunt irure anim velit aliquip aliquip. Labore ullamco occaecat proident voluptate cillum labore minim nostrud excepteur. Qui fugiat nostrud cillum fugiat ullamco id commodo aliqua voluptate mollit id id laboris. Cillum qui duis duis sit adipisicing elit ut aliqua eu. Anim nisi aliqua sit mollit.','registered':'Sunday, July 30, 2017 1:02 PM','latitude':'31.937613','longitude':'-9.957927','tags':['magna','adipisicing','exercitation','tempor','consectetur'],'greeting':'Hello, Natalia! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed8823fa385cad4aa3','index':84,'guid':'5cf280da-f5f0-4cc6-9063-e9d5863c8c89','isActive':false,'balance':'$1,624.17','picture':'http://placehold.it/32x32','age':25,'eyeColor':'blue','name':{'first':'Greene','last':'Waller'},'company':'ISOTRACK','email':'greene.waller@isotrack.io','phone':'+1 (838) 406-3608','address':'362 Albemarle Road, Gardiner, Michigan, 2764','about':'Ut nisi sit sint nulla dolor magna. Culpa occaecat adipisicing veniam proident excepteur tempor quis ex. Fugiat tempor laborum dolor adipisicing irure anim cupidatat ut exercitation ex sit. Cupidatat exercitation commodo sunt ex irure fugiat eu esse do ullamco mollit dolore cupidatat. Cupidatat magna incididunt officia dolore esse voluptate deserunt in laborum dolor. Sit fugiat Lorem eu ullamco. Laboris veniam quis cillum tempor ex fugiat cillum cupidatat.','registered':'Sunday, June 10, 2018 10:32 PM','latitude':'0.256921','longitude':'-96.141941','tags':['magna','dolore','deserunt','aliquip','cillum'],'greeting':'Hello, Greene! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0eda7c905c2d24c7d31','index':85,'guid':'aa30a9fb-8a16-48eb-8bb7-1307d1e1f191','isActive':false,'balance':'$1,974.04','picture':'http://placehold.it/32x32','age':36,'eyeColor':'green','name':{'first':'Carlene','last':'Hanson'},'company':'DIGIRANG','email':'carlene.hanson@digirang.me','phone':'+1 (981) 417-3209','address':'435 Clark Street, Choctaw, Oregon, 9888','about':'Amet labore esse cillum irure laborum consectetur occaecat non aliquip aliquip proident. Nisi magna nulla officia duis labore aute nulla laborum duis tempor minim. Velit elit reprehenderit nisi exercitation officia incididunt amet cupidatat excepteur proident consectetur.','registered':'Thursday, April 20, 2017 6:13 AM','latitude':'68.529086','longitude':'68.802409','tags':['pariatur','nulla','qui','amet','labore'],'greeting':'Hello, Carlene! You have 10 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed6fbee12ce9e55dbf','index':86,'guid':'0fce89aa-3310-48df-862a-68bd3d776644','isActive':false,'balance':'$3,909.64','picture':'http://placehold.it/32x32','age':40,'eyeColor':'brown','name':{'first':'Doris','last':'Collins'},'company':'ZIORE','email':'doris.collins@ziore.com','phone':'+1 (914) 405-2360','address':'301 Lorraine Street, Stouchsburg, Minnesota, 7476','about':'Nisi deserunt aliquip et deserunt ipsum ad consectetur est non ullamco. Dolore do ut voluptate do eiusmod. Culpa ad in eiusmod nisi cillum do. Officia magna cillum sint aliqua reprehenderit amet est ipsum. Eiusmod deserunt commodo proident consequat. Amet minim dolor consequat aliquip aliquip culpa non exercitation non.','registered':'Wednesday, February 25, 2015 9:15 PM','latitude':'-57.364906','longitude':'130.766587','tags':['nulla','deserunt','cillum','eiusmod','adipisicing'],'greeting':'Hello, Doris! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0edede9402476c398c0','index':87,'guid':'60cf0aa6-bc6d-4305-8842-d27e6af1306f','isActive':false,'balance':'$2,817.53','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Cline','last':'Hayden'},'company':'ECRAZE','email':'cline.hayden@ecraze.org','phone':'+1 (965) 507-2138','address':'352 Rutland Road, Ebro, Connecticut, 1196','about':'Dolor eiusmod enim anim sit enim ea tempor. Tempor amet consectetur aliquip culpa do ex excepteur deserunt. Dolor commodo veniam culpa sint. Commodo consectetur pariatur irure nisi deserunt cillum est dolor ipsum ea.','registered':'Thursday, September 29, 2016 5:58 AM','latitude':'62.50713','longitude':'86.247286','tags':['enim','tempor','anim','veniam','proident'],'greeting':'Hello, Cline! You have 9 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edeb72f151994a551b','index':88,'guid':'dbb49c62-86b1-409f-b8b8-f609c709d2a8','isActive':false,'balance':'$3,122.56','picture':'http://placehold.it/32x32','age':39,'eyeColor':'green','name':{'first':'Janelle','last':'Rutledge'},'company':'TERRAGEN','email':'janelle.rutledge@terragen.net','phone':'+1 (914) 581-3749','address':'170 Falmouth Street, Alderpoint, West Virginia, 642','about':'Laboris proident cillum sunt qui ea sunt. Officia adipisicing exercitation dolore magna reprehenderit amet anim id. Laboris commodo sit irure irure. Excepteur est mollit fugiat incididunt consectetur veniam irure ea mollit. Cillum enim consequat sunt sunt nisi incididunt tempor enim.','registered':'Monday, February 16, 2015 5:46 AM','latitude':'-46.392023','longitude':'32.054562','tags':['eu','eu','nisi','labore','deserunt'],'greeting':'Hello, Janelle! You have 9 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edc9c2604846ff9a0d','index':89,'guid':'c4d7a365-f1d3-4584-b78e-008394c219f7','isActive':true,'balance':'$1,807.19','picture':'http://placehold.it/32x32','age':24,'eyeColor':'green','name':{'first':'Abby','last':'Lopez'},'company':'GRAINSPOT','email':'abby.lopez@grainspot.name','phone':'+1 (917) 442-3955','address':'488 Kensington Walk, Winston, Hawaii, 9109','about':'Incididunt deserunt Lorem proident magna tempor enim quis duis eu ut adipisicing in. Ex mollit non irure aliqua officia. Fugiat id ipsum consequat irure id ullamco culpa quis nulla enim aliquip consequat et. Dolor ut anim velit irure consequat cillum eu. Aute occaecat laborum est aliqua.','registered':'Sunday, April 1, 2018 11:28 PM','latitude':'-10.177041','longitude':'-165.756718','tags':['est','laborum','culpa','non','quis'],'greeting':'Hello, Abby! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed03237438b158af9e','index':90,'guid':'36c4a19f-2d00-4e40-bd49-155fd2ce0a6c','isActive':false,'balance':'$2,757.86','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Whitney','last':'Sheppard'},'company':'ANACHO','email':'whitney.sheppard@anacho.us','phone':'+1 (922) 437-2383','address':'951 Beekman Place, Homeworth, New York, 6088','about':'Sint minim nisi minim non minim aliqua pariatur ullamco do sint qui labore. Aute elit reprehenderit ad do fugiat est amet. In incididunt tempor commodo cillum tempor est labore anim.','registered':'Tuesday, September 13, 2016 6:43 PM','latitude':'-49.732527','longitude':'-171.846715','tags':['exercitation','veniam','sunt','est','proident'],'greeting':'Hello, Whitney! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0edb99dd3aa53d2cb7f','index':91,'guid':'17afd430-f37f-4d55-958c-72f35cdb5997','isActive':false,'balance':'$3,683.86','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Ilene','last':'Blackwell'},'company':'ENQUILITY','email':'ilene.blackwell@enquility.biz','phone':'+1 (817) 555-2616','address':'950 Varanda Place, Belgreen, Virgin Islands, 1765','about':'Id eiusmod deserunt eiusmod adipisicing adipisicing est enim pariatur esse duis. Qui velit duis irure magna consectetur dolore reprehenderit. Cillum dolore minim consectetur irure non qui velit cillum veniam adipisicing incididunt. Deserunt veniam excepteur veniam velit aliquip labore quis exercitation magna do non dolor. Aliquip occaecat minim adipisicing deserunt fugiat nulla occaecat proident irure consectetur eiusmod irure. Enim Lorem deserunt amet Lorem commodo eiusmod reprehenderit occaecat adipisicing dolor voluptate cillum.','registered':'Thursday, February 1, 2018 8:39 AM','latitude':'57.393644','longitude':'-3.704258','tags':['adipisicing','dolor','commodo','Lorem','Lorem'],'greeting':'Hello, Ilene! You have 6 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed353f4deb62c3342a','index':92,'guid':'9953e285-2095-4f1c-978b-9ece2a867e9d','isActive':false,'balance':'$1,202.44','picture':'http://placehold.it/32x32','age':38,'eyeColor':'blue','name':{'first':'Dawson','last':'Herman'},'company':'BITENDREX','email':'dawson.herman@bitendrex.ca','phone':'+1 (843) 522-2655','address':'471 Channel Avenue, Denio, Alaska, 5040','about':'Nisi occaecat mollit reprehenderit nisi minim Lorem mollit. Ea proident irure cillum quis. Deserunt consectetur consectetur consequat quis enim minim ea ipsum proident nisi ad non aliquip. Veniam aute minim consequat irure voluptate aute amet excepteur exercitation cillum duis quis adipisicing nostrud.','registered':'Tuesday, December 8, 2015 5:40 PM','latitude':'-55.602721','longitude':'-26.683234','tags':['qui','dolor','deserunt','eiusmod','labore'],'greeting':'Hello, Dawson! You have 7 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0edd5464bc50a5310ad','index':93,'guid':'724b2434-4dbd-417d-aa07-6065715f434f','isActive':false,'balance':'$1,595.98','picture':'http://placehold.it/32x32','age':25,'eyeColor':'brown','name':{'first':'Alice','last':'Christian'},'company':'ZENOLUX','email':'alice.christian@zenolux.info','phone':'+1 (954) 466-2650','address':'875 Gerritsen Avenue, Townsend, Kentucky, 6568','about':'Nulla labore occaecat ex culpa magna. Commodo occaecat et in consequat cillum laborum magna adipisicing excepteur. Do ut Lorem esse voluptate officia ea aliquip proident amet veniam minim nulla adipisicing. Enim consectetur incididunt laborum voluptate tempor deserunt non laboris. Aliquip deserunt aute irure dolore magna anim aliquip sint magna Lorem. Officia laboris nulla officia sint labore nisi. Do Lorem id in est esse adipisicing id fugiat enim esse laborum.','registered':'Wednesday, October 3, 2018 9:26 PM','latitude':'-88.790637','longitude':'138.817328','tags':['duis','ea','magna','ea','incididunt'],'greeting':'Hello, Alice! You have 8 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0eda01886247b6a4f3d','index':94,'guid':'17c9f4d3-7d72-44e3-8f7c-08d7de920f46','isActive':false,'balance':'$3,173.29','picture':'http://placehold.it/32x32','age':31,'eyeColor':'blue','name':{'first':'Schwartz','last':'Mccormick'},'company':'EVIDENDS','email':'schwartz.mccormick@evidends.tv','phone':'+1 (924) 531-2802','address':'160 Midwood Street, Indio, Palau, 4241','about':'Anim reprehenderit et et adipisicing voluptate consequat elit. Sint Lorem laboris Lorem minim nostrud aute reprehenderit elit aute quis nulla. Officia aute eiusmod mollit cillum eu aliquip non enim ea occaecat quis fugiat occaecat officia. Eiusmod culpa exercitation dolor aliqua enim occaecat nisi cupidatat duis ex dolore id. Id consequat aliqua cupidatat ut. Sit nisi est sunt culpa ullamco excepteur sunt pariatur incididunt amet. Ut tempor duis velit eu ut id culpa aute anim occaecat labore.','registered':'Thursday, March 2, 2017 5:57 PM','latitude':'38.618587','longitude':'-165.142529','tags':['ad','reprehenderit','magna','elit','mollit'],'greeting':'Hello, Schwartz! You have 10 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed51be4df456ec2bc9','index':95,'guid':'44f68f65-959b-4ec2-bd2a-1f30035f76fc','isActive':false,'balance':'$3,242.24','picture':'http://placehold.it/32x32','age':39,'eyeColor':'blue','name':{'first':'Bonita','last':'Stevens'},'company':'SLOFAST','email':'bonita.stevens@slofast.co.uk','phone':'+1 (886) 473-2105','address':'459 Bushwick Court, Kilbourne, Rhode Island, 9450','about':'Consequat reprehenderit qui reprehenderit nisi sit est in qui aliquip amet. Ex deserunt cupidatat amet cillum eiusmod irure anim in amet proident voluptate. Ad officia culpa in non incididunt do.','registered':'Saturday, August 22, 2015 5:23 AM','latitude':'60.013542','longitude':'58.242132','tags':['aute','adipisicing','in','cillum','officia'],'greeting':'Hello, Bonita! You have 5 unread messages.','favoriteFruit':'banana'},{'_id':'5c5ab0ed50a55e3587993f68','index':96,'guid':'652e434f-221e-4899-af12-38dca5c9621d','isActive':false,'balance':'$2,720.06','picture':'http://placehold.it/32x32','age':28,'eyeColor':'green','name':{'first':'Charmaine','last':'Jackson'},'company':'FLUM','email':'charmaine.jackson@flum.io','phone':'+1 (947) 573-2692','address':'788 Windsor Place, Highland, Arkansas, 8869','about':'Dolore reprehenderit irure excepteur eu reprehenderit sint Lorem ut amet in. Consequat anim elit sunt aliquip incididunt. Culpa consequat do exercitation dolor enim dolor sunt sit excepteur ad anim. Dolor aute elit velit mollit minim eu.','registered':'Wednesday, April 6, 2016 7:54 PM','latitude':'25.756553','longitude':'-5.482531','tags':['amet','sint','consequat','est','ex'],'greeting':'Hello, Charmaine! You have 10 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed213621949bbdd5d3','index':97,'guid':'7d7d93d8-3e37-4b4a-9fa2-591fb7d153ce','isActive':true,'balance':'$1,370.63','picture':'http://placehold.it/32x32','age':36,'eyeColor':'brown','name':{'first':'Petersen','last':'Cooley'},'company':'ROTODYNE','email':'petersen.cooley@rotodyne.me','phone':'+1 (929) 563-3339','address':'338 Pioneer Street, Carbonville, Missouri, 3030','about':'Cillum elit dolore labore aute. Cillum ea incididunt cupidatat consequat sint eu mollit. Excepteur commodo eiusmod ex Lorem enim velit minim.','registered':'Friday, December 8, 2017 5:53 AM','latitude':'-10.576254','longitude':'-111.176861','tags':['veniam','eu','eiusmod','dolore','voluptate'],'greeting':'Hello, Petersen! You have 9 unread messages.','favoriteFruit':'apple'},{'_id':'5c5ab0ed3e938138d58ed453','index':98,'guid':'d6fea4a3-03f6-46ee-90b9-8ec51a585e29','isActive':true,'balance':'$1,216.54','picture':'http://placehold.it/32x32','age':39,'eyeColor':'blue','name':{'first':'Rosanne','last':'Terry'},'company':'EXTREMO','email':'rosanne.terry@extremo.com','phone':'+1 (812) 496-2691','address':'368 Rockaway Avenue, Gloucester, Illinois, 7913','about':'Duis et nostrud duis quis minim eiusmod culpa do ea ad pariatur tempor. Velit veniam aliqua aliquip est enim ex et culpa dolor ullamco culpa officia. Eu id occaecat aute cillum aute sit aute laboris ipsum voluptate ex. Amet tempor minim tempor Lorem quis dolore. Pariatur consequat dolore nulla veniam dolor exercitation consequat nulla laboris incididunt do. Dolore do tempor deserunt exercitation incididunt officia incididunt ut do reprehenderit do eiusmod nulla.','registered':'Sunday, August 6, 2017 12:46 PM','latitude':'-43.257964','longitude':'-45.147686','tags':['et','incididunt','esse','commodo','ipsum'],'greeting':'Hello, Rosanne! You have 6 unread messages.','favoriteFruit':'strawberry'},{'_id':'5c5ab0ed632b1a1d65501d6b','index':99,'guid':'bf8c6ac1-ee18-48ee-ae94-ea515a53c951','isActive':true,'balance':'$2,905.58','picture':'http://placehold.it/32x32','age':21,'eyeColor':'blue','name':{'first':'Irene','last':'Castro'},'company':'POLARIA','email':'irene.castro@polaria.org','phone':'+1 (818) 417-3761','address':'901 Dupont Street, Sperryville, Oklahoma, 953','about':'Pariatur minim laboris aliqua dolor aliquip consequat ea do duis voluptate id Lorem. In reprehenderit et adipisicing anim elit incididunt velit in laborum laborum. Qui minim magna et amet sit do voluptate reprehenderit ea sit sint velit.','registered':'Tuesday, August 18, 2015 10:48 AM','latitude':'-7.004055','longitude':'116.052433','tags':['sit','proident','enim','ullamco','non'],'greeting':'Hello, Irene! You have 10 unread messages.','favoriteFruit':'apple'}]" + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-no-changes/plan.log b/internal/cloud/testdata/plan-no-changes/plan.log new file mode 100644 index 000000000000..70416815133f --- /dev/null +++ b/internal/cloud/testdata/plan-no-changes/plan.log @@ -0,0 +1,17 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +null_resource.hello: Refreshing state... (ID: 8657651096157629581) + +------------------------------------------------------------------------ + +No changes. Infrastructure is up-to-date. + +This means that Terraform did not detect any differences between your +configuration and real physical resources that exist. As a result, no +actions need to be performed. diff --git a/internal/cloud/testdata/plan-no-changes/policy.log b/internal/cloud/testdata/plan-no-changes/policy.log new file mode 100644 index 000000000000..b0cb1e598592 --- /dev/null +++ b/internal/cloud/testdata/plan-no-changes/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: true + +This result means that Sentinel policies returned true and the protected +behavior is allowed by Sentinel policies. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: true + +TRUE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/plan-policy-hard-failed/plan.log b/internal/cloud/testdata/plan-policy-hard-failed/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/plan-policy-hard-failed/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-policy-hard-failed/policy.log b/internal/cloud/testdata/plan-policy-hard-failed/policy.log new file mode 100644 index 000000000000..5d6e6935b937 --- /dev/null +++ b/internal/cloud/testdata/plan-policy-hard-failed/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: false + +Sentinel evaluated to false because one or more Sentinel policies evaluated +to false. This false was not due to an undefined value or runtime error. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (hard-mandatory) + +Result: false + +FALSE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/plan-policy-passed/plan.log b/internal/cloud/testdata/plan-policy-passed/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/plan-policy-passed/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-policy-passed/policy.log b/internal/cloud/testdata/plan-policy-passed/policy.log new file mode 100644 index 000000000000..b0cb1e598592 --- /dev/null +++ b/internal/cloud/testdata/plan-policy-passed/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: true + +This result means that Sentinel policies returned true and the protected +behavior is allowed by Sentinel policies. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: true + +TRUE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/plan-policy-soft-failed/plan.log b/internal/cloud/testdata/plan-policy-soft-failed/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/plan-policy-soft-failed/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-policy-soft-failed/policy.log b/internal/cloud/testdata/plan-policy-soft-failed/policy.log new file mode 100644 index 000000000000..3e4ebedf6179 --- /dev/null +++ b/internal/cloud/testdata/plan-policy-soft-failed/policy.log @@ -0,0 +1,12 @@ +Sentinel Result: false + +Sentinel evaluated to false because one or more Sentinel policies evaluated +to false. This false was not due to an undefined value or runtime error. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: false + +FALSE - Passthrough.sentinel:1:1 - Rule "main" diff --git a/internal/cloud/testdata/plan-variables/plan.log b/internal/cloud/testdata/plan-variables/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/plan-variables/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan-with-error/plan.log b/internal/cloud/testdata/plan-with-error/plan.log new file mode 100644 index 000000000000..4344a3722905 --- /dev/null +++ b/internal/cloud/testdata/plan-with-error/plan.log @@ -0,0 +1,10 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... + +Error: null_resource.foo: 1 error(s) occurred: + +* null_resource.foo: 1:3: unknown function called: guid in: + +${guid()} diff --git a/internal/cloud/testdata/plan-with-working-directory/terraform/plan.log b/internal/cloud/testdata/plan-with-working-directory/terraform/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/plan-with-working-directory/terraform/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. diff --git a/internal/cloud/testdata/plan/plan.log b/internal/cloud/testdata/plan/plan.log new file mode 100644 index 000000000000..5849e57595ef --- /dev/null +++ b/internal/cloud/testdata/plan/plan.log @@ -0,0 +1,21 @@ +Terraform v0.11.7 + +Configuring remote state backend... +Initializing Terraform configuration... +Refreshing Terraform state in-memory prior to plan... +The refreshed state will be used to calculate this plan, but will not be +persisted to local or remote state storage. + +------------------------------------------------------------------------ + +An execution plan has been generated and is shown below. +Resource actions are indicated with the following symbols: + + create + +Terraform will perform the following actions: + + + null_resource.foo + id: + + +Plan: 1 to add, 0 to change, 0 to destroy. From 34597c237f6dec569a51a40bec6b412864ef942e Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 31 Aug 2021 11:47:26 -0500 Subject: [PATCH 205/644] cloud: Don't ignore .log golden files --- internal/cloud/testdata/.gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 internal/cloud/testdata/.gitignore diff --git a/internal/cloud/testdata/.gitignore b/internal/cloud/testdata/.gitignore new file mode 100644 index 000000000000..15498bbfb826 --- /dev/null +++ b/internal/cloud/testdata/.gitignore @@ -0,0 +1 @@ +!*.log From 471dd479e8296878378750991c865e2503aa490c Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 7 Sep 2021 15:35:32 -0500 Subject: [PATCH 206/644] Update go-tfe to 26689e These changes include additions to fulfill the interface for the client mock, plus moving all that logic (which needn't be duplicated across both the remote and cloud packages) over to the cloud package under a dedicated mock client file. --- go.mod | 6 +- go.sum | 15 +- internal/backend/remote/backend_apply_test.go | 25 +- internal/backend/remote/backend_mock.go | 1364 ----------------- internal/backend/remote/backend_plan_test.go | 29 +- internal/backend/remote/backend_state_test.go | 3 +- internal/backend/remote/testing.go | 24 +- internal/cloud/backend_apply_test.go | 24 +- internal/cloud/backend_plan_test.go | 28 +- internal/cloud/backend_state_test.go | 2 +- internal/cloud/testing.go | 23 +- .../{backend_mock.go => tfe_client_mock.go} | 363 ++--- 12 files changed, 302 insertions(+), 1604 deletions(-) delete mode 100644 internal/backend/remote/backend_mock.go rename internal/cloud/{backend_mock.go => tfe_client_mock.go} (75%) diff --git a/go.mod b/go.mod index 646309e2a559..9074b31d85c0 100644 --- a/go.mod +++ b/go.mod @@ -40,7 +40,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.5.2 - github.com/hashicorp/go-tfe v0.15.0 + github.com/hashicorp/go-tfe v0.18.1-0.20210902165242-26689edbfddf github.com/hashicorp/go-uuid v1.0.1 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f @@ -143,9 +143,9 @@ require ( github.com/hashicorp/go-msgpack v0.5.4 // indirect github.com/hashicorp/go-rootcerts v1.0.2 // indirect github.com/hashicorp/go-safetemp v1.0.0 // indirect - github.com/hashicorp/go-slug v0.4.1 // indirect + github.com/hashicorp/go-slug v0.7.0 // indirect github.com/hashicorp/golang-lru v0.5.1 // indirect - github.com/hashicorp/jsonapi v0.0.0-20210518035559-1e50d74c8db3 // indirect + github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d // indirect github.com/hashicorp/serf v0.9.5 // indirect github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect github.com/huandu/xstrings v1.3.2 // indirect diff --git a/go.sum b/go.sum index bd8b487fba33..4a206459700d 100644 --- a/go.sum +++ b/go.sum @@ -370,13 +370,13 @@ github.com/hashicorp/go-rootcerts v1.0.2 h1:jzhAVGtqPKbwpyCPELlgNWhE1znq+qwJtW5O github.com/hashicorp/go-rootcerts v1.0.2/go.mod h1:pqUvnprVnM5bf7AOirdbb01K4ccR319Vf4pU3K5EGc8= github.com/hashicorp/go-safetemp v1.0.0 h1:2HR189eFNrjHQyENnQMMpCiBAsRxzbTMIgBhEyExpmo= github.com/hashicorp/go-safetemp v1.0.0/go.mod h1:oaerMy3BhqiTbVye6QuFhFtIceqFoDHxNAB65b+Rj1I= -github.com/hashicorp/go-slug v0.4.1 h1:/jAo8dNuLgSImoLXaX7Od7QB4TfYCVPam+OpAt5bZqc= -github.com/hashicorp/go-slug v0.4.1/go.mod h1:I5tq5Lv0E2xcNXNkmx7BSfzi1PsJ2cNjs3cC3LwyhK8= +github.com/hashicorp/go-slug v0.7.0 h1:8HIi6oreWPtnhpYd8lIGQBgp4rXzDWQTOhfILZm+nok= +github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41RKLH301v4= github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.15.0 h1:vdnz1NjOhvmap+cj8iPsL8SbS4iFFVuNYFkGpF5SdoA= -github.com/hashicorp/go-tfe v0.15.0/go.mod h1:c8glB5p6XzocEWLNkuy5RxcjqN5X2PpY6NF3f2W6nIo= +github.com/hashicorp/go-tfe v0.18.1-0.20210902165242-26689edbfddf h1:Tn5cI9kacNyO40ztxmwfAaHrOGd7dELLSAueV2Xfv38= +github.com/hashicorp/go-tfe v0.18.1-0.20210902165242-26689edbfddf/go.mod h1:7lChm1Mjsh0ofrUNkP8MHljUFrnKNZNTw36S6qSbJZU= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1 h1:fv1ep09latC32wFoVwnqcnKJGnMSdBanPczbHAYm1BE= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= @@ -393,8 +393,8 @@ github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f/go.mod h1:oZtUIOe8dh github.com/hashicorp/hcl/v2 v2.0.0/go.mod h1:oVVDG71tEinNGYCxinCYadcmKU9bglqW9pV3txagJ90= github.com/hashicorp/hcl/v2 v2.10.1 h1:h4Xx4fsrRE26ohAk/1iGF/JBqRQbyUqu5Lvj60U54ys= github.com/hashicorp/hcl/v2 v2.10.1/go.mod h1:FwWsfWEjyV/CMj8s/gqAuiviY72rJ1/oayI9WftqcKg= -github.com/hashicorp/jsonapi v0.0.0-20210518035559-1e50d74c8db3 h1:mzwkutymYIXR5oQT9YnfbLuuw7LZmksiHKRPUTN5ijo= -github.com/hashicorp/jsonapi v0.0.0-20210518035559-1e50d74c8db3/go.mod h1:Yog5+CPEM3c99L1CL2CFCYoSzgWm5vTU58idbRUaLik= +github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d h1:9ARUJJ1VVynB176G1HCwleORqCaXm/Vx0uUi0dL26I0= +github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d/go.mod h1:Yog5+CPEM3c99L1CL2CFCYoSzgWm5vTU58idbRUaLik= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= github.com/hashicorp/mdns v1.0.1/go.mod h1:4gW7WsVCke5TE7EPeYliwHlRUyBtfCwuFwuMg2DmyNY= github.com/hashicorp/memberlist v0.2.2 h1:5+RffWKwqJ71YPu9mWsF7ZOscZmwfasdA8kbdC7AO2g= @@ -610,8 +610,9 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= -github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.194/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y= github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.232 h1:kwsWbh4rEw42ZDe9/812ebhbwNZxlQyZ2sTmxBOKhN4= github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.232/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y= diff --git a/internal/backend/remote/backend_apply_test.go b/internal/backend/remote/backend_apply_test.go index e15fe0bb37cf..9b42860104e6 100644 --- a/internal/backend/remote/backend_apply_test.go +++ b/internal/backend/remote/backend_apply_test.go @@ -14,6 +14,7 @@ import ( version "github.com/hashicorp/go-version" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" @@ -308,11 +309,11 @@ func TestRemote_applyWithoutRefresh(t *testing.T) { // We should find a run inside the mock client that has refresh set // to false. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(false, run.Refresh); diff != "" { t.Errorf("wrong Refresh setting in the created run\n%s", diff) } @@ -377,11 +378,11 @@ func TestRemote_applyWithRefreshOnly(t *testing.T) { // We should find a run inside the mock client that has refresh-only set // to true. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(true, run.RefreshOnly); diff != "" { t.Errorf("wrong RefreshOnly setting in the created run\n%s", diff) } @@ -448,11 +449,11 @@ func TestRemote_applyWithTarget(t *testing.T) { // We should find a run inside the mock client that has the same // target address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.TargetAddrs); diff != "" { t.Errorf("wrong TargetAddrs in the created run\n%s", diff) } @@ -523,11 +524,11 @@ func TestRemote_applyWithReplace(t *testing.T) { // We should find a run inside the mock client that has the same // refresh address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.ReplaceAddrs); diff != "" { t.Errorf("wrong ReplaceAddrs in the created run\n%s", diff) } diff --git a/internal/backend/remote/backend_mock.go b/internal/backend/remote/backend_mock.go deleted file mode 100644 index abf150f7cb1e..000000000000 --- a/internal/backend/remote/backend_mock.go +++ /dev/null @@ -1,1364 +0,0 @@ -package remote - -import ( - "bytes" - "context" - "encoding/base64" - "errors" - "fmt" - "io" - "io/ioutil" - "math/rand" - "os" - "path/filepath" - "strings" - "sync" - "time" - - tfe "github.com/hashicorp/go-tfe" - "github.com/hashicorp/terraform/internal/terraform" - tfversion "github.com/hashicorp/terraform/version" - "github.com/mitchellh/copystructure" -) - -type mockClient struct { - Applies *mockApplies - ConfigurationVersions *mockConfigurationVersions - CostEstimates *mockCostEstimates - Organizations *mockOrganizations - Plans *mockPlans - PolicyChecks *mockPolicyChecks - Runs *mockRuns - StateVersions *mockStateVersions - Variables *mockVariables - Workspaces *mockWorkspaces -} - -func newMockClient() *mockClient { - c := &mockClient{} - c.Applies = newMockApplies(c) - c.ConfigurationVersions = newMockConfigurationVersions(c) - c.CostEstimates = newMockCostEstimates(c) - c.Organizations = newMockOrganizations(c) - c.Plans = newMockPlans(c) - c.PolicyChecks = newMockPolicyChecks(c) - c.Runs = newMockRuns(c) - c.StateVersions = newMockStateVersions(c) - c.Variables = newMockVariables(c) - c.Workspaces = newMockWorkspaces(c) - return c -} - -type mockApplies struct { - client *mockClient - applies map[string]*tfe.Apply - logs map[string]string -} - -func newMockApplies(client *mockClient) *mockApplies { - return &mockApplies{ - client: client, - applies: make(map[string]*tfe.Apply), - logs: make(map[string]string), - } -} - -// create is a helper function to create a mock apply that uses the configured -// working directory to find the logfile. -func (m *mockApplies) create(cvID, workspaceID string) (*tfe.Apply, error) { - c, ok := m.client.ConfigurationVersions.configVersions[cvID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - if c.Speculative { - // Speculative means its plan-only so we don't create a Apply. - return nil, nil - } - - id := generateID("apply-") - url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) - - a := &tfe.Apply{ - ID: id, - LogReadURL: url, - Status: tfe.ApplyPending, - } - - w, ok := m.client.Workspaces.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if w.AutoApply { - a.Status = tfe.ApplyRunning - } - - m.logs[url] = filepath.Join( - m.client.ConfigurationVersions.uploadPaths[cvID], - w.WorkingDirectory, - "apply.log", - ) - m.applies[a.ID] = a - - return a, nil -} - -func (m *mockApplies) Read(ctx context.Context, applyID string) (*tfe.Apply, error) { - a, ok := m.applies[applyID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - // Together with the mockLogReader this allows testing queued runs. - if a.Status == tfe.ApplyRunning { - a.Status = tfe.ApplyFinished - } - return a, nil -} - -func (m *mockApplies) Logs(ctx context.Context, applyID string) (io.Reader, error) { - a, err := m.Read(ctx, applyID) - if err != nil { - return nil, err - } - - logfile, ok := m.logs[a.LogReadURL] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return bytes.NewBufferString("logfile does not exist"), nil - } - - logs, err := ioutil.ReadFile(logfile) - if err != nil { - return nil, err - } - - done := func() (bool, error) { - a, err := m.Read(ctx, applyID) - if err != nil { - return false, err - } - if a.Status != tfe.ApplyFinished { - return false, nil - } - return true, nil - } - - return &mockLogReader{ - done: done, - logs: bytes.NewBuffer(logs), - }, nil -} - -type mockConfigurationVersions struct { - client *mockClient - configVersions map[string]*tfe.ConfigurationVersion - uploadPaths map[string]string - uploadURLs map[string]*tfe.ConfigurationVersion -} - -func newMockConfigurationVersions(client *mockClient) *mockConfigurationVersions { - return &mockConfigurationVersions{ - client: client, - configVersions: make(map[string]*tfe.ConfigurationVersion), - uploadPaths: make(map[string]string), - uploadURLs: make(map[string]*tfe.ConfigurationVersion), - } -} - -func (m *mockConfigurationVersions) List(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionListOptions) (*tfe.ConfigurationVersionList, error) { - cvl := &tfe.ConfigurationVersionList{} - for _, cv := range m.configVersions { - cvl.Items = append(cvl.Items, cv) - } - - cvl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 1, - PreviousPage: 1, - TotalPages: 1, - TotalCount: len(cvl.Items), - } - - return cvl, nil -} - -func (m *mockConfigurationVersions) Create(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionCreateOptions) (*tfe.ConfigurationVersion, error) { - id := generateID("cv-") - url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) - - cv := &tfe.ConfigurationVersion{ - ID: id, - Status: tfe.ConfigurationPending, - UploadURL: url, - } - - m.configVersions[cv.ID] = cv - m.uploadURLs[url] = cv - - return cv, nil -} - -func (m *mockConfigurationVersions) Read(ctx context.Context, cvID string) (*tfe.ConfigurationVersion, error) { - cv, ok := m.configVersions[cvID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return cv, nil -} - -func (m *mockConfigurationVersions) Upload(ctx context.Context, url, path string) error { - cv, ok := m.uploadURLs[url] - if !ok { - return errors.New("404 not found") - } - m.uploadPaths[cv.ID] = path - cv.Status = tfe.ConfigurationUploaded - return nil -} - -type mockCostEstimates struct { - client *mockClient - estimations map[string]*tfe.CostEstimate - logs map[string]string -} - -func newMockCostEstimates(client *mockClient) *mockCostEstimates { - return &mockCostEstimates{ - client: client, - estimations: make(map[string]*tfe.CostEstimate), - logs: make(map[string]string), - } -} - -// create is a helper function to create a mock cost estimation that uses the -// configured working directory to find the logfile. -func (m *mockCostEstimates) create(cvID, workspaceID string) (*tfe.CostEstimate, error) { - id := generateID("ce-") - - ce := &tfe.CostEstimate{ - ID: id, - MatchedResourcesCount: 1, - ResourcesCount: 1, - DeltaMonthlyCost: "0.00", - ProposedMonthlyCost: "0.00", - Status: tfe.CostEstimateFinished, - } - - w, ok := m.client.Workspaces.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - logfile := filepath.Join( - m.client.ConfigurationVersions.uploadPaths[cvID], - w.WorkingDirectory, - "cost-estimate.log", - ) - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return nil, nil - } - - m.logs[ce.ID] = logfile - m.estimations[ce.ID] = ce - - return ce, nil -} - -func (m *mockCostEstimates) Read(ctx context.Context, costEstimateID string) (*tfe.CostEstimate, error) { - ce, ok := m.estimations[costEstimateID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return ce, nil -} - -func (m *mockCostEstimates) Logs(ctx context.Context, costEstimateID string) (io.Reader, error) { - ce, ok := m.estimations[costEstimateID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - logfile, ok := m.logs[ce.ID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return bytes.NewBufferString("logfile does not exist"), nil - } - - logs, err := ioutil.ReadFile(logfile) - if err != nil { - return nil, err - } - - ce.Status = tfe.CostEstimateFinished - - return bytes.NewBuffer(logs), nil -} - -// mockInput is a mock implementation of terraform.UIInput. -type mockInput struct { - answers map[string]string -} - -func (m *mockInput) Input(ctx context.Context, opts *terraform.InputOpts) (string, error) { - v, ok := m.answers[opts.Id] - if !ok { - return "", fmt.Errorf("unexpected input request in test: %s", opts.Id) - } - if v == "wait-for-external-update" { - select { - case <-ctx.Done(): - case <-time.After(time.Minute): - } - } - delete(m.answers, opts.Id) - return v, nil -} - -type mockOrganizations struct { - client *mockClient - organizations map[string]*tfe.Organization -} - -func newMockOrganizations(client *mockClient) *mockOrganizations { - return &mockOrganizations{ - client: client, - organizations: make(map[string]*tfe.Organization), - } -} - -func (m *mockOrganizations) List(ctx context.Context, options tfe.OrganizationListOptions) (*tfe.OrganizationList, error) { - orgl := &tfe.OrganizationList{} - for _, org := range m.organizations { - orgl.Items = append(orgl.Items, org) - } - - orgl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 1, - PreviousPage: 1, - TotalPages: 1, - TotalCount: len(orgl.Items), - } - - return orgl, nil -} - -// mockLogReader is a mock logreader that enables testing queued runs. -type mockLogReader struct { - done func() (bool, error) - logs *bytes.Buffer -} - -func (m *mockLogReader) Read(l []byte) (int, error) { - for { - if written, err := m.read(l); err != io.ErrNoProgress { - return written, err - } - time.Sleep(1 * time.Millisecond) - } -} - -func (m *mockLogReader) read(l []byte) (int, error) { - done, err := m.done() - if err != nil { - return 0, err - } - if !done { - return 0, io.ErrNoProgress - } - return m.logs.Read(l) -} - -func (m *mockOrganizations) Create(ctx context.Context, options tfe.OrganizationCreateOptions) (*tfe.Organization, error) { - org := &tfe.Organization{Name: *options.Name} - m.organizations[org.Name] = org - return org, nil -} - -func (m *mockOrganizations) Read(ctx context.Context, name string) (*tfe.Organization, error) { - org, ok := m.organizations[name] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return org, nil -} - -func (m *mockOrganizations) Update(ctx context.Context, name string, options tfe.OrganizationUpdateOptions) (*tfe.Organization, error) { - org, ok := m.organizations[name] - if !ok { - return nil, tfe.ErrResourceNotFound - } - org.Name = *options.Name - return org, nil - -} - -func (m *mockOrganizations) Delete(ctx context.Context, name string) error { - delete(m.organizations, name) - return nil -} - -func (m *mockOrganizations) Capacity(ctx context.Context, name string) (*tfe.Capacity, error) { - var pending, running int - for _, r := range m.client.Runs.runs { - if r.Status == tfe.RunPending { - pending++ - continue - } - running++ - } - return &tfe.Capacity{Pending: pending, Running: running}, nil -} - -func (m *mockOrganizations) Entitlements(ctx context.Context, name string) (*tfe.Entitlements, error) { - return &tfe.Entitlements{ - Operations: true, - PrivateModuleRegistry: true, - Sentinel: true, - StateStorage: true, - Teams: true, - VCSIntegrations: true, - }, nil -} - -func (m *mockOrganizations) RunQueue(ctx context.Context, name string, options tfe.RunQueueOptions) (*tfe.RunQueue, error) { - rq := &tfe.RunQueue{} - - for _, r := range m.client.Runs.runs { - rq.Items = append(rq.Items, r) - } - - rq.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 1, - PreviousPage: 1, - TotalPages: 1, - TotalCount: len(rq.Items), - } - - return rq, nil -} - -type mockPlans struct { - client *mockClient - logs map[string]string - planOutputs map[string]string - plans map[string]*tfe.Plan -} - -func newMockPlans(client *mockClient) *mockPlans { - return &mockPlans{ - client: client, - logs: make(map[string]string), - planOutputs: make(map[string]string), - plans: make(map[string]*tfe.Plan), - } -} - -// create is a helper function to create a mock plan that uses the configured -// working directory to find the logfile. -func (m *mockPlans) create(cvID, workspaceID string) (*tfe.Plan, error) { - id := generateID("plan-") - url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) - - p := &tfe.Plan{ - ID: id, - LogReadURL: url, - Status: tfe.PlanPending, - } - - w, ok := m.client.Workspaces.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - m.logs[url] = filepath.Join( - m.client.ConfigurationVersions.uploadPaths[cvID], - w.WorkingDirectory, - "plan.log", - ) - m.plans[p.ID] = p - - return p, nil -} - -func (m *mockPlans) Read(ctx context.Context, planID string) (*tfe.Plan, error) { - p, ok := m.plans[planID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - // Together with the mockLogReader this allows testing queued runs. - if p.Status == tfe.PlanRunning { - p.Status = tfe.PlanFinished - } - return p, nil -} - -func (m *mockPlans) Logs(ctx context.Context, planID string) (io.Reader, error) { - p, err := m.Read(ctx, planID) - if err != nil { - return nil, err - } - - logfile, ok := m.logs[p.LogReadURL] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return bytes.NewBufferString("logfile does not exist"), nil - } - - logs, err := ioutil.ReadFile(logfile) - if err != nil { - return nil, err - } - - done := func() (bool, error) { - p, err := m.Read(ctx, planID) - if err != nil { - return false, err - } - if p.Status != tfe.PlanFinished { - return false, nil - } - return true, nil - } - - return &mockLogReader{ - done: done, - logs: bytes.NewBuffer(logs), - }, nil -} - -func (m *mockPlans) JSONOutput(ctx context.Context, planID string) ([]byte, error) { - planOutput, ok := m.planOutputs[planID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - return []byte(planOutput), nil -} - -type mockPolicyChecks struct { - client *mockClient - checks map[string]*tfe.PolicyCheck - logs map[string]string -} - -func newMockPolicyChecks(client *mockClient) *mockPolicyChecks { - return &mockPolicyChecks{ - client: client, - checks: make(map[string]*tfe.PolicyCheck), - logs: make(map[string]string), - } -} - -// create is a helper function to create a mock policy check that uses the -// configured working directory to find the logfile. -func (m *mockPolicyChecks) create(cvID, workspaceID string) (*tfe.PolicyCheck, error) { - id := generateID("pc-") - - pc := &tfe.PolicyCheck{ - ID: id, - Actions: &tfe.PolicyActions{}, - Permissions: &tfe.PolicyPermissions{}, - Scope: tfe.PolicyScopeOrganization, - Status: tfe.PolicyPending, - } - - w, ok := m.client.Workspaces.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - logfile := filepath.Join( - m.client.ConfigurationVersions.uploadPaths[cvID], - w.WorkingDirectory, - "policy.log", - ) - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return nil, nil - } - - m.logs[pc.ID] = logfile - m.checks[pc.ID] = pc - - return pc, nil -} - -func (m *mockPolicyChecks) List(ctx context.Context, runID string, options tfe.PolicyCheckListOptions) (*tfe.PolicyCheckList, error) { - _, ok := m.client.Runs.runs[runID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - pcl := &tfe.PolicyCheckList{} - for _, pc := range m.checks { - pcl.Items = append(pcl.Items, pc) - } - - pcl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 1, - PreviousPage: 1, - TotalPages: 1, - TotalCount: len(pcl.Items), - } - - return pcl, nil -} - -func (m *mockPolicyChecks) Read(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { - pc, ok := m.checks[policyCheckID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - logfile, ok := m.logs[pc.ID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return nil, fmt.Errorf("logfile does not exist") - } - - logs, err := ioutil.ReadFile(logfile) - if err != nil { - return nil, err - } - - switch { - case bytes.Contains(logs, []byte("Sentinel Result: true")): - pc.Status = tfe.PolicyPasses - case bytes.Contains(logs, []byte("Sentinel Result: false")): - switch { - case bytes.Contains(logs, []byte("hard-mandatory")): - pc.Status = tfe.PolicyHardFailed - case bytes.Contains(logs, []byte("soft-mandatory")): - pc.Actions.IsOverridable = true - pc.Permissions.CanOverride = true - pc.Status = tfe.PolicySoftFailed - } - default: - // As this is an unexpected state, we say the policy errored. - pc.Status = tfe.PolicyErrored - } - - return pc, nil -} - -func (m *mockPolicyChecks) Override(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { - pc, ok := m.checks[policyCheckID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - pc.Status = tfe.PolicyOverridden - return pc, nil -} - -func (m *mockPolicyChecks) Logs(ctx context.Context, policyCheckID string) (io.Reader, error) { - pc, ok := m.checks[policyCheckID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - logfile, ok := m.logs[pc.ID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if _, err := os.Stat(logfile); os.IsNotExist(err) { - return bytes.NewBufferString("logfile does not exist"), nil - } - - logs, err := ioutil.ReadFile(logfile) - if err != nil { - return nil, err - } - - switch { - case bytes.Contains(logs, []byte("Sentinel Result: true")): - pc.Status = tfe.PolicyPasses - case bytes.Contains(logs, []byte("Sentinel Result: false")): - switch { - case bytes.Contains(logs, []byte("hard-mandatory")): - pc.Status = tfe.PolicyHardFailed - case bytes.Contains(logs, []byte("soft-mandatory")): - pc.Actions.IsOverridable = true - pc.Permissions.CanOverride = true - pc.Status = tfe.PolicySoftFailed - } - default: - // As this is an unexpected state, we say the policy errored. - pc.Status = tfe.PolicyErrored - } - - return bytes.NewBuffer(logs), nil -} - -type mockRuns struct { - sync.Mutex - - client *mockClient - runs map[string]*tfe.Run - workspaces map[string][]*tfe.Run - - // If modifyNewRun is non-nil, the create method will call it just before - // saving a new run in the runs map, so that a calling test can mimic - // side-effects that a real server might apply in certain situations. - modifyNewRun func(client *mockClient, options tfe.RunCreateOptions, run *tfe.Run) -} - -func newMockRuns(client *mockClient) *mockRuns { - return &mockRuns{ - client: client, - runs: make(map[string]*tfe.Run), - workspaces: make(map[string][]*tfe.Run), - } -} - -func (m *mockRuns) List(ctx context.Context, workspaceID string, options tfe.RunListOptions) (*tfe.RunList, error) { - m.Lock() - defer m.Unlock() - - w, ok := m.client.Workspaces.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - rl := &tfe.RunList{} - for _, run := range m.workspaces[w.ID] { - rc, err := copystructure.Copy(run) - if err != nil { - panic(err) - } - rl.Items = append(rl.Items, rc.(*tfe.Run)) - } - - rl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 1, - PreviousPage: 1, - TotalPages: 1, - TotalCount: len(rl.Items), - } - - return rl, nil -} - -func (m *mockRuns) Create(ctx context.Context, options tfe.RunCreateOptions) (*tfe.Run, error) { - m.Lock() - defer m.Unlock() - - a, err := m.client.Applies.create(options.ConfigurationVersion.ID, options.Workspace.ID) - if err != nil { - return nil, err - } - - ce, err := m.client.CostEstimates.create(options.ConfigurationVersion.ID, options.Workspace.ID) - if err != nil { - return nil, err - } - - p, err := m.client.Plans.create(options.ConfigurationVersion.ID, options.Workspace.ID) - if err != nil { - return nil, err - } - - pc, err := m.client.PolicyChecks.create(options.ConfigurationVersion.ID, options.Workspace.ID) - if err != nil { - return nil, err - } - - r := &tfe.Run{ - ID: generateID("run-"), - Actions: &tfe.RunActions{IsCancelable: true}, - Apply: a, - CostEstimate: ce, - HasChanges: false, - Permissions: &tfe.RunPermissions{}, - Plan: p, - ReplaceAddrs: options.ReplaceAddrs, - Status: tfe.RunPending, - TargetAddrs: options.TargetAddrs, - } - - if options.Message != nil { - r.Message = *options.Message - } - - if pc != nil { - r.PolicyChecks = []*tfe.PolicyCheck{pc} - } - - if options.IsDestroy != nil { - r.IsDestroy = *options.IsDestroy - } - - if options.Refresh != nil { - r.Refresh = *options.Refresh - } - - if options.RefreshOnly != nil { - r.RefreshOnly = *options.RefreshOnly - } - - w, ok := m.client.Workspaces.workspaceIDs[options.Workspace.ID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - if w.CurrentRun == nil { - w.CurrentRun = r - } - - if m.modifyNewRun != nil { - // caller-provided callback may modify the run in-place to mimic - // side-effects that a real server might take in some situations. - m.modifyNewRun(m.client, options, r) - } - - m.runs[r.ID] = r - m.workspaces[options.Workspace.ID] = append(m.workspaces[options.Workspace.ID], r) - - return r, nil -} - -func (m *mockRuns) Read(ctx context.Context, runID string) (*tfe.Run, error) { - return m.ReadWithOptions(ctx, runID, nil) -} - -func (m *mockRuns) ReadWithOptions(ctx context.Context, runID string, _ *tfe.RunReadOptions) (*tfe.Run, error) { - m.Lock() - defer m.Unlock() - - r, ok := m.runs[runID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - pending := false - for _, r := range m.runs { - if r.ID != runID && r.Status == tfe.RunPending { - pending = true - break - } - } - - if !pending && r.Status == tfe.RunPending { - // Only update the status if there are no other pending runs. - r.Status = tfe.RunPlanning - r.Plan.Status = tfe.PlanRunning - } - - logs, _ := ioutil.ReadFile(m.client.Plans.logs[r.Plan.LogReadURL]) - if r.Status == tfe.RunPlanning && r.Plan.Status == tfe.PlanFinished { - if r.IsDestroy || bytes.Contains(logs, []byte("1 to add, 0 to change, 0 to destroy")) { - r.Actions.IsCancelable = false - r.Actions.IsConfirmable = true - r.HasChanges = true - r.Permissions.CanApply = true - } - - if bytes.Contains(logs, []byte("null_resource.foo: 1 error")) { - r.Actions.IsCancelable = false - r.HasChanges = false - r.Status = tfe.RunErrored - } - } - - // we must return a copy for the client - rc, err := copystructure.Copy(r) - if err != nil { - panic(err) - } - - return rc.(*tfe.Run), nil -} - -func (m *mockRuns) Apply(ctx context.Context, runID string, options tfe.RunApplyOptions) error { - m.Lock() - defer m.Unlock() - - r, ok := m.runs[runID] - if !ok { - return tfe.ErrResourceNotFound - } - if r.Status != tfe.RunPending { - // Only update the status if the run is not pending anymore. - r.Status = tfe.RunApplying - r.Actions.IsConfirmable = false - r.Apply.Status = tfe.ApplyRunning - } - return nil -} - -func (m *mockRuns) Cancel(ctx context.Context, runID string, options tfe.RunCancelOptions) error { - panic("not implemented") -} - -func (m *mockRuns) ForceCancel(ctx context.Context, runID string, options tfe.RunForceCancelOptions) error { - panic("not implemented") -} - -func (m *mockRuns) Discard(ctx context.Context, runID string, options tfe.RunDiscardOptions) error { - m.Lock() - defer m.Unlock() - - r, ok := m.runs[runID] - if !ok { - return tfe.ErrResourceNotFound - } - r.Status = tfe.RunDiscarded - r.Actions.IsConfirmable = false - return nil -} - -type mockStateVersions struct { - client *mockClient - states map[string][]byte - stateVersions map[string]*tfe.StateVersion - workspaces map[string][]string -} - -func newMockStateVersions(client *mockClient) *mockStateVersions { - return &mockStateVersions{ - client: client, - states: make(map[string][]byte), - stateVersions: make(map[string]*tfe.StateVersion), - workspaces: make(map[string][]string), - } -} - -func (m *mockStateVersions) List(ctx context.Context, options tfe.StateVersionListOptions) (*tfe.StateVersionList, error) { - svl := &tfe.StateVersionList{} - for _, sv := range m.stateVersions { - svl.Items = append(svl.Items, sv) - } - - svl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 1, - PreviousPage: 1, - TotalPages: 1, - TotalCount: len(svl.Items), - } - - return svl, nil -} - -func (m *mockStateVersions) Create(ctx context.Context, workspaceID string, options tfe.StateVersionCreateOptions) (*tfe.StateVersion, error) { - id := generateID("sv-") - runID := os.Getenv("TFE_RUN_ID") - url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) - - if runID != "" && (options.Run == nil || runID != options.Run.ID) { - return nil, fmt.Errorf("option.Run.ID does not contain the ID exported by TFE_RUN_ID") - } - - sv := &tfe.StateVersion{ - ID: id, - DownloadURL: url, - Serial: *options.Serial, - } - - state, err := base64.StdEncoding.DecodeString(*options.State) - if err != nil { - return nil, err - } - - m.states[sv.DownloadURL] = state - m.stateVersions[sv.ID] = sv - m.workspaces[workspaceID] = append(m.workspaces[workspaceID], sv.ID) - - return sv, nil -} - -func (m *mockStateVersions) Read(ctx context.Context, svID string) (*tfe.StateVersion, error) { - return m.ReadWithOptions(ctx, svID, nil) -} - -func (m *mockStateVersions) ReadWithOptions(ctx context.Context, svID string, options *tfe.StateVersionReadOptions) (*tfe.StateVersion, error) { - sv, ok := m.stateVersions[svID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return sv, nil -} - -func (m *mockStateVersions) Current(ctx context.Context, workspaceID string) (*tfe.StateVersion, error) { - return m.CurrentWithOptions(ctx, workspaceID, nil) -} - -func (m *mockStateVersions) CurrentWithOptions(ctx context.Context, workspaceID string, options *tfe.StateVersionCurrentOptions) (*tfe.StateVersion, error) { - w, ok := m.client.Workspaces.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - svs, ok := m.workspaces[w.ID] - if !ok || len(svs) == 0 { - return nil, tfe.ErrResourceNotFound - } - - sv, ok := m.stateVersions[svs[len(svs)-1]] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - return sv, nil -} - -func (m *mockStateVersions) Download(ctx context.Context, url string) ([]byte, error) { - state, ok := m.states[url] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return state, nil -} - -type mockVariables struct { - client *mockClient - workspaces map[string]*tfe.VariableList -} - -var _ tfe.Variables = (*mockVariables)(nil) - -func newMockVariables(client *mockClient) *mockVariables { - return &mockVariables{ - client: client, - workspaces: make(map[string]*tfe.VariableList), - } -} - -func (m *mockVariables) List(ctx context.Context, workspaceID string, options tfe.VariableListOptions) (*tfe.VariableList, error) { - vl := m.workspaces[workspaceID] - return vl, nil -} - -func (m *mockVariables) Create(ctx context.Context, workspaceID string, options tfe.VariableCreateOptions) (*tfe.Variable, error) { - v := &tfe.Variable{ - ID: generateID("var-"), - Key: *options.Key, - Category: *options.Category, - } - if options.Value != nil { - v.Value = *options.Value - } - if options.HCL != nil { - v.HCL = *options.HCL - } - if options.Sensitive != nil { - v.Sensitive = *options.Sensitive - } - - workspace := workspaceID - - if m.workspaces[workspace] == nil { - m.workspaces[workspace] = &tfe.VariableList{} - } - - vl := m.workspaces[workspace] - vl.Items = append(vl.Items, v) - - return v, nil -} - -func (m *mockVariables) Read(ctx context.Context, workspaceID string, variableID string) (*tfe.Variable, error) { - panic("not implemented") -} - -func (m *mockVariables) Update(ctx context.Context, workspaceID string, variableID string, options tfe.VariableUpdateOptions) (*tfe.Variable, error) { - panic("not implemented") -} - -func (m *mockVariables) Delete(ctx context.Context, workspaceID string, variableID string) error { - panic("not implemented") -} - -type mockWorkspaces struct { - client *mockClient - workspaceIDs map[string]*tfe.Workspace - workspaceNames map[string]*tfe.Workspace -} - -func newMockWorkspaces(client *mockClient) *mockWorkspaces { - return &mockWorkspaces{ - client: client, - workspaceIDs: make(map[string]*tfe.Workspace), - workspaceNames: make(map[string]*tfe.Workspace), - } -} - -func (m *mockWorkspaces) List(ctx context.Context, organization string, options tfe.WorkspaceListOptions) (*tfe.WorkspaceList, error) { - dummyWorkspaces := 10 - wl := &tfe.WorkspaceList{} - - // Get the prefix from the search options. - prefix := "" - if options.Search != nil { - prefix = *options.Search - } - - // Get all the workspaces that match the prefix. - var ws []*tfe.Workspace - for _, w := range m.workspaceIDs { - if strings.HasPrefix(w.Name, prefix) { - ws = append(ws, w) - } - } - - // Return an empty result if we have no matches. - if len(ws) == 0 { - wl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - } - return wl, nil - } - - // Return dummy workspaces for the first page to test pagination. - if options.PageNumber <= 1 { - for i := 0; i < dummyWorkspaces; i++ { - wl.Items = append(wl.Items, &tfe.Workspace{ - ID: generateID("ws-"), - Name: fmt.Sprintf("dummy-workspace-%d", i), - }) - } - - wl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 2, - TotalPages: 2, - TotalCount: len(wl.Items) + len(ws), - } - - return wl, nil - } - - // Return the actual workspaces that matched as the second page. - wl.Items = ws - wl.Pagination = &tfe.Pagination{ - CurrentPage: 2, - PreviousPage: 1, - TotalPages: 2, - TotalCount: len(wl.Items) + dummyWorkspaces, - } - - return wl, nil -} - -func (m *mockWorkspaces) Create(ctx context.Context, organization string, options tfe.WorkspaceCreateOptions) (*tfe.Workspace, error) { - if strings.HasSuffix(*options.Name, "no-operations") { - options.Operations = tfe.Bool(false) - } else if options.Operations == nil { - options.Operations = tfe.Bool(true) - } - w := &tfe.Workspace{ - ID: generateID("ws-"), - Name: *options.Name, - Operations: *options.Operations, - Permissions: &tfe.WorkspacePermissions{ - CanQueueApply: true, - CanQueueRun: true, - }, - } - if options.AutoApply != nil { - w.AutoApply = *options.AutoApply - } - if options.VCSRepo != nil { - w.VCSRepo = &tfe.VCSRepo{} - } - if options.TerraformVersion != nil { - w.TerraformVersion = *options.TerraformVersion - } else { - w.TerraformVersion = tfversion.String() - } - m.workspaceIDs[w.ID] = w - m.workspaceNames[w.Name] = w - return w, nil -} - -func (m *mockWorkspaces) Read(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { - // custom error for TestRemote_plan500 in backend_plan_test.go - if workspace == "network-error" { - return nil, errors.New("I'm a little teacup") - } - - w, ok := m.workspaceNames[workspace] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return w, nil -} - -func (m *mockWorkspaces) ReadByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { - w, ok := m.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - return w, nil -} - -func (m *mockWorkspaces) Update(ctx context.Context, organization, workspace string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { - w, ok := m.workspaceNames[workspace] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if options.Operations != nil { - w.Operations = *options.Operations - } - if options.Name != nil { - w.Name = *options.Name - } - if options.TerraformVersion != nil { - w.TerraformVersion = *options.TerraformVersion - } - if options.WorkingDirectory != nil { - w.WorkingDirectory = *options.WorkingDirectory - } - - delete(m.workspaceNames, workspace) - m.workspaceNames[w.Name] = w - - return w, nil -} - -func (m *mockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { - w, ok := m.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - - if options.Name != nil { - w.Name = *options.Name - } - if options.TerraformVersion != nil { - w.TerraformVersion = *options.TerraformVersion - } - if options.WorkingDirectory != nil { - w.WorkingDirectory = *options.WorkingDirectory - } - - delete(m.workspaceNames, w.Name) - m.workspaceNames[w.Name] = w - - return w, nil -} - -func (m *mockWorkspaces) Delete(ctx context.Context, organization, workspace string) error { - if w, ok := m.workspaceNames[workspace]; ok { - delete(m.workspaceIDs, w.ID) - } - delete(m.workspaceNames, workspace) - return nil -} - -func (m *mockWorkspaces) DeleteByID(ctx context.Context, workspaceID string) error { - if w, ok := m.workspaceIDs[workspaceID]; ok { - delete(m.workspaceIDs, w.Name) - } - delete(m.workspaceIDs, workspaceID) - return nil -} - -func (m *mockWorkspaces) RemoveVCSConnection(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { - w, ok := m.workspaceNames[workspace] - if !ok { - return nil, tfe.ErrResourceNotFound - } - w.VCSRepo = nil - return w, nil -} - -func (m *mockWorkspaces) RemoveVCSConnectionByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { - w, ok := m.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - w.VCSRepo = nil - return w, nil -} - -func (m *mockWorkspaces) Lock(ctx context.Context, workspaceID string, options tfe.WorkspaceLockOptions) (*tfe.Workspace, error) { - w, ok := m.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - if w.Locked { - return nil, tfe.ErrWorkspaceLocked - } - w.Locked = true - return w, nil -} - -func (m *mockWorkspaces) Unlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { - w, ok := m.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - if !w.Locked { - return nil, tfe.ErrWorkspaceNotLocked - } - w.Locked = false - return w, nil -} - -func (m *mockWorkspaces) ForceUnlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { - w, ok := m.workspaceIDs[workspaceID] - if !ok { - return nil, tfe.ErrResourceNotFound - } - if !w.Locked { - return nil, tfe.ErrWorkspaceNotLocked - } - w.Locked = false - return w, nil -} - -func (m *mockWorkspaces) AssignSSHKey(ctx context.Context, workspaceID string, options tfe.WorkspaceAssignSSHKeyOptions) (*tfe.Workspace, error) { - panic("not implemented") -} - -func (m *mockWorkspaces) UnassignSSHKey(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { - panic("not implemented") -} - -func (m *mockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string) (*tfe.WorkspaceList, error) { - panic("not implemented") -} - -func (m *mockWorkspaces) AddRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceAddRemoteStateConsumersOptions) error { - panic("not implemented") -} - -func (m *mockWorkspaces) RemoveRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceRemoveRemoteStateConsumersOptions) error { - panic("not implemented") -} - -func (m *mockWorkspaces) UpdateRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateRemoteStateConsumersOptions) error { - panic("not implemented") -} - -func (m *mockWorkspaces) Readme(ctx context.Context, workspaceID string) (io.Reader, error) { - panic("not implemented") -} - -const alphanumeric = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" - -func generateID(s string) string { - b := make([]byte, 16) - for i := range b { - b[i] = alphanumeric[rand.Intn(len(alphanumeric))] - } - return s + string(b) -} diff --git a/internal/backend/remote/backend_plan_test.go b/internal/backend/remote/backend_plan_test.go index 147c68e9dbe2..95aacea97037 100644 --- a/internal/backend/remote/backend_plan_test.go +++ b/internal/backend/remote/backend_plan_test.go @@ -13,6 +13,7 @@ import ( tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" @@ -313,11 +314,11 @@ func TestRemote_planWithoutRefresh(t *testing.T) { // We should find a run inside the mock client that has refresh set // to false. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(false, run.Refresh); diff != "" { t.Errorf("wrong Refresh setting in the created run\n%s", diff) } @@ -382,11 +383,11 @@ func TestRemote_planWithRefreshOnly(t *testing.T) { // We should find a run inside the mock client that has refresh-only set // to true. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(true, run.RefreshOnly); diff != "" { t.Errorf("wrong RefreshOnly setting in the created run\n%s", diff) } @@ -432,7 +433,7 @@ func TestRemote_planWithTarget(t *testing.T) { // When the backend code creates a new run, we'll tweak it so that it // has a cost estimation object with the "skipped_due_to_targeting" status, // emulating how a real server is expected to behave in that case. - b.client.Runs.(*mockRuns).modifyNewRun = func(client *mockClient, options tfe.RunCreateOptions, run *tfe.Run) { + b.client.Runs.(*cloud.MockRuns).ModifyNewRun = func(client *cloud.MockClient, options tfe.RunCreateOptions, run *tfe.Run) { const fakeID = "fake" // This is the cost estimate object embedded in the run itself which // the backend will use to learn the ID to request from the cost @@ -446,7 +447,7 @@ func TestRemote_planWithTarget(t *testing.T) { // the same ID indicated in the object above, where we'll then return // the status "skipped_due_to_targeting" to trigger the special skip // message in the backend output. - client.CostEstimates.estimations[fakeID] = &tfe.CostEstimate{ + client.CostEstimates.Estimations[fakeID] = &tfe.CostEstimate{ ID: fakeID, Status: "skipped_due_to_targeting", } @@ -483,11 +484,11 @@ func TestRemote_planWithTarget(t *testing.T) { // We should find a run inside the mock client that has the same // target address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.TargetAddrs); diff != "" { t.Errorf("wrong TargetAddrs in the created run\n%s", diff) } @@ -558,11 +559,11 @@ func TestRemote_planWithReplace(t *testing.T) { // We should find a run inside the mock client that has the same // refresh address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*cloud.MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.ReplaceAddrs); diff != "" { t.Errorf("wrong ReplaceAddrs in the created run\n%s", diff) } diff --git a/internal/backend/remote/backend_state_test.go b/internal/backend/remote/backend_state_test.go index 3a1769c307a1..0503936b8e8f 100644 --- a/internal/backend/remote/backend_state_test.go +++ b/internal/backend/remote/backend_state_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statefile" @@ -39,7 +40,7 @@ func TestRemoteClient_stateLock(t *testing.T) { func TestRemoteClient_withRunID(t *testing.T) { // Set the TFE_RUN_ID environment variable before creating the client! - if err := os.Setenv("TFE_RUN_ID", generateID("run-")); err != nil { + if err := os.Setenv("TFE_RUN_ID", cloud.GenerateID("run-")); err != nil { t.Fatalf("error setting env var TFE_RUN_ID: %v", err) } diff --git a/internal/backend/remote/testing.go b/internal/backend/remote/testing.go index f3c66941aee2..7dbb9e9b2c8c 100644 --- a/internal/backend/remote/testing.go +++ b/internal/backend/remote/testing.go @@ -8,12 +8,14 @@ import ( "net/http/httptest" "path" "testing" + "time" tfe "github.com/hashicorp/go-tfe" svchost "github.com/hashicorp/terraform-svchost" "github.com/hashicorp/terraform-svchost/auth" "github.com/hashicorp/terraform-svchost/disco" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/httpclient" @@ -39,6 +41,26 @@ var ( }) ) +// mockInput is a mock implementation of terraform.UIInput. +type mockInput struct { + answers map[string]string +} + +func (m *mockInput) Input(ctx context.Context, opts *terraform.InputOpts) (string, error) { + v, ok := m.answers[opts.Id] + if !ok { + return "", fmt.Errorf("unexpected input request in test: %s", opts.Id) + } + if v == "wait-for-external-update" { + select { + case <-ctx.Done(): + case <-time.After(time.Minute): + } + } + delete(m.answers, opts.Id) + return v, nil +} + func testInput(t *testing.T, answers map[string]string) *mockInput { return &mockInput{answers: answers} } @@ -111,7 +133,7 @@ func testBackend(t *testing.T, obj cty.Value) (*Remote, func()) { } // Get a new mock client. - mc := newMockClient() + mc := cloud.NewMockClient() // Replace the services we use with our mock services. b.CLI = cli.NewMockUi() diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 140dafa8a426..1100c31dc847 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -299,11 +299,11 @@ func TestCloud_applyWithoutRefresh(t *testing.T) { // We should find a run inside the mock client that has refresh set // to false. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(false, run.Refresh); diff != "" { t.Errorf("wrong Refresh setting in the created run\n%s", diff) } @@ -368,11 +368,11 @@ func TestCloud_applyWithRefreshOnly(t *testing.T) { // We should find a run inside the mock client that has refresh-only set // to true. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(true, run.RefreshOnly); diff != "" { t.Errorf("wrong RefreshOnly setting in the created run\n%s", diff) } @@ -439,11 +439,11 @@ func TestCloud_applyWithTarget(t *testing.T) { // We should find a run inside the mock client that has the same // target address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.TargetAddrs); diff != "" { t.Errorf("wrong TargetAddrs in the created run\n%s", diff) } @@ -514,11 +514,11 @@ func TestCloud_applyWithReplace(t *testing.T) { // We should find a run inside the mock client that has the same // refresh address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.ReplaceAddrs); diff != "" { t.Errorf("wrong ReplaceAddrs in the created run\n%s", diff) } diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 790c8cc030c1..cd836b46d002 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -304,11 +304,11 @@ func TestCloud_planWithoutRefresh(t *testing.T) { // We should find a run inside the mock client that has refresh set // to false. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(false, run.Refresh); diff != "" { t.Errorf("wrong Refresh setting in the created run\n%s", diff) } @@ -373,11 +373,11 @@ func TestCloud_planWithRefreshOnly(t *testing.T) { // We should find a run inside the mock client that has refresh-only set // to true. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff(true, run.RefreshOnly); diff != "" { t.Errorf("wrong RefreshOnly setting in the created run\n%s", diff) } @@ -423,7 +423,7 @@ func TestCloud_planWithTarget(t *testing.T) { // When the backend code creates a new run, we'll tweak it so that it // has a cost estimation object with the "skipped_due_to_targeting" status, // emulating how a real server is expected to behave in that case. - b.client.Runs.(*mockRuns).modifyNewRun = func(client *mockClient, options tfe.RunCreateOptions, run *tfe.Run) { + b.client.Runs.(*MockRuns).ModifyNewRun = func(client *MockClient, options tfe.RunCreateOptions, run *tfe.Run) { const fakeID = "fake" // This is the cost estimate object embedded in the run itself which // the backend will use to learn the ID to request from the cost @@ -437,7 +437,7 @@ func TestCloud_planWithTarget(t *testing.T) { // the same ID indicated in the object above, where we'll then return // the status "skipped_due_to_targeting" to trigger the special skip // message in the backend output. - client.CostEstimates.estimations[fakeID] = &tfe.CostEstimate{ + client.CostEstimates.Estimations[fakeID] = &tfe.CostEstimate{ ID: fakeID, Status: "skipped_due_to_targeting", } @@ -474,11 +474,11 @@ func TestCloud_planWithTarget(t *testing.T) { // We should find a run inside the mock client that has the same // target address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.TargetAddrs); diff != "" { t.Errorf("wrong TargetAddrs in the created run\n%s", diff) } @@ -549,11 +549,11 @@ func TestCloud_planWithReplace(t *testing.T) { // We should find a run inside the mock client that has the same // refresh address we requested above. - runsAPI := b.client.Runs.(*mockRuns) - if got, want := len(runsAPI.runs), 1; got != want { + runsAPI := b.client.Runs.(*MockRuns) + if got, want := len(runsAPI.Runs), 1; got != want { t.Fatalf("wrong number of runs in the mock client %d; want %d", got, want) } - for _, run := range runsAPI.runs { + for _, run := range runsAPI.Runs { if diff := cmp.Diff([]string{"null_resource.foo"}, run.ReplaceAddrs); diff != "" { t.Errorf("wrong ReplaceAddrs in the created run\n%s", diff) } diff --git a/internal/cloud/backend_state_test.go b/internal/cloud/backend_state_test.go index dc2a45723687..a94c60c6ee3f 100644 --- a/internal/cloud/backend_state_test.go +++ b/internal/cloud/backend_state_test.go @@ -39,7 +39,7 @@ func TestRemoteClient_stateLock(t *testing.T) { func TestRemoteClient_withRunID(t *testing.T) { // Set the TFE_RUN_ID environment variable before creating the client! - if err := os.Setenv("TFE_RUN_ID", generateID("run-")); err != nil { + if err := os.Setenv("TFE_RUN_ID", GenerateID("run-")); err != nil { t.Fatalf("error setting env var TFE_RUN_ID: %v", err) } diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index 73668b2b0330..7bb145b3cfc0 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -8,6 +8,7 @@ import ( "net/http/httptest" "path" "testing" + "time" tfe "github.com/hashicorp/go-tfe" svchost "github.com/hashicorp/terraform-svchost" @@ -39,6 +40,26 @@ var ( }) ) +// mockInput is a mock implementation of terraform.UIInput. +type mockInput struct { + answers map[string]string +} + +func (m *mockInput) Input(ctx context.Context, opts *terraform.InputOpts) (string, error) { + v, ok := m.answers[opts.Id] + if !ok { + return "", fmt.Errorf("unexpected input request in test: %s", opts.Id) + } + if v == "wait-for-external-update" { + select { + case <-ctx.Done(): + case <-time.After(time.Minute): + } + } + delete(m.answers, opts.Id) + return v, nil +} + func testInput(t *testing.T, answers map[string]string) *mockInput { return &mockInput{answers: answers} } @@ -111,7 +132,7 @@ func testBackend(t *testing.T, obj cty.Value) (*Cloud, func()) { } // Get a new mock client. - mc := newMockClient() + mc := NewMockClient() // Replace the services we use with our mock services. b.CLI = cli.NewMockUi() diff --git a/internal/cloud/backend_mock.go b/internal/cloud/tfe_client_mock.go similarity index 75% rename from internal/cloud/backend_mock.go rename to internal/cloud/tfe_client_mock.go index 0ee036bc56e5..d575d82e8d9b 100644 --- a/internal/cloud/backend_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -16,26 +16,25 @@ import ( "time" tfe "github.com/hashicorp/go-tfe" - "github.com/hashicorp/terraform/internal/terraform" tfversion "github.com/hashicorp/terraform/version" "github.com/mitchellh/copystructure" ) -type mockClient struct { - Applies *mockApplies - ConfigurationVersions *mockConfigurationVersions - CostEstimates *mockCostEstimates - Organizations *mockOrganizations - Plans *mockPlans - PolicyChecks *mockPolicyChecks - Runs *mockRuns - StateVersions *mockStateVersions - Variables *mockVariables - Workspaces *mockWorkspaces -} - -func newMockClient() *mockClient { - c := &mockClient{} +type MockClient struct { + Applies *MockApplies + ConfigurationVersions *MockConfigurationVersions + CostEstimates *MockCostEstimates + Organizations *MockOrganizations + Plans *MockPlans + PolicyChecks *MockPolicyChecks + Runs *MockRuns + StateVersions *MockStateVersions + Variables *MockVariables + Workspaces *MockWorkspaces +} + +func NewMockClient() *MockClient { + c := &MockClient{} c.Applies = newMockApplies(c) c.ConfigurationVersions = newMockConfigurationVersions(c) c.CostEstimates = newMockCostEstimates(c) @@ -49,14 +48,14 @@ func newMockClient() *mockClient { return c } -type mockApplies struct { - client *mockClient +type MockApplies struct { + client *MockClient applies map[string]*tfe.Apply logs map[string]string } -func newMockApplies(client *mockClient) *mockApplies { - return &mockApplies{ +func newMockApplies(client *MockClient) *MockApplies { + return &MockApplies{ client: client, applies: make(map[string]*tfe.Apply), logs: make(map[string]string), @@ -65,7 +64,7 @@ func newMockApplies(client *mockClient) *mockApplies { // create is a helper function to create a mock apply that uses the configured // working directory to find the logfile. -func (m *mockApplies) create(cvID, workspaceID string) (*tfe.Apply, error) { +func (m *MockApplies) create(cvID, workspaceID string) (*tfe.Apply, error) { c, ok := m.client.ConfigurationVersions.configVersions[cvID] if !ok { return nil, tfe.ErrResourceNotFound @@ -75,7 +74,7 @@ func (m *mockApplies) create(cvID, workspaceID string) (*tfe.Apply, error) { return nil, nil } - id := generateID("apply-") + id := GenerateID("apply-") url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) a := &tfe.Apply{ @@ -103,7 +102,7 @@ func (m *mockApplies) create(cvID, workspaceID string) (*tfe.Apply, error) { return a, nil } -func (m *mockApplies) Read(ctx context.Context, applyID string) (*tfe.Apply, error) { +func (m *MockApplies) Read(ctx context.Context, applyID string) (*tfe.Apply, error) { a, ok := m.applies[applyID] if !ok { return nil, tfe.ErrResourceNotFound @@ -115,7 +114,7 @@ func (m *mockApplies) Read(ctx context.Context, applyID string) (*tfe.Apply, err return a, nil } -func (m *mockApplies) Logs(ctx context.Context, applyID string) (io.Reader, error) { +func (m *MockApplies) Logs(ctx context.Context, applyID string) (io.Reader, error) { a, err := m.Read(ctx, applyID) if err != nil { return nil, err @@ -152,15 +151,15 @@ func (m *mockApplies) Logs(ctx context.Context, applyID string) (io.Reader, erro }, nil } -type mockConfigurationVersions struct { - client *mockClient +type MockConfigurationVersions struct { + client *MockClient configVersions map[string]*tfe.ConfigurationVersion uploadPaths map[string]string uploadURLs map[string]*tfe.ConfigurationVersion } -func newMockConfigurationVersions(client *mockClient) *mockConfigurationVersions { - return &mockConfigurationVersions{ +func newMockConfigurationVersions(client *MockClient) *MockConfigurationVersions { + return &MockConfigurationVersions{ client: client, configVersions: make(map[string]*tfe.ConfigurationVersion), uploadPaths: make(map[string]string), @@ -168,7 +167,7 @@ func newMockConfigurationVersions(client *mockClient) *mockConfigurationVersions } } -func (m *mockConfigurationVersions) List(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionListOptions) (*tfe.ConfigurationVersionList, error) { +func (m *MockConfigurationVersions) List(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionListOptions) (*tfe.ConfigurationVersionList, error) { cvl := &tfe.ConfigurationVersionList{} for _, cv := range m.configVersions { cvl.Items = append(cvl.Items, cv) @@ -185,8 +184,8 @@ func (m *mockConfigurationVersions) List(ctx context.Context, workspaceID string return cvl, nil } -func (m *mockConfigurationVersions) Create(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionCreateOptions) (*tfe.ConfigurationVersion, error) { - id := generateID("cv-") +func (m *MockConfigurationVersions) Create(ctx context.Context, workspaceID string, options tfe.ConfigurationVersionCreateOptions) (*tfe.ConfigurationVersion, error) { + id := GenerateID("cv-") url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) cv := &tfe.ConfigurationVersion{ @@ -201,7 +200,7 @@ func (m *mockConfigurationVersions) Create(ctx context.Context, workspaceID stri return cv, nil } -func (m *mockConfigurationVersions) Read(ctx context.Context, cvID string) (*tfe.ConfigurationVersion, error) { +func (m *MockConfigurationVersions) Read(ctx context.Context, cvID string) (*tfe.ConfigurationVersion, error) { cv, ok := m.configVersions[cvID] if !ok { return nil, tfe.ErrResourceNotFound @@ -209,7 +208,15 @@ func (m *mockConfigurationVersions) Read(ctx context.Context, cvID string) (*tfe return cv, nil } -func (m *mockConfigurationVersions) Upload(ctx context.Context, url, path string) error { +func (m *MockConfigurationVersions) ReadWithOptions(ctx context.Context, cvID string, options *tfe.ConfigurationVersionReadOptions) (*tfe.ConfigurationVersion, error) { + cv, ok := m.configVersions[cvID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return cv, nil +} + +func (m *MockConfigurationVersions) Upload(ctx context.Context, url, path string) error { cv, ok := m.uploadURLs[url] if !ok { return errors.New("404 not found") @@ -219,24 +226,24 @@ func (m *mockConfigurationVersions) Upload(ctx context.Context, url, path string return nil } -type mockCostEstimates struct { - client *mockClient - estimations map[string]*tfe.CostEstimate +type MockCostEstimates struct { + client *MockClient + Estimations map[string]*tfe.CostEstimate logs map[string]string } -func newMockCostEstimates(client *mockClient) *mockCostEstimates { - return &mockCostEstimates{ +func newMockCostEstimates(client *MockClient) *MockCostEstimates { + return &MockCostEstimates{ client: client, - estimations: make(map[string]*tfe.CostEstimate), + Estimations: make(map[string]*tfe.CostEstimate), logs: make(map[string]string), } } // create is a helper function to create a mock cost estimation that uses the // configured working directory to find the logfile. -func (m *mockCostEstimates) create(cvID, workspaceID string) (*tfe.CostEstimate, error) { - id := generateID("ce-") +func (m *MockCostEstimates) create(cvID, workspaceID string) (*tfe.CostEstimate, error) { + id := GenerateID("ce-") ce := &tfe.CostEstimate{ ID: id, @@ -263,21 +270,21 @@ func (m *mockCostEstimates) create(cvID, workspaceID string) (*tfe.CostEstimate, } m.logs[ce.ID] = logfile - m.estimations[ce.ID] = ce + m.Estimations[ce.ID] = ce return ce, nil } -func (m *mockCostEstimates) Read(ctx context.Context, costEstimateID string) (*tfe.CostEstimate, error) { - ce, ok := m.estimations[costEstimateID] +func (m *MockCostEstimates) Read(ctx context.Context, costEstimateID string) (*tfe.CostEstimate, error) { + ce, ok := m.Estimations[costEstimateID] if !ok { return nil, tfe.ErrResourceNotFound } return ce, nil } -func (m *mockCostEstimates) Logs(ctx context.Context, costEstimateID string) (io.Reader, error) { - ce, ok := m.estimations[costEstimateID] +func (m *MockCostEstimates) Logs(ctx context.Context, costEstimateID string) (io.Reader, error) { + ce, ok := m.Estimations[costEstimateID] if !ok { return nil, tfe.ErrResourceNotFound } @@ -301,39 +308,19 @@ func (m *mockCostEstimates) Logs(ctx context.Context, costEstimateID string) (io return bytes.NewBuffer(logs), nil } -// mockInput is a mock implementation of terraform.UIInput. -type mockInput struct { - answers map[string]string -} - -func (m *mockInput) Input(ctx context.Context, opts *terraform.InputOpts) (string, error) { - v, ok := m.answers[opts.Id] - if !ok { - return "", fmt.Errorf("unexpected input request in test: %s", opts.Id) - } - if v == "wait-for-external-update" { - select { - case <-ctx.Done(): - case <-time.After(time.Minute): - } - } - delete(m.answers, opts.Id) - return v, nil -} - -type mockOrganizations struct { - client *mockClient +type MockOrganizations struct { + client *MockClient organizations map[string]*tfe.Organization } -func newMockOrganizations(client *mockClient) *mockOrganizations { - return &mockOrganizations{ +func newMockOrganizations(client *MockClient) *MockOrganizations { + return &MockOrganizations{ client: client, organizations: make(map[string]*tfe.Organization), } } -func (m *mockOrganizations) List(ctx context.Context, options tfe.OrganizationListOptions) (*tfe.OrganizationList, error) { +func (m *MockOrganizations) List(ctx context.Context, options tfe.OrganizationListOptions) (*tfe.OrganizationList, error) { orgl := &tfe.OrganizationList{} for _, org := range m.organizations { orgl.Items = append(orgl.Items, org) @@ -376,13 +363,13 @@ func (m *mockLogReader) read(l []byte) (int, error) { return m.logs.Read(l) } -func (m *mockOrganizations) Create(ctx context.Context, options tfe.OrganizationCreateOptions) (*tfe.Organization, error) { +func (m *MockOrganizations) Create(ctx context.Context, options tfe.OrganizationCreateOptions) (*tfe.Organization, error) { org := &tfe.Organization{Name: *options.Name} m.organizations[org.Name] = org return org, nil } -func (m *mockOrganizations) Read(ctx context.Context, name string) (*tfe.Organization, error) { +func (m *MockOrganizations) Read(ctx context.Context, name string) (*tfe.Organization, error) { org, ok := m.organizations[name] if !ok { return nil, tfe.ErrResourceNotFound @@ -390,7 +377,7 @@ func (m *mockOrganizations) Read(ctx context.Context, name string) (*tfe.Organiz return org, nil } -func (m *mockOrganizations) Update(ctx context.Context, name string, options tfe.OrganizationUpdateOptions) (*tfe.Organization, error) { +func (m *MockOrganizations) Update(ctx context.Context, name string, options tfe.OrganizationUpdateOptions) (*tfe.Organization, error) { org, ok := m.organizations[name] if !ok { return nil, tfe.ErrResourceNotFound @@ -400,14 +387,14 @@ func (m *mockOrganizations) Update(ctx context.Context, name string, options tfe } -func (m *mockOrganizations) Delete(ctx context.Context, name string) error { +func (m *MockOrganizations) Delete(ctx context.Context, name string) error { delete(m.organizations, name) return nil } -func (m *mockOrganizations) Capacity(ctx context.Context, name string) (*tfe.Capacity, error) { +func (m *MockOrganizations) Capacity(ctx context.Context, name string) (*tfe.Capacity, error) { var pending, running int - for _, r := range m.client.Runs.runs { + for _, r := range m.client.Runs.Runs { if r.Status == tfe.RunPending { pending++ continue @@ -417,7 +404,7 @@ func (m *mockOrganizations) Capacity(ctx context.Context, name string) (*tfe.Cap return &tfe.Capacity{Pending: pending, Running: running}, nil } -func (m *mockOrganizations) Entitlements(ctx context.Context, name string) (*tfe.Entitlements, error) { +func (m *MockOrganizations) Entitlements(ctx context.Context, name string) (*tfe.Entitlements, error) { return &tfe.Entitlements{ Operations: true, PrivateModuleRegistry: true, @@ -428,10 +415,10 @@ func (m *mockOrganizations) Entitlements(ctx context.Context, name string) (*tfe }, nil } -func (m *mockOrganizations) RunQueue(ctx context.Context, name string, options tfe.RunQueueOptions) (*tfe.RunQueue, error) { +func (m *MockOrganizations) RunQueue(ctx context.Context, name string, options tfe.RunQueueOptions) (*tfe.RunQueue, error) { rq := &tfe.RunQueue{} - for _, r := range m.client.Runs.runs { + for _, r := range m.client.Runs.Runs { rq.Items = append(rq.Items, r) } @@ -446,15 +433,15 @@ func (m *mockOrganizations) RunQueue(ctx context.Context, name string, options t return rq, nil } -type mockPlans struct { - client *mockClient +type MockPlans struct { + client *MockClient logs map[string]string planOutputs map[string]string plans map[string]*tfe.Plan } -func newMockPlans(client *mockClient) *mockPlans { - return &mockPlans{ +func newMockPlans(client *MockClient) *MockPlans { + return &MockPlans{ client: client, logs: make(map[string]string), planOutputs: make(map[string]string), @@ -464,8 +451,8 @@ func newMockPlans(client *mockClient) *mockPlans { // create is a helper function to create a mock plan that uses the configured // working directory to find the logfile. -func (m *mockPlans) create(cvID, workspaceID string) (*tfe.Plan, error) { - id := generateID("plan-") +func (m *MockPlans) create(cvID, workspaceID string) (*tfe.Plan, error) { + id := GenerateID("plan-") url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) p := &tfe.Plan{ @@ -489,7 +476,7 @@ func (m *mockPlans) create(cvID, workspaceID string) (*tfe.Plan, error) { return p, nil } -func (m *mockPlans) Read(ctx context.Context, planID string) (*tfe.Plan, error) { +func (m *MockPlans) Read(ctx context.Context, planID string) (*tfe.Plan, error) { p, ok := m.plans[planID] if !ok { return nil, tfe.ErrResourceNotFound @@ -501,7 +488,7 @@ func (m *mockPlans) Read(ctx context.Context, planID string) (*tfe.Plan, error) return p, nil } -func (m *mockPlans) Logs(ctx context.Context, planID string) (io.Reader, error) { +func (m *MockPlans) Logs(ctx context.Context, planID string) (io.Reader, error) { p, err := m.Read(ctx, planID) if err != nil { return nil, err @@ -538,7 +525,7 @@ func (m *mockPlans) Logs(ctx context.Context, planID string) (io.Reader, error) }, nil } -func (m *mockPlans) JSONOutput(ctx context.Context, planID string) ([]byte, error) { +func (m *MockPlans) JSONOutput(ctx context.Context, planID string) ([]byte, error) { planOutput, ok := m.planOutputs[planID] if !ok { return nil, tfe.ErrResourceNotFound @@ -547,14 +534,14 @@ func (m *mockPlans) JSONOutput(ctx context.Context, planID string) ([]byte, erro return []byte(planOutput), nil } -type mockPolicyChecks struct { - client *mockClient +type MockPolicyChecks struct { + client *MockClient checks map[string]*tfe.PolicyCheck logs map[string]string } -func newMockPolicyChecks(client *mockClient) *mockPolicyChecks { - return &mockPolicyChecks{ +func newMockPolicyChecks(client *MockClient) *MockPolicyChecks { + return &MockPolicyChecks{ client: client, checks: make(map[string]*tfe.PolicyCheck), logs: make(map[string]string), @@ -563,8 +550,8 @@ func newMockPolicyChecks(client *mockClient) *mockPolicyChecks { // create is a helper function to create a mock policy check that uses the // configured working directory to find the logfile. -func (m *mockPolicyChecks) create(cvID, workspaceID string) (*tfe.PolicyCheck, error) { - id := generateID("pc-") +func (m *MockPolicyChecks) create(cvID, workspaceID string) (*tfe.PolicyCheck, error) { + id := GenerateID("pc-") pc := &tfe.PolicyCheck{ ID: id, @@ -595,8 +582,8 @@ func (m *mockPolicyChecks) create(cvID, workspaceID string) (*tfe.PolicyCheck, e return pc, nil } -func (m *mockPolicyChecks) List(ctx context.Context, runID string, options tfe.PolicyCheckListOptions) (*tfe.PolicyCheckList, error) { - _, ok := m.client.Runs.runs[runID] +func (m *MockPolicyChecks) List(ctx context.Context, runID string, options tfe.PolicyCheckListOptions) (*tfe.PolicyCheckList, error) { + _, ok := m.client.Runs.Runs[runID] if !ok { return nil, tfe.ErrResourceNotFound } @@ -617,7 +604,7 @@ func (m *mockPolicyChecks) List(ctx context.Context, runID string, options tfe.P return pcl, nil } -func (m *mockPolicyChecks) Read(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { +func (m *MockPolicyChecks) Read(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { pc, ok := m.checks[policyCheckID] if !ok { return nil, tfe.ErrResourceNotFound @@ -657,7 +644,7 @@ func (m *mockPolicyChecks) Read(ctx context.Context, policyCheckID string) (*tfe return pc, nil } -func (m *mockPolicyChecks) Override(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { +func (m *MockPolicyChecks) Override(ctx context.Context, policyCheckID string) (*tfe.PolicyCheck, error) { pc, ok := m.checks[policyCheckID] if !ok { return nil, tfe.ErrResourceNotFound @@ -666,7 +653,7 @@ func (m *mockPolicyChecks) Override(ctx context.Context, policyCheckID string) ( return pc, nil } -func (m *mockPolicyChecks) Logs(ctx context.Context, policyCheckID string) (io.Reader, error) { +func (m *MockPolicyChecks) Logs(ctx context.Context, policyCheckID string) (io.Reader, error) { pc, ok := m.checks[policyCheckID] if !ok { return nil, tfe.ErrResourceNotFound @@ -706,28 +693,28 @@ func (m *mockPolicyChecks) Logs(ctx context.Context, policyCheckID string) (io.R return bytes.NewBuffer(logs), nil } -type mockRuns struct { +type MockRuns struct { sync.Mutex - client *mockClient - runs map[string]*tfe.Run + client *MockClient + Runs map[string]*tfe.Run workspaces map[string][]*tfe.Run - // If modifyNewRun is non-nil, the create method will call it just before + // If ModifyNewRun is non-nil, the create method will call it just before // saving a new run in the runs map, so that a calling test can mimic // side-effects that a real server might apply in certain situations. - modifyNewRun func(client *mockClient, options tfe.RunCreateOptions, run *tfe.Run) + ModifyNewRun func(client *MockClient, options tfe.RunCreateOptions, run *tfe.Run) } -func newMockRuns(client *mockClient) *mockRuns { - return &mockRuns{ +func newMockRuns(client *MockClient) *MockRuns { + return &MockRuns{ client: client, - runs: make(map[string]*tfe.Run), + Runs: make(map[string]*tfe.Run), workspaces: make(map[string][]*tfe.Run), } } -func (m *mockRuns) List(ctx context.Context, workspaceID string, options tfe.RunListOptions) (*tfe.RunList, error) { +func (m *MockRuns) List(ctx context.Context, workspaceID string, options tfe.RunListOptions) (*tfe.RunList, error) { m.Lock() defer m.Unlock() @@ -756,7 +743,7 @@ func (m *mockRuns) List(ctx context.Context, workspaceID string, options tfe.Run return rl, nil } -func (m *mockRuns) Create(ctx context.Context, options tfe.RunCreateOptions) (*tfe.Run, error) { +func (m *MockRuns) Create(ctx context.Context, options tfe.RunCreateOptions) (*tfe.Run, error) { m.Lock() defer m.Unlock() @@ -781,7 +768,7 @@ func (m *mockRuns) Create(ctx context.Context, options tfe.RunCreateOptions) (*t } r := &tfe.Run{ - ID: generateID("run-"), + ID: GenerateID("run-"), Actions: &tfe.RunActions{IsCancelable: true}, Apply: a, CostEstimate: ce, @@ -821,33 +808,33 @@ func (m *mockRuns) Create(ctx context.Context, options tfe.RunCreateOptions) (*t w.CurrentRun = r } - if m.modifyNewRun != nil { + if m.ModifyNewRun != nil { // caller-provided callback may modify the run in-place to mimic // side-effects that a real server might take in some situations. - m.modifyNewRun(m.client, options, r) + m.ModifyNewRun(m.client, options, r) } - m.runs[r.ID] = r + m.Runs[r.ID] = r m.workspaces[options.Workspace.ID] = append(m.workspaces[options.Workspace.ID], r) return r, nil } -func (m *mockRuns) Read(ctx context.Context, runID string) (*tfe.Run, error) { +func (m *MockRuns) Read(ctx context.Context, runID string) (*tfe.Run, error) { return m.ReadWithOptions(ctx, runID, nil) } -func (m *mockRuns) ReadWithOptions(ctx context.Context, runID string, _ *tfe.RunReadOptions) (*tfe.Run, error) { +func (m *MockRuns) ReadWithOptions(ctx context.Context, runID string, _ *tfe.RunReadOptions) (*tfe.Run, error) { m.Lock() defer m.Unlock() - r, ok := m.runs[runID] + r, ok := m.Runs[runID] if !ok { return nil, tfe.ErrResourceNotFound } pending := false - for _, r := range m.runs { + for _, r := range m.Runs { if r.ID != runID && r.Status == tfe.RunPending { pending = true break @@ -885,11 +872,11 @@ func (m *mockRuns) ReadWithOptions(ctx context.Context, runID string, _ *tfe.Run return rc.(*tfe.Run), nil } -func (m *mockRuns) Apply(ctx context.Context, runID string, options tfe.RunApplyOptions) error { +func (m *MockRuns) Apply(ctx context.Context, runID string, options tfe.RunApplyOptions) error { m.Lock() defer m.Unlock() - r, ok := m.runs[runID] + r, ok := m.Runs[runID] if !ok { return tfe.ErrResourceNotFound } @@ -902,19 +889,19 @@ func (m *mockRuns) Apply(ctx context.Context, runID string, options tfe.RunApply return nil } -func (m *mockRuns) Cancel(ctx context.Context, runID string, options tfe.RunCancelOptions) error { +func (m *MockRuns) Cancel(ctx context.Context, runID string, options tfe.RunCancelOptions) error { panic("not implemented") } -func (m *mockRuns) ForceCancel(ctx context.Context, runID string, options tfe.RunForceCancelOptions) error { +func (m *MockRuns) ForceCancel(ctx context.Context, runID string, options tfe.RunForceCancelOptions) error { panic("not implemented") } -func (m *mockRuns) Discard(ctx context.Context, runID string, options tfe.RunDiscardOptions) error { +func (m *MockRuns) Discard(ctx context.Context, runID string, options tfe.RunDiscardOptions) error { m.Lock() defer m.Unlock() - r, ok := m.runs[runID] + r, ok := m.Runs[runID] if !ok { return tfe.ErrResourceNotFound } @@ -923,15 +910,15 @@ func (m *mockRuns) Discard(ctx context.Context, runID string, options tfe.RunDis return nil } -type mockStateVersions struct { - client *mockClient +type MockStateVersions struct { + client *MockClient states map[string][]byte stateVersions map[string]*tfe.StateVersion workspaces map[string][]string } -func newMockStateVersions(client *mockClient) *mockStateVersions { - return &mockStateVersions{ +func newMockStateVersions(client *MockClient) *MockStateVersions { + return &MockStateVersions{ client: client, states: make(map[string][]byte), stateVersions: make(map[string]*tfe.StateVersion), @@ -939,7 +926,7 @@ func newMockStateVersions(client *mockClient) *mockStateVersions { } } -func (m *mockStateVersions) List(ctx context.Context, options tfe.StateVersionListOptions) (*tfe.StateVersionList, error) { +func (m *MockStateVersions) List(ctx context.Context, options tfe.StateVersionListOptions) (*tfe.StateVersionList, error) { svl := &tfe.StateVersionList{} for _, sv := range m.stateVersions { svl.Items = append(svl.Items, sv) @@ -956,8 +943,8 @@ func (m *mockStateVersions) List(ctx context.Context, options tfe.StateVersionLi return svl, nil } -func (m *mockStateVersions) Create(ctx context.Context, workspaceID string, options tfe.StateVersionCreateOptions) (*tfe.StateVersion, error) { - id := generateID("sv-") +func (m *MockStateVersions) Create(ctx context.Context, workspaceID string, options tfe.StateVersionCreateOptions) (*tfe.StateVersion, error) { + id := GenerateID("sv-") runID := os.Getenv("TFE_RUN_ID") url := fmt.Sprintf("https://app.terraform.io/_archivist/%s", id) @@ -983,11 +970,11 @@ func (m *mockStateVersions) Create(ctx context.Context, workspaceID string, opti return sv, nil } -func (m *mockStateVersions) Read(ctx context.Context, svID string) (*tfe.StateVersion, error) { +func (m *MockStateVersions) Read(ctx context.Context, svID string) (*tfe.StateVersion, error) { return m.ReadWithOptions(ctx, svID, nil) } -func (m *mockStateVersions) ReadWithOptions(ctx context.Context, svID string, options *tfe.StateVersionReadOptions) (*tfe.StateVersion, error) { +func (m *MockStateVersions) ReadWithOptions(ctx context.Context, svID string, options *tfe.StateVersionReadOptions) (*tfe.StateVersion, error) { sv, ok := m.stateVersions[svID] if !ok { return nil, tfe.ErrResourceNotFound @@ -995,11 +982,11 @@ func (m *mockStateVersions) ReadWithOptions(ctx context.Context, svID string, op return sv, nil } -func (m *mockStateVersions) Current(ctx context.Context, workspaceID string) (*tfe.StateVersion, error) { +func (m *MockStateVersions) Current(ctx context.Context, workspaceID string) (*tfe.StateVersion, error) { return m.CurrentWithOptions(ctx, workspaceID, nil) } -func (m *mockStateVersions) CurrentWithOptions(ctx context.Context, workspaceID string, options *tfe.StateVersionCurrentOptions) (*tfe.StateVersion, error) { +func (m *MockStateVersions) CurrentWithOptions(ctx context.Context, workspaceID string, options *tfe.StateVersionCurrentOptions) (*tfe.StateVersion, error) { w, ok := m.client.Workspaces.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1018,7 +1005,7 @@ func (m *mockStateVersions) CurrentWithOptions(ctx context.Context, workspaceID return sv, nil } -func (m *mockStateVersions) Download(ctx context.Context, url string) ([]byte, error) { +func (m *MockStateVersions) Download(ctx context.Context, url string) ([]byte, error) { state, ok := m.states[url] if !ok { return nil, tfe.ErrResourceNotFound @@ -1026,28 +1013,32 @@ func (m *mockStateVersions) Download(ctx context.Context, url string) ([]byte, e return state, nil } -type mockVariables struct { - client *mockClient +func (m *MockStateVersions) Outputs(ctx context.Context, svID string, options tfe.StateVersionOutputsListOptions) ([]*tfe.StateVersionOutput, error) { + panic("not implemented") +} + +type MockVariables struct { + client *MockClient workspaces map[string]*tfe.VariableList } -var _ tfe.Variables = (*mockVariables)(nil) +var _ tfe.Variables = (*MockVariables)(nil) -func newMockVariables(client *mockClient) *mockVariables { - return &mockVariables{ +func newMockVariables(client *MockClient) *MockVariables { + return &MockVariables{ client: client, workspaces: make(map[string]*tfe.VariableList), } } -func (m *mockVariables) List(ctx context.Context, workspaceID string, options tfe.VariableListOptions) (*tfe.VariableList, error) { +func (m *MockVariables) List(ctx context.Context, workspaceID string, options tfe.VariableListOptions) (*tfe.VariableList, error) { vl := m.workspaces[workspaceID] return vl, nil } -func (m *mockVariables) Create(ctx context.Context, workspaceID string, options tfe.VariableCreateOptions) (*tfe.Variable, error) { +func (m *MockVariables) Create(ctx context.Context, workspaceID string, options tfe.VariableCreateOptions) (*tfe.Variable, error) { v := &tfe.Variable{ - ID: generateID("var-"), + ID: GenerateID("var-"), Key: *options.Key, Category: *options.Category, } @@ -1073,33 +1064,33 @@ func (m *mockVariables) Create(ctx context.Context, workspaceID string, options return v, nil } -func (m *mockVariables) Read(ctx context.Context, workspaceID string, variableID string) (*tfe.Variable, error) { +func (m *MockVariables) Read(ctx context.Context, workspaceID string, variableID string) (*tfe.Variable, error) { panic("not implemented") } -func (m *mockVariables) Update(ctx context.Context, workspaceID string, variableID string, options tfe.VariableUpdateOptions) (*tfe.Variable, error) { +func (m *MockVariables) Update(ctx context.Context, workspaceID string, variableID string, options tfe.VariableUpdateOptions) (*tfe.Variable, error) { panic("not implemented") } -func (m *mockVariables) Delete(ctx context.Context, workspaceID string, variableID string) error { +func (m *MockVariables) Delete(ctx context.Context, workspaceID string, variableID string) error { panic("not implemented") } -type mockWorkspaces struct { - client *mockClient +type MockWorkspaces struct { + client *MockClient workspaceIDs map[string]*tfe.Workspace workspaceNames map[string]*tfe.Workspace } -func newMockWorkspaces(client *mockClient) *mockWorkspaces { - return &mockWorkspaces{ +func newMockWorkspaces(client *MockClient) *MockWorkspaces { + return &MockWorkspaces{ client: client, workspaceIDs: make(map[string]*tfe.Workspace), workspaceNames: make(map[string]*tfe.Workspace), } } -func (m *mockWorkspaces) List(ctx context.Context, organization string, options tfe.WorkspaceListOptions) (*tfe.WorkspaceList, error) { +func (m *MockWorkspaces) List(ctx context.Context, organization string, options tfe.WorkspaceListOptions) (*tfe.WorkspaceList, error) { dummyWorkspaces := 10 wl := &tfe.WorkspaceList{} @@ -1129,7 +1120,7 @@ func (m *mockWorkspaces) List(ctx context.Context, organization string, options if options.PageNumber <= 1 { for i := 0; i < dummyWorkspaces; i++ { wl.Items = append(wl.Items, &tfe.Workspace{ - ID: generateID("ws-"), + ID: GenerateID("ws-"), Name: fmt.Sprintf("dummy-workspace-%d", i), }) } @@ -1156,14 +1147,14 @@ func (m *mockWorkspaces) List(ctx context.Context, organization string, options return wl, nil } -func (m *mockWorkspaces) Create(ctx context.Context, organization string, options tfe.WorkspaceCreateOptions) (*tfe.Workspace, error) { +func (m *MockWorkspaces) Create(ctx context.Context, organization string, options tfe.WorkspaceCreateOptions) (*tfe.Workspace, error) { if strings.HasSuffix(*options.Name, "no-operations") { options.Operations = tfe.Bool(false) } else if options.Operations == nil { options.Operations = tfe.Bool(true) } w := &tfe.Workspace{ - ID: generateID("ws-"), + ID: GenerateID("ws-"), Name: *options.Name, Operations: *options.Operations, Permissions: &tfe.WorkspacePermissions{ @@ -1187,7 +1178,7 @@ func (m *mockWorkspaces) Create(ctx context.Context, organization string, option return w, nil } -func (m *mockWorkspaces) Read(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) Read(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { // custom error for TestCloud_plan500 in backend_plan_test.go if workspace == "network-error" { return nil, errors.New("I'm a little teacup") @@ -1200,7 +1191,7 @@ func (m *mockWorkspaces) Read(ctx context.Context, organization, workspace strin return w, nil } -func (m *mockWorkspaces) ReadByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) ReadByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { w, ok := m.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1208,7 +1199,19 @@ func (m *mockWorkspaces) ReadByID(ctx context.Context, workspaceID string) (*tfe return w, nil } -func (m *mockWorkspaces) Update(ctx context.Context, organization, workspace string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { +func (m *MockWorkspaces) ReadWithOptions(ctx context.Context, organization string, workspace string, options *tfe.WorkspaceReadOptions) (*tfe.Workspace, error) { + panic("not implemented") +} + +func (m *MockWorkspaces) ReadByIDWithOptions(ctx context.Context, workspaceID string, options *tfe.WorkspaceReadOptions) (*tfe.Workspace, error) { + w, ok := m.workspaceIDs[workspaceID] + if !ok { + return nil, tfe.ErrResourceNotFound + } + return w, nil +} + +func (m *MockWorkspaces) Update(ctx context.Context, organization, workspace string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { w, ok := m.workspaceNames[workspace] if !ok { return nil, tfe.ErrResourceNotFound @@ -1233,7 +1236,7 @@ func (m *mockWorkspaces) Update(ctx context.Context, organization, workspace str return w, nil } -func (m *mockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { +func (m *MockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateOptions) (*tfe.Workspace, error) { w, ok := m.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1255,7 +1258,7 @@ func (m *mockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, opt return w, nil } -func (m *mockWorkspaces) Delete(ctx context.Context, organization, workspace string) error { +func (m *MockWorkspaces) Delete(ctx context.Context, organization, workspace string) error { if w, ok := m.workspaceNames[workspace]; ok { delete(m.workspaceIDs, w.ID) } @@ -1263,7 +1266,7 @@ func (m *mockWorkspaces) Delete(ctx context.Context, organization, workspace str return nil } -func (m *mockWorkspaces) DeleteByID(ctx context.Context, workspaceID string) error { +func (m *MockWorkspaces) DeleteByID(ctx context.Context, workspaceID string) error { if w, ok := m.workspaceIDs[workspaceID]; ok { delete(m.workspaceIDs, w.Name) } @@ -1271,7 +1274,7 @@ func (m *mockWorkspaces) DeleteByID(ctx context.Context, workspaceID string) err return nil } -func (m *mockWorkspaces) RemoveVCSConnection(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) RemoveVCSConnection(ctx context.Context, organization, workspace string) (*tfe.Workspace, error) { w, ok := m.workspaceNames[workspace] if !ok { return nil, tfe.ErrResourceNotFound @@ -1280,7 +1283,7 @@ func (m *mockWorkspaces) RemoveVCSConnection(ctx context.Context, organization, return w, nil } -func (m *mockWorkspaces) RemoveVCSConnectionByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) RemoveVCSConnectionByID(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { w, ok := m.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1289,7 +1292,7 @@ func (m *mockWorkspaces) RemoveVCSConnectionByID(ctx context.Context, workspaceI return w, nil } -func (m *mockWorkspaces) Lock(ctx context.Context, workspaceID string, options tfe.WorkspaceLockOptions) (*tfe.Workspace, error) { +func (m *MockWorkspaces) Lock(ctx context.Context, workspaceID string, options tfe.WorkspaceLockOptions) (*tfe.Workspace, error) { w, ok := m.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1301,7 +1304,7 @@ func (m *mockWorkspaces) Lock(ctx context.Context, workspaceID string, options t return w, nil } -func (m *mockWorkspaces) Unlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) Unlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { w, ok := m.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1313,7 +1316,7 @@ func (m *mockWorkspaces) Unlock(ctx context.Context, workspaceID string) (*tfe.W return w, nil } -func (m *mockWorkspaces) ForceUnlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) ForceUnlock(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { w, ok := m.workspaceIDs[workspaceID] if !ok { return nil, tfe.ErrResourceNotFound @@ -1325,37 +1328,49 @@ func (m *mockWorkspaces) ForceUnlock(ctx context.Context, workspaceID string) (* return w, nil } -func (m *mockWorkspaces) AssignSSHKey(ctx context.Context, workspaceID string, options tfe.WorkspaceAssignSSHKeyOptions) (*tfe.Workspace, error) { +func (m *MockWorkspaces) AssignSSHKey(ctx context.Context, workspaceID string, options tfe.WorkspaceAssignSSHKeyOptions) (*tfe.Workspace, error) { + panic("not implemented") +} + +func (m *MockWorkspaces) UnassignSSHKey(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { + panic("not implemented") +} + +func (m *MockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string) (*tfe.WorkspaceList, error) { + panic("not implemented") +} + +func (m *MockWorkspaces) AddRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceAddRemoteStateConsumersOptions) error { panic("not implemented") } -func (m *mockWorkspaces) UnassignSSHKey(ctx context.Context, workspaceID string) (*tfe.Workspace, error) { +func (m *MockWorkspaces) RemoveRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceRemoveRemoteStateConsumersOptions) error { panic("not implemented") } -func (m *mockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string) (*tfe.WorkspaceList, error) { +func (m *MockWorkspaces) UpdateRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateRemoteStateConsumersOptions) error { panic("not implemented") } -func (m *mockWorkspaces) AddRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceAddRemoteStateConsumersOptions) error { +func (m *MockWorkspaces) Readme(ctx context.Context, workspaceID string) (io.Reader, error) { panic("not implemented") } -func (m *mockWorkspaces) RemoveRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceRemoveRemoteStateConsumersOptions) error { +func (m *MockWorkspaces) Tags(ctx context.Context, workspaceID string, options tfe.WorkspaceTagListOptions) (*tfe.TagList, error) { panic("not implemented") } -func (m *mockWorkspaces) UpdateRemoteStateConsumers(ctx context.Context, workspaceID string, options tfe.WorkspaceUpdateRemoteStateConsumersOptions) error { +func (m *MockWorkspaces) AddTags(ctx context.Context, workspaceID string, options tfe.WorkspaceAddTagsOptions) error { panic("not implemented") } -func (m *mockWorkspaces) Readme(ctx context.Context, workspaceID string) (io.Reader, error) { +func (m *MockWorkspaces) RemoveTags(ctx context.Context, workspaceID string, options tfe.WorkspaceRemoveTagsOptions) error { panic("not implemented") } const alphanumeric = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" -func generateID(s string) string { +func GenerateID(s string) string { b := make([]byte, 16) for i := range b { b[i] = alphanumeric[rand.Intn(len(alphanumeric))] From 8f49757f89e7b2c24ee2b19a90dced46f2fc0200 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 8 Sep 2021 19:02:25 -0400 Subject: [PATCH 207/644] Add testing for Cloud PrepareConfig --- internal/cloud/backend.go | 21 ++---------- internal/cloud/backend_test.go | 59 ++++++++++++++++++++++++++++++++++ internal/cloud/errors.go | 29 +++++++++++++++++ 3 files changed, 91 insertions(+), 18 deletions(-) create mode 100644 internal/cloud/errors.go diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 2a05496895e9..6fd6e6ace5e9 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -151,12 +151,7 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { } if val := obj.GetAttr("organization"); val.IsNull() || val.AsString() == "" { - diags = diags.Append(tfdiags.AttributeValue( - tfdiags.Error, - "Invalid organization value", - `The "organization" attribute value must not be empty.`, - cty.Path{cty.GetAttrStep{Name: "organization"}}, - )) + diags = diags.Append(invalidOrganizationConfigMissingValue) } var name, prefix string @@ -171,22 +166,12 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { // Make sure that we have either a workspace name or a prefix. if name == "" && prefix == "" { - diags = diags.Append(tfdiags.AttributeValue( - tfdiags.Error, - "Invalid workspaces configuration", - `Either workspace "name" or "prefix" is required.`, - cty.Path{cty.GetAttrStep{Name: "workspaces"}}, - )) + diags = diags.Append(invalidWorkspaceConfigMissingValues) } // Make sure that only one of workspace name or a prefix is configured. if name != "" && prefix != "" { - diags = diags.Append(tfdiags.AttributeValue( - tfdiags.Error, - "Invalid workspaces configuration", - `Only one of workspace "name" or "prefix" is allowed.`, - cty.Path{cty.GetAttrStep{Name: "workspaces"}}, - )) + diags = diags.Append(invalidWorkspaceConfigMisconfiguration) } return obj, diags diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 7862ad0a362c..66c3f5bef1bc 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -39,6 +39,65 @@ func TestCloud_backendNoDefault(t *testing.T) { backend.TestBackendStates(t, b) } +func TestCloud_PrepareConfig(t *testing.T) { + cases := map[string]struct { + config cty.Value + expectedErr string + }{ + "null organization": { + config: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + expectedErr: `Invalid organization value: The "organization" attribute value must not be empty.`, + }, + "null workspace": { + config: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("org"), + "workspaces": cty.NullVal(cty.String), + }), + expectedErr: `Invalid workspaces configuration: Either workspace "name" or "prefix" is required.`, + }, + "workspace: empty name and empty prefix": { + config: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("org"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.NullVal(cty.String), + }), + }), + expectedErr: `Invalid workspaces configuration: Either workspace "name" or "prefix" is required.`, + }, + "workspace: name and prefix present": { + config: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("org"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.StringVal("app-"), + }), + }), + expectedErr: `Invalid workspaces configuration: Only one of workspace "name" or "prefix" is allowed.`, + }, + } + + for name, tc := range cases { + s := testServer(t) + b := New(testDisco(s)) + + // Validate + _, valDiags := b.PrepareConfig(tc.config) + if valDiags.Err() != nil && tc.expectedErr != "" { + actualErr := valDiags.Err().Error() + if !strings.Contains(actualErr, tc.expectedErr) { + t.Fatalf("%s: unexpected validation result: %v", name, valDiags.Err()) + } + } + } +} + func TestCloud_config(t *testing.T) { cases := map[string]struct { config cty.Value diff --git a/internal/cloud/errors.go b/internal/cloud/errors.go new file mode 100644 index 000000000000..273f8a15749a --- /dev/null +++ b/internal/cloud/errors.go @@ -0,0 +1,29 @@ +package cloud + +import ( + "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/zclconf/go-cty/cty" +) + +var ( + invalidOrganizationConfigMissingValue = tfdiags.AttributeValue( + tfdiags.Error, + "Invalid organization value", + `The "organization" attribute value must not be empty.`, + cty.Path{cty.GetAttrStep{Name: "organization"}}, + ) + + invalidWorkspaceConfigMissingValues = tfdiags.AttributeValue( + tfdiags.Error, + "Invalid workspaces configuration", + `Either workspace "name" or "prefix" is required.`, + cty.Path{cty.GetAttrStep{Name: "workspaces"}}, + ) + + invalidWorkspaceConfigMisconfiguration = tfdiags.AttributeValue( + tfdiags.Error, + "Invalid workspaces configuration", + `Only one of workspace "name" or "prefix" is allowed.`, + cty.Path{cty.GetAttrStep{Name: "workspaces"}}, + ) +) From 0a125c0400d82f490e8bce90900c0ba9667cb627 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 8 Sep 2021 19:02:25 -0400 Subject: [PATCH 208/644] Cloud: refactor setting attributes, add tests --- internal/cloud/backend.go | 76 +++++++++++--------- internal/cloud/backend_test.go | 122 +++++++++++++++++++++++++++++++++ 2 files changed, 166 insertions(+), 32 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 6fd6e6ace5e9..7557e3f799c3 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -183,41 +183,14 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { if obj.IsNull() { return diags } - - // Get the hostname. - if val := obj.GetAttr("hostname"); !val.IsNull() && val.AsString() != "" { - b.hostname = val.AsString() - } else { - b.hostname = defaultHostname - } - - // Get the organization. - if val := obj.GetAttr("organization"); !val.IsNull() { - b.organization = val.AsString() - } - - // Get the workspaces configuration block and retrieve the - // default workspace name and prefix. - if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { - if val := workspaces.GetAttr("name"); !val.IsNull() { - b.workspace = val.AsString() - } - if val := workspaces.GetAttr("prefix"); !val.IsNull() { - b.prefix = val.AsString() - } - } - - // Determine if we are forced to use the local backend. - b.forceLocal = os.Getenv("TF_FORCE_LOCAL_BACKEND") != "" - - serviceID := tfeServiceID - if b.forceLocal { - serviceID = stateServiceID + diagErr := b.setConfigurationFields(obj) + if diagErr.HasErrors() { + return diagErr } // Discover the service URL to confirm that it provides the Terraform Cloud/Enterprise API // and to get the version constraints. - service, constraints, err := b.discover(serviceID) + service, constraints, err := b.discover() // First check any contraints we might have received. if constraints != nil { @@ -332,8 +305,47 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { return diags } +func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + // Get the hostname. + if val := obj.GetAttr("hostname"); !val.IsNull() && val.AsString() != "" { + b.hostname = val.AsString() + } else { + b.hostname = defaultHostname + } + + // Get the organization. + if val := obj.GetAttr("organization"); !val.IsNull() { + b.organization = val.AsString() + } + + // Get the workspaces configuration block and retrieve the + // default workspace name and prefix. + if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { + + // PrepareConfig checks that you cannot set both of these. + if val := workspaces.GetAttr("name"); !val.IsNull() { + b.workspace = val.AsString() + } + if val := workspaces.GetAttr("prefix"); !val.IsNull() { + b.prefix = val.AsString() + } + } + + // Determine if we are forced to use the local backend. + b.forceLocal = os.Getenv("TF_FORCE_LOCAL_BACKEND") != "" + + return diags +} + // discover the TFC/E API service URL and version constraints. -func (b *Cloud) discover(serviceID string) (*url.URL, *disco.Constraints, error) { +func (b *Cloud) discover() (*url.URL, *disco.Constraints, error) { + serviceID := tfeServiceID + if b.forceLocal { + serviceID = stateServiceID + } + hostname, err := svchost.ForComparison(b.hostname) if err != nil { return nil, nil, err diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 66c3f5bef1bc..7f02f08e891c 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -3,6 +3,7 @@ package cloud import ( "context" "fmt" + "os" "reflect" "strings" "testing" @@ -212,6 +213,127 @@ func TestCloud_config(t *testing.T) { } } +func TestCloud_setConfigurationFields(t *testing.T) { + originalForceBackendEnv := os.Getenv("TF_FORCE_LOCAL_BACKEND") + + cases := map[string]struct { + obj cty.Value + expectedHostname string + expectedOrganziation string + expectedWorkspacePrefix string + expectedWorkspaceName string + expectedForceLocal bool + setEnv func() + resetEnv func() + expectedErr string + }{ + "with hostname set": { + obj: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("hashicorp"), + "hostname": cty.StringVal("hashicorp.com"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + expectedHostname: "hashicorp.com", + expectedOrganziation: "hashicorp", + }, + "with hostname not set, set to default hostname": { + obj: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("hashicorp"), + "hostname": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + expectedHostname: defaultHostname, + expectedOrganziation: "hashicorp", + }, + "with workspace name set": { + obj: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("hashicorp"), + "hostname": cty.StringVal("hashicorp.com"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + }), + }), + expectedHostname: "hashicorp.com", + expectedOrganziation: "hashicorp", + expectedWorkspaceName: "prod", + }, + "with workspace prefix set": { + obj: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("hashicorp"), + "hostname": cty.StringVal("hashicorp.com"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.StringVal("prod"), + }), + }), + expectedHostname: "hashicorp.com", + expectedOrganziation: "hashicorp", + expectedWorkspacePrefix: "prod", + }, + "with force local set": { + obj: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("hashicorp"), + "hostname": cty.StringVal("hashicorp.com"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.StringVal("prod"), + }), + }), + expectedHostname: "hashicorp.com", + expectedOrganziation: "hashicorp", + expectedWorkspacePrefix: "prod", + setEnv: func() { + os.Setenv("TF_FORCE_LOCAL_BACKEND", "1") + }, + resetEnv: func() { + os.Setenv("TF_FORCE_LOCAL_BACKEND", originalForceBackendEnv) + }, + expectedForceLocal: true, + }, + } + + for name, tc := range cases { + b := &Cloud{} + + // if `setEnv` is set, then we expect `resetEnv` to also be set + if tc.setEnv != nil { + tc.setEnv() + defer tc.resetEnv() + } + + errDiags := b.setConfigurationFields(tc.obj) + if errDiags.HasErrors() || tc.expectedErr != "" { + actualErr := errDiags.Err().Error() + if !strings.Contains(actualErr, tc.expectedErr) { + t.Fatalf("%s: unexpected validation result: %v", name, errDiags.Err()) + } + } + + if tc.expectedHostname != "" && b.hostname != tc.expectedHostname { + t.Fatalf("%s: expected hostname %s to match actual hostname %s", name, tc.expectedHostname, b.hostname) + } + if tc.expectedOrganziation != "" && b.organization != tc.expectedOrganziation { + t.Fatalf("%s: expected organization %s to match actual organization %s", name, tc.expectedOrganziation, b.organization) + } + if tc.expectedWorkspacePrefix != "" && b.prefix != tc.expectedWorkspacePrefix { + t.Fatalf("%s: expected workspace prefix %s to match actual workspace prefix %s", name, tc.expectedWorkspacePrefix, b.prefix) + } + if tc.expectedWorkspaceName != "" && b.workspace != tc.expectedWorkspaceName { + t.Fatalf("%s: expected workspace name %s to match actual workspace name %s", name, tc.expectedWorkspaceName, b.workspace) + } + if tc.expectedForceLocal != false && b.forceLocal != tc.expectedForceLocal { + t.Fatalf("%s: expected force local backend to be set ", name) + } + } +} + func TestCloud_versionConstraints(t *testing.T) { cases := map[string]struct { config cty.Value From 922a8e448871e91c273e5bc3768b33f18a4c5f28 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 7 Sep 2021 15:54:33 -0500 Subject: [PATCH 209/644] Refactor private workspace fields into workspaceMapping A mostly cosemetic change; The fields 'workspace' and 'prefix' don't really describe well what they are from a caller, so change these to use a workspaceMapping struct to convey they are for implementing workspace mapping strategies from CLI -> TFC --- internal/cloud/backend.go | 61 +++++++++++++++------------- internal/cloud/backend_apply_test.go | 14 +++---- internal/cloud/backend_context.go | 6 +-- internal/cloud/backend_plan_test.go | 10 ++--- internal/cloud/backend_test.go | 12 +++--- internal/cloud/testing.go | 4 +- 6 files changed, 55 insertions(+), 52 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 7557e3f799c3..305bf8861bd6 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -63,12 +63,9 @@ type Cloud struct { // organization is the organization that contains the target workspaces. organization string - // workspace is used to map the default workspace to a TFC workspace. - workspace string - - // prefix is used to filter down a set of workspaces that use a single - // configuration. - prefix string + // workspaceMapping contains strategies for mapping CLI workspaces in the working directory + // to remote Terraform Cloud workspaces. + workspaceMapping workspaceMapping // services is used for service discovery services *disco.Disco @@ -183,6 +180,7 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { if obj.IsNull() { return diags } + diagErr := b.setConfigurationFields(obj) if diagErr.HasErrors() { return diagErr @@ -326,10 +324,10 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { // PrepareConfig checks that you cannot set both of these. if val := workspaces.GetAttr("name"); !val.IsNull() { - b.workspace = val.AsString() + b.workspaceMapping.name = val.AsString() } if val := workspaces.GetAttr("prefix"); !val.IsNull() { - b.prefix = val.AsString() + b.workspaceMapping.prefix = val.AsString() } } @@ -514,7 +512,7 @@ func (b *Cloud) retryLogHook(attemptNum int, resp *http.Response) { // Workspaces implements backend.Enhanced. func (b *Cloud) Workspaces() ([]string, error) { - if b.prefix == "" { + if b.workspaceMapping.prefix == "" { return nil, backend.ErrWorkspacesNotSupported } return b.workspaces() @@ -524,10 +522,10 @@ func (b *Cloud) Workspaces() ([]string, error) { func (b *Cloud) workspaces() ([]string, error) { options := tfe.WorkspaceListOptions{} switch { - case b.workspace != "": - options.Search = tfe.String(b.workspace) - case b.prefix != "": - options.Search = tfe.String(b.prefix) + case b.workspaceMapping.name != "": + options.Search = tfe.String(b.workspaceMapping.name) + case b.workspaceMapping.prefix != "": + options.Search = tfe.String(b.workspaceMapping.prefix) } // Create a slice to contain all the names. @@ -540,12 +538,12 @@ func (b *Cloud) workspaces() ([]string, error) { } for _, w := range wl.Items { - if b.workspace != "" && w.Name == b.workspace { + if b.workspaceMapping.name != "" && w.Name == b.workspaceMapping.name { names = append(names, backend.DefaultStateName) continue } - if b.prefix != "" && strings.HasPrefix(w.Name, b.prefix) { - names = append(names, strings.TrimPrefix(w.Name, b.prefix)) + if b.workspaceMapping.prefix != "" && strings.HasPrefix(w.Name, b.workspaceMapping.prefix) { + names = append(names, strings.TrimPrefix(w.Name, b.workspaceMapping.prefix)) } } @@ -566,19 +564,19 @@ func (b *Cloud) workspaces() ([]string, error) { // DeleteWorkspace implements backend.Enhanced. func (b *Cloud) DeleteWorkspace(name string) error { - if b.workspace == "" && name == backend.DefaultStateName { + if b.workspaceMapping.name == "" && name == backend.DefaultStateName { return backend.ErrDefaultWorkspaceNotSupported } - if b.prefix == "" && name != backend.DefaultStateName { + if b.workspaceMapping.prefix == "" && name != backend.DefaultStateName { return backend.ErrWorkspacesNotSupported } // Configure the remote workspace name. switch { case name == backend.DefaultStateName: - name = b.workspace - case b.prefix != "" && !strings.HasPrefix(name, b.prefix): - name = b.prefix + name + name = b.workspaceMapping.name + case b.workspaceMapping.prefix != "" && !strings.HasPrefix(name, b.workspaceMapping.prefix): + name = b.workspaceMapping.prefix + name } client := &remoteClient{ @@ -594,19 +592,19 @@ func (b *Cloud) DeleteWorkspace(name string) error { // StateMgr implements backend.Enhanced. func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { - if b.workspace == "" && name == backend.DefaultStateName { + if b.workspaceMapping.name == "" && name == backend.DefaultStateName { return nil, backend.ErrDefaultWorkspaceNotSupported } - if b.prefix == "" && name != backend.DefaultStateName { + if b.workspaceMapping.prefix == "" && name != backend.DefaultStateName { return nil, backend.ErrWorkspacesNotSupported } // Configure the remote workspace name. switch { case name == backend.DefaultStateName: - name = b.workspace - case b.prefix != "" && !strings.HasPrefix(name, b.prefix): - name = b.prefix + name + name = b.workspaceMapping.name + case b.workspaceMapping.prefix != "" && !strings.HasPrefix(name, b.workspaceMapping.prefix): + name = b.workspaceMapping.prefix + name } workspace, err := b.client.Workspaces.Read(context.Background(), b.organization, name) @@ -663,9 +661,9 @@ func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend. name := op.Workspace switch { case op.Workspace == backend.DefaultStateName: - name = b.workspace - case b.prefix != "" && !strings.HasPrefix(op.Workspace, b.prefix): - name = b.prefix + op.Workspace + name = b.workspaceMapping.name + case b.workspaceMapping.prefix != "" && !strings.HasPrefix(op.Workspace, b.workspaceMapping.prefix): + name = b.workspaceMapping.prefix + op.Workspace } // Retrieve the workspace for this operation. @@ -974,6 +972,11 @@ func (b *Cloud) cliColorize() *colorstring.Colorize { } } +type workspaceMapping struct { + name string + prefix string +} + func generalError(msg string, err error) error { var diags tfdiags.Diagnostics diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 1100c31dc847..8fa2d9758c01 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -143,7 +143,7 @@ func TestCloud_applyWithoutPermissions(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.prefix + "prod"), + Name: tfe.String(b.workspaceMapping.prefix + "prod"), }, ) if err != nil { @@ -183,7 +183,7 @@ func TestCloud_applyWithVCS(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.prefix + "prod"), + Name: tfe.String(b.workspaceMapping.prefix + "prod"), VCSRepo: &tfe.VCSRepoOptions{}, }, ) @@ -900,7 +900,7 @@ func TestCloud_applyWithAutoApply(t *testing.T) { b.organization, tfe.WorkspaceCreateOptions{ AutoApply: tfe.Bool(true), - Name: tfe.String(b.prefix + "prod"), + Name: tfe.String(b.workspaceMapping.prefix + "prod"), }, ) if err != nil { @@ -1015,7 +1015,7 @@ func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.prefix + "no-operations"), + Name: tfe.String(b.workspaceMapping.prefix + "no-operations"), }, ) if err != nil { @@ -1074,7 +1074,7 @@ func TestCloud_applyLockTimeout(t *testing.T) { ctx := context.Background() // Retrieve the workspace used to run this operation in. - w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspace) + w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspaceMapping.name) if err != nil { t.Fatalf("error retrieving workspace: %v", err) } @@ -1434,7 +1434,7 @@ func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { b.organization, tfe.WorkspaceCreateOptions{ AutoApply: tfe.Bool(true), - Name: tfe.String(b.prefix + "prod"), + Name: tfe.String(b.workspaceMapping.prefix + "prod"), }, ) if err != nil { @@ -1583,7 +1583,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { _, err := b.client.Workspaces.Update( ctx, b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ Operations: tfe.Bool(tc.hasOperations), TerraformVersion: tfe.String(tc.remoteVersion), diff --git a/internal/cloud/backend_context.go b/internal/cloud/backend_context.go index a564a6d3a718..32a1e52a2583 100644 --- a/internal/cloud/backend_context.go +++ b/internal/cloud/backend_context.go @@ -143,9 +143,9 @@ func (b *Cloud) getRemoteWorkspaceName(localWorkspaceName string) string { // The default workspace name is a special case, for when the backend // is configured to with to an exact remote workspace rather than with // a remote workspace _prefix_. - return b.workspace - case b.prefix != "" && !strings.HasPrefix(localWorkspaceName, b.prefix): - return b.prefix + localWorkspaceName + return b.workspaceMapping.name + case b.workspaceMapping.prefix != "" && !strings.HasPrefix(localWorkspaceName, b.workspaceMapping.prefix): + return b.workspaceMapping.prefix + localWorkspaceName default: return localWorkspaceName } diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index cd836b46d002..45c1958b282e 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -161,7 +161,7 @@ func TestCloud_planWithoutPermissions(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.prefix + "prod"), + Name: tfe.String(b.workspaceMapping.prefix + "prod"), }, ) if err != nil { @@ -772,7 +772,7 @@ func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.prefix + "no-operations"), + Name: tfe.String(b.workspaceMapping.prefix + "no-operations"), }, ) if err != nil { @@ -818,7 +818,7 @@ func TestCloud_planLockTimeout(t *testing.T) { ctx := context.Background() // Retrieve the workspace used to run this operation in. - w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspace) + w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspaceMapping.name) if err != nil { t.Fatalf("error retrieving workspace: %v", err) } @@ -941,7 +941,7 @@ func TestCloud_planWithWorkingDirectory(t *testing.T) { } // Configure the workspace to use a custom working directory. - _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspace, options) + _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspaceMapping.name, options) if err != nil { t.Fatalf("error configuring working directory: %v", err) } @@ -986,7 +986,7 @@ func TestCloud_planWithWorkingDirectoryFromCurrentPath(t *testing.T) { } // Configure the workspace to use a custom working directory. - _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspace, options) + _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspaceMapping.name, options) if err != nil { t.Fatalf("error configuring working directory: %v", err) } diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 7f02f08e891c..cc45a3538155 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -664,7 +664,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String(v0140.String()), }, @@ -681,7 +681,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String(v0135.String()), }, @@ -721,7 +721,7 @@ func TestCloud_StateMgr_versionCheckLatest(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String("latest"), }, @@ -779,7 +779,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ Operations: tfe.Bool(tc.operations), TerraformVersion: tfe.String(tc.remote), @@ -830,7 +830,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String("1.0.cheetarah"), }, @@ -878,7 +878,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspace, + b.workspaceMapping.name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String(remote.String()), }, diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index 7bb145b3cfc0..cfc8d3dce759 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -161,9 +161,9 @@ func testBackend(t *testing.T, obj cty.Value) (*Cloud, func()) { } // Create the default workspace if required. - if b.workspace != "" { + if b.workspaceMapping.name != "" { _, err = b.client.Workspaces.Create(ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspace), + Name: tfe.String(b.workspaceMapping.name), }) if err != nil { t.Fatalf("error: %v", err) From 7a243379fbf6c4e18a4627576492e5563d15f888 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 9 Sep 2021 16:21:35 -0500 Subject: [PATCH 210/644] cloud: Refactor workspaceMapping concerns into strategy() --- internal/cloud/backend.go | 104 +++++++++++++++++++++++---------- internal/cloud/backend_test.go | 8 +-- 2 files changed, 76 insertions(+), 36 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 305bf8861bd6..d92e1fa8c275 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -151,23 +151,22 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { diags = diags.Append(invalidOrganizationConfigMissingValue) } - var name, prefix string + workspaceMapping := workspaceMapping{} if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { if val := workspaces.GetAttr("name"); !val.IsNull() { - name = val.AsString() + workspaceMapping.name = val.AsString() } if val := workspaces.GetAttr("prefix"); !val.IsNull() { - prefix = val.AsString() + workspaceMapping.prefix = val.AsString() } } - // Make sure that we have either a workspace name or a prefix. - if name == "" && prefix == "" { + switch workspaceMapping.strategy() { + // Make sure have a workspace mapping strategy present + case workspaceNoneStrategy: diags = diags.Append(invalidWorkspaceConfigMissingValues) - } - // Make sure that only one of workspace name or a prefix is configured. - if name != "" && prefix != "" { + case workspaceInvalidStrategy: diags = diags.Append(invalidWorkspaceConfigMisconfiguration) } @@ -512,19 +511,20 @@ func (b *Cloud) retryLogHook(attemptNum int, resp *http.Response) { // Workspaces implements backend.Enhanced. func (b *Cloud) Workspaces() ([]string, error) { - if b.workspaceMapping.prefix == "" { + if b.workspaceMapping.strategy() == workspaceNameStrategy { return nil, backend.ErrWorkspacesNotSupported } return b.workspaces() } -// workspaces returns a filtered list of remote workspace names. +// workspaces returns a filtered list of remote workspace names according to the workspace mapping +// strategy configured. func (b *Cloud) workspaces() ([]string, error) { options := tfe.WorkspaceListOptions{} - switch { - case b.workspaceMapping.name != "": + switch b.workspaceMapping.strategy() { + case workspaceNameStrategy: options.Search = tfe.String(b.workspaceMapping.name) - case b.workspaceMapping.prefix != "": + case workspacePrefixStrategy: options.Search = tfe.String(b.workspaceMapping.prefix) } @@ -538,12 +538,22 @@ func (b *Cloud) workspaces() ([]string, error) { } for _, w := range wl.Items { - if b.workspaceMapping.name != "" && w.Name == b.workspaceMapping.name { - names = append(names, backend.DefaultStateName) - continue - } - if b.workspaceMapping.prefix != "" && strings.HasPrefix(w.Name, b.workspaceMapping.prefix) { - names = append(names, strings.TrimPrefix(w.Name, b.workspaceMapping.prefix)) + switch b.workspaceMapping.strategy() { + case workspaceNameStrategy: + if w.Name == b.workspaceMapping.name { + names = append(names, backend.DefaultStateName) + continue + } + case workspacePrefixStrategy: + if strings.HasPrefix(w.Name, b.workspaceMapping.prefix) { + names = append(names, strings.TrimPrefix(w.Name, b.workspaceMapping.prefix)) + continue + } + default: + // Pass-through. "name" and "prefix" strategies are naive and do + // client-side filtering above, but for any other future + // strategy this filtering should be left to the API. + names = append(names, w.Name) } } @@ -564,10 +574,10 @@ func (b *Cloud) workspaces() ([]string, error) { // DeleteWorkspace implements backend.Enhanced. func (b *Cloud) DeleteWorkspace(name string) error { - if b.workspaceMapping.name == "" && name == backend.DefaultStateName { + if b.workspaceMapping.strategy() != workspaceNameStrategy && name == backend.DefaultStateName { return backend.ErrDefaultWorkspaceNotSupported } - if b.workspaceMapping.prefix == "" && name != backend.DefaultStateName { + if b.workspaceMapping.strategy() == workspaceNameStrategy && name != backend.DefaultStateName { return backend.ErrWorkspacesNotSupported } @@ -575,7 +585,7 @@ func (b *Cloud) DeleteWorkspace(name string) error { switch { case name == backend.DefaultStateName: name = b.workspaceMapping.name - case b.workspaceMapping.prefix != "" && !strings.HasPrefix(name, b.workspaceMapping.prefix): + case b.workspaceMapping.strategy() == workspacePrefixStrategy && !strings.HasPrefix(name, b.workspaceMapping.prefix): name = b.workspaceMapping.prefix + name } @@ -592,10 +602,10 @@ func (b *Cloud) DeleteWorkspace(name string) error { // StateMgr implements backend.Enhanced. func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { - if b.workspaceMapping.name == "" && name == backend.DefaultStateName { + if b.workspaceMapping.strategy() != workspaceNameStrategy && name == backend.DefaultStateName { return nil, backend.ErrDefaultWorkspaceNotSupported } - if b.workspaceMapping.prefix == "" && name != backend.DefaultStateName { + if b.workspaceMapping.strategy() == workspaceNameStrategy && name != backend.DefaultStateName { return nil, backend.ErrWorkspacesNotSupported } @@ -603,7 +613,7 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { switch { case name == backend.DefaultStateName: name = b.workspaceMapping.name - case b.workspaceMapping.prefix != "" && !strings.HasPrefix(name, b.workspaceMapping.prefix): + case b.workspaceMapping.strategy() == workspacePrefixStrategy && !strings.HasPrefix(name, b.workspaceMapping.prefix): name = b.workspaceMapping.prefix + name } @@ -662,7 +672,7 @@ func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend. switch { case op.Workspace == backend.DefaultStateName: name = b.workspaceMapping.name - case b.workspaceMapping.prefix != "" && !strings.HasPrefix(op.Workspace, b.workspaceMapping.prefix): + case b.workspaceMapping.strategy() == workspacePrefixStrategy && !strings.HasPrefix(op.Workspace, b.workspaceMapping.prefix): name = b.workspaceMapping.prefix + op.Workspace } @@ -977,6 +987,29 @@ type workspaceMapping struct { prefix string } +type workspaceStrategy string + +const ( + workspaceNameStrategy workspaceStrategy = "name" + workspacePrefixStrategy workspaceStrategy = "prefix" + workspaceNoneStrategy workspaceStrategy = "none" + workspaceInvalidStrategy workspaceStrategy = "invalid" +) + +func (wm workspaceMapping) strategy() workspaceStrategy { + switch { + case wm.name != "" && wm.prefix == "": + return workspaceNameStrategy + case wm.name == "" && wm.prefix != "": + return workspacePrefixStrategy + case wm.name == "" && wm.prefix == "": + return workspaceNoneStrategy + default: + // Any other combination is invalid as each strategy is mutually exclusive + return workspaceInvalidStrategy + } +} + func generalError(msg string, err error) error { var diags tfdiags.Diagnostics @@ -1042,10 +1075,17 @@ var schemaDescriptions = map[string]string{ "organization": "The name of the organization containing the targeted workspace(s).", "token": "The token used to authenticate with Terraform Cloud/Enterprise. Typically this argument should not be set,\n" + "and 'terraform login' used instead; your credentials will then be fetched from your CLI configuration file or configured credential helper.", - "name": "A workspace name used to map the default workspace to a named remote workspace.\n" + - "When configured only the default workspace can be used. This option conflicts\n" + - "with \"prefix\"", - "prefix": "A prefix used to filter workspaces using a single configuration. New workspaces\n" + - "will automatically be prefixed with this prefix. If omitted only the default\n" + - "workspace can be used. This option conflicts with \"name\"", + "name": "The name of a single Terraform Cloud workspace to be used with this configuration.\n" + + "When configured only the specified workspace can be used. This option conflicts\n" + + "with \"prefix\".", + "prefix": "A name prefix used to select remote Terraform Cloud workspaces to be used for this\n" + + "single configuration. New workspaces will automatically be prefixed with this prefix. This option conflicts with \"name\".", } + +var workspaceConfigurationHelp = fmt.Sprintf(`The 'workspaces' block configures how Terraform CLI maps its workspaces for this +single configuration to workspaces within a Terraform Cloud organization. Two strategies are available: + +[bold]name[reset] - %s + +[bold]prefix[reset] - %s +`, schemaDescriptions["name"], schemaDescriptions["prefix"]) diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index cc45a3538155..945c5637878a 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -322,11 +322,11 @@ func TestCloud_setConfigurationFields(t *testing.T) { if tc.expectedOrganziation != "" && b.organization != tc.expectedOrganziation { t.Fatalf("%s: expected organization %s to match actual organization %s", name, tc.expectedOrganziation, b.organization) } - if tc.expectedWorkspacePrefix != "" && b.prefix != tc.expectedWorkspacePrefix { - t.Fatalf("%s: expected workspace prefix %s to match actual workspace prefix %s", name, tc.expectedWorkspacePrefix, b.prefix) + if tc.expectedWorkspacePrefix != "" && b.workspaceMapping.prefix != tc.expectedWorkspacePrefix { + t.Fatalf("%s: expected workspace prefix %s to match actual workspace prefix %s", name, tc.expectedWorkspacePrefix, b.workspaceMapping.prefix) } - if tc.expectedWorkspaceName != "" && b.workspace != tc.expectedWorkspaceName { - t.Fatalf("%s: expected workspace name %s to match actual workspace name %s", name, tc.expectedWorkspaceName, b.workspace) + if tc.expectedWorkspaceName != "" && b.workspaceMapping.name != tc.expectedWorkspaceName { + t.Fatalf("%s: expected workspace name %s to match actual workspace name %s", name, tc.expectedWorkspaceName, b.workspaceMapping.name) } if tc.expectedForceLocal != false && b.forceLocal != tc.expectedForceLocal { t.Fatalf("%s: expected force local backend to be set ", name) From 6dcd0db2657cb9a47354e5c7c208fc8010f34ebb Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 13 Sep 2021 14:18:32 -0500 Subject: [PATCH 211/644] Map CLI workspaces by TFC tags --- internal/cloud/backend.go | 94 ++++++++++++++++------ internal/cloud/backend_test.go | 142 ++++++++++++++++++++++++++++++--- internal/cloud/errors.go | 8 +- internal/cloud/testing.go | 3 + 4 files changed, 209 insertions(+), 38 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index d92e1fa8c275..9d7d2e5fc4ee 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -26,6 +26,7 @@ import ( "github.com/mitchellh/cli" "github.com/mitchellh/colorstring" "github.com/zclconf/go-cty/cty" + "github.com/zclconf/go-cty/cty/gocty" backendLocal "github.com/hashicorp/terraform/internal/backend/local" ) @@ -104,17 +105,17 @@ func (b *Cloud) ConfigSchema() *configschema.Block { "hostname": { Type: cty.String, Optional: true, - Description: schemaDescriptions["hostname"], + Description: schemaDescriptionHostname, }, "organization": { Type: cty.String, Required: true, - Description: schemaDescriptions["organization"], + Description: schemaDescriptionOrganization, }, "token": { Type: cty.String, Optional: true, - Description: schemaDescriptions["token"], + Description: schemaDescriptionToken, }, }, @@ -125,12 +126,17 @@ func (b *Cloud) ConfigSchema() *configschema.Block { "name": { Type: cty.String, Optional: true, - Description: schemaDescriptions["name"], + Description: schemaDescriptionName, }, "prefix": { Type: cty.String, Optional: true, - Description: schemaDescriptions["prefix"], + Description: schemaDescriptionPrefix, + }, + "tags": { + Type: cty.Set(cty.String), + Optional: true, + Description: schemaDescriptionTags, }, }, }, @@ -159,6 +165,12 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { if val := workspaces.GetAttr("prefix"); !val.IsNull() { workspaceMapping.prefix = val.AsString() } + if val := workspaces.GetAttr("tags"); !val.IsNull() { + err := gocty.FromCtyValue(val, &workspaceMapping.tags) + if err != nil { + log.Panicf("An unxpected error occurred: %s", err) + } + } } switch workspaceMapping.strategy() { @@ -328,6 +340,15 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { if val := workspaces.GetAttr("prefix"); !val.IsNull() { b.workspaceMapping.prefix = val.AsString() } + if val := workspaces.GetAttr("tags"); !val.IsNull() { + var tags []string + err := gocty.FromCtyValue(val, &tags) + if err != nil { + log.Panicf("An unxpected error occurred: %s", err) + } + + b.workspaceMapping.tags = tags + } } // Determine if we are forced to use the local backend. @@ -526,6 +547,9 @@ func (b *Cloud) workspaces() ([]string, error) { options.Search = tfe.String(b.workspaceMapping.name) case workspacePrefixStrategy: options.Search = tfe.String(b.workspaceMapping.prefix) + case workspaceTagsStrategy: + taglist := strings.Join(b.workspaceMapping.tags, ",") + options.Tags = &taglist } // Create a slice to contain all the names. @@ -551,7 +575,7 @@ func (b *Cloud) workspaces() ([]string, error) { } default: // Pass-through. "name" and "prefix" strategies are naive and do - // client-side filtering above, but for any other future + // client-side filtering above, but for tags and any other future // strategy this filtering should be left to the API. names = append(names, w.Name) } @@ -627,6 +651,13 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { Name: tfe.String(name), } + var tags []*tfe.Tag + for _, tag := range b.workspaceMapping.tags { + t := tfe.Tag{Name: tag} + tags = append(tags, &t) + } + options.Tags = tags + // We only set the Terraform Version for the new workspace if this is // a release candidate or a final release. if tfversion.Prerelease == "" || strings.HasPrefix(tfversion.Prerelease, "rc") { @@ -985,11 +1016,13 @@ func (b *Cloud) cliColorize() *colorstring.Colorize { type workspaceMapping struct { name string prefix string + tags []string } type workspaceStrategy string const ( + workspaceTagsStrategy workspaceStrategy = "tags" workspaceNameStrategy workspaceStrategy = "name" workspacePrefixStrategy workspaceStrategy = "prefix" workspaceNoneStrategy workspaceStrategy = "none" @@ -998,11 +1031,13 @@ const ( func (wm workspaceMapping) strategy() workspaceStrategy { switch { - case wm.name != "" && wm.prefix == "": + case len(wm.tags) > 0 && wm.name == "" && wm.prefix == "": + return workspaceTagsStrategy + case len(wm.tags) == 0 && wm.name != "" && wm.prefix == "": return workspaceNameStrategy - case wm.name == "" && wm.prefix != "": + case len(wm.tags) == 0 && wm.name == "" && wm.prefix != "": return workspacePrefixStrategy - case wm.name == "" && wm.prefix == "": + case len(wm.tags) == 0 && wm.name == "" && wm.prefix == "": return workspaceNoneStrategy default: // Any other combination is invalid as each strategy is mutually exclusive @@ -1070,22 +1105,33 @@ const operationNotCanceled = ` [reset][red]The remote operation was not cancelled.[reset] ` -var schemaDescriptions = map[string]string{ - "hostname": "The Terraform Enterprise hostname to connect to. This optional argument defaults to app.terraform.io for use with Terraform Cloud.", - "organization": "The name of the organization containing the targeted workspace(s).", - "token": "The token used to authenticate with Terraform Cloud/Enterprise. Typically this argument should not be set,\n" + - "and 'terraform login' used instead; your credentials will then be fetched from your CLI configuration file or configured credential helper.", - "name": "The name of a single Terraform Cloud workspace to be used with this configuration.\n" + - "When configured only the specified workspace can be used. This option conflicts\n" + - "with \"prefix\".", - "prefix": "A name prefix used to select remote Terraform Cloud workspaces to be used for this\n" + - "single configuration. New workspaces will automatically be prefixed with this prefix. This option conflicts with \"name\".", -} +var ( + workspaceConfigurationHelp = fmt.Sprintf( + `The 'workspaces' block configures how Terraform CLI maps its workspaces for this single +configuration to workspaces within a Terraform Cloud organization. Three strategies are available: -var workspaceConfigurationHelp = fmt.Sprintf(`The 'workspaces' block configures how Terraform CLI maps its workspaces for this -single configuration to workspaces within a Terraform Cloud organization. Two strategies are available: +[bold]tags[reset] - %s [bold]name[reset] - %s -[bold]prefix[reset] - %s -`, schemaDescriptions["name"], schemaDescriptions["prefix"]) +[bold]prefix[reset] - %s`, schemaDescriptionTags, schemaDescriptionName, schemaDescriptionPrefix) + + schemaDescriptionHostname = `The Terraform Enterprise hostname to connect to. This optional argument defaults to app.terraform.io +for use with Terraform Cloud.` + + schemaDescriptionOrganization = `The name of the organization containing the targeted workspace(s).` + + schemaDescriptionToken = `The token used to authenticate with Terraform Cloud/Enterprise. Typically this argument should not +be set, and 'terraform login' used instead; your credentials will then be fetched from your CLI +configuration file or configured credential helper.` + + schemaDescriptionTags = `A set of tags used to select remote Terraform Cloud workspaces to be used for this single +configuration. New workspaces will automatically be tagged with these tag values. Generally, this +is the primary and recommended strategy to use. This option conflicts with "prefix" and "name".` + + schemaDescriptionName = `The name of a single Terraform Cloud workspace to be used with this configuration When configured +only the specified workspace can be used. This option conflicts with "tags" and "prefix".` + + schemaDescriptionPrefix = `DEPRECATED. A name prefix used to select remote Terraform Cloud to be used for this single configuration. New +workspaces will automatically be prefixed with this prefix. This option conflicts with "tags" and "name".` +) diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 945c5637878a..c5115d2005ca 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -51,6 +51,7 @@ func TestCloud_PrepareConfig(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedErr: `Invalid organization value: The "organization" attribute value must not be empty.`, @@ -60,17 +61,18 @@ func TestCloud_PrepareConfig(t *testing.T) { "organization": cty.StringVal("org"), "workspaces": cty.NullVal(cty.String), }), - expectedErr: `Invalid workspaces configuration: Either workspace "name" or "prefix" is required.`, + expectedErr: `Invalid workspaces configuration: Missing workspace mapping strategy. Either workspace "tags", "name", or "prefix" is required.`, }, - "workspace: empty name and empty prefix": { + "workspace: empty tags, name, and prefix": { config: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("org"), "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.String), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), - expectedErr: `Invalid workspaces configuration: Either workspace "name" or "prefix" is required.`, + expectedErr: `Invalid workspaces configuration: Missing workspace mapping strategy. Either workspace "tags", "name", or "prefix" is required.`, }, "workspace: name and prefix present": { config: cty.ObjectVal(map[string]cty.Value{ @@ -78,9 +80,25 @@ func TestCloud_PrepareConfig(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.StringVal("app-"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), - expectedErr: `Invalid workspaces configuration: Only one of workspace "name" or "prefix" is allowed.`, + expectedErr: `Invalid workspaces configuration: Only one of workspace "tags", "name", or "prefix" is allowed.`, + }, + "workspace: name and tags present": { + config: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("org"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), + }), + }), + expectedErr: `Invalid workspaces configuration: Only one of workspace "tags", "name", or "prefix" is allowed.`, }, } @@ -113,6 +131,7 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), confErr: "organization \"nonexisting\" at host app.terraform.io not found", @@ -125,6 +144,7 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), confErr: "Failed to request discovery document", @@ -138,10 +158,27 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), confErr: "terraform login localhost", }, + "with_tags": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), + }), + }), + }, "with_a_name": { config: cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), @@ -150,6 +187,7 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), }, @@ -161,10 +199,11 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.String), "prefix": cty.StringVal("my-app-"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), }, - "without_either_a_name_and_a_prefix": { + "without_a_name_prefix_or_tags": { config: cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), @@ -172,9 +211,10 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.String), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), - valErr: `Either workspace "name" or "prefix" is required`, + valErr: `Missing workspace mapping strategy.`, }, "with_both_a_name_and_a_prefix": { config: cty.ObjectVal(map[string]cty.Value{ @@ -184,9 +224,27 @@ func TestCloud_config(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.StringVal("my-app-"), + "tags": cty.NullVal(cty.Set(cty.String)), + }), + }), + valErr: `Only one of workspace "tags", "name", or "prefix" is allowed.`, + }, + "with_both_a_name_and_tags": { + config: cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.StringVal("prod"), + "prefix": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), }), }), - valErr: `Only one of workspace "name" or "prefix" is allowed`, + valErr: `Only one of workspace "tags", "name", or "prefix" is allowed.`, }, "null config": { config: cty.NullVal(cty.EmptyObject), @@ -222,6 +280,7 @@ func TestCloud_setConfigurationFields(t *testing.T) { expectedOrganziation string expectedWorkspacePrefix string expectedWorkspaceName string + expectedWorkspaceTags []string expectedForceLocal bool setEnv func() resetEnv func() @@ -234,6 +293,7 @@ func TestCloud_setConfigurationFields(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: "hashicorp.com", @@ -246,6 +306,7 @@ func TestCloud_setConfigurationFields(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: defaultHostname, @@ -258,6 +319,7 @@ func TestCloud_setConfigurationFields(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: "hashicorp.com", @@ -271,12 +333,31 @@ func TestCloud_setConfigurationFields(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.String), "prefix": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: "hashicorp.com", expectedOrganziation: "hashicorp", expectedWorkspacePrefix: "prod", }, + "with workspace tags set": { + obj: cty.ObjectVal(map[string]cty.Value{ + "organization": cty.StringVal("hashicorp"), + "hostname": cty.StringVal("hashicorp.com"), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), + }), + }), + expectedHostname: "hashicorp.com", + expectedOrganziation: "hashicorp", + expectedWorkspaceTags: []string{"billing"}, + }, "with force local set": { obj: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("hashicorp"), @@ -284,6 +365,7 @@ func TestCloud_setConfigurationFields(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.String), "prefix": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: "hashicorp.com", @@ -317,16 +399,51 @@ func TestCloud_setConfigurationFields(t *testing.T) { } if tc.expectedHostname != "" && b.hostname != tc.expectedHostname { - t.Fatalf("%s: expected hostname %s to match actual hostname %s", name, tc.expectedHostname, b.hostname) + t.Fatalf("%s: expected hostname %s to match configured hostname %s", name, b.hostname, tc.expectedHostname) } if tc.expectedOrganziation != "" && b.organization != tc.expectedOrganziation { - t.Fatalf("%s: expected organization %s to match actual organization %s", name, tc.expectedOrganziation, b.organization) + t.Fatalf("%s: expected organization (%s) to match configured organization (%s)", name, b.organization, tc.expectedOrganziation) } if tc.expectedWorkspacePrefix != "" && b.workspaceMapping.prefix != tc.expectedWorkspacePrefix { - t.Fatalf("%s: expected workspace prefix %s to match actual workspace prefix %s", name, tc.expectedWorkspacePrefix, b.workspaceMapping.prefix) + t.Fatalf("%s: expected workspace prefix mapping (%s) to match configured workspace prefix (%s)", name, b.workspaceMapping.prefix, tc.expectedWorkspacePrefix) } if tc.expectedWorkspaceName != "" && b.workspaceMapping.name != tc.expectedWorkspaceName { - t.Fatalf("%s: expected workspace name %s to match actual workspace name %s", name, tc.expectedWorkspaceName, b.workspaceMapping.name) + t.Fatalf("%s: expected workspace name mapping (%s) to match configured workspace name (%s)", name, b.workspaceMapping.name, tc.expectedWorkspaceName) + } + if len(tc.expectedWorkspaceTags) > 0 { + presentSet := make(map[string]struct{}) + for _, tag := range b.workspaceMapping.tags { + presentSet[tag] = struct{}{} + } + + expectedSet := make(map[string]struct{}) + for _, tag := range tc.expectedWorkspaceTags { + expectedSet[tag] = struct{}{} + } + + var missing []string + var unexpected []string + + for _, expected := range tc.expectedWorkspaceTags { + if _, ok := presentSet[expected]; !ok { + missing = append(missing, expected) + } + } + + for _, actual := range b.workspaceMapping.tags { + if _, ok := expectedSet[actual]; !ok { + unexpected = append(missing, actual) + } + } + + if len(missing) > 0 { + t.Fatalf("%s: expected workspace tag mapping (%s) to contain the following tags: %s", name, b.workspaceMapping.tags, missing) + } + + if len(unexpected) > 0 { + t.Fatalf("%s: expected workspace tag mapping (%s) to NOT contain the following tags: %s", name, b.workspaceMapping.tags, unexpected) + } + } if tc.expectedForceLocal != false && b.forceLocal != tc.expectedForceLocal { t.Fatalf("%s: expected force local backend to be set ", name) @@ -349,6 +466,7 @@ func TestCloud_versionConstraints(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), version: "0.11.1", @@ -361,6 +479,7 @@ func TestCloud_versionConstraints(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), version: "0.0.1", @@ -374,6 +493,7 @@ func TestCloud_versionConstraints(t *testing.T) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), version: "10.0.1", diff --git a/internal/cloud/errors.go b/internal/cloud/errors.go index 273f8a15749a..81dfe7bb78b6 100644 --- a/internal/cloud/errors.go +++ b/internal/cloud/errors.go @@ -1,6 +1,8 @@ package cloud import ( + "fmt" + "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" ) @@ -9,21 +11,21 @@ var ( invalidOrganizationConfigMissingValue = tfdiags.AttributeValue( tfdiags.Error, "Invalid organization value", - `The "organization" attribute value must not be empty.`, + `The "organization" attribute value must not be empty.\n\n%s`, cty.Path{cty.GetAttrStep{Name: "organization"}}, ) invalidWorkspaceConfigMissingValues = tfdiags.AttributeValue( tfdiags.Error, "Invalid workspaces configuration", - `Either workspace "name" or "prefix" is required.`, + fmt.Sprintf("Missing workspace mapping strategy. Either workspace \"tags\", \"name\", or \"prefix\" is required.\n\n%s", workspaceConfigurationHelp), cty.Path{cty.GetAttrStep{Name: "workspaces"}}, ) invalidWorkspaceConfigMisconfiguration = tfdiags.AttributeValue( tfdiags.Error, "Invalid workspaces configuration", - `Only one of workspace "name" or "prefix" is allowed.`, + fmt.Sprintf("Only one of workspace \"tags\", \"name\", or \"prefix\" is allowed.\n\n%s", workspaceConfigurationHelp), cty.Path{cty.GetAttrStep{Name: "workspaces"}}, ) ) diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index cfc8d3dce759..726ba0595e99 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -72,6 +72,7 @@ func testBackendDefault(t *testing.T) (*Cloud, func()) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }) return testBackend(t, obj) @@ -85,6 +86,7 @@ func testBackendNoDefault(t *testing.T) (*Cloud, func()) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.NullVal(cty.String), "prefix": cty.StringVal("my-app-"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }) return testBackend(t, obj) @@ -98,6 +100,7 @@ func testBackendNoOperations(t *testing.T) (*Cloud, func()) { "workspaces": cty.ObjectVal(map[string]cty.Value{ "name": cty.StringVal("prod"), "prefix": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }) return testBackend(t, obj) From 9bdf1d2579aa3afcd8ee18bbba009e3c0e3c8fe2 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 14 Sep 2021 15:20:04 -0500 Subject: [PATCH 212/644] Rename testBackendNoDefault "NoDefault" is now ambiguous with tags, and it does not imply using a prefix. --- internal/cloud/backend_apply_test.go | 8 ++++---- internal/cloud/backend_plan_test.go | 4 ++-- internal/cloud/backend_test.go | 6 +++--- internal/cloud/testing.go | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 8fa2d9758c01..090f767cc4cb 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -135,7 +135,7 @@ func TestCloud_applyCanceled(t *testing.T) { } func TestCloud_applyWithoutPermissions(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() // Create a named workspace without permissions. @@ -175,7 +175,7 @@ func TestCloud_applyWithoutPermissions(t *testing.T) { } func TestCloud_applyWithVCS(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() // Create a named workspace with a VCS. @@ -891,7 +891,7 @@ func TestCloud_applyDiscardedExternally(t *testing.T) { } func TestCloud_applyWithAutoApply(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() // Create a named workspace that auto applies. @@ -1005,7 +1005,7 @@ func TestCloud_applyForceLocal(t *testing.T) { } func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() ctx := context.Background() diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 45c1958b282e..a0a7ced71301 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -153,7 +153,7 @@ func TestCloud_planLongLine(t *testing.T) { } func TestCloud_planWithoutPermissions(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() // Create a named workspace without permissions. @@ -762,7 +762,7 @@ func TestCloud_planWithoutOperationsEntitlement(t *testing.T) { } func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() ctx := context.Background() diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index c5115d2005ca..5580cc925db6 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -33,8 +33,8 @@ func TestCloud_backendDefault(t *testing.T) { backend.TestBackendStateForceUnlock(t, b, b) } -func TestCloud_backendNoDefault(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) +func TestCloud_backendWithPrefix(t *testing.T) { + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() backend.TestBackendStates(t, b) @@ -573,7 +573,7 @@ func TestCloud_addAndRemoveWorkspacesDefault(t *testing.T) { } func TestCloud_addAndRemoveWorkspacesNoDefault(t *testing.T) { - b, bCleanup := testBackendNoDefault(t) + b, bCleanup := testBackendWithPrefix(t) defer bCleanup() states, err := b.Workspaces() diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index 726ba0595e99..c5bee1c02dce 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -78,7 +78,7 @@ func testBackendDefault(t *testing.T) (*Cloud, func()) { return testBackend(t, obj) } -func testBackendNoDefault(t *testing.T) (*Cloud, func()) { +func testBackendWithPrefix(t *testing.T) (*Cloud, func()) { obj := cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), From a97a1c8f66db4218f243d3f2b5dc59a9fc18a44b Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 14 Sep 2021 15:22:33 -0500 Subject: [PATCH 213/644] cloud.MockClient: Use Contains() to implement Search The TFC API doesn't behave this way; a search term just signals the substring was found within the name. --- internal/cloud/tfe_client_mock.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index d575d82e8d9b..2dea3096dbc1 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1103,7 +1103,7 @@ func (m *MockWorkspaces) List(ctx context.Context, organization string, options // Get all the workspaces that match the prefix. var ws []*tfe.Workspace for _, w := range m.workspaceIDs { - if strings.HasPrefix(w.Name, prefix) { + if strings.Contains(w.Name, prefix) { ws = append(ws, w) } } From 1791b711962a60e31233a979ca34dcef8843a182 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 15 Sep 2021 00:04:15 -0500 Subject: [PATCH 214/644] cloud: TestCloud_backendWithTags Implementing this test was quite a rabbithole, as in order to satisfy backendTestBackendStates() the workspaces returned from backend.Workspaces() must match exactly, and the shortcut taken to test pagination in 3cc58813f088fac3b9d008372052694ae1f75914 created an impossible circumstance that got plastered over with the fact that prefix filtering is done clientside, not by the API as it should be. Tagging does not rely on clientside filtering, and expects that the request made to the TFC API returns exactly those workspaces with the given tags. These changes include a better way to test pagination, wherein we actually create over a page worth of valid workspaces in the mock client and implement a simplified pagination behavior to match how the TFC API actually works. --- internal/backend/remote/backend_apply_test.go | 8 +- internal/cloud/backend_apply_test.go | 8 +- internal/cloud/backend_test.go | 24 ++++++ internal/cloud/testing.go | 18 +++++ internal/cloud/tfe_client_mock.go | 73 ++++++++++++------- 5 files changed, 91 insertions(+), 40 deletions(-) diff --git a/internal/backend/remote/backend_apply_test.go b/internal/backend/remote/backend_apply_test.go index 9b42860104e6..1f0d319bffff 100644 --- a/internal/backend/remote/backend_apply_test.go +++ b/internal/backend/remote/backend_apply_test.go @@ -777,9 +777,7 @@ func TestRemote_applyApprovedExternally(t *testing.T) { wl, err := b.client.Workspaces.List( ctx, b.organization, - tfe.WorkspaceListOptions{ - ListOptions: tfe.ListOptions{PageNumber: 2, PageSize: 10}, - }, + tfe.WorkspaceListOptions{}, ) if err != nil { t.Fatalf("unexpected error listing workspaces: %v", err) @@ -853,9 +851,7 @@ func TestRemote_applyDiscardedExternally(t *testing.T) { wl, err := b.client.Workspaces.List( ctx, b.organization, - tfe.WorkspaceListOptions{ - ListOptions: tfe.ListOptions{PageNumber: 2, PageSize: 10}, - }, + tfe.WorkspaceListOptions{}, ) if err != nil { t.Fatalf("unexpected error listing workspaces: %v", err) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 090f767cc4cb..99d74c1cc735 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -767,9 +767,7 @@ func TestCloud_applyApprovedExternally(t *testing.T) { wl, err := b.client.Workspaces.List( ctx, b.organization, - tfe.WorkspaceListOptions{ - ListOptions: tfe.ListOptions{PageNumber: 2, PageSize: 10}, - }, + tfe.WorkspaceListOptions{}, ) if err != nil { t.Fatalf("unexpected error listing workspaces: %v", err) @@ -843,9 +841,7 @@ func TestCloud_applyDiscardedExternally(t *testing.T) { wl, err := b.client.Workspaces.List( ctx, b.organization, - tfe.WorkspaceListOptions{ - ListOptions: tfe.ListOptions{PageNumber: 2, PageSize: 10}, - }, + tfe.WorkspaceListOptions{}, ) if err != nil { t.Fatalf("unexpected error listing workspaces: %v", err) diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 5580cc925db6..928182b5358c 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -40,6 +40,30 @@ func TestCloud_backendWithPrefix(t *testing.T) { backend.TestBackendStates(t, b) } +func TestCloud_backendWithTags(t *testing.T) { + b, bCleanup := testBackendWithTags(t) + defer bCleanup() + + backend.TestBackendStates(t, b) + + // Test pagination works + for i := 0; i < 25; i++ { + _, err := b.StateMgr(fmt.Sprintf("foo-%d", i+1)) + if err != nil { + t.Fatalf("error: %s", err) + } + } + + workspaces, err := b.Workspaces() + if err != nil { + t.Fatalf("error: %s", err) + } + actual := len(workspaces) + if actual != 26 { + t.Errorf("expected 26 workspaces (over one standard paginated response), got %d", actual) + } +} + func TestCloud_PrepareConfig(t *testing.T) { cases := map[string]struct { config cty.Value diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index c5bee1c02dce..d289a42c2d52 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -92,6 +92,24 @@ func testBackendWithPrefix(t *testing.T) (*Cloud, func()) { return testBackend(t, obj) } +func testBackendWithTags(t *testing.T) (*Cloud, func()) { + obj := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), + }), + }) + return testBackend(t, obj) +} + func testBackendNoOperations(t *testing.T) (*Cloud, func()) { obj := cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index 2dea3096dbc1..fd93c48d9577 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1091,20 +1091,36 @@ func newMockWorkspaces(client *MockClient) *MockWorkspaces { } func (m *MockWorkspaces) List(ctx context.Context, organization string, options tfe.WorkspaceListOptions) (*tfe.WorkspaceList, error) { - dummyWorkspaces := 10 wl := &tfe.WorkspaceList{} - // Get the prefix from the search options. - prefix := "" + // Get all the workspaces that match the Search value + searchValue := "" if options.Search != nil { - prefix = *options.Search + searchValue = *options.Search } - // Get all the workspaces that match the prefix. var ws []*tfe.Workspace + var tags []string + + if options.Tags != nil { + tags = strings.Split(*options.Tags, ",") + } for _, w := range m.workspaceIDs { - if strings.Contains(w.Name, prefix) { - ws = append(ws, w) + wTags := make(map[string]struct{}) + for _, wTag := range w.Tags { + wTags[wTag.Name] = struct{}{} + } + + if strings.Contains(w.Name, searchValue) { + tagsSatisfied := true + for _, tag := range tags { + if _, ok := wTags[tag]; !ok { + tagsSatisfied = false + } + } + if tagsSatisfied { + ws = append(ws, w) + } } } @@ -1116,32 +1132,27 @@ func (m *MockWorkspaces) List(ctx context.Context, organization string, options return wl, nil } - // Return dummy workspaces for the first page to test pagination. - if options.PageNumber <= 1 { - for i := 0; i < dummyWorkspaces; i++ { - wl.Items = append(wl.Items, &tfe.Workspace{ - ID: GenerateID("ws-"), - Name: fmt.Sprintf("dummy-workspace-%d", i), - }) - } + numPages := (len(ws) / 20) + 1 + currentPage := 1 + if options.PageNumber != 0 { + currentPage = options.PageNumber + } + previousPage := currentPage - 1 + nextPage := currentPage + 1 - wl.Pagination = &tfe.Pagination{ - CurrentPage: 1, - NextPage: 2, - TotalPages: 2, - TotalCount: len(wl.Items) + len(ws), + for i := ((currentPage - 1) * 20); i < ((currentPage-1)*20)+20; i++ { + if i > (len(ws) - 1) { + break } - - return wl, nil + wl.Items = append(wl.Items, ws[i]) } - // Return the actual workspaces that matched as the second page. - wl.Items = ws wl.Pagination = &tfe.Pagination{ - CurrentPage: 2, - PreviousPage: 1, - TotalPages: 2, - TotalCount: len(wl.Items) + dummyWorkspaces, + CurrentPage: currentPage, + NextPage: nextPage, + PreviousPage: previousPage, + TotalPages: numPages, + TotalCount: len(wl.Items), } return wl, nil @@ -1173,6 +1184,12 @@ func (m *MockWorkspaces) Create(ctx context.Context, organization string, option } else { w.TerraformVersion = tfversion.String() } + var tags []*tfe.Tag + for _, tag := range options.Tags { + tags = append(tags, tag) + w.TagNames = append(w.TagNames, tag.Name) + } + w.Tags = tags m.workspaceIDs[w.ID] = w m.workspaceNames[w.Name] = w return w, nil From 594a390f848833298c75ce7096e173e23d397de0 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 22 Sep 2021 17:59:47 -0400 Subject: [PATCH 215/644] Use context parallelism --- internal/cloud/backend_apply.go | 2 +- internal/cloud/backend_apply_test.go | 6 ++++-- internal/cloud/backend_plan.go | 2 +- internal/cloud/backend_plan_test.go | 6 ++++-- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/internal/cloud/backend_apply.go b/internal/cloud/backend_apply.go index b52719593500..74d167673848 100644 --- a/internal/cloud/backend_apply.go +++ b/internal/cloud/backend_apply.go @@ -42,7 +42,7 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio return nil, diags.Err() } - if op.Parallelism != defaultParallelism { + if b.ContextOpts != nil && b.ContextOpts.Parallelism != defaultParallelism { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Custom parallelism values are currently not supported", diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 99d74c1cc735..629074e0a079 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -46,7 +46,6 @@ func testOperationApplyWithTimeout(t *testing.T, configDir string, timeout time. return &backend.Operation{ ConfigDir: configDir, ConfigLoader: configLoader, - Parallelism: defaultParallelism, PlanRefresh: true, StateLocker: clistate.NewLocker(timeout, stateLockerView), Type: backend.OperationTypeApply, @@ -223,7 +222,10 @@ func TestCloud_applyWithParallelism(t *testing.T) { op, configCleanup, done := testOperationApply(t, "./testdata/apply") defer configCleanup() - op.Parallelism = 3 + if b.ContextOpts == nil { + b.ContextOpts = &terraform.ContextOpts{} + } + b.ContextOpts.Parallelism = 3 op.Workspace = backend.DefaultStateName run, err := b.Operation(context.Background(), op) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 3e3916b36ca5..693210d4f05d 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -38,7 +38,7 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation return nil, diags.Err() } - if op.Parallelism != defaultParallelism { + if b.ContextOpts != nil && b.ContextOpts.Parallelism != defaultParallelism { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Custom parallelism values are currently not supported", diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index a0a7ced71301..1dcfdeb07ccb 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -44,7 +44,6 @@ func testOperationPlanWithTimeout(t *testing.T, configDir string, timeout time.D return &backend.Operation{ ConfigDir: configDir, ConfigLoader: configLoader, - Parallelism: defaultParallelism, PlanRefresh: true, StateLocker: clistate.NewLocker(timeout, stateLockerView), Type: backend.OperationTypePlan, @@ -198,7 +197,10 @@ func TestCloud_planWithParallelism(t *testing.T) { op, configCleanup, done := testOperationPlan(t, "./testdata/plan") defer configCleanup() - op.Parallelism = 3 + if b.ContextOpts == nil { + b.ContextOpts = &terraform.ContextOpts{} + } + b.ContextOpts.Parallelism = 3 op.Workspace = backend.DefaultStateName run, err := b.Operation(context.Background(), op) From a94b2405b18b70d6ea0982540769b6d9b36a0911 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 22 Sep 2021 18:12:51 -0400 Subject: [PATCH 216/644] static checker --- internal/cloud/backend.go | 3 ++- internal/cloud/backend_apply_test.go | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 9d7d2e5fc4ee..09a9995c7b08 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -922,7 +922,7 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di // If the workspace has remote operations disabled, the remote Terraform // version is effectively meaningless, so we'll skip version verification. - if workspace.Operations == false { + if !workspace.Operations { return nil } @@ -1002,6 +1002,7 @@ func (b *Cloud) IsLocalOperations() bool { // as a helper to wrap any potentially colored strings. // // TODO SvH: Rename this back to Colorize as soon as we can pass -no-color. +//lint:ignore U1000 see above todo func (b *Cloud) cliColorize() *colorstring.Colorize { if b.CLIColor != nil { return b.CLIColor diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 629074e0a079..1af4b4726af3 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -1592,8 +1592,9 @@ func TestCloud_applyVersionCheck(t *testing.T) { } // RUN: prepare the apply operation and run it - op, configCleanup, done := testOperationApply(t, "./testdata/apply") + op, configCleanup, opDone := testOperationApply(t, "./testdata/apply") defer configCleanup() + defer opDone(t) streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) From d2b6b5f2b392894e7241231f5eaa13b9a2811020 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 20 Sep 2021 13:07:53 -0500 Subject: [PATCH 217/644] cloud: Align local and remote workspace name with 'name' strategy This changes the 'name' strategy to always align the local configured workspace name and the remote Terraform Cloud workspace, rather than the implicit use of the 'default' unnamed workspace being used instead. What this essentially means is that the Cloud integration does not fully support workspaces when configured for a single TFC workspace (as was the case with the 'remote' backend), but *does* use the backend.Workspaces() interface to allow for normal local behaviors like terraform.workspace to resolve to the correct name. It does this by always setting the local workspace name when the 'name' strategy is used, as a part of initialization. Part of the diff here is exporting all the previously unexported types for mapping workspaces. The command package (and init in particular) needs to be able to handle setting the local workspace in this particular scenario. --- internal/cloud/backend.go | 151 ++++++++++++------------- internal/cloud/backend_apply_test.go | 78 ++++++------- internal/cloud/backend_context.go | 6 +- internal/cloud/backend_context_test.go | 8 +- internal/cloud/backend_plan_test.go | 72 ++++++------ internal/cloud/backend_state_test.go | 5 +- internal/cloud/backend_test.go | 79 +++++++------ internal/cloud/testing.go | 11 +- 8 files changed, 202 insertions(+), 208 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 09a9995c7b08..22adb98d175d 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -64,9 +64,9 @@ type Cloud struct { // organization is the organization that contains the target workspaces. organization string - // workspaceMapping contains strategies for mapping CLI workspaces in the working directory + // WorkspaceMapping contains strategies for mapping CLI workspaces in the working directory // to remote Terraform Cloud workspaces. - workspaceMapping workspaceMapping + WorkspaceMapping WorkspaceMapping // services is used for service discovery services *disco.Disco @@ -157,28 +157,28 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { diags = diags.Append(invalidOrganizationConfigMissingValue) } - workspaceMapping := workspaceMapping{} + WorkspaceMapping := WorkspaceMapping{} if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { if val := workspaces.GetAttr("name"); !val.IsNull() { - workspaceMapping.name = val.AsString() + WorkspaceMapping.Name = val.AsString() } if val := workspaces.GetAttr("prefix"); !val.IsNull() { - workspaceMapping.prefix = val.AsString() + WorkspaceMapping.Prefix = val.AsString() } if val := workspaces.GetAttr("tags"); !val.IsNull() { - err := gocty.FromCtyValue(val, &workspaceMapping.tags) + err := gocty.FromCtyValue(val, &WorkspaceMapping.Tags) if err != nil { log.Panicf("An unxpected error occurred: %s", err) } } } - switch workspaceMapping.strategy() { + switch WorkspaceMapping.Strategy() { // Make sure have a workspace mapping strategy present - case workspaceNoneStrategy: + case WorkspaceNoneStrategy: diags = diags.Append(invalidWorkspaceConfigMissingValues) // Make sure that only one of workspace name or a prefix is configured. - case workspaceInvalidStrategy: + case WorkspaceInvalidStrategy: diags = diags.Append(invalidWorkspaceConfigMisconfiguration) } @@ -335,10 +335,10 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { // PrepareConfig checks that you cannot set both of these. if val := workspaces.GetAttr("name"); !val.IsNull() { - b.workspaceMapping.name = val.AsString() + b.WorkspaceMapping.Name = val.AsString() } if val := workspaces.GetAttr("prefix"); !val.IsNull() { - b.workspaceMapping.prefix = val.AsString() + b.WorkspaceMapping.Prefix = val.AsString() } if val := workspaces.GetAttr("tags"); !val.IsNull() { var tags []string @@ -347,7 +347,7 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { log.Panicf("An unxpected error occurred: %s", err) } - b.workspaceMapping.tags = tags + b.WorkspaceMapping.Tags = tags } } @@ -530,31 +530,30 @@ func (b *Cloud) retryLogHook(attemptNum int, resp *http.Response) { } } -// Workspaces implements backend.Enhanced. +// Workspaces implements backend.Enhanced, returning a filtered list of workspace names according to +// the workspace mapping strategy configured. func (b *Cloud) Workspaces() ([]string, error) { - if b.workspaceMapping.strategy() == workspaceNameStrategy { - return nil, backend.ErrWorkspacesNotSupported + // Create a slice to contain all the names. + var names []string + + // If configured for a single workspace, return that exact name only. The StateMgr for this + // backend will automatically create the remote workspace if it does not yet exist. + if b.WorkspaceMapping.Strategy() == WorkspaceNameStrategy { + names = append(names, b.WorkspaceMapping.Name) + return names, nil } - return b.workspaces() -} -// workspaces returns a filtered list of remote workspace names according to the workspace mapping -// strategy configured. -func (b *Cloud) workspaces() ([]string, error) { + // Otherwise, multiple workspaces are being mapped. Query Terraform Cloud for all the remote + // workspaces by the provided mapping strategy. options := tfe.WorkspaceListOptions{} - switch b.workspaceMapping.strategy() { - case workspaceNameStrategy: - options.Search = tfe.String(b.workspaceMapping.name) - case workspacePrefixStrategy: - options.Search = tfe.String(b.workspaceMapping.prefix) - case workspaceTagsStrategy: - taglist := strings.Join(b.workspaceMapping.tags, ",") + switch b.WorkspaceMapping.Strategy() { + case WorkspacePrefixStrategy: + options.Search = tfe.String(b.WorkspaceMapping.Prefix) + case WorkspaceTagsStrategy: + taglist := strings.Join(b.WorkspaceMapping.Tags, ",") options.Tags = &taglist } - // Create a slice to contain all the names. - var names []string - for { wl, err := b.client.Workspaces.List(context.Background(), b.organization, options) if err != nil { @@ -562,20 +561,15 @@ func (b *Cloud) workspaces() ([]string, error) { } for _, w := range wl.Items { - switch b.workspaceMapping.strategy() { - case workspaceNameStrategy: - if w.Name == b.workspaceMapping.name { - names = append(names, backend.DefaultStateName) - continue - } - case workspacePrefixStrategy: - if strings.HasPrefix(w.Name, b.workspaceMapping.prefix) { - names = append(names, strings.TrimPrefix(w.Name, b.workspaceMapping.prefix)) + switch b.WorkspaceMapping.Strategy() { + case WorkspacePrefixStrategy: + if strings.HasPrefix(w.Name, b.WorkspaceMapping.Prefix) { + names = append(names, strings.TrimPrefix(w.Name, b.WorkspaceMapping.Prefix)) continue } default: - // Pass-through. "name" and "prefix" strategies are naive and do - // client-side filtering above, but for tags and any other future + // Pass-through. The "prefix" strategy is naive and does + // client-side filtering, but for tags and any other future // strategy this filtering should be left to the API. names = append(names, w.Name) } @@ -598,19 +592,18 @@ func (b *Cloud) workspaces() ([]string, error) { // DeleteWorkspace implements backend.Enhanced. func (b *Cloud) DeleteWorkspace(name string) error { - if b.workspaceMapping.strategy() != workspaceNameStrategy && name == backend.DefaultStateName { + if name == backend.DefaultStateName { return backend.ErrDefaultWorkspaceNotSupported } - if b.workspaceMapping.strategy() == workspaceNameStrategy && name != backend.DefaultStateName { + + if b.WorkspaceMapping.Strategy() == WorkspaceNameStrategy { return backend.ErrWorkspacesNotSupported } // Configure the remote workspace name. switch { - case name == backend.DefaultStateName: - name = b.workspaceMapping.name - case b.workspaceMapping.strategy() == workspacePrefixStrategy && !strings.HasPrefix(name, b.workspaceMapping.prefix): - name = b.workspaceMapping.prefix + name + case b.WorkspaceMapping.Strategy() == WorkspacePrefixStrategy && !strings.HasPrefix(name, b.WorkspaceMapping.Prefix): + name = b.WorkspaceMapping.Prefix + name } client := &remoteClient{ @@ -626,19 +619,17 @@ func (b *Cloud) DeleteWorkspace(name string) error { // StateMgr implements backend.Enhanced. func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { - if b.workspaceMapping.strategy() != workspaceNameStrategy && name == backend.DefaultStateName { + if name == backend.DefaultStateName { return nil, backend.ErrDefaultWorkspaceNotSupported } - if b.workspaceMapping.strategy() == workspaceNameStrategy && name != backend.DefaultStateName { + + if b.WorkspaceMapping.Strategy() == WorkspaceNameStrategy && name != b.WorkspaceMapping.Name { return nil, backend.ErrWorkspacesNotSupported } - // Configure the remote workspace name. - switch { - case name == backend.DefaultStateName: - name = b.workspaceMapping.name - case b.workspaceMapping.strategy() == workspacePrefixStrategy && !strings.HasPrefix(name, b.workspaceMapping.prefix): - name = b.workspaceMapping.prefix + name + // If the prefix strategy is used, translate the local name to the TFC workspace name. + if b.WorkspaceMapping.Strategy() == WorkspacePrefixStrategy { + name = b.WorkspaceMapping.Prefix + name } workspace, err := b.client.Workspaces.Read(context.Background(), b.organization, name) @@ -652,7 +643,7 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { } var tags []*tfe.Tag - for _, tag := range b.workspaceMapping.tags { + for _, tag := range b.WorkspaceMapping.Tags { t := tfe.Tag{Name: tag} tags = append(tags, &t) } @@ -698,13 +689,11 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { // Operation implements backend.Enhanced. func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend.RunningOperation, error) { - // Get the remote workspace name. name := op.Workspace - switch { - case op.Workspace == backend.DefaultStateName: - name = b.workspaceMapping.name - case b.workspaceMapping.strategy() == workspacePrefixStrategy && !strings.HasPrefix(op.Workspace, b.workspaceMapping.prefix): - name = b.workspaceMapping.prefix + op.Workspace + + // If the prefix strategy is used, translate the local name to the TFC workspace name. + if b.WorkspaceMapping.Strategy() == WorkspacePrefixStrategy { + name = b.WorkspaceMapping.Prefix + op.Workspace } // Retrieve the workspace for this operation. @@ -1014,35 +1003,35 @@ func (b *Cloud) cliColorize() *colorstring.Colorize { } } -type workspaceMapping struct { - name string - prefix string - tags []string +type WorkspaceMapping struct { + Name string + Prefix string + Tags []string } type workspaceStrategy string const ( - workspaceTagsStrategy workspaceStrategy = "tags" - workspaceNameStrategy workspaceStrategy = "name" - workspacePrefixStrategy workspaceStrategy = "prefix" - workspaceNoneStrategy workspaceStrategy = "none" - workspaceInvalidStrategy workspaceStrategy = "invalid" + WorkspaceTagsStrategy workspaceStrategy = "tags" + WorkspaceNameStrategy workspaceStrategy = "name" + WorkspacePrefixStrategy workspaceStrategy = "prefix" + WorkspaceNoneStrategy workspaceStrategy = "none" + WorkspaceInvalidStrategy workspaceStrategy = "invalid" ) -func (wm workspaceMapping) strategy() workspaceStrategy { +func (wm WorkspaceMapping) Strategy() workspaceStrategy { switch { - case len(wm.tags) > 0 && wm.name == "" && wm.prefix == "": - return workspaceTagsStrategy - case len(wm.tags) == 0 && wm.name != "" && wm.prefix == "": - return workspaceNameStrategy - case len(wm.tags) == 0 && wm.name == "" && wm.prefix != "": - return workspacePrefixStrategy - case len(wm.tags) == 0 && wm.name == "" && wm.prefix == "": - return workspaceNoneStrategy + case len(wm.Tags) > 0 && wm.Name == "" && wm.Prefix == "": + return WorkspaceTagsStrategy + case len(wm.Tags) == 0 && wm.Name != "" && wm.Prefix == "": + return WorkspaceNameStrategy + case len(wm.Tags) == 0 && wm.Name == "" && wm.Prefix != "": + return WorkspacePrefixStrategy + case len(wm.Tags) == 0 && wm.Name == "" && wm.Prefix == "": + return WorkspaceNoneStrategy default: // Any other combination is invalid as each strategy is mutually exclusive - return workspaceInvalidStrategy + return WorkspaceInvalidStrategy } } diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 1af4b4726af3..9f464c3f3722 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -67,7 +67,7 @@ func TestCloud_applyBasic(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -97,7 +97,7 @@ func TestCloud_applyBasic(t *testing.T) { t.Fatalf("expected apply summery in output: %s", output) } - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) // An error suggests that the state was not unlocked after apply if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { t.Fatalf("unexpected error locking state after apply: %s", err.Error()) @@ -112,7 +112,7 @@ func TestCloud_applyCanceled(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -127,7 +127,7 @@ func TestCloud_applyCanceled(t *testing.T) { t.Fatal("expected apply operation to fail") } - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { t.Fatalf("unexpected error locking state after cancelling apply: %s", err.Error()) } @@ -142,7 +142,7 @@ func TestCloud_applyWithoutPermissions(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspaceMapping.prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), }, ) if err != nil { @@ -182,7 +182,7 @@ func TestCloud_applyWithVCS(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspaceMapping.prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), VCSRepo: &tfe.VCSRepoOptions{}, }, ) @@ -226,7 +226,7 @@ func TestCloud_applyWithParallelism(t *testing.T) { b.ContextOpts = &terraform.ContextOpts{} } b.ContextOpts.Parallelism = 3 - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -253,7 +253,7 @@ func TestCloud_applyWithPlan(t *testing.T) { defer configCleanup() op.PlanFile = &planfile.Reader{} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -284,7 +284,7 @@ func TestCloud_applyWithoutRefresh(t *testing.T) { defer done(t) op.PlanRefresh = false - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -322,7 +322,7 @@ func TestCloud_applyWithoutRefreshIncompatibleAPIVersion(t *testing.T) { b.client.SetFakeRemoteAPIVersion("2.3") op.PlanRefresh = false - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -353,7 +353,7 @@ func TestCloud_applyWithRefreshOnly(t *testing.T) { defer done(t) op.PlanMode = plans.RefreshOnlyMode - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -391,7 +391,7 @@ func TestCloud_applyWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { b.client.SetFakeRemoteAPIVersion("2.3") op.PlanMode = plans.RefreshOnlyMode - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -424,7 +424,7 @@ func TestCloud_applyWithTarget(t *testing.T) { addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") op.Targets = []addrs.Targetable{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -466,7 +466,7 @@ func TestCloud_applyWithTargetIncompatibleAPIVersion(t *testing.T) { addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") op.Targets = []addrs.Targetable{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -499,7 +499,7 @@ func TestCloud_applyWithReplace(t *testing.T) { addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") op.ForceReplace = []addrs.AbsResourceInstance{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -539,7 +539,7 @@ func TestCloud_applyWithReplaceIncompatibleAPIVersion(t *testing.T) { addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") op.ForceReplace = []addrs.AbsResourceInstance{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -569,7 +569,7 @@ func TestCloud_applyWithVariables(t *testing.T) { defer configCleanup() op.Variables = testVariables(terraform.ValueFromNamedFile, "foo", "bar") - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -595,7 +595,7 @@ func TestCloud_applyNoConfig(t *testing.T) { op, configCleanup, done := testOperationApply(t, "./testdata/empty") defer configCleanup() - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -616,7 +616,7 @@ func TestCloud_applyNoConfig(t *testing.T) { t.Fatalf("expected configuration files error, got: %v", errOutput) } - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) // An error suggests that the state was not unlocked after apply if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { t.Fatalf("unexpected error locking state after failed apply: %s", err.Error()) @@ -631,7 +631,7 @@ func TestCloud_applyNoChanges(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -668,7 +668,7 @@ func TestCloud_applyNoApprove(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -709,7 +709,7 @@ func TestCloud_applyAutoApprove(t *testing.T) { op.AutoApprove = true op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -754,7 +754,7 @@ func TestCloud_applyApprovedExternally(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName ctx := context.Background() @@ -828,7 +828,7 @@ func TestCloud_applyDiscardedExternally(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName ctx := context.Background() @@ -898,7 +898,7 @@ func TestCloud_applyWithAutoApply(t *testing.T) { b.organization, tfe.WorkspaceCreateOptions{ AutoApply: tfe.Bool(true), - Name: tfe.String(b.workspaceMapping.prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), }, ) if err != nil { @@ -967,7 +967,7 @@ func TestCloud_applyForceLocal(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) @@ -1013,7 +1013,7 @@ func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspaceMapping.prefix + "no-operations"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "no-operations"), }, ) if err != nil { @@ -1072,7 +1072,7 @@ func TestCloud_applyLockTimeout(t *testing.T) { ctx := context.Background() // Retrieve the workspace used to run this operation in. - w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspaceMapping.name) + w, err := b.client.Workspaces.Read(ctx, b.organization, b.WorkspaceMapping.Name) if err != nil { t.Fatalf("error retrieving workspace: %v", err) } @@ -1103,7 +1103,7 @@ func TestCloud_applyLockTimeout(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName _, err = b.Operation(context.Background(), op) if err != nil { @@ -1154,7 +1154,7 @@ func TestCloud_applyDestroy(t *testing.T) { op.PlanMode = plans.DestroyMode op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1200,7 +1200,7 @@ func TestCloud_applyDestroyNoConfig(t *testing.T) { op.PlanMode = plans.DestroyMode op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1234,7 +1234,7 @@ func TestCloud_applyPolicyPass(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1281,7 +1281,7 @@ func TestCloud_applyPolicyHardFail(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1337,7 +1337,7 @@ func TestCloud_applyPolicySoftFail(t *testing.T) { op.AutoApprove = false op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1383,7 +1383,7 @@ func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { op.AutoApprove = true op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1432,7 +1432,7 @@ func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { b.organization, tfe.WorkspaceCreateOptions{ AutoApply: tfe.Bool(true), - Name: tfe.String(b.workspaceMapping.prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), }, ) if err != nil { @@ -1492,7 +1492,7 @@ func TestCloud_applyWithRemoteError(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1581,7 +1581,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { _, err := b.client.Workspaces.Update( ctx, b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ Operations: tfe.Bool(tc.hasOperations), TerraformVersion: tfe.String(tc.remoteVersion), @@ -1606,7 +1606,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(ctx, op) if err != nil { diff --git a/internal/cloud/backend_context.go b/internal/cloud/backend_context.go index 32a1e52a2583..95c80c5cbf49 100644 --- a/internal/cloud/backend_context.go +++ b/internal/cloud/backend_context.go @@ -143,9 +143,9 @@ func (b *Cloud) getRemoteWorkspaceName(localWorkspaceName string) string { // The default workspace name is a special case, for when the backend // is configured to with to an exact remote workspace rather than with // a remote workspace _prefix_. - return b.workspaceMapping.name - case b.workspaceMapping.prefix != "" && !strings.HasPrefix(localWorkspaceName, b.workspaceMapping.prefix): - return b.workspaceMapping.prefix + localWorkspaceName + return b.WorkspaceMapping.Name + case b.WorkspaceMapping.Prefix != "" && !strings.HasPrefix(localWorkspaceName, b.WorkspaceMapping.Prefix): + return b.WorkspaceMapping.Prefix + localWorkspaceName default: return localWorkspaceName } diff --git a/internal/cloud/backend_context_test.go b/internal/cloud/backend_context_test.go index 683ad98ebaa2..7a7668a83a3a 100644 --- a/internal/cloud/backend_context_test.go +++ b/internal/cloud/backend_context_test.go @@ -182,7 +182,7 @@ func TestRemoteContextWithVars(t *testing.T) { _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) defer configCleanup() - workspaceID, err := b.getRemoteWorkspaceID(context.Background(), backend.DefaultStateName) + workspaceID, err := b.getRemoteWorkspaceID(context.Background(), testBackendSingleWorkspaceName) if err != nil { t.Fatal(err) } @@ -194,7 +194,7 @@ func TestRemoteContextWithVars(t *testing.T) { ConfigDir: configDir, ConfigLoader: configLoader, StateLocker: clistate.NewLocker(0, view), - Workspace: backend.DefaultStateName, + Workspace: testBackendSingleWorkspaceName, } v := test.Opts @@ -216,7 +216,7 @@ func TestRemoteContextWithVars(t *testing.T) { } // When Context() returns an error, it should unlock the state, // so re-locking it is expected to succeed. - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { t.Fatalf("unexpected error locking state: %s", err.Error()) } @@ -225,7 +225,7 @@ func TestRemoteContextWithVars(t *testing.T) { t.Fatalf("unexpected error\ngot: %s\nwant: ", diags.Err().Error()) } // When Context() succeeds, this should fail w/ "workspace already locked" - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err == nil { t.Fatal("unexpected success locking state after Context") } diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 1dcfdeb07ccb..a76841f2b225 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -59,7 +59,7 @@ func TestCloud_planBasic(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -82,7 +82,7 @@ func TestCloud_planBasic(t *testing.T) { t.Fatalf("expected plan summary in output: %s", output) } - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) // An error suggests that the state was not unlocked after the operation finished if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { t.Fatalf("unexpected error locking state after successful plan: %s", err.Error()) @@ -97,7 +97,7 @@ func TestCloud_planCanceled(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -112,7 +112,7 @@ func TestCloud_planCanceled(t *testing.T) { t.Fatal("expected plan operation to fail") } - stateMgr, _ := b.StateMgr(backend.DefaultStateName) + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) // An error suggests that the state was not unlocked after the operation finished if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { t.Fatalf("unexpected error locking state after cancelled plan: %s", err.Error()) @@ -127,7 +127,7 @@ func TestCloud_planLongLine(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -160,7 +160,7 @@ func TestCloud_planWithoutPermissions(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspaceMapping.prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), }, ) if err != nil { @@ -201,7 +201,7 @@ func TestCloud_planWithParallelism(t *testing.T) { b.ContextOpts = &terraform.ContextOpts{} } b.ContextOpts.Parallelism = 3 - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -228,7 +228,7 @@ func TestCloud_planWithPlan(t *testing.T) { defer configCleanup() op.PlanFile = &planfile.Reader{} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -258,7 +258,7 @@ func TestCloud_planWithPath(t *testing.T) { defer configCleanup() op.PlanOutPath = "./testdata/plan" - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -289,7 +289,7 @@ func TestCloud_planWithoutRefresh(t *testing.T) { defer done(t) op.PlanRefresh = false - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -327,7 +327,7 @@ func TestCloud_planWithoutRefreshIncompatibleAPIVersion(t *testing.T) { b.client.SetFakeRemoteAPIVersion("2.3") op.PlanRefresh = false - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -358,7 +358,7 @@ func TestCloud_planWithRefreshOnly(t *testing.T) { defer done(t) op.PlanMode = plans.RefreshOnlyMode - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -396,7 +396,7 @@ func TestCloud_planWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { b.client.SetFakeRemoteAPIVersion("2.3") op.PlanMode = plans.RefreshOnlyMode - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -452,7 +452,7 @@ func TestCloud_planWithTarget(t *testing.T) { addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") op.Targets = []addrs.Targetable{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -501,7 +501,7 @@ func TestCloud_planWithTargetIncompatibleAPIVersion(t *testing.T) { addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") op.Targets = []addrs.Targetable{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -534,7 +534,7 @@ func TestCloud_planWithReplace(t *testing.T) { addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") op.ForceReplace = []addrs.AbsResourceInstance{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -574,7 +574,7 @@ func TestCloud_planWithReplaceIncompatibleAPIVersion(t *testing.T) { addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") op.ForceReplace = []addrs.AbsResourceInstance{addr} - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -604,7 +604,7 @@ func TestCloud_planWithVariables(t *testing.T) { defer configCleanup() op.Variables = testVariables(terraform.ValueFromCLIArg, "foo", "bar") - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -630,7 +630,7 @@ func TestCloud_planNoConfig(t *testing.T) { op, configCleanup, done := testOperationPlan(t, "./testdata/empty") defer configCleanup() - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -660,7 +660,7 @@ func TestCloud_planNoChanges(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -699,7 +699,7 @@ func TestCloud_planForceLocal(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) @@ -735,7 +735,7 @@ func TestCloud_planWithoutOperationsEntitlement(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName streams, done := terminal.StreamsForTesting(t) view := views.NewOperation(arguments.ViewHuman, false, views.NewView(streams)) @@ -774,7 +774,7 @@ func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspaceMapping.prefix + "no-operations"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "no-operations"), }, ) if err != nil { @@ -820,7 +820,7 @@ func TestCloud_planLockTimeout(t *testing.T) { ctx := context.Background() // Retrieve the workspace used to run this operation in. - w, err := b.client.Workspaces.Read(ctx, b.organization, b.workspaceMapping.name) + w, err := b.client.Workspaces.Read(ctx, b.organization, b.WorkspaceMapping.Name) if err != nil { t.Fatalf("error retrieving workspace: %v", err) } @@ -851,7 +851,7 @@ func TestCloud_planLockTimeout(t *testing.T) { op.UIIn = input op.UIOut = b.CLI - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName _, err = b.Operation(context.Background(), op) if err != nil { @@ -893,7 +893,7 @@ func TestCloud_planDestroy(t *testing.T) { defer done(t) op.PlanMode = plans.DestroyMode - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -918,7 +918,7 @@ func TestCloud_planDestroyNoConfig(t *testing.T) { defer done(t) op.PlanMode = plans.DestroyMode - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -943,7 +943,7 @@ func TestCloud_planWithWorkingDirectory(t *testing.T) { } // Configure the workspace to use a custom working directory. - _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspaceMapping.name, options) + _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.WorkspaceMapping.Name, options) if err != nil { t.Fatalf("error configuring working directory: %v", err) } @@ -952,7 +952,7 @@ func TestCloud_planWithWorkingDirectory(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -988,7 +988,7 @@ func TestCloud_planWithWorkingDirectoryFromCurrentPath(t *testing.T) { } // Configure the workspace to use a custom working directory. - _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.workspaceMapping.name, options) + _, err := b.client.Workspaces.Update(context.Background(), b.organization, b.WorkspaceMapping.Name, options) if err != nil { t.Fatalf("error configuring working directory: %v", err) } @@ -1011,7 +1011,7 @@ func TestCloud_planWithWorkingDirectoryFromCurrentPath(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1043,7 +1043,7 @@ func TestCloud_planCostEstimation(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1078,7 +1078,7 @@ func TestCloud_planPolicyPass(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1112,7 +1112,7 @@ func TestCloud_planPolicyHardFail(t *testing.T) { op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-hard-failed") defer configCleanup() - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1152,7 +1152,7 @@ func TestCloud_planPolicySoftFail(t *testing.T) { op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-soft-failed") defer configCleanup() - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { @@ -1193,7 +1193,7 @@ func TestCloud_planWithRemoteError(t *testing.T) { defer configCleanup() defer done(t) - op.Workspace = backend.DefaultStateName + op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) if err != nil { diff --git a/internal/cloud/backend_state_test.go b/internal/cloud/backend_state_test.go index a94c60c6ee3f..e39dd211f19b 100644 --- a/internal/cloud/backend_state_test.go +++ b/internal/cloud/backend_state_test.go @@ -5,7 +5,6 @@ import ( "os" "testing" - "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/states" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statefile" @@ -24,12 +23,12 @@ func TestRemoteClient_stateLock(t *testing.T) { b, bCleanup := testBackendDefault(t) defer bCleanup() - s1, err := b.StateMgr(backend.DefaultStateName) + s1, err := b.StateMgr(testBackendSingleWorkspaceName) if err != nil { t.Fatalf("expected no error, got %v", err) } - s2, err := b.StateMgr(backend.DefaultStateName) + s2, err := b.StateMgr(testBackendSingleWorkspaceName) if err != nil { t.Fatalf("expected no error, got %v", err) } diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 928182b5358c..9f1a5190b288 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -24,13 +24,30 @@ func TestCloud(t *testing.T) { var _ backend.CLI = New(nil) } -func TestCloud_backendDefault(t *testing.T) { +func TestCloud_backendWithName(t *testing.T) { b, bCleanup := testBackendDefault(t) defer bCleanup() - backend.TestBackendStates(t, b) - backend.TestBackendStateLocks(t, b, b) - backend.TestBackendStateForceUnlock(t, b, b) + workspaces, err := b.Workspaces() + if err != nil { + t.Fatalf("error: %v", err) + } + + if len(workspaces) != 1 || workspaces[0] != testBackendSingleWorkspaceName { + t.Fatalf("should only have a single configured workspace matching the configured 'name' strategy, but got: %#v", workspaces) + } + + if _, err := b.StateMgr("foo"); err != backend.ErrWorkspacesNotSupported { + t.Fatalf("expected fetching a state which is NOT the single configured workspace to have an ErrWorkspacesNotSupported error, but got: %v", err) + } + + if err := b.DeleteWorkspace(testBackendSingleWorkspaceName); err != backend.ErrWorkspacesNotSupported { + t.Fatalf("expected deleting the single configured workspace name to result in an error, but got: %v", err) + } + + if err := b.DeleteWorkspace("foo"); err != backend.ErrWorkspacesNotSupported { + t.Fatalf("expected deleting a workspace which is NOT the configured workspace name to result in an error, but got: %v", err) + } } func TestCloud_backendWithPrefix(t *testing.T) { @@ -428,15 +445,15 @@ func TestCloud_setConfigurationFields(t *testing.T) { if tc.expectedOrganziation != "" && b.organization != tc.expectedOrganziation { t.Fatalf("%s: expected organization (%s) to match configured organization (%s)", name, b.organization, tc.expectedOrganziation) } - if tc.expectedWorkspacePrefix != "" && b.workspaceMapping.prefix != tc.expectedWorkspacePrefix { - t.Fatalf("%s: expected workspace prefix mapping (%s) to match configured workspace prefix (%s)", name, b.workspaceMapping.prefix, tc.expectedWorkspacePrefix) + if tc.expectedWorkspacePrefix != "" && b.WorkspaceMapping.Prefix != tc.expectedWorkspacePrefix { + t.Fatalf("%s: expected workspace prefix mapping (%s) to match configured workspace prefix (%s)", name, b.WorkspaceMapping.Prefix, tc.expectedWorkspacePrefix) } - if tc.expectedWorkspaceName != "" && b.workspaceMapping.name != tc.expectedWorkspaceName { - t.Fatalf("%s: expected workspace name mapping (%s) to match configured workspace name (%s)", name, b.workspaceMapping.name, tc.expectedWorkspaceName) + if tc.expectedWorkspaceName != "" && b.WorkspaceMapping.Name != tc.expectedWorkspaceName { + t.Fatalf("%s: expected workspace name mapping (%s) to match configured workspace name (%s)", name, b.WorkspaceMapping.Name, tc.expectedWorkspaceName) } if len(tc.expectedWorkspaceTags) > 0 { presentSet := make(map[string]struct{}) - for _, tag := range b.workspaceMapping.tags { + for _, tag := range b.WorkspaceMapping.Tags { presentSet[tag] = struct{}{} } @@ -454,18 +471,18 @@ func TestCloud_setConfigurationFields(t *testing.T) { } } - for _, actual := range b.workspaceMapping.tags { + for _, actual := range b.WorkspaceMapping.Tags { if _, ok := expectedSet[actual]; !ok { unexpected = append(missing, actual) } } if len(missing) > 0 { - t.Fatalf("%s: expected workspace tag mapping (%s) to contain the following tags: %s", name, b.workspaceMapping.tags, missing) + t.Fatalf("%s: expected workspace tag mapping (%s) to contain the following tags: %s", name, b.WorkspaceMapping.Tags, missing) } if len(unexpected) > 0 { - t.Fatalf("%s: expected workspace tag mapping (%s) to NOT contain the following tags: %s", name, b.workspaceMapping.tags, unexpected) + t.Fatalf("%s: expected workspace tag mapping (%s) to NOT contain the following tags: %s", name, b.WorkspaceMapping.Tags, unexpected) } } @@ -575,28 +592,16 @@ func TestCloud_addAndRemoveWorkspacesDefault(t *testing.T) { b, bCleanup := testBackendDefault(t) defer bCleanup() - if _, err := b.Workspaces(); err != backend.ErrWorkspacesNotSupported { - t.Fatalf("expected error %v, got %v", backend.ErrWorkspacesNotSupported, err) - } - - if _, err := b.StateMgr(backend.DefaultStateName); err != nil { - t.Fatalf("expected no error, got %v", err) - } - - if _, err := b.StateMgr("prod"); err != backend.ErrWorkspacesNotSupported { - t.Fatalf("expected error %v, got %v", backend.ErrWorkspacesNotSupported, err) - } - - if err := b.DeleteWorkspace(backend.DefaultStateName); err != nil { + if _, err := b.StateMgr(testBackendSingleWorkspaceName); err != nil { t.Fatalf("expected no error, got %v", err) } - if err := b.DeleteWorkspace("prod"); err != backend.ErrWorkspacesNotSupported { + if err := b.DeleteWorkspace(testBackendSingleWorkspaceName); err != backend.ErrWorkspacesNotSupported { t.Fatalf("expected error %v, got %v", backend.ErrWorkspacesNotSupported, err) } } -func TestCloud_addAndRemoveWorkspacesNoDefault(t *testing.T) { +func TestCloud_addAndRemoveWorkspacesWithPrefix(t *testing.T) { b, bCleanup := testBackendWithPrefix(t) defer bCleanup() @@ -808,7 +813,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String(v0140.String()), }, @@ -817,7 +822,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { } // This should succeed - if _, err := b.StateMgr(backend.DefaultStateName); err != nil { + if _, err := b.StateMgr(testBackendSingleWorkspaceName); err != nil { t.Fatalf("expected no error, got %v", err) } @@ -825,7 +830,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String(v0135.String()), }, @@ -835,7 +840,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { // This should fail want := `Remote workspace Terraform version "0.13.5" does not match local Terraform version "0.14.0"` - if _, err := b.StateMgr(backend.DefaultStateName); err.Error() != want { + if _, err := b.StateMgr(testBackendSingleWorkspaceName); err.Error() != want { t.Fatalf("wrong error\n got: %v\nwant: %v", err.Error(), want) } } @@ -865,7 +870,7 @@ func TestCloud_StateMgr_versionCheckLatest(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String("latest"), }, @@ -874,7 +879,7 @@ func TestCloud_StateMgr_versionCheckLatest(t *testing.T) { } // This should succeed despite not being a string match - if _, err := b.StateMgr(backend.DefaultStateName); err != nil { + if _, err := b.StateMgr(testBackendSingleWorkspaceName); err != nil { t.Fatalf("expected no error, got %v", err) } } @@ -923,7 +928,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ Operations: tfe.Bool(tc.operations), TerraformVersion: tfe.String(tc.remote), @@ -974,7 +979,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String("1.0.cheetarah"), }, @@ -1022,7 +1027,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { if _, err := b.client.Workspaces.Update( context.Background(), b.organization, - b.workspaceMapping.name, + b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ TerraformVersion: tfe.String(remote.String()), }, @@ -1041,7 +1046,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { if got, want := diags[0].Description().Summary, "Terraform version mismatch"; got != want { t.Errorf("wrong summary: got %s, want %s", got, want) } - wantDetail := "The local Terraform version (0.14.0) does not match the configured version for remote workspace hashicorp/prod (0.13.5)." + wantDetail := "The local Terraform version (0.14.0) does not match the configured version for remote workspace hashicorp/app-prod (0.13.5)." if got := diags[0].Description().Detail; got != wantDetail { t.Errorf("wrong summary: got %s, want %s", got, wantDetail) } diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index d289a42c2d52..9dd570e6933b 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -38,6 +38,7 @@ var ( credsSrc = auth.StaticCredentialsSource(map[svchost.Hostname]map[string]interface{}{ tfeHost: {"token": testCred}, }) + testBackendSingleWorkspaceName = "app-prod" ) // mockInput is a mock implementation of terraform.UIInput. @@ -70,7 +71,7 @@ func testBackendDefault(t *testing.T) (*Cloud, func()) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), + "name": cty.StringVal(testBackendSingleWorkspaceName), "prefix": cty.NullVal(cty.String), "tags": cty.NullVal(cty.Set(cty.String)), }), @@ -116,7 +117,7 @@ func testBackendNoOperations(t *testing.T) (*Cloud, func()) { "organization": cty.StringVal("no-operations"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), + "name": cty.StringVal(testBackendSingleWorkspaceName), "prefix": cty.NullVal(cty.String), "tags": cty.NullVal(cty.Set(cty.String)), }), @@ -128,7 +129,7 @@ func testRemoteClient(t *testing.T) remote.Client { b, bCleanup := testBackendDefault(t) defer bCleanup() - raw, err := b.StateMgr(backend.DefaultStateName) + raw, err := b.StateMgr(testBackendSingleWorkspaceName) if err != nil { t.Fatalf("error: %v", err) } @@ -182,9 +183,9 @@ func testBackend(t *testing.T, obj cty.Value) (*Cloud, func()) { } // Create the default workspace if required. - if b.workspaceMapping.name != "" { + if b.WorkspaceMapping.Name != "" { _, err = b.client.Workspaces.Create(ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.workspaceMapping.name), + Name: tfe.String(b.WorkspaceMapping.Name), }) if err != nil { t.Fatalf("error: %v", err) From 74e087dc299243d2bf97ba07b2887338bf2f1a31 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 20 Sep 2021 16:54:41 -0500 Subject: [PATCH 218/644] Rename cloud.testBackendDefault -> cloud.testBackendWithName --- internal/cloud/backend_apply_test.go | 60 +++++++++++++------------- internal/cloud/backend_context_test.go | 2 +- internal/cloud/backend_plan_test.go | 58 ++++++++++++------------- internal/cloud/backend_state_test.go | 2 +- internal/cloud/backend_test.go | 18 ++++---- internal/cloud/testing.go | 4 +- 6 files changed, 72 insertions(+), 72 deletions(-) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 9f464c3f3722..1ae00946a79b 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -54,7 +54,7 @@ func testOperationApplyWithTimeout(t *testing.T, configDir string, timeout time. } func TestCloud_applyBasic(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -105,7 +105,7 @@ func TestCloud_applyBasic(t *testing.T) { } func TestCloud_applyCanceled(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -216,7 +216,7 @@ func TestCloud_applyWithVCS(t *testing.T) { } func TestCloud_applyWithParallelism(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -246,7 +246,7 @@ func TestCloud_applyWithParallelism(t *testing.T) { } func TestCloud_applyWithPlan(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -276,7 +276,7 @@ func TestCloud_applyWithPlan(t *testing.T) { } func TestCloud_applyWithoutRefresh(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -313,7 +313,7 @@ func TestCloud_applyWithoutRefresh(t *testing.T) { } func TestCloud_applyWithoutRefreshIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -345,7 +345,7 @@ func TestCloud_applyWithoutRefreshIncompatibleAPIVersion(t *testing.T) { } func TestCloud_applyWithRefreshOnly(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -382,7 +382,7 @@ func TestCloud_applyWithRefreshOnly(t *testing.T) { } func TestCloud_applyWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -414,7 +414,7 @@ func TestCloud_applyWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { } func TestCloud_applyWithTarget(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -453,7 +453,7 @@ func TestCloud_applyWithTarget(t *testing.T) { } func TestCloud_applyWithTargetIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -489,7 +489,7 @@ func TestCloud_applyWithTargetIncompatibleAPIVersion(t *testing.T) { } func TestCloud_applyWithReplace(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -528,7 +528,7 @@ func TestCloud_applyWithReplace(t *testing.T) { } func TestCloud_applyWithReplaceIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -562,7 +562,7 @@ func TestCloud_applyWithReplaceIncompatibleAPIVersion(t *testing.T) { } func TestCloud_applyWithVariables(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-variables") @@ -589,7 +589,7 @@ func TestCloud_applyWithVariables(t *testing.T) { } func TestCloud_applyNoConfig(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/empty") @@ -624,7 +624,7 @@ func TestCloud_applyNoConfig(t *testing.T) { } func TestCloud_applyNoChanges(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-no-changes") @@ -656,7 +656,7 @@ func TestCloud_applyNoChanges(t *testing.T) { } func TestCloud_applyNoApprove(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -695,7 +695,7 @@ func TestCloud_applyNoApprove(t *testing.T) { } func TestCloud_applyAutoApprove(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -741,7 +741,7 @@ func TestCloud_applyAutoApprove(t *testing.T) { } func TestCloud_applyApprovedExternally(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -815,7 +815,7 @@ func TestCloud_applyApprovedExternally(t *testing.T) { } func TestCloud_applyDiscardedExternally(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -954,7 +954,7 @@ func TestCloud_applyForceLocal(t *testing.T) { } defer os.Unsetenv("TF_FORCE_LOCAL_BACKEND") - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply") @@ -1066,7 +1066,7 @@ func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { } func TestCloud_applyLockTimeout(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() ctx := context.Background() @@ -1140,7 +1140,7 @@ func TestCloud_applyLockTimeout(t *testing.T) { } func TestCloud_applyDestroy(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-destroy") @@ -1186,7 +1186,7 @@ func TestCloud_applyDestroy(t *testing.T) { } func TestCloud_applyDestroyNoConfig(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() input := testInput(t, map[string]string{ @@ -1221,7 +1221,7 @@ func TestCloud_applyDestroyNoConfig(t *testing.T) { } func TestCloud_applyPolicyPass(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-passed") @@ -1269,7 +1269,7 @@ func TestCloud_applyPolicyPass(t *testing.T) { } func TestCloud_applyPolicyHardFail(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-hard-failed") @@ -1322,7 +1322,7 @@ func TestCloud_applyPolicyHardFail(t *testing.T) { } func TestCloud_applyPolicySoftFail(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-soft-failed") @@ -1372,7 +1372,7 @@ func TestCloud_applyPolicySoftFail(t *testing.T) { } func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-soft-failed") @@ -1423,7 +1423,7 @@ func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { } func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() // Create a named workspace that auto applies. @@ -1485,7 +1485,7 @@ func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { } func TestCloud_applyWithRemoteError(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-with-error") @@ -1553,7 +1553,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { for name, tc := range testCases { t.Run(name, func(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() // SETUP: Save original local version state and restore afterwards diff --git a/internal/cloud/backend_context_test.go b/internal/cloud/backend_context_test.go index 7a7668a83a3a..e1001ee5292a 100644 --- a/internal/cloud/backend_context_test.go +++ b/internal/cloud/backend_context_test.go @@ -176,7 +176,7 @@ func TestRemoteContextWithVars(t *testing.T) { t.Run(name, func(t *testing.T) { configDir := "./testdata/empty" - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index a76841f2b225..19221dc90493 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -52,7 +52,7 @@ func testOperationPlanWithTimeout(t *testing.T, configDir string, timeout time.D } func TestCloud_planBasic(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -90,7 +90,7 @@ func TestCloud_planBasic(t *testing.T) { } func TestCloud_planCanceled(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -120,7 +120,7 @@ func TestCloud_planCanceled(t *testing.T) { } func TestCloud_planLongLine(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-long-line") @@ -191,7 +191,7 @@ func TestCloud_planWithoutPermissions(t *testing.T) { } func TestCloud_planWithParallelism(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -221,7 +221,7 @@ func TestCloud_planWithParallelism(t *testing.T) { } func TestCloud_planWithPlan(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -251,7 +251,7 @@ func TestCloud_planWithPlan(t *testing.T) { } func TestCloud_planWithPath(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -281,7 +281,7 @@ func TestCloud_planWithPath(t *testing.T) { } func TestCloud_planWithoutRefresh(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -318,7 +318,7 @@ func TestCloud_planWithoutRefresh(t *testing.T) { } func TestCloud_planWithoutRefreshIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -350,7 +350,7 @@ func TestCloud_planWithoutRefreshIncompatibleAPIVersion(t *testing.T) { } func TestCloud_planWithRefreshOnly(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -387,7 +387,7 @@ func TestCloud_planWithRefreshOnly(t *testing.T) { } func TestCloud_planWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -419,7 +419,7 @@ func TestCloud_planWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { } func TestCloud_planWithTarget(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() // When the backend code creates a new run, we'll tweak it so that it @@ -488,7 +488,7 @@ func TestCloud_planWithTarget(t *testing.T) { } func TestCloud_planWithTargetIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -524,7 +524,7 @@ func TestCloud_planWithTargetIncompatibleAPIVersion(t *testing.T) { } func TestCloud_planWithReplace(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -563,7 +563,7 @@ func TestCloud_planWithReplace(t *testing.T) { } func TestCloud_planWithReplaceIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -597,7 +597,7 @@ func TestCloud_planWithReplaceIncompatibleAPIVersion(t *testing.T) { } func TestCloud_planWithVariables(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-variables") @@ -624,7 +624,7 @@ func TestCloud_planWithVariables(t *testing.T) { } func TestCloud_planNoConfig(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/empty") @@ -653,7 +653,7 @@ func TestCloud_planNoConfig(t *testing.T) { } func TestCloud_planNoChanges(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-no-changes") @@ -692,7 +692,7 @@ func TestCloud_planForceLocal(t *testing.T) { } defer os.Unsetenv("TF_FORCE_LOCAL_BACKEND") - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -814,7 +814,7 @@ func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { } func TestCloud_planLockTimeout(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() ctx := context.Background() @@ -885,7 +885,7 @@ func TestCloud_planLockTimeout(t *testing.T) { } func TestCloud_planDestroy(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") @@ -910,7 +910,7 @@ func TestCloud_planDestroy(t *testing.T) { } func TestCloud_planDestroyNoConfig(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/empty") @@ -935,7 +935,7 @@ func TestCloud_planDestroyNoConfig(t *testing.T) { } func TestCloud_planWithWorkingDirectory(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() options := tfe.WorkspaceUpdateOptions{ @@ -980,7 +980,7 @@ func TestCloud_planWithWorkingDirectory(t *testing.T) { } func TestCloud_planWithWorkingDirectoryFromCurrentPath(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() options := tfe.WorkspaceUpdateOptions{ @@ -1036,7 +1036,7 @@ func TestCloud_planWithWorkingDirectoryFromCurrentPath(t *testing.T) { } func TestCloud_planCostEstimation(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-cost-estimation") @@ -1071,7 +1071,7 @@ func TestCloud_planCostEstimation(t *testing.T) { } func TestCloud_planPolicyPass(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-passed") @@ -1106,7 +1106,7 @@ func TestCloud_planPolicyPass(t *testing.T) { } func TestCloud_planPolicyHardFail(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-hard-failed") @@ -1146,7 +1146,7 @@ func TestCloud_planPolicyHardFail(t *testing.T) { } func TestCloud_planPolicySoftFail(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-policy-soft-failed") @@ -1186,7 +1186,7 @@ func TestCloud_planPolicySoftFail(t *testing.T) { } func TestCloud_planWithRemoteError(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-with-error") @@ -1218,7 +1218,7 @@ func TestCloud_planWithRemoteError(t *testing.T) { } func TestCloud_planOtherError(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan") diff --git a/internal/cloud/backend_state_test.go b/internal/cloud/backend_state_test.go index e39dd211f19b..63c970438a3c 100644 --- a/internal/cloud/backend_state_test.go +++ b/internal/cloud/backend_state_test.go @@ -20,7 +20,7 @@ func TestRemoteClient(t *testing.T) { } func TestRemoteClient_stateLock(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() s1, err := b.StateMgr(testBackendSingleWorkspaceName) diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 9f1a5190b288..9ac894467d77 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -25,7 +25,7 @@ func TestCloud(t *testing.T) { } func TestCloud_backendWithName(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() workspaces, err := b.Workspaces() @@ -574,7 +574,7 @@ func TestCloud_versionConstraints(t *testing.T) { } func TestCloud_localBackend(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() local, ok := b.local.(*backendLocal.Local) @@ -589,7 +589,7 @@ func TestCloud_localBackend(t *testing.T) { } func TestCloud_addAndRemoveWorkspacesDefault(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() if _, err := b.StateMgr(testBackendSingleWorkspaceName); err != nil { @@ -683,7 +683,7 @@ func TestCloud_addAndRemoveWorkspacesWithPrefix(t *testing.T) { } func TestCloud_checkConstraints(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() cases := map[string]struct { @@ -785,7 +785,7 @@ func TestCloud_checkConstraints(t *testing.T) { } func TestCloud_StateMgr_versionCheck(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() // Some fixed versions for testing with. This logic is a simple string @@ -846,7 +846,7 @@ func TestCloud_StateMgr_versionCheck(t *testing.T) { } func TestCloud_StateMgr_versionCheckLatest(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() v0140 := version.Must(version.NewSemver("0.14.0")) @@ -903,7 +903,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { } for _, tc := range testCases { t.Run(fmt.Sprintf("local %s, remote %s", tc.local, tc.remote), func(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() local := version.Must(version.NewSemver(tc.local)) @@ -955,7 +955,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { } func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() // Attempting to check the version against a workspace which doesn't exist @@ -997,7 +997,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { } func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() // If the ignore flag is set, the behaviour changes diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index 9dd570e6933b..b2811fe2f2b9 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -65,7 +65,7 @@ func testInput(t *testing.T, answers map[string]string) *mockInput { return &mockInput{answers: answers} } -func testBackendDefault(t *testing.T) (*Cloud, func()) { +func testBackendWithName(t *testing.T) (*Cloud, func()) { obj := cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), @@ -126,7 +126,7 @@ func testBackendNoOperations(t *testing.T) (*Cloud, func()) { } func testRemoteClient(t *testing.T) remote.Client { - b, bCleanup := testBackendDefault(t) + b, bCleanup := testBackendWithName(t) defer bCleanup() raw, err := b.StateMgr(testBackendSingleWorkspaceName) From aba7d9659642bcd025fe9e53b35a013df6e4f101 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 24 Sep 2021 09:03:12 -0500 Subject: [PATCH 219/644] cloud: Support interop from 0.14 to 1.1 The previous conservative guarantee that we would not make backwards incompatible changes to the state file format until at least Terraform 1.1 can now be extended. Terraform 0.14 through 1.1 will be able to interoperably use state files, so we can update the remote backend version compatibility check accordingly. This is a port of https://github.com/hashicorp/terraform/pull/29645 --- internal/cloud/backend.go | 6 +++--- internal/cloud/backend_test.go | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 22adb98d175d..0356740b093f 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -940,9 +940,9 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di // are aware of are: // // - 0.14.0 is guaranteed to be compatible with versions up to but not - // including 1.1.0 - v110 := version.Must(version.NewSemver("1.1.0")) - if tfversion.SemVer.LessThan(v110) && remoteVersion.LessThan(v110) { + // including 1.2.0 + v120 := version.Must(version.NewSemver("1.2.0")) + if tfversion.SemVer.LessThan(v120) && remoteVersion.LessThan(v120) { return diags } // - Any new Terraform state version will require at least minor patch diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 9ac894467d77..4c3546ec5f29 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -896,7 +896,8 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { {"0.14.0", "0.13.5", false, false}, {"0.14.0", "0.14.1", true, false}, {"0.14.0", "1.0.99", true, false}, - {"0.14.0", "1.1.0", true, true}, + {"0.14.0", "1.1.0", true, false}, + {"0.14.0", "1.2.0", true, true}, {"1.2.0", "1.2.99", true, false}, {"1.2.0", "1.3.0", true, true}, {"0.15.0", "latest", true, false}, From ee384e8716f304961fd1126fd258c0f3b65c8017 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 29 Sep 2021 12:41:44 -0500 Subject: [PATCH 220/644] Attempt to set current Terraform version on new workspaces, always --- internal/cloud/backend.go | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 0356740b093f..91c3f6976cd4 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -649,11 +649,7 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { } options.Tags = tags - // We only set the Terraform Version for the new workspace if this is - // a release candidate or a final release. - if tfversion.Prerelease == "" || strings.HasPrefix(tfversion.Prerelease, "rc") { - options.TerraformVersion = tfe.String(tfversion.String()) - } + options.TerraformVersion = tfe.String(tfversion.String()) workspace, err = b.client.Workspaces.Create(context.Background(), b.organization, options) if err != nil { From a387af6c61263f397739233dc85c08dea70422d6 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 22 Sep 2021 17:53:33 -0400 Subject: [PATCH 221/644] Add auto-approve logic, e2e tests --- go.mod | 4 +- go.sum | 8 +- internal/cloud/backend_apply.go | 80 ++--- internal/cloud/backend_apply_test.go | 93 +++++- internal/cloud/backend_plan.go | 1 + internal/cloud/e2e/apply_auto_approve_test.go | 280 ++++++++++++++++++ internal/cloud/e2e/helper_test.go | 50 ++++ internal/cloud/e2e/main_test.go | 198 +++++++++++++ internal/cloud/tfe_client_mock.go | 2 +- 9 files changed, 647 insertions(+), 69 deletions(-) create mode 100644 internal/cloud/e2e/apply_auto_approve_test.go create mode 100644 internal/cloud/e2e/helper_test.go create mode 100644 internal/cloud/e2e/main_test.go diff --git a/go.mod b/go.mod index 9074b31d85c0..6dfa7bdcc887 100644 --- a/go.mod +++ b/go.mod @@ -22,7 +22,7 @@ require ( github.com/davecgh/go-spew v1.1.1 github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 github.com/go-test/deep v1.0.3 - github.com/golang/mock v1.5.0 + github.com/golang/mock v1.6.0 github.com/golang/protobuf v1.5.2 github.com/google/go-cmp v0.5.5 github.com/google/uuid v1.2.0 @@ -40,7 +40,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.5.2 - github.com/hashicorp/go-tfe v0.18.1-0.20210902165242-26689edbfddf + github.com/hashicorp/go-tfe v0.19.1-0.20210922134841-a2c1784e9c00 github.com/hashicorp/go-uuid v1.0.1 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index 4a206459700d..aaba3e315579 100644 --- a/go.sum +++ b/go.sum @@ -241,8 +241,9 @@ github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFU github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw= -github.com/golang/mock v1.4.4 h1:l75CXGRSwbaYNpl/Z2X1XIIAMSCquvXgpVZDhwEIJsc= github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4= +github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc= +github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= github.com/golang/protobuf v0.0.0-20161109072736-4bd1920723d7/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.1.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= @@ -375,8 +376,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.18.1-0.20210902165242-26689edbfddf h1:Tn5cI9kacNyO40ztxmwfAaHrOGd7dELLSAueV2Xfv38= -github.com/hashicorp/go-tfe v0.18.1-0.20210902165242-26689edbfddf/go.mod h1:7lChm1Mjsh0ofrUNkP8MHljUFrnKNZNTw36S6qSbJZU= +github.com/hashicorp/go-tfe v0.19.1-0.20210922134841-a2c1784e9c00 h1:51ARk47jO4piKzhhbwk6u67ErvSuBj4cu2f2VS9HkgI= +github.com/hashicorp/go-tfe v0.19.1-0.20210922134841-a2c1784e9c00/go.mod h1:U5Iy307L+MazGg0uF8annDtaxAbPp4ElFZ9uPMrjw/I= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1 h1:fv1ep09latC32wFoVwnqcnKJGnMSdBanPczbHAYm1BE= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= @@ -933,6 +934,7 @@ golang.org/x/tools v0.0.0-20201201161351-ac6f37ff4c2a/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= +golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.7 h1:6j8CgantCy3yc8JGBqkDLMKWqZ0RDU2g1HVgacojGWQ= golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo= diff --git a/internal/cloud/backend_apply.go b/internal/cloud/backend_apply.go index 74d167673848..02f006c2c2f6 100644 --- a/internal/cloud/backend_apply.go +++ b/internal/cloud/backend_apply.go @@ -181,75 +181,43 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio } // Return if the run cannot be confirmed. - if !w.AutoApply && !r.Actions.IsConfirmable { + if !op.AutoApprove && !r.Actions.IsConfirmable { return r, nil } - // Since we already checked the permissions before creating the run - // this should never happen. But it doesn't hurt to keep this in as - // a safeguard for any unexpected situations. - if !w.AutoApply && !r.Permissions.CanApply { - // Make sure we discard the run if possible. - if r.Actions.IsDiscardable { - err = b.client.Runs.Discard(stopCtx, r.ID, tfe.RunDiscardOptions{}) - if err != nil { - switch op.PlanMode { - case plans.DestroyMode: - return r, generalError("Failed to discard destroy", err) - default: - return r, generalError("Failed to discard apply", err) - } - } - } - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Insufficient rights to approve the pending changes", - fmt.Sprintf("There are pending changes, but the provided credentials have "+ - "insufficient rights to approve them. The run will be discarded to prevent "+ - "it from blocking the queue waiting for external approval. To queue a run "+ - "that can be approved by someone else, please use the 'Queue Plan' button in "+ - "the web UI:\nhttps://%s/app/%s/%s/runs", b.hostname, b.organization, op.Workspace), - )) - return r, diags.Err() - } - mustConfirm := (op.UIIn != nil && op.UIOut != nil) && !op.AutoApprove - if !w.AutoApply { - if mustConfirm { - opts := &terraform.InputOpts{Id: "approve"} - - if op.PlanMode == plans.DestroyMode { - opts.Query = "\nDo you really want to destroy all resources in workspace \"" + op.Workspace + "\"?" - opts.Description = "Terraform will destroy all your managed infrastructure, as shown above.\n" + - "There is no undo. Only 'yes' will be accepted to confirm." - } else { - opts.Query = "\nDo you want to perform these actions in workspace \"" + op.Workspace + "\"?" - opts.Description = "Terraform will perform the actions described above.\n" + - "Only 'yes' will be accepted to approve." - } - - err = b.confirm(stopCtx, op, opts, r, "yes") - if err != nil && err != errRunApproved { - return r, err - } + if mustConfirm { + opts := &terraform.InputOpts{Id: "approve"} + + if op.PlanMode == plans.DestroyMode { + opts.Query = "\nDo you really want to destroy all resources in workspace \"" + op.Workspace + "\"?" + opts.Description = "Terraform will destroy all your managed infrastructure, as shown above.\n" + + "There is no undo. Only 'yes' will be accepted to confirm." + } else { + opts.Query = "\nDo you want to perform these actions in workspace \"" + op.Workspace + "\"?" + opts.Description = "Terraform will perform the actions described above.\n" + + "Only 'yes' will be accepted to approve." } - if err != errRunApproved { - if err = b.client.Runs.Apply(stopCtx, r.ID, tfe.RunApplyOptions{}); err != nil { - return r, generalError("Failed to approve the apply command", err) - } + err = b.confirm(stopCtx, op, opts, r, "yes") + if err != nil && err != errRunApproved { + return r, err } - } - - // If we don't need to ask for confirmation, insert a blank - // line to separate the ouputs. - if w.AutoApply || !mustConfirm { + } else { + // If we don't need to ask for confirmation, insert a blank + // line to separate the ouputs. if b.CLI != nil { b.CLI.Output("") } } + if !op.AutoApprove && err != errRunApproved { + if err = b.client.Runs.Apply(stopCtx, r.ID, tfe.RunApplyOptions{}); err != nil { + return r, generalError("Failed to approve the apply command", err) + } + } + r, err = b.waitForRun(stopCtx, cancelCtx, op, "apply", r, w) if err != nil { return r, err diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 1ae00946a79b..ff98d99285c0 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -2,6 +2,7 @@ package cloud import ( "context" + "fmt" "os" "os/signal" "strings" @@ -9,6 +10,7 @@ import ( "testing" "time" + gomock "github.com/golang/mock/gomock" "github.com/google/go-cmp/cmp" tfe "github.com/hashicorp/go-tfe" version "github.com/hashicorp/go-version" @@ -697,6 +699,14 @@ func TestCloud_applyNoApprove(t *testing.T) { func TestCloud_applyAutoApprove(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() + ctrl := gomock.NewController(t) + + applyMock := tfe.NewMockApplies(ctrl) + // This needs three new lines because we check for a minimum of three lines + // in the parsing of logs in `opApply` function. + logs := strings.NewReader(applySuccessOneResourceAdded) + applyMock.EXPECT().Logs(gomock.Any(), gomock.Any()).Return(logs, nil) + b.client.Applies = applyMock op, configCleanup, done := testOperationApply(t, "./testdata/apply") defer configCleanup() @@ -888,17 +898,24 @@ func TestCloud_applyDiscardedExternally(t *testing.T) { } } -func TestCloud_applyWithAutoApply(t *testing.T) { +func TestCloud_applyWithAutoApprove(t *testing.T) { b, bCleanup := testBackendWithPrefix(t) defer bCleanup() + ctrl := gomock.NewController(t) + + applyMock := tfe.NewMockApplies(ctrl) + // This needs three new lines because we check for a minimum of three lines + // in the parsing of logs in `opApply` function. + logs := strings.NewReader(applySuccessOneResourceAdded) + applyMock.EXPECT().Logs(gomock.Any(), gomock.Any()).Return(logs, nil) + b.client.Applies = applyMock // Create a named workspace that auto applies. _, err := b.client.Workspaces.Create( context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - AutoApply: tfe.Bool(true), - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), }, ) if err != nil { @@ -916,6 +933,7 @@ func TestCloud_applyWithAutoApply(t *testing.T) { op.UIIn = input op.UIOut = b.CLI op.Workspace = "prod" + op.AutoApprove = true run, err := b.Operation(context.Background(), op) if err != nil { @@ -1374,6 +1392,34 @@ func TestCloud_applyPolicySoftFail(t *testing.T) { func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() + ctrl := gomock.NewController(t) + + policyCheckMock := tfe.NewMockPolicyChecks(ctrl) + // This needs three new lines because we check for a minimum of three lines + // in the parsing of logs in `opApply` function. + logs := strings.NewReader(fmt.Sprintf("%s\n%s", sentinelSoftFail, applySuccessOneResourceAdded)) + + pc := &tfe.PolicyCheck{ + ID: "pc-1", + Actions: &tfe.PolicyActions{ + IsOverridable: true, + }, + Permissions: &tfe.PolicyPermissions{ + CanOverride: true, + }, + Scope: tfe.PolicyScopeOrganization, + Status: tfe.PolicySoftFailed, + } + policyCheckMock.EXPECT().Read(gomock.Any(), gomock.Any()).Return(pc, nil) + policyCheckMock.EXPECT().Logs(gomock.Any(), gomock.Any()).Return(logs, nil) + policyCheckMock.EXPECT().Override(gomock.Any(), gomock.Any()).Return(nil, nil) + b.client.PolicyChecks = policyCheckMock + applyMock := tfe.NewMockApplies(ctrl) + // This needs three new lines because we check for a minimum of three lines + // in the parsing of logs in `opApply` function. + logs = strings.NewReader("\n\n\n1 added, 0 changed, 0 destroyed") + applyMock.EXPECT().Logs(gomock.Any(), gomock.Any()).Return(logs, nil) + b.client.Applies = applyMock op, configCleanup, done := testOperationApply(t, "./testdata/apply-policy-soft-failed") defer configCleanup() @@ -1422,17 +1468,24 @@ func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { } } -func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { +func TestCloud_applyPolicySoftFailAutoApprove(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() + ctrl := gomock.NewController(t) + + applyMock := tfe.NewMockApplies(ctrl) + // This needs three new lines because we check for a minimum of three lines + // in the parsing of logs in `opApply` function. + logs := strings.NewReader(applySuccessOneResourceAdded) + applyMock.EXPECT().Logs(gomock.Any(), gomock.Any()).Return(logs, nil) + b.client.Applies = applyMock // Create a named workspace that auto applies. _, err := b.client.Workspaces.Create( context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - AutoApply: tfe.Bool(true), - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), }, ) if err != nil { @@ -1451,6 +1504,7 @@ func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { op.UIIn = input op.UIOut = b.CLI op.Workspace = "prod" + op.AutoApprove = true run, err := b.Operation(context.Background(), op) if err != nil { @@ -1465,7 +1519,7 @@ func TestCloud_applyPolicySoftFailAutoApply(t *testing.T) { t.Fatalf("expected a non-empty plan") } - if len(input.answers) != 1 { + if len(input.answers) != 2 { t.Fatalf("expected an unused answer, got: %v", input.answers) } @@ -1656,3 +1710,28 @@ func TestCloud_applyVersionCheck(t *testing.T) { }) } } + +const applySuccessOneResourceAdded = ` +Terraform v0.11.10 + +Initializing plugins and modules... +null_resource.hello: Creating... +null_resource.hello: Creation complete after 0s (ID: 8657651096157629581) + +Apply complete! Resources: 1 added, 0 changed, 0 destroyed. +` + +const sentinelSoftFail = ` +Sentinel Result: false + +Sentinel evaluated to false because one or more Sentinel policies evaluated +to false. This false was not due to an undefined value or runtime error. + +1 policies evaluated. + +## Policy 1: Passthrough.sentinel (soft-mandatory) + +Result: false + +FALSE - Passthrough.sentinel:1:1 - Rule "main" +` diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 693210d4f05d..8b61cae5bf4d 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -277,6 +277,7 @@ in order to capture the filesystem context the remote workspace expects: ConfigurationVersion: cv, Refresh: tfe.Bool(op.PlanRefresh), Workspace: w, + AutoApply: tfe.Bool(op.AutoApprove), } switch op.PlanMode { diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go new file mode 100644 index 000000000000..919c457e2d5b --- /dev/null +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -0,0 +1,280 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "context" + "fmt" + "io/ioutil" + "log" + "os" + "strings" + "testing" + + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/e2e" +) + +type tfCommand struct { + command []string + expectedOutput string + expectedErr string +} + +func Test_terraform_apply_autoApprove(t *testing.T) { + ctx := context.Background() + cases := map[string]struct { + setup func(t *testing.T) (map[string]string, func()) + commands []tfCommand + validations func(t *testing.T, orgName, wsName string) + }{ + "workspace manual apply, terraform apply without auto-approve": { + setup: func(t *testing.T) (map[string]string, func()) { + org, orgCleanup := createOrganization(t) + wOpts := tfe.WorkspaceCreateOptions{ + Name: tfe.String(randomString(t)), + TerraformVersion: tfe.String(terraformVersion), + AutoApply: tfe.Bool(false), + } + workspace := createWorkspace(t, org, wOpts) + cleanup := func() { + defer orgCleanup() + } + names := map[string]string{ + "organization": org.Name, + "workspace": workspace.Name, + } + + return names, cleanup + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: "Terraform has been successfully initialized", + expectedErr: "", + }, + { + command: []string{"apply"}, + expectedOutput: "Do you want to perform these actions in workspace", + expectedErr: "Error asking approve", + }, + }, + validations: func(t *testing.T, orgName, wsName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + if err != nil { + t.Fatal(err) + } + if workspace.CurrentRun == nil { + t.Fatal("Expected workspace to have run, but got nil") + } + if workspace.CurrentRun.Status != tfe.RunPlanned { + t.Fatalf("Expected run status to be `planned`, but is %s", workspace.CurrentRun.Status) + } + }, + }, + "workspace auto apply, terraform apply without auto-approve": { + setup: func(t *testing.T) (map[string]string, func()) { + org, orgCleanup := createOrganization(t) + wOpts := tfe.WorkspaceCreateOptions{ + Name: tfe.String(randomString(t)), + TerraformVersion: tfe.String(terraformVersion), + AutoApply: tfe.Bool(true), + } + workspace := createWorkspace(t, org, wOpts) + cleanup := func() { + defer orgCleanup() + } + names := map[string]string{ + "organization": org.Name, + "workspace": workspace.Name, + } + + return names, cleanup + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: "Terraform has been successfully initialized", + expectedErr: "", + }, + { + command: []string{"apply"}, + expectedOutput: "Do you want to perform these actions in workspace", + expectedErr: "Error asking approve", + }, + }, + validations: func(t *testing.T, orgName, wsName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + if err != nil { + t.Fatal(err) + } + if workspace.CurrentRun == nil { + t.Fatalf("Expected workspace to have run, but got nil") + } + if workspace.CurrentRun.Status != tfe.RunPlanned { + t.Fatalf("Expected run status to be `planned`, but is %s", workspace.CurrentRun.Status) + } + }, + }, + "workspace manual apply, terraform apply auto-approve": { + setup: func(t *testing.T) (map[string]string, func()) { + org, orgCleanup := createOrganization(t) + wOpts := tfe.WorkspaceCreateOptions{ + Name: tfe.String(randomString(t)), + TerraformVersion: tfe.String(terraformVersion), + AutoApply: tfe.Bool(false), + } + workspace := createWorkspace(t, org, wOpts) + cleanup := func() { + defer orgCleanup() + } + names := map[string]string{ + "organization": org.Name, + "workspace": workspace.Name, + } + + return names, cleanup + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: "Terraform has been successfully initialized", + expectedErr: "", + }, + { + command: []string{"apply", "-auto-approve"}, + expectedOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", + expectedErr: "", + }, + }, + validations: func(t *testing.T, orgName, wsName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + if err != nil { + t.Fatal(err) + } + if workspace.CurrentRun == nil { + t.Fatalf("Expected workspace to have run, but got nil") + } + if workspace.CurrentRun.Status != tfe.RunApplied { + t.Fatalf("Expected run status to be `applied`, but is %s", workspace.CurrentRun.Status) + } + }, + }, + "workspace auto apply, terraform apply auto-approve": { + setup: func(t *testing.T) (map[string]string, func()) { + org, orgCleanup := createOrganization(t) + + wOpts := tfe.WorkspaceCreateOptions{ + Name: tfe.String(randomString(t)), + TerraformVersion: tfe.String(terraformVersion), + AutoApply: tfe.Bool(true), + } + workspace := createWorkspace(t, org, wOpts) + cleanup := func() { + defer orgCleanup() + } + names := map[string]string{ + "organization": org.Name, + "workspace": workspace.Name, + } + + return names, cleanup + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: "Terraform has been successfully initialized", + expectedErr: "", + }, + { + command: []string{"apply", "-auto-approve"}, + expectedOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", + expectedErr: "", + }, + }, + validations: func(t *testing.T, orgName, wsName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + if err != nil { + t.Fatal(err) + } + if workspace.CurrentRun == nil { + t.Fatalf("Expected workspace to have run, but got nil") + } + if workspace.CurrentRun.Status != tfe.RunApplied { + t.Fatalf("Expected run status to be `applied`, but is %s", workspace.CurrentRun.Status) + } + }, + }, + } + for name, tc := range cases { + log.Println("Test: ", name) + resourceData, cleanup := tc.setup(t) + defer cleanup() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + orgName := resourceData["organization"] + wsName := resourceData["workspace"] + tfBlock := createTerraformBlock(orgName, wsName) + writeMainTF(t, tfBlock, tmpDir) + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv("TF_LOG=debug") + tf.AddEnv(cliConfigFileEnv) + + for _, cmd := range tc.commands { + stdout, stderr, err := tf.Run(cmd.command...) + if cmd.expectedErr == "" && err != nil { + t.Fatalf("Expected no error, but got %v. stderr\n: %s", err, stderr) + } + if cmd.expectedErr != "" { + if !strings.Contains(stderr, cmd.expectedErr) { + t.Fatalf("Expected to find error %s, but got %s", cmd.expectedErr, stderr) + } + } + + if cmd.expectedOutput != "" && !strings.Contains(stdout, cmd.expectedOutput) { + t.Fatalf("Expected to find output %s, but did not find in\n%s", cmd.expectedOutput, stdout) + } + } + + tc.validations(t, orgName, wsName) + } +} + +func createTerraformBlock(org, ws string) string { + return fmt.Sprintf( + `terraform { + cloud { + hostname = "%s" + organization = "%s" + + workspaces { + name = "%s" + } + } +} + +resource "random_pet" "server" { + keepers = { + uuid = uuid() + } + + length = 3 +}`, tfeHostname, org, ws) +} + +func writeMainTF(t *testing.T, block string, dir string) { + f, err := os.Create(fmt.Sprintf("%s/main.tf", dir)) + if err != nil { + t.Fatal(err) + } + _, err = f.WriteString(block) + if err != nil { + t.Fatal(err) + } + f.Close() +} diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go new file mode 100644 index 000000000000..7793b917faa5 --- /dev/null +++ b/internal/cloud/e2e/helper_test.go @@ -0,0 +1,50 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "context" + "fmt" + "testing" + + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/go-uuid" +) + +func createOrganization(t *testing.T) (*tfe.Organization, func()) { + ctx := context.Background() + org, err := tfeClient.Organizations.Create(ctx, tfe.OrganizationCreateOptions{ + Name: tfe.String("tst-" + randomString(t)), + Email: tfe.String(fmt.Sprintf("%s@tfe.local", randomString(t))), + }) + if err != nil { + t.Fatal(err) + } + + return org, func() { + if err := tfeClient.Organizations.Delete(ctx, org.Name); err != nil { + t.Errorf("Error destroying organization! WARNING: Dangling resources\n"+ + "may exist! The full error is shown below.\n\n"+ + "Organization: %s\nError: %s", org.Name, err) + } + } +} + +func createWorkspace(t *testing.T, org *tfe.Organization, wOpts tfe.WorkspaceCreateOptions) *tfe.Workspace { + ctx := context.Background() + w, err := tfeClient.Workspaces.Create(ctx, org.Name, wOpts) + if err != nil { + t.Fatal(err) + } + + return w +} + +func randomString(t *testing.T) string { + v, err := uuid.GenerateUUID() + if err != nil { + t.Fatal(err) + } + return v +} diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go new file mode 100644 index 000000000000..414442170e4c --- /dev/null +++ b/internal/cloud/e2e/main_test.go @@ -0,0 +1,198 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "context" + "encoding/json" + "fmt" + "io/ioutil" + "log" + "os" + "os/exec" + "strings" + "testing" + + tfe "github.com/hashicorp/go-tfe" +) + +var terraformVersion string +var terraformBin string +var cliConfigFileEnv string + +var tfeClient *tfe.Client +var tfeHostname string +var tfeToken string + +func TestMain(m *testing.M) { + log.SetFlags(log.LstdFlags | log.Lshortfile) + if !accTest() { + // if TF_ACC is not set, we want to skip all these tests. + return + } + teardown := setup() + code := m.Run() + teardown() + + os.Exit(code) +} + +func accTest() bool { + // TF_ACC is set when we want to run acceptance tests, meaning it relies on + // network access. + return os.Getenv("TF_ACC") != "" +} + +func setup() func() { + setTfeClient() + teardown := setupBinary() + setVersion() + ensureVersionExists() + + return func() { + teardown() + } +} + +func setTfeClient() { + hostname := os.Getenv("TFE_HOSTNAME") + token := os.Getenv("TFE_TOKEN") + if hostname == "" { + log.Fatalf("hostname cannot be empty") + } + if token == "" { + log.Fatalf("token cannot be empty") + } + tfeHostname = hostname + tfeToken = token + + cfg := &tfe.Config{ + Address: fmt.Sprintf("https://%s", hostname), + Token: token, + } + + // Create a new TFE client. + client, err := tfe.NewClient(cfg) + if err != nil { + log.Fatal(err) + } + tfeClient = client +} + +func setupBinary() func() { + log.Println("Setting up terraform binary") + tmpTerraformBinaryDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + log.Fatal(err) + } + log.Println(tmpTerraformBinaryDir) + currentDir, err := os.Getwd() + defer os.Chdir(currentDir) + if err != nil { + log.Fatal(err) + } + // Getting top level dir + dirPaths := strings.Split(currentDir, "/") + log.Println(currentDir) + topLevel := len(dirPaths) - 3 + topDir := strings.Join(dirPaths[0:topLevel], "/") + + if err := os.Chdir(topDir); err != nil { + log.Fatal(err) + } + + cmd := exec.Command("go", "build", "-o", tmpTerraformBinaryDir) + err = cmd.Run() + if err != nil { + log.Fatal(err) + } + + credFile := fmt.Sprintf("%s/dev.tfrc", tmpTerraformBinaryDir) + writeCredRC(credFile) + + terraformBin = fmt.Sprintf("%s/terraform", tmpTerraformBinaryDir) + cliConfigFileEnv = fmt.Sprintf("TF_CLI_CONFIG_FILE=%s", credFile) + + return func() { + os.RemoveAll(tmpTerraformBinaryDir) + } +} + +func setVersion() { + log.Println("Retrieving version") + cmd := exec.Command(terraformBin, "version", "-json") + out, err := cmd.Output() + if err != nil { + log.Fatal(fmt.Sprintf("Could not output terraform version: %v", err)) + } + var data map[string]interface{} + if err := json.Unmarshal(out, &data); err != nil { + log.Fatal(fmt.Sprintf("Could not unmarshal version output: %v", err)) + } + + out, err = exec.Command("git", "rev-parse", "HEAD").Output() + if err != nil { + log.Fatal(fmt.Sprintf("Could not execute go build command: %v", err)) + } + + hash := string(out)[0:8] + + terraformVersion = fmt.Sprintf("%s-%s", data["terraform_version"].(string), hash) +} + +func ensureVersionExists() { + opts := tfe.AdminTerraformVersionsListOptions{ + ListOptions: tfe.ListOptions{ + PageNumber: 1, + PageSize: 100, + }, + } + hasVersion := false + +findTfVersion: + for { + tfVersionList, err := tfeClient.Admin.TerraformVersions.List(context.Background(), opts) + if err != nil { + log.Fatalf("Could not retrieve list of terraform versions: %v", err) + } + for _, item := range tfVersionList.Items { + if item.Version == terraformVersion { + hasVersion = true + break findTfVersion + } + } + + // Exit the loop when we've seen all pages. + if tfVersionList.CurrentPage >= tfVersionList.TotalPages { + break + } + + // Update the page number to get the next page. + opts.PageNumber = tfVersionList.NextPage + } + + if !hasVersion { + log.Fatalf("Terraform Version %s does not exist in the list. Please add it.", terraformVersion) + } +} + +func writeCredRC(file string) { + creds := credentialBlock() + f, err := os.Create(file) + if err != nil { + log.Fatal(err) + } + _, err = f.WriteString(creds) + if err != nil { + log.Fatal(err) + } + f.Close() +} + +func credentialBlock() string { + return fmt.Sprintf(` +credentials "%s" { + token = "%s" +}`, tfeHostname, tfeToken) +} diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index fd93c48d9577..518602c3c847 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1353,7 +1353,7 @@ func (m *MockWorkspaces) UnassignSSHKey(ctx context.Context, workspaceID string) panic("not implemented") } -func (m *MockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string) (*tfe.WorkspaceList, error) { +func (m *MockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string, options *tfe.RemoteStateConsumersListOptions) (*tfe.WorkspaceList, error) { panic("not implemented") } From d5567b479c6b580c02bd90bd587854799811cdbe Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Mon, 4 Oct 2021 09:57:46 -0400 Subject: [PATCH 222/644] Fix terraform version in cloud e2e tests to ignore prerelease. (#29) --- internal/cloud/e2e/main_test.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index 414442170e4c..310032848d43 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -59,10 +59,10 @@ func setTfeClient() { hostname := os.Getenv("TFE_HOSTNAME") token := os.Getenv("TFE_TOKEN") if hostname == "" { - log.Fatalf("hostname cannot be empty") + log.Fatal("hostname cannot be empty") } if token == "" { - log.Fatalf("token cannot be empty") + log.Fatal("token cannot be empty") } tfeHostname = hostname tfeToken = token @@ -138,7 +138,9 @@ func setVersion() { hash := string(out)[0:8] - terraformVersion = fmt.Sprintf("%s-%s", data["terraform_version"].(string), hash) + fullVersion := data["terraform_version"].(string) + version := strings.Split(fullVersion, "-")[0] + terraformVersion = fmt.Sprintf("%s-%s", version, hash) } func ensureVersionExists() { From a4e196d0677c64149bcbd8297cf4a03d1c6de8a9 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 7 Oct 2021 18:56:25 -0500 Subject: [PATCH 223/644] Port backend/local: Check dependency lock consistency before any operations This is a port of the changes made in #29683 --- internal/cloud/backend_apply_test.go | 19 +++++++++++++------ internal/cloud/backend_plan_test.go | 19 +++++++++++++------ 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index ff98d99285c0..bd819e556271 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -19,6 +19,7 @@ import ( "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" @@ -45,13 +46,19 @@ func testOperationApplyWithTimeout(t *testing.T, configDir string, timeout time. stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) operationView := views.NewOperation(arguments.ViewHuman, false, view) + // Many of our tests use an overridden "null" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/null")) + return &backend.Operation{ - ConfigDir: configDir, - ConfigLoader: configLoader, - PlanRefresh: true, - StateLocker: clistate.NewLocker(timeout, stateLockerView), - Type: backend.OperationTypeApply, - View: operationView, + ConfigDir: configDir, + ConfigLoader: configLoader, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypeApply, + View: operationView, + DependencyLocks: depLocks, }, configCleanup, done } diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 19221dc90493..3683f1b4fb70 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -16,6 +16,7 @@ import ( "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/depsfile" "github.com/hashicorp/terraform/internal/initwd" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" @@ -41,13 +42,19 @@ func testOperationPlanWithTimeout(t *testing.T, configDir string, timeout time.D stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) operationView := views.NewOperation(arguments.ViewHuman, false, view) + // Many of our tests use an overridden "null" provider that's just in-memory + // inside the test process, not a separate plugin on disk. + depLocks := depsfile.NewLocks() + depLocks.SetProviderOverridden(addrs.MustParseProviderSourceString("registry.terraform.io/hashicorp/null")) + return &backend.Operation{ - ConfigDir: configDir, - ConfigLoader: configLoader, - PlanRefresh: true, - StateLocker: clistate.NewLocker(timeout, stateLockerView), - Type: backend.OperationTypePlan, - View: operationView, + ConfigDir: configDir, + ConfigLoader: configLoader, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypePlan, + View: operationView, + DependencyLocks: depLocks, }, configCleanup, done } From 412679522df42f56856455066c802f20caac3b27 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 5 Oct 2021 15:32:17 -0500 Subject: [PATCH 224/644] Remove all constraint checking This is an outdated mechanism that isn't used anymore. --- internal/cloud/backend.go | 136 ++---------------------- internal/cloud/backend_test.go | 184 --------------------------------- 2 files changed, 7 insertions(+), 313 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 91c3f6976cd4..bd71d23ba646 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -198,19 +198,9 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { } // Discover the service URL to confirm that it provides the Terraform Cloud/Enterprise API - // and to get the version constraints. - service, constraints, err := b.discover() + service, err := b.discover() - // First check any contraints we might have received. - if constraints != nil { - diags = diags.Append(b.checkConstraints(constraints)) - if diags.HasErrors() { - return diags - } - } - - // When we don't have any constraints errors, also check for discovery - // errors before we continue. + // Check for errors before we continue. if err != nil { diags = diags.Append(tfdiags.AttributeValue( tfdiags.Error, @@ -358,7 +348,7 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { } // discover the TFC/E API service URL and version constraints. -func (b *Cloud) discover() (*url.URL, *disco.Constraints, error) { +func (b *Cloud) discover() (*url.URL, error) { serviceID := tfeServiceID if b.forceLocal { serviceID = stateServiceID @@ -366,124 +356,21 @@ func (b *Cloud) discover() (*url.URL, *disco.Constraints, error) { hostname, err := svchost.ForComparison(b.hostname) if err != nil { - return nil, nil, err + return nil, err } host, err := b.services.Discover(hostname) if err != nil { - return nil, nil, err + return nil, err } service, err := host.ServiceURL(serviceID) // Return the error, unless its a disco.ErrVersionNotSupported error. if _, ok := err.(*disco.ErrVersionNotSupported); !ok && err != nil { - return nil, nil, err + return nil, err } - // We purposefully ignore the error and return the previous error, as - // checking for version constraints is considered optional. - constraints, _ := host.VersionConstraints(serviceID, "terraform") - - return service, constraints, err -} - -// checkConstraints checks service version constrains against our own -// version and returns rich and informational diagnostics in case any -// incompatibilities are detected. -func (b *Cloud) checkConstraints(c *disco.Constraints) tfdiags.Diagnostics { - var diags tfdiags.Diagnostics - - if c == nil || c.Minimum == "" || c.Maximum == "" { - return diags - } - - // Generate a parsable constraints string. - excluding := "" - if len(c.Excluding) > 0 { - excluding = fmt.Sprintf(", != %s", strings.Join(c.Excluding, ", != ")) - } - constStr := fmt.Sprintf(">= %s%s, <= %s", c.Minimum, excluding, c.Maximum) - - // Create the constraints to check against. - constraints, err := version.NewConstraint(constStr) - if err != nil { - return diags.Append(checkConstraintsWarning(err)) - } - - // Create the version to check. - v, err := version.NewVersion(tfversion.Version) - if err != nil { - return diags.Append(checkConstraintsWarning(err)) - } - - // Return if we satisfy all constraints. - if constraints.Check(v) { - return diags - } - - // Find out what action (upgrade/downgrade) we should advice. - minimum, err := version.NewVersion(c.Minimum) - if err != nil { - return diags.Append(checkConstraintsWarning(err)) - } - - maximum, err := version.NewVersion(c.Maximum) - if err != nil { - return diags.Append(checkConstraintsWarning(err)) - } - - var excludes []*version.Version - for _, exclude := range c.Excluding { - v, err := version.NewVersion(exclude) - if err != nil { - return diags.Append(checkConstraintsWarning(err)) - } - excludes = append(excludes, v) - } - - // Sort all the excludes. - sort.Sort(version.Collection(excludes)) - - var action, toVersion string - switch { - case minimum.GreaterThan(v): - action = "upgrade" - toVersion = ">= " + minimum.String() - case maximum.LessThan(v): - action = "downgrade" - toVersion = "<= " + maximum.String() - case len(excludes) > 0: - // Get the latest excluded version. - action = "upgrade" - toVersion = "> " + excludes[len(excludes)-1].String() - } - - switch { - case len(excludes) == 1: - excluding = fmt.Sprintf(", excluding version %s", excludes[0].String()) - case len(excludes) > 1: - var vs []string - for _, v := range excludes { - vs = append(vs, v.String()) - } - excluding = fmt.Sprintf(", excluding versions %s", strings.Join(vs, ", ")) - default: - excluding = "" - } - - summary := fmt.Sprintf("Incompatible Terraform version v%s", v.String()) - details := fmt.Sprintf( - "The configured Terraform Enterprise backend is compatible with Terraform "+ - "versions >= %s, <= %s%s.", c.Minimum, c.Maximum, excluding, - ) - - if action != "" && toVersion != "" { - summary = fmt.Sprintf("Please %s Terraform to %s", action, toVersion) - details += fmt.Sprintf(" Please %s to a supported version and try again.", action) - } - - // Return the customized and informational error message. - return diags.Append(tfdiags.Sourceless(tfdiags.Error, summary, details)) + return service, err } // token returns the token for this host as configured in the credentials @@ -1063,15 +950,6 @@ func generalError(msg string, err error) error { } } -func checkConstraintsWarning(err error) tfdiags.Diagnostic { - return tfdiags.Sourceless( - tfdiags.Warning, - fmt.Sprintf("Failed to check version constraints: %v", err), - "Checking version constraints is considered optional, but this is an"+ - "unexpected error which should be reported.", - ) -} - // The newline in this error is to make it look good in the CLI! const initialRetryError = ` [reset][yellow]There was an error connecting to Terraform Cloud. Please do not exit diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 4c3546ec5f29..f6d8ca14b7c3 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -10,7 +10,6 @@ import ( tfe "github.com/hashicorp/go-tfe" version "github.com/hashicorp/go-version" - "github.com/hashicorp/terraform-svchost/disco" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/tfdiags" tfversion "github.com/hashicorp/terraform/version" @@ -492,87 +491,6 @@ func TestCloud_setConfigurationFields(t *testing.T) { } } -func TestCloud_versionConstraints(t *testing.T) { - cases := map[string]struct { - config cty.Value - prerelease string - version string - result string - }{ - "compatible version": { - config: cty.ObjectVal(map[string]cty.Value{ - "hostname": cty.NullVal(cty.String), - "organization": cty.StringVal("hashicorp"), - "token": cty.NullVal(cty.String), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }), - version: "0.11.1", - }, - "version too old": { - config: cty.ObjectVal(map[string]cty.Value{ - "hostname": cty.NullVal(cty.String), - "organization": cty.StringVal("hashicorp"), - "token": cty.NullVal(cty.String), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }), - version: "0.0.1", - result: "upgrade Terraform to >= 0.1.0", - }, - "version too new": { - config: cty.ObjectVal(map[string]cty.Value{ - "hostname": cty.NullVal(cty.String), - "organization": cty.StringVal("hashicorp"), - "token": cty.NullVal(cty.String), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }), - version: "10.0.1", - result: "downgrade Terraform to <= 10.0.0", - }, - } - - // Save and restore the actual version. - p := tfversion.Prerelease - v := tfversion.Version - defer func() { - tfversion.Prerelease = p - tfversion.Version = v - }() - - for name, tc := range cases { - s := testServer(t) - b := New(testDisco(s)) - - // Set the version for this test. - tfversion.Prerelease = tc.prerelease - tfversion.Version = tc.version - - // Validate - _, valDiags := b.PrepareConfig(tc.config) - if valDiags.HasErrors() { - t.Fatalf("%s: unexpected validation result: %v", name, valDiags.Err()) - } - - // Configure - confDiags := b.Configure(tc.config) - if (confDiags.Err() != nil || tc.result != "") && - (confDiags.Err() == nil || !strings.Contains(confDiags.Err().Error(), tc.result)) { - t.Fatalf("%s: unexpected configure result: %v", name, confDiags.Err()) - } - } -} - func TestCloud_localBackend(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -682,108 +600,6 @@ func TestCloud_addAndRemoveWorkspacesWithPrefix(t *testing.T) { } } -func TestCloud_checkConstraints(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - cases := map[string]struct { - constraints *disco.Constraints - prerelease string - version string - result string - }{ - "compatible version": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Maximum: "0.11.11", - }, - version: "0.11.1", - result: "", - }, - "version too old": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Maximum: "0.11.11", - }, - version: "0.10.1", - result: "upgrade Terraform to >= 0.11.0", - }, - "version too new": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Maximum: "0.11.11", - }, - version: "0.12.0", - result: "downgrade Terraform to <= 0.11.11", - }, - "version excluded - ordered": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Excluding: []string{"0.11.7", "0.11.8"}, - Maximum: "0.11.11", - }, - version: "0.11.7", - result: "upgrade Terraform to > 0.11.8", - }, - "version excluded - unordered": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Excluding: []string{"0.11.8", "0.11.6"}, - Maximum: "0.11.11", - }, - version: "0.11.6", - result: "upgrade Terraform to > 0.11.8", - }, - "list versions": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Maximum: "0.11.11", - }, - version: "0.10.1", - result: "versions >= 0.11.0, <= 0.11.11.", - }, - "list exclusion": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Excluding: []string{"0.11.6"}, - Maximum: "0.11.11", - }, - version: "0.11.6", - result: "excluding version 0.11.6.", - }, - "list exclusions": { - constraints: &disco.Constraints{ - Minimum: "0.11.0", - Excluding: []string{"0.11.8", "0.11.6"}, - Maximum: "0.11.11", - }, - version: "0.11.6", - result: "excluding versions 0.11.6, 0.11.8.", - }, - } - - // Save and restore the actual version. - p := tfversion.Prerelease - v := tfversion.Version - defer func() { - tfversion.Prerelease = p - tfversion.Version = v - }() - - for name, tc := range cases { - // Set the version for this test. - tfversion.Prerelease = tc.prerelease - tfversion.Version = tc.version - - // Check the constraints. - diags := b.checkConstraints(tc.constraints) - if (diags.Err() != nil || tc.result != "") && - (diags.Err() == nil || !strings.Contains(diags.Err().Error(), tc.result)) { - t.Fatalf("%s: unexpected constraints result: %v", name, diags.Err()) - } - } -} - func TestCloud_StateMgr_versionCheck(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() From 46e47ed3791816a47bd7dc3b2d88f9d587b475b0 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 5 Oct 2021 15:51:48 -0500 Subject: [PATCH 225/644] Use the 'tfe' service for everything. The 'tfe' service was appended to with various versions to denote a new 'feature' implemented by a new 'service'. This quickly proved to not be scalable, as adding an entry to the discovery document from every feature is bad. The new mechanism added was checking the TFP-API-Version header on requests for a version, instead. So we'll remove the separation here between different tfe service 'versions' and the separate 'state' service and Just Use TFE, as well as the TFP-API-Version header for all feature versioning., as well as the TFP-API-Version header for all feature versioning. --- internal/cloud/backend.go | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index bd71d23ba646..d1b493b1c5de 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -34,8 +34,7 @@ import ( const ( defaultHostname = "app.terraform.io" defaultParallelism = 10 - stateServiceID = "state.v2" - tfeServiceID = "tfe.v2.1" + tfeServiceID = "tfe.v2" ) // Cloud is an implementation of EnhancedBackend in service of the Terraform Cloud/Enterprise @@ -349,11 +348,6 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { // discover the TFC/E API service URL and version constraints. func (b *Cloud) discover() (*url.URL, error) { - serviceID := tfeServiceID - if b.forceLocal { - serviceID = stateServiceID - } - hostname, err := svchost.ForComparison(b.hostname) if err != nil { return nil, err @@ -364,7 +358,7 @@ func (b *Cloud) discover() (*url.URL, error) { return nil, err } - service, err := host.ServiceURL(serviceID) + service, err := host.ServiceURL(tfeServiceID) // Return the error, unless its a disco.ErrVersionNotSupported error. if _, ok := err.(*disco.ErrVersionNotSupported); !ok && err != nil { return nil, err From 7cc53fe1636f7e3b738adbda4d26cd934db77c7e Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 7 Oct 2021 23:42:41 -0500 Subject: [PATCH 226/644] cloud: Set minimum TFE version These changes remove all of the preexisting version checking for individual features, wiping the slate clean with an overall minimum requirement of a future TFP-API-Version 2.5, which at the time of this writing is expected to be TFE v202112-1. It also actually provides that expected TFE version as an actionable error message, rather than generically saying that it isn't supported or using the somewhat opaque API version header. --- internal/cloud/backend.go | 23 ++++- internal/cloud/backend_apply.go | 70 -------------- internal/cloud/backend_apply_test.go | 134 --------------------------- internal/cloud/backend_plan.go | 70 -------------- internal/cloud/backend_plan_test.go | 134 --------------------------- internal/cloud/backend_test.go | 38 ++++++++ internal/cloud/testing.go | 64 ++++++++----- internal/cloud/versioning.go | 12 +++ 8 files changed, 111 insertions(+), 434 deletions(-) create mode 100644 internal/cloud/versioning.go diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index d1b493b1c5de..730d8be83836 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -265,10 +265,10 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { if err != nil { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Failed to create the Terraform Enterprise client", + "Failed to create the Terraform Cloud/Enterprise client", fmt.Sprintf( `Encountered an unexpected error while creating the `+ - `Terraform Enterprise client: %s.`, err, + `Terraform Cloud/Enterprise client: %s.`, err, ), )) return diags @@ -293,6 +293,25 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { return diags } + // Check for the minimum version of Terraform Enterprise required. + // + // For API versions prior to 2.3, RemoteAPIVersion will return an empty string, + // so if there's an error when parsing the RemoteAPIVersion, it's handled as + // equivalent to an API version < 2.3. + currentAPIVersion, parseErr := version.NewVersion(b.client.RemoteAPIVersion()) + desiredAPIVersion, _ := version.NewVersion("2.5") + + if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Unsupported Terraform Enterprise version", + fmt.Sprintf( + `The 'cloud' option requires Terraform Enterprise %s or later.`, + apiToMinimumTFEVersion["2.5"], + ), + )) + } + // Configure a local backend for when we need to run operations locally. b.local = backendLocal.NewWithBackend(b) b.forceLocal = b.forceLocal || !entitlements.Operations diff --git a/internal/cloud/backend_apply.go b/internal/cloud/backend_apply.go index 02f006c2c2f6..65f51ff6c5ad 100644 --- a/internal/cloud/backend_apply.go +++ b/internal/cloud/backend_apply.go @@ -8,7 +8,6 @@ import ( "log" tfe "github.com/hashicorp/go-tfe" - version "github.com/hashicorp/go-version" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/terraform" @@ -87,75 +86,6 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio )) } - // For API versions prior to 2.3, RemoteAPIVersion will return an empty string, - // so if there's an error when parsing the RemoteAPIVersion, it's handled as - // equivalent to an API version < 2.3. - currentAPIVersion, parseErr := version.NewVersion(b.client.RemoteAPIVersion()) - - if !op.PlanRefresh { - desiredAPIVersion, _ := version.NewVersion("2.4") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Planning without refresh is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support the -refresh=false option for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - - if op.PlanMode == plans.RefreshOnlyMode { - desiredAPIVersion, _ := version.NewVersion("2.4") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Refresh-only mode is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support -refresh-only mode for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - - if len(op.ForceReplace) != 0 { - desiredAPIVersion, _ := version.NewVersion("2.4") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Planning resource replacements is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support the -replace option for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - - if len(op.Targets) != 0 { - desiredAPIVersion, _ := version.NewVersion("2.3") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Resource targeting is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support the -target option for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - // Return if there are any errors. if diags.HasErrors() { return nil, diags.Err() diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index bd819e556271..ad01c0d431a3 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -321,38 +321,6 @@ func TestCloud_applyWithoutRefresh(t *testing.T) { } } -func TestCloud_applyWithoutRefreshIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationApply(t, "./testdata/apply") - defer configCleanup() - - b.client.SetFakeRemoteAPIVersion("2.3") - - op.PlanRefresh = false - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected apply operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Planning without refresh is not supported") { - t.Fatalf("expected a not supported error, got: %v", errOutput) - } -} - func TestCloud_applyWithRefreshOnly(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -390,38 +358,6 @@ func TestCloud_applyWithRefreshOnly(t *testing.T) { } } -func TestCloud_applyWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationApply(t, "./testdata/apply") - defer configCleanup() - - b.client.SetFakeRemoteAPIVersion("2.3") - - op.PlanMode = plans.RefreshOnlyMode - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected apply operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Refresh-only mode is not supported") { - t.Fatalf("expected a not supported error, got: %v", errOutput) - } -} - func TestCloud_applyWithTarget(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -461,42 +397,6 @@ func TestCloud_applyWithTarget(t *testing.T) { } } -func TestCloud_applyWithTargetIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationApply(t, "./testdata/apply") - defer configCleanup() - - // Set the tfe client's RemoteAPIVersion to an empty string, to mimic - // API versions prior to 2.3. - b.client.SetFakeRemoteAPIVersion("") - - addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") - - op.Targets = []addrs.Targetable{addr} - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected apply operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Resource targeting is not supported") { - t.Fatalf("expected a targeting error, got: %v", errOutput) - } -} - func TestCloud_applyWithReplace(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -536,40 +436,6 @@ func TestCloud_applyWithReplace(t *testing.T) { } } -func TestCloud_applyWithReplaceIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationApply(t, "./testdata/apply") - defer configCleanup() - - b.client.SetFakeRemoteAPIVersion("2.3") - - addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") - - op.ForceReplace = []addrs.AbsResourceInstance{addr} - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected apply operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Planning resource replacements is not supported") { - t.Fatalf("expected a not supported error, got: %v", errOutput) - } -} - func TestCloud_applyWithVariables(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 8b61cae5bf4d..5455ec06ec9e 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -15,7 +15,6 @@ import ( "time" tfe "github.com/hashicorp/go-tfe" - version "github.com/hashicorp/go-version" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/tfdiags" @@ -93,75 +92,6 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation )) } - // For API versions prior to 2.3, RemoteAPIVersion will return an empty string, - // so if there's an error when parsing the RemoteAPIVersion, it's handled as - // equivalent to an API version < 2.3. - currentAPIVersion, parseErr := version.NewVersion(b.client.RemoteAPIVersion()) - - if len(op.Targets) != 0 { - desiredAPIVersion, _ := version.NewVersion("2.3") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Resource targeting is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support the -target option for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - - if !op.PlanRefresh { - desiredAPIVersion, _ := version.NewVersion("2.4") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Planning without refresh is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support the -refresh=false option for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - - if len(op.ForceReplace) != 0 { - desiredAPIVersion, _ := version.NewVersion("2.4") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Planning resource replacements is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support the -replace option for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - - if op.PlanMode == plans.RefreshOnlyMode { - desiredAPIVersion, _ := version.NewVersion("2.4") - - if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Refresh-only mode is not supported", - fmt.Sprintf( - `The Terraform Enterprise installation at %s does not support -refresh-only mode for `+ - `remote plans.`, - b.hostname, - ), - )) - } - } - // Return if there are any errors. if diags.HasErrors() { return nil, diags.Err() diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 3683f1b4fb70..3a6d2e74baa1 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -324,38 +324,6 @@ func TestCloud_planWithoutRefresh(t *testing.T) { } } -func TestCloud_planWithoutRefreshIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationPlan(t, "./testdata/plan") - defer configCleanup() - - b.client.SetFakeRemoteAPIVersion("2.3") - - op.PlanRefresh = false - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected plan operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Planning without refresh is not supported") { - t.Fatalf("expected not supported error, got: %v", errOutput) - } -} - func TestCloud_planWithRefreshOnly(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -393,38 +361,6 @@ func TestCloud_planWithRefreshOnly(t *testing.T) { } } -func TestCloud_planWithRefreshOnlyIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationPlan(t, "./testdata/plan") - defer configCleanup() - - b.client.SetFakeRemoteAPIVersion("2.3") - - op.PlanMode = plans.RefreshOnlyMode - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected plan operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Refresh-only mode is not supported") { - t.Fatalf("expected not supported error, got: %v", errOutput) - } -} - func TestCloud_planWithTarget(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -494,42 +430,6 @@ func TestCloud_planWithTarget(t *testing.T) { } } -func TestCloud_planWithTargetIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationPlan(t, "./testdata/plan") - defer configCleanup() - - // Set the tfe client's RemoteAPIVersion to an empty string, to mimic - // API versions prior to 2.3. - b.client.SetFakeRemoteAPIVersion("") - - addr, _ := addrs.ParseAbsResourceStr("null_resource.foo") - - op.Targets = []addrs.Targetable{addr} - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected plan operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Resource targeting is not supported") { - t.Fatalf("expected a targeting error, got: %v", errOutput) - } -} - func TestCloud_planWithReplace(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() @@ -569,40 +469,6 @@ func TestCloud_planWithReplace(t *testing.T) { } } -func TestCloud_planWithReplaceIncompatibleAPIVersion(t *testing.T) { - b, bCleanup := testBackendWithName(t) - defer bCleanup() - - op, configCleanup, done := testOperationPlan(t, "./testdata/plan") - defer configCleanup() - - b.client.SetFakeRemoteAPIVersion("2.3") - - addr, _ := addrs.ParseAbsResourceInstanceStr("null_resource.foo") - - op.ForceReplace = []addrs.AbsResourceInstance{addr} - op.Workspace = testBackendSingleWorkspaceName - - run, err := b.Operation(context.Background(), op) - if err != nil { - t.Fatalf("error starting operation: %v", err) - } - - <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected plan operation to fail") - } - if !run.PlanEmpty { - t.Fatalf("expected plan to be empty") - } - - errOutput := output.Stderr() - if !strings.Contains(errOutput, "Planning resource replacements is not supported") { - t.Fatalf("expected not supported error, got: %v", errOutput) - } -} - func TestCloud_planWithVariables(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index f6d8ca14b7c3..01072898c7cf 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -3,6 +3,7 @@ package cloud import ( "context" "fmt" + "net/http" "os" "reflect" "strings" @@ -311,6 +312,43 @@ func TestCloud_config(t *testing.T) { } } +func TestCloud_configVerifyMinimumTFEVersion(t *testing.T) { + config := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "prefix": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), + }), + }) + + handlers := map[string]func(http.ResponseWriter, *http.Request){ + "/api/v2/ping": func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + w.Header().Set("TFP-API-Version", "2.4") + }, + } + s := testServerWithHandlers(handlers) + + b := New(testDisco(s)) + + confDiags := b.Configure(config) + if confDiags.Err() == nil { + t.Fatalf("expected configure to error") + } + + expected := "The 'cloud' option requires Terraform Enterprise v202201-1 or later." + if !strings.Contains(confDiags.Err().Error(), expected) { + t.Fatalf("expected configure to error with %q, got %q", expected, confDiags.Err().Error()) + } +} + func TestCloud_setConfigurationFields(t *testing.T) { originalForceBackendEnv := os.Getenv("TF_FORCE_LOCAL_BACKEND") diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index b2811fe2f2b9..75e53c5bcb11 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -144,13 +144,13 @@ func testBackend(t *testing.T, obj cty.Value) (*Cloud, func()) { // Configure the backend so the client is created. newObj, valDiags := b.PrepareConfig(obj) if len(valDiags) != 0 { - t.Fatal(valDiags.ErrWithWarnings()) + t.Fatalf("testBackend: backend.PrepareConfig() failed: %s", valDiags.ErrWithWarnings()) } obj = newObj confDiags := b.Configure(obj) if len(confDiags) != 0 { - t.Fatal(confDiags.ErrWithWarnings()) + t.Fatalf("testBackend: backend.Configure() failed: %s", confDiags.ErrWithWarnings()) } // Get a new mock client. @@ -215,22 +215,42 @@ func testLocalBackend(t *testing.T, cloud *Cloud) backend.Enhanced { return b } -// testServer returns a *httptest.Server used for local testing. +// testServer returns a started *httptest.Server used for local testing with the default set of +// request handlers. func testServer(t *testing.T) *httptest.Server { + return testServerWithHandlers(testDefaultRequestHandlers) +} + +// testServerWithHandlers returns a started *httptest.Server with the given set of request handlers +// overriding any default request handlers (testDefaultRequestHandlers). +func testServerWithHandlers(handlers map[string]func(http.ResponseWriter, *http.Request)) *httptest.Server { mux := http.NewServeMux() + for route, handler := range handlers { + mux.HandleFunc(route, handler) + } + for route, handler := range testDefaultRequestHandlers { + if handlers[route] == nil { + mux.HandleFunc(route, handler) + } + } + + return httptest.NewServer(mux) +} +// testDefaultRequestHandlers is a map of request handlers intended to be used in a request +// multiplexer for a test server. A caller may use testServerWithHandlers to start a server with +// this base set of routes, and override a particular route for whatever edge case is being tested. +var testDefaultRequestHandlers = map[string]func(http.ResponseWriter, *http.Request){ // Respond to service discovery calls. - mux.HandleFunc("/well-known/terraform.json", func(w http.ResponseWriter, r *http.Request) { + "/well-known/terraform.json": func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") io.WriteString(w, `{ - "state.v2": "/api/v2/", - "tfe.v2.1": "/api/v2/", - "versions.v1": "/v1/versions/" + "tfe.v2": "/api/v2/", }`) - }) + }, // Respond to service version constraints calls. - mux.HandleFunc("/v1/versions/", func(w http.ResponseWriter, r *http.Request) { + "/v1/versions/": func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") io.WriteString(w, fmt.Sprintf(`{ "service": "%s", @@ -238,16 +258,16 @@ func testServer(t *testing.T) *httptest.Server { "minimum": "0.1.0", "maximum": "10.0.0" }`, path.Base(r.URL.Path))) - }) + }, // Respond to pings to get the API version header. - mux.HandleFunc("/api/v2/ping", func(w http.ResponseWriter, r *http.Request) { + "/api/v2/ping": func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/json") - w.Header().Set("TFP-API-Version", "2.4") - }) + w.Header().Set("TFP-API-Version", "2.5") + }, // Respond to the initial query to read the hashicorp org entitlements. - mux.HandleFunc("/api/v2/organizations/hashicorp/entitlement-set", func(w http.ResponseWriter, r *http.Request) { + "/api/v2/organizations/hashicorp/entitlement-set": func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/vnd.api+json") io.WriteString(w, `{ "data": { @@ -263,10 +283,10 @@ func testServer(t *testing.T) *httptest.Server { } } }`) - }) + }, // Respond to the initial query to read the no-operations org entitlements. - mux.HandleFunc("/api/v2/organizations/no-operations/entitlement-set", func(w http.ResponseWriter, r *http.Request) { + "/api/v2/organizations/no-operations/entitlement-set": func(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "application/vnd.api+json") io.WriteString(w, `{ "data": { @@ -282,11 +302,11 @@ func testServer(t *testing.T) *httptest.Server { } } }`) - }) + }, // All tests that are assumed to pass will use the hashicorp organization, // so for all other organization requests we will return a 404. - mux.HandleFunc("/api/v2/organizations/", func(w http.ResponseWriter, r *http.Request) { + "/api/v2/organizations/": func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(404) io.WriteString(w, `{ "errors": [ @@ -296,18 +316,14 @@ func testServer(t *testing.T) *httptest.Server { } ] }`) - }) - - return httptest.NewServer(mux) + }, } // testDisco returns a *disco.Disco mapping app.terraform.io and // localhost to a local test server. func testDisco(s *httptest.Server) *disco.Disco { services := map[string]interface{}{ - "state.v2": fmt.Sprintf("%s/api/v2/", s.URL), - "tfe.v2.1": fmt.Sprintf("%s/api/v2/", s.URL), - "versions.v1": fmt.Sprintf("%s/v1/versions/", s.URL), + "tfe.v2": fmt.Sprintf("%s/api/v2/", s.URL), } d := disco.NewWithCredentialsSource(credsSrc) d.SetUserAgent(httpclient.TerraformUserAgent(version.String())) diff --git a/internal/cloud/versioning.go b/internal/cloud/versioning.go new file mode 100644 index 000000000000..b07fd74aa430 --- /dev/null +++ b/internal/cloud/versioning.go @@ -0,0 +1,12 @@ +package cloud + +// This simple map exists to translate TFP-API-Version strings to the TFE release where it was +// introduced, to provide actionable feedback on features that may be unsupported by the TFE +// installation but present in this version of Terraform. +// +// The cloud package here, introduced in Terraform 1.1.0, requires a minimum of 2.5 (v202201-1) +// The TFP-API-Version header that this refers to was introduced in 2.3 (v202006-1), so an absent +// header can be considered < 2.3. +var apiToMinimumTFEVersion = map[string]string{ + "2.5": "v202201-1", +} From 55fc590904c90c07e91b205f727c5106e560b6ed Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 22 Sep 2021 17:53:33 -0400 Subject: [PATCH 227/644] Teraform Cloud Backend State Migration * determining source or destination to cloud * handling single to single state migrations to cloud, using a name strategy or a tags strategy * Add end-to-end tests for state migration. --- go.mod | 2 + go.sum | 3 + internal/cloud/e2e/apply_auto_approve_test.go | 30 +-- internal/cloud/e2e/helper_test.go | 78 +++++++ internal/cloud/e2e/main_test.go | 38 ---- .../e2e/migrate_state_multi_to_tfc_test.go | 18 ++ ...igrate_state_remote_backend_to_tfc_test.go | 31 +++ .../e2e/migrate_state_single_to_tfc_test.go | 196 ++++++++++++++++++ .../e2e/migrate_state_tfc_to_other_test.go | 113 ++++++++++ .../e2e/migrate_state_tfc_to_tfc_test.go | 21 ++ internal/command/meta_backend_migrate.go | 120 +++++++++-- 11 files changed, 567 insertions(+), 83 deletions(-) create mode 100644 internal/cloud/e2e/migrate_state_multi_to_tfc_test.go create mode 100644 internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go create mode 100644 internal/cloud/e2e/migrate_state_single_to_tfc_test.go create mode 100644 internal/cloud/e2e/migrate_state_tfc_to_other_test.go create mode 100644 internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go diff --git a/go.mod b/go.mod index 6dfa7bdcc887..9910399a3266 100644 --- a/go.mod +++ b/go.mod @@ -4,6 +4,7 @@ require ( cloud.google.com/go/storage v1.10.0 github.com/Azure/azure-sdk-for-go v52.5.0+incompatible github.com/Azure/go-autorest/autorest v0.11.18 + github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25 github.com/agext/levenshtein v1.2.3 github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70 @@ -154,6 +155,7 @@ require ( github.com/jstemmer/go-junit-report v0.9.1 // indirect github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect + github.com/kr/pty v1.1.1 // indirect github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/mattn/go-colorable v0.1.6 // indirect github.com/mitchellh/go-testing-interface v1.0.0 // indirect diff --git a/go.sum b/go.sum index aaba3e315579..4b6b9daa3331 100644 --- a/go.sum +++ b/go.sum @@ -89,6 +89,8 @@ github.com/Masterminds/sprig v2.22.0+incompatible/go.mod h1:y6hNFY5UBTIWBxnzTeuN github.com/Microsoft/go-winio v0.5.0 h1:Elr9Wn+sGKPlkaBvwu4mTrxtmOp3F3yV9qhaHbXGjwU= github.com/Microsoft/go-winio v0.5.0/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpzfwIujj1a84= github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ= +github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25 h1:hWfsqBaNZUHztXA78g7Y2Jj3rDQaTCZhhFwz43i2VlA= +github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25/go.mod h1:68ORG0HSEWDuH5Eh73AFbYWZ1zT4Y+b0vhOa+vZRUdI= github.com/PuerkitoBio/purell v1.0.0/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= github.com/PuerkitoBio/urlesc v0.0.0-20160726150825-5bd2802263f2/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM= @@ -453,6 +455,7 @@ github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFB github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs= github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 919c457e2d5b..8ece4836dd1d 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -16,12 +16,6 @@ import ( "github.com/hashicorp/terraform/internal/e2e" ) -type tfCommand struct { - command []string - expectedOutput string - expectedErr string -} - func Test_terraform_apply_autoApprove(t *testing.T) { ctx := context.Background() cases := map[string]struct { @@ -218,7 +212,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { } orgName := resourceData["organization"] wsName := resourceData["workspace"] - tfBlock := createTerraformBlock(orgName, wsName) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) writeMainTF(t, tfBlock, tmpDir) tf := e2e.NewBinary(terraformBin, tmpDir) defer tf.Close() @@ -245,28 +239,6 @@ func Test_terraform_apply_autoApprove(t *testing.T) { } } -func createTerraformBlock(org, ws string) string { - return fmt.Sprintf( - `terraform { - cloud { - hostname = "%s" - organization = "%s" - - workspaces { - name = "%s" - } - } -} - -resource "random_pet" "server" { - keepers = { - uuid = uuid() - } - - length = 3 -}`, tfeHostname, org, ws) -} - func writeMainTF(t *testing.T, block string, dir string) { f, err := os.Create(fmt.Sprintf("%s/main.tf", dir)) if err != nil { diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 7793b917faa5..cad01a5c1a09 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -7,11 +7,30 @@ import ( "context" "fmt" "testing" + "time" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/go-uuid" ) +const ( + expectConsoleTimeout = 15 * time.Second +) + +type tfCommand struct { + command []string + expectedOutput string + expectedErr string + expectError bool + userInput []string + postInputOutput string +} + +type operationSets struct { + commands []tfCommand + prep func(t *testing.T, orgName, dir string) +} + func createOrganization(t *testing.T) (*tfe.Organization, func()) { ctx := context.Background() org, err := tfeClient.Organizations.Create(ctx, tfe.OrganizationCreateOptions{ @@ -48,3 +67,62 @@ func randomString(t *testing.T) string { } return v } + +func terraformConfigLocalBackend() string { + return fmt.Sprintf(` +terraform { + backend "local" { + } +} + +output "val" { + value = "${terraform.workspace}" +} +`) +} + +func terraformConfigCloudBackendTags(org, tag string) string { + return fmt.Sprintf(` +terraform { + cloud { + hostname = "%s" + organization = "%s" + + workspaces { + tags = ["%s"] + } + } +} + +resource "random_pet" "server" { + keepers = { + uuid = uuid() + } + + length = 3 +} +`, tfeHostname, org, tag) +} + +func terraformConfigCloudBackendName(org, name string) string { + return fmt.Sprintf(` +terraform { + cloud { + hostname = "%s" + organization = "%s" + + workspaces { + name = "%s" + } + } +} + +resource "random_pet" "server" { + keepers = { + uuid = uuid() + } + + length = 3 +} +`, tfeHostname, org, name) +} diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index 310032848d43..58653e0029fe 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -4,7 +4,6 @@ package main import ( - "context" "encoding/json" "fmt" "io/ioutil" @@ -48,7 +47,6 @@ func setup() func() { setTfeClient() teardown := setupBinary() setVersion() - ensureVersionExists() return func() { teardown() @@ -143,42 +141,6 @@ func setVersion() { terraformVersion = fmt.Sprintf("%s-%s", version, hash) } -func ensureVersionExists() { - opts := tfe.AdminTerraformVersionsListOptions{ - ListOptions: tfe.ListOptions{ - PageNumber: 1, - PageSize: 100, - }, - } - hasVersion := false - -findTfVersion: - for { - tfVersionList, err := tfeClient.Admin.TerraformVersions.List(context.Background(), opts) - if err != nil { - log.Fatalf("Could not retrieve list of terraform versions: %v", err) - } - for _, item := range tfVersionList.Items { - if item.Version == terraformVersion { - hasVersion = true - break findTfVersion - } - } - - // Exit the loop when we've seen all pages. - if tfVersionList.CurrentPage >= tfVersionList.TotalPages { - break - } - - // Update the page number to get the next page. - opts.PageNumber = tfVersionList.NextPage - } - - if !hasVersion { - log.Fatalf("Terraform Version %s does not exist in the list. Please add it.", terraformVersion) - } -} - func writeCredRC(file string) { creds := credentialBlock() f, err := os.Create(file) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go new file mode 100644 index 000000000000..a6c4f8190730 --- /dev/null +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -0,0 +1,18 @@ +package main + +import ( + "testing" +) + +/* + "multi" == multi-backend, multiple workspaces + -- when cloud config == name -> + ---- prompt -> do you want to ONLY migrate the current workspace + + -- when cloud config == tags + -- If Default present, prompt to rename default. + -- Then -> Prompt with * +*/ +func Test_migrate_multi_to_tfc(t *testing.T) { + t.Skip("todo: see comments") +} diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go new file mode 100644 index 000000000000..6819ea7aacd5 --- /dev/null +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -0,0 +1,31 @@ +package main + +import ( + "testing" +) + +// REMOTE BACKEND +/* + - RB name -> TFC name + -- straight copy if only if different name, or same WS name in diff org + -- other + -- ensure that the local workspace, after migration, is the new name (in the tfc config block) + - RB name -> TFC tags + -- just add tag, if in same org + -- If new org, if WS exists, just add tag + -- If new org, if WS not exists, create and add tag + - RB prefix -> TFC name + -- create if not exists + -- migrate the current worksapce state to ws name + - RB prefix -> TFC tags + -- update previous workspaces (prefix + local) with cloud config tag + -- Rename the local workspaces to match the TFC workspaces (prefix + former local, ie app-prod). inform user + +*/ +func Test_migrate_remote_backend_name_to_tfc(t *testing.T) { + t.Skip("todo: see comments") +} + +func Test_migrate_remote_backend_prefix_to_tfc(t *testing.T) { + t.Skip("todo: see comments") +} diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go new file mode 100644 index 000000000000..28292419ccc1 --- /dev/null +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -0,0 +1,196 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "context" + "fmt" + "io/ioutil" + "os" + "testing" + + expect "github.com/Netflix/go-expect" + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/e2e" +) + +func Test_migrate_single_to_tfc(t *testing.T) { + ctx := context.Background() + + cases := map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "migrate using cloud workspace name strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply"}, + userInput: []string{"yes"}, + expectedOutput: `Do you want to perform these actions?`, + postInputOutput: `Apply complete!`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedOutput: `Do you want to copy existing state to the new backend?`, + userInput: []string{"yes"}, + postInputOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"workspace", "list"}, + expectedOutput: `new-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + if err != nil { + t.Fatal(err) + } + ws := wsList.Items[0] + if ws.Name != "new-workspace" { + t.Fatalf("Expected workspace to be `new-workspace`, but is %s", ws.Name) + } + }, + }, + "migrate using cloud workspace tags strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply"}, + userInput: []string{"yes"}, + expectedOutput: `Do you want to perform these actions?`, + postInputOutput: `Apply complete!`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedOutput: `The "cloud" backend configuration only allows named workspaces!`, + userInput: []string{"new-workspace", "yes"}, + postInputOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"workspace", "list"}, + expectedOutput: `new-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + ws := wsList.Items[0] + if ws.Name != "new-workspace" { + t.Fatalf("Expected workspace to be `new-workspace`, but is %s", ws.Name) + } + }, + }, + } + + for name, tc := range cases { + fmt.Println("Test: ", name) + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=info") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedOutput) + if err != nil { + t.Fatal(err) + } + } + + if len(tfCmd.userInput) > 0 { + for _, input := range tfCmd.userInput { + exp.SendLine(input) + } + } + + if tfCmd.postInputOutput != "" { + _, err := exp.ExpectString(tfCmd.postInputOutput) + if err != nil { + t.Fatal(err) + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } + } +} diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go new file mode 100644 index 000000000000..750a315b8459 --- /dev/null +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -0,0 +1,113 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "fmt" + "io/ioutil" + "os" + "testing" + + expect "github.com/Netflix/go-expect" + "github.com/hashicorp/terraform/internal/e2e" +) + +func Test_migrate_tfc_to_other(t *testing.T) { + cases := map[string]struct { + operations []operationSets + }{ + "migrate from cloud to local backend": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: `Successfully configured the backend "cloud"!`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedOutput: `Migrating state from Terraform Cloud to another backend is not yet implemented.`, + expectError: true, + }, + }, + }, + }, + }, + } + + for name, tc := range cases { + fmt.Println("Test: ", name) + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=info") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedOutput) + if err != nil { + t.Fatal(err) + } + } + + if len(tfCmd.userInput) > 0 { + for _, input := range tfCmd.userInput { + exp.SendLine(input) + } + } + + if tfCmd.postInputOutput != "" { + _, err := exp.ExpectString(tfCmd.postInputOutput) + if err != nil { + t.Fatal(err) + } + } + + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } + } + } + } +} diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go new file mode 100644 index 000000000000..17bbc05069a9 --- /dev/null +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -0,0 +1,21 @@ +package main + +import ( + "testing" +) + +/* + + If org to org, treat it like a new backend. Then go through the multi/single logic + + If same org, but name/tag changes + config name -> config name + -- straight copy + config name -> config tags + -- jsut add tag to workspace. + config tags -> config name + -- straight copy +*/ +func Test_migrate_tfc_to_tfc(t *testing.T) { + t.Skip("todo: see comments") +} diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index e998b0ffdf00..132bd96efdb0 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -12,6 +12,7 @@ import ( "strings" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" @@ -46,25 +47,18 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { log.Printf("[TRACE] backendMigrateState: need to migrate from %q to %q backend config", opts.SourceType, opts.DestinationType) // We need to check what the named state status is. If we're converting // from multi-state to single-state for example, we need to handle that. - var sourceSingleState, destinationSingleState bool - sourceWorkspaces, err := opts.Source.Workspaces() - if err == backend.ErrWorkspacesNotSupported { - sourceSingleState = true - err = nil - } - if err != nil { - return fmt.Errorf(strings.TrimSpace( - errMigrateLoadStates), opts.SourceType, err) - } + var sourceSingleState, destinationSingleState, sourceTFC, destinationTFC bool - destinationWorkspaces, err := opts.Destination.Workspaces() - if err == backend.ErrWorkspacesNotSupported { - destinationSingleState = true - err = nil + _, sourceTFC = opts.Source.(*cloud.Cloud) + _, destinationTFC = opts.Destination.(*cloud.Cloud) + + sourceWorkspaces, sourceSingleState, err := retrieveWorkspaces(opts.Source, opts.SourceType) + if err != nil { + return err } + destinationWorkspaces, destinationSingleState, err := retrieveWorkspaces(opts.Destination, opts.SourceType) if err != nil { - return fmt.Errorf(strings.TrimSpace( - errMigrateLoadStates), opts.DestinationType, err) + return err } // Set up defaults @@ -103,6 +97,9 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { // Determine migration behavior based on whether the source/destination // supports multi-state. switch { + case sourceTFC || destinationTFC: + return m.backendMigrateTFC(opts) + // Single-state to single-state. This is the easiest case: we just // copy the default state directly. case sourceSingleState && destinationSingleState: @@ -497,6 +494,91 @@ func (m *Meta) backendMigrateNonEmptyConfirm( return m.confirm(inputOpts) } +func retrieveWorkspaces(back backend.Backend, sourceType string) ([]string, bool, error) { + var singleState bool + var err error + workspaces, err := back.Workspaces() + if err == backend.ErrWorkspacesNotSupported { + singleState = true + err = nil + } + if err != nil { + return nil, singleState, fmt.Errorf(strings.TrimSpace( + errMigrateLoadStates), sourceType, err) + } + + return workspaces, singleState, err +} + +func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { + _, sourceTFC := opts.Source.(*cloud.Cloud) + cloudBackendDestination, destinationTFC := opts.Destination.(*cloud.Cloud) + + sourceWorkspaces, sourceSingleState, err := retrieveWorkspaces(opts.Source, opts.SourceType) + if err != nil { + return err + } + //to be used below, not yet implamented + // destinationWorkspaces, destinationSingleState + _, _, err = retrieveWorkspaces(opts.Destination, opts.SourceType) + if err != nil { + return err + } + + // from TFC to non-TFC backend + if sourceTFC && !destinationTFC { + // From Terraform Cloud to another backend. This is not yet implemented, and + // we recommend people to use the TFC API. + return fmt.Errorf(strings.TrimSpace(errTFCMigrateNotYetImplemented)) + } + + // from TFC to TFC + if sourceTFC && destinationTFC { + // TODO: see internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go for notes + panic("not yet implemented") + } + + // Everything below, by the above two conditionals, now assumes that the + // destination is always Terraform Cloud (TFC). + + sourceSingle := sourceSingleState || (len(sourceWorkspaces) == 1 && sourceWorkspaces[0] == backend.DefaultStateName) + if sourceSingle { + if cloudBackendDestination.WorkspaceMapping.Strategy() == cloud.WorkspaceNameStrategy { + // If we know the name via WorkspaceNameStrategy, then set the + // destinationWorkspace to the new Name and skip the user prompt. Here the + // destinationWorkspace is not set to `default` thereby we will create it + // in TFC if it does not exist. + opts.destinationWorkspace = cloudBackendDestination.WorkspaceMapping.Name + } + // Run normal single-to-single state migration + // This will handle both situations where the new cloud backend + // configuration is using a workspace.name strategy or workspace.tags + // strategy. + return m.backendMigrateState_s_s(opts) + } + + destinationTagsStrategy := cloudBackendDestination.WorkspaceMapping.Strategy() == cloud.WorkspaceTagsStrategy + destinationNameStrategy := cloudBackendDestination.WorkspaceMapping.Strategy() == cloud.WorkspaceNameStrategy + + multiSource := !sourceSingleState && len(sourceWorkspaces) > 1 + if multiSource && destinationNameStrategy { + // we have to take the current workspace from the source and migrate that + // over to destination. Since there is multiple sources, and we are using a + // name strategy, we will only migrate the current workspace. + panic("not yet implemented") + } + + // Multiple sources, and using tags strategy. So migrate every source + // workspace over to new one, prompt for workspace name pattern (*), + // and start migrating, and create tags for each workspace. + if multiSource && destinationTagsStrategy { + // TODO: see internal/cloud/e2e/migrate_state_multi_to_tfc_test.go for notes + panic("not yet implemented") + } + + return nil +} + const errMigrateLoadStates = ` Error inspecting states in the %q backend: %s @@ -541,6 +623,12 @@ The state in the previous backend remains intact and unmodified. Please resolve the error above and try again. ` +const errTFCMigrateNotYetImplemented = ` +Migrating state from Terraform Cloud to another backend is not yet implemented. + +Please use the API to do this: https://www.terraform.io/docs/cloud/api/state-versions.html +` + const inputBackendMigrateEmpty = ` Pre-existing state was found while migrating the previous %q backend to the newly configured %q backend. No existing state was found in the newly From dbbfae5a1cbd5a1a7bd5526b8ce06fece9ec9381 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Wed, 6 Oct 2021 16:10:25 -0600 Subject: [PATCH 228/644] refactor ParseVariableValues into separate operations 1. ParseDeclaredValues: parses unparsed variables into terraform.InputValues 2. ProbeUndeclaredVariableValues: compares variable declarations with unparsed values to warn/error about undeclared variables --- internal/backend/unparsed_value.go | 177 ++++++++++++-------- internal/backend/unparsed_value_test.go | 206 +++++++++++++++++------- 2 files changed, 263 insertions(+), 120 deletions(-) diff --git a/internal/backend/unparsed_value.go b/internal/backend/unparsed_value.go index abd16ef9eacd..91c9825826e2 100644 --- a/internal/backend/unparsed_value.go +++ b/internal/backend/unparsed_value.go @@ -25,87 +25,65 @@ type UnparsedVariableValue interface { ParseVariableValue(mode configs.VariableParsingMode) (*terraform.InputValue, tfdiags.Diagnostics) } -// ParseVariableValues processes a map of unparsed variable values by -// correlating each one with the given variable declarations which should -// be from a root module. -// -// The map of unparsed variable values should include variables from all -// possible root module declarations sources such that it is as complete as -// it can possibly be for the current operation. If any declared variables -// are not included in the map, ParseVariableValues will either substitute -// a configured default value or produce an error. -// -// If this function returns without any errors in the diagnostics, the -// resulting input values map is guaranteed to be valid and ready to pass -// to terraform.NewContext. If the diagnostics contains errors, the returned -// InputValues may be incomplete but will include the subset of variables -// that were successfully processed, allowing for careful analysis of the -// partial result. -func ParseVariableValues(vv map[string]UnparsedVariableValue, decls map[string]*configs.Variable) (terraform.InputValues, tfdiags.Diagnostics) { +// ParseUndeclaredVariableValues processes a map of unparsed variable values +// and returns an input values map of the ones not declared in the specified +// declaration map along with detailed diagnostics about values of undeclared +// variables being present, depending on the source of these values. If more +// than two undeclared values are present in file form (config, auto, -var-file) +// the remaining errors are summarized to avoid a massive list of errors. +func ParseUndeclaredVariableValues(vv map[string]UnparsedVariableValue, decls map[string]*configs.Variable) (terraform.InputValues, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics ret := make(terraform.InputValues, len(vv)) - - // Currently we're generating only warnings for undeclared variables - // defined in files (see below) but we only want to generate a few warnings - // at a time because existing deployments may have lots of these and - // the result can therefore be overwhelming. seenUndeclaredInFile := 0 for name, rv := range vv { - var mode configs.VariableParsingMode - config, declared := decls[name] - if declared { - mode = config.ParsingMode - } else { - mode = configs.VariableParseLiteral + if _, declared := decls[name]; declared { + // Only interested in parsing undeclared variables + continue } - val, valDiags := rv.ParseVariableValue(mode) - diags = diags.Append(valDiags) + val, valDiags := rv.ParseVariableValue(configs.VariableParseLiteral) if valDiags.HasErrors() { continue } - if !declared { - switch val.SourceType { - case terraform.ValueFromConfig, terraform.ValueFromAutoFile, terraform.ValueFromNamedFile: - // We allow undeclared names for variable values from files and warn in case - // users have forgotten a variable {} declaration or have a typo in their var name. - // Some users will actively ignore this warning because they use a .tfvars file - // across multiple configurations. - if seenUndeclaredInFile < 2 { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Warning, - "Value for undeclared variable", - fmt.Sprintf("The root module does not declare a variable named %q but a value was found in file %q. If you meant to use this value, add a \"variable\" block to the configuration.\n\nTo silence these warnings, use TF_VAR_... environment variables to provide certain \"global\" settings to all configurations in your organization. To reduce the verbosity of these warnings, use the -compact-warnings option.", name, val.SourceRange.Filename), - )) - } - seenUndeclaredInFile++ - - case terraform.ValueFromEnvVar: - // We allow and ignore undeclared names for environment - // variables, because users will often set these globally - // when they are used across many (but not necessarily all) - // configurations. - case terraform.ValueFromCLIArg: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Value for undeclared variable", - fmt.Sprintf("A variable named %q was assigned on the command line, but the root module does not declare a variable of that name. To use this value, add a \"variable\" block to the configuration.", name), - )) - default: - // For all other source types we are more vague, but other situations - // don't generally crop up at this layer in practice. + ret[name] = val + + switch val.SourceType { + case terraform.ValueFromConfig, terraform.ValueFromAutoFile, terraform.ValueFromNamedFile: + // We allow undeclared names for variable values from files and warn in case + // users have forgotten a variable {} declaration or have a typo in their var name. + // Some users will actively ignore this warning because they use a .tfvars file + // across multiple configurations. + if seenUndeclaredInFile < 2 { diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, + tfdiags.Warning, "Value for undeclared variable", - fmt.Sprintf("A variable named %q was assigned a value, but the root module does not declare a variable of that name. To use this value, add a \"variable\" block to the configuration.", name), + fmt.Sprintf("The root module does not declare a variable named %q but a value was found in file %q. If you meant to use this value, add a \"variable\" block to the configuration.\n\nTo silence these warnings, use TF_VAR_... environment variables to provide certain \"global\" settings to all configurations in your organization. To reduce the verbosity of these warnings, use the -compact-warnings option.", name, val.SourceRange.Filename), )) } - continue - } + seenUndeclaredInFile++ - ret[name] = val + case terraform.ValueFromEnvVar: + // We allow and ignore undeclared names for environment + // variables, because users will often set these globally + // when they are used across many (but not necessarily all) + // configurations. + case terraform.ValueFromCLIArg: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Value for undeclared variable", + fmt.Sprintf("A variable named %q was assigned on the command line, but the root module does not declare a variable of that name. To use this value, add a \"variable\" block to the configuration.", name), + )) + default: + // For all other source types we are more vague, but other situations + // don't generally crop up at this layer in practice. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Value for undeclared variable", + fmt.Sprintf("A variable named %q was assigned a value, but the root module does not declare a variable of that name. To use this value, add a \"variable\" block to the configuration.", name), + )) + } } if seenUndeclaredInFile > 2 { @@ -117,12 +95,79 @@ func ParseVariableValues(vv map[string]UnparsedVariableValue, decls map[string]* }) } + return ret, diags +} + +// ParseDeclaredVariableValues processes a map of unparsed variable values +// and returns an input values map of the ones declared in the specified +// variable declaration mapping. Diagnostics will be populating with +// any variable parsing errors encountered within this collection. +func ParseDeclaredVariableValues(vv map[string]UnparsedVariableValue, decls map[string]*configs.Variable) (terraform.InputValues, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + ret := make(terraform.InputValues, len(vv)) + + for name, rv := range vv { + var mode configs.VariableParsingMode + config, declared := decls[name] + + if declared { + mode = config.ParsingMode + } else { + // Only interested in parsing declared variables + continue + } + + val, valDiags := rv.ParseVariableValue(mode) + diags = diags.Append(valDiags) + if valDiags.HasErrors() { + continue + } + + ret[name] = val + } + + return ret, diags +} + +// Checks all given terraform.InputValues variable maps for the existance of +// a named variable +func isDefinedAny(name string, maps ...terraform.InputValues) bool { + for _, m := range maps { + if _, defined := m[name]; defined { + return true + } + } + return false +} + +// ParseVariableValues processes a map of unparsed variable values by +// correlating each one with the given variable declarations which should +// be from a root module. +// +// The map of unparsed variable values should include variables from all +// possible root module declarations sources such that it is as complete as +// it can possibly be for the current operation. If any declared variables +// are not included in the map, ParseVariableValues will either substitute +// a configured default value or produce an error. +// +// If this function returns without any errors in the diagnostics, the +// resulting input values map is guaranteed to be valid and ready to pass +// to terraform.NewContext. If the diagnostics contains errors, the returned +// InputValues may be incomplete but will include the subset of variables +// that were successfully processed, allowing for careful analysis of the +// partial result. +func ParseVariableValues(vv map[string]UnparsedVariableValue, decls map[string]*configs.Variable) (terraform.InputValues, tfdiags.Diagnostics) { + ret, diags := ParseDeclaredVariableValues(vv, decls) + undeclared, diagsUndeclared := ParseUndeclaredVariableValues(vv, decls) + + diags = diags.Append(diagsUndeclared) + // By this point we should've gathered all of the required root module // variables from one of the many possible sources. We'll now populate // any we haven't gathered as their defaults and fail if any of the // missing ones are required. for name, vc := range decls { - if _, defined := ret[name]; defined { + if isDefinedAny(name, ret, undeclared) { continue } diff --git a/internal/backend/unparsed_value_test.go b/internal/backend/unparsed_value_test.go index 6df7c226a47b..981c84a43e7a 100644 --- a/internal/backend/unparsed_value_test.go +++ b/internal/backend/unparsed_value_test.go @@ -13,7 +13,7 @@ import ( "github.com/hashicorp/terraform/internal/tfdiags" ) -func TestParseVariableValuesUndeclared(t *testing.T) { +func TestUnparsedValue(t *testing.T) { vv := map[string]UnparsedVariableValue{ "undeclared0": testUnparsedVariableValue("0"), "undeclared1": testUnparsedVariableValue("1"), @@ -59,66 +59,164 @@ func TestParseVariableValuesUndeclared(t *testing.T) { }, } - gotVals, diags := ParseVariableValues(vv, decls) - for _, diag := range diags { - t.Logf("%s: %s", diag.Description().Summary, diag.Description().Detail) - } - if got, want := len(diags), 4; got != want { - t.Fatalf("wrong number of diagnostics %d; want %d", got, want) - } - const undeclSingular = `Value for undeclared variable` const undeclPlural = `Values for undeclared variables` - const missingRequired = `No value for required variable` - if got, want := diags[0].Description().Summary, undeclSingular; got != want { - t.Errorf("wrong summary for diagnostic 0\ngot: %s\nwant: %s", got, want) - } - if got, want := diags[1].Description().Summary, undeclSingular; got != want { - t.Errorf("wrong summary for diagnostic 1\ngot: %s\nwant: %s", got, want) - } - if got, want := diags[2].Description().Summary, undeclPlural; got != want { - t.Errorf("wrong summary for diagnostic 2\ngot: %s\nwant: %s", got, want) - } - if got, want := diags[2].Description().Detail, "3 other variable(s)"; !strings.Contains(got, want) { - t.Errorf("wrong detail for diagnostic 2\ngot: %s\nmust contain: %s", got, want) - } - if got, want := diags[3].Description().Summary, missingRequired; got != want { - t.Errorf("wrong summary for diagnostic 3\ngot: %s\nwant: %s", got, want) - } + t.Run("ParseDeclaredVariableValues", func(t *testing.T) { + gotVals, diags := ParseDeclaredVariableValues(vv, decls) - wantVals := terraform.InputValues{ - "declared1": { - Value: cty.StringVal("5"), - SourceType: terraform.ValueFromNamedFile, - SourceRange: tfdiags.SourceRange{ - Filename: "fake.tfvars", - Start: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, - End: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + if got, want := len(diags), 0; got != want { + t.Fatalf("wrong number of diagnostics %d; want %d", got, want) + } + + wantVals := terraform.InputValues{ + "declared1": { + Value: cty.StringVal("5"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + End: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + }, }, - }, - "missing1": { - Value: cty.DynamicVal, - SourceType: terraform.ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "fake.tf", - Start: tfdiags.SourcePos{Line: 3, Column: 1, Byte: 0}, - End: tfdiags.SourcePos{Line: 3, Column: 1, Byte: 0}, + } + + if diff := cmp.Diff(wantVals, gotVals, cmp.Comparer(cty.Value.RawEquals)); diff != "" { + t.Errorf("wrong result\n%s", diff) + } + }) + + t.Run("ParseUndeclaredVariableValues", func(t *testing.T) { + gotVals, diags := ParseUndeclaredVariableValues(vv, decls) + + if got, want := len(diags), 3; got != want { + t.Fatalf("wrong number of diagnostics %d; want %d", got, want) + } + + if got, want := diags[0].Description().Summary, undeclSingular; got != want { + t.Errorf("wrong summary for diagnostic 0\ngot: %s\nwant: %s", got, want) + } + + if got, want := diags[1].Description().Summary, undeclSingular; got != want { + t.Errorf("wrong summary for diagnostic 1\ngot: %s\nwant: %s", got, want) + } + + if got, want := diags[2].Description().Summary, undeclPlural; got != want { + t.Errorf("wrong summary for diagnostic 2\ngot: %s\nwant: %s", got, want) + } + + wantVals := terraform.InputValues{ + "undeclared0": { + Value: cty.StringVal("0"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1}, + End: tfdiags.SourcePos{Line: 1, Column: 1}, + }, }, - }, - "missing2": { - Value: cty.StringVal("default for missing2"), - SourceType: terraform.ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "fake.tf", - Start: tfdiags.SourcePos{Line: 4, Column: 1, Byte: 0}, - End: tfdiags.SourcePos{Line: 4, Column: 1, Byte: 0}, + "undeclared1": { + Value: cty.StringVal("1"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1}, + End: tfdiags.SourcePos{Line: 1, Column: 1}, + }, }, - }, - } - if diff := cmp.Diff(wantVals, gotVals, cmp.Comparer(cty.Value.RawEquals)); diff != "" { - t.Errorf("wrong result\n%s", diff) - } + "undeclared2": { + Value: cty.StringVal("2"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1}, + End: tfdiags.SourcePos{Line: 1, Column: 1}, + }, + }, + "undeclared3": { + Value: cty.StringVal("3"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1}, + End: tfdiags.SourcePos{Line: 1, Column: 1}, + }, + }, + "undeclared4": { + Value: cty.StringVal("4"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1}, + End: tfdiags.SourcePos{Line: 1, Column: 1}, + }, + }, + } + if diff := cmp.Diff(wantVals, gotVals, cmp.Comparer(cty.Value.RawEquals)); diff != "" { + t.Errorf("wrong result\n%s", diff) + } + }) + + t.Run("ParseVariableValues", func(t *testing.T) { + gotVals, diags := ParseVariableValues(vv, decls) + for _, diag := range diags { + t.Logf("%s: %s", diag.Description().Summary, diag.Description().Detail) + } + if got, want := len(diags), 4; got != want { + t.Fatalf("wrong number of diagnostics %d; want %d", got, want) + } + + const missingRequired = `No value for required variable` + + if got, want := diags[0].Description().Summary, undeclSingular; got != want { + t.Errorf("wrong summary for diagnostic 0\ngot: %s\nwant: %s", got, want) + } + if got, want := diags[1].Description().Summary, undeclSingular; got != want { + t.Errorf("wrong summary for diagnostic 1\ngot: %s\nwant: %s", got, want) + } + if got, want := diags[2].Description().Summary, undeclPlural; got != want { + t.Errorf("wrong summary for diagnostic 2\ngot: %s\nwant: %s", got, want) + } + if got, want := diags[2].Description().Detail, "3 other variable(s)"; !strings.Contains(got, want) { + t.Errorf("wrong detail for diagnostic 2\ngot: %s\nmust contain: %s", got, want) + } + if got, want := diags[3].Description().Summary, missingRequired; got != want { + t.Errorf("wrong summary for diagnostic 3\ngot: %s\nwant: %s", got, want) + } + + wantVals := terraform.InputValues{ + "declared1": { + Value: cty.StringVal("5"), + SourceType: terraform.ValueFromNamedFile, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + End: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + }, + }, + "missing1": { + Value: cty.DynamicVal, + SourceType: terraform.ValueFromConfig, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tf", + Start: tfdiags.SourcePos{Line: 3, Column: 1, Byte: 0}, + End: tfdiags.SourcePos{Line: 3, Column: 1, Byte: 0}, + }, + }, + "missing2": { + Value: cty.StringVal("default for missing2"), + SourceType: terraform.ValueFromConfig, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tf", + Start: tfdiags.SourcePos{Line: 4, Column: 1, Byte: 0}, + End: tfdiags.SourcePos{Line: 4, Column: 1, Byte: 0}, + }, + }, + } + if diff := cmp.Diff(wantVals, gotVals, cmp.Comparer(cty.Value.RawEquals)); diff != "" { + t.Errorf("wrong result\n%s", diff) + } + }) } type testUnparsedVariableValue string From dd856f8a1b80bbc8e60aa172339ac8acc312a833 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Mon, 23 Aug 2021 13:35:54 -0400 Subject: [PATCH 229/644] Add run variables to cloud plan operations from non-file sources Run variables allow the run API to accept input variables not found in the configuration slug (the file-based ones plus workspace vars) --- go.mod | 6 +- go.sum | 12 +-- internal/cloud/backend_apply.go | 17 ---- internal/cloud/backend_apply_test.go | 18 ++-- internal/cloud/backend_common.go | 38 -------- internal/cloud/backend_plan.go | 35 ++++---- internal/cloud/backend_plan_test.go | 18 ++-- internal/cloud/cloud_variables.go | 52 +++++++++++ internal/cloud/cloud_variables_test.go | 119 +++++++++++++++++++++++++ 9 files changed, 220 insertions(+), 95 deletions(-) create mode 100644 internal/cloud/cloud_variables.go create mode 100644 internal/cloud/cloud_variables_test.go diff --git a/go.mod b/go.mod index 9910399a3266..5c09bc4b6c24 100644 --- a/go.mod +++ b/go.mod @@ -40,9 +40,9 @@ require ( github.com/hashicorp/go-hclog v0.15.0 github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 - github.com/hashicorp/go-retryablehttp v0.5.2 - github.com/hashicorp/go-tfe v0.19.1-0.20210922134841-a2c1784e9c00 - github.com/hashicorp/go-uuid v1.0.1 + github.com/hashicorp/go-retryablehttp v0.7.0 + github.com/hashicorp/go-tfe v0.19.1-0.20211001235029-ff29186e11db + github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f github.com/hashicorp/hcl/v2 v2.10.1 diff --git a/go.sum b/go.sum index 4b6b9daa3331..8972a8d9ef56 100644 --- a/go.sum +++ b/go.sum @@ -352,6 +352,7 @@ github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9n github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= github.com/hashicorp/go-getter v1.5.2 h1:XDo8LiAcDisiqZdv0TKgz+HtX3WN7zA2JD1R1tjsabE= github.com/hashicorp/go-getter v1.5.2/go.mod h1:orNH3BTYLu/fIxGIdLjLoAJHWMDQ/UKQr5O4m3iBuoo= +github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= github.com/hashicorp/go-hclog v0.12.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= github.com/hashicorp/go-hclog v0.15.0 h1:qMuK0wxsoW4D0ddCCYwPSTm4KQv1X1ke3WmPWZ0Mvsk= @@ -367,8 +368,8 @@ github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+l github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= github.com/hashicorp/go-plugin v1.4.3 h1:DXmvivbWD5qdiBts9TpBC7BYL1Aia5sxbRgQB+v6UZM= github.com/hashicorp/go-plugin v1.4.3/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ= -github.com/hashicorp/go-retryablehttp v0.5.2 h1:AoISa4P4IsW0/m4T6St8Yw38gTl5GtBAgfkhYh1xAz4= -github.com/hashicorp/go-retryablehttp v0.5.2/go.mod h1:9B5zBasrRhHXnJnui7y6sL7es7NDiJgTc6Er0maI1Xs= +github.com/hashicorp/go-retryablehttp v0.7.0 h1:eu1EI/mbirUgP5C8hVsTNaGZreBDlYiwC1FZWkvQPQ4= +github.com/hashicorp/go-retryablehttp v0.7.0/go.mod h1:vAew36LZh98gCBJNLH42IQ1ER/9wtLZZ8meHqQvEYWY= github.com/hashicorp/go-rootcerts v1.0.2 h1:jzhAVGtqPKbwpyCPELlgNWhE1znq+qwJtW5Oi2viEzc= github.com/hashicorp/go-rootcerts v1.0.2/go.mod h1:pqUvnprVnM5bf7AOirdbb01K4ccR319Vf4pU3K5EGc8= github.com/hashicorp/go-safetemp v1.0.0 h1:2HR189eFNrjHQyENnQMMpCiBAsRxzbTMIgBhEyExpmo= @@ -378,11 +379,12 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.19.1-0.20210922134841-a2c1784e9c00 h1:51ARk47jO4piKzhhbwk6u67ErvSuBj4cu2f2VS9HkgI= -github.com/hashicorp/go-tfe v0.19.1-0.20210922134841-a2c1784e9c00/go.mod h1:U5Iy307L+MazGg0uF8annDtaxAbPp4ElFZ9uPMrjw/I= +github.com/hashicorp/go-tfe v0.19.1-0.20211001235029-ff29186e11db h1:e7oSI8NO5bAJBGI8pTxvLkI/0/LMxRaBkJS9hFdKuMk= +github.com/hashicorp/go-tfe v0.19.1-0.20211001235029-ff29186e11db/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= -github.com/hashicorp/go-uuid v1.0.1 h1:fv1ep09latC32wFoVwnqcnKJGnMSdBanPczbHAYm1BE= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= +github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= +github.com/hashicorp/go-uuid v1.0.2/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-version v1.0.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.1.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= diff --git a/internal/cloud/backend_apply.go b/internal/cloud/backend_apply.go index 65f51ff6c5ad..85c447e60265 100644 --- a/internal/cloud/backend_apply.go +++ b/internal/cloud/backend_apply.go @@ -3,7 +3,6 @@ package cloud import ( "bufio" "context" - "fmt" "io" "log" @@ -59,22 +58,6 @@ func (b *Cloud) opApply(stopCtx, cancelCtx context.Context, op *backend.Operatio )) } - if b.hasExplicitVariableValues(op) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Run variables are currently not supported", - fmt.Sprintf( - "Terraform Cloud does not support setting run variables from command line arguments at this time. "+ - "Currently the only to way to pass variables is by "+ - "creating a '*.auto.tfvars' variables file. This file will automatically "+ - "be loaded when the workspace is configured to use "+ - "Terraform v0.10.0 or later.\n\nAdditionally you can also set variables on "+ - "the workspace in the web UI:\nhttps://%s/app/%s/%s/variables", - b.hostname, b.organization, op.Workspace, - ), - )) - } - if !op.HasConfig() && op.PlanMode != plans.DestroyMode { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index ad01c0d431a3..0151f39bc553 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -436,14 +436,15 @@ func TestCloud_applyWithReplace(t *testing.T) { } } -func TestCloud_applyWithVariables(t *testing.T) { +func TestCloud_applyWithRequiredVariables(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationApply(t, "./testdata/apply-variables") defer configCleanup() + defer done(t) - op.Variables = testVariables(terraform.ValueFromNamedFile, "foo", "bar") + op.Variables = testVariables(terraform.ValueFromNamedFile, "foo") // "bar" variable value missing op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) @@ -452,14 +453,15 @@ func TestCloud_applyWithVariables(t *testing.T) { } <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected apply operation to fail") + // The usual error of a required variable being missing is deferred and the operation + // is successful + if run.Result != backend.OperationSuccess { + t.Fatal("expected plan operation to succeed") } - errOutput := output.Stderr() - if !strings.Contains(errOutput, "variables are currently not supported") { - t.Fatalf("expected a variables error, got: %v", errOutput) + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running apply in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) } } diff --git a/internal/cloud/backend_common.go b/internal/cloud/backend_common.go index 92f28a1dd1a0..2ca3fc1a2d8d 100644 --- a/internal/cloud/backend_common.go +++ b/internal/cloud/backend_common.go @@ -208,44 +208,6 @@ func (b *Cloud) waitForRun(stopCtx, cancelCtx context.Context, op *backend.Opera } } -// hasExplicitVariableValues is a best-effort check to determine whether the -// user has provided -var or -var-file arguments to a remote operation. -// -// The results may be inaccurate if the configuration is invalid or if -// individual variable values are invalid. That's okay because we only use this -// result to hint the user to set variables a different way. It's always the -// remote system's responsibility to do final validation of the input. -func (b *Cloud) hasExplicitVariableValues(op *backend.Operation) bool { - // Load the configuration using the caller-provided configuration loader. - config, _, configDiags := op.ConfigLoader.LoadConfigWithSnapshot(op.ConfigDir) - if configDiags.HasErrors() { - // If we can't load the configuration then we'll assume no explicit - // variable values just to let the remote operation start and let - // the remote system return the same set of configuration errors. - return false - } - - // We're intentionally ignoring the diagnostics here because validation - // of the variable values is the responsibilty of the remote system. Our - // goal here is just to make a best effort count of how many variable - // values are coming from -var or -var-file CLI arguments so that we can - // hint the user that those are not supported for remote operations. - variables, _ := backend.ParseVariableValues(op.Variables, config.Module.Variables) - - // Check for explicitly-defined (-var and -var-file) variables, which the - // Terraform Cloud currently does not support. All other source types are okay, - // because they are implicit from the execution context anyway and so - // their final values will come from the _remote_ execution context. - for _, v := range variables { - switch v.SourceType { - case terraform.ValueFromCLIArg, terraform.ValueFromNamedFile: - return true - } - } - - return false -} - func (b *Cloud) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Operation, r *tfe.Run) error { if r.CostEstimate == nil { return nil diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 5455ec06ec9e..4abb22ee3fac 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -64,22 +64,6 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation )) } - if b.hasExplicitVariableValues(op) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Run variables are currently not supported", - fmt.Sprintf( - "Terraform Cloud does not support setting run variables from command line arguments at this time. "+ - "Currently the only to way to pass variables is by "+ - "creating a '*.auto.tfvars' variables file. This file will automatically "+ - "be loaded when the workspace is configured to use "+ - "Terraform v0.10.0 or later.\n\nAdditionally you can also set variables on "+ - "the workspace in the web UI:\nhttps://%s/app/%s/%s/variables", - b.hostname, b.organization, op.Workspace, - ), - )) - } - if !op.HasConfig() && op.PlanMode != plans.DestroyMode { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, @@ -241,6 +225,25 @@ in order to capture the filesystem context the remote workspace expects: } } + config, _, configDiags := op.ConfigLoader.LoadConfigWithSnapshot(op.ConfigDir) + if configDiags.HasErrors() { + return nil, fmt.Errorf("error loading config with snapshot: %w", configDiags.Errs()[0]) + } + variables, varDiags := ParseCloudRunVariables(op.Variables, config.Module.Variables) + + if varDiags.HasErrors() { + return nil, varDiags.Err() + } + + runVariables := make([]*tfe.RunVariable, len(variables)) + for name, value := range variables { + runVariables = append(runVariables, &tfe.RunVariable{ + Key: name, + Value: value, + }) + } + runOptions.Variables = runVariables + r, err := b.client.Runs.Create(stopCtx, runOptions) if err != nil { return r, generalError("Failed to create run", err) diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 3a6d2e74baa1..6c08c3762dd1 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -469,14 +469,15 @@ func TestCloud_planWithReplace(t *testing.T) { } } -func TestCloud_planWithVariables(t *testing.T) { +func TestCloud_planWithRequiredVariables(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() op, configCleanup, done := testOperationPlan(t, "./testdata/plan-variables") defer configCleanup() + defer done(t) - op.Variables = testVariables(terraform.ValueFromCLIArg, "foo", "bar") + op.Variables = testVariables(terraform.ValueFromCLIArg, "foo") // "bar" variable value missing op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) @@ -485,14 +486,15 @@ func TestCloud_planWithVariables(t *testing.T) { } <-run.Done() - output := done(t) - if run.Result == backend.OperationSuccess { - t.Fatal("expected plan operation to fail") + // The usual error of a required variable being missing is deferred and the operation + // is successful + if run.Result != backend.OperationSuccess { + t.Fatal("expected plan operation to succeed") } - errOutput := output.Stderr() - if !strings.Contains(errOutput, "variables are currently not supported") { - t.Fatalf("expected a variables error, got: %v", errOutput) + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Running plan in Terraform Cloud") { + t.Fatalf("unexpected TFC header in output: %s", output) } } diff --git a/internal/cloud/cloud_variables.go b/internal/cloud/cloud_variables.go new file mode 100644 index 000000000000..9a900282862d --- /dev/null +++ b/internal/cloud/cloud_variables.go @@ -0,0 +1,52 @@ +package cloud + +import ( + "encoding/json" + "fmt" + + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" + ctyjson "github.com/zclconf/go-cty/cty/json" +) + +func allowedSourceType(source terraform.ValueSourceType) bool { + return source == terraform.ValueFromNamedFile || source == terraform.ValueFromCLIArg || source == terraform.ValueFromEnvVar +} + +// ParseCloudRunVariables accepts a mapping of unparsed values and a mapping of variable +// declarations and returns a name/value variable map appropriate for an API run context, +// that is, containing declared string variables only sourced from non-file inputs like CLI args +// and environment variables. However, all variable parsing diagnostics are returned +// in order to allow callers to short circuit cloud runs that contain variable +// declaration or parsing errors. The only exception is that missing required values are not +// considered errors because they may be defined within the cloud workspace. +func ParseCloudRunVariables(vv map[string]backend.UnparsedVariableValue, decls map[string]*configs.Variable) (map[string]string, tfdiags.Diagnostics) { + declared, diags := backend.ParseDeclaredVariableValues(vv, decls) + _, undedeclaredDiags := backend.ParseUndeclaredVariableValues(vv, decls) + diags = diags.Append(undedeclaredDiags) + + ret := make(map[string]string, len(declared)) + + // Even if there are parsing or declaration errors, populate the return map with the + // variables that could be used for cloud runs + for name, v := range declared { + if !allowedSourceType(v.SourceType) { + continue + } + + valueData, err := ctyjson.Marshal(v.Value, v.Value.Type()) + if err != nil { + return nil, diags.Append(fmt.Errorf("error marshaling input variable value as json: %w", err)) + } + var variableValue string + if err = json.Unmarshal(valueData, &variableValue); err != nil { + // This should never happen since cty marshaled the value to begin with without error + return nil, diags.Append(fmt.Errorf("error unmarshaling run variable: %w", err)) + } + ret[name] = variableValue + } + + return ret, diags +} diff --git a/internal/cloud/cloud_variables_test.go b/internal/cloud/cloud_variables_test.go new file mode 100644 index 000000000000..f8a8a5f1cf34 --- /dev/null +++ b/internal/cloud/cloud_variables_test.go @@ -0,0 +1,119 @@ +package cloud + +import ( + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/hashicorp/hcl/v2" + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/zclconf/go-cty/cty" +) + +func TestParseCloudRunVariables(t *testing.T) { + t.Run("populates variables from allowed sources", func(t *testing.T) { + vv := map[string]backend.UnparsedVariableValue{ + "undeclared": testUnparsedVariableValue{source: terraform.ValueFromCLIArg, value: "0"}, + "declaredFromConfig": testUnparsedVariableValue{source: terraform.ValueFromConfig, value: "1"}, + "declaredFromNamedFile": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: "2"}, + "declaredFromCLIArg": testUnparsedVariableValue{source: terraform.ValueFromCLIArg, value: "3"}, + "declaredFromEnvVar": testUnparsedVariableValue{source: terraform.ValueFromEnvVar, value: "4"}, + } + + decls := map[string]*configs.Variable{ + "declaredFromConfig": { + Name: "declaredFromConfig", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromNamedFile": { + Name: "declaredFromNamedFile", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromCLIArg": { + Name: "declaredFromCLIArg", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromEnvVar": { + Name: "declaredFromEnvVar", + Type: cty.String, + ConstraintType: cty.String, + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "missing": { + Name: "missing", + Type: cty.String, + ConstraintType: cty.String, + Default: cty.StringVal("2"), + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + } + wantVals := make(map[string]string) + + wantVals["declaredFromNamedFile"] = "2" + wantVals["declaredFromCLIArg"] = "3" + wantVals["declaredFromEnvVar"] = "4" + + gotVals, diags := ParseCloudRunVariables(vv, decls) + if diff := cmp.Diff(wantVals, gotVals, cmp.Comparer(cty.Value.RawEquals)); diff != "" { + t.Errorf("wrong result\n%s", diff) + } + + if got, want := len(diags), 1; got != want { + t.Fatalf("expected 1 variable error: %v, got %v", diags.Err(), want) + } + + if got, want := diags[0].Description().Summary, "Value for undeclared variable"; got != want { + t.Errorf("wrong summary for diagnostic 0\ngot: %s\nwant: %s", got, want) + } + }) +} + +type testUnparsedVariableValue struct { + source terraform.ValueSourceType + value string +} + +func (v testUnparsedVariableValue) ParseVariableValue(mode configs.VariableParsingMode) (*terraform.InputValue, tfdiags.Diagnostics) { + return &terraform.InputValue{ + Value: cty.StringVal(v.value), + SourceType: v.source, + SourceRange: tfdiags.SourceRange{ + Filename: "fake.tfvars", + Start: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + End: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, + }, + }, nil +} From 9963bf940a546d0e583bdf28a82830ead8b3e97e Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Mon, 11 Oct 2021 11:43:39 -0600 Subject: [PATCH 230/644] refactor: only fetch variables if unset variables are not allowed --- internal/cloud/backend_context.go | 32 +++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/internal/cloud/backend_context.go b/internal/cloud/backend_context.go index 95c80c5cbf49..24ed978547ad 100644 --- a/internal/cloud/backend_context.go +++ b/internal/cloud/backend_context.go @@ -82,22 +82,6 @@ func (b *Cloud) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Ful } ret.Config = config - // The underlying API expects us to use the opaque workspace id to request - // variables, so we'll need to look that up using our organization name - // and workspace name. - remoteWorkspaceID, err := b.getRemoteWorkspaceID(context.Background(), op.Workspace) - if err != nil { - diags = diags.Append(fmt.Errorf("error finding remote workspace: %w", err)) - return nil, nil, diags - } - - log.Printf("[TRACE] cloud: retrieving variables from workspace %s/%s (%s)", remoteWorkspaceName, b.organization, remoteWorkspaceID) - tfeVariables, err := b.client.Variables.List(context.Background(), remoteWorkspaceID, tfe.VariableListOptions{}) - if err != nil && err != tfe.ErrResourceNotFound { - diags = diags.Append(fmt.Errorf("error loading variables: %w", err)) - return nil, nil, diags - } - if op.AllowUnsetVariables { // If we're not going to use the variables in an operation we'll be // more lax about them, stubbing out any unset ones as unknown. @@ -105,6 +89,22 @@ func (b *Cloud) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Ful // but not enough information to run a real operation (plan, apply, etc) ret.PlanOpts.SetVariables = stubAllVariables(op.Variables, config.Module.Variables) } else { + // The underlying API expects us to use the opaque workspace id to request + // variables, so we'll need to look that up using our organization name + // and workspace name. + remoteWorkspaceID, err := b.getRemoteWorkspaceID(context.Background(), op.Workspace) + if err != nil { + diags = diags.Append(fmt.Errorf("error finding remote workspace: %w", err)) + return nil, nil, diags + } + + log.Printf("[TRACE] cloud: retrieving variables from workspace %s/%s (%s)", remoteWorkspaceName, b.organization, remoteWorkspaceID) + tfeVariables, err := b.client.Variables.List(context.Background(), remoteWorkspaceID, tfe.VariableListOptions{}) + if err != nil && err != tfe.ErrResourceNotFound { + diags = diags.Append(fmt.Errorf("error loading variables: %w", err)) + return nil, nil, diags + } + if tfeVariables != nil { if op.Variables == nil { op.Variables = make(map[string]backend.UnparsedVariableValue) From bf02b5cb5362d5203855959288c7e0cfd3f2e2d0 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Mon, 11 Oct 2021 16:14:44 -0600 Subject: [PATCH 231/644] e2e test for cloud run variables --- internal/cloud/e2e/apply_auto_approve_test.go | 14 -- internal/cloud/e2e/helper_test.go | 18 +++ internal/cloud/e2e/run_variables_test.go | 144 ++++++++++++++++++ 3 files changed, 162 insertions(+), 14 deletions(-) create mode 100644 internal/cloud/e2e/run_variables_test.go diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 8ece4836dd1d..4e5a65a02219 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -5,10 +5,8 @@ package main import ( "context" - "fmt" "io/ioutil" "log" - "os" "strings" "testing" @@ -238,15 +236,3 @@ func Test_terraform_apply_autoApprove(t *testing.T) { tc.validations(t, orgName, wsName) } } - -func writeMainTF(t *testing.T, block string, dir string) { - f, err := os.Create(fmt.Sprintf("%s/main.tf", dir)) - if err != nil { - t.Fatal(err) - } - _, err = f.WriteString(block) - if err != nil { - t.Fatal(err) - } - f.Close() -} diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index cad01a5c1a09..5af66bf1c663 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -6,6 +6,7 @@ package main import ( "context" "fmt" + "os" "testing" "time" @@ -31,6 +32,11 @@ type operationSets struct { prep func(t *testing.T, orgName, dir string) } +type testCases map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) +} + func createOrganization(t *testing.T) (*tfe.Organization, func()) { ctx := context.Background() org, err := tfeClient.Organizations.Create(ctx, tfe.OrganizationCreateOptions{ @@ -126,3 +132,15 @@ resource "random_pet" "server" { } `, tfeHostname, org, name) } + +func writeMainTF(t *testing.T, block string, dir string) { + f, err := os.Create(fmt.Sprintf("%s/main.tf", dir)) + if err != nil { + t.Fatal(err) + } + _, err = f.WriteString(block) + if err != nil { + t.Fatal(err) + } + f.Close() +} diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go new file mode 100644 index 000000000000..ba20077a14ff --- /dev/null +++ b/internal/cloud/e2e/run_variables_test.go @@ -0,0 +1,144 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "fmt" + "io/ioutil" + "os" + "testing" + + expect "github.com/Netflix/go-expect" + "github.com/hashicorp/terraform/internal/e2e" +) + +func terraformConfigRequiredVariable(org, name string) string { + return fmt.Sprintf(` +terraform { + cloud { + hostname = "%s" + organization = "%s" + + workspaces { + name = "%s" + } + } +} + +variable "foo" { + type = string +} + +variable "baz" { + type = string +} + +output "test_cli" { + value = var.foo +} + +output "test_env" { + value = var.baz +} + +`, tfeHostname, org, name) +} + +func Test_cloud_run_variables(t *testing.T) { + cases := testCases{ + "run variables from CLI arg": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigRequiredVariable(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"plan", "-var", "foo=bar"}, + expectedOutput: ` + test_cli = "bar"`, + }, + { + command: []string{"plan", "-var", "foo=bar"}, + expectedOutput: ` + test_env = "qux"`, + }, + }, + }, + }, + }, + } + + for name, tc := range cases { + fmt.Println("Test: ", name) + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=info") + tf.AddEnv("TF_CLI_ARGS=-no-color") + tf.AddEnv("TF_VAR_baz=qux") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedOutput) + if err != nil { + t.Fatal(err) + } + } + + if len(tfCmd.userInput) > 0 { + for _, input := range tfCmd.userInput { + exp.SendLine(input) + } + } + + if tfCmd.postInputOutput != "" { + _, err := exp.ExpectString(tfCmd.postInputOutput) + if err != nil { + t.Fatal(err) + } + } + + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } + } + } +} From edbc84420c9ecec0babeec04ae84b95e13d3b666 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Fri, 8 Oct 2021 14:36:37 -0500 Subject: [PATCH 232/644] Run apply -refresh-state instead of refresh When a user runs `terraform refresh` we give them an error message that tells them to run `terraform apply -refresh-state`. We could just run that command for them, though. That is what this PR does. --- internal/cloud/backend.go | 16 ++++- internal/cloud/backend_plan.go | 2 +- internal/cloud/backend_refresh_test.go | 79 +++++++++++++++++++++++++ internal/cloud/testdata/refresh/main.tf | 6 ++ internal/command/refresh.go | 7 +++ 5 files changed, 106 insertions(+), 4 deletions(-) create mode 100644 internal/cloud/backend_refresh_test.go create mode 100644 internal/cloud/testdata/refresh/main.tf diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 730d8be83836..2e611745e46c 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -18,6 +18,7 @@ import ( "github.com/hashicorp/terraform-svchost/disco" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statemgr" "github.com/hashicorp/terraform/internal/terraform" @@ -643,9 +644,16 @@ func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend. case backend.OperationTypeApply: f = b.opApply case backend.OperationTypeRefresh: - return nil, fmt.Errorf( - "\n\nThe \"refresh\" operation is not supported when using Terraform Cloud. " + - "Use \"terraform apply -refresh-only\" instead.") + // The `terraform refresh` command has been deprecated in favor of `terraform apply -refresh-state`. + // Rather than respond with an error telling the user to run the other command we can just run + // that command instead. We will tell the user what we are doing, and then do it. + if b.CLI != nil { + b.CLI.Output(b.Colorize().Color(strings.TrimSpace(refreshToApplyRefresh) + "\n")) + } + op.PlanMode = plans.RefreshOnlyMode + op.PlanRefresh = true + op.AutoApprove = true + f = b.opApply default: return nil, fmt.Errorf( "\n\nTerraform Cloud does not support the %q operation.", op.Type) @@ -982,6 +990,8 @@ const operationNotCanceled = ` [reset][red]The remote operation was not cancelled.[reset] ` +const refreshToApplyRefresh = `[bold][yellow]Proceeding with 'terraform apply -refresh-only -auto-approve'.[reset]` + var ( workspaceConfigurationHelp = fmt.Sprintf( `The 'workspaces' block configures how Terraform CLI maps its workspaces for this single diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 4abb22ee3fac..1956a9c82954 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -87,7 +87,7 @@ func (b *Cloud) opPlan(stopCtx, cancelCtx context.Context, op *backend.Operation func (b *Cloud) plan(stopCtx, cancelCtx context.Context, op *backend.Operation, w *tfe.Workspace) (*tfe.Run, error) { if b.CLI != nil { header := planDefaultHeader - if op.Type == backend.OperationTypeApply { + if op.Type == backend.OperationTypeApply || op.Type == backend.OperationTypeRefresh { header = applyDefaultHeader } b.CLI.Output(b.Colorize().Color(strings.TrimSpace(header) + "\n")) diff --git a/internal/cloud/backend_refresh_test.go b/internal/cloud/backend_refresh_test.go new file mode 100644 index 000000000000..3abb93577793 --- /dev/null +++ b/internal/cloud/backend_refresh_test.go @@ -0,0 +1,79 @@ +package cloud + +import ( + "context" + "strings" + "testing" + "time" + + "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/command/arguments" + "github.com/hashicorp/terraform/internal/command/clistate" + "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/initwd" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terminal" + "github.com/mitchellh/cli" +) + +func testOperationRefresh(t *testing.T, configDir string) (*backend.Operation, func(), func(*testing.T) *terminal.TestOutput) { + t.Helper() + + return testOperationRefreshWithTimeout(t, configDir, 0) +} + +func testOperationRefreshWithTimeout(t *testing.T, configDir string, timeout time.Duration) (*backend.Operation, func(), func(*testing.T) *terminal.TestOutput) { + t.Helper() + + _, configLoader, configCleanup := initwd.MustLoadConfigForTests(t, configDir) + + streams, done := terminal.StreamsForTesting(t) + view := views.NewView(streams) + stateLockerView := views.NewStateLocker(arguments.ViewHuman, view) + operationView := views.NewOperation(arguments.ViewHuman, false, view) + + return &backend.Operation{ + ConfigDir: configDir, + ConfigLoader: configLoader, + PlanRefresh: true, + StateLocker: clistate.NewLocker(timeout, stateLockerView), + Type: backend.OperationTypeRefresh, + View: operationView, + }, configCleanup, done +} + +func TestCloud_refreshBasicActuallyRunsApplyRefresh(t *testing.T) { + b, bCleanup := testBackendWithName(t) + defer bCleanup() + + op, configCleanup, done := testOperationRefresh(t, "./testdata/refresh") + defer configCleanup() + defer done(t) + + op.UIOut = b.CLI + b.CLIColor = b.cliColorize() + op.PlanMode = plans.RefreshOnlyMode + op.Workspace = testBackendSingleWorkspaceName + + run, err := b.Operation(context.Background(), op) + if err != nil { + t.Fatalf("error starting operation: %v", err) + } + + <-run.Done() + if run.Result != backend.OperationSuccess { + t.Fatalf("operation failed: %s", b.CLI.(*cli.MockUi).ErrorWriter.String()) + } + + output := b.CLI.(*cli.MockUi).OutputWriter.String() + if !strings.Contains(output, "Proceeding with 'terraform apply -refresh-only -auto-approve'") { + t.Fatalf("expected TFC header in output: %s", output) + } + + stateMgr, _ := b.StateMgr(testBackendSingleWorkspaceName) + // An error suggests that the state was not unlocked after apply + if _, err := stateMgr.Lock(statemgr.NewLockInfo()); err != nil { + t.Fatalf("unexpected error locking state after apply: %s", err.Error()) + } +} diff --git a/internal/cloud/testdata/refresh/main.tf b/internal/cloud/testdata/refresh/main.tf new file mode 100644 index 000000000000..8d61d5f51808 --- /dev/null +++ b/internal/cloud/testdata/refresh/main.tf @@ -0,0 +1,6 @@ +resource "random_pet" "always_new" { + keepers = { + uuid = uuid() # Force a new name each time + } + length = 3 +} diff --git a/internal/command/refresh.go b/internal/command/refresh.go index 1bb5d3933c75..c7c041eb72b5 100644 --- a/internal/command/refresh.go +++ b/internal/command/refresh.go @@ -17,10 +17,17 @@ type RefreshCommand struct { } func (c *RefreshCommand) Run(rawArgs []string) int { + var diags tfdiags.Diagnostics + // Parse and apply global view arguments common, rawArgs := arguments.ParseView(rawArgs) c.View.Configure(common) + // Propagate -no-color for the remote backend's legacy use of Ui. This + // should be removed when the remote backend is migrated to views. + c.Meta.color = !common.NoColor + c.Meta.Color = c.Meta.color + // Parse and validate flags args, diags := arguments.ParseRefresh(rawArgs) From 83337de6540da9012453669f3fa5400795aa9db7 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Mon, 11 Oct 2021 16:26:07 -0500 Subject: [PATCH 233/644] Remove prefix from the cloud backend config Now that we have tags we no longer need prefix. --- internal/cloud/backend.go | 73 ++------ internal/cloud/backend_apply_test.go | 18 +- internal/cloud/backend_context.go | 7 +- internal/cloud/backend_plan_test.go | 8 +- internal/cloud/backend_test.go | 246 ++++++--------------------- internal/cloud/errors.go | 4 +- internal/cloud/testing.go | 27 +-- 7 files changed, 81 insertions(+), 302 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 2e611745e46c..2bf5d3c4d878 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -128,11 +128,6 @@ func (b *Cloud) ConfigSchema() *configschema.Block { Optional: true, Description: schemaDescriptionName, }, - "prefix": { - Type: cty.String, - Optional: true, - Description: schemaDescriptionPrefix, - }, "tags": { Type: cty.Set(cty.String), Optional: true, @@ -162,9 +157,6 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { if val := workspaces.GetAttr("name"); !val.IsNull() { WorkspaceMapping.Name = val.AsString() } - if val := workspaces.GetAttr("prefix"); !val.IsNull() { - WorkspaceMapping.Prefix = val.AsString() - } if val := workspaces.GetAttr("tags"); !val.IsNull() { err := gocty.FromCtyValue(val, &WorkspaceMapping.Tags) if err != nil { @@ -177,7 +169,7 @@ func (b *Cloud) PrepareConfig(obj cty.Value) (cty.Value, tfdiags.Diagnostics) { // Make sure have a workspace mapping strategy present case WorkspaceNoneStrategy: diags = diags.Append(invalidWorkspaceConfigMissingValues) - // Make sure that only one of workspace name or a prefix is configured. + // Make sure that a workspace name is configured. case WorkspaceInvalidStrategy: diags = diags.Append(invalidWorkspaceConfigMisconfiguration) } @@ -339,16 +331,13 @@ func (b *Cloud) setConfigurationFields(obj cty.Value) tfdiags.Diagnostics { } // Get the workspaces configuration block and retrieve the - // default workspace name and prefix. + // default workspace name. if workspaces := obj.GetAttr("workspaces"); !workspaces.IsNull() { // PrepareConfig checks that you cannot set both of these. if val := workspaces.GetAttr("name"); !val.IsNull() { b.WorkspaceMapping.Name = val.AsString() } - if val := workspaces.GetAttr("prefix"); !val.IsNull() { - b.WorkspaceMapping.Prefix = val.AsString() - } if val := workspaces.GetAttr("tags"); !val.IsNull() { var tags []string err := gocty.FromCtyValue(val, &tags) @@ -447,10 +436,7 @@ func (b *Cloud) Workspaces() ([]string, error) { // Otherwise, multiple workspaces are being mapped. Query Terraform Cloud for all the remote // workspaces by the provided mapping strategy. options := tfe.WorkspaceListOptions{} - switch b.WorkspaceMapping.Strategy() { - case WorkspacePrefixStrategy: - options.Search = tfe.String(b.WorkspaceMapping.Prefix) - case WorkspaceTagsStrategy: + if b.WorkspaceMapping.Strategy() == WorkspaceTagsStrategy { taglist := strings.Join(b.WorkspaceMapping.Tags, ",") options.Tags = &taglist } @@ -462,18 +448,7 @@ func (b *Cloud) Workspaces() ([]string, error) { } for _, w := range wl.Items { - switch b.WorkspaceMapping.Strategy() { - case WorkspacePrefixStrategy: - if strings.HasPrefix(w.Name, b.WorkspaceMapping.Prefix) { - names = append(names, strings.TrimPrefix(w.Name, b.WorkspaceMapping.Prefix)) - continue - } - default: - // Pass-through. The "prefix" strategy is naive and does - // client-side filtering, but for tags and any other future - // strategy this filtering should be left to the API. - names = append(names, w.Name) - } + names = append(names, w.Name) } // Exit the loop when we've seen all pages. @@ -502,11 +477,6 @@ func (b *Cloud) DeleteWorkspace(name string) error { } // Configure the remote workspace name. - switch { - case b.WorkspaceMapping.Strategy() == WorkspacePrefixStrategy && !strings.HasPrefix(name, b.WorkspaceMapping.Prefix): - name = b.WorkspaceMapping.Prefix + name - } - client := &remoteClient{ client: b.client, organization: b.organization, @@ -528,11 +498,6 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { return nil, backend.ErrWorkspacesNotSupported } - // If the prefix strategy is used, translate the local name to the TFC workspace name. - if b.WorkspaceMapping.Strategy() == WorkspacePrefixStrategy { - name = b.WorkspaceMapping.Prefix + name - } - workspace, err := b.client.Workspaces.Read(context.Background(), b.organization, name) if err != nil && err != tfe.ErrResourceNotFound { return nil, fmt.Errorf("Failed to retrieve workspace %s: %v", name, err) @@ -588,11 +553,6 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend.RunningOperation, error) { name := op.Workspace - // If the prefix strategy is used, translate the local name to the TFC workspace name. - if b.WorkspaceMapping.Strategy() == WorkspacePrefixStrategy { - name = b.WorkspaceMapping.Prefix + op.Workspace - } - // Retrieve the workspace for this operation. w, err := b.client.Workspaces.Read(ctx, b.organization, name) if err != nil { @@ -908,9 +868,8 @@ func (b *Cloud) cliColorize() *colorstring.Colorize { } type WorkspaceMapping struct { - Name string - Prefix string - Tags []string + Name string + Tags []string } type workspaceStrategy string @@ -918,20 +877,17 @@ type workspaceStrategy string const ( WorkspaceTagsStrategy workspaceStrategy = "tags" WorkspaceNameStrategy workspaceStrategy = "name" - WorkspacePrefixStrategy workspaceStrategy = "prefix" WorkspaceNoneStrategy workspaceStrategy = "none" WorkspaceInvalidStrategy workspaceStrategy = "invalid" ) func (wm WorkspaceMapping) Strategy() workspaceStrategy { switch { - case len(wm.Tags) > 0 && wm.Name == "" && wm.Prefix == "": + case len(wm.Tags) > 0 && wm.Name == "": return WorkspaceTagsStrategy - case len(wm.Tags) == 0 && wm.Name != "" && wm.Prefix == "": + case len(wm.Tags) == 0 && wm.Name != "": return WorkspaceNameStrategy - case len(wm.Tags) == 0 && wm.Name == "" && wm.Prefix != "": - return WorkspacePrefixStrategy - case len(wm.Tags) == 0 && wm.Name == "" && wm.Prefix == "": + case len(wm.Tags) == 0 && wm.Name == "": return WorkspaceNoneStrategy default: // Any other combination is invalid as each strategy is mutually exclusive @@ -999,9 +955,7 @@ configuration to workspaces within a Terraform Cloud organization. Three strateg [bold]tags[reset] - %s -[bold]name[reset] - %s - -[bold]prefix[reset] - %s`, schemaDescriptionTags, schemaDescriptionName, schemaDescriptionPrefix) +[bold]name[reset] - %s`, schemaDescriptionTags, schemaDescriptionName) schemaDescriptionHostname = `The Terraform Enterprise hostname to connect to. This optional argument defaults to app.terraform.io for use with Terraform Cloud.` @@ -1014,11 +968,8 @@ configuration file or configured credential helper.` schemaDescriptionTags = `A set of tags used to select remote Terraform Cloud workspaces to be used for this single configuration. New workspaces will automatically be tagged with these tag values. Generally, this -is the primary and recommended strategy to use. This option conflicts with "prefix" and "name".` +is the primary and recommended strategy to use. This option conflicts with "name".` schemaDescriptionName = `The name of a single Terraform Cloud workspace to be used with this configuration When configured -only the specified workspace can be used. This option conflicts with "tags" and "prefix".` - - schemaDescriptionPrefix = `DEPRECATED. A name prefix used to select remote Terraform Cloud to be used for this single configuration. New -workspaces will automatically be prefixed with this prefix. This option conflicts with "tags" and "name".` +only the specified workspace can be used. This option conflicts with "tags".` ) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 0151f39bc553..fc5e993371a4 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -143,7 +143,7 @@ func TestCloud_applyCanceled(t *testing.T) { } func TestCloud_applyWithoutPermissions(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) + b, bCleanup := testBackendWithTags(t) defer bCleanup() // Create a named workspace without permissions. @@ -151,7 +151,7 @@ func TestCloud_applyWithoutPermissions(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String("prod"), }, ) if err != nil { @@ -183,7 +183,7 @@ func TestCloud_applyWithoutPermissions(t *testing.T) { } func TestCloud_applyWithVCS(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) + b, bCleanup := testBackendWithTags(t) defer bCleanup() // Create a named workspace with a VCS. @@ -191,7 +191,7 @@ func TestCloud_applyWithVCS(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String("prod"), VCSRepo: &tfe.VCSRepoOptions{}, }, ) @@ -774,7 +774,7 @@ func TestCloud_applyDiscardedExternally(t *testing.T) { } func TestCloud_applyWithAutoApprove(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) + b, bCleanup := testBackendWithTags(t) defer bCleanup() ctrl := gomock.NewController(t) @@ -790,7 +790,7 @@ func TestCloud_applyWithAutoApprove(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String("prod"), }, ) if err != nil { @@ -896,7 +896,7 @@ func TestCloud_applyForceLocal(t *testing.T) { } func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) + b, bCleanup := testBackendWithTags(t) defer bCleanup() ctx := context.Background() @@ -906,7 +906,7 @@ func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "no-operations"), + Name: tfe.String("no-operations"), }, ) if err != nil { @@ -1360,7 +1360,7 @@ func TestCloud_applyPolicySoftFailAutoApprove(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String("prod"), }, ) if err != nil { diff --git a/internal/cloud/backend_context.go b/internal/cloud/backend_context.go index 24ed978547ad..27afadd2ffe1 100644 --- a/internal/cloud/backend_context.go +++ b/internal/cloud/backend_context.go @@ -4,7 +4,6 @@ import ( "context" "fmt" "log" - "strings" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/hcl/v2" @@ -140,12 +139,8 @@ func (b *Cloud) LocalRun(op *backend.Operation) (*backend.LocalRun, statemgr.Ful func (b *Cloud) getRemoteWorkspaceName(localWorkspaceName string) string { switch { case localWorkspaceName == backend.DefaultStateName: - // The default workspace name is a special case, for when the backend - // is configured to with to an exact remote workspace rather than with - // a remote workspace _prefix_. + // The default workspace name is a special case return b.WorkspaceMapping.Name - case b.WorkspaceMapping.Prefix != "" && !strings.HasPrefix(localWorkspaceName, b.WorkspaceMapping.Prefix): - return b.WorkspaceMapping.Prefix + localWorkspaceName default: return localWorkspaceName } diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index 6c08c3762dd1..ba2508091365 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -159,7 +159,7 @@ func TestCloud_planLongLine(t *testing.T) { } func TestCloud_planWithoutPermissions(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) + b, bCleanup := testBackendWithTags(t) defer bCleanup() // Create a named workspace without permissions. @@ -167,7 +167,7 @@ func TestCloud_planWithoutPermissions(t *testing.T) { context.Background(), b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "prod"), + Name: tfe.String("prod"), }, ) if err != nil { @@ -639,7 +639,7 @@ func TestCloud_planWithoutOperationsEntitlement(t *testing.T) { } func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) + b, bCleanup := testBackendWithTags(t) defer bCleanup() ctx := context.Background() @@ -649,7 +649,7 @@ func TestCloud_planWorkspaceWithoutOperations(t *testing.T) { ctx, b.organization, tfe.WorkspaceCreateOptions{ - Name: tfe.String(b.WorkspaceMapping.Prefix + "no-operations"), + Name: tfe.String("no-operations"), }, ) if err != nil { diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 01072898c7cf..ed9a675eef85 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -5,7 +5,6 @@ import ( "fmt" "net/http" "os" - "reflect" "strings" "testing" @@ -50,13 +49,6 @@ func TestCloud_backendWithName(t *testing.T) { } } -func TestCloud_backendWithPrefix(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) - defer bCleanup() - - backend.TestBackendStates(t, b) -} - func TestCloud_backendWithTags(t *testing.T) { b, bCleanup := testBackendWithTags(t) defer bCleanup() @@ -90,9 +82,8 @@ func TestCloud_PrepareConfig(t *testing.T) { config: cty.ObjectVal(map[string]cty.Value{ "organization": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedErr: `Invalid organization value: The "organization" attribute value must not be empty.`, @@ -102,36 +93,33 @@ func TestCloud_PrepareConfig(t *testing.T) { "organization": cty.StringVal("org"), "workspaces": cty.NullVal(cty.String), }), - expectedErr: `Invalid workspaces configuration: Missing workspace mapping strategy. Either workspace "tags", "name", or "prefix" is required.`, + expectedErr: `Invalid workspaces configuration: Missing workspace mapping strategy. Either workspace "tags" or "name" is required.`, }, - "workspace: empty tags, name, and prefix": { + "workspace: empty tags, name": { config: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("org"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), - expectedErr: `Invalid workspaces configuration: Missing workspace mapping strategy. Either workspace "tags", "name", or "prefix" is required.`, + expectedErr: `Invalid workspaces configuration: Missing workspace mapping strategy. Either workspace "tags" or "name" is required.`, }, - "workspace: name and prefix present": { + "workspace: name present": { config: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("org"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.StringVal("app-"), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), - expectedErr: `Invalid workspaces configuration: Only one of workspace "tags", "name", or "prefix" is allowed.`, + expectedErr: `Invalid workspaces configuration: Only one of workspace "tags" or "name" is allowed.`, }, "workspace: name and tags present": { config: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("org"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), + "name": cty.StringVal("prod"), "tags": cty.SetVal( []cty.Value{ cty.StringVal("billing"), @@ -139,7 +127,7 @@ func TestCloud_PrepareConfig(t *testing.T) { ), }), }), - expectedErr: `Invalid workspaces configuration: Only one of workspace "tags", "name", or "prefix" is allowed.`, + expectedErr: `Invalid workspaces configuration: Only one of workspace "tags" or "name" is allowed.`, }, } @@ -170,9 +158,8 @@ func TestCloud_config(t *testing.T) { "organization": cty.StringVal("nonexisting"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), confErr: "organization \"nonexisting\" at host app.terraform.io not found", @@ -183,9 +170,8 @@ func TestCloud_config(t *testing.T) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), confErr: "Failed to request discovery document", @@ -197,9 +183,8 @@ func TestCloud_config(t *testing.T) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), confErr: "terraform login localhost", @@ -210,8 +195,7 @@ func TestCloud_config(t *testing.T) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.NullVal(cty.String), + "name": cty.NullVal(cty.String), "tags": cty.SetVal( []cty.Value{ cty.StringVal("billing"), @@ -226,58 +210,30 @@ func TestCloud_config(t *testing.T) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }), - }, - "with_a_prefix": { - config: cty.ObjectVal(map[string]cty.Value{ - "hostname": cty.NullVal(cty.String), - "organization": cty.StringVal("hashicorp"), - "token": cty.NullVal(cty.String), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.StringVal("my-app-"), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), }, - "without_a_name_prefix_or_tags": { + "without_a_name_tags": { config: cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), valErr: `Missing workspace mapping strategy.`, }, - "with_both_a_name_and_a_prefix": { - config: cty.ObjectVal(map[string]cty.Value{ - "hostname": cty.NullVal(cty.String), - "organization": cty.StringVal("hashicorp"), - "token": cty.NullVal(cty.String), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.StringVal("my-app-"), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }), - valErr: `Only one of workspace "tags", "name", or "prefix" is allowed.`, - }, "with_both_a_name_and_tags": { config: cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), + "name": cty.StringVal("prod"), "tags": cty.SetVal( []cty.Value{ cty.StringVal("billing"), @@ -285,7 +241,7 @@ func TestCloud_config(t *testing.T) { ), }), }), - valErr: `Only one of workspace "tags", "name", or "prefix" is allowed.`, + valErr: `Only one of workspace "tags" or "name" is allowed.`, }, "null config": { config: cty.NullVal(cty.EmptyObject), @@ -318,8 +274,7 @@ func TestCloud_configVerifyMinimumTFEVersion(t *testing.T) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.NullVal(cty.String), + "name": cty.NullVal(cty.String), "tags": cty.SetVal( []cty.Value{ cty.StringVal("billing"), @@ -353,25 +308,23 @@ func TestCloud_setConfigurationFields(t *testing.T) { originalForceBackendEnv := os.Getenv("TF_FORCE_LOCAL_BACKEND") cases := map[string]struct { - obj cty.Value - expectedHostname string - expectedOrganziation string - expectedWorkspacePrefix string - expectedWorkspaceName string - expectedWorkspaceTags []string - expectedForceLocal bool - setEnv func() - resetEnv func() - expectedErr string + obj cty.Value + expectedHostname string + expectedOrganziation string + expectedWorkspaceName string + expectedWorkspaceTags []string + expectedForceLocal bool + setEnv func() + resetEnv func() + expectedErr string }{ "with hostname set": { obj: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("hashicorp"), "hostname": cty.StringVal("hashicorp.com"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: "hashicorp.com", @@ -382,9 +335,8 @@ func TestCloud_setConfigurationFields(t *testing.T) { "organization": cty.StringVal("hashicorp"), "hostname": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: defaultHostname, @@ -395,36 +347,20 @@ func TestCloud_setConfigurationFields(t *testing.T) { "organization": cty.StringVal("hashicorp"), "hostname": cty.StringVal("hashicorp.com"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal("prod"), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal("prod"), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), expectedHostname: "hashicorp.com", expectedOrganziation: "hashicorp", expectedWorkspaceName: "prod", }, - "with workspace prefix set": { - obj: cty.ObjectVal(map[string]cty.Value{ - "organization": cty.StringVal("hashicorp"), - "hostname": cty.StringVal("hashicorp.com"), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.StringVal("prod"), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }), - expectedHostname: "hashicorp.com", - expectedOrganziation: "hashicorp", - expectedWorkspacePrefix: "prod", - }, "with workspace tags set": { obj: cty.ObjectVal(map[string]cty.Value{ "organization": cty.StringVal("hashicorp"), "hostname": cty.StringVal("hashicorp.com"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.NullVal(cty.String), + "name": cty.NullVal(cty.String), "tags": cty.SetVal( []cty.Value{ cty.StringVal("billing"), @@ -441,14 +377,12 @@ func TestCloud_setConfigurationFields(t *testing.T) { "organization": cty.StringVal("hashicorp"), "hostname": cty.StringVal("hashicorp.com"), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.StringVal("prod"), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.NullVal(cty.String), + "tags": cty.NullVal(cty.Set(cty.String)), }), }), - expectedHostname: "hashicorp.com", - expectedOrganziation: "hashicorp", - expectedWorkspacePrefix: "prod", + expectedHostname: "hashicorp.com", + expectedOrganziation: "hashicorp", setEnv: func() { os.Setenv("TF_FORCE_LOCAL_BACKEND", "1") }, @@ -482,9 +416,6 @@ func TestCloud_setConfigurationFields(t *testing.T) { if tc.expectedOrganziation != "" && b.organization != tc.expectedOrganziation { t.Fatalf("%s: expected organization (%s) to match configured organization (%s)", name, b.organization, tc.expectedOrganziation) } - if tc.expectedWorkspacePrefix != "" && b.WorkspaceMapping.Prefix != tc.expectedWorkspacePrefix { - t.Fatalf("%s: expected workspace prefix mapping (%s) to match configured workspace prefix (%s)", name, b.WorkspaceMapping.Prefix, tc.expectedWorkspacePrefix) - } if tc.expectedWorkspaceName != "" && b.WorkspaceMapping.Name != tc.expectedWorkspaceName { t.Fatalf("%s: expected workspace name mapping (%s) to match configured workspace name (%s)", name, b.WorkspaceMapping.Name, tc.expectedWorkspaceName) } @@ -557,87 +488,6 @@ func TestCloud_addAndRemoveWorkspacesDefault(t *testing.T) { } } -func TestCloud_addAndRemoveWorkspacesWithPrefix(t *testing.T) { - b, bCleanup := testBackendWithPrefix(t) - defer bCleanup() - - states, err := b.Workspaces() - if err != nil { - t.Fatal(err) - } - - expectedWorkspaces := []string(nil) - if !reflect.DeepEqual(states, expectedWorkspaces) { - t.Fatalf("expected states %#+v, got %#+v", expectedWorkspaces, states) - } - - if _, err := b.StateMgr(backend.DefaultStateName); err != backend.ErrDefaultWorkspaceNotSupported { - t.Fatalf("expected error %v, got %v", backend.ErrDefaultWorkspaceNotSupported, err) - } - - expectedA := "test_A" - if _, err := b.StateMgr(expectedA); err != nil { - t.Fatal(err) - } - - states, err = b.Workspaces() - if err != nil { - t.Fatal(err) - } - - expectedWorkspaces = append(expectedWorkspaces, expectedA) - if !reflect.DeepEqual(states, expectedWorkspaces) { - t.Fatalf("expected %#+v, got %#+v", expectedWorkspaces, states) - } - - expectedB := "test_B" - if _, err := b.StateMgr(expectedB); err != nil { - t.Fatal(err) - } - - states, err = b.Workspaces() - if err != nil { - t.Fatal(err) - } - - expectedWorkspaces = append(expectedWorkspaces, expectedB) - if !reflect.DeepEqual(states, expectedWorkspaces) { - t.Fatalf("expected %#+v, got %#+v", expectedWorkspaces, states) - } - - if err := b.DeleteWorkspace(backend.DefaultStateName); err != backend.ErrDefaultWorkspaceNotSupported { - t.Fatalf("expected error %v, got %v", backend.ErrDefaultWorkspaceNotSupported, err) - } - - if err := b.DeleteWorkspace(expectedA); err != nil { - t.Fatal(err) - } - - states, err = b.Workspaces() - if err != nil { - t.Fatal(err) - } - - expectedWorkspaces = []string{expectedB} - if !reflect.DeepEqual(states, expectedWorkspaces) { - t.Fatalf("expected %#+v got %#+v", expectedWorkspaces, states) - } - - if err := b.DeleteWorkspace(expectedB); err != nil { - t.Fatal(err) - } - - states, err = b.Workspaces() - if err != nil { - t.Fatal(err) - } - - expectedWorkspaces = []string(nil) - if !reflect.DeepEqual(states, expectedWorkspaces) { - t.Fatalf("expected %#+v, got %#+v", expectedWorkspaces, states) - } -} - func TestCloud_StateMgr_versionCheck(t *testing.T) { b, bCleanup := testBackendWithName(t) defer bCleanup() diff --git a/internal/cloud/errors.go b/internal/cloud/errors.go index 81dfe7bb78b6..2c5910030904 100644 --- a/internal/cloud/errors.go +++ b/internal/cloud/errors.go @@ -18,14 +18,14 @@ var ( invalidWorkspaceConfigMissingValues = tfdiags.AttributeValue( tfdiags.Error, "Invalid workspaces configuration", - fmt.Sprintf("Missing workspace mapping strategy. Either workspace \"tags\", \"name\", or \"prefix\" is required.\n\n%s", workspaceConfigurationHelp), + fmt.Sprintf("Missing workspace mapping strategy. Either workspace \"tags\" or \"name\" is required.\n\n%s", workspaceConfigurationHelp), cty.Path{cty.GetAttrStep{Name: "workspaces"}}, ) invalidWorkspaceConfigMisconfiguration = tfdiags.AttributeValue( tfdiags.Error, "Invalid workspaces configuration", - fmt.Sprintf("Only one of workspace \"tags\", \"name\", or \"prefix\" is allowed.\n\n%s", workspaceConfigurationHelp), + fmt.Sprintf("Only one of workspace \"tags\" or \"name\" is allowed.\n\n%s", workspaceConfigurationHelp), cty.Path{cty.GetAttrStep{Name: "workspaces"}}, ) ) diff --git a/internal/cloud/testing.go b/internal/cloud/testing.go index 75e53c5bcb11..e7be4748cef1 100644 --- a/internal/cloud/testing.go +++ b/internal/cloud/testing.go @@ -71,23 +71,8 @@ func testBackendWithName(t *testing.T) (*Cloud, func()) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal(testBackendSingleWorkspaceName), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), - }), - }) - return testBackend(t, obj) -} - -func testBackendWithPrefix(t *testing.T) (*Cloud, func()) { - obj := cty.ObjectVal(map[string]cty.Value{ - "hostname": cty.NullVal(cty.String), - "organization": cty.StringVal("hashicorp"), - "token": cty.NullVal(cty.String), - "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.StringVal("my-app-"), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal(testBackendSingleWorkspaceName), + "tags": cty.NullVal(cty.Set(cty.String)), }), }) return testBackend(t, obj) @@ -99,8 +84,7 @@ func testBackendWithTags(t *testing.T) (*Cloud, func()) { "organization": cty.StringVal("hashicorp"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.NullVal(cty.String), - "prefix": cty.NullVal(cty.String), + "name": cty.NullVal(cty.String), "tags": cty.SetVal( []cty.Value{ cty.StringVal("billing"), @@ -117,9 +101,8 @@ func testBackendNoOperations(t *testing.T) (*Cloud, func()) { "organization": cty.StringVal("no-operations"), "token": cty.NullVal(cty.String), "workspaces": cty.ObjectVal(map[string]cty.Value{ - "name": cty.StringVal(testBackendSingleWorkspaceName), - "prefix": cty.NullVal(cty.String), - "tags": cty.NullVal(cty.Set(cty.String)), + "name": cty.StringVal(testBackendSingleWorkspaceName), + "tags": cty.NullVal(cty.Set(cty.String)), }), }) return testBackend(t, obj) From 0bae48bc0183473cc246311c35ba85c976a11743 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Tue, 12 Oct 2021 12:14:02 -0600 Subject: [PATCH 234/644] update to tfc-integration branch of go-tfe --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 5c09bc4b6c24..66522fce6bad 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.19.1-0.20211001235029-ff29186e11db + github.com/hashicorp/go-tfe v0.19.1-0.20211012181137-3666eed9e8e9 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index 8972a8d9ef56..c5635216ded9 100644 --- a/go.sum +++ b/go.sum @@ -379,8 +379,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.19.1-0.20211001235029-ff29186e11db h1:e7oSI8NO5bAJBGI8pTxvLkI/0/LMxRaBkJS9hFdKuMk= -github.com/hashicorp/go-tfe v0.19.1-0.20211001235029-ff29186e11db/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.19.1-0.20211012181137-3666eed9e8e9 h1:97QOrhJha4EmU+mUC1ubf15B40CjdcObULUop49+u8c= +github.com/hashicorp/go-tfe v0.19.1-0.20211012181137-3666eed9e8e9/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= From b43daeaa8d72d66f5a990ed2ffbe5942e12bcde3 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Fri, 24 Sep 2021 13:08:03 -0700 Subject: [PATCH 235/644] Cloud backend: accept version constraints from workspaces The cloud backend (and remote before it) previously expected a TFC workspace's `terraform-version` attribute to be either the magic string `"latest"` or an explicit semver value. But a workspace might have a version constraint instead (like `~> 1.1.0`), in which case the version check would blow up. This commit checks whether `terraform-version` is a valid version constraint before erroring out, and if so, returns success if the local version meets the constraint. Because it's not practical to deeply introspect the slice of version space defined by a constraint, this check is slightly less robust than the version comparisons below it: - It can give a false OK on open-ended constraints like `>= 1.1.0`. Say you're running 1.3.0, it changed the state format, and the TFE instance admin has not yet added any 1.3.x Terraform versions; your workspace will now break. - It will give a false not-OK when using different minor versions within a range that we know to be compatible, e.g. remote constraint of `~> 0.15.0` and local version of 1.1.0. - This would be totally useless with the pre-0.14 versions of Terraform, where patch releases could change state format... but we're not going back in time to add this feature to them anyway. Still, in the most common likely case (`~> x.y.z`), it'll complain at you (with an error you can choose to override) if you're not using the same minor version, and that seems proportionate, useful, and expected. --- internal/cloud/backend.go | 68 ++++++++++++++++++++++++++++----------- 1 file changed, 50 insertions(+), 18 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 2bf5d3c4d878..418658417770 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -742,10 +742,12 @@ func (b *Cloud) IgnoreVersionConflict() { } // VerifyWorkspaceTerraformVersion compares the local Terraform version against -// the workspace's configured Terraform version. If they are equal, this means -// that there are no compatibility concerns, so it returns no diagnostics. +// the workspace's configured Terraform version. If they are compatible, this +// means that there are no state compatibility concerns, so it returns no +// diagnostics. // -// If the versions differ, +// If the versions aren't compatible, it returns an error (or, if +// b.ignoreVersionConflict is set, a warning). func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Diagnostics { var diags tfdiags.Diagnostics @@ -779,13 +781,55 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di return nil } + // Even if ignoring version conflicts, it may still be useful to call this + // method and warn the user about a mismatch between the local and remote + // Terraform versions. + severity := tfdiags.Error + if b.ignoreVersionConflict { + severity = tfdiags.Warning + } + suggestion := " If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." + if b.ignoreVersionConflict { + suggestion = "" + } + remoteVersion, err := version.NewSemver(workspace.TerraformVersion) if err != nil { + // If it's not a valid version, it might be a valid version constraint: + remoteConstraint, err := version.NewConstraint(workspace.TerraformVersion) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Error looking up workspace", + fmt.Sprintf("Invalid Terraform version or version constraint: %s", err), + )) + return diags + } + + // Avoiding tfversion.SemVer because it omits the prerelease prefix, and we + // want constraints like `~> 1.2.0-beta1` to be possible. + fullTfversion := version.Must(version.NewSemver(tfversion.String())) + + // If it's a constraint, we only ensure that the local version meets it. + // This can result in both false positives and false negatives, but in the + // most common case (~> x.y.z) it's useful enough. + if remoteConstraint.Check(fullTfversion) { + return diags + } + diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error looking up workspace", - fmt.Sprintf("Invalid Terraform version: %s", err), + severity, + "Terraform version mismatch", + fmt.Sprintf( + "The local Terraform version (%s) does not meet the version requirements for remote workspace %s/%s (%s).%s", + tfversion.String(), + b.organization, + workspace.Name, + workspace.TerraformVersion, + suggestion, + ), )) + return diags } @@ -818,18 +862,6 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di } } - // Even if ignoring version conflicts, it may still be useful to call this - // method and warn the user about a mismatch between the local and remote - // Terraform versions. - severity := tfdiags.Error - if b.ignoreVersionConflict { - severity = tfdiags.Warning - } - - suggestion := " If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." - if b.ignoreVersionConflict { - suggestion = "" - } diags = diags.Append(tfdiags.Sourceless( severity, "Terraform version mismatch", From 9857097b3479f4ed49b5f300328f2d942f9c135a Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Fri, 24 Sep 2021 17:27:02 -0700 Subject: [PATCH 236/644] Add tests for version constraints in workspace terraform-versions --- internal/cloud/backend_test.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index ed9a675eef85..56fe9ebe1ca8 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -605,6 +605,15 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { {"1.2.0", "1.2.99", true, false}, {"1.2.0", "1.3.0", true, true}, {"0.15.0", "latest", true, false}, + {"1.1.5", "~> 1.1.1", true, false}, + {"1.1.5", "> 1.1.0, < 1.3.0", true, false}, + {"1.1.5", "~> 1.0.1", true, true}, + // pre-release versions are comparable within their pre-release stage (dev, + // alpha, beta), but not comparable to different stages and not comparable + // to final releases. + {"1.1.0-beta1", "~> 1.1.0-beta", true, false}, + {"1.1.0", "~> 1.1.0-beta", true, true}, + {"1.1.0-beta1", "~> 1.1.0-dev", true, true}, } for _, tc := range testCases { t.Run(fmt.Sprintf("local %s, remote %s", tc.local, tc.remote), func(t *testing.T) { From 83538fdd6bd4cdfd6435f2e97e1d438e736c9750 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 29 Sep 2021 16:55:43 -0500 Subject: [PATCH 237/644] Shift errors to error file, improve error text --- internal/cloud/backend.go | 46 +++++----------------------------- internal/cloud/backend_test.go | 4 +-- internal/cloud/errors.go | 41 ++++++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 42 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 418658417770..5fdd2b12cc46 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -784,25 +784,15 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di // Even if ignoring version conflicts, it may still be useful to call this // method and warn the user about a mismatch between the local and remote // Terraform versions. - severity := tfdiags.Error - if b.ignoreVersionConflict { - severity = tfdiags.Warning - } - suggestion := " If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." - if b.ignoreVersionConflict { - suggestion = "" - } - remoteVersion, err := version.NewSemver(workspace.TerraformVersion) if err != nil { + log.Printf("[DEBUG] Invalid Terraform version (%s); will try to parse as version constraint", workspace.TerraformVersion) + } + if remoteVersion == nil { // If it's not a valid version, it might be a valid version constraint: remoteConstraint, err := version.NewConstraint(workspace.TerraformVersion) if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Error looking up workspace", - fmt.Sprintf("Invalid Terraform version or version constraint: %s", err), - )) + diags = diags.Append(terraformInvalidVersionOrConstraint(b.ignoreVersionConflict, workspace.TerraformVersion)) return diags } @@ -817,19 +807,7 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di return diags } - diags = diags.Append(tfdiags.Sourceless( - severity, - "Terraform version mismatch", - fmt.Sprintf( - "The local Terraform version (%s) does not meet the version requirements for remote workspace %s/%s (%s).%s", - tfversion.String(), - b.organization, - workspace.Name, - workspace.TerraformVersion, - suggestion, - ), - )) - + diags = diags.Append(terraformMismatchDiagnostic(b.ignoreVersionConflict, b.organization, workspace, tfversion.String())) return diags } @@ -862,19 +840,7 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di } } - diags = diags.Append(tfdiags.Sourceless( - severity, - "Terraform version mismatch", - fmt.Sprintf( - "The local Terraform version (%s) does not match the configured version for remote workspace %s/%s (%s).%s", - tfversion.String(), - b.organization, - workspace.Name, - workspace.TerraformVersion, - suggestion, - ), - )) - + diags = diags.Append(terraformMismatchDiagnostic(b.ignoreVersionConflict, b.organization, workspace, tfversion.String())) return diags } diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 56fe9ebe1ca8..38e4db8d6c09 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -705,7 +705,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { if len(diags) != 1 { t.Fatal("expected diag, but none returned") } - if got := diags.Err().Error(); !strings.Contains(got, "Error looking up workspace: Invalid Terraform version") { + if got := diags.Err().Error(); !strings.Contains(got, "Terraform version error: The remote workspace specified") { t.Fatalf("unexpected error: %s", got) } } @@ -760,7 +760,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { if got, want := diags[0].Description().Summary, "Terraform version mismatch"; got != want { t.Errorf("wrong summary: got %s, want %s", got, want) } - wantDetail := "The local Terraform version (0.14.0) does not match the configured version for remote workspace hashicorp/app-prod (0.13.5)." + wantDetail := "The local Terraform version (0.14.0) does not meet the version requirements for remote workspace hashicorp/app-prod (0.13.5)." if got := diags[0].Description().Detail; got != wantDetail { t.Errorf("wrong summary: got %s, want %s", got, wantDetail) } diff --git a/internal/cloud/errors.go b/internal/cloud/errors.go index 2c5910030904..b51f443386f8 100644 --- a/internal/cloud/errors.go +++ b/internal/cloud/errors.go @@ -2,7 +2,9 @@ package cloud import ( "fmt" + "strings" + tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" ) @@ -29,3 +31,42 @@ var ( cty.Path{cty.GetAttrStep{Name: "workspaces"}}, ) ) + +func terraformMismatchDiagnostic(ignoreVersionConflict bool, organization string, workspace *tfe.Workspace, tfversion string) tfdiags.Diagnostic { + severity := tfdiags.Error + if ignoreVersionConflict { + severity = tfdiags.Warning + } + + suggestion := "If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." + if ignoreVersionConflict { + suggestion = "" + } + + description := fmt.Sprintf( + "The local Terraform version (%s) does not meet the version requirements for remote workspace %s/%s (%s).\n\n%s", + tfversion, + organization, + workspace.Name, + workspace.TerraformVersion, + suggestion, + ) + description = strings.TrimSpace(description) + return tfdiags.Sourceless(severity, "Terraform version mismatch", description) +} + +func terraformInvalidVersionOrConstraint(ignoreVersionConflict bool, tfversion string) tfdiags.Diagnostic { + severity := tfdiags.Error + if ignoreVersionConflict { + severity = tfdiags.Warning + } + + suggestion := "If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." + if ignoreVersionConflict { + suggestion = "" + } + + description := fmt.Sprintf("The remote workspace specified an invalid Terraform version or version constraint: %s\n\n%s", tfversion, suggestion) + description = strings.TrimSpace(description) + return tfdiags.Sourceless(severity, "Terraform version error", description) +} From baa72ce235c40da70df1c796fb5ef44fdd15dd38 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 12 Oct 2021 17:59:56 -0700 Subject: [PATCH 238/644] Simplify logic flow: everything is a constraint Explicit version strings are actually also version constraints! And the special comparisons we were doing to allow a range of compatible versions can also be expressed as version constraints. Bonus: also simplify the way we handle version check errors, by composing the messages inline and only extracting the repetitive parts into a function. --- internal/cloud/backend.go | 100 ++++++++++++++++----------------- internal/cloud/backend_test.go | 6 +- internal/cloud/errors.go | 37 ++---------- 3 files changed, 58 insertions(+), 85 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 5fdd2b12cc46..08dafb275a7d 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -781,66 +781,66 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di return nil } - // Even if ignoring version conflicts, it may still be useful to call this - // method and warn the user about a mismatch between the local and remote - // Terraform versions. - remoteVersion, err := version.NewSemver(workspace.TerraformVersion) + remoteConstraint, err := version.NewConstraint(workspace.TerraformVersion) if err != nil { - log.Printf("[DEBUG] Invalid Terraform version (%s); will try to parse as version constraint", workspace.TerraformVersion) + message := fmt.Sprintf( + "The remote workspace specified an invalid Terraform version or constraint (%s), "+ + "and it isn't possible to determine whether the local Terraform version (%s) is compatible.", + workspace.TerraformVersion, + tfversion.String(), + ) + diags = diags.Append(incompatibleWorkspaceTerraformVersion(message, b.ignoreVersionConflict)) + return diags } - if remoteVersion == nil { - // If it's not a valid version, it might be a valid version constraint: - remoteConstraint, err := version.NewConstraint(workspace.TerraformVersion) - if err != nil { - diags = diags.Append(terraformInvalidVersionOrConstraint(b.ignoreVersionConflict, workspace.TerraformVersion)) - return diags - } - // Avoiding tfversion.SemVer because it omits the prerelease prefix, and we - // want constraints like `~> 1.2.0-beta1` to be possible. - fullTfversion := version.Must(version.NewSemver(tfversion.String())) + // If the workspace has a literal Terraform version, see if we can use a + // looser version constraint. + remoteVersion, _ := version.NewSemver(workspace.TerraformVersion) + if remoteVersion != nil { + v014 := version.Must(version.NewSemver("0.14.0")) + v120 := version.Must(version.NewSemver("1.2.0")) - // If it's a constraint, we only ensure that the local version meets it. - // This can result in both false positives and false negatives, but in the - // most common case (~> x.y.z) it's useful enough. - if remoteConstraint.Check(fullTfversion) { - return diags + // Versions from 0.14 through the early 1.x series should be compatible + // (though we don't know about 1.2 yet). + if remoteVersion.GreaterThanOrEqual(v014) && remoteVersion.LessThan(v120) { + early1xCompatible, err := version.NewConstraint(fmt.Sprintf(">= 0.14.0, < %s", v120.String())) + if err != nil { + panic(err) + } + remoteConstraint = early1xCompatible } - diags = diags.Append(terraformMismatchDiagnostic(b.ignoreVersionConflict, b.organization, workspace, tfversion.String())) - return diags - } - - v014 := version.Must(version.NewSemver("0.14.0")) - if tfversion.SemVer.LessThan(v014) || remoteVersion.LessThan(v014) { - // Versions of Terraform prior to 0.14.0 will refuse to load state files - // written by a newer version of Terraform, even if it is only a patch - // level difference. As a result we require an exact match. - if tfversion.SemVer.Equal(remoteVersion) { - return diags + // Any future new state format will require at least a minor version + // increment, so x.y.* will always be compatible with each other. + if remoteVersion.GreaterThanOrEqual(v120) { + rwvs := remoteVersion.Segments64() + if len(rwvs) >= 3 { + // ~> x.y.0 + minorVersionCompatible, err := version.NewConstraint(fmt.Sprintf("~> %d.%d.0", rwvs[0], rwvs[1])) + if err != nil { + panic(err) + } + remoteConstraint = minorVersionCompatible + } } } - if tfversion.SemVer.GreaterThanOrEqual(v014) && remoteVersion.GreaterThanOrEqual(v014) { - // Versions of Terraform after 0.14.0 should be compatible with each - // other. At the time this code was written, the only constraints we - // are aware of are: - // - // - 0.14.0 is guaranteed to be compatible with versions up to but not - // including 1.2.0 - v120 := version.Must(version.NewSemver("1.2.0")) - if tfversion.SemVer.LessThan(v120) && remoteVersion.LessThan(v120) { - return diags - } - // - Any new Terraform state version will require at least minor patch - // increment, so x.y.* will always be compatible with each other - tfvs := tfversion.SemVer.Segments64() - rwvs := remoteVersion.Segments64() - if len(tfvs) == 3 && len(rwvs) == 3 && tfvs[0] == rwvs[0] && tfvs[1] == rwvs[1] { - return diags - } + + // Re-parsing tfversion.String because tfversion.SemVer omits the prerelease + // prefix, and we want to allow constraints like `~> 1.2.0-beta1`. + fullTfversion := version.Must(version.NewSemver(tfversion.String())) + + if remoteConstraint.Check(fullTfversion) { + return diags } - diags = diags.Append(terraformMismatchDiagnostic(b.ignoreVersionConflict, b.organization, workspace, tfversion.String())) + message := fmt.Sprintf( + "The local Terraform version (%s) does not meet the version requirements for remote workspace %s/%s (%s).", + tfversion.String(), + b.organization, + workspace.Name, + workspace.TerraformVersion, + ) + diags = diags.Append(incompatibleWorkspaceTerraformVersion(message, b.ignoreVersionConflict)) return diags } diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 38e4db8d6c09..cd2995887678 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -656,7 +656,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { if len(diags) != 1 { t.Fatal("expected diag, but none returned") } - if got := diags.Err().Error(); !strings.Contains(got, "Terraform version mismatch") { + if got := diags.Err().Error(); !strings.Contains(got, "Incompatible Terraform version") { t.Fatalf("unexpected error: %s", got) } } else { @@ -705,7 +705,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_workspaceErrors(t *testing.T) { if len(diags) != 1 { t.Fatal("expected diag, but none returned") } - if got := diags.Err().Error(); !strings.Contains(got, "Terraform version error: The remote workspace specified") { + if got := diags.Err().Error(); !strings.Contains(got, "Incompatible Terraform version: The remote workspace specified") { t.Fatalf("unexpected error: %s", got) } } @@ -757,7 +757,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion_ignoreFlagSet(t *testing.T) { if got, want := diags[0].Severity(), tfdiags.Warning; got != want { t.Errorf("wrong severity: got %#v, want %#v", got, want) } - if got, want := diags[0].Description().Summary, "Terraform version mismatch"; got != want { + if got, want := diags[0].Description().Summary, "Incompatible Terraform version"; got != want { t.Errorf("wrong summary: got %s, want %s", got, want) } wantDetail := "The local Terraform version (0.14.0) does not meet the version requirements for remote workspace hashicorp/app-prod (0.13.5)." diff --git a/internal/cloud/errors.go b/internal/cloud/errors.go index b51f443386f8..58494f70eb2a 100644 --- a/internal/cloud/errors.go +++ b/internal/cloud/errors.go @@ -4,7 +4,6 @@ import ( "fmt" "strings" - tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" ) @@ -32,41 +31,15 @@ var ( ) ) -func terraformMismatchDiagnostic(ignoreVersionConflict bool, organization string, workspace *tfe.Workspace, tfversion string) tfdiags.Diagnostic { - severity := tfdiags.Error - if ignoreVersionConflict { - severity = tfdiags.Warning - } - - suggestion := "If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." - if ignoreVersionConflict { - suggestion = "" - } +const ignoreRemoteVersionHelp = "If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." - description := fmt.Sprintf( - "The local Terraform version (%s) does not meet the version requirements for remote workspace %s/%s (%s).\n\n%s", - tfversion, - organization, - workspace.Name, - workspace.TerraformVersion, - suggestion, - ) - description = strings.TrimSpace(description) - return tfdiags.Sourceless(severity, "Terraform version mismatch", description) -} - -func terraformInvalidVersionOrConstraint(ignoreVersionConflict bool, tfversion string) tfdiags.Diagnostic { +func incompatibleWorkspaceTerraformVersion(message string, ignoreVersionConflict bool) tfdiags.Diagnostic { severity := tfdiags.Error + suggestion := ignoreRemoteVersionHelp if ignoreVersionConflict { severity = tfdiags.Warning - } - - suggestion := "If you're sure you want to upgrade the state, you can force Terraform to continue using the -ignore-remote-version flag. This may result in an unusable workspace." - if ignoreVersionConflict { suggestion = "" } - - description := fmt.Sprintf("The remote workspace specified an invalid Terraform version or version constraint: %s\n\n%s", tfversion, suggestion) - description = strings.TrimSpace(description) - return tfdiags.Sourceless(severity, "Terraform version error", description) + description := strings.TrimSpace(fmt.Sprintf("%s\n\n%s", message, suggestion)) + return tfdiags.Sourceless(severity, "Incompatible Terraform version", description) } From 3fedd6898cac09451bc1e877bad0471c69404c3f Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Sat, 9 Oct 2021 08:47:12 -0400 Subject: [PATCH 239/644] Backend State Migration to `cloud`: Multiple Workspaces * Handle when there are multiple workspaces migrating to cloud, using both the cloud name strategy and cloud tags strategy. * Add e2e tests --- internal/cloud/e2e/apply_auto_approve_test.go | 52 +-- internal/cloud/e2e/helper_test.go | 12 +- .../e2e/migrate_state_multi_to_tfc_test.go | 438 +++++++++++++++++- ...igrate_state_remote_backend_to_tfc_test.go | 34 +- .../e2e/migrate_state_single_to_tfc_test.go | 75 +-- .../e2e/migrate_state_tfc_to_other_test.go | 38 +- internal/command/meta_backend_migrate.go | 187 +++++++- internal/command/meta_backend_migrate_test.go | 62 +++ 8 files changed, 785 insertions(+), 113 deletions(-) create mode 100644 internal/command/meta_backend_migrate_test.go diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 4e5a65a02219..1614e4f1e133 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -42,14 +42,14 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: "Terraform has been successfully initialized", - expectedErr: "", + command: []string{"init"}, + expectedCmdOutput: "Terraform has been successfully initialized", + expectedErr: "", }, { - command: []string{"apply"}, - expectedOutput: "Do you want to perform these actions in workspace", - expectedErr: "Error asking approve", + command: []string{"apply"}, + expectedCmdOutput: "Do you want to perform these actions in workspace", + expectedErr: "Error asking approve", }, }, validations: func(t *testing.T, orgName, wsName string) { @@ -86,14 +86,14 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: "Terraform has been successfully initialized", - expectedErr: "", + command: []string{"init"}, + expectedCmdOutput: "Terraform has been successfully initialized", + expectedErr: "", }, { - command: []string{"apply"}, - expectedOutput: "Do you want to perform these actions in workspace", - expectedErr: "Error asking approve", + command: []string{"apply"}, + expectedCmdOutput: "Do you want to perform these actions in workspace", + expectedErr: "Error asking approve", }, }, validations: func(t *testing.T, orgName, wsName string) { @@ -130,14 +130,14 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: "Terraform has been successfully initialized", - expectedErr: "", + command: []string{"init"}, + expectedCmdOutput: "Terraform has been successfully initialized", + expectedErr: "", }, { - command: []string{"apply", "-auto-approve"}, - expectedOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", - expectedErr: "", + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", + expectedErr: "", }, }, validations: func(t *testing.T, orgName, wsName string) { @@ -175,14 +175,14 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: "Terraform has been successfully initialized", - expectedErr: "", + command: []string{"init"}, + expectedCmdOutput: "Terraform has been successfully initialized", + expectedErr: "", }, { - command: []string{"apply", "-auto-approve"}, - expectedOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", - expectedErr: "", + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", + expectedErr: "", }, }, validations: func(t *testing.T, orgName, wsName string) { @@ -228,8 +228,8 @@ func Test_terraform_apply_autoApprove(t *testing.T) { } } - if cmd.expectedOutput != "" && !strings.Contains(stdout, cmd.expectedOutput) { - t.Fatalf("Expected to find output %s, but did not find in\n%s", cmd.expectedOutput, stdout) + if cmd.expectedCmdOutput != "" && !strings.Contains(stdout, cmd.expectedCmdOutput) { + t.Fatalf("Expected to find output %s, but did not find in\n%s", cmd.expectedCmdOutput, stdout) } } diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 5af66bf1c663..f8dad3a790c9 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -19,12 +19,12 @@ const ( ) type tfCommand struct { - command []string - expectedOutput string - expectedErr string - expectError bool - userInput []string - postInputOutput string + command []string + expectedCmdOutput string + expectedErr string + expectError bool + userInput []string + postInputOutput []string } type operationSets struct { diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index a6c4f8190730..f4160a61af7b 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -1,18 +1,434 @@ +//go:build e2e +// +build e2e + package main import ( + "context" + "fmt" + "io/ioutil" + "os" "testing" + + expect "github.com/Netflix/go-expect" + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/e2e" ) -/* - "multi" == multi-backend, multiple workspaces - -- when cloud config == name -> - ---- prompt -> do you want to ONLY migrate the current workspace - - -- when cloud config == tags - -- If Default present, prompt to rename default. - -- Then -> Prompt with * -*/ -func Test_migrate_multi_to_tfc(t *testing.T) { - t.Skip("todo: see comments") +func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { + ctx := context.Background() + + cases := map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "migrating multiple workspaces to cloud using name strategy; current workspace is 'default'": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "new", "prod"}, + expectedCmdOutput: `Created and switched to workspace "prod"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "select", "default"}, + expectedCmdOutput: `Switched to workspace "default".`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `Do you want to copy only your current workspace?`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `new-workspace`, // this comes from the `prep` function + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "default"`, // this was the output of the current workspace selected before migration + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 1 { + t.Fatalf("Expected the number of workspaces to be 1, but got %d", len(wsList.Items)) + } + ws := wsList.Items[0] + // this workspace name is what exists in the cloud backend configuration block + if ws.Name != "new-workspace" { + t.Fatalf("Expected workspace to be `new-workspace`, but is %s", ws.Name) + } + }, + }, + "migrating multiple workspaces to cloud using name strategy; current workspace is 'prod'": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "new", "prod"}, + expectedCmdOutput: `Created and switched to workspace "prod"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `Do you want to copy only your current workspace?`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "list"}, + expectedCmdOutput: `new-workspace`, // this comes from the `prep` function + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "prod"`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + if err != nil { + t.Fatal(err) + } + ws := wsList.Items[0] + // this workspace name is what exists in the cloud backend configuration block + if ws.Name != "new-workspace" { + t.Fatalf("Expected workspace to be `new-workspace`, but is %s", ws.Name) + } + }, + }, + } + + for name, tc := range cases { + fmt.Println("Test: ", name) + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + t.Log("Running commands: ", tfCmd.command) + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } + } + +} + +func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { + ctx := context.Background() + + cases := map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "migrating multiple workspaces to cloud using tags strategy; pattern is using prefix `app-*`": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "new", "prod"}, + expectedCmdOutput: `Created and switched to workspace "prod"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "select", "default"}, + expectedCmdOutput: `Switched to workspace "default".`, + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "default"`, + }, + { + command: []string{"workspace", "select", "prod"}, + expectedCmdOutput: `Switched to workspace "prod".`, + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "prod"`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + userInput: []string{"dev", "1", "app-*", "1"}, + postInputOutput: []string{ + `Would you like to rename your workspaces?`, + "What pattern would you like to add to all your workspaces?", + "The currently selected workspace (prod) does not exist.", + "Terraform has been successfully initialized!"}, + }, + { + command: []string{"workspace", "select", "app-prod"}, + expectedCmdOutput: `Switched to workspace "app-prod".`, + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "prod"`, + }, + { + command: []string{"workspace", "select", "app-dev"}, + expectedCmdOutput: `Switched to workspace "app-dev".`, + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "default"`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 2 { + t.Fatalf("Expected the number of workspaecs to be 2, but got %d", len(wsList.Items)) + } + expectedWorkspaceNames := []string{"app-prod", "app-dev"} + for _, ws := range wsList.Items { + hasName := false + for _, expectedNames := range expectedWorkspaceNames { + if expectedNames == ws.Name { + hasName = true + } + } + if !hasName { + t.Fatalf("Worksapce %s is not in the expected list of workspaces", ws.Name) + } + } + }, + }, + } + + for name, tc := range cases { + fmt.Println("Test: ", name) + organization, cleanup := createOrganization(t) + t.Log(organization.Name) + defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + t.Log("running commands: ", tfCmd.command) + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + if output == "" { + continue + } + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } + } } diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 6819ea7aacd5..0381216a6ccd 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -1,3 +1,6 @@ +//go:build e2e +// +build e2e + package main import ( @@ -23,9 +26,34 @@ import ( */ func Test_migrate_remote_backend_name_to_tfc(t *testing.T) { - t.Skip("todo: see comments") + t.Skip("TODO: see comments") + _ = map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "single workspace with backend name strategy, to cloud with name strategy": {}, + "single workspace with backend name strategy, to cloud with tags strategy": {}, + } +} + +func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { + t.Skip("TODO: see comments") + _ = map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "single workspace with backend prefix strategy, to cloud with name strategy": {}, + "multiple workspaces with backend prefix strategy, to cloud with name strategy": {}, + } } -func Test_migrate_remote_backend_prefix_to_tfc(t *testing.T) { - t.Skip("todo: see comments") +func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { + t.Skip("TODO: see comments") + _ = map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "single workspace with backend prefix strategy, to cloud with tags strategy": {}, + "multiple workspaces with backend prefix strategy, to cloud with tags strategy": {}, + } } diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index 28292419ccc1..d251207fe886 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -31,14 +31,14 @@ func Test_migrate_single_to_tfc(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: `Successfully configured the backend "local"!`, + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - userInput: []string{"yes"}, - expectedOutput: `Do you want to perform these actions?`, - postInputOutput: `Apply complete!`, + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -50,14 +50,14 @@ func Test_migrate_single_to_tfc(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, - expectedOutput: `Do you want to copy existing state to the new backend?`, - userInput: []string{"yes"}, - postInputOutput: `Successfully configured the backend "cloud"!`, + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Successfully configured the backend "cloud"!`}, }, { - command: []string{"workspace", "list"}, - expectedOutput: `new-workspace`, + command: []string{"workspace", "list"}, + expectedCmdOutput: `new-workspace`, }, }, }, @@ -82,14 +82,14 @@ func Test_migrate_single_to_tfc(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: `Successfully configured the backend "local"!`, + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - userInput: []string{"yes"}, - expectedOutput: `Do you want to perform these actions?`, - postInputOutput: `Apply complete!`, + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -101,14 +101,14 @@ func Test_migrate_single_to_tfc(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, - expectedOutput: `The "cloud" backend configuration only allows named workspaces!`, - userInput: []string{"new-workspace", "yes"}, - postInputOutput: `Successfully configured the backend "cloud"!`, + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + userInput: []string{"new-workspace", "yes"}, + postInputOutput: []string{`Successfully configured the backend "cloud"!`}, }, { - command: []string{"workspace", "list"}, - expectedOutput: `new-workspace`, + command: []string{"workspace", "list"}, + expectedCmdOutput: `new-workspace`, }, }, }, @@ -162,23 +162,28 @@ func Test_migrate_single_to_tfc(t *testing.T) { t.Fatal(err) } - if tfCmd.expectedOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedOutput) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } } - if len(tfCmd.userInput) > 0 { - for _, input := range tfCmd.userInput { + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i <= lenInput; i++ { + input := tfCmd.userInput[i] exp.SendLine(input) - } - } - - if tfCmd.postInputOutput != "" { - _, err := exp.ExpectString(tfCmd.postInputOutput) - if err != nil { - t.Fatal(err) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } } } diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 750a315b8459..5c4173d014ff 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -27,8 +27,8 @@ func Test_migrate_tfc_to_other(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: `Successfully configured the backend "cloud"!`, + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, }, }, }, @@ -39,9 +39,9 @@ func Test_migrate_tfc_to_other(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, - expectedOutput: `Migrating state from Terraform Cloud to another backend is not yet implemented.`, - expectError: true, + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `Migrating state from Terraform Cloud to another backend is not yet implemented.`, + expectError: true, }, }, }, @@ -83,26 +83,30 @@ func Test_migrate_tfc_to_other(t *testing.T) { t.Fatal(err) } - if tfCmd.expectedOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedOutput) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } } - if len(tfCmd.userInput) > 0 { - for _, input := range tfCmd.userInput { + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i <= lenInput; i++ { + input := tfCmd.userInput[i] exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } } } - - if tfCmd.postInputOutput != "" { - _, err := exp.ExpectString(tfCmd.postInputOutput) - if err != nil { - t.Fatal(err) - } - } - err = cmd.Wait() if err != nil && !tfCmd.expectError { t.Fatal(err) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 132bd96efdb0..17dcd930cda2 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -275,16 +275,9 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { // for a new name and migrate the default state to the given named state. destinationState, err = func() (statemgr.Full, error) { log.Print("[TRACE] backendMigrateState: destination doesn't support a default workspace, so we must prompt for a new name") - name, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ - Id: "new-state-name", - Query: fmt.Sprintf( - "[reset][bold][yellow]The %q backend configuration only allows "+ - "named workspaces![reset]", - opts.DestinationType), - Description: strings.TrimSpace(inputBackendNewWorkspaceName), - }) + name, err := m.promptNewWorkspaceName(opts.DestinationType) if err != nil { - return nil, fmt.Errorf("Error asking for new state name: %s", err) + return nil, err } // Update the name of the destination state. @@ -562,23 +555,156 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { multiSource := !sourceSingleState && len(sourceWorkspaces) > 1 if multiSource && destinationNameStrategy { - // we have to take the current workspace from the source and migrate that - // over to destination. Since there is multiple sources, and we are using a - // name strategy, we will only migrate the current workspace. - panic("not yet implemented") + if err := m.promptMultiToSingleCloudMigration(opts); err != nil { + return err + } + + currentEnv, err := m.Workspace() + if err != nil { + return err + } + + opts.sourceWorkspace = currentEnv + opts.destinationWorkspace = cloudBackendDestination.WorkspaceMapping.Name + + return m.backendMigrateState_s_s(opts) } // Multiple sources, and using tags strategy. So migrate every source // workspace over to new one, prompt for workspace name pattern (*), // and start migrating, and create tags for each workspace. if multiSource && destinationTagsStrategy { - // TODO: see internal/cloud/e2e/migrate_state_multi_to_tfc_test.go for notes - panic("not yet implemented") + return m.backendMigrateState_S_TFC(opts, sourceWorkspaces) + } + + return nil +} + +// migrates a multi-state backend to Terraform Cloud +func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspaces []string) error { + log.Print("[TRACE] backendMigrateState: migrating all named workspaces") + + // This map is used later when doing the migration per source/destination. + // If a source has 'default', then we ask what the new name should be. + // And further down when we actually run state migration for each + // sourc/destination workspce, we use this new name (where source is 'default') + // and set as destinationWorkspace. + defaultNewName := map[string]string{} + for i := 0; i < len(sourceWorkspaces); i++ { + if sourceWorkspaces[i] == backend.DefaultStateName { + newName, err := m.promptNewWorkspaceName(opts.DestinationType) + if err != nil { + return err + } + defaultNewName[sourceWorkspaces[i]] = newName + } + } + pattern, err := m.promptMultiStateMigrationPattern(opts.SourceType) + if err != nil { + return err + } + + // Go through each and migrate + for _, name := range sourceWorkspaces { + + // Copy the same names + opts.sourceWorkspace = name + if newName, ok := defaultNewName[name]; ok { + // this has to be done before setting destinationWorkspace + name = newName + } + opts.destinationWorkspace = strings.Replace(pattern, "*", name, -1) + + // Force it, we confirmed above + opts.force = true + + // Perform the migration + if err := m.backendMigrateState_s_s(opts); err != nil { + return fmt.Errorf(strings.TrimSpace( + errMigrateMulti), name, opts.SourceType, opts.DestinationType, err) + } + } + + return nil +} + +// Multi-state to single state. +func (m *Meta) promptMultiToSingleCloudMigration(opts *backendMigrateOpts) error { + migrate := opts.force + if !migrate { + var err error + // Ask the user if they want to migrate their existing remote state + migrate, err = m.confirm(&terraform.InputOpts{ + Id: "backend-migrate-multistate-to-single", + Query: "Do you want to copy only your current workspace?", + Description: strings.TrimSpace(tfcInputBackendMigrateMultiToSingle), + }) + if err != nil { + return fmt.Errorf("Error asking for state migration action: %s", err) + } + } + + if !migrate { + return fmt.Errorf("Migration aborted by user.") } return nil } +func (m *Meta) promptNewWorkspaceName(destinationType string) (string, error) { + name, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ + Id: "new-state-name", + Query: fmt.Sprintf( + "[reset][bold][yellow]The %q backend configuration only allows "+ + "named workspaces![reset]", + destinationType), + Description: strings.TrimSpace(inputBackendNewWorkspaceName), + }) + if err != nil { + return "", fmt.Errorf("Error asking for new state name: %s", err) + } + + return name, nil +} + +func (m *Meta) promptMultiStateMigrationPattern(sourceType string) (string, error) { + renameWorkspaces, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ + Id: "backend-migrate-multistate-to-tfc", + Query: fmt.Sprintf("[reset][bold][yellow]%s[reset]", "Would you like to rename your workspaces?"), + Description: fmt.Sprintf(strings.TrimSpace(tfcInputBackendMigrateMultiToMulti), sourceType), + }) + if err != nil { + return "", fmt.Errorf("Error asking for state migration action: %s", err) + } + if renameWorkspaces != "2" && renameWorkspaces != "1" { + return "", fmt.Errorf("Please select 1 or 2 as part of this option.") + } + if renameWorkspaces == "2" { + // this means they did not want to rename their workspaces, and we are + // returning a generic '*' that means use the same workspace name during + // migration. + return "*", nil + } + + pattern, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ + Id: "backend-migrate-multistate-to-tfc-pattern", + Query: fmt.Sprintf("[reset][bold][yellow]%s[reset]", "What pattern would you like to add to all your workspaces?"), + Description: fmt.Sprintf(strings.TrimSpace(tfcInputBackendMigrateMultiToMultiPattern), sourceType), + }) + if err != nil { + return "", fmt.Errorf("Error asking for state migration action: %s", err) + } + if !strings.Contains(pattern, "*") { + return "", fmt.Errorf("The pattern must have an '*'") + } + + if count := strings.Count(pattern, "*"); count > 1 { + return "", fmt.Errorf("The pattern '*' cannot be used more than once.") + } + + return pattern, nil +} + const errMigrateLoadStates = ` Error inspecting states in the %q backend: %s @@ -629,6 +755,37 @@ Migrating state from Terraform Cloud to another backend is not yet implemented. Please use the API to do this: https://www.terraform.io/docs/cloud/api/state-versions.html ` +const tfcInputBackendMigrateMultiToMultiPattern = ` +If you choose to NOT rename your workspaces, just input "*". + +The asterisk "*" represents your workspace name. Here are a few examples +if a workspace was named 'prod': +* input: 'app-*'; output: 'app-prod' +* input: '*-app', output: 'prod-app' +* input: 'app-*-service', output: 'app-prod-service' +* input: '*'; output: 'prod' +` + +const tfcInputBackendMigrateMultiToMulti = ` +When migrating existing workspaces from the backend %[1]q to Terraform Cloud, would you like to +rename your workspaces? + +Unlike typical Terraform workspaces representing an environment associated with a particular +configuration (e.g. production, staging, development), Terraform Cloud workspaces are named uniquely +across all configurations used within an organization. A typical strategy to start with is +-- (e.g. networking-prod-us-east, networking-staging-us-east). + +For more information on workspace naming, see https://www.terraform.io/docs/cloud/workspaces/naming.html + +1. Yes, rename workspaces according to a pattern. +2. No, I would not like to rename my workspaces. Migrate them as currently named. +` + +const tfcInputBackendMigrateMultiToSingle = ` +The cloud configuration has one workspace declared, and you are attemtping to migrate multiple workspaces +to a single workspace. By continuing, you will only migrate your current workspace. +` + const inputBackendMigrateEmpty = ` Pre-existing state was found while migrating the previous %q backend to the newly configured %q backend. No existing state was found in the newly diff --git a/internal/command/meta_backend_migrate_test.go b/internal/command/meta_backend_migrate_test.go new file mode 100644 index 000000000000..d45cbdc0d962 --- /dev/null +++ b/internal/command/meta_backend_migrate_test.go @@ -0,0 +1,62 @@ +package command + +import ( + "fmt" + "testing" +) + +func TestBackendMigrate_promptMultiStatePattern(t *testing.T) { + // Setup the meta + + cases := map[string]struct { + renamePrompt string + patternPrompt string + expectedErr string + }{ + "valid pattern": { + renamePrompt: "1", + patternPrompt: "hello-*", + expectedErr: "", + }, + "invalid pattern, only one asterisk allowed": { + renamePrompt: "1", + patternPrompt: "hello-*-world-*", + expectedErr: "The pattern '*' cannot be used more than once.", + }, + "invalid pattern, missing asterisk": { + renamePrompt: "1", + patternPrompt: "hello-world", + expectedErr: "The pattern must have an '*'", + }, + "invalid rename": { + renamePrompt: "3", + expectedErr: "Please select 1 or 2 as part of this option.", + }, + "no rename": { + renamePrompt: "2", + }, + } + for name, tc := range cases { + fmt.Println("Test: ", name) + m := testMetaBackend(t, nil) + input := map[string]string{} + cleanup := testInputMap(t, input) + if tc.renamePrompt != "" { + input["backend-migrate-multistate-to-tfc"] = tc.renamePrompt + } + if tc.patternPrompt != "" { + input["backend-migrate-multistate-to-tfc-pattern"] = tc.patternPrompt + } + + sourceType := "cloud" + _, err := m.promptMultiStateMigrationPattern(sourceType) + if tc.expectedErr == "" && err != nil { + t.Fatalf("expected error to be nil, but was %s", err.Error()) + } + if tc.expectedErr != "" && tc.expectedErr != err.Error() { + t.Fatalf("expected error to eq %s but got %s", tc.expectedErr, err.Error()) + } + + cleanup() + } +} From dc76bbee73bd232a47762a0797fbe3b9f59b6ff4 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Sat, 9 Oct 2021 08:47:12 -0400 Subject: [PATCH 240/644] Backend State Migration: Add remote backend test --- internal/cloud/e2e/apply_auto_approve_test.go | 8 +- internal/cloud/e2e/helper_test.go | 51 +- .../e2e/migrate_state_multi_to_tfc_test.go | 6 +- ...igrate_state_remote_backend_to_tfc_test.go | 918 +++++++++++++++++- internal/cloud/e2e/run_variables_test.go | 39 +- internal/command/meta_backend_migrate.go | 34 +- 6 files changed, 989 insertions(+), 67 deletions(-) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 1614e4f1e133..bcdbaeb53472 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -29,7 +29,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { TerraformVersion: tfe.String(terraformVersion), AutoApply: tfe.Bool(false), } - workspace := createWorkspace(t, org, wOpts) + workspace := createWorkspace(t, org.Name, wOpts) cleanup := func() { defer orgCleanup() } @@ -73,7 +73,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { TerraformVersion: tfe.String(terraformVersion), AutoApply: tfe.Bool(true), } - workspace := createWorkspace(t, org, wOpts) + workspace := createWorkspace(t, org.Name, wOpts) cleanup := func() { defer orgCleanup() } @@ -117,7 +117,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { TerraformVersion: tfe.String(terraformVersion), AutoApply: tfe.Bool(false), } - workspace := createWorkspace(t, org, wOpts) + workspace := createWorkspace(t, org.Name, wOpts) cleanup := func() { defer orgCleanup() } @@ -162,7 +162,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { TerraformVersion: tfe.String(terraformVersion), AutoApply: tfe.Bool(true), } - workspace := createWorkspace(t, org, wOpts) + workspace := createWorkspace(t, org.Name, wOpts) cleanup := func() { defer orgCleanup() } diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index f8dad3a790c9..844797f2d378 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -56,9 +56,9 @@ func createOrganization(t *testing.T) (*tfe.Organization, func()) { } } -func createWorkspace(t *testing.T, org *tfe.Organization, wOpts tfe.WorkspaceCreateOptions) *tfe.Workspace { +func createWorkspace(t *testing.T, orgName string, wOpts tfe.WorkspaceCreateOptions) *tfe.Workspace { ctx := context.Background() - w, err := tfeClient.Workspaces.Create(ctx, org.Name, wOpts) + w, err := tfeClient.Workspaces.Create(ctx, orgName, wOpts) if err != nil { t.Fatal(err) } @@ -66,6 +66,15 @@ func createWorkspace(t *testing.T, org *tfe.Organization, wOpts tfe.WorkspaceCre return w } +func getWorkspace(workspaces []*tfe.Workspace, workspace string) (*tfe.Workspace, bool) { + for _, ws := range workspaces { + if ws.Name == workspace { + return ws, false + } + } + return nil, true +} + func randomString(t *testing.T) string { v, err := uuid.GenerateUUID() if err != nil { @@ -87,6 +96,44 @@ output "val" { `) } +func terraformConfigRemoteBackendName(org, name string) string { + return fmt.Sprintf(` +terraform { + backend "remote" { + hostname = "%s" + organization = "%s" + + workspaces { + name = "%s" + } + } +} + +output "val" { + value = "${terraform.workspace}" +} +`, tfeHostname, org, name) +} + +func terraformConfigRemoteBackendPrefix(org, prefix string) string { + return fmt.Sprintf(` +terraform { + backend "remote" { + hostname = "%s" + organization = "%s" + + workspaces { + prefix = "%s" + } + } +} + +output "val" { + value = "${terraform.workspace}" +} +`, tfeHostname, org, prefix) +} + func terraformConfigCloudBackendTags(org, tag string) string { return fmt.Sprintf(` terraform { diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index f4160a61af7b..dd3ae2c268b1 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -5,7 +5,6 @@ package main import ( "context" - "fmt" "io/ioutil" "os" "testing" @@ -168,7 +167,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) + t.Log("Test: ", name) organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) @@ -192,6 +191,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { op.prep(t, organization.Name, tf.WorkDir()) for _, tfCmd := range op.commands { t.Log("Running commands: ", tfCmd.command) + tfCmd.command = append(tfCmd.command, "-ignore-remote-version") cmd := tf.Cmd(tfCmd.command...) cmd.Stdin = exp.Tty() cmd.Stdout = exp.Tty() @@ -357,7 +357,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) + t.Log("Test: ", name) organization, cleanup := createOrganization(t) t.Log(organization.Name) defer cleanup() diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 0381216a6ccd..33c1686c8b27 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -4,56 +4,912 @@ package main import ( + "context" + "io/ioutil" + "os" "testing" + + expect "github.com/Netflix/go-expect" + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/e2e" ) -// REMOTE BACKEND -/* - - RB name -> TFC name - -- straight copy if only if different name, or same WS name in diff org - -- other - -- ensure that the local workspace, after migration, is the new name (in the tfc config block) - - RB name -> TFC tags - -- just add tag, if in same org - -- If new org, if WS exists, just add tag - -- If new org, if WS not exists, create and add tag - - RB prefix -> TFC name - -- create if not exists - -- migrate the current worksapce state to ws name - - RB prefix -> TFC tags - -- update previous workspaces (prefix + local) with cloud config tag - -- Rename the local workspaces to match the TFC workspaces (prefix + former local, ie app-prod). inform user - -*/ -func Test_migrate_remote_backend_name_to_tfc(t *testing.T) { - t.Skip("TODO: see comments") - _ = map[string]struct { +func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { + ctx := context.Background() + cases := map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "backend name strategy, to cloud with name strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "cloud-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + }, + }, + "backend name strategy, to cloud name strategy, using the same name": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "remote-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Terraform has been successfully initialized!`, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `remote-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + expectedName := "remote-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } + } +} + +func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { + ctx := context.Background() + cases := map[string]struct { operations []operationSets validations func(t *testing.T, orgName string) }{ - "single workspace with backend name strategy, to cloud with name strategy": {}, - "single workspace with backend name strategy, to cloud with tags strategy": {}, + "backend name strategy, to cloud name strategy, using the same name, different organization": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "remote-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `remote-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + expectedName := "remote-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + orgOne, cleanupOne := createOrganization(t) + orgTwo, cleanupTwo := createOrganization(t) + defer cleanupOne() + defer cleanupTwo() + orgs := []string{orgOne.Name, orgTwo.Name} + var orgName string + for index, op := range tc.operations { + orgName = orgs[index] + op.prep(t, orgName, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, orgName) + } + } +} + +func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { + ctx := context.Background() + cases := map[string]struct { + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "single workspace with backend name strategy, to cloud with tags strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `default`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + userInput: []string{"cloud-workspace", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 1 { + t.Fatalf("Expected number of workspaces to be 1, but got %d", len(wsList.Items)) + } + ws := wsList.Items[0] + if ws.Name != "cloud-workspace" { + t.Fatalf("Expected workspace to be `cloud-workspace`, but is %s", ws.Name) + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } } } func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { - t.Skip("TODO: see comments") - _ = map[string]struct { + ctx := context.Background() + cases := map[string]struct { operations []operationSets validations func(t *testing.T, orgName string) }{ - "single workspace with backend prefix strategy, to cloud with name strategy": {}, - "multiple workspaces with backend prefix strategy, to cloud with name strategy": {}, + "single workspace with backend prefix strategy, to cloud with name strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Terraform has been successfully initialized!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "cloud-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + userInput: []string{"yes"}, + postInputOutput: []string{ + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + }, + }, + "multiple workspaces with backend prefix strategy, to cloud with name strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-two")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `The currently selected workspace (default) does not exist.`, + userInput: []string{"1"}, + postInputOutput: []string{`Terraform has been successfully initialized!`}, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "list"}, + expectedCmdOutput: "* one", // app name retrieved via prefix + }, + { + command: []string{"workspace", "select", "two"}, + expectedCmdOutput: `Switched to workspace "two".`, // app name retrieved via prefix + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "cloud-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy only your current workspace?`, + userInput: []string{"yes"}, + postInputOutput: []string{ + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 3 { + t.Fatalf("expected number of workspaces in this org to be 3, but got %d", len(wsList.Items)) + } + ws, empty := getWorkspace(wsList.Items, "cloud-workspace") + if empty { + t.Fatalf("expected workspaces to include 'cloud-workspace' but didn't.") + } + ws, empty = getWorkspace(wsList.Items, "app-one") + if empty { + t.Fatalf("expected workspaces to include 'app-one' but didn't.") + } + ws, empty = getWorkspace(wsList.Items, "app-two") + if empty { + t.Fatalf("expected workspaces to include 'app-two' but didn't.") + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } } } func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { - t.Skip("TODO: see comments") - _ = map[string]struct { + ctx := context.Background() + cases := map[string]struct { operations []operationSets validations func(t *testing.T, orgName string) }{ - "single workspace with backend prefix strategy, to cloud with tags strategy": {}, - "multiple workspaces with backend prefix strategy, to cloud with tags strategy": {}, + "single workspace with backend prefix strategy, to cloud with tags strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Terraform has been successfully initialized!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + userInput: []string{"cloud-workspace", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "list"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + }, + }, + "multiple workspaces with backend prefix strategy, to cloud with tags strategy": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-two")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `The currently selected workspace (default) does not exist.`, + userInput: []string{"1"}, + postInputOutput: []string{`Terraform has been successfully initialized!`}, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "select", "two"}, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-two"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Would you like to rename your workspaces?`, + userInput: []string{"1", "*"}, + postInputOutput: []string{`What pattern would you like to add to all your workspaces?`, + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: "two", // this comes from the original workspace name from the previous backend. + }, + { + command: []string{"workspace", "select", "one"}, + expectedCmdOutput: `Switched to workspace "one".`, // this comes from the original workspace name from the previous backend. + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 2 { + t.Logf("Expected the number of workspaces to be 2, but got %d", len(wsList.Items)) + } + ws, empty := getWorkspace(wsList.Items, "one") + if empty { + t.Fatalf("expected workspaces to include 'one' but didn't.") + } + if len(ws.TagNames) == 0 { + t.Fatalf("expected workspaces 'one' to have tags.") + } + ws, empty = getWorkspace(wsList.Items, "two") + if empty { + t.Fatalf("expected workspaces to include 'two' but didn't.") + } + if len(ws.TagNames) == 0 { + t.Fatalf("expected workspaces 'two' to have tags.") + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if tc.validations != nil { + tc.validations(t, organization.Name) + } } } diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index ba20077a14ff..6029066b7908 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -57,16 +57,16 @@ func Test_cloud_run_variables(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init"}, - expectedOutput: `Successfully configured the backend "cloud"!`, + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, }, { - command: []string{"plan", "-var", "foo=bar"}, - expectedOutput: ` + test_cli = "bar"`, + command: []string{"plan", "-var", "foo=bar"}, + expectedCmdOutput: ` + test_cli = "bar"`, }, { - command: []string{"plan", "-var", "foo=bar"}, - expectedOutput: ` + test_env = "qux"`, + command: []string{"plan", "-var", "foo=bar"}, + expectedCmdOutput: ` + test_env = "qux"`, }, }, }, @@ -110,23 +110,28 @@ func Test_cloud_run_variables(t *testing.T) { t.Fatal(err) } - if tfCmd.expectedOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedOutput) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } } - if len(tfCmd.userInput) > 0 { - for _, input := range tfCmd.userInput { + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] exp.SendLine(input) - } - } - - if tfCmd.postInputOutput != "" { - _, err := exp.ExpectString(tfCmd.postInputOutput) - if err != nil { - t.Fatal(err) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } } } diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 17dcd930cda2..fd4c176dd2a1 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -44,7 +44,7 @@ type backendMigrateOpts struct { // // This will attempt to lock both states for the migration. func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { - log.Printf("[TRACE] backendMigrateState: need to migrate from %q to %q backend config", opts.SourceType, opts.DestinationType) + log.Printf("[INFO] backendMigrateState: need to migrate from %q to %q backend config", opts.SourceType, opts.DestinationType) // We need to check what the named state status is. If we're converting // from multi-state to single-state for example, we need to handle that. var sourceSingleState, destinationSingleState, sourceTFC, destinationTFC bool @@ -154,7 +154,7 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { // Multi-state to multi-state. func (m *Meta) backendMigrateState_S_S(opts *backendMigrateOpts) error { - log.Print("[TRACE] backendMigrateState: migrating all named workspaces") + log.Print("[INFO] backendMigrateState: migrating all named workspaces") migrate := opts.force if !migrate { @@ -209,9 +209,9 @@ func (m *Meta) backendMigrateState_S_S(opts *backendMigrateOpts) error { // Multi-state to single state. func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { - log.Printf("[TRACE] backendMigrateState: destination backend type %q does not support named workspaces", opts.DestinationType) + log.Printf("[INFO] backendMigrateState: destination backend type %q does not support named workspaces", opts.DestinationType) - currentEnv, err := m.Workspace() + currentWorkspace, err := m.Workspace() if err != nil { return err } @@ -228,7 +228,7 @@ func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { opts.DestinationType), Description: fmt.Sprintf( strings.TrimSpace(inputBackendMigrateMultiToSingle), - opts.SourceType, opts.DestinationType, currentEnv), + opts.SourceType, opts.DestinationType, currentWorkspace), }) if err != nil { return fmt.Errorf( @@ -241,7 +241,7 @@ func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { } // Copy the default state - opts.sourceWorkspace = currentEnv + opts.sourceWorkspace = currentWorkspace // now switch back to the default env so we can acccess the new backend m.SetWorkspace(backend.DefaultStateName) @@ -251,7 +251,7 @@ func (m *Meta) backendMigrateState_S_s(opts *backendMigrateOpts) error { // Single state to single state, assumed default state name. func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { - log.Printf("[TRACE] backendMigrateState: migrating %q workspace to %q workspace", opts.sourceWorkspace, opts.destinationWorkspace) + log.Printf("[INFO] backendMigrateState: single-to-single migrating %q workspace to %q workspace", opts.sourceWorkspace, opts.destinationWorkspace) sourceState, err := opts.Source.StateMgr(opts.sourceWorkspace) if err != nil { @@ -534,7 +534,7 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { // Everything below, by the above two conditionals, now assumes that the // destination is always Terraform Cloud (TFC). - sourceSingle := sourceSingleState || (len(sourceWorkspaces) == 1 && sourceWorkspaces[0] == backend.DefaultStateName) + sourceSingle := sourceSingleState || (len(sourceWorkspaces) == 1) if sourceSingle { if cloudBackendDestination.WorkspaceMapping.Strategy() == cloud.WorkspaceNameStrategy { // If we know the name via WorkspaceNameStrategy, then set the @@ -543,6 +543,14 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { // in TFC if it does not exist. opts.destinationWorkspace = cloudBackendDestination.WorkspaceMapping.Name } + + currentWorkspace, err := m.Workspace() + if err != nil { + return err + } + opts.sourceWorkspace = currentWorkspace + + log.Printf("[INFO] backendMigrateTFC: single-to-single migration from source %s to destination %q", opts.sourceWorkspace, opts.destinationWorkspace) // Run normal single-to-single state migration // This will handle both situations where the new cloud backend // configuration is using a workspace.name strategy or workspace.tags @@ -559,13 +567,14 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { return err } - currentEnv, err := m.Workspace() + currentWorkspace, err := m.Workspace() if err != nil { return err } - opts.sourceWorkspace = currentEnv + opts.sourceWorkspace = currentWorkspace opts.destinationWorkspace = cloudBackendDestination.WorkspaceMapping.Name + log.Printf("[INFO] backendMigrateTFC: multi-to-single migration from source %s to destination %q", opts.sourceWorkspace, opts.destinationWorkspace) return m.backendMigrateState_s_s(opts) } @@ -574,9 +583,13 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { // workspace over to new one, prompt for workspace name pattern (*), // and start migrating, and create tags for each workspace. if multiSource && destinationTagsStrategy { + log.Printf("[INFO] backendMigrateTFC: multi-to-multi migration from source workspaces %q", sourceWorkspaces) return m.backendMigrateState_S_TFC(opts, sourceWorkspaces) } + // TODO(omar): after the check for sourceSingle is done, everything following + // it has to be multi. So rework the code to not need to check for multi, adn + // return m.backendMigrateState_S_TFC here. return nil } @@ -619,6 +632,7 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa opts.force = true // Perform the migration + log.Printf("[INFO] backendMigrateTFC: multi-to-multi migration, source workspace %q to destination workspace %q", opts.sourceWorkspace, opts.destinationWorkspace) if err := m.backendMigrateState_s_s(opts); err != nil { return fmt.Errorf(strings.TrimSpace( errMigrateMulti), name, opts.SourceType, opts.DestinationType, err) From f8256f6634c8de055669bac3e06cd507146f895a Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 13 Oct 2021 10:22:12 -0500 Subject: [PATCH 241/644] Update ux for "terraform init [-reconfigure]" --- internal/command/init.go | 30 ++++++++++++++++++++++++++++-- internal/command/meta_backend.go | 10 +++++++--- 2 files changed, 35 insertions(+), 5 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index d88ec181ef37..3de1d410132b 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -15,6 +15,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" backendInit "github.com/hashicorp/terraform/internal/backend/init" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/getproviders" @@ -304,12 +305,25 @@ func (c *InitCommand) Run(args []string) int { // by errors then we'll output them here so that the success message is // still the final thing shown. c.showDiagnostics(diags) - c.Ui.Output(c.Colorize().Color(strings.TrimSpace(outputInitSuccess))) + _, cloud := back.(*cloud.Cloud) + output := "" + if cloud { + output = outputInitSuccessCloud + } else { + output = outputInitSuccess + } + + c.Ui.Output(c.Colorize().Color(strings.TrimSpace(output))) + if !c.RunningInAutomation { // If we're not running in an automation wrapper, give the user // some more detailed next steps that are appropriate for interactive // shell usage. - c.Ui.Output(c.Colorize().Color(strings.TrimSpace(outputInitSuccessCLI))) + output = outputInitSuccessCLI + if cloud { + output = outputInitSuccessCLICloud + } + c.Ui.Output(c.Colorize().Color(strings.TrimSpace(output))) } return 0 } @@ -1087,6 +1101,10 @@ const outputInitSuccess = ` [reset][bold][green]Terraform has been successfully initialized![reset][green] ` +const outputInitSuccessCloud = ` +[reset][bold][green]Terraform Cloud has been successfully initialized![reset][green] +` + const outputInitSuccessCLI = `[reset][green] You may now begin working with Terraform. Try running "terraform plan" to see any changes that are required for your infrastructure. All Terraform commands @@ -1097,6 +1115,14 @@ rerun this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary. ` +const outputInitSuccessCLICloud = `[reset][green] +You may now begin working with Terraform Cloud. Try running "terraform plan" to +see any changes that are required for your infrastructure. + +If you ever set or change modules or configuration for Terraform, run +"terraform init" again to reinitialize your working directory. +` + // providerProtocolTooOld is a message sent to the CLI UI if the provider's // supported protocol versions are too old for the user's version of terraform, // but a newer version of the provider is compatible. diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 58cafdd4ff2f..f3a2c11e2b09 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -17,6 +17,7 @@ import ( "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hcldec" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" @@ -921,9 +922,12 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local return nil, diags } - // By now the backend is successfully configured. - m.Ui.Output(m.Colorize().Color(fmt.Sprintf( - "[reset][green]\n"+strings.TrimSpace(successBackendSet), s.Backend.Type))) + // By now the backend is successfully configured. If using Terraform Cloud, the success + // message is handled as part of the final init message + if _, ok := b.(*cloud.Cloud); !ok { + m.Ui.Output(m.Colorize().Color(fmt.Sprintf( + "[reset][green]\n"+strings.TrimSpace(successBackendSet), s.Backend.Type))) + } return b, diags } From 0cd94908388cb2a586c6d29d2dc6fc2ec5d1f216 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Mon, 18 Oct 2021 09:03:38 -0500 Subject: [PATCH 242/644] PR Feedback: cleanup variable setter --- internal/command/init.go | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index 3de1d410132b..9065b1359430 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -306,11 +306,9 @@ func (c *InitCommand) Run(args []string) int { // still the final thing shown. c.showDiagnostics(diags) _, cloud := back.(*cloud.Cloud) - output := "" + output := outputInitSuccess if cloud { output = outputInitSuccessCloud - } else { - output = outputInitSuccess } c.Ui.Output(c.Colorize().Color(strings.TrimSpace(output))) From d04c01573c51c2fa09d79b8401bc10d341a8aea1 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Mon, 18 Oct 2021 11:11:56 -0500 Subject: [PATCH 243/644] Fix iterator in a couple of e2e tests --- internal/cloud/e2e/migrate_state_single_to_tfc_test.go | 2 +- internal/cloud/e2e/migrate_state_tfc_to_other_test.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index d251207fe886..ebe85d1b558a 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -172,7 +172,7 @@ func Test_migrate_single_to_tfc(t *testing.T) { lenInput := len(tfCmd.userInput) lenInputOutput := len(tfCmd.postInputOutput) if lenInput > 0 { - for i := 0; i <= lenInput; i++ { + for i := 0; i < lenInput; i++ { input := tfCmd.userInput[i] exp.SendLine(input) // use the index to find the corresponding diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 5c4173d014ff..08a5e703ab6e 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -93,7 +93,7 @@ func Test_migrate_tfc_to_other(t *testing.T) { lenInput := len(tfCmd.userInput) lenInputOutput := len(tfCmd.postInputOutput) if lenInput > 0 { - for i := 0; i <= lenInput; i++ { + for i := 0; i < lenInput; i++ { input := tfCmd.userInput[i] exp.SendLine(input) // use the index to find the corresponding From 261a2b49d37c5aa14a10597bb04836cfaa062b1b Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Fri, 15 Oct 2021 15:33:08 -0500 Subject: [PATCH 244/644] UX for terraform init that copies state to TFC --- internal/command/meta_backend_migrate.go | 63 +++++++++++++++++++----- 1 file changed, 51 insertions(+), 12 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index fd4c176dd2a1..08ec3b8e7331 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -434,12 +434,21 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { } func (m *Meta) backendMigrateEmptyConfirm(source, destination statemgr.Full, opts *backendMigrateOpts) (bool, error) { - inputOpts := &terraform.InputOpts{ - Id: "backend-migrate-copy-to-empty", - Query: "Do you want to copy existing state to the new backend?", - Description: fmt.Sprintf( - strings.TrimSpace(inputBackendMigrateEmpty), - opts.SourceType, opts.DestinationType), + var inputOpts *terraform.InputOpts + if opts.DestinationType == "cloud" { + inputOpts = &terraform.InputOpts{ + Id: "backend-migrate-copy-to-empty-cloud", + Query: "Do you want to copy existing state to Terraform Cloud?", + Description: fmt.Sprintf(strings.TrimSpace(inputBackendMigrateEmptyCloud), opts.SourceType), + } + } else { + inputOpts = &terraform.InputOpts{ + Id: "backend-migrate-copy-to-empty", + Query: "Do you want to copy existing state to the new backend?", + Description: fmt.Sprintf( + strings.TrimSpace(inputBackendMigrateEmpty), + opts.SourceType, opts.DestinationType), + } } return m.confirm(inputOpts) @@ -475,12 +484,23 @@ func (m *Meta) backendMigrateNonEmptyConfirm( } // Ask for confirmation - inputOpts := &terraform.InputOpts{ - Id: "backend-migrate-to-backend", - Query: "Do you want to copy existing state to the new backend?", - Description: fmt.Sprintf( - strings.TrimSpace(inputBackendMigrateNonEmpty), - opts.SourceType, opts.DestinationType, sourcePath, destinationPath), + var inputOpts *terraform.InputOpts + if opts.DestinationType == "cloud" { + inputOpts = &terraform.InputOpts{ + Id: "backend-migrate-to-tfc", + Query: "Do you want to copy existing state to Terraform Cloud?", + Description: fmt.Sprintf( + strings.TrimSpace(inputBackendMigrateNonEmptyCloud), + opts.SourceType, sourcePath, destinationPath), + } + } else { + inputOpts = &terraform.InputOpts{ + Id: "backend-migrate-to-backend", + Query: "Do you want to copy existing state to the new backend?", + Description: fmt.Sprintf( + strings.TrimSpace(inputBackendMigrateNonEmpty), + opts.SourceType, opts.DestinationType, sourcePath, destinationPath), + } } // Confirm with the user that the copy should occur @@ -807,6 +827,12 @@ configured %[2]q backend. Do you want to copy this state to the new %[2]q backend? Enter "yes" to copy and "no" to start with an empty state. ` +const inputBackendMigrateEmptyCloud = ` +Pre-existing state was found while migrating the previous %q backend to Terraform Cloud. +No existing state was found in Terraform Cloud. Do you want to copy this state to Terraform Cloud? +Enter "yes" to copy and "no" to start with an empty state. +` + const inputBackendMigrateNonEmpty = ` Pre-existing state was found while migrating the previous %q backend to the newly configured %q backend. An existing non-empty state already exists in @@ -821,6 +847,19 @@ Enter "yes" to copy and "no" to start with the existing state in the newly configured %[2]q backend. ` +const inputBackendMigrateNonEmptyCloud = ` +Pre-existing state was found while migrating the previous %q backend to +Terraform Cloud. An existing non-empty state already exists in Terraform Cloud. +The two states have been saved to temporary files that will be removed after +responding to this query. + +Previous (type %[1]q): %[2]s +New (Terraform Cloud): %[3]s + +Do you want to overwrite the state in Terraform Cloud with the previous state? +Enter "yes" to copy and "no" to start with the existing state in Terraform Cloud. +` + const inputBackendMigrateMultiToSingle = ` The existing %[1]q backend supports workspaces and you currently are using more than one. The newly configured %[2]q backend doesn't support From 93bfcff61af0ad5af41569e478929f0ed5bf4f05 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Mon, 18 Oct 2021 16:02:45 -0500 Subject: [PATCH 245/644] More Terraform Cloud UX changes * Update e2e tests to specify Terraform Cloud * Update more of the terraform command flow to specify Terraform Cloud --- .../e2e/migrate_state_multi_to_tfc_test.go | 8 ++++---- ...migrate_state_remote_backend_to_tfc_test.go | 8 ++++---- .../e2e/migrate_state_single_to_tfc_test.go | 8 ++++---- internal/command/meta_backend.go | 18 +++++++++++++++--- internal/command/meta_backend_migrate.go | 13 ++++++++----- 5 files changed, 35 insertions(+), 20 deletions(-) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index dd3ae2c268b1..e72169186d18 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -68,7 +68,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { userInput: []string{"yes", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to the new backend?`, - `Successfully configured the backend "cloud"!`}, + `Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "show"}, @@ -139,7 +139,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { userInput: []string{"yes", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to the new backend?`, - `Successfully configured the backend "cloud"!`}, + `Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "list"}, @@ -191,7 +191,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { op.prep(t, organization.Name, tf.WorkDir()) for _, tfCmd := range op.commands { t.Log("Running commands: ", tfCmd.command) - tfCmd.command = append(tfCmd.command, "-ignore-remote-version") + tfCmd.command = append(tfCmd.command) cmd := tf.Cmd(tfCmd.command...) cmd.Stdin = exp.Tty() cmd.Stdout = exp.Tty() @@ -303,7 +303,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"dev", "1", "app-*", "1"}, postInputOutput: []string{ `Would you like to rename your workspaces?`, diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 33c1686c8b27..0cb7d5efcba5 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -52,7 +52,7 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, expectedCmdOutput: `Do you want to copy existing state to the new backend?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + postInputOutput: []string{`Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "show"}, @@ -234,7 +234,7 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, expectedCmdOutput: `Do you want to copy existing state to the new backend?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + postInputOutput: []string{`Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "show"}, @@ -373,7 +373,7 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to the new backend?`, @@ -516,7 +516,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { expectedCmdOutput: `Do you want to copy existing state to the new backend?`, userInput: []string{"yes"}, postInputOutput: []string{ - `Successfully configured the backend "cloud"!`}, + `Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "show"}, diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index ebe85d1b558a..805a5766d304 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -51,9 +51,9 @@ func Test_migrate_single_to_tfc(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + expectedCmdOutput: `Do you want to copy existing state to the Terraform Cloud?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + postInputOutput: []string{`Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "list"}, @@ -102,9 +102,9 @@ func Test_migrate_single_to_tfc(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"new-workspace", "yes"}, - postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + postInputOutput: []string{`Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "list"}, diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index f3a2c11e2b09..94b9e5e5c61f 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -952,7 +952,11 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista // no need to confuse the user if the backend types are the same if s.Backend.Type != c.Type { - m.Ui.Output(strings.TrimSpace(fmt.Sprintf(outputBackendMigrateChange, s.Backend.Type, c.Type))) + output := fmt.Sprintf(outputBackendMigrateChange, s.Backend.Type, c.Type) + if c.Type == "cloud" { + output = fmt.Sprintf(outputBackendMigrateChangeCloud, s.Backend.Type) + } + m.Ui.Output(strings.TrimSpace(output)) } // Grab the existing backend @@ -1011,8 +1015,12 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista } if output { - m.Ui.Output(m.Colorize().Color(fmt.Sprintf( - "[reset][green]\n"+strings.TrimSpace(successBackendSet), s.Backend.Type))) + // By now the backend is successfully configured. If using Terraform Cloud, the success + // message is handled as part of the final init message + if _, ok := b.(*cloud.Cloud); !ok { + m.Ui.Output(m.Colorize().Color(fmt.Sprintf( + "[reset][green]\n"+strings.TrimSpace(successBackendSet), s.Backend.Type))) + } } return b, diags @@ -1306,6 +1314,10 @@ const outputBackendMigrateChange = ` Terraform detected that the backend type changed from %q to %q. ` +const outputBackendMigrateChangeCloud = ` +Terraform detected that the backend type changed from %q to Terraform Cloud. +` + const outputBackendMigrateLocal = ` Terraform has detected you're unconfiguring your previously set %q backend. ` diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 08ec3b8e7331..92eadfa03a27 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -686,12 +686,15 @@ func (m *Meta) promptMultiToSingleCloudMigration(opts *backendMigrateOpts) error } func (m *Meta) promptNewWorkspaceName(destinationType string) (string, error) { + message := fmt.Sprintf("[reset][bold][yellow]The %q backend configuration only allows "+ + "named workspaces![reset]", destinationType) + if destinationType == "cloud" { + message = fmt.Sprintf("[reset][bold][yellow]The Terraform Cloud configuration only allows " + + "named workspaces![reset]") + } name, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ - Id: "new-state-name", - Query: fmt.Sprintf( - "[reset][bold][yellow]The %q backend configuration only allows "+ - "named workspaces![reset]", - destinationType), + Id: "new-state-name", + Query: message, Description: strings.TrimSpace(inputBackendNewWorkspaceName), }) if err != nil { From dfb4609be2b251fb43124d446c272e2d73ed4ebc Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Mon, 11 Oct 2021 17:44:44 -0400 Subject: [PATCH 246/644] Backend State Migration from cloud to cloud. * Add test for tfc to tfc mgiration * Fix old tests, and remove unused code. --- go.mod | 2 +- go.sum | 4 +- internal/cloud/e2e/apply_auto_approve_test.go | 321 +++++------ internal/cloud/e2e/helper_test.go | 67 ++- internal/cloud/e2e/main_test.go | 27 - .../e2e/migrate_state_multi_to_tfc_test.go | 6 +- .../e2e/migrate_state_single_to_tfc_test.go | 7 +- .../e2e/migrate_state_tfc_to_tfc_test.go | 506 +++++++++++++++++- internal/command/meta_backend_migrate.go | 13 +- 9 files changed, 735 insertions(+), 218 deletions(-) diff --git a/go.mod b/go.mod index 66522fce6bad..26967a74513d 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.19.1-0.20211012181137-3666eed9e8e9 + github.com/hashicorp/go-tfe v0.19.1-0.20211015143223-e7e0a0182bbd github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index c5635216ded9..f1f6be181909 100644 --- a/go.sum +++ b/go.sum @@ -379,8 +379,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.19.1-0.20211012181137-3666eed9e8e9 h1:97QOrhJha4EmU+mUC1ubf15B40CjdcObULUop49+u8c= -github.com/hashicorp/go-tfe v0.19.1-0.20211012181137-3666eed9e8e9/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.19.1-0.20211015143223-e7e0a0182bbd h1:mn11v5DDNXkZq32QM8JSLNoUSbW2Ud4jMxm8IMpfS2w= +github.com/hashicorp/go-tfe v0.19.1-0.20211015143223-e7e0a0182bbd/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index bcdbaeb53472..8e10feb08739 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -7,191 +7,175 @@ import ( "context" "io/ioutil" "log" - "strings" + "os" "testing" + expect "github.com/Netflix/go-expect" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/e2e" ) func Test_terraform_apply_autoApprove(t *testing.T) { ctx := context.Background() + tfVersion := "1.1.0-tfc-integration" + if !hasTerraformVersion(version) { + t.Skip("Skipping test because TFC does not have current terraform version.") + } + cases := map[string]struct { - setup func(t *testing.T) (map[string]string, func()) - commands []tfCommand - validations func(t *testing.T, orgName, wsName string) + operations []operationSets + validations func(t *testing.T, orgName string) }{ - "workspace manual apply, terraform apply without auto-approve": { - setup: func(t *testing.T) (map[string]string, func()) { - org, orgCleanup := createOrganization(t) - wOpts := tfe.WorkspaceCreateOptions{ - Name: tfe.String(randomString(t)), - TerraformVersion: tfe.String(terraformVersion), - AutoApply: tfe.Bool(false), - } - workspace := createWorkspace(t, org.Name, wOpts) - cleanup := func() { - defer orgCleanup() - } - names := map[string]string{ - "organization": org.Name, - "workspace": workspace.Name, - } - - return names, cleanup - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: "Terraform has been successfully initialized", - expectedErr: "", - }, + "workspace manual apply, terraform apply without auto-approve, expect prompt": { + operations: []operationSets{ { - command: []string{"apply"}, - expectedCmdOutput: "Do you want to perform these actions in workspace", - expectedErr: "Error asking approve", + prep: func(t *testing.T, orgName, dir string) { + wsName := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(wsName), + TerraformVersion: tfe.String(tfVersion), + AutoApply: tfe.Bool(false), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, }, }, - validations: func(t *testing.T, orgName, wsName string) { - workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + validations: func(t *testing.T, orgName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, "app", &tfe.WorkspaceReadOptions{Include: "current_run"}) if err != nil { t.Fatal(err) } if workspace.CurrentRun == nil { t.Fatal("Expected workspace to have run, but got nil") } - if workspace.CurrentRun.Status != tfe.RunPlanned { - t.Fatalf("Expected run status to be `planned`, but is %s", workspace.CurrentRun.Status) + if workspace.CurrentRun.Status != tfe.RunApplied { + t.Fatalf("Expected run status to be `applied`, but is %s", workspace.CurrentRun.Status) } }, }, - "workspace auto apply, terraform apply without auto-approve": { - setup: func(t *testing.T) (map[string]string, func()) { - org, orgCleanup := createOrganization(t) - wOpts := tfe.WorkspaceCreateOptions{ - Name: tfe.String(randomString(t)), - TerraformVersion: tfe.String(terraformVersion), - AutoApply: tfe.Bool(true), - } - workspace := createWorkspace(t, org.Name, wOpts) - cleanup := func() { - defer orgCleanup() - } - names := map[string]string{ - "organization": org.Name, - "workspace": workspace.Name, - } - - return names, cleanup - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: "Terraform has been successfully initialized", - expectedErr: "", - }, + "workspace auto apply, terraform apply without auto-approve, expect prompt": { + operations: []operationSets{ { - command: []string{"apply"}, - expectedCmdOutput: "Do you want to perform these actions in workspace", - expectedErr: "Error asking approve", + prep: func(t *testing.T, orgName, dir string) { + wsName := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(wsName), + TerraformVersion: tfe.String(tfVersion), + AutoApply: tfe.Bool(true), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, }, }, - validations: func(t *testing.T, orgName, wsName string) { - workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + validations: func(t *testing.T, orgName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, "app", &tfe.WorkspaceReadOptions{Include: "current_run"}) if err != nil { t.Fatal(err) } if workspace.CurrentRun == nil { - t.Fatalf("Expected workspace to have run, but got nil") + t.Fatal("Expected workspace to have run, but got nil") } - if workspace.CurrentRun.Status != tfe.RunPlanned { - t.Fatalf("Expected run status to be `planned`, but is %s", workspace.CurrentRun.Status) + if workspace.CurrentRun.Status != tfe.RunApplied { + t.Fatalf("Expected run status to be `applied`, but is %s", workspace.CurrentRun.Status) } }, }, - "workspace manual apply, terraform apply auto-approve": { - setup: func(t *testing.T) (map[string]string, func()) { - org, orgCleanup := createOrganization(t) - wOpts := tfe.WorkspaceCreateOptions{ - Name: tfe.String(randomString(t)), - TerraformVersion: tfe.String(terraformVersion), - AutoApply: tfe.Bool(false), - } - workspace := createWorkspace(t, org.Name, wOpts) - cleanup := func() { - defer orgCleanup() - } - names := map[string]string{ - "organization": org.Name, - "workspace": workspace.Name, - } - - return names, cleanup - }, - commands: []tfCommand{ + "workspace manual apply, terraform apply with auto-approve, no prompt": { + operations: []operationSets{ { - command: []string{"init"}, - expectedCmdOutput: "Terraform has been successfully initialized", - expectedErr: "", - }, - { - command: []string{"apply", "-auto-approve"}, - expectedCmdOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", - expectedErr: "", + prep: func(t *testing.T, orgName, dir string) { + wsName := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(wsName), + TerraformVersion: tfe.String(tfVersion), + AutoApply: tfe.Bool(false), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: `Apply complete!`, + }, + }, }, }, - validations: func(t *testing.T, orgName, wsName string) { - workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + validations: func(t *testing.T, orgName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, "app", &tfe.WorkspaceReadOptions{Include: "current_run"}) if err != nil { t.Fatal(err) } if workspace.CurrentRun == nil { - t.Fatalf("Expected workspace to have run, but got nil") + t.Fatal("Expected workspace to have run, but got nil") } if workspace.CurrentRun.Status != tfe.RunApplied { t.Fatalf("Expected run status to be `applied`, but is %s", workspace.CurrentRun.Status) } }, }, - "workspace auto apply, terraform apply auto-approve": { - setup: func(t *testing.T) (map[string]string, func()) { - org, orgCleanup := createOrganization(t) - - wOpts := tfe.WorkspaceCreateOptions{ - Name: tfe.String(randomString(t)), - TerraformVersion: tfe.String(terraformVersion), - AutoApply: tfe.Bool(true), - } - workspace := createWorkspace(t, org.Name, wOpts) - cleanup := func() { - defer orgCleanup() - } - names := map[string]string{ - "organization": org.Name, - "workspace": workspace.Name, - } - - return names, cleanup - }, - commands: []tfCommand{ + "workspace auto apply, terraform apply with auto-approve, no prompt": { + operations: []operationSets{ { - command: []string{"init"}, - expectedCmdOutput: "Terraform has been successfully initialized", - expectedErr: "", - }, - { - command: []string{"apply", "-auto-approve"}, - expectedCmdOutput: "Apply complete! Resources: 1 added, 0 changed, 0 destroyed.", - expectedErr: "", + prep: func(t *testing.T, orgName, dir string) { + wsName := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(wsName), + TerraformVersion: tfe.String(tfVersion), + AutoApply: tfe.Bool(true), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: `Apply complete!`, + }, + }, }, }, - validations: func(t *testing.T, orgName, wsName string) { - workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, wsName, &tfe.WorkspaceReadOptions{Include: "current_run"}) + validations: func(t *testing.T, orgName string) { + workspace, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, "app", &tfe.WorkspaceReadOptions{Include: "current_run"}) if err != nil { t.Fatal(err) } if workspace.CurrentRun == nil { - t.Fatalf("Expected workspace to have run, but got nil") + t.Fatal("Expected workspace to have run, but got nil") } if workspace.CurrentRun.Status != tfe.RunApplied { t.Fatalf("Expected run status to be `applied`, but is %s", workspace.CurrentRun.Status) @@ -201,38 +185,73 @@ func Test_terraform_apply_autoApprove(t *testing.T) { } for name, tc := range cases { log.Println("Test: ", name) - resourceData, cleanup := tc.setup(t) + + organization, cleanup := createOrganization(t) defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() tmpDir, err := ioutil.TempDir("", "terraform-test") if err != nil { t.Fatal(err) } - orgName := resourceData["organization"] - wsName := resourceData["workspace"] - tfBlock := terraformConfigCloudBackendName(orgName, wsName) - writeMainTF(t, tfBlock, tmpDir) + defer os.RemoveAll(tmpDir) + tf := e2e.NewBinary(terraformBin, tmpDir) - defer tf.Close() - tf.AddEnv("TF_LOG=debug") + tf.AddEnv("TF_LOG=info") tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - for _, cmd := range tc.commands { - stdout, stderr, err := tf.Run(cmd.command...) - if cmd.expectedErr == "" && err != nil { - t.Fatalf("Expected no error, but got %v. stderr\n: %s", err, stderr) - } - if cmd.expectedErr != "" { - if !strings.Contains(stderr, cmd.expectedErr) { - t.Fatalf("Expected to find error %s, but got %s", cmd.expectedErr, stderr) + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } } - } - if cmd.expectedCmdOutput != "" && !strings.Contains(stdout, cmd.expectedCmdOutput) { - t.Fatalf("Expected to find output %s, but did not find in\n%s", cmd.expectedCmdOutput, stdout) + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } } } - tc.validations(t, orgName, wsName) + if tc.validations != nil { + tc.validations(t, organization.Name) + } } } diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 844797f2d378..af585004b45c 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -47,6 +47,18 @@ func createOrganization(t *testing.T) (*tfe.Organization, func()) { t.Fatal(err) } + // TODO: remove this when we are ready to release. This should not need beta + // or internal access as the release will be. Also, we won't be able to access + // admin in production. + opts := tfe.AdminOrganizationUpdateOptions{ + AccessBetaTools: tfe.Bool(true), + AccessInternalTools: tfe.Bool(true), + } + _, err = tfeClient.Admin.Organizations.Update(ctx, org.Name, opts) + if err != nil { + t.Fatal(err) + } + return org, func() { if err := tfeClient.Organizations.Delete(ctx, org.Name); err != nil { t.Errorf("Error destroying organization! WARNING: Dangling resources\n"+ @@ -147,14 +159,10 @@ terraform { } } -resource "random_pet" "server" { - keepers = { - uuid = uuid() - } - - length = 3 +output "tag_val" { + value = "%s" } -`, tfeHostname, org, tag) +`, tfeHostname, org, tag, tag) } func terraformConfigCloudBackendName(org, name string) string { @@ -170,12 +178,8 @@ terraform { } } -resource "random_pet" "server" { - keepers = { - uuid = uuid() - } - - length = 3 +output "val" { + value = "${terraform.workspace}" } `, tfeHostname, org, name) } @@ -191,3 +195,40 @@ func writeMainTF(t *testing.T, block string, dir string) { } f.Close() } + +// Ensure that TFC/E has a particular terraform version. +func hasTerraformVersion(version string) bool { + opts := tfe.AdminTerraformVersionsListOptions{ + ListOptions: tfe.ListOptions{ + PageNumber: 1, + PageSize: 100, + }, + } + hasVersion := false + +findTfVersion: + for { + // TODO: update go-tfe Read() to retrieve a terraform version by name. + // Currently you can only retrieve by ID. + tfVersionList, err := tfeClient.Admin.TerraformVersions.List(context.Background(), opts) + if err != nil { + t.Fatalf("Could not retrieve list of terraform versions: %v", err) + } + for _, item := range tfVersionList.Items { + if item.Version == version { + hasVersion = true + break findTfVersion + } + } + + // Exit the loop when we've seen all pages. + if tfVersionList.CurrentPage >= tfVersionList.TotalPages { + break + } + + // Update the page number to get the next page. + opts.PageNumber = tfVersionList.NextPage + } + + return hasVersion +} diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index 58653e0029fe..c1315132049f 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -4,7 +4,6 @@ package main import ( - "encoding/json" "fmt" "io/ioutil" "log" @@ -16,7 +15,6 @@ import ( tfe "github.com/hashicorp/go-tfe" ) -var terraformVersion string var terraformBin string var cliConfigFileEnv string @@ -46,7 +44,6 @@ func accTest() bool { func setup() func() { setTfeClient() teardown := setupBinary() - setVersion() return func() { teardown() @@ -117,30 +114,6 @@ func setupBinary() func() { } } -func setVersion() { - log.Println("Retrieving version") - cmd := exec.Command(terraformBin, "version", "-json") - out, err := cmd.Output() - if err != nil { - log.Fatal(fmt.Sprintf("Could not output terraform version: %v", err)) - } - var data map[string]interface{} - if err := json.Unmarshal(out, &data); err != nil { - log.Fatal(fmt.Sprintf("Could not unmarshal version output: %v", err)) - } - - out, err = exec.Command("git", "rev-parse", "HEAD").Output() - if err != nil { - log.Fatal(fmt.Sprintf("Could not execute go build command: %v", err)) - } - - hash := string(out)[0:8] - - fullVersion := data["terraform_version"].(string) - version := strings.Split(fullVersion, "-")[0] - terraformVersion = fmt.Sprintf("%s-%s", version, hash) -} - func writeCredRC(file string) { creds := credentialBlock() f, err := os.Create(file) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index e72169186d18..d7916a04611a 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -67,7 +67,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, + `Do you want to copy existing state to Terraform Cloud?`, `Successfully configured Terraform Cloud!`}, }, { @@ -138,8 +138,8 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, - `Successfully configured Terraform Cloud!`}, + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "list"}, diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index 805a5766d304..d89396f4c87a 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -5,7 +5,6 @@ package main import ( "context" - "fmt" "io/ioutil" "os" "testing" @@ -104,7 +103,9 @@ func Test_migrate_single_to_tfc(t *testing.T) { command: []string{"init", "-migrate-state"}, expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"new-workspace", "yes"}, - postInputOutput: []string{`Successfully configured Terraform Cloud!`}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Successfully configured Terraform Cloud!`}, }, { command: []string{"workspace", "list"}, @@ -129,7 +130,7 @@ func Test_migrate_single_to_tfc(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) + t.Log("Test: ", name) organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 17bbc05069a9..39ae98003337 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -1,21 +1,503 @@ +//go:build e2e +// +build e2e + package main import ( + "context" + "io/ioutil" + "os" "testing" + + expect "github.com/Netflix/go-expect" + tfe "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/e2e" ) -/* +func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { + ctx := context.Background() + tfVersion := "1.1.0-tfc-integration" + if !hasTerraformVersion(version) { + t.Skip("Skipping test because TFC does not have current terraform version.") + } + + cases := map[string]struct { + setup func(t *testing.T) (string, func()) + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "migrating from name to name": { + setup: func(t *testing.T) (string, func()) { + organization, cleanup := createOrganization(t) + return organization.Name, cleanup + }, + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "prod" + // Creating the workspace here instead of it being created + // dynamically in the Cloud StateMgr because we want to ensure that + // the terraform version selected for the workspace matches the + // terraform version of this current branch. + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("prod"), + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `prod`, // this comes from the `prep` function + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "prod"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "dev" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(wsName), + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `dev`, // this comes from the `prep` function + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + if err != nil { + t.Fatal(err) + } + // this workspace name is what exists in the cloud backend configuration block + if len(wsList.Items) != 2 { + t.Fatal("Expected number of workspaces to be 2") + } + }, + }, + "migrating from name to tags": { + setup: func(t *testing.T) (string, func()) { + organization, cleanup := createOrganization(t) + return organization.Name, cleanup + }, + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "prod" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("prod"), + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "cloud"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "prod"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + userInput: []string{"new-workspace", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Successfully configured the backend "cloud"!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `new-workspace`, // this comes from the `prep` function + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + // this workspace name is what exists in the cloud backend configuration block + if len(wsList.Items) != 1 { + t.Fatal("Expected number of workspaces to be 1") + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + + orgName, cleanup := tc.setup(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, orgName, tf.WorkDir()) + for _, tfCmd := range op.commands { + t.Log("Running commands: ", tfCmd.command) + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err.Error()) + } + } + } + + if tc.validations != nil { + tc.validations(t, orgName) + } + } +} + +func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { + ctx := context.Background() + tfVersion := "1.1.0-tfc-integration" + if !hasTerraformVersion(version) { + t.Skip("Skipping test because TFC does not have current terraform version.") + } + + cases := map[string]struct { + setup func(t *testing.T) (string, func()) + operations []operationSets + validations func(t *testing.T, orgName string) + }{ + "migrating from multiple workspaces via tags to name": { + setup: func(t *testing.T) (string, func()) { + organization, cleanup := createOrganization(t) + return organization.Name, cleanup + }, + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("app-prod"), + Tags: []*tfe.Tag{{Name: tag}}, + TerraformVersion: tfe.String(tfVersion), + }) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("app-staging"), + Tags: []*tfe.Tag{{Name: tag}}, + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `The currently selected workspace (default) does not exist.`, + userInput: []string{"1"}, + postInputOutput: []string{`Terraform has been successfully initialized!`}, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-prod"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "select", "app-staging"}, + expectedCmdOutput: `Switched to workspace "app-staging".`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-staging"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"output"}, + expectedCmdOutput: `tag_val = "app"`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + name := "service" + // Doing this here instead of relying on dynamic workspace creation + // because we want to set the terraform version here so that it is + // using the right version for post init operations. + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(name), + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendName(orgName, name) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy only your current workspace?`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to the new backend?`, + `Terraform has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `service`, // this comes from the `prep` function + }, + { + command: []string{"output"}, + expectedCmdOutput: `tag_val = "app"`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + ws, err := tfeClient.Workspaces.Read(ctx, orgName, "service") + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatal("Expected to workspace not be empty") + } + }, + }, + "migrating from multiple workspaces via tags to other tags": { + setup: func(t *testing.T) (string, func()) { + organization, cleanup := createOrganization(t) + return organization.Name, cleanup + }, + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("app-prod"), + Tags: []*tfe.Tag{{Name: tag}}, + TerraformVersion: tfe.String(tfVersion), + }) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("app-staging"), + Tags: []*tfe.Tag{{Name: tag}}, + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `The currently selected workspace (default) does not exist.`, + userInput: []string{"1"}, + postInputOutput: []string{`Terraform has been successfully initialized!`}, + }, + { + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: `Apply complete!`, + }, + { + command: []string{"workspace", "select", "app-staging"}, + expectedCmdOutput: `Switched to workspace "app-staging".`, + }, + { + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: `Apply complete!`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "billing" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + t.Log(orgName) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Would you like to rename your workspaces?`, + userInput: []string{"1", "new-*", "1"}, + postInputOutput: []string{ + `What pattern would you like to add to all your workspaces?`, + `The currently selected workspace (app-staging) does not exist.`, + `Successfully configured the backend "cloud"!`}, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("billing"), + }) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 2 { + t.Logf("Expected the number of workspaces to be 2, but got %d", len(wsList.Items)) + } + _, empty := getWorkspace(wsList.Items, "new-app-prod") + if empty { + t.Fatalf("expected workspaces to include 'new-app-prod' but didn't.") + } + _, empty = getWorkspace(wsList.Items, "new-app-staging") + if empty { + t.Fatalf("expected workspaces to include 'new-app-staging' but didn't.") + } + }, + }, + } + + for name, tc := range cases { + t.Log("Test: ", name) + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv("TF_LOG=INFO") + tf.AddEnv(cliConfigFileEnv) + + orgName, cleanup := tc.setup(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, orgName, tf.WorkDir()) + for _, tfCmd := range op.commands { + t.Log("Running commands: ", tfCmd.command) + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } - If org to org, treat it like a new backend. Then go through the multi/single logic + t.Log(cmd.Stderr) + err = cmd.Wait() + if err != nil { + t.Fatal(err.Error()) + } + } + } - If same org, but name/tag changes - config name -> config name - -- straight copy - config name -> config tags - -- jsut add tag to workspace. - config tags -> config name - -- straight copy -*/ -func Test_migrate_tfc_to_tfc(t *testing.T) { - t.Skip("todo: see comments") + if tc.validations != nil { + tc.validations(t, orgName) + } + } } diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 92eadfa03a27..77d2ef05bd6c 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -545,12 +545,6 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { return fmt.Errorf(strings.TrimSpace(errTFCMigrateNotYetImplemented)) } - // from TFC to TFC - if sourceTFC && destinationTFC { - // TODO: see internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go for notes - panic("not yet implemented") - } - // Everything below, by the above two conditionals, now assumes that the // destination is always Terraform Cloud (TFC). @@ -659,6 +653,13 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa } } + // After migrating multiple workspaces, we want to ensure that a workspace is + // set or we prompt the user to set a workspace. + err = m.selectWorkspace(opts.Destination) + if err != nil { + return err + } + return nil } From 09d5b70b7a2bcd3634bad10cec0aec959f8c6d73 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 19 Oct 2021 16:25:24 -0500 Subject: [PATCH 247/644] command/meta_backend_migrate:Tweak multi-to-single To TFC copy --- internal/command/meta_backend_migrate.go | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 77d2ef05bd6c..0ba769b0c06a 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -577,10 +577,6 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { multiSource := !sourceSingleState && len(sourceWorkspaces) > 1 if multiSource && destinationNameStrategy { - if err := m.promptMultiToSingleCloudMigration(opts); err != nil { - return err - } - currentWorkspace, err := m.Workspace() if err != nil { return err @@ -588,6 +584,10 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { opts.sourceWorkspace = currentWorkspace opts.destinationWorkspace = cloudBackendDestination.WorkspaceMapping.Name + if err := m.promptMultiToSingleCloudMigration(opts); err != nil { + return err + } + log.Printf("[INFO] backendMigrateTFC: multi-to-single migration from source %s to destination %q", opts.sourceWorkspace, opts.destinationWorkspace) return m.backendMigrateState_s_s(opts) @@ -670,9 +670,11 @@ func (m *Meta) promptMultiToSingleCloudMigration(opts *backendMigrateOpts) error var err error // Ask the user if they want to migrate their existing remote state migrate, err = m.confirm(&terraform.InputOpts{ - Id: "backend-migrate-multistate-to-single", - Query: "Do you want to copy only your current workspace?", - Description: strings.TrimSpace(tfcInputBackendMigrateMultiToSingle), + Id: "backend-migrate-multistate-to-single", + Query: "Do you want to copy only your current workspace?", + Description: fmt.Sprintf( + strings.TrimSpace(tfcInputBackendMigrateMultiToSingle), + opts.SourceType, opts.destinationWorkspace), }) if err != nil { return fmt.Errorf("Error asking for state migration action: %s", err) @@ -820,8 +822,11 @@ For more information on workspace naming, see https://www.terraform.io/docs/clou ` const tfcInputBackendMigrateMultiToSingle = ` -The cloud configuration has one workspace declared, and you are attemtping to migrate multiple workspaces -to a single workspace. By continuing, you will only migrate your current workspace. +The previous backend %[1]q has multiple workspaces, but Terraform Cloud has been +configured to use a single workspace (%[2]q). By continuing, you will only +migrate your current workspace. If you wish to migrate all workspaces from the +previous backend, use the 'tags' strategy in your workspace configuration block +instead. ` const inputBackendMigrateEmpty = ` From 86f93a2cbc4ab5dc6cef7a3adfb08a497f2f97ce Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Tue, 19 Oct 2021 17:06:41 -0400 Subject: [PATCH 248/644] Cloud UX test fixes --- internal/cloud/e2e/apply_auto_approve_test.go | 10 +++---- internal/cloud/e2e/helper_test.go | 2 +- .../e2e/migrate_state_multi_to_tfc_test.go | 4 +-- ...igrate_state_remote_backend_to_tfc_test.go | 28 +++++++++---------- .../e2e/migrate_state_single_to_tfc_test.go | 8 +++--- .../e2e/migrate_state_tfc_to_other_test.go | 2 +- .../e2e/migrate_state_tfc_to_tfc_test.go | 28 +++++++++---------- 7 files changed, 41 insertions(+), 41 deletions(-) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 8e10feb08739..626f4c272209 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -18,7 +18,7 @@ import ( func Test_terraform_apply_autoApprove(t *testing.T) { ctx := context.Background() tfVersion := "1.1.0-tfc-integration" - if !hasTerraformVersion(version) { + if !hasTerraformVersion(t, tfVersion) { t.Skip("Skipping test because TFC does not have current terraform version.") } @@ -42,7 +42,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"apply"}, @@ -82,7 +82,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"apply"}, @@ -122,7 +122,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"apply", "-auto-approve"}, @@ -160,7 +160,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"apply", "-auto-approve"}, diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index af585004b45c..a9f4313ff9bd 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -197,7 +197,7 @@ func writeMainTF(t *testing.T, block string, dir string) { } // Ensure that TFC/E has a particular terraform version. -func hasTerraformVersion(version string) bool { +func hasTerraformVersion(t *testing.T, version string) bool { opts := tfe.AdminTerraformVersionsListOptions{ ListOptions: tfe.ListOptions{ PageNumber: 1, diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index d7916a04611a..c9b8370190b0 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -68,7 +68,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { userInput: []string{"yes", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to Terraform Cloud?`, - `Successfully configured Terraform Cloud!`}, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -309,7 +309,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { `Would you like to rename your workspaces?`, "What pattern would you like to add to all your workspaces?", "The currently selected workspace (prod) does not exist.", - "Terraform has been successfully initialized!"}, + "Terraform Cloud has been successfully initialized!"}, }, { command: []string{"workspace", "select", "app-prod"}, diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 0cb7d5efcba5..e6402e87680a 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -50,9 +50,9 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured Terraform Cloud!`}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -102,7 +102,7 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform has been successfully initialized!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"workspace", "show"}, @@ -232,9 +232,9 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured Terraform Cloud!`}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -376,8 +376,8 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, - `Successfully configured the backend "cloud"!`}, + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -513,10 +513,10 @@ func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, userInput: []string{"yes"}, postInputOutput: []string{ - `Successfully configured Terraform Cloud!`}, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -581,7 +581,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes"}, postInputOutput: []string{ - `Successfully configured the backend "cloud"!`}, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -731,11 +731,11 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, - `Successfully configured the backend "cloud"!`}, + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "list"}, @@ -801,7 +801,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { expectedCmdOutput: `Would you like to rename your workspaces?`, userInput: []string{"1", "*"}, postInputOutput: []string{`What pattern would you like to add to all your workspaces?`, - `Successfully configured the backend "cloud"!`}, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index d89396f4c87a..d8423f4283db 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -50,9 +50,9 @@ func Test_migrate_single_to_tfc(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `Do you want to copy existing state to the Terraform Cloud?`, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured Terraform Cloud!`}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "list"}, @@ -104,8 +104,8 @@ func Test_migrate_single_to_tfc(t *testing.T) { expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"new-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, - `Successfully configured Terraform Cloud!`}, + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "list"}, diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 08a5e703ab6e..a7b807191d95 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -28,7 +28,7 @@ func Test_migrate_tfc_to_other(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, }, }, diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 39ae98003337..ab5d908ed1b9 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -17,7 +17,7 @@ import ( func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { ctx := context.Background() tfVersion := "1.1.0-tfc-integration" - if !hasTerraformVersion(version) { + if !hasTerraformVersion(t, tfVersion) { t.Skip("Skipping test because TFC does not have current terraform version.") } @@ -49,7 +49,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"workspace", "show"}, @@ -76,9 +76,9 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to the new backend?`, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, userInput: []string{"yes"}, - postInputOutput: []string{`Successfully configured the backend "cloud"!`}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -117,7 +117,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"apply"}, @@ -136,11 +136,11 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `The "cloud" backend configuration only allows named workspaces!`, + expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, userInput: []string{"new-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, - `Successfully configured the backend "cloud"!`}, + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -240,7 +240,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { ctx := context.Background() tfVersion := "1.1.0-tfc-integration" - if !hasTerraformVersion(version) { + if !hasTerraformVersion(t, tfVersion) { t.Skip("Skipping test because TFC does not have current terraform version.") } @@ -276,7 +276,7 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { command: []string{"init"}, expectedCmdOutput: `The currently selected workspace (default) does not exist.`, userInput: []string{"1"}, - postInputOutput: []string{`Terraform has been successfully initialized!`}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"apply"}, @@ -319,8 +319,8 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to the new backend?`, - `Terraform has been successfully initialized!`}, + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -370,7 +370,7 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { command: []string{"init"}, expectedCmdOutput: `The currently selected workspace (default) does not exist.`, userInput: []string{"1"}, - postInputOutput: []string{`Terraform has been successfully initialized!`}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"apply", "-auto-approve"}, @@ -401,7 +401,7 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { postInputOutput: []string{ `What pattern would you like to add to all your workspaces?`, `The currently selected workspace (app-staging) does not exist.`, - `Successfully configured the backend "cloud"!`}, + `Terraform Cloud has been successfully initialized!`}, }, }, }, From 5ff2495ffaeb58b045815e47beffa2cb33b08b76 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Thu, 21 Oct 2021 09:55:27 -0400 Subject: [PATCH 249/644] Update HasResource to HasManagedResourceInstanceObjects --- internal/cloud/backend_apply_test.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index fc5e993371a4..d741662cd5a5 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -890,7 +890,7 @@ func TestCloud_applyForceLocal(t *testing.T) { if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { t.Fatalf("expected plan summary in output: %s", output) } - if !run.State.HasResources() { + if !run.State.HasManagedResourceInstanceObjects() { t.Fatalf("expected resources in state") } } @@ -953,7 +953,7 @@ func TestCloud_applyWorkspaceWithoutOperations(t *testing.T) { if output := done(t).Stdout(); !strings.Contains(output, "1 to add, 0 to change, 0 to destroy") { t.Fatalf("expected plan summary in output: %s", output) } - if !run.State.HasResources() { + if !run.State.HasManagedResourceInstanceObjects() { t.Fatalf("expected resources in state") } } @@ -1565,7 +1565,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { output := b.CLI.(*cli.MockUi).OutputWriter.String() hasRemote := strings.Contains(output, "Running apply in Terraform Cloud") hasSummary := strings.Contains(output, "1 added, 0 changed, 0 destroyed") - hasResources := run.State.HasResources() + hasResources := run.State.HasManagedResourceInstanceObjects() if !tc.forceLocal && tc.hasOperations { if !hasRemote { t.Errorf("missing TFC header in output: %s", output) From e49f271eb5d84b668529f576bae6816ca5e676c0 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Thu, 21 Oct 2021 08:40:09 -0500 Subject: [PATCH 250/644] Update copy for terraform init with cloud block --- internal/command/init.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index 9065b1359430..39a902c965af 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -1117,8 +1117,8 @@ const outputInitSuccessCLICloud = `[reset][green] You may now begin working with Terraform Cloud. Try running "terraform plan" to see any changes that are required for your infrastructure. -If you ever set or change modules or configuration for Terraform, run -"terraform init" again to reinitialize your working directory. +If you ever set or change modules or Terraform Settings, run "terraform init" +again to reinitialize your working directory. ` // providerProtocolTooOld is a message sent to the CLI UI if the provider's From d29532cfeb64f19da70a2e8c015273d824b6349c Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Tue, 19 Oct 2021 10:20:11 -0500 Subject: [PATCH 251/644] tfc apply before init https://app.asana.com/0/1199201948575144/1201019450474843/f --- internal/command/meta_backend.go | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 94b9e5e5c61f..5a26c71b0de8 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -592,6 +592,20 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di return m.backend_c_r_S(c, cHash, sMgr, true) + // Configuring Terraform Cloud for the first time. + case c != nil && c.Type == "cloud" && s.Backend.Empty(): + log.Printf("[TRACE] Meta.Backend: moving from default local state only to Terraform Cloud") + if !opts.Init { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Terraform Cloud has been configured but needs to be initialized.", + "Run \"terraform init\" to initialize Terraform Cloud.", + )) + return nil, diags + } + + return m.backend_C_r_s(c, cHash, sMgr) + // Configuring a backend for the first time. case c != nil && s.Backend.Empty(): log.Printf("[TRACE] Meta.Backend: moving from default local state only to %q backend", c.Type) From ab304d831f61e15e7bd7c6b5e867c236b80b6153 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Thu, 21 Oct 2021 06:19:33 -0500 Subject: [PATCH 252/644] Found another path to backend init error MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit There are actually a few different ways to get to this message. 1. Blank state — no previous terraform applied. Start with a cloud block. 1. Implicit local — start with no backend specified. This actually goes through the same code execution path as the first scenario. 1. Explicit local — start with a backend local block that has been applied, then change from the local backend to a cloud block. This will recognize the state, and is a different path through the code in the meta backend. This commit handles the last case. The messaging has also been tweaked. End to end test included as well. --- .../e2e/backend_apply_before_init_test.go | 141 ++++++++++++++++++ internal/command/meta_backend.go | 48 +++++- 2 files changed, 181 insertions(+), 8 deletions(-) create mode 100644 internal/cloud/e2e/backend_apply_before_init_test.go diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go new file mode 100644 index 000000000000..86f2f515cb71 --- /dev/null +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -0,0 +1,141 @@ +//go:build e2e +// +build e2e + +package main + +import ( + "fmt" + "io/ioutil" + "os" + "testing" + + expect "github.com/Netflix/go-expect" + "github.com/hashicorp/terraform/internal/e2e" +) + +func Test_backend_apply_before_init(t *testing.T) { + cases := map[string]struct { + operations []operationSets + }{ + "terraform apply with cloud block - blank state": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"apply"}, + expectedCmdOutput: `Terraform Cloud has been configured but needs to be initialized`, + expectError: true, + }, + }, + }, + }, + }, + "terraform apply with cloud block - local state": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"apply"}, + expectedCmdOutput: `Terraform Cloud has been configured but needs to be initialized`, + expectError: true, + }, + }, + }, + }, + }, + } + + for name, tc := range cases { + fmt.Println("Test: ", name) + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_LOG=info") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } + } + } + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } + } + } + } +} diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 5a26c71b0de8..a521289b55cd 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -593,13 +593,14 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di return m.backend_c_r_S(c, cHash, sMgr, true) // Configuring Terraform Cloud for the first time. + // NOTE: There may be an implicit local backend with state that is not visible to this block. case c != nil && c.Type == "cloud" && s.Backend.Empty(): log.Printf("[TRACE] Meta.Backend: moving from default local state only to Terraform Cloud") if !opts.Init { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Terraform Cloud has been configured but needs to be initialized.", - "Run \"terraform init\" to initialize Terraform Cloud.", + strings.TrimSpace(errBackendInitCloud), )) return nil, diags } @@ -640,17 +641,30 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di } log.Printf("[TRACE] Meta.Backend: backend configuration has changed (from type %q to type %q)", s.Backend.Type, c.Type) - initReason := fmt.Sprintf("Backend configuration changed for %q", c.Type) - if s.Backend.Type != c.Type { + initReason := "" + switch { + case c.Type == "cloud": + initReason = fmt.Sprintf("Backend configuration changed from %q to Terraform Cloud", s.Backend.Type) + case s.Backend.Type != c.Type: initReason = fmt.Sprintf("Backend configuration changed from %q to %q", s.Backend.Type, c.Type) + default: + initReason = fmt.Sprintf("Backend configuration changed for %q", c.Type) } if !opts.Init { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Backend initialization required, please run \"terraform init\"", - fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), - )) + if c.Type == "cloud" { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Terraform Cloud has been configured but needs to be initialized.", + strings.TrimSpace(errBackendInitCloud), + )) + } else { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Backend initialization required, please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), + )) + } return nil, diags } @@ -1315,6 +1329,24 @@ hasn't changed and try again. At this point, no changes to your existing configuration or state have been made. ` +const errBackendInitCloud = ` +Changes to the Terraform Cloud configuration block require reinitialization. +This allows Terraform to set up the new configuration, copy existing state, +etc. Learn more about Terraform Settings: +https://www.terraform.io/docs/language/settings/index.html + +Please run "terraform init" with either the "-reconfigure" or "-migrate-state" +flags. The "-reconfigure" option disregards any existing configuration, +preventing migration of any existing state. The "-migrate-state" option +will attempt to copy existing state to Terraform Cloud. Learn more about +using "terraform init": +https://www.terraform.io/docs/cli/commands/init.html#backend-initialization + +If the change reason above is incorrect, please verify your configuration +hasn't changed and try again. At this point, no changes to your existing +configuration or state have been made. +` + const errBackendWriteSaved = ` Error saving the backend configuration: %s From e16c53b561d3e524e5e53c6a40ac86f76e8bca8e Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Thu, 21 Oct 2021 14:29:12 -0500 Subject: [PATCH 253/644] Simplify/Consolidate the cloud conditionals --- internal/command/meta_backend.go | 36 +++++++++++++------------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index a521289b55cd..d72a56c1df6c 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -592,31 +592,25 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di return m.backend_c_r_S(c, cHash, sMgr, true) - // Configuring Terraform Cloud for the first time. - // NOTE: There may be an implicit local backend with state that is not visible to this block. - case c != nil && c.Type == "cloud" && s.Backend.Empty(): - log.Printf("[TRACE] Meta.Backend: moving from default local state only to Terraform Cloud") - if !opts.Init { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Terraform Cloud has been configured but needs to be initialized.", - strings.TrimSpace(errBackendInitCloud), - )) - return nil, diags - } - - return m.backend_C_r_s(c, cHash, sMgr) - // Configuring a backend for the first time. case c != nil && s.Backend.Empty(): log.Printf("[TRACE] Meta.Backend: moving from default local state only to %q backend", c.Type) if !opts.Init { - initReason := fmt.Sprintf("Initial configuration of the requested backend %q", c.Type) - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Backend initialization required, please run \"terraform init\"", - fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), - )) + if c.Type == "cloud" { + // NOTE: There may be an implicit local backend with state that is not visible to this block. + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Terraform Cloud has been configured but needs to be initialized.", + strings.TrimSpace(errBackendInitCloud), + )) + } else { + initReason := fmt.Sprintf("Initial configuration of the requested backend %q", c.Type) + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Backend initialization required, please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), + )) + } return nil, diags } From 12a4af3e72416b59f2a0c4b5afb52ddc668d23e4 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 21 Oct 2021 22:25:00 -0500 Subject: [PATCH 254/644] Temporarily skip API version checking --- internal/cloud/backend.go | 18 ++++++++++-------- internal/cloud/backend_test.go | 1 + internal/cloud/versioning.go | 6 +++--- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 08dafb275a7d..e6b0ba98a142 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -295,14 +295,16 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { desiredAPIVersion, _ := version.NewVersion("2.5") if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Unsupported Terraform Enterprise version", - fmt.Sprintf( - `The 'cloud' option requires Terraform Enterprise %s or later.`, - apiToMinimumTFEVersion["2.5"], - ), - )) + log.Printf("[TRACE] API version check failed; want: >= %s, got: %s", desiredAPIVersion.Original(), currentAPIVersion) + // FIXME: Skip version checking temporarily. + // diags = diags.Append(tfdiags.Sourceless( + // tfdiags.Error, + // "Unsupported Terraform Enterprise version", + // fmt.Sprintf( + // `The 'cloud' option requires Terraform Enterprise %s or later.`, + // apiToMinimumTFEVersion["2.5"], + // ), + // )) } // Configure a local backend for when we need to run operations locally. diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index cd2995887678..d3b5d7c5f24c 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -269,6 +269,7 @@ func TestCloud_config(t *testing.T) { } func TestCloud_configVerifyMinimumTFEVersion(t *testing.T) { + t.Skip("skipping, as TFE version checking has been temporarily disabled") config := cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), diff --git a/internal/cloud/versioning.go b/internal/cloud/versioning.go index b07fd74aa430..4b9ee52e1ec2 100644 --- a/internal/cloud/versioning.go +++ b/internal/cloud/versioning.go @@ -7,6 +7,6 @@ package cloud // The cloud package here, introduced in Terraform 1.1.0, requires a minimum of 2.5 (v202201-1) // The TFP-API-Version header that this refers to was introduced in 2.3 (v202006-1), so an absent // header can be considered < 2.3. -var apiToMinimumTFEVersion = map[string]string{ - "2.5": "v202201-1", -} +// var apiToMinimumTFEVersion = map[string]string{ +// "2.5": "v202201-1", +// } From 85f0bc6198b021b39e8844fd0760ccfcc68d492f Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 21 Oct 2021 22:26:05 -0500 Subject: [PATCH 255/644] Update go-tfe to e52963e --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 26967a74513d..be6b904fedd0 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.19.1-0.20211015143223-e7e0a0182bbd + github.com/hashicorp/go-tfe v0.19.1-0.20211020175229-e52963e079d0 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index f1f6be181909..da6b2940b061 100644 --- a/go.sum +++ b/go.sum @@ -379,8 +379,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.19.1-0.20211015143223-e7e0a0182bbd h1:mn11v5DDNXkZq32QM8JSLNoUSbW2Ud4jMxm8IMpfS2w= -github.com/hashicorp/go-tfe v0.19.1-0.20211015143223-e7e0a0182bbd/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.19.1-0.20211020175229-e52963e079d0 h1:64o1fy8p4a9J/5Gooy1S9iuEJQqXTVGYk5ZrXwFDZ8w= +github.com/hashicorp/go-tfe v0.19.1-0.20211020175229-e52963e079d0/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= From cc6de251d8275ce00fb49205f4750dcbc0f830a2 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Thu, 21 Oct 2021 15:54:41 -0500 Subject: [PATCH 256/644] Update init reconfigure error message If you move from the remote backend to the cloud block you will see this error message. --- internal/command/meta_backend.go | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index d72a56c1df6c..552ee6300b20 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -663,7 +663,11 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di } if !m.migrateState { - diags = diags.Append(migrateOrReconfigDiag) + if c.Type == "cloud" { + diags = diags.Append(migrateOrReconfigDiagCloud) + } else { + diags = diags.Append(migrateOrReconfigDiag) + } return nil, diags } @@ -1384,3 +1388,10 @@ var migrateOrReconfigDiag = tfdiags.Sourceless( "A change in the backend configuration has been detected, which may require migrating existing state.\n\n"+ "If you wish to attempt automatic migration of the state, use \"terraform init -migrate-state\".\n"+ `If you wish to store the current configuration with no changes to the state, use "terraform init -reconfigure".`) + +var migrateOrReconfigDiagCloud = tfdiags.Sourceless( + tfdiags.Error, + "Terraform Cloud configuration changed", + "A change in the Terraform Cloud configuration has been detected, which may require migrating existing state.\n\n"+ + "If you wish to attempt automatic migration of the state, use \"terraform init -migrate-state\".\n"+ + `If you wish to store the current configuration with no changes to the state, use "terraform init -reconfigure".`) From 1ff782741624e168cba7dd606f620ca29efcc28b Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Fri, 22 Oct 2021 10:42:58 -0400 Subject: [PATCH 257/644] Multi-state migration prompt fix --- internal/command/meta_backend_migrate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 0ba769b0c06a..6cfb69be139b 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -729,7 +729,7 @@ func (m *Meta) promptMultiStateMigrationPattern(sourceType string) (string, erro pattern, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "backend-migrate-multistate-to-tfc-pattern", Query: fmt.Sprintf("[reset][bold][yellow]%s[reset]", "What pattern would you like to add to all your workspaces?"), - Description: fmt.Sprintf(strings.TrimSpace(tfcInputBackendMigrateMultiToMultiPattern), sourceType), + Description: strings.TrimSpace(tfcInputBackendMigrateMultiToMultiPattern), }) if err != nil { return "", fmt.Errorf("Error asking for state migration action: %s", err) From 64fbb0b6137384151662fca37636d2b83d41df7e Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Fri, 22 Oct 2021 13:42:31 -0600 Subject: [PATCH 258/644] remove reference to AccessInternalTools --- internal/cloud/e2e/helper_test.go | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index a9f4313ff9bd..7af990f12054 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -47,18 +47,6 @@ func createOrganization(t *testing.T) (*tfe.Organization, func()) { t.Fatal(err) } - // TODO: remove this when we are ready to release. This should not need beta - // or internal access as the release will be. Also, we won't be able to access - // admin in production. - opts := tfe.AdminOrganizationUpdateOptions{ - AccessBetaTools: tfe.Bool(true), - AccessInternalTools: tfe.Bool(true), - } - _, err = tfeClient.Admin.Organizations.Update(ctx, org.Name, opts) - if err != nil { - t.Fatal(err) - } - return org, func() { if err := tfeClient.Organizations.Delete(ctx, org.Name); err != nil { t.Errorf("Error destroying organization! WARNING: Dangling resources\n"+ From aace0015c2eb108d9bbb978a1a7618a11f943cee Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Sat, 23 Oct 2021 23:33:52 -0500 Subject: [PATCH 259/644] cloud: Fix E2E variables test --- internal/cloud/e2e/run_variables_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index 6029066b7908..f5a86c650af7 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -58,7 +58,7 @@ func Test_cloud_run_variables(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "cloud"!`, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { command: []string{"plan", "-var", "foo=bar"}, From c99f5972dee6f62eaaf96ba74ab3cd4e71d19caa Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Fri, 22 Oct 2021 14:50:16 -0700 Subject: [PATCH 260/644] cloud.StateMgr(): Set terraform version AFTER creating workspace MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Previously, if the remote TFC/TFE instance doesn't happen to have a tool_version record whose name exactly matches the value of `tfversion.String()`, Terraform would be completely blocked from using the `terraform workspace new` command (when configured with the tags strategy) — the API would give a 422 to the whole create request. This commit changes the StateMgr() function to do the work in two passes; first create the workspace (which should work fine regardless), THEN update the Terraform version and print a warning to the terminal if it fails (which 99% of the time is a benign failure with little impact on your future CLI usage). --- internal/cloud/backend.go | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index e6b0ba98a142..f043378f680c 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -506,6 +506,7 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { } if err == tfe.ErrResourceNotFound { + // Create a workspace options := tfe.WorkspaceCreateOptions{ Name: tfe.String(name), } @@ -517,12 +518,27 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { } options.Tags = tags - options.TerraformVersion = tfe.String(tfversion.String()) - workspace, err = b.client.Workspaces.Create(context.Background(), b.organization, options) if err != nil { return nil, fmt.Errorf("Error creating workspace %s: %v", name, err) } + + // Attempt to set the new workspace to use this version of Terraform. This + // can fail if there's no enabled tool_version whose name matches our + // version string, but that's expected sometimes -- just warn and continue. + versionOptions := tfe.WorkspaceUpdateOptions{ + TerraformVersion: tfe.String(tfversion.String()), + } + _, err := b.client.Workspaces.UpdateByID(context.Background(), workspace.ID, versionOptions) + if err != nil { + // TODO: Ideally we could rely on the client to tell us what the actual + // problem was, but we currently can't get enough context from the error + // object to do a nicely formatted message, so we're just assuming the + // issue was that the version wasn't available since that's probably what + // happened. + versionUnavailable := fmt.Sprintf(unavailableTerraformVersion, tfversion.String(), workspace.TerraformVersion) + b.CLI.Output(b.Colorize().Color(versionUnavailable)) + } } // This is a fallback error check. Most code paths should use other @@ -948,6 +964,12 @@ const operationNotCanceled = ` const refreshToApplyRefresh = `[bold][yellow]Proceeding with 'terraform apply -refresh-only -auto-approve'.[reset]` +const unavailableTerraformVersion = ` +[reset][yellow]The local Terraform version (%s) is not available in Terraform Cloud, or your +organization does not have access to it. The new workspace will use %s. You can +change this later in the workspace settings.[reset] +` + var ( workspaceConfigurationHelp = fmt.Sprintf( `The 'workspaces' block configures how Terraform CLI maps its workspaces for this single From cb26cbba22737f7145559f5c36664818a9e4c9b6 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Mon, 25 Oct 2021 19:32:46 -0700 Subject: [PATCH 261/644] Add tests for cloud.StateMgr() when TFC lacks local tf version Alas, there's not a very good way to test the message we're supposed to print to the console in this situation; we just don't appear to have a mock terminal that the test can read from. But we can at least test that the function returns without erroring under the exact conditions where it was erroring before. Note that the behaviors of mc.Workspaces.Update and UpdateByID were already starting to drift, so I consolidated their actual attribute update logic into a helper function before they drifted much further. --- internal/cloud/backend_test.go | 52 +++++++++++++++++++++++++++++++ internal/cloud/tfe_client_mock.go | 44 ++++++++++++++++---------- 2 files changed, 80 insertions(+), 16 deletions(-) diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index d3b5d7c5f24c..0b0bb316a23a 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -305,6 +305,58 @@ func TestCloud_configVerifyMinimumTFEVersion(t *testing.T) { } } +func TestCloud_setUnavailableTerraformVersion(t *testing.T) { + // go-tfe returns an error IRL if you try to set a Terraform version that's + // not available in your TFC instance. To test this, tfe_client_mock errors if + // you try to set any Terraform version for this specific workspace name. + workspaceName := "unavailable-terraform-version" + + config := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("sometag"), + }, + ), + }), + }) + + b, bCleanup := testBackend(t, config) + defer bCleanup() + + // Make sure the workspace doesn't exist yet -- otherwise, we can't test what + // happens when a workspace gets created. This is why we can't use "name" in + // the backend config above, btw: if you do, testBackend() creates the default + // workspace before we get a chance to do anything. + _, err := b.client.Workspaces.Read(context.Background(), b.organization, workspaceName) + if err != tfe.ErrResourceNotFound { + t.Fatalf("the workspace we were about to try and create (%s/%s) already exists in the mocks somehow, so this test isn't trustworthy anymore", b.organization, workspaceName) + } + + _, err = b.StateMgr(workspaceName) + if err != nil { + t.Fatalf("expected no error from StateMgr, despite not being able to set remote Terraform version: %#v", err) + } + // Make sure the workspace was created: + workspace, err := b.client.Workspaces.Read(context.Background(), b.organization, workspaceName) + if err != nil { + t.Fatalf("b.StateMgr() didn't actually create the desired workspace") + } + // Make sure our mocks still error as expected, using the same update function b.StateMgr() would call: + _, err = b.client.Workspaces.UpdateByID( + context.Background(), + workspace.ID, + tfe.WorkspaceUpdateOptions{TerraformVersion: tfe.String("1.1.0")}, + ) + if err == nil { + t.Fatalf("the mocks aren't emulating a nonexistent remote Terraform version correctly, so this test isn't trustworthy anymore") + } +} + func TestCloud_setConfigurationFields(t *testing.T) { originalForceBackendEnv := os.Getenv("TF_FORCE_LOCAL_BACKEND") diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index 518602c3c847..8ba6883c3a82 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1159,6 +1159,10 @@ func (m *MockWorkspaces) List(ctx context.Context, organization string, options } func (m *MockWorkspaces) Create(ctx context.Context, organization string, options tfe.WorkspaceCreateOptions) (*tfe.Workspace, error) { + // for TestCloud_setUnavailableTerraformVersion + if *options.Name == "unavailable-terraform-version" && options.TerraformVersion != nil { + return nil, fmt.Errorf("requested Terraform version not available in this TFC instance") + } if strings.HasSuffix(*options.Name, "no-operations") { options.Operations = tfe.Bool(false) } else if options.Operations == nil { @@ -1234,17 +1238,9 @@ func (m *MockWorkspaces) Update(ctx context.Context, organization, workspace str return nil, tfe.ErrResourceNotFound } - if options.Operations != nil { - w.Operations = *options.Operations - } - if options.Name != nil { - w.Name = *options.Name - } - if options.TerraformVersion != nil { - w.TerraformVersion = *options.TerraformVersion - } - if options.WorkingDirectory != nil { - w.WorkingDirectory = *options.WorkingDirectory + err := updateMockWorkspaceAttributes(w, options) + if err != nil { + return nil, err } delete(m.workspaceNames, workspace) @@ -1259,6 +1255,26 @@ func (m *MockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, opt return nil, tfe.ErrResourceNotFound } + err := updateMockWorkspaceAttributes(w, options) + if err != nil { + return nil, err + } + + delete(m.workspaceNames, w.Name) + m.workspaceNames[w.Name] = w + + return w, nil +} + +func updateMockWorkspaceAttributes(w *tfe.Workspace, options tfe.WorkspaceUpdateOptions) error { + // for TestCloud_setUnavailableTerraformVersion + if w.Name == "unavailable-terraform-version" && options.TerraformVersion != nil { + return fmt.Errorf("requested Terraform version not available in this TFC instance") + } + + if options.Operations != nil { + w.Operations = *options.Operations + } if options.Name != nil { w.Name = *options.Name } @@ -1268,11 +1284,7 @@ func (m *MockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, opt if options.WorkingDirectory != nil { w.WorkingDirectory = *options.WorkingDirectory } - - delete(m.workspaceNames, w.Name) - m.workspaceNames[w.Name] = w - - return w, nil + return nil } func (m *MockWorkspaces) Delete(ctx context.Context, organization, workspace string) error { From 50997d9a32c40604b33bd56ca7abb2f62ffe1bb3 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 22 Oct 2021 15:08:22 -0500 Subject: [PATCH 262/644] Restore API version checking, with internal usage accounted for --- internal/cloud/backend.go | 39 +++++++++++++++++++++++--------- internal/cloud/backend_cli.go | 1 + internal/cloud/backend_test.go | 41 ++++++++++++++++++++++++++++++++-- internal/cloud/versioning.go | 12 ---------- 4 files changed, 68 insertions(+), 25 deletions(-) delete mode 100644 internal/cloud/versioning.go diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index f043378f680c..786309fedbd8 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -85,6 +85,8 @@ type Cloud struct { // version. This will also cause VerifyWorkspaceTerraformVersion to return // a warning diagnostic instead of an error. ignoreVersionConflict bool + + runningInAutomation bool } var _ backend.Backend = (*Cloud)(nil) @@ -296,15 +298,25 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { if parseErr != nil || currentAPIVersion.LessThan(desiredAPIVersion) { log.Printf("[TRACE] API version check failed; want: >= %s, got: %s", desiredAPIVersion.Original(), currentAPIVersion) - // FIXME: Skip version checking temporarily. - // diags = diags.Append(tfdiags.Sourceless( - // tfdiags.Error, - // "Unsupported Terraform Enterprise version", - // fmt.Sprintf( - // `The 'cloud' option requires Terraform Enterprise %s or later.`, - // apiToMinimumTFEVersion["2.5"], - // ), - // )) + if b.runningInAutomation { + // It should never be possible for this Terraform process to be mistakenly + // used internally within an unsupported Terraform Enterprise install - but + // just in case it happens, give an actionable error. + diags = diags.Append( + tfdiags.Sourceless( + tfdiags.Error, + "Unsupported Terraform Enterprise version", + cloudIntegrationUsedInUnsupportedTFE, + ), + ) + } else { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Unsupported Terraform Enterprise version", + `The 'cloud' option is not supported with this version of Terraform Enterprise.`, + ), + ) + } } // Configure a local backend for when we need to run operations locally. @@ -967,8 +979,13 @@ const refreshToApplyRefresh = `[bold][yellow]Proceeding with 'terraform apply -r const unavailableTerraformVersion = ` [reset][yellow]The local Terraform version (%s) is not available in Terraform Cloud, or your organization does not have access to it. The new workspace will use %s. You can -change this later in the workspace settings.[reset] -` +change this later in the workspace settings.[reset]` + +const cloudIntegrationUsedInUnsupportedTFE = ` +This version of Terraform Cloud/Enterprise does not support the state mechanism +attempting to be used by the platform. This should never happen. + +Please reach out to HashiCorp Support to resolve this issue.` var ( workspaceConfigurationHelp = fmt.Sprintf( diff --git a/internal/cloud/backend_cli.go b/internal/cloud/backend_cli.go index 8dac9bf3e143..cd054961633b 100644 --- a/internal/cloud/backend_cli.go +++ b/internal/cloud/backend_cli.go @@ -15,6 +15,7 @@ func (b *Cloud) CLIInit(opts *backend.CLIOpts) error { b.CLI = opts.CLI b.CLIColor = opts.CLIColor b.ContextOpts = opts.ContextOpts + b.runningInAutomation = opts.RunningInAutomation return nil } diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 0b0bb316a23a..87f7a91f2007 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -269,7 +269,6 @@ func TestCloud_config(t *testing.T) { } func TestCloud_configVerifyMinimumTFEVersion(t *testing.T) { - t.Skip("skipping, as TFE version checking has been temporarily disabled") config := cty.ObjectVal(map[string]cty.Value{ "hostname": cty.NullVal(cty.String), "organization": cty.StringVal("hashicorp"), @@ -299,7 +298,45 @@ func TestCloud_configVerifyMinimumTFEVersion(t *testing.T) { t.Fatalf("expected configure to error") } - expected := "The 'cloud' option requires Terraform Enterprise v202201-1 or later." + expected := `The 'cloud' option is not supported with this version of Terraform Enterprise.` + if !strings.Contains(confDiags.Err().Error(), expected) { + t.Fatalf("expected configure to error with %q, got %q", expected, confDiags.Err().Error()) + } +} + +func TestCloud_configVerifyMinimumTFEVersionInAutomation(t *testing.T) { + config := cty.ObjectVal(map[string]cty.Value{ + "hostname": cty.NullVal(cty.String), + "organization": cty.StringVal("hashicorp"), + "token": cty.NullVal(cty.String), + "workspaces": cty.ObjectVal(map[string]cty.Value{ + "name": cty.NullVal(cty.String), + "tags": cty.SetVal( + []cty.Value{ + cty.StringVal("billing"), + }, + ), + }), + }) + + handlers := map[string]func(http.ResponseWriter, *http.Request){ + "/api/v2/ping": func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "application/json") + w.Header().Set("TFP-API-Version", "2.4") + }, + } + s := testServerWithHandlers(handlers) + + b := New(testDisco(s)) + b.runningInAutomation = true + + confDiags := b.Configure(config) + if confDiags.Err() == nil { + t.Fatalf("expected configure to error") + } + + expected := `This version of Terraform Cloud/Enterprise does not support the state mechanism +attempting to be used by the platform. This should never happen.` if !strings.Contains(confDiags.Err().Error(), expected) { t.Fatalf("expected configure to error with %q, got %q", expected, confDiags.Err().Error()) } diff --git a/internal/cloud/versioning.go b/internal/cloud/versioning.go deleted file mode 100644 index 4b9ee52e1ec2..000000000000 --- a/internal/cloud/versioning.go +++ /dev/null @@ -1,12 +0,0 @@ -package cloud - -// This simple map exists to translate TFP-API-Version strings to the TFE release where it was -// introduced, to provide actionable feedback on features that may be unsupported by the TFE -// installation but present in this version of Terraform. -// -// The cloud package here, introduced in Terraform 1.1.0, requires a minimum of 2.5 (v202201-1) -// The TFP-API-Version header that this refers to was introduced in 2.3 (v202006-1), so an absent -// header can be considered < 2.3. -// var apiToMinimumTFEVersion = map[string]string{ -// "2.5": "v202201-1", -// } From fabd8eb0b63b1489e24c7be95636611e29fb8696 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 26 Oct 2021 17:02:28 -0700 Subject: [PATCH 263/644] Fix broken rename behavior in tfe_client_mock.go MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The delete + assign at the end of `Update` and `UpdateByID` are meant to handle renaming a workspace — (remove old name), (insert new name). However, `UpdateByID` was doing (remove new name), (insert new name) and leaving the old name in place. This commit changes it to match `Update` by grabbing the original name off the workspace object _before_ potentially renaming it. --- internal/cloud/tfe_client_mock.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index 8ba6883c3a82..ecc3b9addb7c 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1255,12 +1255,13 @@ func (m *MockWorkspaces) UpdateByID(ctx context.Context, workspaceID string, opt return nil, tfe.ErrResourceNotFound } + originalName := w.Name err := updateMockWorkspaceAttributes(w, options) if err != nil { return nil, err } - delete(m.workspaceNames, w.Name) + delete(m.workspaceNames, originalName) m.workspaceNames[w.Name] = w return w, nil From 2c0294c7e37fbe3896bb0fbae7b86292af721018 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 27 Oct 2021 17:05:36 -0500 Subject: [PATCH 264/644] Tweak configuration copy for TFC This aligns more with the existing copy for backends --- internal/command/meta_backend.go | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 552ee6300b20..8746c4366593 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -597,11 +597,11 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di log.Printf("[TRACE] Meta.Backend: moving from default local state only to %q backend", c.Type) if !opts.Init { if c.Type == "cloud" { - // NOTE: There may be an implicit local backend with state that is not visible to this block. + initReason := "Initial configuration of Terraform Cloud" diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Terraform Cloud has been configured but needs to be initialized.", - strings.TrimSpace(errBackendInitCloud), + "Terraform Cloud initialization required, please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), )) } else { initReason := fmt.Sprintf("Initial configuration of the requested backend %q", c.Type) @@ -649,8 +649,8 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di if c.Type == "cloud" { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Terraform Cloud has been configured but needs to be initialized.", - strings.TrimSpace(errBackendInitCloud), + "Terraform Cloud initialization required, please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), )) } else { diags = diags.Append(tfdiags.Sourceless( @@ -1328,17 +1328,12 @@ configuration or state have been made. ` const errBackendInitCloud = ` -Changes to the Terraform Cloud configuration block require reinitialization. -This allows Terraform to set up the new configuration, copy existing state, -etc. Learn more about Terraform Settings: -https://www.terraform.io/docs/language/settings/index.html +Reason: %s +Changes to the Terraform Cloud configuration block require reinitialization. +This allows Terraform to set up the new configuration, copy existing state, etc. Please run "terraform init" with either the "-reconfigure" or "-migrate-state" -flags. The "-reconfigure" option disregards any existing configuration, -preventing migration of any existing state. The "-migrate-state" option -will attempt to copy existing state to Terraform Cloud. Learn more about -using "terraform init": -https://www.terraform.io/docs/cli/commands/init.html#backend-initialization +flags to use the current configuration. If the change reason above is incorrect, please verify your configuration hasn't changed and try again. At this point, no changes to your existing From f5366468b4a201718d668834a54ff84eb38f643e Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 27 Oct 2021 16:27:12 -0500 Subject: [PATCH 265/644] Cloud Backend reference migrating away from TFC --- internal/command/meta_backend.go | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 8746c4366593..4167964a9470 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -779,7 +779,11 @@ func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.Local // Get the backend type for output backendType := s.Backend.Type - m.Ui.Output(fmt.Sprintf(strings.TrimSpace(outputBackendMigrateLocal), s.Backend.Type)) + if s.Backend.Type == "cloud" { + m.Ui.Output(strings.TrimSpace(outputBackendMigrateLocalFromCloud)) + } else { + m.Ui.Output(fmt.Sprintf(strings.TrimSpace(outputBackendMigrateLocal), s.Backend.Type)) + } // Grab a purely local backend to get the local state if it exists localB, diags := m.Backend(&BackendOpts{ForceLocal: true, Init: true}) @@ -1360,6 +1364,9 @@ Terraform detected that the backend type changed from %q to Terraform Cloud. const outputBackendMigrateLocal = ` Terraform has detected you're unconfiguring your previously set %q backend. ` +const outputBackendMigrateLocalFromCloud = ` +Terraform has detected you're unconfiguring Terraform Cloud. +` const outputBackendReconfigure = ` [reset][bold]Backend configuration changed![reset] From fc5863844c901ddaffbd6b1a4118662e9da910ce Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Wed, 27 Oct 2021 11:14:54 -0400 Subject: [PATCH 266/644] Cloud migration: ignore backend version check when empty worksapces --- internal/cloud/backend.go | 6 +- internal/cloud/e2e/helper_test.go | 7 ++ .../e2e/migrate_state_tfc_to_tfc_test.go | 76 ++++++++++++++++++- internal/command/meta_backend_migrate.go | 4 +- 4 files changed, 87 insertions(+), 6 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 786309fedbd8..1a5607f584a2 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -548,8 +548,10 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { // object to do a nicely formatted message, so we're just assuming the // issue was that the version wasn't available since that's probably what // happened. - versionUnavailable := fmt.Sprintf(unavailableTerraformVersion, tfversion.String(), workspace.TerraformVersion) - b.CLI.Output(b.Colorize().Color(versionUnavailable)) + if b.CLI != nil { + versionUnavailable := fmt.Sprintf(unavailableTerraformVersion, tfversion.String(), workspace.TerraformVersion) + b.CLI.Output(b.Colorize().Color(versionUnavailable)) + } } } diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 7af990f12054..0b0a6be5861d 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -47,6 +47,13 @@ func createOrganization(t *testing.T) (*tfe.Organization, func()) { t.Fatal(err) } + _, err = tfeClient.Admin.Organizations.Update(ctx, org.Name, tfe.AdminOrganizationUpdateOptions{ + AccessBetaTools: tfe.Bool(true), + }) + if err != nil { + t.Fatal(err) + } + return org, func() { if err := tfeClient.Organizations.Delete(ctx, org.Name); err != nil { t.Errorf("Error destroying organization! WARNING: Dangling resources\n"+ diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index ab5d908ed1b9..342ee2f3cbc2 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -5,6 +5,7 @@ package main import ( "context" + "fmt" "io/ioutil" "os" "testing" @@ -16,7 +17,7 @@ import ( func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { ctx := context.Background() - tfVersion := "1.1.0-tfc-integration" + tfVersion := "1.1.0-alpha-20211027-dev-e51508be" if !hasTerraformVersion(t, tfVersion) { t.Skip("Skipping test because TFC does not have current terraform version.") } @@ -162,6 +163,75 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { } }, }, + "migrating from name to tags without ignore-version flag": { + setup: func(t *testing.T) (string, func()) { + organization, cleanup := createOrganization(t) + return organization.Name, cleanup + }, + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "prod" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("prod"), + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "prod"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + // This is only here to ensure that the updated terraform version is + // present in the workspace, and it does not default to a lower + // version that does not support `cloud`. + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("new-workspace"), + TerraformVersion: tfe.String(tfVersion), + }) + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, + expectError: true, + userInput: []string{"new-workspace", "yes"}, + postInputOutput: []string{ + // this is a temporary measure till we resolve some of the + // version mismatching. + fmt.Sprintf(`Remote workspace Terraform version "%s" does not match local Terraform version`, tfVersion)}, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + // The migration never occured, so we have no workspaces with this tag. + if len(wsList.Items) != 0 { + t.Fatalf("Expected number of workspaces to be 0, but got %d", len(wsList.Items)) + } + }, + }, } for name, tc := range cases { @@ -225,7 +295,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { } err = cmd.Wait() - if err != nil { + if err != nil && !tfCmd.expectError { t.Fatal(err.Error()) } } @@ -239,7 +309,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { ctx := context.Background() - tfVersion := "1.1.0-tfc-integration" + tfVersion := "1.1.0-alpha-20211027-dev-e51508be" if !hasTerraformVersion(t, tfVersion) { t.Skip("Skipping test because TFC does not have current terraform version.") } diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 6cfb69be139b..a4c0578ccaff 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -86,7 +86,9 @@ func (m *Meta) backendMigrateState(opts *backendMigrateOpts) error { } // If there are no specified destination workspaces, perform a remote // backend version check with the default workspace. - if len(destinationWorkspaces) == 0 { + // Ensure that we are not dealing with Terraform Cloud migrations, as it + // does not support the default name. + if len(destinationWorkspaces) == 0 && !destinationTFC { diags := m.remoteVersionCheck(opts.Destination, backend.DefaultStateName) if diags.HasErrors() { return diags.Err() From e364ef2905579ff8e71e8a03ff89736e68e887c6 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 28 Oct 2021 00:35:58 -0500 Subject: [PATCH 267/644] cloud/e2e: Disable cost estimation E2E tests including cost estimation should indeed be added, but the default case should be disabled; lots of cycles lost to pointless cost estimates on null and random resources. --- internal/cloud/e2e/helper_test.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 0b0a6be5861d..c8cccc0f1bb3 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -40,8 +40,9 @@ type testCases map[string]struct { func createOrganization(t *testing.T) (*tfe.Organization, func()) { ctx := context.Background() org, err := tfeClient.Organizations.Create(ctx, tfe.OrganizationCreateOptions{ - Name: tfe.String("tst-" + randomString(t)), - Email: tfe.String(fmt.Sprintf("%s@tfe.local", randomString(t))), + Name: tfe.String("tst-" + randomString(t)), + Email: tfe.String(fmt.Sprintf("%s@tfe.local", randomString(t))), + CostEstimationEnabled: tfe.Bool(false), }) if err != nil { t.Fatal(err) From f881c2d7940e12d61cf270fa4f0b8e160c6962df Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 27 Oct 2021 18:07:12 -0500 Subject: [PATCH 268/644] cloud: Skip E2E tests without an exact version --- internal/cloud/e2e/apply_auto_approve_test.go | 15 ++++---- .../e2e/backend_apply_before_init_test.go | 2 ++ internal/cloud/e2e/helper_test.go | 8 +++-- internal/cloud/e2e/main_test.go | 8 ++++- .../e2e/migrate_state_multi_to_tfc_test.go | 4 +++ ...igrate_state_remote_backend_to_tfc_test.go | 10 ++++++ .../e2e/migrate_state_single_to_tfc_test.go | 2 ++ .../e2e/migrate_state_tfc_to_tfc_test.go | 34 ++++++++----------- internal/cloud/e2e/run_variables_test.go | 2 ++ 9 files changed, 55 insertions(+), 30 deletions(-) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 626f4c272209..535be368a8d5 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -13,14 +13,13 @@ import ( expect "github.com/Netflix/go-expect" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/e2e" + tfversion "github.com/hashicorp/terraform/version" ) func Test_terraform_apply_autoApprove(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() - tfVersion := "1.1.0-tfc-integration" - if !hasTerraformVersion(t, tfVersion) { - t.Skip("Skipping test because TFC does not have current terraform version.") - } cases := map[string]struct { operations []operationSets @@ -33,7 +32,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { wsName := "app" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String(wsName), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), AutoApply: tfe.Bool(false), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) @@ -73,7 +72,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { wsName := "app" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String(wsName), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), AutoApply: tfe.Bool(true), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) @@ -113,7 +112,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { wsName := "app" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String(wsName), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), AutoApply: tfe.Bool(false), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) @@ -151,7 +150,7 @@ func Test_terraform_apply_autoApprove(t *testing.T) { wsName := "app" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String(wsName), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), AutoApply: tfe.Bool(true), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index 86f2f515cb71..213a48f0fadc 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -14,6 +14,8 @@ import ( ) func Test_backend_apply_before_init(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + cases := map[string]struct { operations []operationSets }{ diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index c8cccc0f1bb3..0f4480ddfc31 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -12,6 +12,7 @@ import ( tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/go-uuid" + tfversion "github.com/hashicorp/terraform/version" ) const ( @@ -193,7 +194,8 @@ func writeMainTF(t *testing.T, block string, dir string) { } // Ensure that TFC/E has a particular terraform version. -func hasTerraformVersion(t *testing.T, version string) bool { +func skipWithoutRemoteTerraformVersion(t *testing.T) { + version := tfversion.String() opts := tfe.AdminTerraformVersionsListOptions{ ListOptions: tfe.ListOptions{ PageNumber: 1, @@ -226,5 +228,7 @@ findTfVersion: opts.PageNumber = tfVersionList.NextPage } - return hasVersion + if !hasVersion { + t.Skip(fmt.Sprintf("Skipping test because TFC/E does not have current Terraform version to test with (%s)", version)) + } } diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index c1315132049f..48e40b81ff8c 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -13,6 +13,7 @@ import ( "testing" tfe "github.com/hashicorp/go-tfe" + tfversion "github.com/hashicorp/terraform/version" ) var terraformBin string @@ -97,7 +98,12 @@ func setupBinary() func() { log.Fatal(err) } - cmd := exec.Command("go", "build", "-o", tmpTerraformBinaryDir) + cmd := exec.Command( + "go", + "build", + "-o", tmpTerraformBinaryDir, + "-ldflags", fmt.Sprintf("-X \"github.com/hashicorp/terraform/version.Prerelease=%s\"", tfversion.Prerelease), + ) err = cmd.Run() if err != nil { log.Fatal(err) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index c9b8370190b0..6fda558f3f84 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -15,6 +15,8 @@ import ( ) func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { @@ -242,6 +244,8 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index e6402e87680a..c9fe01976623 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -15,6 +15,8 @@ import ( ) func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { operations []operationSets @@ -197,6 +199,8 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { } func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { operations []operationSets @@ -334,6 +338,8 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { } func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { operations []operationSets @@ -477,6 +483,8 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { } func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { operations []operationSets @@ -695,6 +703,8 @@ func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { } func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { operations []operationSets diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index d8423f4283db..c060ee63e1b4 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -15,6 +15,8 @@ import ( ) func Test_migrate_single_to_tfc(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() cases := map[string]struct { diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 342ee2f3cbc2..3c48e6f3d7c7 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -13,14 +13,12 @@ import ( expect "github.com/Netflix/go-expect" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/e2e" + tfversion "github.com/hashicorp/terraform/version" ) func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) ctx := context.Background() - tfVersion := "1.1.0-alpha-20211027-dev-e51508be" - if !hasTerraformVersion(t, tfVersion) { - t.Skip("Skipping test because TFC does not have current terraform version.") - } cases := map[string]struct { setup func(t *testing.T) (string, func()) @@ -42,7 +40,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { // terraform version of this current branch. _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("prod"), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) writeMainTF(t, tfBlock, dir) @@ -69,7 +67,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { wsName := "dev" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String(wsName), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) writeMainTF(t, tfBlock, dir) @@ -110,7 +108,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { wsName := "prod" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("prod"), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) writeMainTF(t, tfBlock, dir) @@ -174,7 +172,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { wsName := "prod" _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("prod"), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendName(orgName, wsName) writeMainTF(t, tfBlock, dir) @@ -200,7 +198,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { // version that does not support `cloud`. _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("new-workspace"), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendTags(orgName, tag) writeMainTF(t, tfBlock, dir) @@ -214,7 +212,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { postInputOutput: []string{ // this is a temporary measure till we resolve some of the // version mismatching. - fmt.Sprintf(`Remote workspace Terraform version "%s" does not match local Terraform version`, tfVersion)}, + fmt.Sprintf(`Remote workspace Terraform version "%s" does not match local Terraform version`, tfversion.String())}, }, }, }, @@ -308,11 +306,9 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { } func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() - tfVersion := "1.1.0-alpha-20211027-dev-e51508be" - if !hasTerraformVersion(t, tfVersion) { - t.Skip("Skipping test because TFC does not have current terraform version.") - } cases := map[string]struct { setup func(t *testing.T) (string, func()) @@ -331,12 +327,12 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("app-prod"), Tags: []*tfe.Tag{{Name: tag}}, - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("app-staging"), Tags: []*tfe.Tag{{Name: tag}}, - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendTags(orgName, tag) writeMainTF(t, tfBlock, dir) @@ -378,7 +374,7 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { // using the right version for post init operations. _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String(name), - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendName(orgName, name) writeMainTF(t, tfBlock, dir) @@ -425,12 +421,12 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("app-prod"), Tags: []*tfe.Tag{{Name: tag}}, - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ Name: tfe.String("app-staging"), Tags: []*tfe.Tag{{Name: tag}}, - TerraformVersion: tfe.String(tfVersion), + TerraformVersion: tfe.String(tfversion.String()), }) tfBlock := terraformConfigCloudBackendTags(orgName, tag) writeMainTF(t, tfBlock, dir) diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index f5a86c650af7..c92f22e9b44f 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -46,6 +46,8 @@ output "test_env" { } func Test_cloud_run_variables(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + cases := testCases{ "run variables from CLI arg": { operations: []operationSets{ From 652a68715f4b78f7d157fc5ec58381dbaa2e9e11 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 28 Oct 2021 01:33:18 -0500 Subject: [PATCH 269/644] cloud/e2e: Misc test fixes --- internal/cloud/e2e/backend_apply_before_init_test.go | 4 ++-- internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go | 5 ----- 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index 213a48f0fadc..702b79bbc3e5 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -30,7 +30,7 @@ func Test_backend_apply_before_init(t *testing.T) { commands: []tfCommand{ { command: []string{"apply"}, - expectedCmdOutput: `Terraform Cloud has been configured but needs to be initialized`, + expectedCmdOutput: `Terraform Cloud initialization required, please run "terraform init"`, expectError: true, }, }, @@ -66,7 +66,7 @@ func Test_backend_apply_before_init(t *testing.T) { commands: []tfCommand{ { command: []string{"apply"}, - expectedCmdOutput: `Terraform Cloud has been configured but needs to be initialized`, + expectedCmdOutput: `Terraform Cloud initialization required, please run "terraform init"`, expectError: true, }, }, diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 3c48e6f3d7c7..6d086de5bbf7 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -5,7 +5,6 @@ package main import ( "context" - "fmt" "io/ioutil" "os" "testing" @@ -209,10 +208,6 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, expectError: true, userInput: []string{"new-workspace", "yes"}, - postInputOutput: []string{ - // this is a temporary measure till we resolve some of the - // version mismatching. - fmt.Sprintf(`Remote workspace Terraform version "%s" does not match local Terraform version`, tfversion.String())}, }, }, }, From 3d23a8e06299f49b9bde340e991446112a453e7c Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 27 Oct 2021 23:52:40 -0500 Subject: [PATCH 270/644] cloud: Fix version check regression When the 'select the exact version if possible' behavior was added, the version check below it was never updated to take the newly updated version in to account, resulting in a failed version check even as the remote workspace updated to the correct version necessary. --- internal/cloud/backend.go | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 1a5607f584a2..caf6ffe3087d 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -504,6 +504,8 @@ func (b *Cloud) DeleteWorkspace(name string) error { // StateMgr implements backend.Enhanced. func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { + var remoteTFVersion string + if name == backend.DefaultStateName { return nil, backend.ErrDefaultWorkspaceNotSupported } @@ -516,6 +518,9 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { if err != nil && err != tfe.ErrResourceNotFound { return nil, fmt.Errorf("Failed to retrieve workspace %s: %v", name, err) } + if workspace != nil { + remoteTFVersion = workspace.TerraformVersion + } if err == tfe.ErrResourceNotFound { // Create a workspace @@ -530,11 +535,14 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { } options.Tags = tags + log.Printf("[TRACE] cloud: Creating Terraform Cloud workspace %s/%s", b.organization, name) workspace, err = b.client.Workspaces.Create(context.Background(), b.organization, options) if err != nil { return nil, fmt.Errorf("Error creating workspace %s: %v", name, err) } + remoteTFVersion = workspace.TerraformVersion + // Attempt to set the new workspace to use this version of Terraform. This // can fail if there's no enabled tool_version whose name matches our // version string, but that's expected sometimes -- just warn and continue. @@ -542,12 +550,15 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { TerraformVersion: tfe.String(tfversion.String()), } _, err := b.client.Workspaces.UpdateByID(context.Background(), workspace.ID, versionOptions) - if err != nil { + if err == nil { + remoteTFVersion = tfversion.String() + } else { // TODO: Ideally we could rely on the client to tell us what the actual // problem was, but we currently can't get enough context from the error // object to do a nicely formatted message, so we're just assuming the // issue was that the version wasn't available since that's probably what // happened. + log.Printf("[TRACE] cloud: Attempted to select version %s for TFC workspace; unavailable, so %s will be used instead.", tfversion.String(), workspace.TerraformVersion) if b.CLI != nil { versionUnavailable := fmt.Sprintf(unavailableTerraformVersion, tfversion.String(), workspace.TerraformVersion) b.CLI.Output(b.Colorize().Color(versionUnavailable)) @@ -561,11 +572,10 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { // accidentally upgrade state with a new code path, and the version check // logic is coarser and simpler. if !b.ignoreVersionConflict { - wsv := workspace.TerraformVersion // Explicitly ignore the pseudo-version "latest" here, as it will cause // plan and apply to always fail. - if wsv != tfversion.String() && wsv != "latest" { - return nil, fmt.Errorf("Remote workspace Terraform version %q does not match local Terraform version %q", workspace.TerraformVersion, tfversion.String()) + if remoteTFVersion != tfversion.String() && remoteTFVersion != "latest" { + return nil, fmt.Errorf("Remote workspace Terraform version %q does not match local Terraform version %q", remoteTFVersion, tfversion.String()) } } From 6d9c919f55227a05264942b18a717cedbb65b8f2 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Wed, 27 Oct 2021 21:23:19 -0600 Subject: [PATCH 271/644] adds X-Terraform-Integration header This can help differentiate cloud integration API requests from normal remote backend requests --- internal/cloud/backend.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index caf6ffe3087d..7ae10b8cb06d 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -36,6 +36,8 @@ const ( defaultHostname = "app.terraform.io" defaultParallelism = 10 tfeServiceID = "tfe.v2" + headerSourceKey = "X-Terraform-Integration" + headerSourceValue = "cloud" ) // Cloud is an implementation of EnhancedBackend in service of the Terraform Cloud/Enterprise @@ -254,6 +256,7 @@ func (b *Cloud) Configure(obj cty.Value) tfdiags.Diagnostics { // Set the version header to the current version. cfg.Headers.Set(tfversion.Header, tfversion.Version) + cfg.Headers.Set(headerSourceKey, headerSourceValue) // Create the TFC/E API client. b.client, err = tfe.NewClient(cfg) From 14260a5b4cd293d4a0ffae947ebb13c7173803cf Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 28 Oct 2021 10:37:06 -0500 Subject: [PATCH 272/644] Adjust default workspace naming prompt The previous version is a little overdramatic and somewhat accusatory. Just lay it out how it is: TFC needs workspaces to be named. --- internal/cloud/e2e/migrate_state_multi_to_tfc_test.go | 2 +- .../cloud/e2e/migrate_state_remote_backend_to_tfc_test.go | 4 ++-- internal/cloud/e2e/migrate_state_single_to_tfc_test.go | 2 +- internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go | 4 ++-- internal/command/meta_backend_migrate.go | 5 ++--- 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 6fda558f3f84..a0a6b74309cd 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -307,7 +307,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"dev", "1", "app-*", "1"}, postInputOutput: []string{ `Would you like to rename your workspaces?`, diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index c9fe01976623..7f0a6fbc8eac 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -379,7 +379,7 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to Terraform Cloud?`, @@ -741,7 +741,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to Terraform Cloud?`, diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index c060ee63e1b4..baf9126f4d87 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -103,7 +103,7 @@ func Test_migrate_single_to_tfc(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `Terraform Cloud configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"new-workspace", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to Terraform Cloud?`, diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 6d086de5bbf7..fff9b54161c2 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -134,7 +134,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"new-workspace", "yes"}, postInputOutput: []string{ `Do you want to copy existing state to Terraform Cloud?`, @@ -205,7 +205,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `The Terraform Cloud configuration only allows named workspaces!`, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, expectError: true, userInput: []string{"new-workspace", "yes"}, }, diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index a4c0578ccaff..449c8303fed3 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -694,8 +694,7 @@ func (m *Meta) promptNewWorkspaceName(destinationType string) (string, error) { message := fmt.Sprintf("[reset][bold][yellow]The %q backend configuration only allows "+ "named workspaces![reset]", destinationType) if destinationType == "cloud" { - message = fmt.Sprintf("[reset][bold][yellow]The Terraform Cloud configuration only allows " + - "named workspaces![reset]") + message = `[reset][bold][yellow]Terraform Cloud requires all workspaces to be given an explicit name.[reset]` } name, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "new-state-name", @@ -896,7 +895,7 @@ If you answer "yes", Terraform will migrate all states. If you answer const inputBackendNewWorkspaceName = ` Please provide a new workspace name (e.g. dev, test) that will be used -to migrate the existing default workspace. +to migrate the existing default workspace. ` const inputBackendSelectWorkspace = ` From 6dc1fed6d548a5bb34b755a35e3e6be9b89b8454 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 28 Oct 2021 15:27:39 -0500 Subject: [PATCH 273/644] Clarify legacy Ui comments --- internal/command/apply.go | 5 +++-- internal/command/plan.go | 5 +++-- internal/command/refresh.go | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/internal/command/apply.go b/internal/command/apply.go index 9d481c06b8e1..7405bddf0013 100644 --- a/internal/command/apply.go +++ b/internal/command/apply.go @@ -29,8 +29,9 @@ func (c *ApplyCommand) Run(rawArgs []string) int { common, rawArgs := arguments.ParseView(rawArgs) c.View.Configure(common) - // Propagate -no-color for the remote backend's legacy use of Ui. This - // should be removed when the remote backend is migrated to views. + // Propagate -no-color for legacy use of Ui. The remote backend and + // cloud package use this; it should be removed when/if they are + // migrated to views. c.Meta.color = !common.NoColor c.Meta.Color = c.Meta.color diff --git a/internal/command/plan.go b/internal/command/plan.go index ec90d8371b38..a5ff74ac1158 100644 --- a/internal/command/plan.go +++ b/internal/command/plan.go @@ -21,8 +21,9 @@ func (c *PlanCommand) Run(rawArgs []string) int { common, rawArgs := arguments.ParseView(rawArgs) c.View.Configure(common) - // Propagate -no-color for the remote backend's legacy use of Ui. This - // should be removed when the remote backend is migrated to views. + // Propagate -no-color for legacy use of Ui. The remote backend and + // cloud package use this; it should be removed when/if they are + // migrated to views. c.Meta.color = !common.NoColor c.Meta.Color = c.Meta.color diff --git a/internal/command/refresh.go b/internal/command/refresh.go index c7c041eb72b5..18891b414ebd 100644 --- a/internal/command/refresh.go +++ b/internal/command/refresh.go @@ -23,8 +23,9 @@ func (c *RefreshCommand) Run(rawArgs []string) int { common, rawArgs := arguments.ParseView(rawArgs) c.View.Configure(common) - // Propagate -no-color for the remote backend's legacy use of Ui. This - // should be removed when the remote backend is migrated to views. + // Propagate -no-color for legacy use of Ui. The remote backend and + // cloud package use this; it should be removed when/if they are + // migrated to views. c.Meta.color = !common.NoColor c.Meta.Color = c.Meta.color From 369264865e7512b6c27940d3d9d42733f954a9ad Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 28 Oct 2021 20:16:26 -0500 Subject: [PATCH 274/644] internal/plugin[6]: Add generated mocks --- internal/plugin/grpc_provider_test.go | 3 +- internal/plugin/grpc_provisioner_test.go | 3 +- internal/plugin/mock_proto/mock.go | 155 ++++++++++++----------- internal/plugin6/grpc_provider_test.go | 3 +- internal/plugin6/mock_proto/mock.go | 59 ++++----- 5 files changed, 114 insertions(+), 109 deletions(-) diff --git a/internal/plugin/grpc_provider_test.go b/internal/plugin/grpc_provider_test.go index a78c6d318b55..fc6216cc0606 100644 --- a/internal/plugin/grpc_provider_test.go +++ b/internal/plugin/grpc_provider_test.go @@ -228,7 +228,8 @@ func TestGRPCProvider_Configure(t *testing.T) { } func TestGRPCProvider_Stop(t *testing.T) { - client := mockProviderClient(t) + ctrl := gomock.NewController(t) + client := mockproto.NewMockProviderClient(ctrl) p := &GRPCProvider{ client: client, } diff --git a/internal/plugin/grpc_provisioner_test.go b/internal/plugin/grpc_provisioner_test.go index ab775cdbdfc5..848c9460fa43 100644 --- a/internal/plugin/grpc_provisioner_test.go +++ b/internal/plugin/grpc_provisioner_test.go @@ -129,7 +129,8 @@ func (r *provisionRecorder) Output(s string) { } func TestGRPCProvisioner_Stop(t *testing.T) { - client := mockProvisionerClient(t) + ctrl := gomock.NewController(t) + client := mockproto.NewMockProvisionerClient(ctrl) p := &GRPCProvisioner{ client: client, } diff --git a/internal/plugin/mock_proto/mock.go b/internal/plugin/mock_proto/mock.go index 5f4a69d729a9..054fe1cd821a 100644 --- a/internal/plugin/mock_proto/mock.go +++ b/internal/plugin/mock_proto/mock.go @@ -6,37 +6,38 @@ package mock_tfplugin5 import ( context "context" + reflect "reflect" + gomock "github.com/golang/mock/gomock" tfplugin5 "github.com/hashicorp/terraform/internal/tfplugin5" grpc "google.golang.org/grpc" metadata "google.golang.org/grpc/metadata" - reflect "reflect" ) -// MockProviderClient is a mock of ProviderClient interface +// MockProviderClient is a mock of ProviderClient interface. type MockProviderClient struct { ctrl *gomock.Controller recorder *MockProviderClientMockRecorder } -// MockProviderClientMockRecorder is the mock recorder for MockProviderClient +// MockProviderClientMockRecorder is the mock recorder for MockProviderClient. type MockProviderClientMockRecorder struct { mock *MockProviderClient } -// NewMockProviderClient creates a new mock instance +// NewMockProviderClient creates a new mock instance. func NewMockProviderClient(ctrl *gomock.Controller) *MockProviderClient { mock := &MockProviderClient{ctrl: ctrl} mock.recorder = &MockProviderClientMockRecorder{mock} return mock } -// EXPECT returns an object that allows the caller to indicate expected use +// EXPECT returns an object that allows the caller to indicate expected use. func (m *MockProviderClient) EXPECT() *MockProviderClientMockRecorder { return m.recorder } -// ApplyResourceChange mocks base method +// ApplyResourceChange mocks base method. func (m *MockProviderClient) ApplyResourceChange(arg0 context.Context, arg1 *tfplugin5.ApplyResourceChange_Request, arg2 ...grpc.CallOption) (*tfplugin5.ApplyResourceChange_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -49,14 +50,14 @@ func (m *MockProviderClient) ApplyResourceChange(arg0 context.Context, arg1 *tfp return ret0, ret1 } -// ApplyResourceChange indicates an expected call of ApplyResourceChange +// ApplyResourceChange indicates an expected call of ApplyResourceChange. func (mr *MockProviderClientMockRecorder) ApplyResourceChange(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ApplyResourceChange", reflect.TypeOf((*MockProviderClient)(nil).ApplyResourceChange), varargs...) } -// Configure mocks base method +// Configure mocks base method. func (m *MockProviderClient) Configure(arg0 context.Context, arg1 *tfplugin5.Configure_Request, arg2 ...grpc.CallOption) (*tfplugin5.Configure_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -69,14 +70,14 @@ func (m *MockProviderClient) Configure(arg0 context.Context, arg1 *tfplugin5.Con return ret0, ret1 } -// Configure indicates an expected call of Configure +// Configure indicates an expected call of Configure. func (mr *MockProviderClientMockRecorder) Configure(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Configure", reflect.TypeOf((*MockProviderClient)(nil).Configure), varargs...) } -// GetSchema mocks base method +// GetSchema mocks base method. func (m *MockProviderClient) GetSchema(arg0 context.Context, arg1 *tfplugin5.GetProviderSchema_Request, arg2 ...grpc.CallOption) (*tfplugin5.GetProviderSchema_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -89,14 +90,14 @@ func (m *MockProviderClient) GetSchema(arg0 context.Context, arg1 *tfplugin5.Get return ret0, ret1 } -// GetSchema indicates an expected call of GetSchema +// GetSchema indicates an expected call of GetSchema. func (mr *MockProviderClientMockRecorder) GetSchema(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetSchema", reflect.TypeOf((*MockProviderClient)(nil).GetSchema), varargs...) } -// ImportResourceState mocks base method +// ImportResourceState mocks base method. func (m *MockProviderClient) ImportResourceState(arg0 context.Context, arg1 *tfplugin5.ImportResourceState_Request, arg2 ...grpc.CallOption) (*tfplugin5.ImportResourceState_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -109,14 +110,14 @@ func (m *MockProviderClient) ImportResourceState(arg0 context.Context, arg1 *tfp return ret0, ret1 } -// ImportResourceState indicates an expected call of ImportResourceState +// ImportResourceState indicates an expected call of ImportResourceState. func (mr *MockProviderClientMockRecorder) ImportResourceState(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ImportResourceState", reflect.TypeOf((*MockProviderClient)(nil).ImportResourceState), varargs...) } -// PlanResourceChange mocks base method +// PlanResourceChange mocks base method. func (m *MockProviderClient) PlanResourceChange(arg0 context.Context, arg1 *tfplugin5.PlanResourceChange_Request, arg2 ...grpc.CallOption) (*tfplugin5.PlanResourceChange_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -129,14 +130,14 @@ func (m *MockProviderClient) PlanResourceChange(arg0 context.Context, arg1 *tfpl return ret0, ret1 } -// PlanResourceChange indicates an expected call of PlanResourceChange +// PlanResourceChange indicates an expected call of PlanResourceChange. func (mr *MockProviderClientMockRecorder) PlanResourceChange(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "PlanResourceChange", reflect.TypeOf((*MockProviderClient)(nil).PlanResourceChange), varargs...) } -// PrepareProviderConfig mocks base method +// PrepareProviderConfig mocks base method. func (m *MockProviderClient) PrepareProviderConfig(arg0 context.Context, arg1 *tfplugin5.PrepareProviderConfig_Request, arg2 ...grpc.CallOption) (*tfplugin5.PrepareProviderConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -149,14 +150,14 @@ func (m *MockProviderClient) PrepareProviderConfig(arg0 context.Context, arg1 *t return ret0, ret1 } -// PrepareProviderConfig indicates an expected call of PrepareProviderConfig +// PrepareProviderConfig indicates an expected call of PrepareProviderConfig. func (mr *MockProviderClientMockRecorder) PrepareProviderConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "PrepareProviderConfig", reflect.TypeOf((*MockProviderClient)(nil).PrepareProviderConfig), varargs...) } -// ReadDataSource mocks base method +// ReadDataSource mocks base method. func (m *MockProviderClient) ReadDataSource(arg0 context.Context, arg1 *tfplugin5.ReadDataSource_Request, arg2 ...grpc.CallOption) (*tfplugin5.ReadDataSource_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -169,14 +170,14 @@ func (m *MockProviderClient) ReadDataSource(arg0 context.Context, arg1 *tfplugin return ret0, ret1 } -// ReadDataSource indicates an expected call of ReadDataSource +// ReadDataSource indicates an expected call of ReadDataSource. func (mr *MockProviderClientMockRecorder) ReadDataSource(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReadDataSource", reflect.TypeOf((*MockProviderClient)(nil).ReadDataSource), varargs...) } -// ReadResource mocks base method +// ReadResource mocks base method. func (m *MockProviderClient) ReadResource(arg0 context.Context, arg1 *tfplugin5.ReadResource_Request, arg2 ...grpc.CallOption) (*tfplugin5.ReadResource_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -189,14 +190,14 @@ func (m *MockProviderClient) ReadResource(arg0 context.Context, arg1 *tfplugin5. return ret0, ret1 } -// ReadResource indicates an expected call of ReadResource +// ReadResource indicates an expected call of ReadResource. func (mr *MockProviderClientMockRecorder) ReadResource(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReadResource", reflect.TypeOf((*MockProviderClient)(nil).ReadResource), varargs...) } -// Stop mocks base method +// Stop mocks base method. func (m *MockProviderClient) Stop(arg0 context.Context, arg1 *tfplugin5.Stop_Request, arg2 ...grpc.CallOption) (*tfplugin5.Stop_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -209,14 +210,14 @@ func (m *MockProviderClient) Stop(arg0 context.Context, arg1 *tfplugin5.Stop_Req return ret0, ret1 } -// Stop indicates an expected call of Stop +// Stop indicates an expected call of Stop. func (mr *MockProviderClientMockRecorder) Stop(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Stop", reflect.TypeOf((*MockProviderClient)(nil).Stop), varargs...) } -// UpgradeResourceState mocks base method +// UpgradeResourceState mocks base method. func (m *MockProviderClient) UpgradeResourceState(arg0 context.Context, arg1 *tfplugin5.UpgradeResourceState_Request, arg2 ...grpc.CallOption) (*tfplugin5.UpgradeResourceState_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -229,14 +230,14 @@ func (m *MockProviderClient) UpgradeResourceState(arg0 context.Context, arg1 *tf return ret0, ret1 } -// UpgradeResourceState indicates an expected call of UpgradeResourceState +// UpgradeResourceState indicates an expected call of UpgradeResourceState. func (mr *MockProviderClientMockRecorder) UpgradeResourceState(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpgradeResourceState", reflect.TypeOf((*MockProviderClient)(nil).UpgradeResourceState), varargs...) } -// ValidateDataSourceConfig mocks base method +// ValidateDataSourceConfig mocks base method. func (m *MockProviderClient) ValidateDataSourceConfig(arg0 context.Context, arg1 *tfplugin5.ValidateDataSourceConfig_Request, arg2 ...grpc.CallOption) (*tfplugin5.ValidateDataSourceConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -249,14 +250,14 @@ func (m *MockProviderClient) ValidateDataSourceConfig(arg0 context.Context, arg1 return ret0, ret1 } -// ValidateDataSourceConfig indicates an expected call of ValidateDataSourceConfig +// ValidateDataSourceConfig indicates an expected call of ValidateDataSourceConfig. func (mr *MockProviderClientMockRecorder) ValidateDataSourceConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ValidateDataSourceConfig", reflect.TypeOf((*MockProviderClient)(nil).ValidateDataSourceConfig), varargs...) } -// ValidateResourceTypeConfig mocks base method +// ValidateResourceTypeConfig mocks base method. func (m *MockProviderClient) ValidateResourceTypeConfig(arg0 context.Context, arg1 *tfplugin5.ValidateResourceTypeConfig_Request, arg2 ...grpc.CallOption) (*tfplugin5.ValidateResourceTypeConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -269,37 +270,37 @@ func (m *MockProviderClient) ValidateResourceTypeConfig(arg0 context.Context, ar return ret0, ret1 } -// ValidateResourceTypeConfig indicates an expected call of ValidateResourceTypeConfig +// ValidateResourceTypeConfig indicates an expected call of ValidateResourceTypeConfig. func (mr *MockProviderClientMockRecorder) ValidateResourceTypeConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ValidateResourceTypeConfig", reflect.TypeOf((*MockProviderClient)(nil).ValidateResourceTypeConfig), varargs...) } -// MockProvisionerClient is a mock of ProvisionerClient interface +// MockProvisionerClient is a mock of ProvisionerClient interface. type MockProvisionerClient struct { ctrl *gomock.Controller recorder *MockProvisionerClientMockRecorder } -// MockProvisionerClientMockRecorder is the mock recorder for MockProvisionerClient +// MockProvisionerClientMockRecorder is the mock recorder for MockProvisionerClient. type MockProvisionerClientMockRecorder struct { mock *MockProvisionerClient } -// NewMockProvisionerClient creates a new mock instance +// NewMockProvisionerClient creates a new mock instance. func NewMockProvisionerClient(ctrl *gomock.Controller) *MockProvisionerClient { mock := &MockProvisionerClient{ctrl: ctrl} mock.recorder = &MockProvisionerClientMockRecorder{mock} return mock } -// EXPECT returns an object that allows the caller to indicate expected use +// EXPECT returns an object that allows the caller to indicate expected use. func (m *MockProvisionerClient) EXPECT() *MockProvisionerClientMockRecorder { return m.recorder } -// GetSchema mocks base method +// GetSchema mocks base method. func (m *MockProvisionerClient) GetSchema(arg0 context.Context, arg1 *tfplugin5.GetProvisionerSchema_Request, arg2 ...grpc.CallOption) (*tfplugin5.GetProvisionerSchema_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -312,14 +313,14 @@ func (m *MockProvisionerClient) GetSchema(arg0 context.Context, arg1 *tfplugin5. return ret0, ret1 } -// GetSchema indicates an expected call of GetSchema +// GetSchema indicates an expected call of GetSchema. func (mr *MockProvisionerClientMockRecorder) GetSchema(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetSchema", reflect.TypeOf((*MockProvisionerClient)(nil).GetSchema), varargs...) } -// ProvisionResource mocks base method +// ProvisionResource mocks base method. func (m *MockProvisionerClient) ProvisionResource(arg0 context.Context, arg1 *tfplugin5.ProvisionResource_Request, arg2 ...grpc.CallOption) (tfplugin5.Provisioner_ProvisionResourceClient, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -332,14 +333,14 @@ func (m *MockProvisionerClient) ProvisionResource(arg0 context.Context, arg1 *tf return ret0, ret1 } -// ProvisionResource indicates an expected call of ProvisionResource +// ProvisionResource indicates an expected call of ProvisionResource. func (mr *MockProvisionerClientMockRecorder) ProvisionResource(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ProvisionResource", reflect.TypeOf((*MockProvisionerClient)(nil).ProvisionResource), varargs...) } -// Stop mocks base method +// Stop mocks base method. func (m *MockProvisionerClient) Stop(arg0 context.Context, arg1 *tfplugin5.Stop_Request, arg2 ...grpc.CallOption) (*tfplugin5.Stop_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -352,14 +353,14 @@ func (m *MockProvisionerClient) Stop(arg0 context.Context, arg1 *tfplugin5.Stop_ return ret0, ret1 } -// Stop indicates an expected call of Stop +// Stop indicates an expected call of Stop. func (mr *MockProvisionerClientMockRecorder) Stop(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Stop", reflect.TypeOf((*MockProvisionerClient)(nil).Stop), varargs...) } -// ValidateProvisionerConfig mocks base method +// ValidateProvisionerConfig mocks base method. func (m *MockProvisionerClient) ValidateProvisionerConfig(arg0 context.Context, arg1 *tfplugin5.ValidateProvisionerConfig_Request, arg2 ...grpc.CallOption) (*tfplugin5.ValidateProvisionerConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -372,37 +373,37 @@ func (m *MockProvisionerClient) ValidateProvisionerConfig(arg0 context.Context, return ret0, ret1 } -// ValidateProvisionerConfig indicates an expected call of ValidateProvisionerConfig +// ValidateProvisionerConfig indicates an expected call of ValidateProvisionerConfig. func (mr *MockProvisionerClientMockRecorder) ValidateProvisionerConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ValidateProvisionerConfig", reflect.TypeOf((*MockProvisionerClient)(nil).ValidateProvisionerConfig), varargs...) } -// MockProvisioner_ProvisionResourceClient is a mock of Provisioner_ProvisionResourceClient interface +// MockProvisioner_ProvisionResourceClient is a mock of Provisioner_ProvisionResourceClient interface. type MockProvisioner_ProvisionResourceClient struct { ctrl *gomock.Controller recorder *MockProvisioner_ProvisionResourceClientMockRecorder } -// MockProvisioner_ProvisionResourceClientMockRecorder is the mock recorder for MockProvisioner_ProvisionResourceClient +// MockProvisioner_ProvisionResourceClientMockRecorder is the mock recorder for MockProvisioner_ProvisionResourceClient. type MockProvisioner_ProvisionResourceClientMockRecorder struct { mock *MockProvisioner_ProvisionResourceClient } -// NewMockProvisioner_ProvisionResourceClient creates a new mock instance +// NewMockProvisioner_ProvisionResourceClient creates a new mock instance. func NewMockProvisioner_ProvisionResourceClient(ctrl *gomock.Controller) *MockProvisioner_ProvisionResourceClient { mock := &MockProvisioner_ProvisionResourceClient{ctrl: ctrl} mock.recorder = &MockProvisioner_ProvisionResourceClientMockRecorder{mock} return mock } -// EXPECT returns an object that allows the caller to indicate expected use +// EXPECT returns an object that allows the caller to indicate expected use. func (m *MockProvisioner_ProvisionResourceClient) EXPECT() *MockProvisioner_ProvisionResourceClientMockRecorder { return m.recorder } -// CloseSend mocks base method +// CloseSend mocks base method. func (m *MockProvisioner_ProvisionResourceClient) CloseSend() error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "CloseSend") @@ -410,13 +411,13 @@ func (m *MockProvisioner_ProvisionResourceClient) CloseSend() error { return ret0 } -// CloseSend indicates an expected call of CloseSend +// CloseSend indicates an expected call of CloseSend. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) CloseSend() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CloseSend", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).CloseSend)) } -// Context mocks base method +// Context mocks base method. func (m *MockProvisioner_ProvisionResourceClient) Context() context.Context { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Context") @@ -424,13 +425,13 @@ func (m *MockProvisioner_ProvisionResourceClient) Context() context.Context { return ret0 } -// Context indicates an expected call of Context +// Context indicates an expected call of Context. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) Context() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Context", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).Context)) } -// Header mocks base method +// Header mocks base method. func (m *MockProvisioner_ProvisionResourceClient) Header() (metadata.MD, error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Header") @@ -439,13 +440,13 @@ func (m *MockProvisioner_ProvisionResourceClient) Header() (metadata.MD, error) return ret0, ret1 } -// Header indicates an expected call of Header +// Header indicates an expected call of Header. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) Header() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Header", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).Header)) } -// Recv mocks base method +// Recv mocks base method. func (m *MockProvisioner_ProvisionResourceClient) Recv() (*tfplugin5.ProvisionResource_Response, error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Recv") @@ -454,13 +455,13 @@ func (m *MockProvisioner_ProvisionResourceClient) Recv() (*tfplugin5.ProvisionRe return ret0, ret1 } -// Recv indicates an expected call of Recv +// Recv indicates an expected call of Recv. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) Recv() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Recv", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).Recv)) } -// RecvMsg mocks base method +// RecvMsg mocks base method. func (m *MockProvisioner_ProvisionResourceClient) RecvMsg(arg0 interface{}) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "RecvMsg", arg0) @@ -468,13 +469,13 @@ func (m *MockProvisioner_ProvisionResourceClient) RecvMsg(arg0 interface{}) erro return ret0 } -// RecvMsg indicates an expected call of RecvMsg +// RecvMsg indicates an expected call of RecvMsg. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) RecvMsg(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RecvMsg", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).RecvMsg), arg0) } -// SendMsg mocks base method +// SendMsg mocks base method. func (m *MockProvisioner_ProvisionResourceClient) SendMsg(arg0 interface{}) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "SendMsg", arg0) @@ -482,13 +483,13 @@ func (m *MockProvisioner_ProvisionResourceClient) SendMsg(arg0 interface{}) erro return ret0 } -// SendMsg indicates an expected call of SendMsg +// SendMsg indicates an expected call of SendMsg. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) SendMsg(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SendMsg", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).SendMsg), arg0) } -// Trailer mocks base method +// Trailer mocks base method. func (m *MockProvisioner_ProvisionResourceClient) Trailer() metadata.MD { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Trailer") @@ -496,36 +497,36 @@ func (m *MockProvisioner_ProvisionResourceClient) Trailer() metadata.MD { return ret0 } -// Trailer indicates an expected call of Trailer +// Trailer indicates an expected call of Trailer. func (mr *MockProvisioner_ProvisionResourceClientMockRecorder) Trailer() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Trailer", reflect.TypeOf((*MockProvisioner_ProvisionResourceClient)(nil).Trailer)) } -// MockProvisioner_ProvisionResourceServer is a mock of Provisioner_ProvisionResourceServer interface +// MockProvisioner_ProvisionResourceServer is a mock of Provisioner_ProvisionResourceServer interface. type MockProvisioner_ProvisionResourceServer struct { ctrl *gomock.Controller recorder *MockProvisioner_ProvisionResourceServerMockRecorder } -// MockProvisioner_ProvisionResourceServerMockRecorder is the mock recorder for MockProvisioner_ProvisionResourceServer +// MockProvisioner_ProvisionResourceServerMockRecorder is the mock recorder for MockProvisioner_ProvisionResourceServer. type MockProvisioner_ProvisionResourceServerMockRecorder struct { mock *MockProvisioner_ProvisionResourceServer } -// NewMockProvisioner_ProvisionResourceServer creates a new mock instance +// NewMockProvisioner_ProvisionResourceServer creates a new mock instance. func NewMockProvisioner_ProvisionResourceServer(ctrl *gomock.Controller) *MockProvisioner_ProvisionResourceServer { mock := &MockProvisioner_ProvisionResourceServer{ctrl: ctrl} mock.recorder = &MockProvisioner_ProvisionResourceServerMockRecorder{mock} return mock } -// EXPECT returns an object that allows the caller to indicate expected use +// EXPECT returns an object that allows the caller to indicate expected use. func (m *MockProvisioner_ProvisionResourceServer) EXPECT() *MockProvisioner_ProvisionResourceServerMockRecorder { return m.recorder } -// Context mocks base method +// Context mocks base method. func (m *MockProvisioner_ProvisionResourceServer) Context() context.Context { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Context") @@ -533,13 +534,13 @@ func (m *MockProvisioner_ProvisionResourceServer) Context() context.Context { return ret0 } -// Context indicates an expected call of Context +// Context indicates an expected call of Context. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) Context() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Context", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).Context)) } -// RecvMsg mocks base method +// RecvMsg mocks base method. func (m *MockProvisioner_ProvisionResourceServer) RecvMsg(arg0 interface{}) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "RecvMsg", arg0) @@ -547,13 +548,13 @@ func (m *MockProvisioner_ProvisionResourceServer) RecvMsg(arg0 interface{}) erro return ret0 } -// RecvMsg indicates an expected call of RecvMsg +// RecvMsg indicates an expected call of RecvMsg. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) RecvMsg(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RecvMsg", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).RecvMsg), arg0) } -// Send mocks base method +// Send mocks base method. func (m *MockProvisioner_ProvisionResourceServer) Send(arg0 *tfplugin5.ProvisionResource_Response) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Send", arg0) @@ -561,13 +562,13 @@ func (m *MockProvisioner_ProvisionResourceServer) Send(arg0 *tfplugin5.Provision return ret0 } -// Send indicates an expected call of Send +// Send indicates an expected call of Send. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) Send(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Send", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).Send), arg0) } -// SendHeader mocks base method +// SendHeader mocks base method. func (m *MockProvisioner_ProvisionResourceServer) SendHeader(arg0 metadata.MD) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "SendHeader", arg0) @@ -575,13 +576,13 @@ func (m *MockProvisioner_ProvisionResourceServer) SendHeader(arg0 metadata.MD) e return ret0 } -// SendHeader indicates an expected call of SendHeader +// SendHeader indicates an expected call of SendHeader. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) SendHeader(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SendHeader", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).SendHeader), arg0) } -// SendMsg mocks base method +// SendMsg mocks base method. func (m *MockProvisioner_ProvisionResourceServer) SendMsg(arg0 interface{}) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "SendMsg", arg0) @@ -589,13 +590,13 @@ func (m *MockProvisioner_ProvisionResourceServer) SendMsg(arg0 interface{}) erro return ret0 } -// SendMsg indicates an expected call of SendMsg +// SendMsg indicates an expected call of SendMsg. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) SendMsg(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SendMsg", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).SendMsg), arg0) } -// SetHeader mocks base method +// SetHeader mocks base method. func (m *MockProvisioner_ProvisionResourceServer) SetHeader(arg0 metadata.MD) error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "SetHeader", arg0) @@ -603,19 +604,19 @@ func (m *MockProvisioner_ProvisionResourceServer) SetHeader(arg0 metadata.MD) er return ret0 } -// SetHeader indicates an expected call of SetHeader +// SetHeader indicates an expected call of SetHeader. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) SetHeader(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetHeader", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).SetHeader), arg0) } -// SetTrailer mocks base method +// SetTrailer mocks base method. func (m *MockProvisioner_ProvisionResourceServer) SetTrailer(arg0 metadata.MD) { m.ctrl.T.Helper() m.ctrl.Call(m, "SetTrailer", arg0) } -// SetTrailer indicates an expected call of SetTrailer +// SetTrailer indicates an expected call of SetTrailer. func (mr *MockProvisioner_ProvisionResourceServerMockRecorder) SetTrailer(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetTrailer", reflect.TypeOf((*MockProvisioner_ProvisionResourceServer)(nil).SetTrailer), arg0) diff --git a/internal/plugin6/grpc_provider_test.go b/internal/plugin6/grpc_provider_test.go index ee58f57792ee..cca0b58208fa 100644 --- a/internal/plugin6/grpc_provider_test.go +++ b/internal/plugin6/grpc_provider_test.go @@ -235,7 +235,8 @@ func TestGRPCProvider_Configure(t *testing.T) { } func TestGRPCProvider_Stop(t *testing.T) { - client := mockProviderClient(t) + ctrl := gomock.NewController(t) + client := mockproto.NewMockProviderClient(ctrl) p := &GRPCProvider{ client: client, } diff --git a/internal/plugin6/mock_proto/mock.go b/internal/plugin6/mock_proto/mock.go index 506fd7bc6057..448008ef7528 100644 --- a/internal/plugin6/mock_proto/mock.go +++ b/internal/plugin6/mock_proto/mock.go @@ -6,36 +6,37 @@ package mock_tfplugin6 import ( context "context" + reflect "reflect" + gomock "github.com/golang/mock/gomock" tfplugin6 "github.com/hashicorp/terraform/internal/tfplugin6" grpc "google.golang.org/grpc" - reflect "reflect" ) -// MockProviderClient is a mock of ProviderClient interface +// MockProviderClient is a mock of ProviderClient interface. type MockProviderClient struct { ctrl *gomock.Controller recorder *MockProviderClientMockRecorder } -// MockProviderClientMockRecorder is the mock recorder for MockProviderClient +// MockProviderClientMockRecorder is the mock recorder for MockProviderClient. type MockProviderClientMockRecorder struct { mock *MockProviderClient } -// NewMockProviderClient creates a new mock instance +// NewMockProviderClient creates a new mock instance. func NewMockProviderClient(ctrl *gomock.Controller) *MockProviderClient { mock := &MockProviderClient{ctrl: ctrl} mock.recorder = &MockProviderClientMockRecorder{mock} return mock } -// EXPECT returns an object that allows the caller to indicate expected use +// EXPECT returns an object that allows the caller to indicate expected use. func (m *MockProviderClient) EXPECT() *MockProviderClientMockRecorder { return m.recorder } -// ApplyResourceChange mocks base method +// ApplyResourceChange mocks base method. func (m *MockProviderClient) ApplyResourceChange(arg0 context.Context, arg1 *tfplugin6.ApplyResourceChange_Request, arg2 ...grpc.CallOption) (*tfplugin6.ApplyResourceChange_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -48,14 +49,14 @@ func (m *MockProviderClient) ApplyResourceChange(arg0 context.Context, arg1 *tfp return ret0, ret1 } -// ApplyResourceChange indicates an expected call of ApplyResourceChange +// ApplyResourceChange indicates an expected call of ApplyResourceChange. func (mr *MockProviderClientMockRecorder) ApplyResourceChange(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ApplyResourceChange", reflect.TypeOf((*MockProviderClient)(nil).ApplyResourceChange), varargs...) } -// ConfigureProvider mocks base method +// ConfigureProvider mocks base method. func (m *MockProviderClient) ConfigureProvider(arg0 context.Context, arg1 *tfplugin6.ConfigureProvider_Request, arg2 ...grpc.CallOption) (*tfplugin6.ConfigureProvider_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -68,14 +69,14 @@ func (m *MockProviderClient) ConfigureProvider(arg0 context.Context, arg1 *tfplu return ret0, ret1 } -// ConfigureProvider indicates an expected call of ConfigureProvider +// ConfigureProvider indicates an expected call of ConfigureProvider. func (mr *MockProviderClientMockRecorder) ConfigureProvider(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ConfigureProvider", reflect.TypeOf((*MockProviderClient)(nil).ConfigureProvider), varargs...) } -// GetProviderSchema mocks base method +// GetProviderSchema mocks base method. func (m *MockProviderClient) GetProviderSchema(arg0 context.Context, arg1 *tfplugin6.GetProviderSchema_Request, arg2 ...grpc.CallOption) (*tfplugin6.GetProviderSchema_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -88,14 +89,14 @@ func (m *MockProviderClient) GetProviderSchema(arg0 context.Context, arg1 *tfplu return ret0, ret1 } -// GetProviderSchema indicates an expected call of GetProviderSchema +// GetProviderSchema indicates an expected call of GetProviderSchema. func (mr *MockProviderClientMockRecorder) GetProviderSchema(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetProviderSchema", reflect.TypeOf((*MockProviderClient)(nil).GetProviderSchema), varargs...) } -// ImportResourceState mocks base method +// ImportResourceState mocks base method. func (m *MockProviderClient) ImportResourceState(arg0 context.Context, arg1 *tfplugin6.ImportResourceState_Request, arg2 ...grpc.CallOption) (*tfplugin6.ImportResourceState_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -108,14 +109,14 @@ func (m *MockProviderClient) ImportResourceState(arg0 context.Context, arg1 *tfp return ret0, ret1 } -// ImportResourceState indicates an expected call of ImportResourceState +// ImportResourceState indicates an expected call of ImportResourceState. func (mr *MockProviderClientMockRecorder) ImportResourceState(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ImportResourceState", reflect.TypeOf((*MockProviderClient)(nil).ImportResourceState), varargs...) } -// PlanResourceChange mocks base method +// PlanResourceChange mocks base method. func (m *MockProviderClient) PlanResourceChange(arg0 context.Context, arg1 *tfplugin6.PlanResourceChange_Request, arg2 ...grpc.CallOption) (*tfplugin6.PlanResourceChange_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -128,14 +129,14 @@ func (m *MockProviderClient) PlanResourceChange(arg0 context.Context, arg1 *tfpl return ret0, ret1 } -// PlanResourceChange indicates an expected call of PlanResourceChange +// PlanResourceChange indicates an expected call of PlanResourceChange. func (mr *MockProviderClientMockRecorder) PlanResourceChange(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "PlanResourceChange", reflect.TypeOf((*MockProviderClient)(nil).PlanResourceChange), varargs...) } -// ReadDataSource mocks base method +// ReadDataSource mocks base method. func (m *MockProviderClient) ReadDataSource(arg0 context.Context, arg1 *tfplugin6.ReadDataSource_Request, arg2 ...grpc.CallOption) (*tfplugin6.ReadDataSource_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -148,14 +149,14 @@ func (m *MockProviderClient) ReadDataSource(arg0 context.Context, arg1 *tfplugin return ret0, ret1 } -// ReadDataSource indicates an expected call of ReadDataSource +// ReadDataSource indicates an expected call of ReadDataSource. func (mr *MockProviderClientMockRecorder) ReadDataSource(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReadDataSource", reflect.TypeOf((*MockProviderClient)(nil).ReadDataSource), varargs...) } -// ReadResource mocks base method +// ReadResource mocks base method. func (m *MockProviderClient) ReadResource(arg0 context.Context, arg1 *tfplugin6.ReadResource_Request, arg2 ...grpc.CallOption) (*tfplugin6.ReadResource_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -168,14 +169,14 @@ func (m *MockProviderClient) ReadResource(arg0 context.Context, arg1 *tfplugin6. return ret0, ret1 } -// ReadResource indicates an expected call of ReadResource +// ReadResource indicates an expected call of ReadResource. func (mr *MockProviderClientMockRecorder) ReadResource(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReadResource", reflect.TypeOf((*MockProviderClient)(nil).ReadResource), varargs...) } -// StopProvider mocks base method +// StopProvider mocks base method. func (m *MockProviderClient) StopProvider(arg0 context.Context, arg1 *tfplugin6.StopProvider_Request, arg2 ...grpc.CallOption) (*tfplugin6.StopProvider_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -188,14 +189,14 @@ func (m *MockProviderClient) StopProvider(arg0 context.Context, arg1 *tfplugin6. return ret0, ret1 } -// StopProvider indicates an expected call of StopProvider +// StopProvider indicates an expected call of StopProvider. func (mr *MockProviderClientMockRecorder) StopProvider(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "StopProvider", reflect.TypeOf((*MockProviderClient)(nil).StopProvider), varargs...) } -// UpgradeResourceState mocks base method +// UpgradeResourceState mocks base method. func (m *MockProviderClient) UpgradeResourceState(arg0 context.Context, arg1 *tfplugin6.UpgradeResourceState_Request, arg2 ...grpc.CallOption) (*tfplugin6.UpgradeResourceState_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -208,14 +209,14 @@ func (m *MockProviderClient) UpgradeResourceState(arg0 context.Context, arg1 *tf return ret0, ret1 } -// UpgradeResourceState indicates an expected call of UpgradeResourceState +// UpgradeResourceState indicates an expected call of UpgradeResourceState. func (mr *MockProviderClientMockRecorder) UpgradeResourceState(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpgradeResourceState", reflect.TypeOf((*MockProviderClient)(nil).UpgradeResourceState), varargs...) } -// ValidateDataResourceConfig mocks base method +// ValidateDataResourceConfig mocks base method. func (m *MockProviderClient) ValidateDataResourceConfig(arg0 context.Context, arg1 *tfplugin6.ValidateDataResourceConfig_Request, arg2 ...grpc.CallOption) (*tfplugin6.ValidateDataResourceConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -228,14 +229,14 @@ func (m *MockProviderClient) ValidateDataResourceConfig(arg0 context.Context, ar return ret0, ret1 } -// ValidateDataResourceConfig indicates an expected call of ValidateDataResourceConfig +// ValidateDataResourceConfig indicates an expected call of ValidateDataResourceConfig. func (mr *MockProviderClientMockRecorder) ValidateDataResourceConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ValidateDataResourceConfig", reflect.TypeOf((*MockProviderClient)(nil).ValidateDataResourceConfig), varargs...) } -// ValidateProviderConfig mocks base method +// ValidateProviderConfig mocks base method. func (m *MockProviderClient) ValidateProviderConfig(arg0 context.Context, arg1 *tfplugin6.ValidateProviderConfig_Request, arg2 ...grpc.CallOption) (*tfplugin6.ValidateProviderConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -248,14 +249,14 @@ func (m *MockProviderClient) ValidateProviderConfig(arg0 context.Context, arg1 * return ret0, ret1 } -// ValidateProviderConfig indicates an expected call of ValidateProviderConfig +// ValidateProviderConfig indicates an expected call of ValidateProviderConfig. func (mr *MockProviderClientMockRecorder) ValidateProviderConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ValidateProviderConfig", reflect.TypeOf((*MockProviderClient)(nil).ValidateProviderConfig), varargs...) } -// ValidateResourceConfig mocks base method +// ValidateResourceConfig mocks base method. func (m *MockProviderClient) ValidateResourceConfig(arg0 context.Context, arg1 *tfplugin6.ValidateResourceConfig_Request, arg2 ...grpc.CallOption) (*tfplugin6.ValidateResourceConfig_Response, error) { m.ctrl.T.Helper() varargs := []interface{}{arg0, arg1} @@ -268,7 +269,7 @@ func (m *MockProviderClient) ValidateResourceConfig(arg0 context.Context, arg1 * return ret0, ret1 } -// ValidateResourceConfig indicates an expected call of ValidateResourceConfig +// ValidateResourceConfig indicates an expected call of ValidateResourceConfig. func (mr *MockProviderClientMockRecorder) ValidateResourceConfig(arg0, arg1 interface{}, arg2 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0, arg1}, arg2...) From 4666e930d4c35ff5f65f8bb3853d990d066323e0 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Thu, 28 Oct 2021 23:49:59 -0500 Subject: [PATCH 275/644] Update CHANGELOG for #29826 --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b5849960729..1c928a8e5d92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ UPGRADE NOTES: NEW FEATURES: +* A new `cloud` option in the `terraform` settings block adds a more native integration for Terraform Cloud and its [CLI-driven run workflow](https://www.terraform.io/docs/cloud/run/cli.html). The Cloud integration includes several enhancements, including per-run variable support using the `-var` flag, the ability to map Terraform Cloud workspaces to the current configuration via [Workspace Tags](https://www.terraform.io/docs/cloud/api/workspaces.html#get-tags), and an improved user experience for Terraform Cloud/Enterprise users with actionable error messages and prompts. ([#29826](https://github.com/hashicorp/terraform/pull/29826)) * `terraform plan` and `terraform apply`: When Terraform plans to destroy a resource instance due to it no longer being declared in the configuration, the proposed plan output will now include a note hinting at what situation prompted that proposal, so you can more easily see what configuration change might avoid the object being destroyed. ([#29637](https://github.com/hashicorp/terraform/pull/29637)) * `terraform plan` and `terraform apply`: When Terraform automatically moves a singleton resource instance to index zero or vice-versa in response to adding or removing `count`, it'll report explicitly that it did so as part of the plan output. ([#29605](https://github.com/hashicorp/terraform/pull/29605)) * config: a new `type()` function, available only in `terraform console`. ([#28501](https://github.com/hashicorp/terraform/issues/28501)) From f0a64eb45627b4de5293c98525e7385d127a07dc Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 27 Oct 2021 10:33:00 -0400 Subject: [PATCH 276/644] configs: explicitly nullable variable values The current behavior of module input variables is to allow users to override a default by assigning `null`, which works contrary to the behavior of resource attributes, and prevents explicitly accepting a default when the input must be defined in the configuration. Add a new variable attribute called `nullable` will allow explicitly defining when a variable can be set to null or not. The current default behavior is that of `nullable=true`. Setting `nullable=false` in a variable block indicates that the variable value can never be null. This either requires a non-null input value, or a non-null default value. In the case of the latter, we also opt-in to the new behavior of a `null` input value taking the default rather than overriding it. In a future language edition where we make `nullable=false` the default, setting `nullable=true` will allow the legacy behavior of `null` overriding a default value. The only future configuration in which this would be required even if the legacy behavior were not desired is when setting an optional+nullable value. In that case `default=null` would also be needed and we could therefor imply `nullable=true` without requiring it in the configuration. --- internal/configs/module_merge_test.go | 2 + internal/configs/named_values.go | 26 ++++++++ .../nullable-with-default-null/main.tf | 5 ++ .../configs/testdata/valid-files/variables.tf | 12 ++++ internal/terraform/context_apply2_test.go | 33 +++++++++++ internal/terraform/evaluate.go | 28 ++++++--- .../testdata/apply-nullable-variables/main.tf | 28 +++++++++ .../apply-nullable-variables/mod/main.tf | 59 +++++++++++++++++++ 8 files changed, 186 insertions(+), 7 deletions(-) create mode 100644 internal/configs/testdata/invalid-modules/nullable-with-default-null/main.tf create mode 100644 internal/terraform/testdata/apply-nullable-variables/main.tf create mode 100644 internal/terraform/testdata/apply-nullable-variables/mod/main.tf diff --git a/internal/configs/module_merge_test.go b/internal/configs/module_merge_test.go index 0a57e06bc560..d6df20381c79 100644 --- a/internal/configs/module_merge_test.go +++ b/internal/configs/module_merge_test.go @@ -24,6 +24,7 @@ func TestModuleOverrideVariable(t *testing.T) { Description: "b_override description", DescriptionSet: true, Default: cty.StringVal("b_override"), + Nullable: true, Type: cty.String, ConstraintType: cty.String, ParsingMode: VariableParseLiteral, @@ -46,6 +47,7 @@ func TestModuleOverrideVariable(t *testing.T) { Description: "base description", DescriptionSet: true, Default: cty.StringVal("b_override partial"), + Nullable: true, Type: cty.String, ConstraintType: cty.String, ParsingMode: VariableParseLiteral, diff --git a/internal/configs/named_values.go b/internal/configs/named_values.go index 21abd33c2253..8f3db453e688 100644 --- a/internal/configs/named_values.go +++ b/internal/configs/named_values.go @@ -36,6 +36,11 @@ type Variable struct { DescriptionSet bool SensitiveSet bool + // Nullable indicates that null is a valid value for this variable. Setting + // Nullable to false means that the module can expect this variable to + // never be null. + Nullable bool + DeclRange hcl.Range } @@ -110,6 +115,15 @@ func decodeVariableBlock(block *hcl.Block, override bool) (*Variable, hcl.Diagno v.SensitiveSet = true } + if attr, exists := content.Attributes["nullable"]; exists { + valDiags := gohcl.DecodeExpression(attr.Expr, nil, &v.Nullable) + diags = append(diags, valDiags...) + } else { + // The current default is true, which is subject to change in a future + // language edition. + v.Nullable = true + } + if attr, exists := content.Attributes["default"]; exists { val, valDiags := attr.Expr.Value(nil) diags = append(diags, valDiags...) @@ -134,6 +148,15 @@ func decodeVariableBlock(block *hcl.Block, override bool) (*Variable, hcl.Diagno } } + if !v.Nullable && val.IsNull() { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid default value for variable", + Detail: "A null default value is not valid when nullable=false.", + Subject: attr.Expr.Range().Ptr(), + }) + } + v.Default = val } @@ -556,6 +579,9 @@ var variableBlockSchema = &hcl.BodySchema{ { Name: "sensitive", }, + { + Name: "nullable", + }, }, Blocks: []hcl.BlockHeaderSchema{ { diff --git a/internal/configs/testdata/invalid-modules/nullable-with-default-null/main.tf b/internal/configs/testdata/invalid-modules/nullable-with-default-null/main.tf new file mode 100644 index 000000000000..bf7a58a4040b --- /dev/null +++ b/internal/configs/testdata/invalid-modules/nullable-with-default-null/main.tf @@ -0,0 +1,5 @@ +variable "in" { + type = number + nullable = false + default = null +} diff --git a/internal/configs/testdata/valid-files/variables.tf b/internal/configs/testdata/valid-files/variables.tf index d641966b5f65..16640c983baf 100644 --- a/internal/configs/testdata/valid-files/variables.tf +++ b/internal/configs/testdata/valid-files/variables.tf @@ -30,3 +30,15 @@ variable "sensitive_value" { } sensitive = true } + +variable "nullable" { + type = string + nullable = true + default = "ok" +} + +variable "nullable_default_null" { + type = map(string) + nullable = true + default = null +} diff --git a/internal/terraform/context_apply2_test.go b/internal/terraform/context_apply2_test.go index c405f30aaff2..8708c7228ad4 100644 --- a/internal/terraform/context_apply2_test.go +++ b/internal/terraform/context_apply2_test.go @@ -596,3 +596,36 @@ resource "test_object" "x" { } } + +func TestContext2Apply_nullableVariables(t *testing.T) { + m := testModule(t, "apply-nullable-variables") + state := states.NewState() + ctx := testContext2(t, &ContextOpts{}) + plan, diags := ctx.Plan(m, state, &PlanOpts{}) + if diags.HasErrors() { + t.Fatalf("plan: %s", diags.Err()) + } + state, diags = ctx.Apply(plan, m) + if diags.HasErrors() { + t.Fatalf("apply: %s", diags.Err()) + } + + outputs := state.Module(addrs.RootModuleInstance).OutputValues + // we check for null outputs be seeing that they don't exists + if _, ok := outputs["nullable_null_default"]; ok { + t.Error("nullable_null_default: expected no output value") + } + if _, ok := outputs["nullable_non_null_default"]; ok { + t.Error("nullable_non_null_default: expected no output value") + } + if _, ok := outputs["nullable_no_default"]; ok { + t.Error("nullable_no_default: expected no output value") + } + + if v := outputs["non_nullable_default"].Value; v.AsString() != "ok" { + t.Fatalf("incorrect 'non_nullable_default' output value: %#v\n", v) + } + if v := outputs["non_nullable_no_default"].Value; v.AsString() != "ok" { + t.Fatalf("incorrect 'non_nullable_no_default' output value: %#v\n", v) + } +} diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index 5e746b6d1c5e..81669d81c48f 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -268,11 +268,27 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd } val, isSet := vals[addr.Name] - if !isSet { - if config.Default != cty.NilVal { - return config.Default, diags - } - return cty.UnknownVal(config.Type), diags + switch { + case !isSet: + // The config loader will ensure there is a default if the value is not + // set at all. + val = config.Default + + case val.IsNull() && !config.Nullable && config.Default != cty.NilVal: + // If nullable=false a null value will use the configured default. + val = config.Default + + case val.IsNull() && !config.Nullable: + // The value cannot be null, and there is no configured default. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Invalid variable value`, + Detail: fmt.Sprintf(`The resolved value of variable %q cannot be null.`, addr.Name), + Subject: &config.DeclRange, + }) + // Stub out our return value so that the semantic checker doesn't + // produce redundant downstream errors. + val = cty.UnknownVal(config.Type) } var err error @@ -286,8 +302,6 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd Detail: fmt.Sprintf(`The resolved value of variable %q is not appropriate: %s.`, addr.Name, err), Subject: &config.DeclRange, }) - // Stub out our return value so that the semantic checker doesn't - // produce redundant downstream errors. val = cty.UnknownVal(config.Type) } diff --git a/internal/terraform/testdata/apply-nullable-variables/main.tf b/internal/terraform/testdata/apply-nullable-variables/main.tf new file mode 100644 index 000000000000..ed4b6c7f26f2 --- /dev/null +++ b/internal/terraform/testdata/apply-nullable-variables/main.tf @@ -0,0 +1,28 @@ +module "mod" { + source = "./mod" + nullable_null_default = null + nullable_non_null_default = null + nullable_no_default = null + non_nullable_default = null + non_nullable_no_default = "ok" +} + +output "nullable_null_default" { + value = module.mod.nullable_null_default +} + +output "nullable_non_null_default" { + value = module.mod.nullable_non_null_default +} + +output "nullable_no_default" { + value = module.mod.nullable_no_default +} + +output "non_nullable_default" { + value = module.mod.non_nullable_default +} + +output "non_nullable_no_default" { + value = module.mod.non_nullable_no_default +} diff --git a/internal/terraform/testdata/apply-nullable-variables/mod/main.tf b/internal/terraform/testdata/apply-nullable-variables/mod/main.tf new file mode 100644 index 000000000000..fcac3ba37260 --- /dev/null +++ b/internal/terraform/testdata/apply-nullable-variables/mod/main.tf @@ -0,0 +1,59 @@ +// optional, and this can take null as an input +variable "nullable_null_default" { + // This is implied now as the default, and probably should be implied even + // when nullable=false is the default, so we're leaving this unset for the test. + // nullable = true + + default = null +} + +// assigning null can still override the default. +variable "nullable_non_null_default" { + nullable = true + default = "ok" +} + +// required, and assigning null is valid. +variable "nullable_no_default" { + nullable = true +} + + +// this combination is invalid +//variable "non_nullable_null_default" { +// nullable = false +// default = null +//} + + +// assigning null will take the default +variable "non_nullable_default" { + nullable = false + default = "ok" +} + +// required, but null is not a valid value +variable "non_nullable_no_default" { + nullable = false +} + +output "nullable_null_default" { + value = var.nullable_null_default +} + +output "nullable_non_null_default" { + value = var.nullable_non_null_default +} + +output "nullable_no_default" { + value = var.nullable_no_default +} + +output "non_nullable_default" { + value = var.non_nullable_default +} + +output "non_nullable_no_default" { + value = var.non_nullable_no_default +} + From 91f27c6d0475a3aeb4c12c01e8a89807765fe47f Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 29 Oct 2021 14:43:36 -0400 Subject: [PATCH 277/644] remove Crash section of issue template Terraform is no longer going to silently capture all logs for a possible crash report, and therefor won't create a crash.log file when a panic is encountered. The prompt to create a log file with TF_LOG from the Debug Output section should suffice to get users to submit the logs when possible. In the case of a crash specifically, the crash output also requests that the stack trace be added to the issue for users who may not be aware of what is necessary. --- .github/ISSUE_TEMPLATE/bug_report.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c8ad02922998..a4d37fa551b7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -53,11 +53,6 @@ Full debug output can be obtained by running Terraform with the environment vari Debug output may contain sensitive information. Please review it before posting publicly, and if you are concerned feel free to encrypt the files using the HashiCorp security public key. --> -### Crash Output - - ### Expected Behavior This feature was introduced in Terraform v1.1.0. +-> This feature is available in Terraform v1.1.0 and later. The `nullable` argument in a variable block controls whether the module caller may assign the value `null` to the variable. From 744a231d4c15cfc4394a514820f73c728d4614c0 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 1 Nov 2021 15:43:25 -0400 Subject: [PATCH 303/644] update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d2e520ef46a6..37a55b6f9009 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,7 @@ ENHANCEMENTS: BUG FIXES: +* backend/oss: Flatten `assume_role` block attributes, so that they may be more easily represented in a compatible way with `terraform_remote_state` [GH-29307] * core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) * core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources ([#29682](https://github.com/hashicorp/terraform/issues/29682)) * cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) From 12651c0a81bf5dd94000aaddca57b7bf46ae9a4f Mon Sep 17 00:00:00 2001 From: kmoe <5575356+kmoe@users.noreply.github.com> Date: Mon, 1 Nov 2021 20:09:16 +0000 Subject: [PATCH 304/644] update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 37a55b6f9009..aba0a32e49bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ ENHANCEMENTS: BUG FIXES: * backend/oss: Flatten `assume_role` block attributes, so that they may be more easily represented in a compatible way with `terraform_remote_state` [GH-29307] +* config: Fixed a bug in which `ignore_changes = all` would not work in override files [GH-29849] * core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) * core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources ([#29682](https://github.com/hashicorp/terraform/issues/29682)) * cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) From 52ca30273fef85ce1ddf01b9342d299f646dcffa Mon Sep 17 00:00:00 2001 From: Billy Keyes Date: Tue, 2 Nov 2021 11:13:56 -0400 Subject: [PATCH 305/644] command/format: improve list nested attribute rendering (#29827) * command/format: fix list nested attr diff rendering Previously, diffs only rendered correctly if all changed elements appeared before all unchanged elements. Once an unchanged element was found, all remaining elements were skipped. This usually led to the output being an empty list with a weird amount of space between the brackets. * command/format: improve list nested attr rendering This makes several changes that make diffs for lists clearer and more consistent: * Separate items with brackets instead of only new lines. This better matches the input syntax and avoids confusion from the first and last brackets implying there is a single item. * Render an action symbol for each element of the list * Use the correct action symbol for new and deleted items * Fix the alignment of opening and closing brackets I also refactored the structure so it is similar to the set and map cases to minimize duplication of the new prints. * Fix re-use of blockBodyDiffResult struct --- internal/command/format/diff.go | 70 +++++++++------ internal/command/format/diff_test.go | 123 +++++++++++++++++++++------ 2 files changed, 140 insertions(+), 53 deletions(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index ec777b5852fa..4aafe9dbeb1c 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -473,9 +473,6 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( p.buf.WriteString(p.color.Color(forcesNewResourceCaption)) } p.buf.WriteString("\n") - p.buf.WriteString(strings.Repeat(" ", indent+4)) - p.writeActionSymbol(action) - p.buf.WriteString("{") oldItems := ctyCollectionValues(old) newItems := ctyCollectionValues(new) @@ -489,48 +486,65 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( // commonLen is number of elements that exist in both lists, which // will be presented as updates (~). Any additional items in one // of the lists will be presented as either creates (+) or deletes (-) - // depending on which list they belong to. + // depending on which list they belong to. maxLen is the number of + // elements in that longer list. var commonLen int + var maxLen int // unchanged is the number of unchanged elements var unchanged int switch { case len(oldItems) < len(newItems): commonLen = len(oldItems) + maxLen = len(newItems) default: commonLen = len(newItems) + maxLen = len(oldItems) } - for i := 0; i < commonLen; i++ { + for i := 0; i < maxLen; i++ { path := append(path, cty.IndexStep{Key: cty.NumberIntVal(int64(i))}) - oldItem := oldItems[i] - newItem := newItems[i] - if oldItem.RawEquals(newItem) { + + var action plans.Action + var oldItem, newItem cty.Value + switch { + case i < commonLen: + oldItem = oldItems[i] + newItem = newItems[i] + if oldItem.RawEquals(newItem) { + action = plans.NoOp + unchanged++ + } else { + action = plans.Update + } + case i < len(oldItems): + oldItem = oldItems[i] + newItem = cty.NullVal(oldItem.Type()) + action = plans.Delete + case i < len(newItems): + newItem = newItems[i] + oldItem = cty.NullVal(newItem.Type()) + action = plans.Create + default: action = plans.NoOp - unchanged++ } + if action != plans.NoOp { - p.writeAttrsDiff(objS.Attributes, oldItem, newItem, indent+6, path, result) - p.writeSkippedAttr(result.skippedAttributes, indent+8) + p.buf.WriteString(strings.Repeat(" ", indent+4)) + p.writeActionSymbol(action) + p.buf.WriteString("{") + + result := &blockBodyDiffResult{} + p.writeAttrsDiff(objS.Attributes, oldItem, newItem, indent+8, path, result) + if action == plans.Update { + p.writeSkippedAttr(result.skippedAttributes, indent+10) + } p.buf.WriteString("\n") + + p.buf.WriteString(strings.Repeat(" ", indent+6)) + p.buf.WriteString("},\n") } } - for i := commonLen; i < len(oldItems); i++ { - path := append(path, cty.IndexStep{Key: cty.NumberIntVal(int64(i))}) - oldItem := oldItems[i] - newItem := cty.NullVal(oldItem.Type()) - p.writeAttrsDiff(objS.Attributes, oldItem, newItem, indent+6, path, result) - p.buf.WriteString("\n") - } - for i := commonLen; i < len(newItems); i++ { - path := append(path, cty.IndexStep{Key: cty.NumberIntVal(int64(i))}) - newItem := newItems[i] - oldItem := cty.NullVal(newItem.Type()) - p.writeAttrsDiff(objS.Attributes, oldItem, newItem, indent+6, path, result) - p.buf.WriteString("\n") - } - p.buf.WriteString(strings.Repeat(" ", indent+4)) - p.buf.WriteString("},\n") - p.writeSkippedElems(unchanged, indent+4) + p.writeSkippedElems(unchanged, indent+6) p.buf.WriteString(strings.Repeat(" ", indent+2)) p.buf.WriteString("]") diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index 6a720210ed7b..3ac77b11074f 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -2263,10 +2263,10 @@ func TestResourceChange_nestedList(t *testing.T) { ~ resource "test_instance" "example" { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - ~ { - + mount_point = "/var/diska" - + size = "50GB" - }, + + { + + mount_point = "/var/diska" + + size = "50GB" + }, ] id = "i-02ae66f368e8518a9" @@ -2309,9 +2309,9 @@ func TestResourceChange_nestedList(t *testing.T) { ~ resource "test_instance" "example" { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - ~ { - + mount_point = "/var/diska" - }, + + { + + mount_point = "/var/diska" + }, ] id = "i-02ae66f368e8518a9" @@ -2371,10 +2371,10 @@ func TestResourceChange_nestedList(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ ~ { - + size = "50GB" - # (1 unchanged attribute hidden) - }, - # (1 unchanged element hidden) + + size = "50GB" + # (1 unchanged attribute hidden) + }, + # (1 unchanged element hidden) ] id = "i-02ae66f368e8518a9" @@ -2437,9 +2437,9 @@ func TestResourceChange_nestedList(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ ~ { - ~ mount_point = "/var/diska" -> "/var/diskb" # forces replacement - # (1 unchanged attribute hidden) - }, + ~ mount_point = "/var/diska" -> "/var/diskb" # forces replacement + # (1 unchanged attribute hidden) + }, ] id = "i-02ae66f368e8518a9" @@ -2493,9 +2493,9 @@ func TestResourceChange_nestedList(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ # forces replacement ~ { - ~ mount_point = "/var/diska" -> "/var/diskb" - # (1 unchanged attribute hidden) - }, + ~ mount_point = "/var/diska" -> "/var/diskb" + # (1 unchanged attribute hidden) + }, ] id = "i-02ae66f368e8518a9" @@ -2540,10 +2540,10 @@ func TestResourceChange_nestedList(t *testing.T) { ~ resource "test_instance" "example" { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - ~ { - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - { + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, ] id = "i-02ae66f368e8518a9" @@ -2674,13 +2674,86 @@ func TestResourceChange_nestedList(t *testing.T) { ~ resource "test_instance" "example" { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - ~ { - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - { + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, ] -> (known after apply) id = "i-02ae66f368e8518a9" + # (1 unchanged block hidden) + } +`, + }, + "in-place update - modification": { + Action: plans.Update, + Mode: addrs.ManagedResourceMode, + Before: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("i-02ae66f368e8518a9"), + "ami": cty.StringVal("ami-BEFORE"), + "disks": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diska"), + "size": cty.StringVal("50GB"), + }), + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diskb"), + "size": cty.StringVal("50GB"), + }), + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diskc"), + "size": cty.StringVal("50GB"), + }), + }), + "root_block_device": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "volume_type": cty.StringVal("gp2"), + "new_field": cty.StringVal("new_value"), + }), + }), + }), + After: cty.ObjectVal(map[string]cty.Value{ + "id": cty.StringVal("i-02ae66f368e8518a9"), + "ami": cty.StringVal("ami-AFTER"), + "disks": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diska"), + "size": cty.StringVal("50GB"), + }), + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diskb"), + "size": cty.StringVal("75GB"), + }), + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diskc"), + "size": cty.StringVal("25GB"), + }), + }), + "root_block_device": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "volume_type": cty.StringVal("gp2"), + "new_field": cty.StringVal("new_value"), + }), + }), + }), + RequiredReplace: cty.NewPathSet(), + Schema: testSchemaPlus(configschema.NestingList), + ExpectedOutput: ` # test_instance.example will be updated in-place + ~ resource "test_instance" "example" { + ~ ami = "ami-BEFORE" -> "ami-AFTER" + ~ disks = [ + ~ { + ~ size = "50GB" -> "75GB" + # (1 unchanged attribute hidden) + }, + ~ { + ~ size = "50GB" -> "25GB" + # (1 unchanged attribute hidden) + }, + # (1 unchanged element hidden) + ] + id = "i-02ae66f368e8518a9" + # (1 unchanged block hidden) } `, From 19cce931a8067c714fbb5a096c2eec79a070ecd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Sierant?= Date: Wed, 16 Sep 2020 12:26:46 +0200 Subject: [PATCH 306/644] Test case for changing backend hash during aborted state migration Pulled and updated from https://github.com/hashicorp/terraform/pull/26260 --- internal/command/init_test.go | 35 +++++++++++++++++++ .../.terraform/terraform.tfstate | 22 ++++++++++++ .../input.config | 1 + .../local-state.tfstate | 21 +++++++++++ .../main.tf | 5 +++ 5 files changed, 84 insertions(+) create mode 100644 internal/command/testdata/init-backend-config-file-change-migrate-existing/.terraform/terraform.tfstate create mode 100644 internal/command/testdata/init-backend-config-file-change-migrate-existing/input.config create mode 100644 internal/command/testdata/init-backend-config-file-change-migrate-existing/local-state.tfstate create mode 100644 internal/command/testdata/init-backend-config-file-change-migrate-existing/main.tf diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 56bc1f911623..8f50087654ae 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -616,6 +616,41 @@ func TestInit_backendMigrateWhileLocked(t *testing.T) { } } +func TestInit_backendConfigFileChangeWithExistingState(t *testing.T) { + // Create a temporary working directory that is empty + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-config-file-change-migrate-existing"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + ui := new(cli.MockUi) + c := &InitCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + Ui: ui, + }, + } + + oldState := testDataStateRead(t, filepath.Join(DefaultDataDir, DefaultStateFilename)) + + // we deliberately do not provide the answer for backend-migrate-copy-to-empty to trigger error + args := []string{"-migrate-state", "-backend-config", "input.config", "-input=true"} + if code := c.Run(args); code == 0 { + t.Fatal("expected error") + } + + // Read our backend config and verify new settings are not saved + state := testDataStateRead(t, filepath.Join(DefaultDataDir, DefaultStateFilename)) + if got, want := normalizeJSON(t, state.Backend.ConfigRaw), `{"path":"local-state.tfstate"}`; got != want { + t.Errorf("wrong config\ngot: %s\nwant: %s", got, want) + } + + // without changing config, hash should not change + if oldState.Backend.Hash != state.Backend.Hash { + t.Errorf("backend hash should not have changed\ngot: %d\nwant: %d", state.Backend.Hash, oldState.Backend.Hash) + } +} + func TestInit_backendConfigKV(t *testing.T) { // Create a temporary working directory that is empty td := tempDir(t) diff --git a/internal/command/testdata/init-backend-config-file-change-migrate-existing/.terraform/terraform.tfstate b/internal/command/testdata/init-backend-config-file-change-migrate-existing/.terraform/terraform.tfstate new file mode 100644 index 000000000000..073bd7a82237 --- /dev/null +++ b/internal/command/testdata/init-backend-config-file-change-migrate-existing/.terraform/terraform.tfstate @@ -0,0 +1,22 @@ +{ + "version": 3, + "serial": 0, + "lineage": "666f9301-7e65-4b19-ae23-71184bb19b03", + "backend": { + "type": "local", + "config": { + "path": "local-state.tfstate" + }, + "hash": 9073424445967744180 + }, + "modules": [ + { + "path": [ + "root" + ], + "outputs": {}, + "resources": {}, + "depends_on": [] + } + ] +} diff --git a/internal/command/testdata/init-backend-config-file-change-migrate-existing/input.config b/internal/command/testdata/init-backend-config-file-change-migrate-existing/input.config new file mode 100644 index 000000000000..6cd14f4a3d03 --- /dev/null +++ b/internal/command/testdata/init-backend-config-file-change-migrate-existing/input.config @@ -0,0 +1 @@ +path = "hello" diff --git a/internal/command/testdata/init-backend-config-file-change-migrate-existing/local-state.tfstate b/internal/command/testdata/init-backend-config-file-change-migrate-existing/local-state.tfstate new file mode 100644 index 000000000000..ce8d954f4975 --- /dev/null +++ b/internal/command/testdata/init-backend-config-file-change-migrate-existing/local-state.tfstate @@ -0,0 +1,21 @@ +{ + "version": 3, + "terraform_version": "0.8.2", + "serial": 8, + "lineage": "local", + "modules": [ + { + "path": [ + "root" + ], + "outputs": { + "foo": { + "type": "string", + "value": "bar" + } + }, + "resources": {}, + "depends_on": [] + } + ] +} diff --git a/internal/command/testdata/init-backend-config-file-change-migrate-existing/main.tf b/internal/command/testdata/init-backend-config-file-change-migrate-existing/main.tf new file mode 100644 index 000000000000..ca1bd3921e14 --- /dev/null +++ b/internal/command/testdata/init-backend-config-file-change-migrate-existing/main.tf @@ -0,0 +1,5 @@ +terraform { + backend "local" { + path = "local-state.tfstate" + } +} From f019fb112ee99604b8e437757b04d7bd5b1e1711 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Tue, 2 Nov 2021 11:29:48 -0400 Subject: [PATCH 307/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index aba0a32e49bb..577e605930df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ BUG FIXES: * core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources ([#29682](https://github.com/hashicorp/terraform/issues/29682)) * cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) * cli: Prevent applying a stale planfile when there was no previous state ([#29755](https://github.com/hashicorp/terraform/issues/29755)) +* cli: Improve list nested attribute rendering [GH-29827] ## Previous Releases From 6b8b0617bbdb36689180628d9f7d8d400de9c625 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 2 Nov 2021 15:06:49 -0400 Subject: [PATCH 308/644] generate precise resource types during validate Allow `GetResource` to return correct types values during validation, rather than relying on `cty.DynamicVal` as a placeholder. This allows other dependent expressions to be more correctly evaluated. --- internal/terraform/context_plan_test.go | 1 + internal/terraform/evaluate.go | 78 ++++++++----------- .../testdata/plan-self-ref-multi-all/main.tf | 2 +- 3 files changed, 36 insertions(+), 45 deletions(-) diff --git a/internal/terraform/context_plan_test.go b/internal/terraform/context_plan_test.go index cfd51da8cc43..1159f0b424fc 100644 --- a/internal/terraform/context_plan_test.go +++ b/internal/terraform/context_plan_test.go @@ -5308,6 +5308,7 @@ func TestContext2Plan_selfRefMultiAll(t *testing.T) { ResourceTypes: map[string]*configschema.Block{ "aws_instance": { Attributes: map[string]*configschema.Attribute{ + "id": {Type: cty.String, Computed: true}, "foo": {Type: cty.List(cty.String), Optional: true}, }, }, diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index 71e02d96961e..c4d45efbfa49 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -654,6 +654,25 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc return cty.DynamicVal, diags } + // Build the provider address from configuration, since we may not have + // state available in all cases. + // We need to build an abs provider address, but we can use a default + // instance since we're only interested in the schema. + providerAddr := moduleAddr.ProviderConfigDefault(config.Provider) + schema := d.getResourceSchema(addr, providerAddr) + if schema == nil { + // This shouldn't happen, since validation before we get here should've + // taken care of it, but we'll show a reasonable error message anyway. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Missing resource type schema`, + Detail: fmt.Sprintf("No schema is available for %s in %s. This is a bug in Terraform and should be reported.", addr, providerAddr), + Subject: rng.ToHCL().Ptr(), + }) + return cty.DynamicVal, diags + } + ty := schema.ImpliedType() + rs := d.Evaluator.State.Resource(addr.Absolute(d.ModulePath)) if rs == nil { @@ -675,33 +694,26 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc // (since a planned destroy cannot yet remove root outputs), we // need to return a dynamic value here to allow evaluation to // continue. - log.Printf("[ERROR] unknown instance %q referenced during plan", addr.Absolute(d.ModulePath)) + log.Printf("[ERROR] unknown instance %q referenced during %s", addr.Absolute(d.ModulePath), d.Operation) return cty.DynamicVal, diags } - default: - // We should only end up here during the validate walk, - // since later walks should have at least partial states populated - // for all resources in the configuration. - return cty.DynamicVal, diags - } - } - - providerAddr := rs.ProviderConfig + if d.Operation != walkValidate { + log.Printf("[ERROR] missing state for %q while in %s\n", addr.Absolute(d.ModulePath), d.Operation) + } - schema := d.getResourceSchema(addr, providerAddr) - if schema == nil { - // This shouldn't happen, since validation before we get here should've - // taken care of it, but we'll show a reasonable error message anyway. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: `Missing resource type schema`, - Detail: fmt.Sprintf("No schema is available for %s in %s. This is a bug in Terraform and should be reported.", addr, providerAddr), - Subject: rng.ToHCL().Ptr(), - }) - return cty.DynamicVal, diags + // Validation is done with only the configuration, so generate + // unknown values of the correct shape for evaluation. + switch { + case config.Count != nil: + return cty.UnknownVal(cty.List(ty)), diags + case config.ForEach != nil: + return cty.UnknownVal(cty.Map(ty)), diags + default: + return cty.UnknownVal(ty), diags + } + } } - ty := schema.ImpliedType() // Decode all instances in the current state instances := map[addrs.InstanceKey]cty.Value{} @@ -862,28 +874,6 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc ret = val } - // since the plan was not yet created during validate, the values we - // collected here may not correspond with configuration, so they must be - // unknown. - if d.Operation == walkValidate { - // While we know the type here and it would be nice to validate whether - // indexes are valid or not, because tuples and objects have fixed - // numbers of elements we can't simply return an unknown value of the - // same type since we have not expanded any instances during - // validation. - // - // In order to validate the expression a little precisely, we'll create - // an unknown map or list here to get more type information. - switch { - case config.Count != nil: - ret = cty.UnknownVal(cty.List(ty)) - case config.ForEach != nil: - ret = cty.UnknownVal(cty.Map(ty)) - default: - ret = cty.UnknownVal(ty) - } - } - return ret, diags } diff --git a/internal/terraform/testdata/plan-self-ref-multi-all/main.tf b/internal/terraform/testdata/plan-self-ref-multi-all/main.tf index d3a9857f7bd3..a4d28f8a092f 100644 --- a/internal/terraform/testdata/plan-self-ref-multi-all/main.tf +++ b/internal/terraform/testdata/plan-self-ref-multi-all/main.tf @@ -1,4 +1,4 @@ resource "aws_instance" "web" { - foo = "${aws_instance.web.*.foo}" + foo = aws_instance.web[*].id count = 4 } From 647d36062cf200fda29b59346cb15656741fca02 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 2 Nov 2021 15:35:47 -0400 Subject: [PATCH 309/644] we don't need an abs provider address We only lookup providers by provider type to get the schema, so there's no reason to generate anything more specific. --- internal/terraform/evaluate.go | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index c4d45efbfa49..8fd05d548192 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -658,15 +658,14 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc // state available in all cases. // We need to build an abs provider address, but we can use a default // instance since we're only interested in the schema. - providerAddr := moduleAddr.ProviderConfigDefault(config.Provider) - schema := d.getResourceSchema(addr, providerAddr) + schema := d.getResourceSchema(addr, config.Provider) if schema == nil { // This shouldn't happen, since validation before we get here should've // taken care of it, but we'll show a reasonable error message anyway. diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: `Missing resource type schema`, - Detail: fmt.Sprintf("No schema is available for %s in %s. This is a bug in Terraform and should be reported.", addr, providerAddr), + Detail: fmt.Sprintf("No schema is available for %s in %s. This is a bug in Terraform and should be reported.", addr, config.Provider), Subject: rng.ToHCL().Ptr(), }) return cty.DynamicVal, diags @@ -877,8 +876,8 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc return ret, diags } -func (d *evaluationStateData) getResourceSchema(addr addrs.Resource, providerAddr addrs.AbsProviderConfig) *configschema.Block { - schema, _, err := d.Evaluator.Plugins.ResourceTypeSchema(providerAddr.Provider, addr.Mode, addr.Type) +func (d *evaluationStateData) getResourceSchema(addr addrs.Resource, providerAddr addrs.Provider) *configschema.Block { + schema, _, err := d.Evaluator.Plugins.ResourceTypeSchema(providerAddr, addr.Mode, addr.Type) if err != nil { // We have plently other codepaths that will detect and report // schema lookup errors before we'd reach this point, so we'll just From 7c0c2e952f597a357d5f4116f27929d3158d1a41 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 2 Nov 2021 13:26:00 -0500 Subject: [PATCH 310/644] command: Don't always update backend hash when fetching the saved backend The Meta.backend_C_r_S_unchanged() method was sadly a bit of a mess. It seems to have originally been used as a method to be called when the backend is not changing, with an extra assumption that if the configured backend's hash doesn't match the one in state, surely the hash should just be updated as an option might have been moved to command line flags. However, this function was used throughout this file as 'the method to load the initialized (but not necessarily configured) backend', regardless of whether or not it is the same (unchanged). This is in addition to Meta.backendFromState(), which is used to load the same thing except in the main codepath of 'init -backend=false'. These changes separate the concerns of backend_C_r_S_unchanged() by 1) Fetching the saved backend (savedBackend()) 2) Updating the hash value in the backend cache when appropriate (either by leaving it to the caller to do themselves or by calling updateSavedupdateSavedBackendHash()) This allows migration codepaths to *not* update the hash value until after a migration has successfully taken place. --- internal/command/meta_backend.go | 71 +++++++++++++++++++++----------- 1 file changed, 48 insertions(+), 23 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 1729b42d9458..2ebc61c6f070 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -636,20 +636,37 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di // Potentially changing a backend configuration case c != nil && !s.Backend.Empty(): - // We are not going to migrate if were not initializing and the hashes - // match indicating that the stored config is valid. If we are - // initializing, then we also assume the the backend config is OK if - // the hashes match, as long as we're not providing any new overrides. + // We are not going to migrate if... + // + // We're not initializing + // AND the backend cache hash values match, indicating that the stored config is valid and completely unchanged. + // AND we're not providing any overrides. An override can mean a change overriding an unchanged backend block (indicated by the hash value). if (uint64(cHash) == s.Backend.Hash) && (!opts.Init || opts.ConfigOverride == nil) { log.Printf("[TRACE] Meta.Backend: using already-initialized, unchanged %q backend configuration", c.Type) - return m.backend_C_r_S_unchanged(c, cHash, sMgr) + return m.savedBackend(sMgr) } - // If our configuration is the same, then we're just initializing - // a previously configured remote backend. + // If our configuration (the result of both the literal configuration and given + // -backend-config options) is the same, then we're just initializing a previously + // configured backend. The literal configuration may differ, however, so while we + // don't need to migrate, we update the backend cache hash value. if !m.backendConfigNeedsMigration(c, s.Backend) { log.Printf("[TRACE] Meta.Backend: using already-initialized %q backend configuration", c.Type) - return m.backend_C_r_S_unchanged(c, cHash, sMgr) + savedBackend, moreDiags := m.savedBackend(sMgr) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, diags + } + + // It's possible for a backend to be unchanged, and the config itself to + // have changed by moving a parameter from the config to `-backend-config` + // In this case, we update the Hash. + moreDiags = m.updateSavedBackendHash(cHash, sMgr) + if moreDiags.HasErrors() { + return nil, diags + } + + return savedBackend, diags } log.Printf("[TRACE] Meta.Backend: backend configuration has changed (from type %q to type %q)", s.Backend.Type, c.Type) @@ -810,7 +827,7 @@ func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.Local } // Initialize the configured backend - b, moreDiags := m.backend_C_r_S_unchanged(c, cHash, sMgr) + b, moreDiags := m.savedBackend(sMgr) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { return nil, diags @@ -1008,7 +1025,7 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista } // Grab the existing backend - oldB, oldBDiags := m.backend_C_r_S_unchanged(c, cHash, sMgr) + oldB, oldBDiags := m.savedBackend(sMgr) diags = diags.Append(oldBDiags) if oldBDiags.HasErrors() { return nil, diags @@ -1074,23 +1091,16 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista return b, diags } -// Initiailizing an unchanged saved backend -func (m *Meta) backend_C_r_S_unchanged(c *configs.Backend, cHash int, sMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) { +// Initializing a saved backend from the cache file (legacy state file) +// +// TODO: This is extremely similar to Meta.backendFromState() but for legacy reasons this is the +// function used by the migration APIs within this file. The other handles 'init -backend=false', +// specifically. +func (m *Meta) savedBackend(sMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics s := sMgr.State() - // it's possible for a backend to be unchanged, and the config itself to - // have changed by moving a parameter from the config to `-backend-config` - // In this case we only need to update the Hash. - if c != nil && s.Backend.Hash != uint64(cHash) { - s.Backend.Hash = uint64(cHash) - if err := sMgr.WriteState(s); err != nil { - diags = diags.Append(err) - return nil, diags - } - } - // Get the backend f := backendInit.Backend(s.Backend.Type) if f == nil { @@ -1129,6 +1139,21 @@ func (m *Meta) backend_C_r_S_unchanged(c *configs.Backend, cHash int, sMgr *clis return b, diags } +func (m *Meta) updateSavedBackendHash(cHash int, sMgr *clistate.LocalState) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + s := sMgr.State() + + if s.Backend.Hash != uint64(cHash) { + s.Backend.Hash = uint64(cHash) + if err := sMgr.WriteState(s); err != nil { + diags = diags.Append(err) + } + } + + return diags +} + //------------------------------------------------------------------- // Reusable helper functions for backend management //------------------------------------------------------------------- From ece80c0fc2f9c9d830b036f735cb94187246dc60 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 2 Nov 2021 15:34:49 -0500 Subject: [PATCH 311/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 577e605930df..4597dcbd50e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,7 @@ BUG FIXES: * cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) * cli: Prevent applying a stale planfile when there was no previous state ([#29755](https://github.com/hashicorp/terraform/issues/29755)) * cli: Improve list nested attribute rendering [GH-29827] +* command: Fixed an issue where the backend cache hash value was being updated too early in backend initialization/migrate flows, causing situations where `init` would not properly restart a backend migration process if that process failed previously. [GH-29860] ## Previous Releases From 1da7031855b0089ae067e4456738dd64f21973ba Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Mon, 1 Nov 2021 20:42:54 -0400 Subject: [PATCH 312/644] cloud: Add tags to workspace if necessary when fetching state --- internal/cloud/backend.go | 53 +++++++-- .../e2e/migrate_state_multi_to_tfc_test.go | 103 ++++++++++++++++++ internal/cloud/tfe_client_mock.go | 2 +- 3 files changed, 150 insertions(+), 8 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 90bce8fb6886..cff9d7e2bcf7 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -529,15 +529,9 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { // Create a workspace options := tfe.WorkspaceCreateOptions{ Name: tfe.String(name), + Tags: b.WorkspaceMapping.tfeTags(), } - var tags []*tfe.Tag - for _, tag := range b.WorkspaceMapping.Tags { - t := tfe.Tag{Name: tag} - tags = append(tags, &t) - } - options.Tags = tags - log.Printf("[TRACE] cloud: Creating Terraform Cloud workspace %s/%s", b.organization, name) workspace, err = b.client.Workspaces.Create(context.Background(), b.organization, options) if err != nil { @@ -569,6 +563,17 @@ func (b *Cloud) StateMgr(name string) (statemgr.Full, error) { } } + if b.workspaceTagsRequireUpdate(workspace, b.WorkspaceMapping) { + options := tfe.WorkspaceAddTagsOptions{ + Tags: b.WorkspaceMapping.tfeTags(), + } + log.Printf("[TRACE] cloud: Adding tags for Terraform Cloud workspace %s/%s", b.organization, name) + err = b.client.Workspaces.AddTags(context.Background(), workspace.ID, options) + if err != nil { + return nil, fmt.Errorf("Error updating workspace %s: %v", name, err) + } + } + // This is a fallback error check. Most code paths should use other // mechanisms to check the version, then set the ignoreVersionConflict // field to true. This check is only in place to ensure that we don't @@ -913,6 +918,25 @@ func (b *Cloud) cliColorize() *colorstring.Colorize { } } +func (b *Cloud) workspaceTagsRequireUpdate(workspace *tfe.Workspace, workspaceMapping WorkspaceMapping) bool { + if workspaceMapping.Strategy() != WorkspaceTagsStrategy { + return false + } + + existingTags := map[string]struct{}{} + for _, t := range workspace.TagNames { + existingTags[t] = struct{}{} + } + + for _, tag := range workspaceMapping.Tags { + if _, ok := existingTags[tag]; !ok { + return true + } + } + + return false +} + type WorkspaceMapping struct { Name string Tags []string @@ -941,6 +965,21 @@ func (wm WorkspaceMapping) Strategy() workspaceStrategy { } } +func (wm WorkspaceMapping) tfeTags() []*tfe.Tag { + var tags []*tfe.Tag + + if wm.Strategy() != WorkspaceTagsStrategy { + return tags + } + + for _, tag := range wm.Tags { + t := tfe.Tag{Name: tag} + tags = append(tags, &t) + } + + return tags +} + func generalError(msg string, err error) error { var diags tfdiags.Diagnostics diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 5e1531330fb9..6e1bd40d931f 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -12,6 +12,7 @@ import ( expect "github.com/Netflix/go-expect" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/e2e" + tfversion "github.com/hashicorp/terraform/version" ) func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { @@ -360,6 +361,108 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { } }, }, + "migrating multiple workspaces to cloud using tags strategy; existing workspaces": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "new", "identity"}, + expectedCmdOutput: `Created and switched to workspace "identity"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "new", "billing"}, + expectedCmdOutput: `Created and switched to workspace "billing"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "select", "default"}, + expectedCmdOutput: `Switched to workspace "default".`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("identity"), + TerraformVersion: tfe.String(tfversion.String()), + }) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String("billing"), + TerraformVersion: tfe.String(tfversion.String()), + }) + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, + userInput: []string{"dev", "1", "app-*", "1"}, + postInputOutput: []string{ + `Would you like to rename your workspaces?`, + "What pattern would you like to add to all your workspaces?", + "The currently selected workspace (default) does not exist.", + "Terraform Cloud has been successfully initialized!"}, + }, + { + command: []string{"workspace", "select", "app-dev"}, + expectedCmdOutput: `Switched to workspace "app-dev".`, + }, + { + command: []string{"workspace", "select", "app-billing"}, + expectedCmdOutput: `Switched to workspace "app-billing".`, + }, + { + command: []string{"workspace", "select", "app-identity"}, + expectedCmdOutput: `Switched to workspace "app-identity".`, + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 3 { + t.Fatalf("Expected the number of workspaecs to be 3, but got %d", len(wsList.Items)) + } + expectedWorkspaceNames := []string{"app-billing", "app-dev", "app-identity"} + for _, ws := range wsList.Items { + hasName := false + for _, expectedNames := range expectedWorkspaceNames { + if expectedNames == ws.Name { + hasName = true + } + } + if !hasName { + t.Fatalf("Worksapce %s is not in the expected list of workspaces", ws.Name) + } + } + }, + }, } for name, tc := range cases { diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index ecc3b9addb7c..929e39b89a47 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1391,7 +1391,7 @@ func (m *MockWorkspaces) Tags(ctx context.Context, workspaceID string, options t } func (m *MockWorkspaces) AddTags(ctx context.Context, workspaceID string, options tfe.WorkspaceAddTagsOptions) error { - panic("not implemented") + return nil } func (m *MockWorkspaces) RemoveTags(ctx context.Context, workspaceID string, options tfe.WorkspaceRemoveTagsOptions) error { From 938c0aeee93e8df5ab97bcaaeb46a3b6e363a8fb Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 2 Nov 2021 14:20:16 -0700 Subject: [PATCH 313/644] Update CHANGELOG.md --- CHANGELOG.md | 39 ++------------------------------------- 1 file changed, 2 insertions(+), 37 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4597dcbd50e5..f61750fda27a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,46 +1,11 @@ -## 1.1.0 (Unreleased) +## 1.2.0 (Unreleased) -UPGRADE NOTES: - -* Terraform on macOS now requires macOS 10.13 High Sierra or later; Older macOS versions are no longer supported. -* The `terraform graph` command no longer supports `-type=validate` and `-type=eval` options. The validate graph is always the same as the plan graph anyway, and the "eval" graph was just an implementation detail of the `terraform console` command. The default behavior of creating a plan graph should be a reasonable replacement for both of the removed graph modes. (Please note that `terraform graph` is not covered by the Terraform v1.0 compatibility promises, because its behavior inherently exposes Terraform Core implementation details, so we recommend it only for interactive debugging tasks and not for use in automation.) -* `terraform apply` with a previously-saved plan file will now verify that the provider plugin packages used to create the plan fully match the ones used during apply, using the same checksum scheme that Terraform normally uses for the dependency lock file. Previously Terraform was checking consistency of plugins from a plan file using a legacy mechanism which covered only the main plugin executable, not any other files that might be distributed alongside in the plugin package. - - This additional check should not affect typical plugins that conform to the expectation that a plugin package's contents are immutable once released, but may affect a hypothetical in-house plugin that intentionally modifies extra files in its package directory somehow between plan and apply. If you have such a plugin, you'll need to change its approach to store those files in some other location separate from the package directory. This is a minor compatibility break motivated by increasing the assurance that plugins have not been inadvertently or maliciously modified between plan and apply. - -NEW FEATURES: - -* `moved` blocks for refactoring within modules: Module authors can now record in module source code whenever they've changed the address of a resource or resource instance, and then during planning Terraform will automatically migrate existing objects in the state to new addresses. - - This therefore avoids the need for module users to manually run `terraform state mv` after upgrading to a newer module version, as long as the change is expressible as static configuration. However, `terraform state mv` remains available for use in more complex migration situations that are not well-suited to declarative configuration. -* A new `cloud` option in the `terraform` settings block adds a more native integration for Terraform Cloud and its [CLI-driven run workflow](https://www.terraform.io/docs/cloud/run/cli.html). The Cloud integration includes several enhancements, including per-run variable support using the `-var` flag, the ability to map Terraform Cloud workspaces to the current configuration via [Workspace Tags](https://www.terraform.io/docs/cloud/api/workspaces.html#get-tags), and an improved user experience for Terraform Cloud/Enterprise users with actionable error messages and prompts. ([#29826](https://github.com/hashicorp/terraform/pull/29826)) -* `terraform plan` and `terraform apply`: When Terraform plans to destroy a resource instance due to it no longer being declared in the configuration, the proposed plan output will now include a note hinting at what situation prompted that proposal, so you can more easily see what configuration change might avoid the object being destroyed. ([#29637](https://github.com/hashicorp/terraform/pull/29637)) -* `terraform plan` and `terraform apply`: When Terraform automatically moves a singleton resource instance to index zero or vice-versa in response to adding or removing `count`, it'll report explicitly that it did so as part of the plan output. ([#29605](https://github.com/hashicorp/terraform/pull/29605)) -* config: a new `type()` function, available only in `terraform console`. ([#28501](https://github.com/hashicorp/terraform/issues/28501)) - -ENHANCEMENTS: - -* config: Terraform now checks the syntax of and normalizes module source addresses (the `source` argument in `module` blocks) during configuration decoding rather than only at module installation time. This is largely just an internal refactoring, but a visible benefit of this change is that the `terraform init` messages about module downloading will now show the canonical module package address Terraform is downloading from, after interpreting the special shorthands for common cases like GitHub URLs. ([#28854](https://github.com/hashicorp/terraform/issues/28854)) -* config: A new variable attribute `nullable`, which defines whether a variable can be null within a module. Setting `nullable` to `false` ensures that a variable value will not be `null`, and that a non-null default is used when `null` is given as a module argument [GH-29832] -* `terraform plan` and `terraform apply`: Terraform will now report explicitly in the UI if it automatically moves a resource instance to a new address as a result of adding or removing the `count` argument from an existing resource. For example, if you previously had `resource "aws_subnet" "example"` _without_ `count`, you might have `aws_subnet.example` already bound to a remote object in your state. If you add `count = 1` to that resource then Terraform would previously silently rebind the object to `aws_subnet.example[0]` as part of planning, whereas now Terraform will mention that it did so explicitly in the plan description. ([#29605](https://github.com/hashicorp/terraform/issues/29605)) -* `terraform workspace delete`: will now allow deleting a workspace whose state contains only data resource instances and output values, without running `terraform destroy` first. Previously the presence of data resources would require using `-force` to override the safety check guarding against accidentally forgetting about remote objects, but a data resource is not responsible for the management of its associated remote object(s) anyway. ([#29754](https://github.com/hashicorp/terraform/issues/29754)) -* provisioner/remote-exec and provisioner/file: When using SSH agent authentication mode on Windows, Terraform can now detect and use [the Windows 10 built-in OpenSSH Client](https://devblogs.microsoft.com/powershell/using-the-openssh-beta-in-windows-10-fall-creators-update-and-windows-server-1709/)'s SSH Agent, when available, in addition to the existing support for the third-party solution [Pageant](https://documentation.help/PuTTY/pageant.html) that was already supported. ([#29747](https://github.com/hashicorp/terraform/issues/29747)) - -BUG FIXES: - -* backend/oss: Flatten `assume_role` block attributes, so that they may be more easily represented in a compatible way with `terraform_remote_state` [GH-29307] -* config: Fixed a bug in which `ignore_changes = all` would not work in override files [GH-29849] -* core: Fixed an issue where provider configuration input variables were not properly merging with values in configuration ([#29000](https://github.com/hashicorp/terraform/issues/29000)) -* core: Reduce scope of dependencies that may defer reading of data sources when using `depends_on` or directly referencing managed resources ([#29682](https://github.com/hashicorp/terraform/issues/29682)) -* cli: Blocks using SchemaConfigModeAttr in the provider SDK can now represented in the plan json output ([#29522](https://github.com/hashicorp/terraform/issues/29522)) -* cli: Prevent applying a stale planfile when there was no previous state ([#29755](https://github.com/hashicorp/terraform/issues/29755)) -* cli: Improve list nested attribute rendering [GH-29827] -* command: Fixed an issue where the backend cache hash value was being updated too early in backend initialization/migrate flows, causing situations where `init` would not properly restart a backend migration process if that process failed previously. [GH-29860] ## Previous Releases For information on prior major and minor releases, see their changelogs: +* [v1.1](https://github.com/hashicorp/terraform/blob/v1.1/CHANGELOG.md) * [v1.0](https://github.com/hashicorp/terraform/blob/v1.0/CHANGELOG.md) * [v0.15](https://github.com/hashicorp/terraform/blob/v0.15/CHANGELOG.md) * [v0.14](https://github.com/hashicorp/terraform/blob/v0.14/CHANGELOG.md) From ca6d3cf50f5cf92f168069fa17846d6b5d0622ea Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 2 Nov 2021 17:29:03 -0400 Subject: [PATCH 314/644] update go-cty cty: The documented definition and comparison logic of cty.Number is now refined to acknowledge that its true range is limited only to values that have both a binary floating point and decimal representation, because cty values are primarily designed to traverse JSON serialization where numbers are always defined as decimal strings. In particular, that means that two cty.Number values now always compare as equal if their representation in JSON (under cty's own JSON encoder) would be equal, even though the decimal approximation we use for that conversion is slightly lossy. This pragmatic compromise avoids confusing situations where a round-trip through JSON serialization (or other serializations that use the same number format) may produce a value that doesn't compare equal to the original. This new definition of equals should not cause any significant behavior change for any integer in our in-memory storage range, but may cause some fractional values to compare equal where they didn't before if they differ only by a small fraction. --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index e0dc22906251..2742ca871a07 100644 --- a/go.mod +++ b/go.mod @@ -77,7 +77,7 @@ require ( github.com/tombuildsstuff/giovanni v0.15.1 github.com/xanzy/ssh-agent v0.3.1 github.com/xlab/treeprint v0.0.0-20161029104018-1d6e34225557 - github.com/zclconf/go-cty v1.9.1 + github.com/zclconf/go-cty v1.10.0 github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b github.com/zclconf/go-cty-yaml v1.0.2 go.etcd.io/etcd v0.5.0-alpha.5.0.20210428180535-15715dcf1ace diff --git a/go.sum b/go.sum index addfc11f7f0a..168d04de356a 100644 --- a/go.sum +++ b/go.sum @@ -654,8 +654,8 @@ github.com/zclconf/go-cty v1.0.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLE github.com/zclconf/go-cty v1.1.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.2.0/go.mod h1:hOPWgoHbaTUnI5k4D2ld+GRpFJSCe6bCM7m1q/N4PQ8= github.com/zclconf/go-cty v1.8.0/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk= -github.com/zclconf/go-cty v1.9.1 h1:viqrgQwFl5UpSxc046qblj78wZXVDFnSOufaOTER+cc= -github.com/zclconf/go-cty v1.9.1/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk= +github.com/zclconf/go-cty v1.10.0 h1:mp9ZXQeIcN8kAwuqorjH+Q+njbJKjLrvB2yIh4q7U+0= +github.com/zclconf/go-cty v1.10.0/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk= github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b h1:FosyBZYxY34Wul7O/MSKey3txpPYyCqVO5ZyceuQJEI= github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b/go.mod h1:ZRKQfBXbGkpdV6QMzT3rU1kSTAnfu1dO8dPKjYprgj8= github.com/zclconf/go-cty-yaml v1.0.2 h1:dNyg4QLTrv2IfJpm7Wtxi55ed5gLGOlPrZ6kMd51hY0= From e0a271660113ea4c20dea91f78f2a213b8203da8 Mon Sep 17 00:00:00 2001 From: xiaozhu36 Date: Wed, 3 Nov 2021 11:17:26 +0800 Subject: [PATCH 315/644] backend/oss: Removes the ConflictWith tag which on the attributes assume_role* to fix the incompatible error --- internal/backend/remote-state/oss/backend.go | 59 ++++++++++--------- .../language/settings/backends/oss.html.md | 6 +- 2 files changed, 33 insertions(+), 32 deletions(-) diff --git a/internal/backend/remote-state/oss/backend.go b/internal/backend/remote-state/oss/backend.go index cdc660bf6625..2d488ce14cde 100644 --- a/internal/backend/remote-state/oss/backend.go +++ b/internal/backend/remote-state/oss/backend.go @@ -36,11 +36,10 @@ import ( // Deprecated in favor of flattening assume_role_* options func deprecatedAssumeRoleSchema() *schema.Schema { return &schema.Schema{ - Type: schema.TypeSet, - Optional: true, - ConflictsWith: []string{"assume_role_role_arn", "assume_role_session_name", "assume_role_policy", "assume_role_session_expiration"}, - MaxItems: 1, - Deprecated: "use assume_role_* options instead", + Type: schema.TypeSet, + Optional: true, + MaxItems: 1, + Deprecated: "use assume_role_* options instead", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "role_arn": { @@ -219,30 +218,26 @@ func New() backend.Backend { }, "assume_role": deprecatedAssumeRoleSchema(), "assume_role_role_arn": { - Type: schema.TypeString, - Optional: true, - ConflictsWith: []string{"assume_role"}, - Description: "The ARN of a RAM role to assume prior to making API calls.", - DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), + Type: schema.TypeString, + Optional: true, + Description: "The ARN of a RAM role to assume prior to making API calls.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_ARN", ""), }, "assume_role_session_name": { - Type: schema.TypeString, - Optional: true, - ConflictsWith: []string{"assume_role"}, - Description: "The session name to use when assuming the role.", - DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), + Type: schema.TypeString, + Optional: true, + Description: "The session name to use when assuming the role.", + DefaultFunc: schema.EnvDefaultFunc("ALICLOUD_ASSUME_ROLE_SESSION_NAME", ""), }, "assume_role_policy": { - Type: schema.TypeString, - Optional: true, - ConflictsWith: []string{"assume_role"}, - Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", + Type: schema.TypeString, + Optional: true, + Description: "The permissions applied when assuming a role. You cannot use this policy to grant permissions which exceed those of the role that is being assumed.", }, "assume_role_session_expiration": { - Type: schema.TypeInt, - Optional: true, - ConflictsWith: []string{"assume_role"}, - Description: "The time after which the established session for assuming role expires.", + Type: schema.TypeInt, + Optional: true, + Description: "The time after which the established session for assuming role expires.", ValidateFunc: func(v interface{}, k string) ([]string, []error) { min := 900 max := 3600 @@ -324,7 +319,18 @@ func (b *Backend) configure(ctx context.Context) error { sessionExpiration = (int)(expiredSeconds.(float64)) } - if v, ok := d.GetOk("assume_role"); ok { + if v, ok := d.GetOk("assume_role_role_arn"); ok && v.(string) != "" { + roleArn = v.(string) + if v, ok := d.GetOk("assume_role_session_name"); ok { + sessionName = v.(string) + } + if v, ok := d.GetOk("assume_role_policy"); ok { + policy = v.(string) + } + if v, ok := d.GetOk("assume_role_session_expiration"); ok { + sessionExpiration = v.(int) + } + } else if v, ok := d.GetOk("assume_role"); ok { // deprecated assume_role block for _, v := range v.(*schema.Set).List() { assumeRole := v.(map[string]interface{}) @@ -337,11 +343,6 @@ func (b *Backend) configure(ctx context.Context) error { policy = assumeRole["policy"].(string) sessionExpiration = assumeRole["session_expiration"].(int) } - } else { - roleArn = d.Get("assume_role_role_arn").(string) - sessionName = d.Get("assume_role_session_name").(string) - policy = d.Get("assume_role_policy").(string) - sessionExpiration = d.Get("assume_role_session_expiration").(int) } if sessionName == "" { diff --git a/website/docs/language/settings/backends/oss.html.md b/website/docs/language/settings/backends/oss.html.md index 698e41c4612f..e2a0adc12b8e 100644 --- a/website/docs/language/settings/backends/oss.html.md +++ b/website/docs/language/settings/backends/oss.html.md @@ -98,11 +98,11 @@ The following configuration options or environment variables are supported: * `profile` - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable. * `assume_role_role_arn` - (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable `ALICLOUD_ASSUME_ROLE_ARN`. Terraform executes configuration on account with provided credentials. -* `assume_role_policy` - (Optional, Available in 1.1.0+ A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. +* `assume_role_policy` - (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. * `assume_role_session_name` - (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. -* `assume_role_session_expiration` - (Optional, Available in 1.1.0+ The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. +* `assume_role_session_expiration` - (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. -* `assume_role` - (**Deprecated as of 1.1.0+**, Available in 0.12.6+) If provided with a role ARN, will attempt to assume this role using the supplied credentials. +* `assume_role` - (**Deprecated as of 1.1.0+**, Available in 0.12.6+) If provided with a role ARN, will attempt to assume this role using the supplied credentials. It will be ignored when `assume_role_role_arn` is specified. **Deprecated in favor of flattening assume_role_\* options** From f80b2177c899246ae724e43ee5d64eca801d5e03 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 3 Nov 2021 00:38:05 -0500 Subject: [PATCH 316/644] cloud: Tweak multi-to-multi migration UX Note these change do break the internal/cloud/e2e tests; they are in a sad state that needs adjusting anyway, so I'm not updating them for these changes at this time. --- internal/command/meta_backend_migrate.go | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 449c8303fed3..e708cb380219 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -729,7 +729,7 @@ func (m *Meta) promptMultiStateMigrationPattern(sourceType string) (string, erro pattern, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "backend-migrate-multistate-to-tfc-pattern", - Query: fmt.Sprintf("[reset][bold][yellow]%s[reset]", "What pattern would you like to add to all your workspaces?"), + Query: fmt.Sprintf("[reset][bold][yellow]%s[reset]", "How would you like to rename your workspaces?"), Description: strings.TrimSpace(tfcInputBackendMigrateMultiToMultiPattern), }) if err != nil { @@ -797,14 +797,11 @@ Please use the API to do this: https://www.terraform.io/docs/cloud/api/state-ver ` const tfcInputBackendMigrateMultiToMultiPattern = ` -If you choose to NOT rename your workspaces, just input "*". - -The asterisk "*" represents your workspace name. Here are a few examples -if a workspace was named 'prod': -* input: 'app-*'; output: 'app-prod' -* input: '*-app', output: 'prod-app' -* input: 'app-*-service', output: 'app-prod-service' -* input: '*'; output: 'prod' +Enter a pattern with an asterisk (*) to rename all workspaces based on their +previous names. The asterisk represents the current workspace name. + +For example, if a workspace is currently named 'prod', the pattern 'app-*' would yield +'app-prod' for a new workspace name; 'app-*-region1' would yield 'app-prod-region1'. ` const tfcInputBackendMigrateMultiToMulti = ` @@ -818,7 +815,7 @@ across all configurations used within an organization. A typical strategy to sta For more information on workspace naming, see https://www.terraform.io/docs/cloud/workspaces/naming.html -1. Yes, rename workspaces according to a pattern. +1. Yes, I'd like to rename all workspaces according to a pattern I will provide. 2. No, I would not like to rename my workspaces. Migrate them as currently named. ` From c3bf5d45128954c555ae2d30e1d6300016f77ee9 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 3 Nov 2021 10:59:09 -0500 Subject: [PATCH 317/644] cloud: Automatically select renamed current workspace After migrating to TFC with renamed workspaces, automatically select what was the previous current workspace on behalf of the user. We don't need to make the user reselect. --- internal/command/meta_backend_migrate.go | 32 +++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index e708cb380219..3c022a88a59b 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -613,6 +613,12 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspaces []string) error { log.Print("[TRACE] backendMigrateState: migrating all named workspaces") + currentWorkspace, err := m.Workspace() + if err != nil { + return err + } + newCurrentWorkspace := "" + // This map is used later when doing the migration per source/destination. // If a source has 'default', then we ask what the new name should be. // And further down when we actually run state migration for each @@ -653,15 +659,35 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa return fmt.Errorf(strings.TrimSpace( errMigrateMulti), name, opts.SourceType, opts.DestinationType, err) } + + if currentWorkspace == opts.sourceWorkspace { + newCurrentWorkspace = opts.destinationWorkspace + } } - // After migrating multiple workspaces, we want to ensure that a workspace is - // set or we prompt the user to set a workspace. - err = m.selectWorkspace(opts.Destination) + // After migrating multiple workspaces, we need to reselect the current workspace as it may + // have been renamed. Query the backend first to be sure it now exists, and if it does, + // select it. + workspaces, err := opts.Destination.Workspaces() if err != nil { return err } + for _, name := range workspaces { + if name == newCurrentWorkspace { + if err = m.SetWorkspace(name); err != nil { + return err + } + return nil + } + } + + // If we couldn't select the workspace automatically from the backend (maybe it was empty + // and wasn't migrated, for instance), ask the user to select one. + if err = m.selectWorkspace(opts.Destination); err != nil { + return err + } + return nil } From 6f25ad3e176f89b679703f457535428e0bf7424d Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 3 Nov 2021 11:22:46 -0500 Subject: [PATCH 318/644] cloud: Display the newly renamed workspaces after a migration --- internal/command/meta_backend_migrate.go | 37 +++++++++++++++++++----- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 3c022a88a59b..2999a8c5973d 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -1,6 +1,7 @@ package command import ( + "bytes" "context" "errors" "fmt" @@ -666,28 +667,48 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa } // After migrating multiple workspaces, we need to reselect the current workspace as it may - // have been renamed. Query the backend first to be sure it now exists, and if it does, - // select it. + // have been renamed. Query the backend first to be sure it now exists. workspaces, err := opts.Destination.Workspaces() if err != nil { return err } + var workspacePresent bool for _, name := range workspaces { if name == newCurrentWorkspace { - if err = m.SetWorkspace(name); err != nil { - return err - } - return nil + workspacePresent = true } } // If we couldn't select the workspace automatically from the backend (maybe it was empty - // and wasn't migrated, for instance), ask the user to select one. - if err = m.selectWorkspace(opts.Destination); err != nil { + // and wasn't migrated, for instance), ask the user to select one instead and be done. + if !workspacePresent { + if err = m.selectWorkspace(opts.Destination); err != nil { + return err + } + return nil + } + + // The newly renamed current workspace is present, so we'll automatically select it for the + // user, as well as display the equivalent of 'workspace list' to show how the workspaces + // were changed (as well as the newly selected current workspace). + if err = m.SetWorkspace(newCurrentWorkspace); err != nil { return err } + m.Ui.Output(m.Colorize().Color("[reset][bold]Migration complete! Your workspaces are as follows:[reset]")) + var out bytes.Buffer + for _, name := range workspaces { + if name == newCurrentWorkspace { + out.WriteString("* ") + } else { + out.WriteString(" ") + } + out.WriteString(name + "\n") + } + + m.Ui.Output(out.String()) + return nil } From 779c958fbf7609b20b2665551e1d2e98c3f932a8 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Wed, 3 Nov 2021 14:41:55 -0500 Subject: [PATCH 319/644] cloud: Add streamlined 'remote' backend state migration path For Terraform Cloud users using the 'remote' backend, the existing 'pattern' prompt should work just fine - but because their workspaces are already present in TFC, the 'migration' here is really just realigning their local workspaces with Terraform Cloud. Instead of forcing users to do the mental gymnastics of what it means to migrate from 'prefix' - and because their remote workspaces probably already exist and already conform to Terraform Cloud's naming concerns - streamline the process for them and calculate the necessary pattern to migrate as-is, without any user intervention necessary. --- internal/backend/remote/backend.go | 11 ++++ internal/command/meta_backend.go | 6 +- internal/command/meta_backend_migrate.go | 76 +++++++++++++++++++++--- 3 files changed, 83 insertions(+), 10 deletions(-) diff --git a/internal/backend/remote/backend.go b/internal/backend/remote/backend.go index bc4c03175b19..4f51966c5159 100644 --- a/internal/backend/remote/backend.go +++ b/internal/backend/remote/backend.go @@ -569,6 +569,17 @@ func (b *Remote) workspaces() ([]string, error) { return names, nil } +// WorkspaceNamePattern provides an appropriate workspace renaming pattern for backend migration +// purposes (handled outside of this package), based on previous usage of this backend with the +// 'prefix' workspace functionality. As of this writing, see meta_backend.migrate.go +func (b *Remote) WorkspaceNamePattern() string { + if b.prefix != "" { + return b.prefix + "*" + } + + return "" +} + // DeleteWorkspace implements backend.Enhanced. func (b *Remote) DeleteWorkspace(name string) error { if b.workspace == "" && name == backend.DefaultStateName { diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 2ebc61c6f070..005237845211 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -1002,7 +1002,7 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista if output { // Notify the user m.Ui.Output(m.Colorize().Color(fmt.Sprintf( - "[reset]%s\n\n", + "[reset]%s\n", strings.TrimSpace(outputBackendReconfigure)))) } @@ -1021,7 +1021,9 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista if c.Type == "cloud" { output = fmt.Sprintf(outputBackendMigrateChangeCloud, s.Backend.Type) } - m.Ui.Output(strings.TrimSpace(output)) + m.Ui.Output(m.Colorize().Color(fmt.Sprintf( + "[reset]%s\n", + strings.TrimSpace(output)))) } // Grab the existing backend diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 2999a8c5973d..508199ade870 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -13,6 +13,7 @@ import ( "strings" "github.com/hashicorp/terraform/internal/backend" + "github.com/hashicorp/terraform/internal/backend/remote" "github.com/hashicorp/terraform/internal/cloud" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" @@ -635,9 +636,32 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa defaultNewName[sourceWorkspaces[i]] = newName } } - pattern, err := m.promptMultiStateMigrationPattern(opts.SourceType) - if err != nil { - return err + + // Fetch the pattern that will be used to rename the workspaces for Terraform Cloud. + // + // * For the general case, this will be a pattern provided by the user. + // + // * Specifically for a migration from the "remote" backend using 'prefix', we will + // instead 'migrate' the workspaces using a pattern based on the old prefix+name, + // not allowing a user to accidentally input the wrong pattern to line up with + // what the the remote backend was already using before (which presumably already + // meets the naming considerations for Terraform Cloud). + // In other words, this is a fast-track migration path from the remote backend, retaining + // how things already are in Terraform Cloud with no user intervention needed. + pattern := "" + if remoteBackend, ok := opts.Source.(*remote.Remote); ok { + if err := m.promptRemotePrefixToCloudTagsMigration(opts); err != nil { + return err + } + pattern = remoteBackend.WorkspaceNamePattern() + log.Printf("[TRACE] backendMigrateTFC: Remote backend reports workspace name pattern as: %q", pattern) + } + + if pattern == "" { + pattern, err = m.promptMultiStateMigrationPattern(opts.SourceType) + if err != nil { + return err + } } // Go through each and migrate @@ -712,6 +736,27 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa return nil } +func (m *Meta) promptRemotePrefixToCloudTagsMigration(opts *backendMigrateOpts) error { + migrate := opts.force + if !migrate { + var err error + migrate, err = m.confirm(&terraform.InputOpts{ + Id: "backend-migrate-remote-multistate-to-cloud", + Query: "Do you wish to proceed?", + Description: strings.TrimSpace(tfcInputBackendMigrateRemoteMultiToCloud), + }) + if err != nil { + return fmt.Errorf("Error asking for state migration action: %s", err) + } + } + + if !migrate { + return fmt.Errorf("Migration aborted by user.") + } + + return nil +} + // Multi-state to single state. func (m *Meta) promptMultiToSingleCloudMigration(opts *backendMigrateOpts) error { migrate := opts.force @@ -867,11 +912,26 @@ For more information on workspace naming, see https://www.terraform.io/docs/clou ` const tfcInputBackendMigrateMultiToSingle = ` -The previous backend %[1]q has multiple workspaces, but Terraform Cloud has been -configured to use a single workspace (%[2]q). By continuing, you will only -migrate your current workspace. If you wish to migrate all workspaces from the -previous backend, use the 'tags' strategy in your workspace configuration block -instead. +The previous backend %[1]q has multiple workspaces, but Terraform Cloud has +been configured to use a single workspace (%[2]q). By continuing, you will +only migrate your current workspace. If you wish to migrate all workspaces +from the previous backend, you may cancel this operation and use the 'tags' +strategy in your workspace configuration block instead. + +Enter "yes" to proceed or "no" to cancel. +` + +const tfcInputBackendMigrateRemoteMultiToCloud = ` +When migrating from the 'remote' backend to Terraform's native integration +with Terraform Cloud, Terraform will automatically create or use existing +workspaces based on the previous backend configuration's 'prefix' value. + +When the migration is complete, workspace names in Terraform will match the +fully qualified Terraform Cloud workspace name. If necessary, the workspace +tags configured in the 'cloud' option block will be added to the associated +Terraform Cloud workspaces. + +Enter "yes" to proceed or "no" to cancel. ` const inputBackendMigrateEmpty = ` From 8367c049c8c23e39fd94c871b902daa391359116 Mon Sep 17 00:00:00 2001 From: AJ Jordan Date: Thu, 4 Nov 2021 16:19:35 -0400 Subject: [PATCH 320/644] Fix typo in 0.13 upgrade guide --- website/upgrade-guides/0-13.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/upgrade-guides/0-13.html.markdown b/website/upgrade-guides/0-13.html.markdown index 3c1b033d9d80..96fda4b96972 100644 --- a/website/upgrade-guides/0-13.html.markdown +++ b/website/upgrade-guides/0-13.html.markdown @@ -69,7 +69,7 @@ distribution packages into specific local filesystem locations. Terraform v0.13 introduces a new hierarchical namespace for providers that allows specifying both HashiCorp-maintained and community-maintained providers as dependencies of a module, with community providers distributed from other -namespaces on [Terraform Registry](https://registry.terraform.io/) from a +namespaces on [Terraform Registry](https://registry.terraform.io/) or from a third-party provider registry. In order to establish the hierarchical namespace, Terraform now requires From b838a9302375498fda49fdc4551bd22c434fa3a8 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 5 Nov 2021 10:51:59 -0400 Subject: [PATCH 321/644] Add cidr block output example to setproduct function page --- .../language/functions/setproduct.html.md | 87 +++++++++++++++---- 1 file changed, 72 insertions(+), 15 deletions(-) diff --git a/website/docs/language/functions/setproduct.html.md b/website/docs/language/functions/setproduct.html.md index 030ab2c3207e..dfdd0a9b427a 100644 --- a/website/docs/language/functions/setproduct.html.md +++ b/website/docs/language/functions/setproduct.html.md @@ -144,10 +144,7 @@ variable "subnets" { } ``` -If the goal is to create each of the defined subnets per each of the defined -networks, creating the top-level networks can directly use `var.networks` -because it's already in a form where the resulting instances match one-to-one -with map elements: +If the goal is to create each of the defined subnets per each of the defined networks, creating the top-level networks can directly use `var.networks` because it is already in a form where the resulting instances match one-to-one with map elements: ```hcl resource "aws_vpc" "example" { @@ -157,15 +154,12 @@ resource "aws_vpc" "example" { } ``` -However, in order to declare all of the _subnets_ with a single `resource` -block, we must first produce a collection whose elements represent all of -the combinations of networks and subnets, so that each element itself -represents a subnet: +However, to declare all of the _subnets_ with a single `resource` block, you must first produce a collection whose elements represent all of the combinations of networks and subnets, so that each element itself represents a subnet: ```hcl locals { - # setproduct works with sets and lists, but our variables are both maps - # so we'll need to convert them first. + # setproduct works with sets and lists, but the variables are both maps + # so convert them first. networks = [ for key, network in var.networks : { key = key @@ -187,7 +181,7 @@ locals { subnet_key = pair[1].key network_id = aws_vpc.example[pair[0].key].id - # The cidr_block is derived from the corresponding network. See the + # The cidr_block is derived from the corresponding network. Refer to the # cidrsubnet function for more information on how this calculation works. cidr_block = cidrsubnet(pair[0].cidr_block, 4, pair[1].number) } @@ -195,8 +189,8 @@ locals { } resource "aws_subnet" "example" { - # local.network_subnets is a list, so we must now project it into a map - # where each key is unique. We'll combine the network and subnet keys to + # local.network_subnets is a list, so project it into a map + # where each key is unique. Combine the network and subnet keys to # produce a single unique key per instance. for_each = { for subnet in local.network_subnets : "${subnet.network_key}.${subnet.subnet_key}" => subnet @@ -208,8 +202,71 @@ resource "aws_subnet" "example" { } ``` -The above results in one subnet instance per combination of network and subnet -elements in the input variables. +The `network_subnets` block in the example above creates one subnet instance per combination of network and subnet elements in the input variables. So for this example input: + +``` hcl +networks = { + a = { + base_cidr_block = "10.1.0.0/16" + } + b = { + base_cidr_block = "10.2.0.0/16" + } +} +subnets = { + a = { + number = 1 + } + b = { + number = 2 + } + c = { + number = 3 + } +} +``` + +The `nework_subnets` block output would look similar to the following: + +``` hcl +{ + "cidr_block" = "10.1.16.0/20" + "network_id" = "vpc-0bfb00ca6173ea5aa" + "network_key" = "a" + "subnet_key" = "a" +}, +{ + "cidr_block" = "10.1.32.0/20" + "network_id" = "vpc-0bfb00ca6173ea5aa" + "network_key" = "a" + "subnet_key" = "b" +}, +{ + "cidr_block" = "10.1.48.0/20" + "network_id" = "vpc-0bfb00ca6173ea5aa" + "network_key" = "a" + "subnet_key" = "c" +}, +{ + "cidr_block" = "10.2.16.0/20" + "network_id" = "vpc-0d193e011f6211a7d" + "network_key" = "b" + "subnet_key" = "a" +}, +{ + "cidr_block" = "10.2.32.0/20" + "network_id" = "vpc-0d193e011f6211a7d" + "network_key" = "b" + "subnet_key" = "b" +}, +{ + "cidr_block" = "10.2.48.0/20" + "network_id" = "vpc-0d193e011f6211a7d" + "network_key" = "b" + "subnet_key" = "c" +}, +] +``` ## Related Functions From 5ac1074c541f6e2dff4e05459764cf9f943168d3 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 4 Nov 2021 16:20:51 -0700 Subject: [PATCH 322/644] main: Report version information for "interesting" dependencies We have a few dependencies that are such a significant part of Terraform's behavior that they will often be the root cause of or the solution to a bug reported against Terraform. As a small quality-of-life improvement to help with diagnosing those, we'll now report the selected versions for each of these so-called "interesting" dependencies as part of our initial trace log output during Terraform startup. The goal here is that when someone opens a bug report, and includes the trace log as our bug report template requests, we'll be able to see at a glance which versions of these dependencies were involved, instead of having to manually cross-reference in the go.mod file of the reported main Terraform CLI version. This does slightly grow the general overhead of the logs, but as long as we keep this set of interesting dependencies relatively small it shouldn't present any significant problem in typical usage. --- main.go | 3 +++ version/dependencies.go | 44 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 version/dependencies.go diff --git a/main.go b/main.go index 38c7141ccbce..1ffd8a343ade 100644 --- a/main.go +++ b/main.go @@ -79,6 +79,9 @@ func realMain() int { log.Printf( "[INFO] Terraform version: %s %s", Version, VersionPrerelease) + for _, depMod := range version.InterestingDependencies() { + log.Printf("[DEBUG] using %s %s", depMod.Path, depMod.Version) + } log.Printf("[INFO] Go runtime version: %s", runtime.Version()) log.Printf("[INFO] CLI args: %#v", os.Args) diff --git a/version/dependencies.go b/version/dependencies.go new file mode 100644 index 000000000000..155d7eafc3d6 --- /dev/null +++ b/version/dependencies.go @@ -0,0 +1,44 @@ +package version + +import "runtime/debug" + +// See the docs for InterestingDependencyVersions to understand what +// "interesting" is intended to mean here. We should keep this set relatively +// small to avoid bloating the logs too much. +var interestingDependencies = map[string]struct{}{ + "github.com/hashicorp/hcl/v2": {}, + "github.com/zclconf/go-cty": {}, + "github.com/hashicorp/go-tfe": {}, + "github.com/hashicorp/terraform-config-inspect": {}, + "github.com/hashicorp/terraform-svchost": {}, +} + +// InterestingDependencies returns the compiled-in module version info for +// a small number of dependencies that Terraform uses broadly and which we +// tend to upgrade relatively often as part of improvements to Terraform. +// +// The set of dependencies this reports might change over time if our +// opinions change about what's "interesting". This is here only to create +// a small number of extra annotations in a debug log to help us more easily +// cross-reference bug reports with dependency changelogs. +func InterestingDependencies() []*debug.Module { + info, ok := debug.ReadBuildInfo() + if !ok { + // Weird to not be built in module mode, but not a big deal. + return nil + } + + ret := make([]*debug.Module, 0, len(interestingDependencies)) + + for _, mod := range info.Deps { + if _, ok := interestingDependencies[mod.Path]; !ok { + continue + } + if mod.Replace != nil { + mod = mod.Replace + } + ret = append(ret, mod) + } + + return ret +} From 4e3218b4d5bf107e4d8cf0b942c6266dc64812b5 Mon Sep 17 00:00:00 2001 From: Luces Huayhuaca <21225410+uturunku1@users.noreply.github.com> Date: Mon, 8 Nov 2021 07:20:15 -0800 Subject: [PATCH 323/644] cloud: convert uses of worspaces.operations into workspaces.executionMode (#29844) * convert uses of worspaces.operations into workspaces.executionMode The cloud package currently uses a deprecated API on workspaces to determine a workspace's execution mode. Deprecated: Operations (boolean) New hotness: Execution mode (string - "local", "remote", or "agent") More details: https://www.terraform.io/docs/cloud/api/workspaces.html#request-body All uses of Operations field coming from the client (within the cloud package) should be converted to the appropriate ExecutionMode equivalent. Also, we need to update all acknowledgment of operations field on the tests that are testing the behavior of workspaces. Co-authored-by: Nick Fagerlund Co-authored-by: Nick Fagerlund --- internal/cloud/backend.go | 10 +++++-- internal/cloud/backend_apply_test.go | 16 +++++----- internal/cloud/backend_test.go | 44 ++++++++++++++-------------- internal/cloud/tfe_client_mock.go | 12 ++++++-- 4 files changed, 46 insertions(+), 36 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index cff9d7e2bcf7..188996177fca 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -636,7 +636,7 @@ func (b *Cloud) Operation(ctx context.Context, op *backend.Operation) (*backend. b.IgnoreVersionConflict() // Check if we need to use the local backend to run the operation. - if b.forceLocal || !w.Operations { + if b.forceLocal || isLocalExecutionMode(w.ExecutionMode) { // Record that we're forced to run operations locally to allow the // command package UI to operate correctly b.forceLocal = true @@ -825,9 +825,9 @@ func (b *Cloud) VerifyWorkspaceTerraformVersion(workspaceName string) tfdiags.Di return nil } - // If the workspace has remote operations disabled, the remote Terraform + // If the workspace has execution-mode set to local, the remote Terraform // version is effectively meaningless, so we'll skip version verification. - if !workspace.Operations { + if isLocalExecutionMode(workspace.ExecutionMode) { return nil } @@ -965,6 +965,10 @@ func (wm WorkspaceMapping) Strategy() workspaceStrategy { } } +func isLocalExecutionMode(execMode string) bool { + return execMode == "local" +} + func (wm WorkspaceMapping) tfeTags() []*tfe.Tag { var tags []*tfe.Tag diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index d741662cd5a5..6c4ea4106f5e 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -1447,36 +1447,36 @@ func TestCloud_applyVersionCheck(t *testing.T) { localVersion string remoteVersion string forceLocal bool - hasOperations bool + executionMode string wantErr string }{ "versions can be different for remote apply": { localVersion: "0.14.0", remoteVersion: "0.13.5", - hasOperations: true, + executionMode: "remote", }, "versions can be different for local apply": { localVersion: "0.14.0", remoteVersion: "0.13.5", - hasOperations: false, + executionMode: "local", }, "force local with remote operations and different versions is acceptable": { localVersion: "0.14.0", remoteVersion: "0.14.0-acme-provider-bundle", forceLocal: true, - hasOperations: true, + executionMode: "remote", }, "no error if versions are identical": { localVersion: "0.14.0", remoteVersion: "0.14.0", forceLocal: true, - hasOperations: true, + executionMode: "remote", }, "no error if force local but workspace has remote operations disabled": { localVersion: "0.14.0", remoteVersion: "0.13.5", forceLocal: true, - hasOperations: false, + executionMode: "local", }, } @@ -1512,7 +1512,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { b.organization, b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ - Operations: tfe.Bool(tc.hasOperations), + ExecutionMode: tfe.String(tc.executionMode), TerraformVersion: tfe.String(tc.remoteVersion), }, ) @@ -1566,7 +1566,7 @@ func TestCloud_applyVersionCheck(t *testing.T) { hasRemote := strings.Contains(output, "Running apply in Terraform Cloud") hasSummary := strings.Contains(output, "1 added, 0 changed, 0 destroyed") hasResources := run.State.HasManagedResourceInstanceObjects() - if !tc.forceLocal && tc.hasOperations { + if !tc.forceLocal && !isLocalExecutionMode(tc.executionMode) { if !hasRemote { t.Errorf("missing TFC header in output: %s", output) } diff --git a/internal/cloud/backend_test.go b/internal/cloud/backend_test.go index 3bb9e148d332..68e3c4167766 100644 --- a/internal/cloud/backend_test.go +++ b/internal/cloud/backend_test.go @@ -680,31 +680,31 @@ func TestCloud_StateMgr_versionCheckLatest(t *testing.T) { func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { testCases := []struct { - local string - remote string - operations bool - wantErr bool + local string + remote string + executionMode string + wantErr bool }{ - {"0.13.5", "0.13.5", true, false}, - {"0.14.0", "0.13.5", true, true}, - {"0.14.0", "0.13.5", false, false}, - {"0.14.0", "0.14.1", true, false}, - {"0.14.0", "1.0.99", true, false}, - {"0.14.0", "1.1.0", true, false}, - {"0.14.0", "1.2.0", true, true}, - {"1.2.0", "1.2.99", true, false}, - {"1.2.0", "1.3.0", true, true}, - {"0.15.0", "latest", true, false}, - {"1.1.5", "~> 1.1.1", true, false}, - {"1.1.5", "> 1.1.0, < 1.3.0", true, false}, - {"1.1.5", "~> 1.0.1", true, true}, + {"0.13.5", "0.13.5", "agent", false}, + {"0.14.0", "0.13.5", "remote", true}, + {"0.14.0", "0.13.5", "local", false}, + {"0.14.0", "0.14.1", "remote", false}, + {"0.14.0", "1.0.99", "remote", false}, + {"0.14.0", "1.1.0", "remote", false}, + {"0.14.0", "1.2.0", "remote", true}, + {"1.2.0", "1.2.99", "remote", false}, + {"1.2.0", "1.3.0", "remote", true}, + {"0.15.0", "latest", "remote", false}, + {"1.1.5", "~> 1.1.1", "remote", false}, + {"1.1.5", "> 1.1.0, < 1.3.0", "remote", false}, + {"1.1.5", "~> 1.0.1", "remote", true}, // pre-release versions are comparable within their pre-release stage (dev, // alpha, beta), but not comparable to different stages and not comparable // to final releases. - {"1.1.0-beta1", "1.1.0-beta1", true, false}, - {"1.1.0-beta1", "~> 1.1.0-beta", true, false}, - {"1.1.0", "~> 1.1.0-beta", true, true}, - {"1.1.0-beta1", "~> 1.1.0-dev", true, true}, + {"1.1.0-beta1", "1.1.0-beta1", "remote", false}, + {"1.1.0-beta1", "~> 1.1.0-beta", "remote", false}, + {"1.1.0", "~> 1.1.0-beta", "remote", true}, + {"1.1.0-beta1", "~> 1.1.0-dev", "remote", true}, } for _, tc := range testCases { t.Run(fmt.Sprintf("local %s, remote %s", tc.local, tc.remote), func(t *testing.T) { @@ -735,7 +735,7 @@ func TestCloud_VerifyWorkspaceTerraformVersion(t *testing.T) { b.organization, b.WorkspaceMapping.Name, tfe.WorkspaceUpdateOptions{ - Operations: tfe.Bool(tc.operations), + ExecutionMode: &tc.executionMode, TerraformVersion: tfe.String(tc.remote), }, ); err != nil { diff --git a/internal/cloud/tfe_client_mock.go b/internal/cloud/tfe_client_mock.go index 929e39b89a47..2725d8178002 100644 --- a/internal/cloud/tfe_client_mock.go +++ b/internal/cloud/tfe_client_mock.go @@ -1165,13 +1165,16 @@ func (m *MockWorkspaces) Create(ctx context.Context, organization string, option } if strings.HasSuffix(*options.Name, "no-operations") { options.Operations = tfe.Bool(false) + options.ExecutionMode = tfe.String("local") } else if options.Operations == nil { options.Operations = tfe.Bool(true) + options.ExecutionMode = tfe.String("remote") } w := &tfe.Workspace{ - ID: GenerateID("ws-"), - Name: *options.Name, - Operations: *options.Operations, + ID: GenerateID("ws-"), + Name: *options.Name, + ExecutionMode: *options.ExecutionMode, + Operations: *options.Operations, Permissions: &tfe.WorkspacePermissions{ CanQueueApply: true, CanQueueRun: true, @@ -1276,6 +1279,9 @@ func updateMockWorkspaceAttributes(w *tfe.Workspace, options tfe.WorkspaceUpdate if options.Operations != nil { w.Operations = *options.Operations } + if options.ExecutionMode != nil { + w.ExecutionMode = *options.ExecutionMode + } if options.Name != nil { w.Name = *options.Name } From 58304b678cda5ca741d0fcf2cc61e8119099ae45 Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Mon, 8 Nov 2021 08:58:56 -0800 Subject: [PATCH 324/644] import path to go mocks in tfe --- internal/cloud/backend_apply_test.go | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/internal/cloud/backend_apply_test.go b/internal/cloud/backend_apply_test.go index 6c4ea4106f5e..f6a9a2cdc0db 100644 --- a/internal/cloud/backend_apply_test.go +++ b/internal/cloud/backend_apply_test.go @@ -13,6 +13,7 @@ import ( gomock "github.com/golang/mock/gomock" "github.com/google/go-cmp/cmp" tfe "github.com/hashicorp/go-tfe" + mocks "github.com/hashicorp/go-tfe/mocks" version "github.com/hashicorp/go-version" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/backend" @@ -576,7 +577,7 @@ func TestCloud_applyAutoApprove(t *testing.T) { defer bCleanup() ctrl := gomock.NewController(t) - applyMock := tfe.NewMockApplies(ctrl) + applyMock := mocks.NewMockApplies(ctrl) // This needs three new lines because we check for a minimum of three lines // in the parsing of logs in `opApply` function. logs := strings.NewReader(applySuccessOneResourceAdded) @@ -778,7 +779,7 @@ func TestCloud_applyWithAutoApprove(t *testing.T) { defer bCleanup() ctrl := gomock.NewController(t) - applyMock := tfe.NewMockApplies(ctrl) + applyMock := mocks.NewMockApplies(ctrl) // This needs three new lines because we check for a minimum of three lines // in the parsing of logs in `opApply` function. logs := strings.NewReader(applySuccessOneResourceAdded) @@ -1269,7 +1270,7 @@ func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { defer bCleanup() ctrl := gomock.NewController(t) - policyCheckMock := tfe.NewMockPolicyChecks(ctrl) + policyCheckMock := mocks.NewMockPolicyChecks(ctrl) // This needs three new lines because we check for a minimum of three lines // in the parsing of logs in `opApply` function. logs := strings.NewReader(fmt.Sprintf("%s\n%s", sentinelSoftFail, applySuccessOneResourceAdded)) @@ -1289,7 +1290,7 @@ func TestCloud_applyPolicySoftFailAutoApproveSuccess(t *testing.T) { policyCheckMock.EXPECT().Logs(gomock.Any(), gomock.Any()).Return(logs, nil) policyCheckMock.EXPECT().Override(gomock.Any(), gomock.Any()).Return(nil, nil) b.client.PolicyChecks = policyCheckMock - applyMock := tfe.NewMockApplies(ctrl) + applyMock := mocks.NewMockApplies(ctrl) // This needs three new lines because we check for a minimum of three lines // in the parsing of logs in `opApply` function. logs = strings.NewReader("\n\n\n1 added, 0 changed, 0 destroyed") @@ -1348,7 +1349,7 @@ func TestCloud_applyPolicySoftFailAutoApprove(t *testing.T) { defer bCleanup() ctrl := gomock.NewController(t) - applyMock := tfe.NewMockApplies(ctrl) + applyMock := mocks.NewMockApplies(ctrl) // This needs three new lines because we check for a minimum of three lines // in the parsing of logs in `opApply` function. logs := strings.NewReader(applySuccessOneResourceAdded) From 9ef9f97121a6b68bbd92438293e3e0084412e8af Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Mon, 8 Nov 2021 09:03:05 -0800 Subject: [PATCH 325/644] pull go tfe changes from main branch --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 2742ca871a07..baf63ab1e506 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.19.1-0.20211020175229-e52963e079d0 + github.com/hashicorp/go-tfe v0.20.1-0.20211101140842-a4cb47d035cf github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index 168d04de356a..d4e2a4a3995f 100644 --- a/go.sum +++ b/go.sum @@ -379,8 +379,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.19.1-0.20211020175229-e52963e079d0 h1:64o1fy8p4a9J/5Gooy1S9iuEJQqXTVGYk5ZrXwFDZ8w= -github.com/hashicorp/go-tfe v0.19.1-0.20211020175229-e52963e079d0/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.20.1-0.20211101140842-a4cb47d035cf h1:VItt+uNOHWOAvWyHqhmGRJpec4yRmL24+gccz8b7bHw= +github.com/hashicorp/go-tfe v0.20.1-0.20211101140842-a4cb47d035cf/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= From 21750037d5a2ed7a0a20112ee11b029445bbd1d1 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 8 Nov 2021 22:06:41 -0600 Subject: [PATCH 326/644] cloud: Help output typos --- internal/cloud/backend.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/cloud/backend.go b/internal/cloud/backend.go index 188996177fca..45ec969ea5fb 100644 --- a/internal/cloud/backend.go +++ b/internal/cloud/backend.go @@ -1051,7 +1051,7 @@ Please reach out to HashiCorp Support to resolve this issue.` var ( workspaceConfigurationHelp = fmt.Sprintf( `The 'workspaces' block configures how Terraform CLI maps its workspaces for this single -configuration to workspaces within a Terraform Cloud organization. Three strategies are available: +configuration to workspaces within a Terraform Cloud organization. Two strategies are available: [bold]tags[reset] - %s @@ -1067,9 +1067,9 @@ be set, and 'terraform login' used instead; your credentials will then be fetche configuration file or configured credential helper.` schemaDescriptionTags = `A set of tags used to select remote Terraform Cloud workspaces to be used for this single -configuration. New workspaces will automatically be tagged with these tag values. Generally, this +configuration. New workspaces will automatically be tagged with these tag values. Generally, this is the primary and recommended strategy to use. This option conflicts with "name".` - schemaDescriptionName = `The name of a single Terraform Cloud workspace to be used with this configuration When configured -only the specified workspace can be used. This option conflicts with "tags".` + schemaDescriptionName = `The name of a single Terraform Cloud workspace to be used with this configuration. +When configured, only the specified workspace can be used. This option conflicts with "tags".` ) From c44c589f0ab64b8dd4ba964f9c671a9c9bf82a88 Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Fri, 29 Oct 2021 14:53:18 -0500 Subject: [PATCH 327/644] Error if backup or backup-out options are used without the state option on non-local backends for the state mv command --- internal/command/state_mv.go | 38 +++ internal/command/state_mv_test.go | 259 ++++++++++++++++++ .../testdata/init-backend-http/main.tf | 4 + 3 files changed, 301 insertions(+) create mode 100644 internal/command/testdata/init-backend-http/main.tf diff --git a/internal/command/state_mv.go b/internal/command/state_mv.go index 2a0cd5d48c13..a35cfd6aaa55 100644 --- a/internal/command/state_mv.go +++ b/internal/command/state_mv.go @@ -5,6 +5,7 @@ import ( "strings" "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/command/clistate" "github.com/hashicorp/terraform/internal/command/views" @@ -42,6 +43,43 @@ func (c *StateMvCommand) Run(args []string) int { return cli.RunResultHelp } + // If backup or backup-out options are set + // and the state option is not set, make sure + // the backend is local + backupOptionSetWithoutStateOption := c.backupPath != "-" && c.statePath == "" + backupOutOptionSetWithoutStateOption := backupPathOut != "-" && c.statePath == "" + + var setLegacyLocalBackendOptions []string + if backupOptionSetWithoutStateOption { + setLegacyLocalBackendOptions = append(setLegacyLocalBackendOptions, "-backup") + } + if backupOutOptionSetWithoutStateOption { + setLegacyLocalBackendOptions = append(setLegacyLocalBackendOptions, "-backup-out") + } + + if len(setLegacyLocalBackendOptions) > 0 { + currentBackend, diags := c.backendFromConfig(&BackendOpts{}) + if diags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } + + // If currentBackend is nil and diags didn't have errors, + // this means we have an implicit local backend + _, isLocalBackend := currentBackend.(backend.Local) + if currentBackend != nil && !isLocalBackend { + diags = diags.Append( + tfdiags.Sourceless( + tfdiags.Error, + fmt.Sprintf("Invalid command line options: %s", strings.Join(setLegacyLocalBackendOptions[:], ", ")), + "Command line options -backup and -backup-out are legacy options that operate on a local state file only. You must specify a local state file with the -state option or switch to the local backend.", + ), + ) + c.showDiagnostics(diags) + return 1 + } + } + // Read the from state stateFromMgr, err := c.State() if err != nil { diff --git a/internal/command/state_mv_test.go b/internal/command/state_mv_test.go index 1106879f4048..2778de61b0c9 100644 --- a/internal/command/state_mv_test.go +++ b/internal/command/state_mv_test.go @@ -150,6 +150,257 @@ func TestStateMv(t *testing.T) { } +func TestStateMv_backupAndBackupOutOptionsWithNonLocalBackend(t *testing.T) { + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_instance", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"id":"bar","foo":"value","bar":"value"}`), + Status: states.ObjectReady, + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ) + }) + + t.Run("backup option specified", func(t *testing.T) { + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-http"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + backupPath := filepath.Join(td, "backup") + + // Set up our backend state using mock state + dataState, srv := testBackendState(t, state, 200) + defer srv.Close() + testStateFileRemote(t, dataState) + + p := testProvider() + ui := new(cli.MockUi) + view, _ := testView(t) + c := &StateMvCommand{ + StateMeta{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + View: view, + }, + }, + } + + args := []string{ + "-backup", backupPath, + "test_instance.foo", + "test_instance.bar", + } + if code := c.Run(args); code == 0 { + t.Fatalf("expected error output, got:\n%s", ui.OutputWriter.String()) + } + + gotErr := ui.ErrorWriter.String() + wantErr := ` +Error: Invalid command line options: -backup + +Command line options -backup and -backup-out are legacy options that operate +on a local state file only. You must specify a local state file with the +-state option or switch to the local backend. + +` + if gotErr != wantErr { + t.Fatalf("expected error\ngot:%s\n\nwant:%s", gotErr, wantErr) + } + }) + + t.Run("backup-out option specified", func(t *testing.T) { + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-http"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + backupOutPath := filepath.Join(td, "backup-out") + + // Set up our backend state using mock state + dataState, srv := testBackendState(t, state, 200) + defer srv.Close() + testStateFileRemote(t, dataState) + + p := testProvider() + ui := new(cli.MockUi) + view, _ := testView(t) + c := &StateMvCommand{ + StateMeta{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + View: view, + }, + }, + } + + args := []string{ + "-backup-out", backupOutPath, + "test_instance.foo", + "test_instance.bar", + } + if code := c.Run(args); code == 0 { + t.Fatalf("expected error output, got:\n%s", ui.OutputWriter.String()) + } + + gotErr := ui.ErrorWriter.String() + wantErr := ` +Error: Invalid command line options: -backup-out + +Command line options -backup and -backup-out are legacy options that operate +on a local state file only. You must specify a local state file with the +-state option or switch to the local backend. + +` + if gotErr != wantErr { + t.Fatalf("expected error\ngot:%s\n\nwant:%s", gotErr, wantErr) + } + }) + + t.Run("backup and backup-out options specified", func(t *testing.T) { + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-http"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + backupPath := filepath.Join(td, "backup") + backupOutPath := filepath.Join(td, "backup-out") + + // Set up our backend state using mock state + dataState, srv := testBackendState(t, state, 200) + defer srv.Close() + testStateFileRemote(t, dataState) + + p := testProvider() + ui := new(cli.MockUi) + view, _ := testView(t) + c := &StateMvCommand{ + StateMeta{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + View: view, + }, + }, + } + + args := []string{ + "-backup", backupPath, + "-backup-out", backupOutPath, + "test_instance.foo", + "test_instance.bar", + } + if code := c.Run(args); code == 0 { + t.Fatalf("expected error output, got:\n%s", ui.OutputWriter.String()) + } + + gotErr := ui.ErrorWriter.String() + wantErr := ` +Error: Invalid command line options: -backup, -backup-out + +Command line options -backup and -backup-out are legacy options that operate +on a local state file only. You must specify a local state file with the +-state option or switch to the local backend. + +` + if gotErr != wantErr { + t.Fatalf("expected error\ngot:%s\n\nwant:%s", gotErr, wantErr) + } + }) + + t.Run("backup option specified with state option", func(t *testing.T) { + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-http"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + statePath := testStateFile(t, state) + backupPath := filepath.Join(td, "backup") + + // Set up our backend state using mock state + dataState, srv := testBackendState(t, state, 200) + defer srv.Close() + testStateFileRemote(t, dataState) + + p := testProvider() + ui := new(cli.MockUi) + view, _ := testView(t) + c := &StateMvCommand{ + StateMeta{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + View: view, + }, + }, + } + + args := []string{ + "-state", statePath, + "-backup", backupPath, + "test_instance.foo", + "test_instance.bar", + } + if code := c.Run(args); code != 0 { + t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String()) + } + + // Test it is correct + testStateOutput(t, statePath, testStateMvBackupAndBackupOutOptionsWithNonLocalBackendOutput) + }) + + t.Run("backup-out option specified with state option", func(t *testing.T) { + td := tempDir(t) + testCopyDir(t, testFixturePath("init-backend-http"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + statePath := testStateFile(t, state) + backupOutPath := filepath.Join(td, "backup-out") + + // Set up our backend state using mock state + dataState, srv := testBackendState(t, state, 200) + defer srv.Close() + testStateFileRemote(t, dataState) + + p := testProvider() + ui := new(cli.MockUi) + view, _ := testView(t) + c := &StateMvCommand{ + StateMeta{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + View: view, + }, + }, + } + + args := []string{ + "-state", statePath, + "-backup-out", backupOutPath, + "test_instance.foo", + "test_instance.bar", + } + if code := c.Run(args); code != 0 { + t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String()) + } + + // Test it is correct + testStateOutput(t, statePath, testStateMvBackupAndBackupOutOptionsWithNonLocalBackendOutput) + }) +} + func TestStateMv_resourceToInstance(t *testing.T) { // A single resource (no count defined) state := states.BuildState(func(s *states.SyncState) { @@ -1463,6 +1714,14 @@ test_instance.baz: foo = value ` +const testStateMvBackupAndBackupOutOptionsWithNonLocalBackendOutput = ` +test_instance.bar: + ID = bar + provider = provider["registry.terraform.io/hashicorp/test"] + bar = value + foo = value +` + const testStateMvCount_stateOut = ` test_instance.bar.0: ID = foo diff --git a/internal/command/testdata/init-backend-http/main.tf b/internal/command/testdata/init-backend-http/main.tf new file mode 100644 index 000000000000..4ca44e9b5b43 --- /dev/null +++ b/internal/command/testdata/init-backend-http/main.tf @@ -0,0 +1,4 @@ +terraform { + backend "http" { + } +} From a62cff939edfeeb84188e6a23b86a2a3eba68e4e Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Fri, 5 Nov 2021 15:26:22 -0500 Subject: [PATCH 328/644] Update documentation for state mv command to clarify use of backup and backup-out options --- website/docs/cli/commands/state/mv.html.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/commands/state/mv.html.md b/website/docs/cli/commands/state/mv.html.md index 7670ae7a4e4c..2cf2f8cd6c8d 100644 --- a/website/docs/cli/commands/state/mv.html.md +++ b/website/docs/cli/commands/state/mv.html.md @@ -73,10 +73,18 @@ only, `terraform state mv` also accepts the option [`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +The legacy options [`-backup` and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments) +operate on a local state file only. Configurations using +[the `remote` backend](/docs/language/settings/backends/remote.html) +must specify a local state file with the [`-state`](/docs/language/settings/backends/local.html#command-line-arguments) +option in order to use the [`-backup` and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments) +options. + + For configurations using [the `local` state mv](/docs/language/settings/backends/local.html) only, -`terraform taint` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +`terraform state mv` also accepts the legacy options +[`-state`, `-state-out`, `-backup`, and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments). ## Example: Rename a Resource From 40ec62c1391f65147c5b8239d97002705dfde074 Mon Sep 17 00:00:00 2001 From: kmoe <5575356+kmoe@users.noreply.github.com> Date: Mon, 1 Nov 2021 20:09:16 +0000 Subject: [PATCH 329/644] command: make module installation interruptible Earlier work to make "terraform init" interruptible made the getproviders package context-aware in order to allow provider installation to be cancelled. Here we make a similar change for module installation, which is now also cancellable with SIGINT. This involves plumbing context through initwd and getmodules. Functions which can make network requests now include a context parameter whose cancellation cancels those requests. Since the module installation code is shared, "terraform get" is now also interruptible during module installation. --- internal/command/command_test.go | 3 +- internal/command/get.go | 6 +-- internal/command/get_test.go | 32 +++++++++++++ internal/command/init.go | 24 +++++----- internal/command/init_test.go | 40 ++++++++++++++++- internal/command/meta_config.go | 45 ++++++++++++++----- internal/command/test.go | 2 +- .../testdata/init-registry-module/main.tf | 4 ++ internal/getmodules/getter.go | 4 +- internal/getmodules/installer.go | 8 +++- internal/initwd/from_module.go | 5 ++- internal/initwd/from_module_test.go | 7 +-- internal/initwd/module_install.go | 38 +++++++++++----- internal/initwd/module_install_test.go | 21 ++++----- internal/initwd/testing.go | 3 +- internal/refactoring/move_validate_test.go | 3 +- internal/registry/client.go | 8 +++- internal/registry/client_test.go | 24 +++++----- internal/terraform/terraform_test.go | 5 ++- 19 files changed, 207 insertions(+), 75 deletions(-) create mode 100644 internal/command/testdata/init-registry-module/main.tf diff --git a/internal/command/command_test.go b/internal/command/command_test.go index 5fab71f1fc64..4a56ecc73b23 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -2,6 +2,7 @@ package command import ( "bytes" + "context" "crypto/md5" "encoding/base64" "encoding/json" @@ -188,7 +189,7 @@ func testModuleWithSnapshot(t *testing.T, name string) (*configs.Config, *config // sources only this ultimately just records all of the module paths // in a JSON file so that we can load them below. inst := initwd.NewModuleInstaller(loader.ModulesDir(), registry.NewClient(nil, nil)) - _, instDiags := inst.InstallModules(dir, true, initwd.ModuleInstallHooksImpl{}) + _, instDiags := inst.InstallModules(context.Background(), dir, true, initwd.ModuleInstallHooksImpl{}) if instDiags.HasErrors() { t.Fatal(instDiags.Err()) } diff --git a/internal/command/get.go b/internal/command/get.go index 170e1940078f..0f541c3b1e89 100644 --- a/internal/command/get.go +++ b/internal/command/get.go @@ -33,9 +33,9 @@ func (c *GetCommand) Run(args []string) int { path = c.normalizePath(path) - diags := getModules(&c.Meta, path, update) + abort, diags := getModules(&c.Meta, path, update) c.showDiagnostics(diags) - if diags.HasErrors() { + if abort || diags.HasErrors() { return 1 } @@ -73,7 +73,7 @@ func (c *GetCommand) Synopsis() string { return "Install or upgrade remote Terraform modules" } -func getModules(m *Meta, path string, upgrade bool) tfdiags.Diagnostics { +func getModules(m *Meta, path string, upgrade bool) (abort bool, diags tfdiags.Diagnostics) { hooks := uiModuleInstallHooks{ Ui: m.Ui, ShowLocalPaths: true, diff --git a/internal/command/get_test.go b/internal/command/get_test.go index b2a3ea0a75ac..77daeb0b4de9 100644 --- a/internal/command/get_test.go +++ b/internal/command/get_test.go @@ -79,3 +79,35 @@ func TestGet_update(t *testing.T) { t.Fatalf("doesn't look like get: %s", output) } } + +func TestGet_cancel(t *testing.T) { + // This test runs `terraform get` as if SIGINT (or similar on other + // platforms) were sent to it, testing that it is interruptible. + + wd := tempWorkingDirFixture(t, "init-registry-module") + defer testChdir(t, wd.RootModuleDir())() + + // Our shutdown channel is pre-closed so init will exit as soon as it + // starts a cancelable portion of the process. + shutdownCh := make(chan struct{}) + close(shutdownCh) + + ui := cli.NewMockUi() + c := &GetCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + Ui: ui, + WorkingDir: wd, + ShutdownCh: shutdownCh, + }, + } + + args := []string{} + if code := c.Run(args); code == 0 { + t.Fatalf("succeeded; wanted error\n%s", ui.OutputWriter.String()) + } + + if got, want := ui.ErrorWriter.String(), `Module installation was canceled by an interrupt signal`; !strings.Contains(got, want) { + t.Fatalf("wrong error message\nshould contain: %s\ngot:\n%s", want, got) + } +} diff --git a/internal/command/init.go b/internal/command/init.go index 39a902c965af..b8ba6b9ff61b 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -115,9 +115,9 @@ func (c *InitCommand) Run(args []string) int { ShowLocalPaths: false, // since they are in a weird location for init } - initDiags := c.initDirFromModule(path, src, hooks) - diags = diags.Append(initDiags) - if initDiags.HasErrors() { + initDirFromModuleAbort, initDirFromModuleDiags := c.initDirFromModule(path, src, hooks) + diags = diags.Append(initDirFromModuleDiags) + if initDirFromModuleAbort || initDirFromModuleDiags.HasErrors() { c.showDiagnostics(diags) return 1 } @@ -174,9 +174,9 @@ func (c *InitCommand) Run(args []string) int { } if flagGet { - modsOutput, modsDiags := c.getModules(path, rootModEarly, flagUpgrade) + modsOutput, modsAbort, modsDiags := c.getModules(path, rootModEarly, flagUpgrade) diags = diags.Append(modsDiags) - if modsDiags.HasErrors() { + if modsAbort || modsDiags.HasErrors() { c.showDiagnostics(diags) return 1 } @@ -326,10 +326,10 @@ func (c *InitCommand) Run(args []string) int { return 0 } -func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrade bool) (output bool, diags tfdiags.Diagnostics) { +func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrade bool) (output bool, abort bool, diags tfdiags.Diagnostics) { if len(earlyRoot.ModuleCalls) == 0 { // Nothing to do - return false, nil + return false, false, nil } if upgrade { @@ -342,8 +342,12 @@ func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrad Ui: c.Ui, ShowLocalPaths: true, } - instDiags := c.installModules(path, upgrade, hooks) - diags = diags.Append(instDiags) + + installAbort, installDiags := c.installModules(path, upgrade, hooks) + diags = diags.Append(installDiags) + if installAbort || installDiags.HasErrors() { + return true, true, diags + } // Since module installer has modified the module manifest on disk, we need // to refresh the cache of it in the loader. @@ -358,7 +362,7 @@ func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrad } } - return true, diags + return true, false, diags } func (c *InitCommand) initCloud(root *configs.Module) (be backend.Backend, output bool, diags tfdiags.Diagnostics) { diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 56bc1f911623..b952ea0a288e 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -1417,7 +1417,45 @@ func TestInit_providerSource(t *testing.T) { } } -func TestInit_cancel(t *testing.T) { +func TestInit_cancelModules(t *testing.T) { + // This test runs `terraform init` as if SIGINT (or similar on other + // platforms) were sent to it, testing that it is interruptible. + + td := tempDir(t) + testCopyDir(t, testFixturePath("init-registry-module"), td) + defer os.RemoveAll(td) + defer testChdir(t, td)() + + // Our shutdown channel is pre-closed so init will exit as soon as it + // starts a cancelable portion of the process. + shutdownCh := make(chan struct{}) + close(shutdownCh) + + ui := cli.NewMockUi() + view, _ := testView(t) + m := Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + Ui: ui, + View: view, + ShutdownCh: shutdownCh, + } + + c := &InitCommand{ + Meta: m, + } + + args := []string{} + + if code := c.Run(args); code == 0 { + t.Fatalf("succeeded; wanted error\n%s", ui.OutputWriter.String()) + } + + if got, want := ui.ErrorWriter.String(), `Module installation was canceled by an interrupt signal`; !strings.Contains(got, want) { + t.Fatalf("wrong error message\nshould contain: %s\ngot:\n%s", want, got) + } +} + +func TestInit_cancelProviders(t *testing.T) { // This test runs `terraform init` as if SIGINT (or similar on other // platforms) were sent to it, testing that it is interruptible. diff --git a/internal/command/meta_config.go b/internal/command/meta_config.go index 6913db594449..0abaf52a7c7b 100644 --- a/internal/command/meta_config.go +++ b/internal/command/meta_config.go @@ -164,26 +164,39 @@ func (m *Meta) loadHCLFile(filename string) (hcl.Body, tfdiags.Diagnostics) { } // installModules reads a root module from the given directory and attempts -// recursively install all of its descendent modules. +// recursively to install all of its descendent modules. // // The given hooks object will be notified of installation progress, which -// can then be relayed to the end-user. The moduleUiInstallHooks type in +// can then be relayed to the end-user. The uiModuleInstallHooks type in // this package has a reasonable implementation for displaying notifications // via a provided cli.Ui. -func (m *Meta) installModules(rootDir string, upgrade bool, hooks initwd.ModuleInstallHooks) tfdiags.Diagnostics { - var diags tfdiags.Diagnostics +func (m *Meta) installModules(rootDir string, upgrade bool, hooks initwd.ModuleInstallHooks) (abort bool, diags tfdiags.Diagnostics) { rootDir = m.normalizePath(rootDir) err := os.MkdirAll(m.modulesDir(), os.ModePerm) if err != nil { diags = diags.Append(fmt.Errorf("failed to create local modules directory: %s", err)) - return diags + return true, diags } + // FIXME: KEM: does returning the abort here change behaviour in a particular error + // case? inst := m.moduleInstaller() - _, moreDiags := inst.InstallModules(rootDir, upgrade, hooks) + + // Installation can be aborted by interruption signals + ctx, done := m.InterruptibleContext() + defer done() + + _, moreDiags := inst.InstallModules(ctx, rootDir, upgrade, hooks) diags = diags.Append(moreDiags) - return diags + + if ctx.Err() == context.Canceled { + m.showDiagnostics(diags) + m.Ui.Error("Module installation was canceled by an interrupt signal.") + return true, diags + } + + return false, diags } // initDirFromModule initializes the given directory (which should be @@ -192,15 +205,23 @@ func (m *Meta) installModules(rootDir string, upgrade bool, hooks initwd.ModuleI // // Internally this runs similar steps to installModules. // The given hooks object will be notified of installation progress, which -// can then be relayed to the end-user. The moduleUiInstallHooks type in +// can then be relayed to the end-user. The uiModuleInstallHooks type in // this package has a reasonable implementation for displaying notifications // via a provided cli.Ui. -func (m *Meta) initDirFromModule(targetDir string, addr string, hooks initwd.ModuleInstallHooks) tfdiags.Diagnostics { - var diags tfdiags.Diagnostics +func (m *Meta) initDirFromModule(targetDir string, addr string, hooks initwd.ModuleInstallHooks) (abort bool, diags tfdiags.Diagnostics) { + // Installation can be aborted by interruption signals + ctx, done := m.InterruptibleContext() + defer done() + targetDir = m.normalizePath(targetDir) - moreDiags := initwd.DirFromModule(targetDir, m.modulesDir(), addr, m.registryClient(), hooks) + moreDiags := initwd.DirFromModule(ctx, targetDir, m.modulesDir(), addr, m.registryClient(), hooks) diags = diags.Append(moreDiags) - return diags + if ctx.Err() == context.Canceled { + m.showDiagnostics(diags) + m.Ui.Error("Module initialization was canceled by an interrupt signal.") + return true, diags + } + return false, diags } // inputForSchema uses interactive prompts to try to populate any diff --git a/internal/command/test.go b/internal/command/test.go index eff291179a2c..fc6d7ef70047 100644 --- a/internal/command/test.go +++ b/internal/command/test.go @@ -249,7 +249,7 @@ func (c *TestCommand) prepareSuiteDir(ctx context.Context, suiteName string) (te os.MkdirAll(suiteDirs.ModulesDir, 0755) // if this fails then we'll ignore it and let InstallModules below fail instead reg := c.registryClient() moduleInst := initwd.NewModuleInstaller(suiteDirs.ModulesDir, reg) - _, moreDiags := moduleInst.InstallModules(configDir, true, nil) + _, moreDiags := moduleInst.InstallModules(ctx, configDir, true, nil) diags = diags.Append(moreDiags) if diags.HasErrors() { return suiteDirs, diags diff --git a/internal/command/testdata/init-registry-module/main.tf b/internal/command/testdata/init-registry-module/main.tf new file mode 100644 index 000000000000..cc388d7c59d8 --- /dev/null +++ b/internal/command/testdata/init-registry-module/main.tf @@ -0,0 +1,4 @@ +module "foo" { + source = "registry.does.not.exist/example_corp/foo/bar" + version = "0.1.0" +} diff --git a/internal/getmodules/getter.go b/internal/getmodules/getter.go index 67b5c2760bb5..95f334762e64 100644 --- a/internal/getmodules/getter.go +++ b/internal/getmodules/getter.go @@ -1,6 +1,7 @@ package getmodules import ( + "context" "fmt" "log" "os" @@ -119,7 +120,7 @@ type reusingGetter map[string]string // end-user-actionable error messages. At this time we do not have any // reasonable way to improve these error messages at this layer because // the underlying errors are not separately recognizable. -func (g reusingGetter) getWithGoGetter(instPath, packageAddr string) error { +func (g reusingGetter) getWithGoGetter(ctx context.Context, instPath, packageAddr string) error { var err error if prevDir, exists := g[packageAddr]; exists { @@ -144,6 +145,7 @@ func (g reusingGetter) getWithGoGetter(instPath, packageAddr string) error { Detectors: goGetterNoDetectors, // our caller should've already done detection Decompressors: goGetterDecompressors, Getters: goGetterGetters, + Ctx: ctx, } err = client.Get() if err != nil { diff --git a/internal/getmodules/installer.go b/internal/getmodules/installer.go index 087c0cd3dcf3..657c0e73a020 100644 --- a/internal/getmodules/installer.go +++ b/internal/getmodules/installer.go @@ -1,5 +1,9 @@ package getmodules +import ( + "context" +) + // PackageFetcher is a low-level utility for fetching remote module packages // into local filesystem directories in preparation for use by higher-level // module installer functionality implemented elsewhere. @@ -35,6 +39,6 @@ func NewPackageFetcher() *PackageFetcher { // a module source address which includes a subdirectory portion then the // caller must resolve that itself, possibly with the help of the // getmodules.SplitPackageSubdir and getmodules.ExpandSubdirGlobs functions. -func (f *PackageFetcher) FetchPackage(instDir string, packageAddr string) error { - return f.getter.getWithGoGetter(instDir, packageAddr) +func (f *PackageFetcher) FetchPackage(ctx context.Context, instDir string, packageAddr string) error { + return f.getter.getWithGoGetter(ctx, instDir, packageAddr) } diff --git a/internal/initwd/from_module.go b/internal/initwd/from_module.go index 392370032c6a..38a4e49b5cee 100644 --- a/internal/initwd/from_module.go +++ b/internal/initwd/from_module.go @@ -1,6 +1,7 @@ package initwd import ( + "context" "fmt" "io/ioutil" "log" @@ -41,7 +42,7 @@ const initFromModuleRootKeyPrefix = initFromModuleRootCallName + "." // references using ../ from that module to be unresolvable. Error diagnostics // are produced in that case, to prompt the user to rewrite the source strings // to be absolute references to the original remote module. -func DirFromModule(rootDir, modulesDir, sourceAddr string, reg *registry.Client, hooks ModuleInstallHooks) tfdiags.Diagnostics { +func DirFromModule(ctx context.Context, rootDir, modulesDir, sourceAddr string, reg *registry.Client, hooks ModuleInstallHooks) tfdiags.Diagnostics { var diags tfdiags.Diagnostics // The way this function works is pretty ugly, but we accept it because @@ -144,7 +145,7 @@ func DirFromModule(rootDir, modulesDir, sourceAddr string, reg *registry.Client, Wrapped: hooks, } fetcher := getmodules.NewPackageFetcher() - _, instDiags := inst.installDescendentModules(fakeRootModule, rootDir, instManifest, true, wrapHooks, fetcher) + _, instDiags := inst.installDescendentModules(ctx, fakeRootModule, rootDir, instManifest, true, wrapHooks, fetcher) diags = append(diags, instDiags...) if instDiags.HasErrors() { return diags diff --git a/internal/initwd/from_module_test.go b/internal/initwd/from_module_test.go index 8265f0e3a115..a28ad2a7dc06 100644 --- a/internal/initwd/from_module_test.go +++ b/internal/initwd/from_module_test.go @@ -1,6 +1,7 @@ package initwd import ( + "context" "io/ioutil" "os" "path/filepath" @@ -38,7 +39,7 @@ func TestDirFromModule_registry(t *testing.T) { hooks := &testInstallHooks{} reg := registry.NewClient(nil, nil) - diags := DirFromModule(dir, modsDir, "hashicorp/module-installer-acctest/aws//examples/main", reg, hooks) + diags := DirFromModule(context.Background(), dir, modsDir, "hashicorp/module-installer-acctest/aws//examples/main", reg, hooks) assertNoDiagnostics(t, diags) v := version.Must(version.NewVersion("0.0.2")) @@ -154,7 +155,7 @@ func TestDirFromModule_submodules(t *testing.T) { } modInstallDir := filepath.Join(dir, ".terraform/modules") - diags := DirFromModule(dir, modInstallDir, fromModuleDir, nil, hooks) + diags := DirFromModule(context.Background(), dir, modInstallDir, fromModuleDir, nil, hooks) assertNoDiagnostics(t, diags) wantCalls := []testInstallHookCall{ { @@ -248,7 +249,7 @@ func TestDirFromModule_rel_submodules(t *testing.T) { modInstallDir := ".terraform/modules" sourceDir := "../local-modules" - diags := DirFromModule(".", modInstallDir, sourceDir, nil, hooks) + diags := DirFromModule(context.Background(), ".", modInstallDir, sourceDir, nil, hooks) assertNoDiagnostics(t, diags) wantCalls := []testInstallHookCall{ { diff --git a/internal/initwd/module_install.go b/internal/initwd/module_install.go index 83f4ed2bb6a7..c5355ee9670c 100644 --- a/internal/initwd/module_install.go +++ b/internal/initwd/module_install.go @@ -1,6 +1,8 @@ package initwd import ( + "context" + "errors" "fmt" "log" "os" @@ -75,7 +77,7 @@ func NewModuleInstaller(modsDir string, reg *registry.Client) *ModuleInstaller { // If successful (the returned diagnostics contains no errors) then the // first return value is the early configuration tree that was constructed by // the installation process. -func (i *ModuleInstaller) InstallModules(rootDir string, upgrade bool, hooks ModuleInstallHooks) (*earlyconfig.Config, tfdiags.Diagnostics) { +func (i *ModuleInstaller) InstallModules(ctx context.Context, rootDir string, upgrade bool, hooks ModuleInstallHooks) (*earlyconfig.Config, tfdiags.Diagnostics) { log.Printf("[TRACE] ModuleInstaller: installing child modules for %s into %s", rootDir, i.modsDir) rootMod, diags := earlyconfig.LoadModule(rootDir) @@ -94,13 +96,13 @@ func (i *ModuleInstaller) InstallModules(rootDir string, upgrade bool, hooks Mod } fetcher := getmodules.NewPackageFetcher() - cfg, instDiags := i.installDescendentModules(rootMod, rootDir, manifest, upgrade, hooks, fetcher) + cfg, instDiags := i.installDescendentModules(ctx, rootMod, rootDir, manifest, upgrade, hooks, fetcher) diags = append(diags, instDiags...) return cfg, diags } -func (i *ModuleInstaller) installDescendentModules(rootMod *tfconfig.Module, rootDir string, manifest modsdir.Manifest, upgrade bool, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*earlyconfig.Config, tfdiags.Diagnostics) { +func (i *ModuleInstaller) installDescendentModules(ctx context.Context, rootMod *tfconfig.Module, rootDir string, manifest modsdir.Manifest, upgrade bool, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*earlyconfig.Config, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics if hooks == nil { @@ -209,13 +211,13 @@ func (i *ModuleInstaller) installDescendentModules(rootMod *tfconfig.Module, roo case addrs.ModuleSourceRegistry: log.Printf("[TRACE] ModuleInstaller: %s is a registry module at %s", key, addr.String()) - mod, v, mDiags := i.installRegistryModule(req, key, instPath, addr, manifest, hooks, fetcher) + mod, v, mDiags := i.installRegistryModule(ctx, req, key, instPath, addr, manifest, hooks, fetcher) diags = append(diags, mDiags...) return mod, v, diags case addrs.ModuleSourceRemote: log.Printf("[TRACE] ModuleInstaller: %s address %q will be handled by go-getter", key, addr.String()) - mod, mDiags := i.installGoGetterModule(req, key, instPath, manifest, hooks, fetcher) + mod, mDiags := i.installGoGetterModule(ctx, req, key, instPath, manifest, hooks, fetcher) diags = append(diags, mDiags...) return mod, nil, diags @@ -301,7 +303,7 @@ func (i *ModuleInstaller) installLocalModule(req *earlyconfig.ModuleRequest, key return mod, diags } -func (i *ModuleInstaller) installRegistryModule(req *earlyconfig.ModuleRequest, key string, instPath string, addr addrs.ModuleSourceRegistry, manifest modsdir.Manifest, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*tfconfig.Module, *version.Version, tfdiags.Diagnostics) { +func (i *ModuleInstaller) installRegistryModule(ctx context.Context, req *earlyconfig.ModuleRequest, key string, instPath string, addr addrs.ModuleSourceRegistry, manifest modsdir.Manifest, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*tfconfig.Module, *version.Version, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics hostname := addr.PackageAddr.Host @@ -324,7 +326,7 @@ func (i *ModuleInstaller) installRegistryModule(req *earlyconfig.ModuleRequest, } else { var err error log.Printf("[DEBUG] %s listing available versions of %s at %s", key, addr, hostname) - resp, err = reg.ModuleVersions(regsrcAddr) + resp, err = reg.ModuleVersions(ctx, regsrcAddr) if err != nil { if registry.IsModuleNotFound(err) { diags = diags.Append(tfdiags.Sourceless( @@ -332,6 +334,12 @@ func (i *ModuleInstaller) installRegistryModule(req *earlyconfig.ModuleRequest, "Module not found", fmt.Sprintf("Module %q (from %s:%d) cannot be found in the module registry at %s.", req.Name, req.CallPos.Filename, req.CallPos.Line, hostname), )) + } else if errors.Is(err, context.Canceled) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Module installation was interrupted", + fmt.Sprintf("Received interrupt signal while retrieving available versions for module %q.", req.Name), + )) } else { diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, @@ -423,7 +431,7 @@ func (i *ModuleInstaller) installRegistryModule(req *earlyconfig.ModuleRequest, // first check the cache for the download URL moduleAddr := moduleVersion{module: packageAddr, version: latestMatch.String()} if _, exists := i.registryPackageSources[moduleAddr]; !exists { - realAddrRaw, err := reg.ModuleLocation(regsrcAddr, latestMatch.String()) + realAddrRaw, err := reg.ModuleLocation(ctx, regsrcAddr, latestMatch.String()) if err != nil { log.Printf("[ERROR] %s from %s %s: %s", key, addr, latestMatch, err) diags = diags.Append(tfdiags.Sourceless( @@ -463,7 +471,15 @@ func (i *ModuleInstaller) installRegistryModule(req *earlyconfig.ModuleRequest, log.Printf("[TRACE] ModuleInstaller: %s %s %s is available at %q", key, packageAddr, latestMatch, dlAddr.PackageAddr) - err := fetcher.FetchPackage(instPath, dlAddr.PackageAddr.String()) + err := fetcher.FetchPackage(ctx, instPath, dlAddr.PackageAddr.String()) + if errors.Is(err, context.Canceled) { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Module download was interrupted", + fmt.Sprintf("Interrupt signal received when downloading module %s.", addr), + )) + return nil, nil, diags + } if err != nil { // Errors returned by go-getter have very inconsistent quality as // end-user error messages, but for now we're accepting that because @@ -519,7 +535,7 @@ func (i *ModuleInstaller) installRegistryModule(req *earlyconfig.ModuleRequest, return mod, latestMatch, diags } -func (i *ModuleInstaller) installGoGetterModule(req *earlyconfig.ModuleRequest, key string, instPath string, manifest modsdir.Manifest, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*tfconfig.Module, tfdiags.Diagnostics) { +func (i *ModuleInstaller) installGoGetterModule(ctx context.Context, req *earlyconfig.ModuleRequest, key string, instPath string, manifest modsdir.Manifest, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*tfconfig.Module, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // Report up to the caller that we're about to start downloading. @@ -536,7 +552,7 @@ func (i *ModuleInstaller) installGoGetterModule(req *earlyconfig.ModuleRequest, return nil, diags } - err := fetcher.FetchPackage(instPath, packageAddr.String()) + err := fetcher.FetchPackage(ctx, instPath, packageAddr.String()) if err != nil { // go-getter generates a poor error for an invalid relative path, so // we'll detect that case and generate a better one. diff --git a/internal/initwd/module_install_test.go b/internal/initwd/module_install_test.go index 223ca1ca7599..534ef5840b9e 100644 --- a/internal/initwd/module_install_test.go +++ b/internal/initwd/module_install_test.go @@ -2,6 +2,7 @@ package initwd import ( "bytes" + "context" "flag" "fmt" "io/ioutil" @@ -39,7 +40,7 @@ func TestModuleInstaller(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) assertNoDiagnostics(t, diags) wantCalls := []testInstallHookCall{ @@ -100,7 +101,7 @@ func TestModuleInstaller_error(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) if !diags.HasErrors() { t.Fatal("expected error") @@ -135,7 +136,7 @@ func TestModuleInstaller_packageEscapeError(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) if !diags.HasErrors() { t.Fatal("expected error") @@ -170,7 +171,7 @@ func TestModuleInstaller_explicitPackageBoundary(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) if diags.HasErrors() { t.Fatalf("unexpected errors\n%s", diags.Err().Error()) @@ -186,7 +187,7 @@ func TestModuleInstaller_invalid_version_constraint_error(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) if !diags.HasErrors() { t.Fatal("expected error") @@ -204,7 +205,7 @@ func TestModuleInstaller_invalidVersionConstraintGetter(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) if !diags.HasErrors() { t.Fatal("expected error") @@ -222,7 +223,7 @@ func TestModuleInstaller_invalidVersionConstraintLocal(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) if !diags.HasErrors() { t.Fatal("expected error") @@ -240,7 +241,7 @@ func TestModuleInstaller_symlink(t *testing.T) { modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, nil) - _, diags := inst.InstallModules(".", false, hooks) + _, diags := inst.InstallModules(context.Background(), ".", false, hooks) assertNoDiagnostics(t, diags) wantCalls := []testInstallHookCall{ @@ -313,7 +314,7 @@ func TestLoaderInstallModules_registry(t *testing.T) { hooks := &testInstallHooks{} modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, registry.NewClient(nil, nil)) - _, diags := inst.InstallModules(dir, false, hooks) + _, diags := inst.InstallModules(context.Background(), dir, false, hooks) assertNoDiagnostics(t, diags) v := version.Must(version.NewVersion("0.0.1")) @@ -473,7 +474,7 @@ func TestLoaderInstallModules_goGetter(t *testing.T) { hooks := &testInstallHooks{} modulesDir := filepath.Join(dir, ".terraform/modules") inst := NewModuleInstaller(modulesDir, registry.NewClient(nil, nil)) - _, diags := inst.InstallModules(dir, false, hooks) + _, diags := inst.InstallModules(context.Background(), dir, false, hooks) assertNoDiagnostics(t, diags) wantCalls := []testInstallHookCall{ diff --git a/internal/initwd/testing.go b/internal/initwd/testing.go index 320540daab9b..406718159c43 100644 --- a/internal/initwd/testing.go +++ b/internal/initwd/testing.go @@ -1,6 +1,7 @@ package initwd import ( + "context" "testing" "github.com/hashicorp/terraform/internal/configs" @@ -35,7 +36,7 @@ func LoadConfigForTests(t *testing.T, rootDir string) (*configs.Config, *configl loader, cleanup := configload.NewLoaderForTests(t) inst := NewModuleInstaller(loader.ModulesDir(), registry.NewClient(nil, nil)) - _, moreDiags := inst.InstallModules(rootDir, true, ModuleInstallHooksImpl{}) + _, moreDiags := inst.InstallModules(context.Background(), rootDir, true, ModuleInstallHooksImpl{}) diags = diags.Append(moreDiags) if diags.HasErrors() { cleanup() diff --git a/internal/refactoring/move_validate_test.go b/internal/refactoring/move_validate_test.go index 49f8acd86bff..986c1d5db301 100644 --- a/internal/refactoring/move_validate_test.go +++ b/internal/refactoring/move_validate_test.go @@ -1,6 +1,7 @@ package refactoring import ( + "context" "strings" "testing" @@ -419,7 +420,7 @@ func loadRefactoringFixture(t *testing.T, dir string) (*configs.Config, instance defer cleanup() inst := initwd.NewModuleInstaller(loader.ModulesDir(), registry.NewClient(nil, nil)) - _, instDiags := inst.InstallModules(dir, true, initwd.ModuleInstallHooksImpl{}) + _, instDiags := inst.InstallModules(context.Background(), dir, true, initwd.ModuleInstallHooksImpl{}) if instDiags.HasErrors() { t.Fatal(instDiags.Err()) } diff --git a/internal/registry/client.go b/internal/registry/client.go index 495048486071..0204674bbf05 100644 --- a/internal/registry/client.go +++ b/internal/registry/client.go @@ -1,6 +1,7 @@ package registry import ( + "context" "encoding/json" "fmt" "io/ioutil" @@ -109,7 +110,7 @@ func (c *Client) Discover(host svchost.Hostname, serviceID string) (*url.URL, er } // ModuleVersions queries the registry for a module, and returns the available versions. -func (c *Client) ModuleVersions(module *regsrc.Module) (*response.ModuleVersions, error) { +func (c *Client) ModuleVersions(ctx context.Context, module *regsrc.Module) (*response.ModuleVersions, error) { host, err := module.SvcHost() if err != nil { return nil, err @@ -133,6 +134,7 @@ func (c *Client) ModuleVersions(module *regsrc.Module) (*response.ModuleVersions if err != nil { return nil, err } + req = req.WithContext(ctx) c.addRequestCreds(host, req.Request) req.Header.Set(xTerraformVersion, tfVersion) @@ -182,7 +184,7 @@ func (c *Client) addRequestCreds(host svchost.Hostname, req *http.Request) { // ModuleLocation find the download location for a specific version module. // This returns a string, because the final location may contain special go-getter syntax. -func (c *Client) ModuleLocation(module *regsrc.Module, version string) (string, error) { +func (c *Client) ModuleLocation(ctx context.Context, module *regsrc.Module, version string) (string, error) { host, err := module.SvcHost() if err != nil { return "", err @@ -211,6 +213,8 @@ func (c *Client) ModuleLocation(module *regsrc.Module, version string) (string, return "", err } + req = req.WithContext(ctx) + c.addRequestCreds(host, req.Request) req.Header.Set(xTerraformVersion, tfVersion) diff --git a/internal/registry/client_test.go b/internal/registry/client_test.go index 765c3b001c03..da3055110a0c 100644 --- a/internal/registry/client_test.go +++ b/internal/registry/client_test.go @@ -103,7 +103,7 @@ func TestLookupModuleVersions(t *testing.T) { t.Fatal(err) } - resp, err := client.ModuleVersions(modsrc) + resp, err := client.ModuleVersions(context.Background(), modsrc) if err != nil { t.Fatal(err) } @@ -143,7 +143,7 @@ func TestInvalidRegistry(t *testing.T) { t.Fatal(err) } - if _, err := client.ModuleVersions(modsrc); err == nil { + if _, err := client.ModuleVersions(context.Background(), modsrc); err == nil { t.Fatal("expected error") } } @@ -160,11 +160,11 @@ func TestRegistryAuth(t *testing.T) { t.Fatal(err) } - _, err = client.ModuleVersions(mod) + _, err = client.ModuleVersions(context.Background(), mod) if err != nil { t.Fatal(err) } - _, err = client.ModuleLocation(mod, "1.0.0") + _, err = client.ModuleLocation(context.Background(), mod, "1.0.0") if err != nil { t.Fatal(err) } @@ -173,11 +173,11 @@ func TestRegistryAuth(t *testing.T) { client.services.SetCredentialsSource(nil) // both should fail without auth - _, err = client.ModuleVersions(mod) + _, err = client.ModuleVersions(context.Background(), mod) if err == nil { t.Fatal("expected error") } - _, err = client.ModuleLocation(mod, "1.0.0") + _, err = client.ModuleLocation(context.Background(), mod, "1.0.0") if err == nil { t.Fatal("expected error") } @@ -195,7 +195,7 @@ func TestLookupModuleLocationRelative(t *testing.T) { t.Fatal(err) } - got, err := client.ModuleLocation(mod, "0.2.0") + got, err := client.ModuleLocation(context.Background(), mod, "0.2.0") if err != nil { t.Fatal(err) } @@ -224,7 +224,7 @@ func TestAccLookupModuleVersions(t *testing.T) { } s := NewClient(regDisco, nil) - resp, err := s.ModuleVersions(modsrc) + resp, err := s.ModuleVersions(context.Background(), modsrc) if err != nil { t.Fatal(err) } @@ -277,7 +277,7 @@ func TestLookupLookupModuleError(t *testing.T) { return oldCheck(ctx, resp, err) } - _, err = client.ModuleLocation(mod, "0.2.0") + _, err = client.ModuleLocation(context.Background(), mod, "0.2.0") if err == nil { t.Fatal("expected error") } @@ -299,7 +299,7 @@ func TestLookupModuleRetryError(t *testing.T) { if err != nil { t.Fatal(err) } - resp, err := client.ModuleVersions(modsrc) + resp, err := client.ModuleVersions(context.Background(), modsrc) if err == nil { t.Fatal("expected requests to exceed retry", err) } @@ -328,7 +328,7 @@ func TestLookupModuleNoRetryError(t *testing.T) { if err != nil { t.Fatal(err) } - resp, err := client.ModuleVersions(modsrc) + resp, err := client.ModuleVersions(context.Background(), modsrc) if err == nil { t.Fatal("expected request to fail", err) } @@ -354,7 +354,7 @@ func TestLookupModuleNetworkError(t *testing.T) { if err != nil { t.Fatal(err) } - resp, err := client.ModuleVersions(modsrc) + resp, err := client.ModuleVersions(context.Background(), modsrc) if err == nil { t.Fatal("expected request to fail", err) } diff --git a/internal/terraform/terraform_test.go b/internal/terraform/terraform_test.go index 7eccb51c2b5f..51c1579ecc1c 100644 --- a/internal/terraform/terraform_test.go +++ b/internal/terraform/terraform_test.go @@ -1,6 +1,7 @@ package terraform import ( + "context" "flag" "io" "io/ioutil" @@ -61,7 +62,7 @@ func testModuleWithSnapshot(t *testing.T, name string) (*configs.Config, *config // sources only this ultimately just records all of the module paths // in a JSON file so that we can load them below. inst := initwd.NewModuleInstaller(loader.ModulesDir(), registry.NewClient(nil, nil)) - _, instDiags := inst.InstallModules(dir, true, initwd.ModuleInstallHooksImpl{}) + _, instDiags := inst.InstallModules(context.Background(), dir, true, initwd.ModuleInstallHooksImpl{}) if instDiags.HasErrors() { t.Fatal(instDiags.Err()) } @@ -119,7 +120,7 @@ func testModuleInline(t *testing.T, sources map[string]string) *configs.Config { // sources only this ultimately just records all of the module paths // in a JSON file so that we can load them below. inst := initwd.NewModuleInstaller(loader.ModulesDir(), registry.NewClient(nil, nil)) - _, instDiags := inst.InstallModules(cfgPath, true, initwd.ModuleInstallHooksImpl{}) + _, instDiags := inst.InstallModules(context.Background(), cfgPath, true, initwd.ModuleInstallHooksImpl{}) if instDiags.HasErrors() { t.Fatal(instDiags.Err()) } From 70228764940e0dbdd2bbfc506fe48c8d7b7bae06 Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Thu, 4 Nov 2021 12:40:45 +0000 Subject: [PATCH 330/644] bump go-getter to v1.5.9 --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index e0dc22906251..498cefd4025b 100644 --- a/go.mod +++ b/go.mod @@ -36,7 +36,7 @@ require ( github.com/hashicorp/go-azure-helpers v0.14.0 github.com/hashicorp/go-checkpoint v0.5.0 github.com/hashicorp/go-cleanhttp v0.5.2 - github.com/hashicorp/go-getter v1.5.2 + github.com/hashicorp/go-getter v1.5.9 github.com/hashicorp/go-hclog v0.15.0 github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 diff --git a/go.sum b/go.sum index addfc11f7f0a..ddbdbe998d43 100644 --- a/go.sum +++ b/go.sum @@ -350,8 +350,8 @@ github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtng github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= -github.com/hashicorp/go-getter v1.5.2 h1:XDo8LiAcDisiqZdv0TKgz+HtX3WN7zA2JD1R1tjsabE= -github.com/hashicorp/go-getter v1.5.2/go.mod h1:orNH3BTYLu/fIxGIdLjLoAJHWMDQ/UKQr5O4m3iBuoo= +github.com/hashicorp/go-getter v1.5.9 h1:b7ahZW50iQiUek/at3CvZhPK1/jiV6CtKcsJiR6E4R0= +github.com/hashicorp/go-getter v1.5.9/go.mod h1:BrrV/1clo8cCYu6mxvboYg+KutTiFnXjMEgDD8+i7ZI= github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= github.com/hashicorp/go-hclog v0.12.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= From 6da61bf07b527e9c6c5ac1e04d6adb068a15ead3 Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Tue, 9 Nov 2021 13:15:13 +0000 Subject: [PATCH 331/644] revert change to installModules diag handling Error diags from c.installModules() no longer cause getModules() to exit early. Whether installModules completed successfully, errored, or was cancelled, we try to update the manifest as best we can, preferring incomplete information to none. --- internal/command/init.go | 9 +++++---- internal/command/meta_config.go | 2 -- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index b8ba6b9ff61b..a44fba3dce11 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -345,9 +345,10 @@ func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrad installAbort, installDiags := c.installModules(path, upgrade, hooks) diags = diags.Append(installDiags) - if installAbort || installDiags.HasErrors() { - return true, true, diags - } + + // At this point, installModules may have generated error diags or been + // aborted by SIGINT. In any case we continue and the manifest as best + // we can. // Since module installer has modified the module manifest on disk, we need // to refresh the cache of it in the loader. @@ -362,7 +363,7 @@ func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrad } } - return true, false, diags + return true, installAbort, diags } func (c *InitCommand) initCloud(root *configs.Module) (be backend.Backend, output bool, diags tfdiags.Diagnostics) { diff --git a/internal/command/meta_config.go b/internal/command/meta_config.go index 0abaf52a7c7b..d19389283928 100644 --- a/internal/command/meta_config.go +++ b/internal/command/meta_config.go @@ -178,8 +178,6 @@ func (m *Meta) installModules(rootDir string, upgrade bool, hooks initwd.ModuleI diags = diags.Append(fmt.Errorf("failed to create local modules directory: %s", err)) return true, diags } - // FIXME: KEM: does returning the abort here change behaviour in a particular error - // case? inst := m.moduleInstaller() From 40174b634ac54e3f4926ede57e642a346740d780 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 11 Nov 2021 10:15:29 -0500 Subject: [PATCH 332/644] ignore_changes changing a null map to empty Fix an error where using `ignore_changes` would cause some null maps to be saved as an empty map. --- internal/terraform/node_resource_abstract_instance.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index 3cab2b181a99..b7b781191bc4 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -1289,10 +1289,15 @@ func processIgnoreChangesIndividual(prior, config cty.Value, ignoreChangesPath [ } var newVal cty.Value - if len(configMap) == 0 { - newVal = cty.MapValEmpty(v.Type().ElementType()) - } else { + switch { + case len(configMap) > 0: newVal = cty.MapVal(configMap) + case v.IsNull(): + // if the config value was null, and no values remain in the map, + // reset the value to null. + newVal = v + default: + newVal = cty.MapValEmpty(v.Type().ElementType()) } if len(vMarks) > 0 { From 9d19086c8eeef6b8ca5275f8d18d45033d81ed48 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Thu, 11 Nov 2021 10:42:36 -0500 Subject: [PATCH 333/644] test for null map and fix lost map marks Add a test to ensure ignore_changes does not change null maps to empty maps. Fix when a marked map revers the changes ignored within that map. --- .../node_resource_abstract_instance.go | 2 +- internal/terraform/reduce_plan_test.go | 48 +++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index b7b781191bc4..d2b6489be3dc 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -1301,7 +1301,7 @@ func processIgnoreChangesIndividual(prior, config cty.Value, ignoreChangesPath [ } if len(vMarks) > 0 { - newVal = v.WithMarks(vMarks) + newVal = newVal.WithMarks(vMarks) } return newVal, nil diff --git a/internal/terraform/reduce_plan_test.go b/internal/terraform/reduce_plan_test.go index 2d134d2c2852..f32101aaf582 100644 --- a/internal/terraform/reduce_plan_test.go +++ b/internal/terraform/reduce_plan_test.go @@ -369,6 +369,54 @@ func TestProcessIgnoreChangesIndividual(t *testing.T) { "b": cty.StringVal("new b value"), }), }, + "null_map": { + cty.ObjectVal(map[string]cty.Value{ + "a": cty.StringVal("ok"), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "s": cty.StringVal("ok"), + "map": cty.NullVal(cty.Map(cty.String)), + }), + }), + }), + cty.ObjectVal(map[string]cty.Value{ + "a": cty.NullVal(cty.String), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "s": cty.StringVal("ok"), + "map": cty.NullVal(cty.Map(cty.String)), + }), + }), + }), + []string{"a"}, + cty.ObjectVal(map[string]cty.Value{ + "a": cty.StringVal("ok"), + "list": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "s": cty.StringVal("ok"), + "map": cty.NullVal(cty.Map(cty.String)), + }), + }), + }), + }, + "marked_map": { + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "key": cty.StringVal("val"), + }).Mark("marked"), + }), + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "key": cty.StringVal("new val"), + }).Mark("marked"), + }), + []string{`map["key"]`}, + cty.ObjectVal(map[string]cty.Value{ + "map": cty.MapVal(map[string]cty.Value{ + "key": cty.StringVal("val"), + }).Mark("marked"), + }), + }, } for name, test := range tests { From 051bf5df7ed2ab888396c8889a5ca3be1d3d382d Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Thu, 11 Nov 2021 09:57:23 -0700 Subject: [PATCH 334/644] update to go-tfe@tfc-integration --- go.mod | 4 ++-- go.sum | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/go.mod b/go.mod index baf63ab1e506..4c4a4f43a4d3 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.20.1-0.20211101140842-a4cb47d035cf + github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.2.1 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f @@ -176,7 +176,7 @@ require ( go.uber.org/multierr v1.1.0 // indirect go.uber.org/zap v1.10.0 // indirect golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5 // indirect - golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect + golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/appengine v1.6.7 // indirect google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect diff --git a/go.sum b/go.sum index d4e2a4a3995f..b732de768098 100644 --- a/go.sum +++ b/go.sum @@ -379,8 +379,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.20.1-0.20211101140842-a4cb47d035cf h1:VItt+uNOHWOAvWyHqhmGRJpec4yRmL24+gccz8b7bHw= -github.com/hashicorp/go-tfe v0.20.1-0.20211101140842-a4cb47d035cf/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa h1:6LHPSBzcYJwMO+iBSOCTY1ZvMc3EeIuD4okEM7p7G7c= +github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= @@ -884,8 +884,9 @@ golang.org/x/time v0.0.0-20161028155119-f51c12702a4d/go.mod h1:tRJNPiyCQ0inRvYxb golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/time v0.0.0-20191024005414-555d28b269f0 h1:/5xXl8Y5W96D+TtHSlonuFqGHIWVuyCkGJLwGh9JJFs= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac h1:7zkz7BUtwNFFqcowJ+RIgu2MaV/MapERkDIy+mwPyjs= +golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20181011042414-1f849cf54d09/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= From 1f01ba4dbcfb8850a3f3c9a9c3c2a426208e1794 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Tue, 9 Nov 2021 17:02:59 -0700 Subject: [PATCH 335/644] fix(run variables): support all variable types (map, list, bool, number, null, string) All run variables remain encoded as strings in the API but will now be expressed as an HCL value to be evaluated correctly by the remote terraform. Previously, only strings were supported. Examples: string: `"quoted literal"` (strings must be quoted) map: `{ foo = "bar" }` list: `["foo", "bar"]` bool: `true` null: `null` number: `0.0001` This requires the API to anticipate that all run variables will be HCL values --- internal/cloud/backend_plan_test.go | 4 +- internal/cloud/cloud_variables.go | 20 ++---- internal/cloud/cloud_variables_test.go | 92 ++++++++++++++++++++++---- 3 files changed, 85 insertions(+), 31 deletions(-) diff --git a/internal/cloud/backend_plan_test.go b/internal/cloud/backend_plan_test.go index ba2508091365..162a9841aa33 100644 --- a/internal/cloud/backend_plan_test.go +++ b/internal/cloud/backend_plan_test.go @@ -477,7 +477,7 @@ func TestCloud_planWithRequiredVariables(t *testing.T) { defer configCleanup() defer done(t) - op.Variables = testVariables(terraform.ValueFromCLIArg, "foo") // "bar" variable value missing + op.Variables = testVariables(terraform.ValueFromCLIArg, "foo") // "bar" variable defined in config is missing op.Workspace = testBackendSingleWorkspaceName run, err := b.Operation(context.Background(), op) @@ -487,7 +487,7 @@ func TestCloud_planWithRequiredVariables(t *testing.T) { <-run.Done() // The usual error of a required variable being missing is deferred and the operation - // is successful + // is successful. if run.Result != backend.OperationSuccess { t.Fatal("expected plan operation to succeed") } diff --git a/internal/cloud/cloud_variables.go b/internal/cloud/cloud_variables.go index 9a900282862d..af6d6afcfbc1 100644 --- a/internal/cloud/cloud_variables.go +++ b/internal/cloud/cloud_variables.go @@ -1,14 +1,11 @@ package cloud import ( - "encoding/json" - "fmt" - + "github.com/hashicorp/hcl/v2/hclwrite" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" - ctyjson "github.com/zclconf/go-cty/cty/json" ) func allowedSourceType(source terraform.ValueSourceType) bool { @@ -17,7 +14,7 @@ func allowedSourceType(source terraform.ValueSourceType) bool { // ParseCloudRunVariables accepts a mapping of unparsed values and a mapping of variable // declarations and returns a name/value variable map appropriate for an API run context, -// that is, containing declared string variables only sourced from non-file inputs like CLI args +// that is, containing variables only sourced from non-file inputs like CLI args // and environment variables. However, all variable parsing diagnostics are returned // in order to allow callers to short circuit cloud runs that contain variable // declaration or parsing errors. The only exception is that missing required values are not @@ -36,16 +33,9 @@ func ParseCloudRunVariables(vv map[string]backend.UnparsedVariableValue, decls m continue } - valueData, err := ctyjson.Marshal(v.Value, v.Value.Type()) - if err != nil { - return nil, diags.Append(fmt.Errorf("error marshaling input variable value as json: %w", err)) - } - var variableValue string - if err = json.Unmarshal(valueData, &variableValue); err != nil { - // This should never happen since cty marshaled the value to begin with without error - return nil, diags.Append(fmt.Errorf("error unmarshaling run variable: %w", err)) - } - ret[name] = variableValue + // RunVariables are always expressed as HCL strings + tokens := hclwrite.TokensForValue(v.Value) + ret[name] = string(tokens.Bytes()) } return ret, diags diff --git a/internal/cloud/cloud_variables_test.go b/internal/cloud/cloud_variables_test.go index f8a8a5f1cf34..9780f788c154 100644 --- a/internal/cloud/cloud_variables_test.go +++ b/internal/cloud/cloud_variables_test.go @@ -15,11 +15,16 @@ import ( func TestParseCloudRunVariables(t *testing.T) { t.Run("populates variables from allowed sources", func(t *testing.T) { vv := map[string]backend.UnparsedVariableValue{ - "undeclared": testUnparsedVariableValue{source: terraform.ValueFromCLIArg, value: "0"}, - "declaredFromConfig": testUnparsedVariableValue{source: terraform.ValueFromConfig, value: "1"}, - "declaredFromNamedFile": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: "2"}, - "declaredFromCLIArg": testUnparsedVariableValue{source: terraform.ValueFromCLIArg, value: "3"}, - "declaredFromEnvVar": testUnparsedVariableValue{source: terraform.ValueFromEnvVar, value: "4"}, + "undeclared": testUnparsedVariableValue{source: terraform.ValueFromCLIArg, value: cty.StringVal("0")}, + "declaredFromConfig": testUnparsedVariableValue{source: terraform.ValueFromConfig, value: cty.StringVal("1")}, + "declaredFromNamedFileMapString": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: cty.MapVal(map[string]cty.Value{"foo": cty.StringVal("bar")})}, + "declaredFromNamedFileBool": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: cty.BoolVal(true)}, + "declaredFromNamedFileNumber": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: cty.NumberIntVal(2)}, + "declaredFromNamedFileListString": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: cty.ListVal([]cty.Value{cty.StringVal("2a"), cty.StringVal("2b")})}, + "declaredFromNamedFileNull": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: cty.NullVal(cty.String)}, + "declaredFromNamedMapComplex": testUnparsedVariableValue{source: terraform.ValueFromNamedFile, value: cty.MapVal(map[string]cty.Value{"foo": cty.ObjectVal(map[string]cty.Value{"qux": cty.ListVal([]cty.Value{cty.BoolVal(true), cty.BoolVal(false)})})})}, + "declaredFromCLIArg": testUnparsedVariableValue{source: terraform.ValueFromCLIArg, value: cty.StringVal("3")}, + "declaredFromEnvVar": testUnparsedVariableValue{source: terraform.ValueFromEnvVar, value: cty.StringVal("4")}, } decls := map[string]*configs.Variable{ @@ -34,11 +39,66 @@ func TestParseCloudRunVariables(t *testing.T) { End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, }, }, - "declaredFromNamedFile": { - Name: "declaredFromNamedFile", + "declaredFromNamedFileMapString": { + Name: "declaredFromNamedFileMapString", + Type: cty.Map(cty.String), + ConstraintType: cty.Map(cty.String), + ParsingMode: configs.VariableParseHCL, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromNamedFileBool": { + Name: "declaredFromNamedFileBool", + Type: cty.Bool, + ConstraintType: cty.Bool, + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromNamedFileNumber": { + Name: "declaredFromNamedFileNumber", + Type: cty.Number, + ConstraintType: cty.Number, + ParsingMode: configs.VariableParseLiteral, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromNamedFileListString": { + Name: "declaredFromNamedFileListString", + Type: cty.List(cty.String), + ConstraintType: cty.List(cty.String), + ParsingMode: configs.VariableParseHCL, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromNamedFileNull": { + Name: "declaredFromNamedFileNull", Type: cty.String, ConstraintType: cty.String, - ParsingMode: configs.VariableParseLiteral, + ParsingMode: configs.VariableParseHCL, + DeclRange: hcl.Range{ + Filename: "fake.tf", + Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + End: hcl.Pos{Line: 2, Column: 1, Byte: 0}, + }, + }, + "declaredFromNamedMapComplex": { + Name: "declaredFromNamedMapComplex", + Type: cty.DynamicPseudoType, + ConstraintType: cty.DynamicPseudoType, + ParsingMode: configs.VariableParseHCL, DeclRange: hcl.Range{ Filename: "fake.tf", Start: hcl.Pos{Line: 2, Column: 1, Byte: 0}, @@ -81,10 +141,14 @@ func TestParseCloudRunVariables(t *testing.T) { }, } wantVals := make(map[string]string) - - wantVals["declaredFromNamedFile"] = "2" - wantVals["declaredFromCLIArg"] = "3" - wantVals["declaredFromEnvVar"] = "4" + wantVals["declaredFromNamedFileBool"] = "true" + wantVals["declaredFromNamedFileNumber"] = "2" + wantVals["declaredFromNamedFileListString"] = `["2a", "2b"]` + wantVals["declaredFromNamedFileNull"] = "null" + wantVals["declaredFromNamedFileMapString"] = "{\n foo = \"bar\"\n}" + wantVals["declaredFromNamedMapComplex"] = "{\n foo = {\n qux = [true, false]\n }\n}" + wantVals["declaredFromCLIArg"] = `"3"` + wantVals["declaredFromEnvVar"] = `"4"` gotVals, diags := ParseCloudRunVariables(vv, decls) if diff := cmp.Diff(wantVals, gotVals, cmp.Comparer(cty.Value.RawEquals)); diff != "" { @@ -103,12 +167,12 @@ func TestParseCloudRunVariables(t *testing.T) { type testUnparsedVariableValue struct { source terraform.ValueSourceType - value string + value cty.Value } func (v testUnparsedVariableValue) ParseVariableValue(mode configs.VariableParsingMode) (*terraform.InputValue, tfdiags.Diagnostics) { return &terraform.InputValue{ - Value: cty.StringVal(v.value), + Value: v.value, SourceType: v.source, SourceRange: tfdiags.SourceRange{ Filename: "fake.tfvars", From 5ef82ddd2f363cc137b322f3f10dd03007733dc7 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 3 Nov 2021 15:47:14 -0500 Subject: [PATCH 336/644] Cloud: fix e2e tests - Fix tests and remove commented code - Remove parallel for some flaky tests - Add README --- go.mod | 2 +- go.sum | 3 +- internal/cloud/e2e/README.md | 25 + internal/cloud/e2e/apply_auto_approve_test.go | 111 +- .../e2e/backend_apply_before_init_test.go | 109 +- internal/cloud/e2e/helper_test.go | 30 +- .../cloud/e2e/init_with_empty_tags_test.go | 103 +- internal/cloud/e2e/main_test.go | 6 + .../e2e/migrate_state_multi_to_tfc_test.go | 296 ++- ...igrate_state_remote_backend_to_tfc_test.go | 1657 +++++++++-------- .../e2e/migrate_state_single_to_tfc_test.go | 121 +- .../e2e/migrate_state_tfc_to_other_test.go | 104 +- .../e2e/migrate_state_tfc_to_tfc_test.go | 250 ++- internal/cloud/e2e/run_variables_test.go | 117 +- 14 files changed, 1546 insertions(+), 1388 deletions(-) create mode 100644 internal/cloud/e2e/README.md diff --git a/go.mod b/go.mod index 4700526c9d5b..a830edcc323a 100644 --- a/go.mod +++ b/go.mod @@ -43,7 +43,7 @@ require ( github.com/hashicorp/go-retryablehttp v0.7.0 github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa github.com/hashicorp/go-uuid v1.0.2 - github.com/hashicorp/go-version v1.2.1 + github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f github.com/hashicorp/hcl/v2 v2.10.1 github.com/hashicorp/terraform-config-inspect v0.0.0-20210209133302-4fd17a0faac2 diff --git a/go.sum b/go.sum index 2298eacdd13c..f7d7f23db845 100644 --- a/go.sum +++ b/go.sum @@ -388,8 +388,9 @@ github.com/hashicorp/go-uuid v1.0.2/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/b github.com/hashicorp/go-version v1.0.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.1.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= -github.com/hashicorp/go-version v1.2.1 h1:zEfKbn2+PDgroKdiOzqiE8rsmLqU2uwi5PB5pBJ3TkI= github.com/hashicorp/go-version v1.2.1/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= +github.com/hashicorp/go-version v1.3.0 h1:McDWVJIU/y+u1BRV06dPaLfLCaT7fUTJLp5r04x7iNw= +github.com/hashicorp/go-version v1.3.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= github.com/hashicorp/golang-lru v0.5.1 h1:0hERBMJE1eitiLkihrMvRVBYAkpHzc/J3QdDN+dAcgU= github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= diff --git a/internal/cloud/e2e/README.md b/internal/cloud/e2e/README.md new file mode 100644 index 000000000000..02a50bbfeeb9 --- /dev/null +++ b/internal/cloud/e2e/README.md @@ -0,0 +1,25 @@ +# How to run tests + +To run them, use: +``` +TF_ACC=1 go test -tags=e2e ./internal/cloud/e2e/... -ldflags "-X \"github.com/hashicorp/terraform/version.Prerelease=\"" +``` + +Required flags +* `-tags=e2e` for running e2e tests. +* `TF_ACC=1`. This variable is used as part of terraform for tests that make + external network calls. This is needed to run these tests. Without it, the + tests do not run. +* `TFE_TOKEN=` and `TFE_HOSTNAME=`. The helpers +for these tests require admin access to a TFC/TFE instance. +* `-timeout=30m`. Some of these tests take longer than the default 10m timeout for `go test`. + +### Flags + +* Use the `-v` flag for normal verbose mode. +* Use the `-tfoutput` flag to print the terraform output to standard out. +* Use `-ldflags` to change the version Prerelease to match a version +available remotely. Some behaviors rely on the exact local version Terraform +being available in TFC/TFE, and manipulating the Prerelease during build is +often the only way to ensure this. +[(More on `-ldflags`.)](https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index cf27a422dd68..1689caedb373 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -6,7 +6,6 @@ package main import ( "context" "io/ioutil" - "log" "os" "testing" @@ -17,7 +16,6 @@ import ( ) func Test_terraform_apply_autoApprove(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -184,74 +182,75 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, } for name, tc := range cases { - log.Println("Test: ", name) - - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=info") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - err = cmd.Start() - if err != nil { - t.Fatal(err) - } - - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil { - t.Fatal(err) + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } } } - } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if tc.validations != nil { + tc.validations(t, organization.Name) + } + }) } } diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index c3b0becb7969..48d3f3d40b12 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -4,7 +4,6 @@ package main import ( - "fmt" "io/ioutil" "os" "testing" @@ -51,10 +50,8 @@ func Test_backend_apply_before_init(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -77,68 +74,70 @@ func Test_backend_apply_before_init(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=info") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil && !tfCmd.expectError { - t.Fatal(err) + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } } } - } + }) } } diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 0f4480ddfc31..87ed67654e56 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -10,8 +10,10 @@ import ( "testing" "time" + expect "github.com/Netflix/go-expect" tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/go-uuid" + goversion "github.com/hashicorp/go-version" tfversion "github.com/hashicorp/terraform/version" ) @@ -38,6 +40,16 @@ type testCases map[string]struct { validations func(t *testing.T, orgName string) } +func defaultOpts() []expect.ConsoleOpt { + opts := []expect.ConsoleOpt{ + expect.WithDefaultTimeout(expectConsoleTimeout), + } + if verboseMode { + opts = append(opts, expect.WithStdout(os.Stdout)) + } + return opts +} + func createOrganization(t *testing.T) (*tfe.Organization, func()) { ctx := context.Background() org, err := tfeClient.Organizations.Create(ctx, tfe.OrganizationCreateOptions{ @@ -193,9 +205,16 @@ func writeMainTF(t *testing.T, block string, dir string) { f.Close() } -// Ensure that TFC/E has a particular terraform version. +// The e2e tests rely on the fact that the terraform version in TFC/E is able to +// run the `cloud` configuration block, which is available in 1.1 and will +// continue to be available in later versions. So this function checks that +// there is a version that is >= 1.1. func skipWithoutRemoteTerraformVersion(t *testing.T) { - version := tfversion.String() + version := tfversion.Version + baseVersion, err := goversion.NewVersion(version) + if err != nil { + t.Fatalf(fmt.Sprintf("Error instantiating go-version for %s", version)) + } opts := tfe.AdminTerraformVersionsListOptions{ ListOptions: tfe.ListOptions{ PageNumber: 1, @@ -213,7 +232,12 @@ findTfVersion: t.Fatalf("Could not retrieve list of terraform versions: %v", err) } for _, item := range tfVersionList.Items { - if item.Version == version { + availableVersion, err := goversion.NewVersion(item.Version) + if err != nil { + t.Logf("Error instantiating go-version for %s", item.Version) + continue + } + if availableVersion.Core().GreaterThanOrEqual(baseVersion.Core()) { hasVersion = true break findTfVersion } diff --git a/internal/cloud/e2e/init_with_empty_tags_test.go b/internal/cloud/e2e/init_with_empty_tags_test.go index 8b8f4807c12d..15bc3ba18f7f 100644 --- a/internal/cloud/e2e/init_with_empty_tags_test.go +++ b/internal/cloud/e2e/init_with_empty_tags_test.go @@ -4,7 +4,6 @@ package main import ( - "fmt" "io/ioutil" "os" "testing" @@ -42,68 +41,70 @@ func Test_init_with_empty_tags(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=info") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil && !tfCmd.expectError { - t.Fatal(err) + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } } } - } + }) } } diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index 48e40b81ff8c..783dc4d201de 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -4,6 +4,7 @@ package main import ( + "flag" "fmt" "io/ioutil" "log" @@ -22,6 +23,7 @@ var cliConfigFileEnv string var tfeClient *tfe.Client var tfeHostname string var tfeToken string +var verboseMode bool func TestMain(m *testing.M) { log.SetFlags(log.LstdFlags | log.Lshortfile) @@ -43,6 +45,10 @@ func accTest() bool { } func setup() func() { + tfOutput := flag.Bool("tfoutput", false, "This flag produces the terraform output from tests.") + flag.Parse() + verboseMode = *tfOutput + setTfeClient() teardown := setupBinary() diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 6e1bd40d931f..07c4b04f88f8 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -16,7 +16,6 @@ import ( ) func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -38,20 +37,16 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, { command: []string{"workspace", "new", "prod"}, expectedCmdOutput: `Created and switched to workspace "prod"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, { command: []string{"workspace", "select", "default"}, @@ -113,20 +108,16 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, { command: []string{"workspace", "new", "prod"}, expectedCmdOutput: `Created and switched to workspace "prod"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -171,82 +162,81 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } for name, tc := range cases { - t.Log("Test: ", name) - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - defer tf.Close() - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - t.Log("Running commands: ", tfCmd.command) - tfCmd.command = append(tfCmd.command) - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv(cliConfigFileEnv) - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + tfCmd.command = append(tfCmd.command) + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil { - t.Fatal(err) + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } } } - } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if tc.validations != nil { + tc.validations(t, organization.Name) + } + }) } - } func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -268,20 +258,16 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, { command: []string{"workspace", "new", "prod"}, expectedCmdOutput: `Created and switched to workspace "prod"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, { command: []string{"workspace", "select", "default"}, @@ -311,28 +297,27 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { { command: []string{"init", "-migrate-state"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"dev", "1", "app-*", "1"}, + userInput: []string{"dev", "1", "app-*"}, postInputOutput: []string{ `Would you like to rename your workspaces?`, - "What pattern would you like to add to all your workspaces?", - "The currently selected workspace (prod) does not exist.", + "How would you like to rename your workspaces?", "Terraform Cloud has been successfully initialized!"}, }, { - command: []string{"workspace", "select", "app-prod"}, - expectedCmdOutput: `Switched to workspace "app-prod".`, + command: []string{"workspace", "select", "app-dev"}, + expectedCmdOutput: `Switched to workspace "app-dev".`, }, { command: []string{"output"}, - expectedCmdOutput: `val = "prod"`, + expectedCmdOutput: `val = "default"`, }, { - command: []string{"workspace", "select", "app-dev"}, - expectedCmdOutput: `Switched to workspace "app-dev".`, + command: []string{"workspace", "select", "app-prod"}, + expectedCmdOutput: `Switched to workspace "app-prod".`, }, { command: []string{"output"}, - expectedCmdOutput: `val = "default"`, + expectedCmdOutput: `val = "prod"`, }, }, }, @@ -417,17 +402,12 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { { command: []string{"init", "-migrate-state"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"dev", "1", "app-*", "1"}, + userInput: []string{"dev", "1", "app-*"}, postInputOutput: []string{ `Would you like to rename your workspaces?`, - "What pattern would you like to add to all your workspaces?", - "The currently selected workspace (default) does not exist.", + "How would you like to rename your workspaces?", "Terraform Cloud has been successfully initialized!"}, }, - { - command: []string{"workspace", "select", "app-dev"}, - expectedCmdOutput: `Switched to workspace "app-dev".`, - }, { command: []string{"workspace", "select", "app-billing"}, expectedCmdOutput: `Switched to workspace "app-billing".`, @@ -436,6 +416,10 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { command: []string{"workspace", "select", "app-identity"}, expectedCmdOutput: `Switched to workspace "app-identity".`, }, + { + command: []string{"workspace", "select", "app-dev"}, + expectedCmdOutput: `Switched to workspace "app-dev".`, + }, }, }, }, @@ -466,78 +450,78 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { } for name, tc := range cases { - t.Log("Test: ", name) - organization, cleanup := createOrganization(t) - t.Log(organization.Name) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - defer tf.Close() - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - t.Log("running commands: ", tfCmd.command) - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv(cliConfigFileEnv) - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - if output == "" { - continue - } - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + if output == "" { + continue + } + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil { - t.Fatal(err) + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } } } - } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if tc.validations != nil { + tc.validations(t, organization.Name) + } + }) } } diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 7fa2d64011f9..819875e3f176 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -15,916 +15,1053 @@ import ( ) func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() - cases := map[string]struct { - operations []operationSets - validations func(t *testing.T, orgName string) - }{ - "backend name strategy, to cloud with name strategy": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - remoteWorkspace := "remote-workspace" - tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "remote"!`, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - wsName := "cloud-workspace" - tfBlock := terraformConfigCloudBackendName(orgName, wsName) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `cloud-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - expectedName := "cloud-workspace" - ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) - if err != nil { - t.Fatal(err) - } - if ws == nil { - t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) - } + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "cloud-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, }, }, - "backend name strategy, to cloud name strategy, using the same name": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - remoteWorkspace := "remote-workspace" - tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "remote"!`, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - wsName := "remote-workspace" - tfBlock := terraformConfigCloudBackendName(orgName, wsName) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `remote-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - expectedName := "remote-workspace" - ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + } + validations := func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + } + + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } - if ws == nil { - t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if validations != nil { + validations(t, organization.Name) + } +} + +func Test_migrate_remote_backend_name_to_tfc_same_name(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + ctx := context.Background() + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "remote-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `remote-workspace`, + }, }, }, } - - for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + validations := func(t *testing.T, orgName string) { + expectedName := "remote-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) if err != nil { t.Fatal(err) } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) } - defer os.RemoveAll(tmpDir) + } - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - organization, cleanup := createOrganization(t) - defer cleanup() - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - err = cmd.Start() + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } + } - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) - if err != nil { - t.Fatal(err) - } - } - - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) - } + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) } } } + } - err = cmd.Wait() - if err != nil { - t.Fatal(err) - } + err = cmd.Wait() + if err != nil { + t.Fatal(err) } } + } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if validations != nil { + validations(t, organization.Name) } } func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() - cases := map[string]struct { - operations []operationSets - validations func(t *testing.T, orgName string) - }{ - "backend name strategy, to cloud name strategy, using the same name, different organization": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - remoteWorkspace := "remote-workspace" - tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "remote"!`, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - wsName := "remote-workspace" - tfBlock := terraformConfigCloudBackendName(orgName, wsName) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `remote-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - expectedName := "remote-workspace" - ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) - if err != nil { - t.Fatal(err) - } - if ws == nil { - t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) - } + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "remote-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `remote-workspace`, + }, }, }, } - - for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + validations := func(t *testing.T, orgName string) { + expectedName := "remote-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) if err != nil { t.Fatal(err) } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) } - defer os.RemoveAll(tmpDir) - - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() - - orgOne, cleanupOne := createOrganization(t) - orgTwo, cleanupTwo := createOrganization(t) - defer cleanupOne() - defer cleanupTwo() - orgs := []string{orgOne.Name, orgTwo.Name} - var orgName string - for index, op := range tc.operations { - orgName = orgs[index] - op.prep(t, orgName, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() - - err = cmd.Start() + } + + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + orgOne, cleanupOne := createOrganization(t) + orgTwo, cleanupTwo := createOrganization(t) + defer cleanupOne() + defer cleanupTwo() + orgs := []string{orgOne.Name, orgTwo.Name} + var orgName string + for index, op := range operations { + orgName = orgs[index] + op.prep(t, orgName, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } + } - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) - if err != nil { - t.Fatal(err) - } - } - - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) - } + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) } } } + } - err = cmd.Wait() - if err != nil { - t.Fatal(err) - } + err = cmd.Wait() + if err != nil { + t.Fatal(err) } } + } - if tc.validations != nil { - tc.validations(t, orgName) - } + if validations != nil { + validations(t, orgName) } } func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() - cases := map[string]struct { - operations []operationSets - validations func(t *testing.T, orgName string) - }{ - "single workspace with backend name strategy, to cloud with tags strategy": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - remoteWorkspace := "remote-workspace" - tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `Successfully configured the backend "remote"!`, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "remote-workspace"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `default`, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - tag := "app" - tfBlock := terraformConfigCloudBackendTags(orgName, tag) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"cloud-workspace", "yes"}, - postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, - `Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `cloud-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ - Tags: tfe.String("app"), - }) - if err != nil { - t.Fatal(err) - } - if len(wsList.Items) != 1 { - t.Fatalf("Expected number of workspaces to be 1, but got %d", len(wsList.Items)) - } - ws := wsList.Items[0] - if ws.Name != "cloud-workspace" { - t.Fatalf("Expected workspace to be `cloud-workspace`, but is %s", ws.Name) - } + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + remoteWorkspace := "remote-workspace" + tfBlock := terraformConfigRemoteBackendName(orgName, remoteWorkspace) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "remote"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `default`, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, + userInput: []string{"cloud-workspace", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, }, }, } - - for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + validations := func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) if err != nil { t.Fatal(err) } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) + if len(wsList.Items) != 1 { + t.Fatalf("Expected number of workspaces to be 1, but got %d", len(wsList.Items)) } - defer os.RemoveAll(tmpDir) + ws := wsList.Items[0] + if ws.Name != "cloud-workspace" { + t.Fatalf("Expected workspace to be `cloud-workspace`, but is %s", ws.Name) + } + } + + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - organization, cleanup := createOrganization(t) - defer cleanup() - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - err = cmd.Start() + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } + } - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) - if err != nil { - t.Fatal(err) - } - } - - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) - } + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) } } } + } - err = cmd.Wait() - if err != nil { - t.Fatal(err) - } + err = cmd.Wait() + if err != nil { + t.Fatal(err) } } + } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if validations != nil { + validations(t, organization.Name) } } -func Test_migrate_remote_backend_prefix_to_tfc_name(t *testing.T) { - t.Parallel() +func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t *testing.T) { skipWithoutRemoteTerraformVersion(t) ctx := context.Background() - cases := map[string]struct { - operations []operationSets - validations func(t *testing.T, orgName string) - }{ - "single workspace with backend prefix strategy, to cloud with name strategy": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) - prefix := "app-" - tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `Terraform has been successfully initialized!`, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - wsName := "cloud-workspace" - tfBlock := terraformConfigCloudBackendName(orgName, wsName) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, - userInput: []string{"yes"}, - postInputOutput: []string{ - `Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `cloud-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - expectedName := "cloud-workspace" - ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) - if err != nil { - t.Fatal(err) - } - if ws == nil { - t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) - } + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Terraform has been successfully initialized!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, }, }, - "multiple workspaces with backend prefix strategy, to cloud with name strategy": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) - _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-two")}) - prefix := "app-" - tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `The currently selected workspace (default) does not exist.`, - userInput: []string{"1"}, - postInputOutput: []string{`Terraform has been successfully initialized!`}, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - { - command: []string{"workspace", "list"}, - expectedCmdOutput: "* one", // app name retrieved via prefix - }, - { - command: []string{"workspace", "select", "two"}, - expectedCmdOutput: `Switched to workspace "two".`, // app name retrieved via prefix - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - wsName := "cloud-workspace" - tfBlock := terraformConfigCloudBackendName(orgName, wsName) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy only your current workspace?`, - userInput: []string{"yes"}, - postInputOutput: []string{ - `Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: `cloud-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - expectedName := "cloud-workspace" - ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) - if err != nil { - t.Fatal(err) - } - if ws == nil { - t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) - } - wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "cloud-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + userInput: []string{"yes"}, + postInputOutput: []string{ + `Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + } + validations := func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + } + + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } - if len(wsList.Items) != 3 { - t.Fatalf("expected number of workspaces in this org to be 3, but got %d", len(wsList.Items)) - } - ws, empty := getWorkspace(wsList.Items, "cloud-workspace") - if empty { - t.Fatalf("expected workspaces to include 'cloud-workspace' but didn't.") - } - ws, empty = getWorkspace(wsList.Items, "app-one") - if empty { - t.Fatalf("expected workspaces to include 'app-one' but didn't.") - } - ws, empty = getWorkspace(wsList.Items, "app-two") - if empty { - t.Fatalf("expected workspaces to include 'app-two' but didn't.") + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if validations != nil { + validations(t, organization.Name) + } +} + +func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_multi_workspace(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + + ctx := context.Background() + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-two")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `The currently selected workspace (default) does not exist.`, + userInput: []string{"1"}, + postInputOutput: []string{`Terraform has been successfully initialized!`}, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "list"}, + expectedCmdOutput: "* one", // app name retrieved via prefix + }, + { + command: []string{"workspace", "select", "two"}, + expectedCmdOutput: `Switched to workspace "two".`, // app name retrieved via prefix + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "cloud-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you want to copy only your current workspace?`, + userInput: []string{"yes"}, + postInputOutput: []string{ + `Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: `cloud-workspace`, + }, }, }, } - - for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + validations := func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) if err != nil { t.Fatal(err) } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) if err != nil { t.Fatal(err) } - defer os.RemoveAll(tmpDir) + if len(wsList.Items) != 3 { + t.Fatalf("expected number of workspaces in this org to be 3, but got %d", len(wsList.Items)) + } + ws, empty := getWorkspace(wsList.Items, "cloud-workspace") + if empty { + t.Fatalf("expected workspaces to include 'cloud-workspace' but didn't.") + } + ws, empty = getWorkspace(wsList.Items, "app-one") + if empty { + t.Fatalf("expected workspaces to include 'app-one' but didn't.") + } + ws, empty = getWorkspace(wsList.Items, "app-two") + if empty { + t.Fatalf("expected workspaces to include 'app-two' but didn't.") + } + } - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - organization, cleanup := createOrganization(t) - defer cleanup() - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - err = cmd.Start() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } + } - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) - if err != nil { - t.Fatal(err) - } - } - - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) - } + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) } } } + } - err = cmd.Wait() - if err != nil { - t.Fatal(err) - } + err = cmd.Wait() + if err != nil { + t.Fatal(err) } } + } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if validations != nil { + validations(t, organization.Name) } } -func Test_migrate_remote_backend_prefix_to_tfc_tags(t *testing.T) { - t.Parallel() +func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_single_workspace(t *testing.T) { skipWithoutRemoteTerraformVersion(t) ctx := context.Background() - cases := map[string]struct { - operations []operationSets - validations func(t *testing.T, orgName string) - }{ - "single workspace with backend prefix strategy, to cloud with tags strategy": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) - prefix := "app-" - tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `Terraform has been successfully initialized!`, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - tag := "app" - tfBlock := terraformConfigCloudBackendTags(orgName, tag) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"cloud-workspace", "yes"}, - postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, - `Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "list"}, - expectedCmdOutput: `cloud-workspace`, - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - expectedName := "cloud-workspace" - ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) - if err != nil { - t.Fatal(err) - } - if ws == nil { - t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) - } + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Terraform has been successfully initialized!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, }, }, - "multiple workspaces with backend prefix strategy, to cloud with tags strategy": { - operations: []operationSets{ - { - prep: func(t *testing.T, orgName, dir string) { - _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) - _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-two")}) - prefix := "app-" - tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init"}, - expectedCmdOutput: `The currently selected workspace (default) does not exist.`, - userInput: []string{"1"}, - postInputOutput: []string{`Terraform has been successfully initialized!`}, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - { - command: []string{"workspace", "select", "two"}, - }, - { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "app-two"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, - }, - }, - }, - { - prep: func(t *testing.T, orgName, dir string) { - tag := "app" - tfBlock := terraformConfigCloudBackendTags(orgName, tag) - writeMainTF(t, tfBlock, dir) - }, - commands: []tfCommand{ - { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Would you like to rename your workspaces?`, - userInput: []string{"1", "*"}, - postInputOutput: []string{`What pattern would you like to add to all your workspaces?`, - `Terraform Cloud has been successfully initialized!`}, - }, - { - command: []string{"workspace", "show"}, - expectedCmdOutput: "two", // this comes from the original workspace name from the previous backend. - }, - { - command: []string{"workspace", "select", "one"}, - expectedCmdOutput: `Switched to workspace "one".`, // this comes from the original workspace name from the previous backend. - }, - }, - }, - }, - validations: func(t *testing.T, orgName string) { - wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ - Tags: tfe.String("app"), - }) + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, + userInput: []string{"cloud-workspace", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "list"}, + expectedCmdOutput: `cloud-workspace`, + }, + }, + }, + } + validations := func(t *testing.T, orgName string) { + expectedName := "cloud-workspace" + ws, err := tfeClient.Workspaces.Read(ctx, orgName, expectedName) + if err != nil { + t.Fatal(err) + } + if ws == nil { + t.Fatalf("Expected workspace %s to be present, but is not.", expectedName) + } + } + + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() + + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } - if len(wsList.Items) != 2 { - t.Logf("Expected the number of workspaces to be 2, but got %d", len(wsList.Items)) - } - ws, empty := getWorkspace(wsList.Items, "one") - if empty { - t.Fatalf("expected workspaces to include 'one' but didn't.") - } - if len(ws.TagNames) == 0 { - t.Fatalf("expected workspaces 'one' to have tags.") - } - ws, empty = getWorkspace(wsList.Items, "two") - if empty { - t.Fatalf("expected workspaces to include 'two' but didn't.") - } - if len(ws.TagNames) == 0 { - t.Fatalf("expected workspaces 'two' to have tags.") + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } + } } + } + + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } + } + } + + if validations != nil { + validations(t, organization.Name) + } +} + +func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_multi_workspace(t *testing.T) { + skipWithoutRemoteTerraformVersion(t) + + ctx := context.Background() + operations := []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-one")}) + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{Name: tfe.String("app-two")}) + prefix := "app-" + tfBlock := terraformConfigRemoteBackendPrefix(orgName, prefix) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `The currently selected workspace (default) does not exist.`, + userInput: []string{"1"}, + postInputOutput: []string{`Terraform has been successfully initialized!`}, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-one"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "select", "two"}, + }, + { + command: []string{"apply"}, + expectedCmdOutput: `Do you want to perform these actions in workspace "app-two"?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + tag := "app" + tfBlock := terraformConfigCloudBackendTags(orgName, tag) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + expectedCmdOutput: `Do you wish to proceed?`, + userInput: []string{"yes"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "show"}, + expectedCmdOutput: "app-two", + }, + { + command: []string{"workspace", "select", "app-one"}, + expectedCmdOutput: `Switched to workspace "app-one".`, + }, }, }, } - - for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) + validations := func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ + Tags: tfe.String("app"), + }) if err != nil { t.Fatal(err) } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) + if len(wsList.Items) != 2 { + t.Logf("Expected the number of workspaces to be 2, but got %d", len(wsList.Items)) } - defer os.RemoveAll(tmpDir) + ws, empty := getWorkspace(wsList.Items, "app-one") + if empty { + t.Fatalf("expected workspaces to include 'app-one' but didn't.") + } + if len(ws.TagNames) == 0 { + t.Fatalf("expected workspaces 'one' to have tags.") + } + ws, empty = getWorkspace(wsList.Items, "app-two") + if empty { + t.Fatalf("expected workspaces to include 'app-two' but didn't.") + } + if len(ws.TagNames) == 0 { + t.Fatalf("expected workspaces 'app-two' to have tags.") + } + } - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - organization, cleanup := createOrganization(t) - defer cleanup() - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + organization, cleanup := createOrganization(t) + defer cleanup() + for _, op := range operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() + if err != nil { + t.Fatal(err) + } - err = cmd.Start() + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } + } - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) - if err != nil { - t.Fatal(err) - } - } - - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) - } + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) } } } + } - err = cmd.Wait() - if err != nil { - t.Fatal(err) - } + err = cmd.Wait() + if err != nil { + t.Fatal(err) } } + } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if validations != nil { + validations(t, organization.Name) } } diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index d8317ca6976b..14c84eef9e3d 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -15,7 +15,6 @@ import ( ) func Test_migrate_single_to_tfc(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -37,10 +36,8 @@ func Test_migrate_single_to_tfc(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -88,10 +85,8 @@ func Test_migrate_single_to_tfc(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "local"!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -133,73 +128,75 @@ func Test_migrate_single_to_tfc(t *testing.T) { } for name, tc := range cases { - t.Log("Test: ", name) - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=info") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil { - t.Fatal(err) + err = cmd.Wait() + if err != nil { + t.Fatal(err) + } } } - } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if tc.validations != nil { + tc.validations(t, organization.Name) + } + }) } } diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 3de277843381..6e8b3a9019f7 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -4,7 +4,6 @@ package main import ( - "fmt" "io/ioutil" "os" "testing" @@ -14,7 +13,6 @@ import ( ) func Test_migrate_tfc_to_other(t *testing.T) { - t.Parallel() cases := map[string]struct { operations []operationSets }{ @@ -51,68 +49,70 @@ func Test_migrate_tfc_to_other(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tc := tc + t.Run(name, func(t *testing.T) { + t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=info") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil && !tfCmd.expectError { - t.Fatal(err) + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } } } - } + }) } } diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 6ef83fcfb668..496bf988106b 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -16,7 +16,6 @@ import ( ) func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -55,10 +54,8 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { expectedCmdOutput: `prod`, // this comes from the `prep` function }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "prod"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -119,10 +116,8 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "prod"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -183,10 +178,8 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "prod"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, }, }, @@ -214,95 +207,92 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { }, }, validations: func(t *testing.T, orgName string) { - wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{ - Tags: tfe.String("app"), - }) + // We created the workspace, so it will be there. We could not complete the state migration, + // though, so the workspace should be empty. + ws, err := tfeClient.Workspaces.ReadWithOptions(ctx, orgName, "new-workspace", &tfe.WorkspaceReadOptions{Include: "current_run"}) if err != nil { t.Fatal(err) } - // The migration never occured, so we have no workspaces with this tag. - if len(wsList.Items) != 0 { - t.Fatalf("Expected number of workspaces to be 0, but got %d", len(wsList.Items)) + if ws.CurrentRun != nil { + t.Fatal("Expected to workspace be empty") } }, }, } for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + t.Run(name, func(t *testing.T) { + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - defer tf.Close() - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - orgName, cleanup := tc.setup(t) - defer cleanup() - for _, op := range tc.operations { - op.prep(t, orgName, tf.WorkDir()) - for _, tfCmd := range op.commands { - t.Log("Running commands: ", tfCmd.command) - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv(cliConfigFileEnv) - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + orgName, cleanup := tc.setup(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, orgName, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil && !tfCmd.expectError { - t.Fatal(err.Error()) + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err.Error()) + } } } - } - if tc.validations != nil { - tc.validations(t, orgName) - } + if tc.validations != nil { + tc.validations(t, orgName) + } + }) } } func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -454,7 +444,6 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { tag := "billing" tfBlock := terraformConfigCloudBackendTags(orgName, tag) writeMainTF(t, tfBlock, dir) - t.Log(orgName) }, commands: []tfCommand{ { @@ -462,8 +451,7 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { expectedCmdOutput: `Would you like to rename your workspaces?`, userInput: []string{"1", "new-*", "1"}, postInputOutput: []string{ - `What pattern would you like to add to all your workspaces?`, - `The currently selected workspace (app-staging) does not exist.`, + `How would you like to rename your workspaces?`, `Terraform Cloud has been successfully initialized!`}, }, }, @@ -492,75 +480,73 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { } for name, tc := range cases { - t.Log("Test: ", name) - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + t.Run(name, func(t *testing.T) { + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - defer tf.Close() - tf.AddEnv("TF_LOG=INFO") - tf.AddEnv(cliConfigFileEnv) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - orgName, cleanup := tc.setup(t) - defer cleanup() - for _, op := range tc.operations { - op.prep(t, orgName, tf.WorkDir()) - for _, tfCmd := range op.commands { - t.Log("Running commands: ", tfCmd.command) - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + defer tf.Close() + tf.AddEnv(cliConfigFileEnv) - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + orgName, cleanup := tc.setup(t) + defer cleanup() + for _, op := range tc.operations { + op.prep(t, orgName, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatal(err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - t.Log(cmd.Stderr) - err = cmd.Wait() - if err != nil { - t.Fatal(err.Error()) + err = cmd.Wait() + if err != nil { + t.Fatal(err.Error()) + } } } - } - if tc.validations != nil { - tc.validations(t, orgName) - } + if tc.validations != nil { + tc.validations(t, orgName) + } + }) } } diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index e13381ea14df..5f4f40cec83c 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -46,7 +46,6 @@ output "test_env" { } func Test_cloud_run_variables(t *testing.T) { - t.Parallel() skipWithoutRemoteTerraformVersion(t) cases := testCases{ @@ -78,75 +77,75 @@ func Test_cloud_run_variables(t *testing.T) { } for name, tc := range cases { - fmt.Println("Test: ", name) - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(expect.WithStdout(os.Stdout), expect.WithDefaultTimeout(expectConsoleTimeout)) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) - - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv("TF_LOG=info") - tf.AddEnv("TF_CLI_ARGS=-no-color") - tf.AddEnv("TF_VAR_baz=qux") - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() - - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() - - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + t.Run(name, func(t *testing.T) { + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) + + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv("TF_CLI_ARGS=-no-color") + tf.AddEnv("TF_VAR_baz=qux") + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() + + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() + + err = cmd.Start() if err != nil { t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatalf(`Expected command output "%s", but got %v `, tfCmd.expectedCmdOutput, err) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatalf(`Expected command output "%s", but got %v `, tfCmd.expectedCmdOutput, err) + } } } } - } - err = cmd.Wait() - if err != nil && !tfCmd.expectError { - t.Fatal(err) + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } } - } - if tc.validations != nil { - tc.validations(t, organization.Name) + if tc.validations != nil { + tc.validations(t, organization.Name) + } } - } + }) } } From 57a4b51e87686f70f967c28661c23d03f24af12c Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Thu, 11 Nov 2021 15:21:21 -0500 Subject: [PATCH 337/644] remove build tags for cloud e2e --- internal/cloud/e2e/README.md | 3 +-- internal/cloud/e2e/apply_auto_approve_test.go | 3 --- .../cloud/e2e/backend_apply_before_init_test.go | 3 --- internal/cloud/e2e/helper_test.go | 8 ++------ internal/cloud/e2e/init_with_empty_tags_test.go | 3 --- internal/cloud/e2e/main_test.go | 16 +++++++++++----- .../cloud/e2e/migrate_state_multi_to_tfc_test.go | 4 ---- .../migrate_state_remote_backend_to_tfc_test.go | 9 +++------ .../e2e/migrate_state_single_to_tfc_test.go | 3 --- .../cloud/e2e/migrate_state_tfc_to_other_test.go | 3 --- .../cloud/e2e/migrate_state_tfc_to_tfc_test.go | 3 --- internal/cloud/e2e/run_variables_test.go | 9 ++++++--- 12 files changed, 23 insertions(+), 44 deletions(-) diff --git a/internal/cloud/e2e/README.md b/internal/cloud/e2e/README.md index 02a50bbfeeb9..7928fc3f78a2 100644 --- a/internal/cloud/e2e/README.md +++ b/internal/cloud/e2e/README.md @@ -2,11 +2,10 @@ To run them, use: ``` -TF_ACC=1 go test -tags=e2e ./internal/cloud/e2e/... -ldflags "-X \"github.com/hashicorp/terraform/version.Prerelease=\"" +TFE_TOKEN= TFE_HOSTNAME= TF_ACC=1 go test ./internal/cloud/e2e/... -ldflags "-X \"github.com/hashicorp/terraform/version.Prerelease=\"" ``` Required flags -* `-tags=e2e` for running e2e tests. * `TF_ACC=1`. This variable is used as part of terraform for tests that make external network calls. This is needed to run these tests. Without it, the tests do not run. diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 1689caedb373..41bbb11782c9 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index 48d3f3d40b12..4115ecfab4ec 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( diff --git a/internal/cloud/e2e/helper_test.go b/internal/cloud/e2e/helper_test.go index 87ed67654e56..6c65ba983b12 100644 --- a/internal/cloud/e2e/helper_test.go +++ b/internal/cloud/e2e/helper_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( @@ -24,7 +21,6 @@ const ( type tfCommand struct { command []string expectedCmdOutput string - expectedErr string expectError bool userInput []string postInputOutput []string @@ -105,7 +101,7 @@ func randomString(t *testing.T) string { } func terraformConfigLocalBackend() string { - return fmt.Sprintf(` + return ` terraform { backend "local" { } @@ -114,7 +110,7 @@ terraform { output "val" { value = "${terraform.workspace}" } -`) +` } func terraformConfigRemoteBackendName(org, name string) string { diff --git a/internal/cloud/e2e/init_with_empty_tags_test.go b/internal/cloud/e2e/init_with_empty_tags_test.go index 15bc3ba18f7f..ab74ef9d012a 100644 --- a/internal/cloud/e2e/init_with_empty_tags_test.go +++ b/internal/cloud/e2e/init_with_empty_tags_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index 783dc4d201de..656c093facd8 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( @@ -27,8 +24,9 @@ var verboseMode bool func TestMain(m *testing.M) { log.SetFlags(log.LstdFlags | log.Lshortfile) - if !accTest() { - // if TF_ACC is not set, we want to skip all these tests. + hasRequiredEnvVars := accTest() && hasHostname() && hasToken() + if !hasRequiredEnvVars { + // if the above three required variables are not set, then skip all tests. return } teardown := setup() @@ -44,6 +42,14 @@ func accTest() bool { return os.Getenv("TF_ACC") != "" } +func hasHostname() bool { + return os.Getenv("TFE_HOSTNAME") != "" +} + +func hasToken() bool { + return os.Getenv("TFE_TOKEN") != "" +} + func setup() func() { tfOutput := flag.Bool("tfoutput", false, "This flag produces the terraform output from tests.") flag.Parse() diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 07c4b04f88f8..7e1ff542b78e 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( @@ -186,7 +183,6 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { for _, op := range tc.operations { op.prep(t, organization.Name, tf.WorkDir()) for _, tfCmd := range op.commands { - tfCmd.command = append(tfCmd.command) cmd := tf.Cmd(tfCmd.command...) cmd.Stdin = exp.Tty() cmd.Stdout = exp.Tty() diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 819875e3f176..b50228192183 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( @@ -705,15 +702,15 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_multi_workspace(t * if len(wsList.Items) != 3 { t.Fatalf("expected number of workspaces in this org to be 3, but got %d", len(wsList.Items)) } - ws, empty := getWorkspace(wsList.Items, "cloud-workspace") + _, empty := getWorkspace(wsList.Items, "cloud-workspace") if empty { t.Fatalf("expected workspaces to include 'cloud-workspace' but didn't.") } - ws, empty = getWorkspace(wsList.Items, "app-one") + _, empty = getWorkspace(wsList.Items, "app-one") if empty { t.Fatalf("expected workspaces to include 'app-one' but didn't.") } - ws, empty = getWorkspace(wsList.Items, "app-two") + _, empty = getWorkspace(wsList.Items, "app-two") if empty { t.Fatalf("expected workspaces to include 'app-two' but didn't.") } diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index 14c84eef9e3d..e171f048a673 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 6e8b3a9019f7..3da776c3f101 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 496bf988106b..64204565dce3 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index 5f4f40cec83c..b4d3569a2a75 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -1,6 +1,3 @@ -//go:build e2e -// +build e2e - package main import ( @@ -10,7 +7,9 @@ import ( "testing" expect "github.com/Netflix/go-expect" + tfe "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/e2e" + tfversion "github.com/hashicorp/terraform/version" ) func terraformConfigRequiredVariable(org, name string) string { @@ -54,6 +53,10 @@ func Test_cloud_run_variables(t *testing.T) { { prep: func(t *testing.T, orgName, dir string) { wsName := "new-workspace" + _ = createWorkspace(t, orgName, tfe.WorkspaceCreateOptions{ + Name: tfe.String(wsName), + TerraformVersion: tfe.String(tfversion.String()), + }) tfBlock := terraformConfigRequiredVariable(orgName, wsName) writeMainTF(t, tfBlock, dir) }, From 1dabdf0dcd5ab48bf706177da8ffeda89e323dc2 Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Sun, 14 Nov 2021 21:51:53 +0000 Subject: [PATCH 338/644] normalise test names --- internal/configs/moved_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/configs/moved_test.go b/internal/configs/moved_test.go index 4e2666a27dc1..433525d28c17 100644 --- a/internal/configs/moved_test.go +++ b/internal/configs/moved_test.go @@ -9,7 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" ) -func TestDecodeMovedBlock(t *testing.T) { +func TestMovedBlock_decode(t *testing.T) { blockRange := hcl.Range{ Filename: "mock.tf", Start: hcl.Pos{Line: 3, Column: 12, Byte: 27}, @@ -169,7 +169,7 @@ func TestDecodeMovedBlock(t *testing.T) { } } -func TestMovedBlocksInModule(t *testing.T) { +func TestMovedBlock_inModule(t *testing.T) { parser := NewParser(nil) mod, diags := parser.LoadConfigDir("testdata/valid-modules/moved-blocks") if diags.HasErrors() { From 4305271cff59ce6abb3bd7734acf5a223d2cf3dc Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Mon, 15 Nov 2021 10:46:06 +0000 Subject: [PATCH 339/644] remove occurrences of AbsMovable --- internal/addrs/move_endpoint.go | 10 +++++----- internal/addrs/move_endpoint_module.go | 2 +- internal/addrs/move_endpoint_test.go | 2 +- internal/addrs/moveable.go | 4 ++-- internal/refactoring/move_validate.go | 6 +++--- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/internal/addrs/move_endpoint.go b/internal/addrs/move_endpoint.go index 2b44c5cd1d74..765b66f5eecc 100644 --- a/internal/addrs/move_endpoint.go +++ b/internal/addrs/move_endpoint.go @@ -19,7 +19,7 @@ import ( // prompt creating a different plan than Terraform would by default. // // To obtain a full address from a MoveEndpoint you must use -// either the package function UnifyMoveEndpoints (to get an AbsMovable) or +// either the package function UnifyMoveEndpoints (to get an AbsMoveable) or // the method ConfigMoveable (to get a ConfigMoveable). type MoveEndpoint struct { // SourceRange is the location of the physical endpoint address @@ -27,15 +27,15 @@ type MoveEndpoint struct { // configuration expresson. SourceRange tfdiags.SourceRange - // Internally we (ab)use AbsMovable as the representation of our + // Internally we (ab)use AbsMoveable as the representation of our // relative address, even though everywhere else in Terraform - // AbsMovable always represents a fully-absolute address. + // AbsMoveable always represents a fully-absolute address. // In practice, due to the implementation of ParseMoveEndpoint, // this is always either a ModuleInstance or an AbsResourceInstance, // and we only consider the possibility of interpreting it as // a AbsModuleCall or an AbsResource in UnifyMoveEndpoints. // This is intentionally unexported to encapsulate this unusual - // meaning of AbsMovable. + // meaning of AbsMoveable. relSubject AbsMoveable } @@ -44,7 +44,7 @@ func (e *MoveEndpoint) ObjectKind() MoveEndpointKind { } func (e *MoveEndpoint) String() string { - // Our internal pseudo-AbsMovable representing the relative + // Our internal pseudo-AbsMoveable representing the relative // address (either ModuleInstance or AbsResourceInstance) is // a good enough proxy for the relative move endpoint address // serialization. diff --git a/internal/addrs/move_endpoint_module.go b/internal/addrs/move_endpoint_module.go index 8bbbe83e7d11..e2180f25a176 100644 --- a/internal/addrs/move_endpoint_module.go +++ b/internal/addrs/move_endpoint_module.go @@ -131,7 +131,7 @@ func (e *MoveEndpointInModule) Module() Module { return e.module } -// InModuleInstance returns an AbsMovable address which concatenates the +// InModuleInstance returns an AbsMoveable address which concatenates the // given module instance address with the receiver's relative object selection // to produce one example of an instance that might be affected by this // move statement. diff --git a/internal/addrs/move_endpoint_test.go b/internal/addrs/move_endpoint_test.go index 6e117139b77e..602c7e9719e6 100644 --- a/internal/addrs/move_endpoint_test.go +++ b/internal/addrs/move_endpoint_test.go @@ -12,7 +12,7 @@ import ( func TestParseMoveEndpoint(t *testing.T) { tests := []struct { Input string - WantRel AbsMoveable // funny intermediate subset of AbsMovable + WantRel AbsMoveable // funny intermediate subset of AbsMoveable WantErr string }{ { diff --git a/internal/addrs/moveable.go b/internal/addrs/moveable.go index a85fe72c1ce9..dcbd8c03e754 100644 --- a/internal/addrs/moveable.go +++ b/internal/addrs/moveable.go @@ -5,7 +5,7 @@ package addrs // with any other similar cross-module state refactoring statements we might // allow. // -// Note that AbsMovable represents an absolute address relative to the root +// Note that AbsMoveable represents an absolute address relative to the root // of the configuration, which is different than the direct representation // of these in configuration where the author gives an address relative to // the current module where the address is defined. The type MoveEndpoint @@ -16,7 +16,7 @@ type AbsMoveable interface { String() string } -// The following are all of the possible AbsMovable address types: +// The following are all of the possible AbsMoveable address types: var ( _ AbsMoveable = AbsResource{} _ AbsMoveable = AbsResourceInstance{} diff --git a/internal/refactoring/move_validate.go b/internal/refactoring/move_validate.go index aad356cb2b16..2c38ba756d01 100644 --- a/internal/refactoring/move_validate.go +++ b/internal/refactoring/move_validate.go @@ -110,7 +110,7 @@ func ValidateMoves(stmts []MoveStatement, rootCfg *configs.Config, declaredInsts shortNoun = "resource" default: // The above cases should cover all of the AbsMoveable types - panic("unsupported AbsMovable address type") + panic("unsupported AbsMoveable address type") } // It's invalid to have a move statement whose "from" address @@ -234,7 +234,7 @@ func moveableObjectExists(addr addrs.AbsMoveable, in instances.Set) bool { return in.HasResource(addr) default: // The above cases should cover all of the AbsMoveable types - panic("unsupported AbsMovable address type") + panic("unsupported AbsMoveable address type") } } @@ -309,7 +309,7 @@ func movableObjectDeclRange(addr addrs.AbsMoveable, cfg *configs.Config) (tfdiag return tfdiags.SourceRangeFromHCL(rc.DeclRange), true default: // The above cases should cover all of the AbsMoveable types - panic("unsupported AbsMovable address type") + panic("unsupported AbsMoveable address type") } } From dc3ed6271c4111021b92ca9be39a9d6598d3c8a0 Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Mon, 15 Nov 2021 10:42:08 +0000 Subject: [PATCH 340/644] add failing test for resource type mismatch --- internal/refactoring/move_validate_test.go | 18 ++++++++++++++++++ .../move-validate-zoo/move-validate-root.tf | 3 +++ 2 files changed, 21 insertions(+) diff --git a/internal/refactoring/move_validate_test.go b/internal/refactoring/move_validate_test.go index 986c1d5db301..53bbbe6c2e1a 100644 --- a/internal/refactoring/move_validate_test.go +++ b/internal/refactoring/move_validate_test.go @@ -386,6 +386,24 @@ Each resource can have moved from only one source resource.`, }, WantError: ``, // This is okay because the call itself is not considered to be inside the package it refers to }, + "resource type mismatch": { + Statements: []MoveStatement{ + makeTestMoveStmt(t, ``, + `test.nonexist1`, + `other.single`, + ), + }, + WantError: `Resource type mismatch: This statement declares a move from test.nonexist1 to other.single, which is a resource of a different type.`, + }, + "resource instance type mismatch": { + Statements: []MoveStatement{ + makeTestMoveStmt(t, ``, + `test.nonexist1[0]`, + `other.single`, + ), + }, + WantError: `Resource type mismatch: This statement declares a move from test.nonexist1[0] to other.single, which is a resource instance of a different type.`, + }, } for name, test := range tests { diff --git a/internal/refactoring/testdata/move-validate-zoo/move-validate-root.tf b/internal/refactoring/testdata/move-validate-zoo/move-validate-root.tf index 492d671dbc17..3cc8504f9e22 100644 --- a/internal/refactoring/testdata/move-validate-zoo/move-validate-root.tf +++ b/internal/refactoring/testdata/move-validate-zoo/move-validate-root.tf @@ -41,6 +41,9 @@ resource "test" "for_each" { } } +resource "other" "single" { +} + module "fake_external" { # Our configuration fixture loader has a special case for a module call # named "fake_external" where it will mutate the source address after From 7162e79fdf8fc24be62371eb1d800d24e837cf19 Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Mon, 15 Nov 2021 10:43:06 +0000 Subject: [PATCH 341/644] return error on resource type mismatch A resource move is invalid if the two resource( instance)s are of different resource types. Check for this during move validation. --- internal/refactoring/move_validate.go | 36 +++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/internal/refactoring/move_validate.go b/internal/refactoring/move_validate.go index 2c38ba756d01..b59bc315ef1f 100644 --- a/internal/refactoring/move_validate.go +++ b/internal/refactoring/move_validate.go @@ -178,6 +178,16 @@ func ValidateMoves(stmts []MoveStatement, rootCfg *configs.Config, declaredInsts } } + // Resource types must match. + if resourceTypesDiffer(absFrom, absTo) { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Resource type mismatch", + Detail: fmt.Sprintf( + "This statement declares a move from %s to %s, which is a %s of a different type.", absFrom, absTo, noun, + ), + }) + } } } @@ -238,6 +248,32 @@ func moveableObjectExists(addr addrs.AbsMoveable, in instances.Set) bool { } } +func resourceTypesDiffer(absFrom, absTo addrs.AbsMoveable) bool { + switch absFrom.(type) { + case addrs.AbsResourceInstance, addrs.AbsResource: + // addrs.UnifyMoveEndpoints guarantees that both addresses are of the + // same kind, so at this point we can assume that absTo is an + // addrs.AbsResourceInstance or addrs.AbsResource. + return absMoveableResourceType(absFrom) != absMoveableResourceType(absTo) + default: + return false + } +} + +// absMoveableResourceType returns the type of the supplied +// addrs.AbsResourceInstance or addrs.AbsResource, or "" for other AbsMoveable +// types. +func absMoveableResourceType(addr addrs.AbsMoveable) string { + switch addr := addr.(type) { + case addrs.AbsResourceInstance: + return addr.Resource.Resource.Type + case addrs.AbsResource: + return addr.Resource.Type + default: + return "" + } +} + func movableObjectDeclRange(addr addrs.AbsMoveable, cfg *configs.Config) (tfdiags.SourceRange, bool) { switch addr := addr.(type) { case addrs.ModuleInstance: From 11566b1d11eb6a76cc3d5fe664dd197fe021bbdf Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Mon, 15 Nov 2021 11:03:33 +0000 Subject: [PATCH 342/644] introduce AbsMoveableResource AbsMoveableResource is an AbsMoveable that is either a resource or a resource instance. This interface represents a moveable that has a resource type. --- internal/addrs/moveable.go | 13 +++++++++++++ internal/addrs/resource.go | 8 ++++++++ internal/refactoring/move_validate.go | 20 ++++---------------- 3 files changed, 25 insertions(+), 16 deletions(-) diff --git a/internal/addrs/moveable.go b/internal/addrs/moveable.go index dcbd8c03e754..083fcfb27fe6 100644 --- a/internal/addrs/moveable.go +++ b/internal/addrs/moveable.go @@ -24,6 +24,19 @@ var ( _ AbsMoveable = AbsModuleCall{} ) +// AbsMoveableResource is an AbsMoveable that is either a resource or a resource +// instance. +type AbsMoveableResource interface { + AbsMoveable + Type() string +} + +// The following are all of the possible AbsMoveableResource types: +var ( + _ AbsMoveableResource = AbsResource{} + _ AbsMoveableResource = AbsResourceInstance{} +) + // ConfigMoveable is similar to AbsMoveable but represents a static object in // the configuration, rather than an instance of that object created by // module expansion. diff --git a/internal/addrs/resource.go b/internal/addrs/resource.go index 0ebf89d999ec..9c81c0eddd9f 100644 --- a/internal/addrs/resource.go +++ b/internal/addrs/resource.go @@ -186,6 +186,10 @@ func (r AbsResource) String() string { return fmt.Sprintf("%s.%s", r.Module.String(), r.Resource.String()) } +func (r AbsResource) Type() string { + return r.Resource.Type +} + func (r AbsResource) Equal(o AbsResource) bool { return r.Module.Equal(o.Module) && r.Resource.Equal(o.Resource) } @@ -267,6 +271,10 @@ func (r AbsResourceInstance) String() string { return fmt.Sprintf("%s.%s", r.Module.String(), r.Resource.String()) } +func (r AbsResourceInstance) Type() string { + return r.Resource.Resource.Type +} + func (r AbsResourceInstance) Equal(o AbsResourceInstance) bool { return r.Module.Equal(o.Module) && r.Resource.Equal(o.Resource) } diff --git a/internal/refactoring/move_validate.go b/internal/refactoring/move_validate.go index b59bc315ef1f..b393c0a0b035 100644 --- a/internal/refactoring/move_validate.go +++ b/internal/refactoring/move_validate.go @@ -251,29 +251,17 @@ func moveableObjectExists(addr addrs.AbsMoveable, in instances.Set) bool { func resourceTypesDiffer(absFrom, absTo addrs.AbsMoveable) bool { switch absFrom.(type) { case addrs.AbsResourceInstance, addrs.AbsResource: + absFrom := absFrom.(addrs.AbsMoveableResource) // addrs.UnifyMoveEndpoints guarantees that both addresses are of the - // same kind, so at this point we can assume that absTo is an + // same kind, so at this point we can assume that absTo is also an // addrs.AbsResourceInstance or addrs.AbsResource. - return absMoveableResourceType(absFrom) != absMoveableResourceType(absTo) + absTo := absTo.(addrs.AbsMoveableResource) + return absFrom.Type() != absTo.Type() default: return false } } -// absMoveableResourceType returns the type of the supplied -// addrs.AbsResourceInstance or addrs.AbsResource, or "" for other AbsMoveable -// types. -func absMoveableResourceType(addr addrs.AbsMoveable) string { - switch addr := addr.(type) { - case addrs.AbsResourceInstance: - return addr.Resource.Resource.Type - case addrs.AbsResource: - return addr.Resource.Type - default: - return "" - } -} - func movableObjectDeclRange(addr addrs.AbsMoveable, cfg *configs.Config) (tfdiags.SourceRange, bool) { switch addr := addr.(type) { case addrs.ModuleInstance: From bf76cc98ef700637225057f33c79bf7c674aee3d Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Mon, 15 Nov 2021 09:21:31 -0600 Subject: [PATCH 343/644] command: Suggestions on migration copy from user feedback Some small edits to the TFC migration copy. --- internal/command/meta_backend.go | 2 +- internal/command/meta_backend_migrate.go | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 005237845211..5c7f04df3242 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -1426,7 +1426,7 @@ in your Terraform Cloud organization. To finish initializing, Terraform needs at least one workspace available. Terraform can create a properly tagged workspace for you now. Please enter a -name to create a new Terraform Cloud workspace: +name to create a new Terraform Cloud workspace. ` const successBackendUnset = ` diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 508199ade870..97162eb8b3c9 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -897,9 +897,6 @@ For example, if a workspace is currently named 'prod', the pattern 'app-*' would ` const tfcInputBackendMigrateMultiToMulti = ` -When migrating existing workspaces from the backend %[1]q to Terraform Cloud, would you like to -rename your workspaces? - Unlike typical Terraform workspaces representing an environment associated with a particular configuration (e.g. production, staging, development), Terraform Cloud workspaces are named uniquely across all configurations used within an organization. A typical strategy to start with is @@ -907,6 +904,9 @@ across all configurations used within an organization. A typical strategy to sta For more information on workspace naming, see https://www.terraform.io/docs/cloud/workspaces/naming.html +When migrating existing workspaces from the backend %[1]q to Terraform Cloud, would you like to +rename your workspaces? Enter 1 or 2. + 1. Yes, I'd like to rename all workspaces according to a pattern I will provide. 2. No, I would not like to rename my workspaces. Migrate them as currently named. ` From 9b675f8b70b93dcce67ee536617dae1b49162b17 Mon Sep 17 00:00:00 2001 From: Omar Ismail Date: Fri, 12 Nov 2021 12:00:24 -0500 Subject: [PATCH 344/644] Add skip for cloud e2e tests when env vars missing --- internal/cloud/e2e/apply_auto_approve_test.go | 109 +++++++++--------- .../e2e/backend_apply_before_init_test.go | 1 + .../cloud/e2e/init_with_empty_tags_test.go | 1 + internal/cloud/e2e/main_test.go | 63 +++++----- .../e2e/migrate_state_multi_to_tfc_test.go | 2 + ...igrate_state_remote_backend_to_tfc_test.go | 8 ++ .../e2e/migrate_state_single_to_tfc_test.go | 1 + .../e2e/migrate_state_tfc_to_other_test.go | 1 + .../e2e/migrate_state_tfc_to_tfc_test.go | 2 + internal/cloud/e2e/run_variables_test.go | 1 + 10 files changed, 104 insertions(+), 85 deletions(-) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 41bbb11782c9..9f086c88ea38 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -13,6 +13,7 @@ import ( ) func Test_terraform_apply_autoApprove(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -178,76 +179,72 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, }, } - for name, tc := range cases { - tc := tc - t.Run(name, func(t *testing.T) { - t.Parallel() - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(defaultOpts()...) - if err != nil { - t.Fatal(err) - } - defer exp.Close() + for _, tc := range cases { + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - err = cmd.Start() + err = cmd.Start() + if err != nil { + t.Fatal(err) + } + + if tfCmd.expectedCmdOutput != "" { + _, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { t.Fatal(err) } + } - if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) - if err != nil { - t.Fatal(err) - } - } - - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) - } + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) } } } + } - err = cmd.Wait() - if err != nil { - t.Fatal(err) - } + err = cmd.Wait() + if err != nil { + t.Fatal(err) } } + } - if tc.validations != nil { - tc.validations(t, organization.Name) - } - }) + if tc.validations != nil { + tc.validations(t, organization.Name) + } } } diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index 4115ecfab4ec..a5c9fee5a6ad 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -10,6 +10,7 @@ import ( ) func Test_backend_apply_before_init(t *testing.T) { + skipIfMissingEnvVar(t) t.Parallel() skipWithoutRemoteTerraformVersion(t) diff --git a/internal/cloud/e2e/init_with_empty_tags_test.go b/internal/cloud/e2e/init_with_empty_tags_test.go index ab74ef9d012a..ca9743d5e4c3 100644 --- a/internal/cloud/e2e/init_with_empty_tags_test.go +++ b/internal/cloud/e2e/init_with_empty_tags_test.go @@ -10,6 +10,7 @@ import ( ) func Test_init_with_empty_tags(t *testing.T) { + skipIfMissingEnvVar(t) t.Parallel() skipWithoutRemoteTerraformVersion(t) diff --git a/internal/cloud/e2e/main_test.go b/internal/cloud/e2e/main_test.go index 656c093facd8..d758eb65de99 100644 --- a/internal/cloud/e2e/main_test.go +++ b/internal/cloud/e2e/main_test.go @@ -23,12 +23,6 @@ var tfeToken string var verboseMode bool func TestMain(m *testing.M) { - log.SetFlags(log.LstdFlags | log.Lshortfile) - hasRequiredEnvVars := accTest() && hasHostname() && hasToken() - if !hasRequiredEnvVars { - // if the above three required variables are not set, then skip all tests. - return - } teardown := setup() code := m.Run() teardown() @@ -50,6 +44,16 @@ func hasToken() bool { return os.Getenv("TFE_TOKEN") != "" } +func hasRequiredEnvVars() bool { + return accTest() && hasHostname() && hasToken() +} + +func skipIfMissingEnvVar(t *testing.T) { + if !hasRequiredEnvVars() { + t.Skip("Skipping test, required environment variables missing. Use `TF_ACC`, `TFE_HOSTNAME`, `TFE_TOKEN`") + } +} + func setup() func() { tfOutput := flag.Bool("tfoutput", false, "This flag produces the terraform output from tests.") flag.Parse() @@ -64,41 +68,38 @@ func setup() func() { } func setTfeClient() { - hostname := os.Getenv("TFE_HOSTNAME") - token := os.Getenv("TFE_TOKEN") - if hostname == "" { - log.Fatal("hostname cannot be empty") - } - if token == "" { - log.Fatal("token cannot be empty") - } - tfeHostname = hostname - tfeToken = token + tfeHostname = os.Getenv("TFE_HOSTNAME") + tfeToken = os.Getenv("TFE_TOKEN") cfg := &tfe.Config{ - Address: fmt.Sprintf("https://%s", hostname), - Token: token, + Address: fmt.Sprintf("https://%s", tfeHostname), + Token: tfeToken, } - // Create a new TFE client. - client, err := tfe.NewClient(cfg) - if err != nil { - log.Fatal(err) + if tfeHostname != "" && tfeToken != "" { + // Create a new TFE client. + client, err := tfe.NewClient(cfg) + if err != nil { + fmt.Printf("Could not create new tfe client: %v\n", err) + os.Exit(1) + } + tfeClient = client } - tfeClient = client } func setupBinary() func() { log.Println("Setting up terraform binary") tmpTerraformBinaryDir, err := ioutil.TempDir("", "terraform-test") if err != nil { - log.Fatal(err) + fmt.Printf("Could not create temp directory: %v\n", err) + os.Exit(1) } log.Println(tmpTerraformBinaryDir) currentDir, err := os.Getwd() defer os.Chdir(currentDir) if err != nil { - log.Fatal(err) + fmt.Printf("Could not change directories: %v\n", err) + os.Exit(1) } // Getting top level dir dirPaths := strings.Split(currentDir, "/") @@ -107,7 +108,8 @@ func setupBinary() func() { topDir := strings.Join(dirPaths[0:topLevel], "/") if err := os.Chdir(topDir); err != nil { - log.Fatal(err) + fmt.Printf("Could not change directories: %v\n", err) + os.Exit(1) } cmd := exec.Command( @@ -118,7 +120,8 @@ func setupBinary() func() { ) err = cmd.Run() if err != nil { - log.Fatal(err) + fmt.Printf("Could not run exec command: %v\n", err) + os.Exit(1) } credFile := fmt.Sprintf("%s/dev.tfrc", tmpTerraformBinaryDir) @@ -136,11 +139,13 @@ func writeCredRC(file string) { creds := credentialBlock() f, err := os.Create(file) if err != nil { - log.Fatal(err) + fmt.Printf("Could not create file: %v\n", err) + os.Exit(1) } _, err = f.WriteString(creds) if err != nil { - log.Fatal(err) + fmt.Printf("Could not write credentials: %v\n", err) + os.Exit(1) } f.Close() } diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 7e1ff542b78e..950f3859ea02 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -13,6 +13,7 @@ import ( ) func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -233,6 +234,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index b50228192183..76ef0a34c771 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -12,6 +12,7 @@ import ( ) func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -133,6 +134,7 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { } func Test_migrate_remote_backend_name_to_tfc_same_name(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() operations := []operationSets{ @@ -251,6 +253,7 @@ func Test_migrate_remote_backend_name_to_tfc_same_name(t *testing.T) { } func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -377,6 +380,7 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { } func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -509,6 +513,7 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { } func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -632,6 +637,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t } func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_multi_workspace(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -785,6 +791,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_multi_workspace(t * } func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_single_workspace(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -909,6 +916,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_single_workspace(t } func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_multi_workspace(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index e171f048a673..becd882b9316 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -12,6 +12,7 @@ import ( ) func Test_migrate_single_to_tfc(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 3da776c3f101..d99b5504e751 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -10,6 +10,7 @@ import ( ) func Test_migrate_tfc_to_other(t *testing.T) { + skipIfMissingEnvVar(t) cases := map[string]struct { operations []operationSets }{ diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 64204565dce3..9419745e0f85 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -13,6 +13,7 @@ import ( ) func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() @@ -290,6 +291,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { } func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) ctx := context.Background() diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index b4d3569a2a75..07c6d869c641 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -45,6 +45,7 @@ output "test_env" { } func Test_cloud_run_variables(t *testing.T) { + skipIfMissingEnvVar(t) skipWithoutRemoteTerraformVersion(t) cases := testCases{ From bd64d07e6b9e97dfadc036318ebc96ad4edf1bad Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 15 Nov 2021 10:49:37 -0500 Subject: [PATCH 345/644] Apply suggestions from code review --- .../language/functions/setproduct.html.md | 93 ++++++++++--------- 1 file changed, 47 insertions(+), 46 deletions(-) diff --git a/website/docs/language/functions/setproduct.html.md b/website/docs/language/functions/setproduct.html.md index dfdd0a9b427a..42e6decc794e 100644 --- a/website/docs/language/functions/setproduct.html.md +++ b/website/docs/language/functions/setproduct.html.md @@ -202,9 +202,9 @@ resource "aws_subnet" "example" { } ``` -The `network_subnets` block in the example above creates one subnet instance per combination of network and subnet elements in the input variables. So for this example input: +The `network_subnets` list in the example above creates one subnet instance per combination of network and subnet elements in the input variables. So for this example input: -``` hcl +```hcl networks = { a = { base_cidr_block = "10.1.0.0/16" @@ -226,57 +226,58 @@ subnets = { } ``` -The `nework_subnets` block output would look similar to the following: - -``` hcl -{ - "cidr_block" = "10.1.16.0/20" - "network_id" = "vpc-0bfb00ca6173ea5aa" - "network_key" = "a" - "subnet_key" = "a" -}, -{ - "cidr_block" = "10.1.32.0/20" - "network_id" = "vpc-0bfb00ca6173ea5aa" - "network_key" = "a" - "subnet_key" = "b" -}, -{ - "cidr_block" = "10.1.48.0/20" - "network_id" = "vpc-0bfb00ca6173ea5aa" - "network_key" = "a" - "subnet_key" = "c" -}, -{ - "cidr_block" = "10.2.16.0/20" - "network_id" = "vpc-0d193e011f6211a7d" - "network_key" = "b" - "subnet_key" = "a" -}, -{ - "cidr_block" = "10.2.32.0/20" - "network_id" = "vpc-0d193e011f6211a7d" - "network_key" = "b" - "subnet_key" = "b" -}, -{ - "cidr_block" = "10.2.48.0/20" - "network_id" = "vpc-0d193e011f6211a7d" - "network_key" = "b" - "subnet_key" = "c" -}, +The `nework_subnets` output would look similar to the following: + +```hcl +[ + { + "cidr_block" = "10.1.16.0/20" + "network_id" = "vpc-0bfb00ca6173ea5aa" + "network_key" = "a" + "subnet_key" = "a" + }, + { + "cidr_block" = "10.1.32.0/20" + "network_id" = "vpc-0bfb00ca6173ea5aa" + "network_key" = "a" + "subnet_key" = "b" + }, + { + "cidr_block" = "10.1.48.0/20" + "network_id" = "vpc-0bfb00ca6173ea5aa" + "network_key" = "a" + "subnet_key" = "c" + }, + { + "cidr_block" = "10.2.16.0/20" + "network_id" = "vpc-0d193e011f6211a7d" + "network_key" = "b" + "subnet_key" = "a" + }, + { + "cidr_block" = "10.2.32.0/20" + "network_id" = "vpc-0d193e011f6211a7d" + "network_key" = "b" + "subnet_key" = "b" + }, + { + "cidr_block" = "10.2.48.0/20" + "network_id" = "vpc-0d193e011f6211a7d" + "network_key" = "b" + "subnet_key" = "c" + }, ] ``` ## Related Functions -* [`contains`](./contains.html) tests whether a given list or set contains +- [`contains`](./contains.html) tests whether a given list or set contains a given element value. -* [`flatten`](./flatten.html) is useful for flattening hierarchical data +- [`flatten`](./flatten.html) is useful for flattening hierarchical data into a single list, for situations where the relationships between two object types are defined explicitly. -* [`setintersection`](./setintersection.html) computes the _intersection_ of +- [`setintersection`](./setintersection.html) computes the _intersection_ of multiple sets. -* [`setsubtract`](./setsubtract.html) computes the _relative complement_ of two sets -* [`setunion`](./setunion.html) computes the _union_ of multiple +- [`setsubtract`](./setsubtract.html) computes the _relative complement_ of two sets +- [`setunion`](./setunion.html) computes the _union_ of multiple sets. From 5bbd10857250a2c9bf5559ebd9bdc8aa2f144bc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sim=C3=A3o=20Gomes=20Viana?= Date: Thu, 11 Nov 2021 14:32:10 +0100 Subject: [PATCH 346/644] funcs: defer close file in funcs Files opened by these two functions were not being closed, leaking file descriptors. Close files that were opened when the function exist. --- internal/lang/funcs/crypto.go | 1 + internal/lang/funcs/filesystem.go | 1 + 2 files changed, 2 insertions(+) diff --git a/internal/lang/funcs/crypto.go b/internal/lang/funcs/crypto.go index f785a7f3b967..7c4ba4ada3ba 100644 --- a/internal/lang/funcs/crypto.go +++ b/internal/lang/funcs/crypto.go @@ -248,6 +248,7 @@ func makeFileHashFunction(baseDir string, hf func() hash.Hash, enc func([]byte) if err != nil { return cty.UnknownVal(cty.String), err } + defer f.Close() h := hf() _, err = io.Copy(h, f) diff --git a/internal/lang/funcs/filesystem.go b/internal/lang/funcs/filesystem.go index fb0db7e53a64..846b86110f70 100644 --- a/internal/lang/funcs/filesystem.go +++ b/internal/lang/funcs/filesystem.go @@ -377,6 +377,7 @@ func readFileBytes(baseDir, path string) ([]byte, error) { } return nil, err } + defer f.Close() src, err := ioutil.ReadAll(f) if err != nil { From a9eb62d6922cfe6533bac15291f2ac246762ba2d Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Tue, 2 Nov 2021 15:53:26 -0500 Subject: [PATCH 347/644] Cloud: Migrate empty default workspace prompt Given: You have multiple explicit local workspaces, and the `default` workspace is empty. When: You migrate the workspaces to Terraform Cloud. Then: Terraform should _not_ ask for a workspace to migrate the `default` workspace to in Terraform Cloud. --- internal/command/meta_backend_migrate.go | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 97162eb8b3c9..56faa4523fa2 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -629,11 +629,25 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa defaultNewName := map[string]string{} for i := 0; i < len(sourceWorkspaces); i++ { if sourceWorkspaces[i] == backend.DefaultStateName { - newName, err := m.promptNewWorkspaceName(opts.DestinationType) + // For the default workspace we want to look to see if there is any state + // before we ask for a workspace name to migrate the default workspace into. + sourceState, err := opts.Source.StateMgr(backend.DefaultStateName) if err != nil { - return err + return fmt.Errorf(strings.TrimSpace( + errMigrateSingleLoadDefault), opts.SourceType, err) + } + // RefreshState is what actually pulls the state to be evaluated. + if err := sourceState.RefreshState(); err != nil { + return fmt.Errorf(strings.TrimSpace( + errMigrateSingleLoadDefault), opts.SourceType, err) + } + if !sourceState.State().Empty() { + newName, err := m.promptNewWorkspaceName(opts.DestinationType) + if err != nil { + return err + } + defaultNewName[sourceWorkspaces[i]] = newName } - defaultNewName[sourceWorkspaces[i]] = newName } } From aeecc6a627030ac2fdecf12b6cf59dfccb44ff5b Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Tue, 16 Nov 2021 18:19:11 +0000 Subject: [PATCH 348/644] add AffectedAbsResource to interface --- internal/addrs/moveable.go | 2 +- internal/addrs/resource.go | 13 +++++++++---- internal/refactoring/move_validate.go | 7 +++---- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/internal/addrs/moveable.go b/internal/addrs/moveable.go index 083fcfb27fe6..b9d2f87f075d 100644 --- a/internal/addrs/moveable.go +++ b/internal/addrs/moveable.go @@ -28,7 +28,7 @@ var ( // instance. type AbsMoveableResource interface { AbsMoveable - Type() string + AffectedAbsResource() AbsResource } // The following are all of the possible AbsMoveableResource types: diff --git a/internal/addrs/resource.go b/internal/addrs/resource.go index 9c81c0eddd9f..d8596237ffb8 100644 --- a/internal/addrs/resource.go +++ b/internal/addrs/resource.go @@ -186,8 +186,9 @@ func (r AbsResource) String() string { return fmt.Sprintf("%s.%s", r.Module.String(), r.Resource.String()) } -func (r AbsResource) Type() string { - return r.Resource.Type +// AffectedAbsResource returns the AbsResource. +func (r AbsResource) AffectedAbsResource() AbsResource { + return r } func (r AbsResource) Equal(o AbsResource) bool { @@ -271,8 +272,12 @@ func (r AbsResourceInstance) String() string { return fmt.Sprintf("%s.%s", r.Module.String(), r.Resource.String()) } -func (r AbsResourceInstance) Type() string { - return r.Resource.Resource.Type +// AffectedAbsResource returns the AbsResource for the instance. +func (r AbsResourceInstance) AffectedAbsResource() AbsResource { + return AbsResource{ + Module: r.Module, + Resource: r.Resource.Resource, + } } func (r AbsResourceInstance) Equal(o AbsResourceInstance) bool { diff --git a/internal/refactoring/move_validate.go b/internal/refactoring/move_validate.go index b393c0a0b035..133698608388 100644 --- a/internal/refactoring/move_validate.go +++ b/internal/refactoring/move_validate.go @@ -249,14 +249,13 @@ func moveableObjectExists(addr addrs.AbsMoveable, in instances.Set) bool { } func resourceTypesDiffer(absFrom, absTo addrs.AbsMoveable) bool { - switch absFrom.(type) { - case addrs.AbsResourceInstance, addrs.AbsResource: - absFrom := absFrom.(addrs.AbsMoveableResource) + switch absFrom := absFrom.(type) { + case addrs.AbsMoveableResource: // addrs.UnifyMoveEndpoints guarantees that both addresses are of the // same kind, so at this point we can assume that absTo is also an // addrs.AbsResourceInstance or addrs.AbsResource. absTo := absTo.(addrs.AbsMoveableResource) - return absFrom.Type() != absTo.Type() + return absFrom.AffectedAbsResource().Resource.Type != absTo.AffectedAbsResource().Resource.Type default: return false } From a146a2746ebece2e0f983671d0f07c8d4c512364 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Tue, 16 Nov 2021 13:05:26 -0600 Subject: [PATCH 349/644] Add clarifying commend and e2e test This pull request focuses on removing the prompt to rename the default workspace when it is empty. Functionality already exists to not migrate an empty workspace. This commit adds some clarifying language in the comment where we do the evaluation to know whether to ask for a new name or not. I also added an end to end test, which I should have added to begin with. --- .../e2e/migrate_state_multi_to_tfc_test.go | 73 ++++++++++++++++++- internal/command/meta_backend_migrate.go | 8 +- 2 files changed, 77 insertions(+), 4 deletions(-) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 950f3859ea02..b325e218bf12 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -157,6 +157,77 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } }, }, + "migrating multiple workspaces to cloud using name strategy; 'default' workspace is empty": { + operations: []operationSets{ + { + prep: func(t *testing.T, orgName, dir string) { + tfBlock := terraformConfigLocalBackend() + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init"}, + expectedCmdOutput: `Successfully configured the backend "local"!`, + }, + { + command: []string{"workspace", "new", "workspace1"}, + expectedCmdOutput: `Created and switched to workspace "workspace1"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + { + command: []string{"workspace", "new", "workspace2"}, + expectedCmdOutput: `Created and switched to workspace "workspace2"!`, + }, + { + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, + }, + }, + }, + { + prep: func(t *testing.T, orgName, dir string) { + wsName := "new-workspace" + tfBlock := terraformConfigCloudBackendName(orgName, wsName) + writeMainTF(t, tfBlock, dir) + }, + commands: []tfCommand{ + { + command: []string{"init", "-migrate-state"}, + expectedCmdOutput: `Do you want to copy only your current workspace?`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Do you want to copy existing state to Terraform Cloud?`, + `Terraform Cloud has been successfully initialized!`}, + }, + { + command: []string{"workspace", "select", "default"}, + expectError: true, + }, + { + command: []string{"output"}, + expectedCmdOutput: `val = "workspace2"`, // this was the output of the current workspace selected before migration + }, + }, + }, + }, + validations: func(t *testing.T, orgName string) { + wsList, err := tfeClient.Workspaces.List(ctx, orgName, tfe.WorkspaceListOptions{}) + if err != nil { + t.Fatal(err) + } + if len(wsList.Items) != 1 { + t.Fatalf("Expected the number of workspaces to be 1, but got %d", len(wsList.Items)) + } + ws := wsList.Items[0] + // this workspace name is what exists in the cloud backend configuration block + if ws.Name != "new-workspace" { + t.Fatalf("Expected workspace to be `new-workspace`, but is %s", ws.Name) + } + }, + }, } for name, tc := range cases { @@ -220,7 +291,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } err = cmd.Wait() - if err != nil { + if err != nil && !tfCmd.expectError { t.Fatal(err) } } diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 56faa4523fa2..5fc65ae7dd35 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -622,10 +622,12 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa newCurrentWorkspace := "" // This map is used later when doing the migration per source/destination. - // If a source has 'default', then we ask what the new name should be. + // If a source has 'default' and has state, then we ask what the new name should be. // And further down when we actually run state migration for each - // sourc/destination workspce, we use this new name (where source is 'default') - // and set as destinationWorkspace. + // source/destination workspace, we use this new name (where source is 'default') + // and set as destinationWorkspace. If the default workspace does not have + // state we will not prompt the user for a new name because empty workspaces + // do not get migrated. defaultNewName := map[string]string{} for i := 0; i < len(sourceWorkspaces); i++ { if sourceWorkspaces[i] == backend.DefaultStateName { From ac52f5135a2fae65910699866eca5aefa1576dca Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 16 Nov 2021 14:42:06 -0500 Subject: [PATCH 350/644] update k8s packages from retracted module Use the latest k8s.io packages from v0.21 --- go.mod | 34 ++++++------- go.sum | 153 +++++++++++++++++++++++++++++---------------------------- 2 files changed, 94 insertions(+), 93 deletions(-) diff --git a/go.mod b/go.mod index a830edcc323a..d01ec73db159 100644 --- a/go.mod +++ b/go.mod @@ -86,7 +86,7 @@ require ( golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e - golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf + golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d golang.org/x/text v0.3.6 golang.org/x/tools v0.1.7 google.golang.org/api v0.44.0-impersonate-preview @@ -94,10 +94,10 @@ require ( google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 google.golang.org/protobuf v1.27.1 honnef.co/go/tools v0.3.0-0.dev - k8s.io/api v0.0.0-20190620084959-7cf5895f2711 - k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655 - k8s.io/client-go v10.0.0+incompatible - k8s.io/utils v0.0.0-20200411171748-3d5a2fe318e4 + k8s.io/api v0.21.3 + k8s.io/apimachinery v0.21.3 + k8s.io/client-go v0.21.3 + k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b ) require ( @@ -131,13 +131,14 @@ require ( github.com/dylanmei/iso8601 v0.1.0 // indirect github.com/fatih/color v1.9.0 // indirect github.com/form3tech-oss/jwt-go v3.2.2+incompatible // indirect + github.com/go-logr/logr v0.4.0 // indirect github.com/gofrs/uuid v3.3.0+incompatible // indirect - github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d // indirect + github.com/gogo/protobuf v1.3.2 // indirect github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect github.com/google/go-querystring v1.1.0 // indirect - github.com/google/gofuzz v1.0.0 // indirect + github.com/google/gofuzz v1.1.0 // indirect github.com/googleapis/gax-go/v2 v2.0.5 // indirect - github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d // indirect + github.com/googleapis/gnostic v0.4.1 // indirect github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 // indirect github.com/hashicorp/go-immutable-radix v1.0.0 // indirect github.com/hashicorp/go-msgpack v0.5.4 // indirect @@ -150,11 +151,11 @@ require ( github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect github.com/huandu/xstrings v1.3.2 // indirect github.com/imdario/mergo v0.3.11 // indirect - github.com/json-iterator/go v1.1.7 // indirect + github.com/json-iterator/go v1.1.10 // indirect github.com/jstemmer/go-junit-report v0.9.1 // indirect github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect - github.com/kr/pty v1.1.1 // indirect + github.com/kr/pty v1.1.5 // indirect github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/mattn/go-colorable v0.1.6 // indirect github.com/mitchellh/go-testing-interface v1.0.0 // indirect @@ -167,7 +168,7 @@ require ( github.com/satori/go.uuid v1.2.0 // indirect github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a // indirect - github.com/spf13/pflag v1.0.3 // indirect + github.com/spf13/pflag v1.0.5 // indirect github.com/ulikunitz/xz v0.5.8 // indirect github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect github.com/vmihailenco/tagparser v0.1.1 // indirect @@ -180,19 +181,18 @@ require ( golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/appengine v1.6.7 // indirect google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect - gopkg.in/inf.v0 v0.9.0 // indirect + gopkg.in/inf.v0 v0.9.1 // indirect gopkg.in/ini.v1 v1.42.0 // indirect - gopkg.in/yaml.v2 v2.3.0 // indirect - k8s.io/klog v0.4.0 // indirect - sigs.k8s.io/yaml v1.1.0 // indirect + gopkg.in/yaml.v2 v2.4.0 // indirect + k8s.io/klog/v2 v2.8.0 // indirect + sigs.k8s.io/structured-merge-diff/v4 v4.1.2 // indirect + sigs.k8s.io/yaml v1.2.0 // indirect ) replace google.golang.org/grpc v1.36.0 => google.golang.org/grpc v1.27.1 replace github.com/golang/mock v1.5.0 => github.com/golang/mock v1.4.4 -replace k8s.io/client-go => k8s.io/client-go v0.0.0-20190620085101-78d2af792bab - // github.com/dgrijalva/jwt-go is no longer maintained but is an indirect // dependency of the old etcdv2 backend, and so we need to keep this working // until that backend is removed. github.com/golang-jwt/jwt/v3 is a drop-in diff --git a/go.sum b/go.sum index f7d7f23db845..c429b3bb967e 100644 --- a/go.sum +++ b/go.sum @@ -42,11 +42,11 @@ github.com/Azure/azure-sdk-for-go v47.1.0+incompatible/go.mod h1:9XXNKU+eRnpl9mo github.com/Azure/azure-sdk-for-go v51.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/azure-sdk-for-go v52.5.0+incompatible h1:/NLBWHCnIHtZyLPc1P7WIqi4Te4CC23kIQyK3Ep/7lA= github.com/Azure/azure-sdk-for-go v52.5.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= -github.com/Azure/go-autorest v11.1.2+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs= github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= github.com/Azure/go-autorest/autorest v0.11.3/go.mod h1:JFgpikqFJ/MleTTxwepExTKnFUKKszPS8UavbQYUMuw= github.com/Azure/go-autorest/autorest v0.11.10/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= +github.com/Azure/go-autorest/autorest v0.11.12/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= github.com/Azure/go-autorest/autorest v0.11.18 h1:90Y4srNYrwOtAgVo3ndrQkTYn6kf1Eg/AjTFJ8Is2aM= github.com/Azure/go-autorest/autorest v0.11.18/go.mod h1:dSiJPy22c3u0OtOKDNttNgqpNFY/GeWa7GH/Pz56QRA= github.com/Azure/go-autorest/autorest/adal v0.9.0/go.mod h1:/c022QCutn2P7uY+/oQWWNcK9YU+MH96NgK+jErpbcg= @@ -91,8 +91,8 @@ github.com/Microsoft/go-winio v0.5.0/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpz github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ= github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25 h1:hWfsqBaNZUHztXA78g7Y2Jj3rDQaTCZhhFwz43i2VlA= github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25/go.mod h1:68ORG0HSEWDuH5Eh73AFbYWZ1zT4Y+b0vhOa+vZRUdI= -github.com/PuerkitoBio/purell v1.0.0/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= -github.com/PuerkitoBio/urlesc v0.0.0-20160726150825-5bd2802263f2/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= +github.com/PuerkitoBio/purell v1.1.1/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= +github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM= github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af h1:DBNMBMuMiWYu0b+8KMJuWmfCkcxl09JwdlqwDZZ6U14= github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af/go.mod h1:5Jv4cbFiHJMsVxt52+i0Ha45fjshj6wxYr1r19tB9bw= @@ -135,6 +135,7 @@ github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmV github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= +github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY= github.com/aws/aws-sdk-go v1.15.78/go.mod h1:E3/ieXAlvM0XWO57iftYVDLLvQ824smPP3ATZkfNZeM= github.com/aws/aws-sdk-go v1.31.9/go.mod h1:5zCpMtNQVjRREroY7sYe8lOMRSxkhG6MZveU8YkpAk0= github.com/aws/aws-sdk-go v1.40.25 h1:Depnx7O86HWgOCLD5nMto6F9Ju85Q1QuFDnbpZYQWno= @@ -172,22 +173,22 @@ github.com/coreos/go-systemd v0.0.0-20181012123002-c6f51f82210d/go.mod h1:F5haX7 github.com/coreos/pkg v0.0.0-20160727233714-3ac0863d7acf/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f h1:lBNOc5arjvs8E5mO2tbpBpLoyyu8B6e44T7hJy6potg= github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= +github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= -github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/dimchansky/utfbom v1.1.0/go.mod h1:rO41eb7gLfo8SF1jd9F8HplJm1Fewwi4mQvIirEdv+8= github.com/dimchansky/utfbom v1.1.1 h1:vV6w1AhK4VMnhBno/TPVCoK9U/LP0PkLCS9tbxHdi/U= github.com/dimchansky/utfbom v1.1.1/go.mod h1:SxdoEBH5qIqFocHMyGOXVAybYJdr71b1Q/j0mACtrfE= -github.com/docker/spdystream v0.0.0-20160310174837-449fdfce4d96/go.mod h1:Qh8CwZgvJUkLughtfhJv5dyTYa91l1fOUCrgjqmcifM= +github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE= github.com/dustin/go-humanize v0.0.0-20171111073723-bb3d318650d4 h1:qk/FSDDxo05wdJH28W+p5yivv7LuLYLRXPPD8KQCtZs= github.com/dustin/go-humanize v0.0.0-20171111073723-bb3d318650d4/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= github.com/dylanmei/iso8601 v0.1.0 h1:812NGQDBcqquTfH5Yeo7lwR0nzx/cKdsmf3qMjPURUI= github.com/dylanmei/iso8601 v0.1.0/go.mod h1:w9KhXSgIyROl1DefbMYIE7UVSIvELTbMrCfx+QkYnoQ= github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 h1:r1oACdS2XYiAWcfF8BJXkoU8l1J71KehGR+d99yWEDA= github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1/go.mod h1:lcy9/2gH1jn/VCLouHA6tOEwLoNVd4GW6zhuKLmHC2Y= -github.com/elazarl/goproxy v0.0.0-20170405201442-c4fc26588b6e/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc= +github.com/elazarl/goproxy v0.0.0-20180725130230-947c36da3153/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc= github.com/emicklei/go-restful v0.0.0-20170410110728-ff4f55a20633/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs= github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= @@ -195,15 +196,13 @@ github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1m github.com/envoyproxy/go-control-plane v0.9.7/go.mod h1:cwu0lG7PUMfa9snN8LXBig5ynNVH9qI8YYLbd1fK2po= github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= -github.com/evanphx/json-patch v0.0.0-20190203023257-5858425f7550/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= -github.com/evanphx/json-patch v4.2.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= +github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s= github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU= github.com/form3tech-oss/jwt-go v3.2.2+incompatible h1:TcekIExNqud5crz4xD2pavyTgWiPvpYe4Xau31I0PRk= github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= -github.com/ghodss/yaml v0.0.0-20150909031657-73d445a93680/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= @@ -211,10 +210,15 @@ github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2 github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= github.com/go-logr/logr v0.1.0/go.mod h1:ixOQHD9gLJUVQQ2ZOR7zLEifBX6tGkNJF4QyIY7sIas= -github.com/go-openapi/jsonpointer v0.0.0-20160704185906-46af16f9f7b1/go.mod h1:+35s3my2LFTysnkMfxsJBAMHj/DoqoB9knIWoYG/Vk0= -github.com/go-openapi/jsonreference v0.0.0-20160704190145-13c6e3589ad9/go.mod h1:W3Z9FmVs9qj+KR4zFKmDPGiLdk1D9Rlm7cyMvf57TTg= -github.com/go-openapi/spec v0.0.0-20160808142527-6aced65f8501/go.mod h1:J8+jY1nAiCcj+friV/PDoE1/3eeccG9LYBs0tYvLOWc= -github.com/go-openapi/swag v0.0.0-20160704191624-1d0bd113de87/go.mod h1:DXUve3Dpr1UfpPtxFw+EFuQ41HhCWZfha5jSVRG7C7I= +github.com/go-logr/logr v0.4.0 h1:K7/B1jt6fIBQVd4Owv2MqGQClcgf0R266+7C/QjRcLc= +github.com/go-logr/logr v0.4.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU= +github.com/go-openapi/jsonpointer v0.19.2/go.mod h1:3akKfEdA7DF1sugOqz1dVQHBcuDBPKZGEoHC/NkiQRg= +github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= +github.com/go-openapi/jsonreference v0.19.2/go.mod h1:jMjeRr2HHw6nAVajTXJ4eiUwohSTlpa0o73RUL1owJc= +github.com/go-openapi/jsonreference v0.19.3/go.mod h1:rjx6GuL8TTa9VaixXglHmQmIL98+wF9xc8zWvFonSJ8= +github.com/go-openapi/spec v0.19.3/go.mod h1:FpwSN1ksY1eteniUU7X0N/BgJ7a4WvBFVA8Lj9mJglo= +github.com/go-openapi/swag v0.19.2/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= +github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= github.com/go-test/deep v1.0.1/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= @@ -223,11 +227,10 @@ github.com/go-test/deep v1.0.3/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3a github.com/gofrs/uuid v3.2.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= github.com/gofrs/uuid v3.3.0+incompatible h1:8K4tyRfvU1CYPgJsveYFQMhpFd/wXNM7iK6rR7UHz84= github.com/gofrs/uuid v3.3.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= -github.com/gogo/protobuf v0.0.0-20171007142547-342cbe0a0415/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= -github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d h1:3PaI8p3seN09VjbTYC/QWlUZdZ1qS1zGjy7LH2Wt07I= -github.com/gogo/protobuf v1.2.2-0.20190723190241-65acae22fc9d/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o= +github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= +github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c= github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58= @@ -246,7 +249,6 @@ github.com/golang/mock v1.4.3/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt github.com/golang/mock v1.4.4/go.mod h1:l3mdAwkq5BuhzHwde/uurv3sEJeZMXNpwsxVWU71h+4= github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc= github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= -github.com/golang/protobuf v0.0.0-20161109072736-4bd1920723d7/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.1.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= @@ -265,7 +267,6 @@ github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= -github.com/google/btree v0.0.0-20160524151835-7d79101e329e/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= github.com/google/btree v1.0.0 h1:0udJVsspx3VBr5FwtLhQQtuAsVc79tTq0ocGIPAU6qo= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= @@ -284,10 +285,9 @@ github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck= github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8= github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU= -github.com/google/gofuzz v0.0.0-20161122191042-44d81051d367/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI= -github.com/google/gofuzz v0.0.0-20170612174753-24818f796faf/go.mod h1:HP5RmnzzSNb993RKQDq4+1A4ia9nllfqcQFTQJedwGI= -github.com/google/gofuzz v1.0.0 h1:A8PeW59pxE9IoFRqBp37U+mSNaQoZ46F1f0f863XSXw= github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/gofuzz v1.1.0 h1:Hsa8mG0dQ46ij8Sl2AYJDUv1oA9/d6Vk+3LG99Oe02g= +github.com/google/gofuzz v1.1.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/google/martian v2.1.0+incompatible h1:/CP5g8u/VJHijgedC/Legn3BAbAaWPgecwXBIDzw5no= github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs= github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0= @@ -313,9 +313,8 @@ github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+ github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= github.com/googleapis/gax-go/v2 v2.0.5 h1:sjZBwGj9Jlw33ImPtvFviGYvseOtDM7hkSKB7+Tv3SM= github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= -github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d h1:7XGaL1e6bYS1yIonGp9761ExpPPV1ui0SAC59Yube9k= -github.com/googleapis/gnostic v0.0.0-20170729233727-0c5108395e2d/go.mod h1:sJBsCZ4ayReDTBIg8b9dl28c5xFWyhBTVRp3pOg5EKY= -github.com/gophercloud/gophercloud v0.0.0-20190126172459-c818fa66e4c8/go.mod h1:3WdhXV3rUYy9p6AUW8d94kr+HS62Y4VL9mBnFxsD8q4= +github.com/googleapis/gnostic v0.4.1 h1:DLJCy1n/vrD4HPjOvYcT8aYQXpPIzoRZONaYwyycI+I= +github.com/googleapis/gnostic v0.4.1/go.mod h1:LRhVm6pbyptWbWbuZ38d1eyptfvIytN3ir6b65WBswg= github.com/gophercloud/gophercloud v0.6.1-0.20191122030953-d8ac278c1c9d/go.mod h1:ozGNgr9KYOVATV5jsgHl/ceCDXGuguqOZAzoQ/2vcNM= github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 h1:Ciwp7ro4LyptUOkili/TX/ecuYr7vGtEIFnOOOKUjD8= github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5/go.mod h1:gmC5oQqMDOMO1t1gq5DquX/yAU808e/4mzjjDA76+Ss= @@ -325,7 +324,7 @@ github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGa github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= -github.com/gregjones/httpcache v0.0.0-20170728041850-787624de3eb7/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA= +github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA= github.com/grpc-ecosystem/go-grpc-middleware v1.0.1-0.20190118093823-f849b5445de4 h1:z53tR0945TRRQO/fLEVPI6SMv7ZflF0TEaTAoU7tOzg= github.com/grpc-ecosystem/go-grpc-middleware v1.0.1-0.20190118093823-f849b5445de4/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 h1:Ovs26xHkKqVztRpIrF/92BcuyuQ/YW4NSIpoGtfXNho= @@ -435,11 +434,10 @@ github.com/jonboulle/clockwork v0.1.0 h1:VKV+ZcuP6l3yW9doeqz6ziZGgcynBVQO+obU0+0 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926 h1:kie3qOosvRKqwij2HGzXWffwpXvcqfPPXRUw8I4F/mg= github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926/go.mod h1:U+RSyWxWd04xTqnuOQxnai7XGS2PrPY2cfGoDKtMHjA= -github.com/json-iterator/go v0.0.0-20180612202835-f2b4162afba3/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= -github.com/json-iterator/go v0.0.0-20180701071628-ab8a2e0c74be/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= -github.com/json-iterator/go v1.1.7 h1:KfgG9LzI+pYjr4xvmz/5H4FXjokeP+rlHLhv3iH62Fo= github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/json-iterator/go v1.1.10 h1:Kz6Cvnvv2wGdaG/V8yMvfkmNiXq9Ya2KUv4rouJJr68= +github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= github.com/jstemmer/go-junit-report v0.9.1 h1:6QPYqodiu3GuPL+7mfx+NwDdp2eTkp9IfEUpgAwUN0o= github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= @@ -449,7 +447,7 @@ github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7V github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 h1:iQTw/8FWTuc7uiaSepXwyf3o52HaUYcV+Tu66S3F5GA= github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0/go.mod h1:1NbS8ALrpOvjt0rHPNLyCIeMtbizbir8U//inJ+zuB8= github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= -github.com/kisielk/errcheck v1.2.0/go.mod h1:/BMXB+zMLi60iA8Vv6Ksmxu/1UDYcXs4uQLJ+jE2L00= +github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/klauspost/compress v1.11.2 h1:MiK62aErc3gIiVEtyzKfeOHgW7atJb5g/KNX5m3c2nQ= github.com/klauspost/compress v1.11.2/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYsUV+/s2qKfXs= @@ -458,10 +456,12 @@ github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFB github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs= github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= -github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= -github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/pty v1.1.5 h1:hyz3dwM5QLc1Rfoz4FuWJQG5BN7tc6K1MndAUnGpQr4= +github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/kylelemons/godebug v0.0.0-20170820004349-d65d576e9348/go.mod h1:B69LEHPfb2qLo0BaaOLcbitczOKLWTsrBG9LczfCD4k= github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= @@ -469,7 +469,8 @@ github.com/lib/pq v1.10.3 h1:v9QZf2Sn6AmjXtQeFpdoq/eaNtYP6IN+7lcrygsIAtg= github.com/lib/pq v1.10.3/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 h1:wnfcqULT+N2seWf6y4yHzmi7GD2kNx4Ute0qArktD48= github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82/go.mod h1:y54tfGmO3NKssKveTEFFzH8C/akrSOy/iW9qEAUDV84= -github.com/mailru/easyjson v0.0.0-20160728113105-d5b7844b561a/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= github.com/masterzen/simplexml v0.0.0-20160608183007-4572e39b1ab9/go.mod h1:kCEbxUJlNDEBNbdQMkPSp6yaKcRXVI6f4ddk8Riv4bc= github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 h1:2ZKn+w/BJeL43sCxI2jhPLRv73oVVOjEKZjKkflyqxg= github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786/go.mod h1:kCEbxUJlNDEBNbdQMkPSp6yaKcRXVI6f4ddk8Riv4bc= @@ -525,10 +526,10 @@ github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ= github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= +github.com/moby/spdystream v0.2.0/go.mod h1:f7i0iNDQJ059oMTcWxx8MA/zKFIuD/lY+0GqbN2Wy8c= github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= -github.com/modern-go/reflect2 v0.0.0-20180320133207-05fbef0ca5da/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= github.com/modern-go/reflect2 v1.0.1 h1:9f412s+6RmYXLWZSEzVVgPGK7C2PphHj5RJrvfx9AWI= github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= @@ -538,6 +539,8 @@ github.com/mozillazg/go-httpheader v0.3.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK0 github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw= +github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs= +github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/nishanths/exhaustive v0.2.3 h1:+ANTMqRNrqwInnP9aszg/0jDo+zbXa4x66U19Bx/oTk= github.com/nishanths/exhaustive v0.2.3/go.mod h1:bhIX678Nx8inLM9PbpvK1yv6oGtoP8BfaIeMzgBNKvc= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ= @@ -547,10 +550,9 @@ github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQ github.com/olekukonko/tablewriter v0.0.0-20170122224234-a0225b3f23b5/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo= github.com/onsi/ginkgo v0.0.0-20170829012221-11459a886d9c/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= -github.com/onsi/ginkgo v1.8.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.11.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= github.com/onsi/gomega v0.0.0-20170829124025-dcabb60a477c/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA= -github.com/onsi/gomega v0.0.0-20190113212917-5533ce8a0da3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= -github.com/onsi/gomega v1.5.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= +github.com/onsi/gomega v1.7.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db h1:9uViuKtx1jrlXLBW/pMnhOfzn3iSEdLase/But/IZRU= github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db/go.mod h1:f6Izs6JvFTdnRbziASagjZ2vmf55NSIkC/weStxCHqk= github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c h1:Lgl0gzECD8GnQ5QCWA8o6BtfL6mDH5rQgM4/fX3avOs= @@ -562,7 +564,6 @@ github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= -github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI= @@ -605,12 +606,13 @@ github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3 github.com/spf13/pflag v0.0.0-20170130214245-9ff6c6923cff/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/pflag v1.0.1/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/pflag v1.0.2/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= -github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg= github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v0.0.0-20151208002404-e3a8ff8ce365/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/objx v0.2.0 h1:Hbg2NidpLE8veEBkEZTL3CvlkUIVzuU9jDplZO54c48= +github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= @@ -680,13 +682,13 @@ go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/ go.uber.org/zap v1.10.0 h1:ORx85nbTijNz8ljznvCMR1ZBIPKFn3jQrag10X2AsuM= go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= -golang.org/x/crypto v0.0.0-20181025213731-e84da0312774/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190222235706-ffb98f73852f/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190426145343-a29dc8fdc734/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20190611184440-5c40567a22f8/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392/go.mod h1:/lpIB1dKB+9EgE3H3cr1v9wB50oz8l4C4h62xy7jSTY= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191202143827-86a70503ff7e/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= @@ -733,7 +735,6 @@ golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= -golang.org/x/net v0.0.0-20170114055629-f2499483f923/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180530234432-1e491301e022/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180811021610-c39426892332/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -743,17 +744,17 @@ golang.org/x/net v0.0.0-20181023162649-9b4f9f5ad519/go.mod h1:mL1N/T3taQHkDXs73r golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20190206173232-65e2d4e15006/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190501004415-9ce7a6920f09/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20190812203447-cdfb69ac37fc/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190923162816-aa69164e4478/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20191009170851-d66e71096ffb/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20191126235420-ef20fe5d7933/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -776,6 +777,7 @@ golang.org/x/net v0.0.0-20201031054903-ff519b6c9102/go.mod h1:sp8m0HH+o8qH0wwXwY golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210224082022-3d97a244fca7/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= @@ -783,7 +785,6 @@ golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQ golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= -golang.org/x/oauth2 v0.0.0-20190402181905-9f3314589c9a/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -805,7 +806,6 @@ golang.org/x/sync v0.0.0-20200625203802-6e8e738ad208/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201207232520-09787c993a3a/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sys v0.0.0-20170830134202-bb24a47a89ea/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180823144017-11551d06cbcc/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -861,6 +861,7 @@ golang.org/x/sys v0.0.0-20210305230114-8fe3ee5dd75b/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -868,30 +869,26 @@ golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e h1:WUoyKPm6nCo1BnNUvPGnFG3T5 golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf h1:MZ2shdL+ZM/XzY3ZGOnh4Nlpnxz5GSOhOmtHo3iPU6M= -golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/text v0.0.0-20160726164857-2910a502d2bf/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d h1:SZxvLBoTP5yHO3Frd4z4vrF+DBX9vMVanchswa69toE= +golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.1-0.20181227161524-e6919f6577db/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/time v0.0.0-20161028155119-f51c12702a4d/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac h1:7zkz7BUtwNFFqcowJ+RIgu2MaV/MapERkDIy+mwPyjs= golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20181011042414-1f849cf54d09/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20181030221726-6c7e314b6563/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= @@ -901,6 +898,7 @@ golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBn golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= +golang.org/x/tools v0.0.0-20190614205625-5aca471b1d59/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= @@ -930,6 +928,7 @@ golang.org/x/tools v0.0.0-20200501065659-ab2804fb9c9d/go.mod h1:EkVYQZoAsY45+roY golang.org/x/tools v0.0.0-20200512131952-2bc93b1c0c88/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200515010526-7d3b6ebf133d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200618134242-20370b0cb4b2/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= +golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200729194436-6467de6f59a7/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200804011535-6c149bb5ef0d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200825202427-b303f430e36d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= @@ -938,6 +937,7 @@ golang.org/x/tools v0.0.0-20201110124207-079ba7bd75cd/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.0.0-20201201161351-ac6f37ff4c2a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20201208233053-a543418bbed2/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= @@ -1055,14 +1055,15 @@ google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU= +gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/cheggaaa/pb.v1 v1.0.25/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw= gopkg.in/cheggaaa/pb.v1 v1.0.27/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw= gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= -gopkg.in/inf.v0 v0.9.0 h1:3zYtXIO92bvsdS3ggAdA8Gb4Azj0YU+TVY1uGYNFA8o= -gopkg.in/inf.v0 v0.9.0/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw= +gopkg.in/inf.v0 v0.9.1 h1:73M5CoZyi3ZLMOyDlQh031Cx6N9NDJ2Vvfl76EDAgDc= +gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw= gopkg.in/ini.v1 v1.42.0 h1:7N3gPTt50s8GuLortA00n8AqRTk75qOP98+mTPpgzRk= gopkg.in/ini.v1 v1.42.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= @@ -1073,8 +1074,9 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU= gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= @@ -1086,27 +1088,26 @@ honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9 honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= honnef.co/go/tools v0.3.0-0.dev h1:6vzhjcOJu1nJRa2G8QLXf3DPeg601NuerY16vrb01GY= honnef.co/go/tools v0.3.0-0.dev/go.mod h1:lPVVZ2BS5TfnjLyizF7o7hv7j9/L+8cZY2hLyjP9cGY= -k8s.io/api v0.0.0-20190620084959-7cf5895f2711 h1:BblVYz/wE5WtBsD/Gvu54KyBUTJMflolzc5I2DTvh50= -k8s.io/api v0.0.0-20190620084959-7cf5895f2711/go.mod h1:TBhBqb1AWbBQbW3XRusr7n7E4v2+5ZY8r8sAMnyFC5A= -k8s.io/apimachinery v0.0.0-20190612205821-1799e75a0719/go.mod h1:I4A+glKBHiTgiEjQiCCQfCAIcIMFGt291SmsvcrFzJA= -k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655 h1:CS1tBQz3HOXiseWZu6ZicKX361CZLT97UFnnPx0aqBw= -k8s.io/apimachinery v0.0.0-20190913080033-27d36303b655/go.mod h1:nL6pwRT8NgfF8TT68DBI8uEePRt89cSvoXUVqbkWHq4= -k8s.io/client-go v0.0.0-20190620085101-78d2af792bab h1:E8Fecph0qbNsAbijJJQryKu4Oi9QTp5cVpjTE+nqg6g= -k8s.io/client-go v0.0.0-20190620085101-78d2af792bab/go.mod h1:E95RaSlHr79aHaX0aGSwcPNfygDiPKOVXdmivCIZT0k= -k8s.io/gengo v0.0.0-20190128074634-0689ccc1d7d6/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0= -k8s.io/klog v0.0.0-20181102134211-b9b56d5dfc92/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk= -k8s.io/klog v0.3.1/go.mod h1:Gq+BEi5rUBO/HRz0bTSXDUcqjScdoY3a9IHpCEIOOfk= -k8s.io/klog v0.4.0 h1:lCJCxf/LIowc2IGS9TPjWDyXY4nOmdGdfcwwDQCOURQ= -k8s.io/klog v0.4.0/go.mod h1:4Bi6QPql/J/LkTDqv7R/cd3hPo4k2DG6Ptcz060Ez5I= +k8s.io/api v0.21.3 h1:cblWILbLO8ar+Fj6xdDGr603HRsf8Wu9E9rngJeprZQ= +k8s.io/api v0.21.3/go.mod h1:hUgeYHUbBp23Ue4qdX9tR8/ANi/g3ehylAqDn9NWVOg= +k8s.io/apimachinery v0.21.3 h1:3Ju4nvjCngxxMYby0BimUk+pQHPOQp3eCGChk5kfVII= +k8s.io/apimachinery v0.21.3/go.mod h1:H/IM+5vH9kZRNJ4l3x/fXP/5bOPJaVP/guptnZPeCFI= +k8s.io/client-go v0.21.3 h1:J9nxZTOmvkInRDCzcSNQmPJbDYN/PjlxXT9Mos3HcLg= +k8s.io/client-go v0.21.3/go.mod h1:+VPhCgTsaFmGILxR/7E1N0S+ryO010QBeNCv5JwRGYU= +k8s.io/gengo v0.0.0-20200413195148-3a45101e95ac/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0= k8s.io/klog/v2 v2.0.0/go.mod h1:PBfzABfn139FHAV07az/IF9Wp1bkk3vpT2XSJ76fSDE= -k8s.io/kube-openapi v0.0.0-20190228160746-b3a7cee44a30/go.mod h1:BXM9ceUBTj2QnfH2MK1odQs778ajze1RxcmP6S8RVVc= -k8s.io/kube-openapi v0.0.0-20190816220812-743ec37842bf/go.mod h1:1TqjTSzOxsLGIKfj0lK8EeCP7K1iUG65v09OM0/WG5E= -k8s.io/utils v0.0.0-20190221042446-c2654d5206da/go.mod h1:8k8uAuAQ0rXslZKaEWd0c3oVhZz7sSzSiPnVZayjIX0= -k8s.io/utils v0.0.0-20200411171748-3d5a2fe318e4 h1:vEYeh6f+jz98bCG4BHRQ733tuZpjzsJ+C/xv8awA0qM= -k8s.io/utils v0.0.0-20200411171748-3d5a2fe318e4/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= +k8s.io/klog/v2 v2.8.0 h1:Q3gmuM9hKEjefWFFYF0Mat+YyFJvsUyYuwyNNJ5C9Ts= +k8s.io/klog/v2 v2.8.0/go.mod h1:hy9LJ/NvuK+iVyP4Ehqva4HxZG/oXyIS3n3Jmire4Ec= +k8s.io/kube-openapi v0.0.0-20210305001622-591a79e4bda7/go.mod h1:wXW5VT87nVfh/iLV8FpR2uDvrFyomxbtb1KivDbvPTE= +k8s.io/utils v0.0.0-20201110183641-67b214c5f920/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= +k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b h1:wxEMGetGMur3J1xuGLQY7GEQYg9bZxKn3tKo5k/eYcs= +k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= -sigs.k8s.io/structured-merge-diff v0.0.0-20190525122527-15d366b2352e/go.mod h1:wWxsB5ozmmv/SG7nM11ayaAW51xMvak/t1r0CSlcokI= -sigs.k8s.io/yaml v1.1.0 h1:4A07+ZFc2wgJwo8YNlQpr1rVlgUDlxXHhPJciaPY5gs= +sigs.k8s.io/structured-merge-diff/v4 v4.0.2/go.mod h1:bJZC9H9iH24zzfZ/41RGcq60oK1F7G282QMXDPYydCw= +sigs.k8s.io/structured-merge-diff/v4 v4.1.2 h1:Hr/htKFmJEbtMgS/UD0N+gtgctAqz81t3nu+sPzynno= +sigs.k8s.io/structured-merge-diff/v4 v4.1.2/go.mod h1:j/nl6xW8vLS49O8YvXW1ocPhZawJtm+Yrr7PPRQ0Vg4= sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o= +sigs.k8s.io/yaml v1.2.0 h1:kr/MCeFWJWTwyaHoR9c8EjH9OumOmoF9YGiZd7lFm/Q= +sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc= From 61a580868017ca4749f4599b990e683d93c62242 Mon Sep 17 00:00:00 2001 From: Jared Ledvina Date: Fri, 7 May 2021 15:03:42 -0400 Subject: [PATCH 351/644] k8s-backend - Initial context support for library update Signed-off-by: Jared Ledvina --- .../remote-state/kubernetes/backend_state.go | 2 ++ .../remote-state/kubernetes/backend_test.go | 12 +++++---- .../backend/remote-state/kubernetes/client.go | 27 ++++++++++--------- 3 files changed, 24 insertions(+), 17 deletions(-) diff --git a/internal/backend/remote-state/kubernetes/backend_state.go b/internal/backend/remote-state/kubernetes/backend_state.go index e99b4c1be654..56aa089ff81c 100644 --- a/internal/backend/remote-state/kubernetes/backend_state.go +++ b/internal/backend/remote-state/kubernetes/backend_state.go @@ -1,6 +1,7 @@ package kubernetes import ( + "context" "errors" "fmt" "sort" @@ -21,6 +22,7 @@ func (b *Backend) Workspaces() ([]string, error) { } secrets, err := secretClient.List( + context.Background(), metav1.ListOptions{ LabelSelector: tfstateKey + "=true", }, diff --git a/internal/backend/remote-state/kubernetes/backend_test.go b/internal/backend/remote-state/kubernetes/backend_test.go index 7f0786c72cd5..e24689f0fb1c 100644 --- a/internal/backend/remote-state/kubernetes/backend_test.go +++ b/internal/backend/remote-state/kubernetes/backend_test.go @@ -1,6 +1,7 @@ package kubernetes import ( + "context" "fmt" "math/rand" "os" @@ -124,6 +125,7 @@ func TestBackendLocksSoak(t *testing.T) { } func cleanupK8sResources(t *testing.T) { + ctx := context.Background() // Get a backend to use the k8s client b1 := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ "secret_suffix": secretSuffix, @@ -138,13 +140,13 @@ func cleanupK8sResources(t *testing.T) { // Delete secrets opts := metav1.ListOptions{LabelSelector: tfstateKey + "=true"} - secrets, err := sClient.List(opts) + secrets, err := sClient.List(ctx, opts) if err != nil { t.Fatal(err) } delProp := metav1.DeletePropagationBackground - delOps := &metav1.DeleteOptions{PropagationPolicy: &delProp} + delOps := metav1.DeleteOptions{PropagationPolicy: &delProp} var errs []error for _, secret := range secrets.Items { @@ -155,7 +157,7 @@ func cleanupK8sResources(t *testing.T) { } if key == secretSuffix { - err = sClient.Delete(secret.GetName(), delOps) + err = sClient.Delete(ctx, secret.GetName(), delOps) if err != nil { errs = append(errs, err) } @@ -168,7 +170,7 @@ func cleanupK8sResources(t *testing.T) { } // Delete leases - leases, err := leaseClient.List(opts) + leases, err := leaseClient.List(ctx, opts) if err != nil { t.Fatal(err) } @@ -181,7 +183,7 @@ func cleanupK8sResources(t *testing.T) { } if key == secretSuffix { - err = leaseClient.Delete(lease.GetName(), delOps) + err = leaseClient.Delete(ctx, lease.GetName(), delOps) if err != nil { errs = append(errs, err) } diff --git a/internal/backend/remote-state/kubernetes/client.go b/internal/backend/remote-state/kubernetes/client.go index 137450c06131..12447c36e0c7 100644 --- a/internal/backend/remote-state/kubernetes/client.go +++ b/internal/backend/remote-state/kubernetes/client.go @@ -3,6 +3,7 @@ package kubernetes import ( "bytes" "compress/gzip" + "context" "crypto/md5" "encoding/base64" "encoding/json" @@ -46,7 +47,7 @@ func (c *RemoteClient) Get() (payload *remote.Payload, err error) { if err != nil { return nil, err } - secret, err := c.kubernetesSecretClient.Get(secretName, metav1.GetOptions{}) + secret, err := c.kubernetesSecretClient.Get(context.Background(), secretName, metav1.GetOptions{}) if err != nil { if k8serrors.IsNotFound(err) { return nil, nil @@ -78,6 +79,7 @@ func (c *RemoteClient) Get() (payload *remote.Payload, err error) { } func (c *RemoteClient) Put(data []byte) error { + ctx := context.Background() secretName, err := c.createSecretName() if err != nil { return err @@ -105,14 +107,14 @@ func (c *RemoteClient) Put(data []byte) error { }, } - secret, err = c.kubernetesSecretClient.Create(secret, metav1.CreateOptions{}) + secret, err = c.kubernetesSecretClient.Create(ctx, secret, metav1.CreateOptions{}) if err != nil { return err } } setState(secret, payload) - _, err = c.kubernetesSecretClient.Update(secret, metav1.UpdateOptions{}) + _, err = c.kubernetesSecretClient.Update(ctx, secret, metav1.UpdateOptions{}) return err } @@ -145,6 +147,7 @@ func (c *RemoteClient) Delete() error { } func (c *RemoteClient) Lock(info *statemgr.LockInfo) (string, error) { + ctx := context.Background() leaseName, err := c.createLeaseName() if err != nil { return "", err @@ -170,7 +173,7 @@ func (c *RemoteClient) Lock(info *statemgr.LockInfo) (string, error) { }, } - _, err = c.kubernetesLeaseClient.Create(lease) + _, err = c.kubernetesLeaseClient.Create(ctx, lease, metav1.CreateOptions{}) if err != nil { return "", err } else { @@ -197,7 +200,7 @@ func (c *RemoteClient) Lock(info *statemgr.LockInfo) (string, error) { lease.Spec.HolderIdentity = pointer.StringPtr(info.ID) setLockInfo(lease, info.Marshal()) - _, err = c.kubernetesLeaseClient.Update(lease) + _, err = c.kubernetesLeaseClient.Update(ctx, lease, metav1.UpdateOptions{}) if err != nil { return "", err } @@ -234,7 +237,7 @@ func (c *RemoteClient) Unlock(id string) error { lease.Spec.HolderIdentity = nil removeLockInfo(lease) - _, err = c.kubernetesLeaseClient.Update(lease) + _, err = c.kubernetesLeaseClient.Update(context.Background(), lease, metav1.UpdateOptions{}) if err != nil { lockErr.Err = err return lockErr @@ -276,11 +279,11 @@ func (c *RemoteClient) getLabels() map[string]string { } func (c *RemoteClient) getSecret(name string) (*unstructured.Unstructured, error) { - return c.kubernetesSecretClient.Get(name, metav1.GetOptions{}) + return c.kubernetesSecretClient.Get(context.Background(), name, metav1.GetOptions{}) } func (c *RemoteClient) getLease(name string) (*coordinationv1.Lease, error) { - return c.kubernetesLeaseClient.Get(name, metav1.GetOptions{}) + return c.kubernetesLeaseClient.Get(context.Background(), name, metav1.GetOptions{}) } func (c *RemoteClient) deleteSecret(name string) error { @@ -296,8 +299,8 @@ func (c *RemoteClient) deleteSecret(name string) error { } delProp := metav1.DeletePropagationBackground - delOps := &metav1.DeleteOptions{PropagationPolicy: &delProp} - return c.kubernetesSecretClient.Delete(name, delOps) + delOps := metav1.DeleteOptions{PropagationPolicy: &delProp} + return c.kubernetesSecretClient.Delete(context.Background(), name, delOps) } func (c *RemoteClient) deleteLease(name string) error { @@ -313,8 +316,8 @@ func (c *RemoteClient) deleteLease(name string) error { } delProp := metav1.DeletePropagationBackground - delOps := &metav1.DeleteOptions{PropagationPolicy: &delProp} - return c.kubernetesLeaseClient.Delete(name, delOps) + delOps := metav1.DeleteOptions{PropagationPolicy: &delProp} + return c.kubernetesLeaseClient.Delete(context.Background(), name, delOps) } func (c *RemoteClient) createSecretName() (string, error) { From cf56f423282037698f3087f8d5ad3412bf5b8830 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:23:54 +0100 Subject: [PATCH 352/644] dependencies: upgrading to v0.18.0 of github.com/hashicorp/go-azure-helpers --- go.mod | 16 ++++++++-------- go.sum | 13 +++++++++++++ 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/go.mod b/go.mod index d01ec73db159..32249a6babfa 100644 --- a/go.mod +++ b/go.mod @@ -2,8 +2,8 @@ module github.com/hashicorp/terraform require ( cloud.google.com/go/storage v1.10.0 - github.com/Azure/azure-sdk-for-go v52.5.0+incompatible - github.com/Azure/go-autorest/autorest v0.11.18 + github.com/Azure/azure-sdk-for-go v59.2.0+incompatible + github.com/Azure/go-autorest/autorest v0.11.22 github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25 github.com/agext/levenshtein v1.2.3 github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a @@ -33,7 +33,7 @@ require ( github.com/hashicorp/consul/api v1.9.1 github.com/hashicorp/consul/sdk v0.8.0 github.com/hashicorp/errwrap v1.1.0 - github.com/hashicorp/go-azure-helpers v0.14.0 + github.com/hashicorp/go-azure-helpers v0.18.0 github.com/hashicorp/go-checkpoint v0.5.0 github.com/hashicorp/go-cleanhttp v0.5.2 github.com/hashicorp/go-getter v1.5.9 @@ -81,10 +81,10 @@ require ( github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b github.com/zclconf/go-cty-yaml v1.0.2 go.etcd.io/etcd v0.5.0-alpha.5.0.20210428180535-15715dcf1ace - golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 + golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa golang.org/x/mod v0.4.2 golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d - golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 + golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d golang.org/x/text v0.3.6 @@ -103,8 +103,8 @@ require ( require ( cloud.google.com/go v0.79.0 // indirect github.com/Azure/go-autorest v14.2.0+incompatible // indirect - github.com/Azure/go-autorest/autorest/adal v0.9.13 // indirect - github.com/Azure/go-autorest/autorest/azure/cli v0.4.2 // indirect + github.com/Azure/go-autorest/autorest/adal v0.9.17 // indirect + github.com/Azure/go-autorest/autorest/azure/cli v0.4.4 // indirect github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect github.com/Azure/go-autorest/autorest/to v0.4.0 // indirect github.com/Azure/go-autorest/autorest/validation v0.3.1 // indirect @@ -158,7 +158,7 @@ require ( github.com/kr/pty v1.1.5 // indirect github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/mattn/go-colorable v0.1.6 // indirect - github.com/mitchellh/go-testing-interface v1.0.0 // indirect + github.com/mitchellh/go-testing-interface v1.0.4 // indirect github.com/mitchellh/iochan v1.0.0 // indirect github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.1 // indirect diff --git a/go.sum b/go.sum index c429b3bb967e..145a217deae8 100644 --- a/go.sum +++ b/go.sum @@ -42,6 +42,7 @@ github.com/Azure/azure-sdk-for-go v47.1.0+incompatible/go.mod h1:9XXNKU+eRnpl9mo github.com/Azure/azure-sdk-for-go v51.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/azure-sdk-for-go v52.5.0+incompatible h1:/NLBWHCnIHtZyLPc1P7WIqi4Te4CC23kIQyK3Ep/7lA= github.com/Azure/azure-sdk-for-go v52.5.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= +github.com/Azure/azure-sdk-for-go v59.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs= github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= github.com/Azure/go-autorest/autorest v0.11.3/go.mod h1:JFgpikqFJ/MleTTxwepExTKnFUKKszPS8UavbQYUMuw= @@ -49,13 +50,17 @@ github.com/Azure/go-autorest/autorest v0.11.10/go.mod h1:eipySxLmqSyC5s5k1CLupqe github.com/Azure/go-autorest/autorest v0.11.12/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= github.com/Azure/go-autorest/autorest v0.11.18 h1:90Y4srNYrwOtAgVo3ndrQkTYn6kf1Eg/AjTFJ8Is2aM= github.com/Azure/go-autorest/autorest v0.11.18/go.mod h1:dSiJPy22c3u0OtOKDNttNgqpNFY/GeWa7GH/Pz56QRA= +github.com/Azure/go-autorest/autorest v0.11.22/go.mod h1:BAWYUWGPEtKPzjVkp0Q6an0MJcJDsoh5Z1BFAEFs4Xs= github.com/Azure/go-autorest/autorest/adal v0.9.0/go.mod h1:/c022QCutn2P7uY+/oQWWNcK9YU+MH96NgK+jErpbcg= github.com/Azure/go-autorest/autorest/adal v0.9.5/go.mod h1:B7KF7jKIeC9Mct5spmyCB/A8CG/sEz1vwIRGv/bbw7A= github.com/Azure/go-autorest/autorest/adal v0.9.13 h1:Mp5hbtOePIzM8pJVRa3YLrWWmZtoxRXqUEzCfJt3+/Q= github.com/Azure/go-autorest/autorest/adal v0.9.13/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= +github.com/Azure/go-autorest/autorest/adal v0.9.14/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= +github.com/Azure/go-autorest/autorest/adal v0.9.17/go.mod h1:XVVeme+LZwABT8K5Lc3hA4nAe8LDBVle26gTrguhhPQ= github.com/Azure/go-autorest/autorest/azure/cli v0.4.0/go.mod h1:JljT387FplPzBA31vUcvsetLKF3pec5bdAxjVU4kI2s= github.com/Azure/go-autorest/autorest/azure/cli v0.4.2 h1:dMOmEJfkLKW/7JsokJqkyoYSgmR08hi9KrhjZb+JALY= github.com/Azure/go-autorest/autorest/azure/cli v0.4.2/go.mod h1:7qkJkT+j6b+hIpzMOwPChJhTqS8VbsqqgULzMNRugoM= +github.com/Azure/go-autorest/autorest/azure/cli v0.4.4/go.mod h1:yAQ2b6eP/CmLPnmLvxtT1ALIY3OR1oFcCqVBi8vHiTc= github.com/Azure/go-autorest/autorest/date v0.3.0 h1:7gUk1U5M/CQbp9WoqinNzJar+8KY+LPI6wiWrP/myHw= github.com/Azure/go-autorest/autorest/date v0.3.0/go.mod h1:BI0uouVdmngYNUzGWeSYnokU+TrmwEsOqdt8Y6sso74= github.com/Azure/go-autorest/autorest/mocks v0.4.0/go.mod h1:LTp+uSrOhSkaKrUy935gNZuuIPPVsHlr9DSOxSayd+k= @@ -233,6 +238,7 @@ github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c= github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I= +github.com/golang-jwt/jwt/v4 v4.0.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20160516000752-02826c3e7903/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= @@ -343,6 +349,8 @@ github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brv github.com/hashicorp/go-azure-helpers v0.12.0/go.mod h1:Zc3v4DNeX6PDdy7NljlYpnrdac1++qNW0I4U+ofGwpg= github.com/hashicorp/go-azure-helpers v0.14.0 h1:CdC2QqxK/Vk32YS5XMKXHjnpbtNIUCUv/PoSVQHx5jY= github.com/hashicorp/go-azure-helpers v0.14.0/go.mod h1:kR7+sTDEb9TOp/O80ss1UEJg1t4/BHLD/U8wHLS4BGQ= +github.com/hashicorp/go-azure-helpers v0.18.0 h1:hh+lFaURcQ0R12Pj0Ybn+dj6mTHU+I+ep/CAmXiYEvw= +github.com/hashicorp/go-azure-helpers v0.18.0/go.mod h1:lZo52hYeyEoo4qpUUruaEec13bFyu8ldjX2zTFzVzss= github.com/hashicorp/go-checkpoint v0.5.0 h1:MFYpPZCnQqQTE18jFwSII6eUQrD/oxMFp3mlgcqk5mU= github.com/hashicorp/go-checkpoint v0.5.0/go.mod h1:7nfLNL10NsxqO4iWuW6tWW0HjZuDrwkBuEQsVcpCOgg= github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= @@ -512,6 +520,7 @@ github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb/go.mod h1: github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-testing-interface v1.0.0 h1:fzU/JVNcaqHQEcVFAKeR41fkiLdIPrefOvVG1VZ96U0= github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= +github.com/mitchellh/go-testing-interface v1.0.4/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0= @@ -699,6 +708,8 @@ golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPh golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI= golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -795,6 +806,8 @@ golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99/go.mod h1:KelEdhl1UZF7XfJ golang.org/x/oauth2 v0.0.0-20210220000619-9bb904979d93/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 h1:duBc5zuJsmJXYOVVE/6PxejI+N3AaCqKjtsoLn1Je5Q= golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c h1:pkQiBZBvdos9qq4wBAHqlzuZHEXo07pqV06ef90u1WI= +golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= From 5133d30b71dc63f1dc1cb42309f5b50222461184 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:26:23 +0100 Subject: [PATCH 353/644] internal/backend/remote-state/azure: code changes for go-azure-helpers v0.18.0 --- .../backend/remote-state/azure/arm_client.go | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/internal/backend/remote-state/azure/arm_client.go b/internal/backend/remote-state/azure/arm_client.go index 4d03c3718db4..d99ef217a16a 100644 --- a/internal/backend/remote-state/azure/arm_client.go +++ b/internal/backend/remote-state/azure/arm_client.go @@ -96,13 +96,13 @@ func buildArmClient(ctx context.Context, config BackendConfig) (*ArmClient, erro } sender := sender.BuildSender("backend/remote-state/azure") - auth, err := armConfig.GetAuthorizationToken(sender, oauthConfig, env.TokenAudience) + auth, err := armConfig.GetADALToken(ctx, sender, oauthConfig, env.TokenAudience) if err != nil { return nil, err } if config.UseAzureADAuthentication { - storageAuth, err := armConfig.GetAuthorizationToken(sender, oauthConfig, env.ResourceIdentifiers.Storage) + storageAuth, err := armConfig.GetADALToken(ctx, sender, oauthConfig, env.ResourceIdentifiers.Storage) if err != nil { return nil, err } @@ -120,18 +120,6 @@ func buildArmClient(ctx context.Context, config BackendConfig) (*ArmClient, erro return &client, nil } -func buildArmEnvironment(config BackendConfig) (*azure.Environment, error) { - // TODO: can we remove this? - // https://github.com/hashicorp/terraform/issues/27156 - if config.CustomResourceManagerEndpoint != "" { - log.Printf("[DEBUG] Loading Environment from Endpoint %q", config.CustomResourceManagerEndpoint) - return authentication.LoadEnvironmentFromUrl(config.CustomResourceManagerEndpoint) - } - - log.Printf("[DEBUG] Loading Environment %q", config.Environment) - return authentication.DetermineEnvironment(config.Environment) -} - func (c ArmClient) getBlobClient(ctx context.Context) (*blobs.Client, error) { if c.sasToken != "" { log.Printf("[DEBUG] Building the Blob Client from a SAS Token") From 0272249f470616509c88ecaec7635f286f41e67a Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:27:55 +0100 Subject: [PATCH 354/644] go mod vendor/go mod tidy --- go.mod | 2 ++ go.sum | 13 +++++++++++++ 2 files changed, 15 insertions(+) diff --git a/go.mod b/go.mod index 32249a6babfa..f1bbba8126e8 100644 --- a/go.mod +++ b/go.mod @@ -134,6 +134,7 @@ require ( github.com/go-logr/logr v0.4.0 // indirect github.com/gofrs/uuid v3.3.0+incompatible // indirect github.com/gogo/protobuf v1.3.2 // indirect + github.com/golang-jwt/jwt/v4 v4.1.0 // indirect github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect github.com/google/go-querystring v1.1.0 // indirect github.com/google/gofuzz v1.1.0 // indirect @@ -156,6 +157,7 @@ require ( github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect github.com/kr/pty v1.1.5 // indirect + github.com/manicminer/hamilton v0.35.0 // indirect github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/mattn/go-colorable v0.1.6 // indirect github.com/mitchellh/go-testing-interface v1.0.4 // indirect diff --git a/go.sum b/go.sum index 145a217deae8..dc9672566d6c 100644 --- a/go.sum +++ b/go.sum @@ -42,6 +42,7 @@ github.com/Azure/azure-sdk-for-go v47.1.0+incompatible/go.mod h1:9XXNKU+eRnpl9mo github.com/Azure/azure-sdk-for-go v51.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/azure-sdk-for-go v52.5.0+incompatible h1:/NLBWHCnIHtZyLPc1P7WIqi4Te4CC23kIQyK3Ep/7lA= github.com/Azure/azure-sdk-for-go v52.5.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= +github.com/Azure/azure-sdk-for-go v59.2.0+incompatible h1:mbxiZy1K820hQ+dI+YIO/+a0wQDYqOu18BAGe4lXjVk= github.com/Azure/azure-sdk-for-go v59.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs= github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= @@ -50,16 +51,20 @@ github.com/Azure/go-autorest/autorest v0.11.10/go.mod h1:eipySxLmqSyC5s5k1CLupqe github.com/Azure/go-autorest/autorest v0.11.12/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= github.com/Azure/go-autorest/autorest v0.11.18 h1:90Y4srNYrwOtAgVo3ndrQkTYn6kf1Eg/AjTFJ8Is2aM= github.com/Azure/go-autorest/autorest v0.11.18/go.mod h1:dSiJPy22c3u0OtOKDNttNgqpNFY/GeWa7GH/Pz56QRA= +github.com/Azure/go-autorest/autorest v0.11.21/go.mod h1:Do/yuMSW/13ayUkcVREpsMHGG+MvV81uzSCFgYPj4tM= +github.com/Azure/go-autorest/autorest v0.11.22 h1:bXiQwDjrRmBQOE67bwlvUKAC1EU1yZTPQ38c+bstZws= github.com/Azure/go-autorest/autorest v0.11.22/go.mod h1:BAWYUWGPEtKPzjVkp0Q6an0MJcJDsoh5Z1BFAEFs4Xs= github.com/Azure/go-autorest/autorest/adal v0.9.0/go.mod h1:/c022QCutn2P7uY+/oQWWNcK9YU+MH96NgK+jErpbcg= github.com/Azure/go-autorest/autorest/adal v0.9.5/go.mod h1:B7KF7jKIeC9Mct5spmyCB/A8CG/sEz1vwIRGv/bbw7A= github.com/Azure/go-autorest/autorest/adal v0.9.13 h1:Mp5hbtOePIzM8pJVRa3YLrWWmZtoxRXqUEzCfJt3+/Q= github.com/Azure/go-autorest/autorest/adal v0.9.13/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= github.com/Azure/go-autorest/autorest/adal v0.9.14/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= +github.com/Azure/go-autorest/autorest/adal v0.9.17 h1:esOPl2dhcz9P3jqBSJ8tPGEj2EqzPPT6zfyuloiogKY= github.com/Azure/go-autorest/autorest/adal v0.9.17/go.mod h1:XVVeme+LZwABT8K5Lc3hA4nAe8LDBVle26gTrguhhPQ= github.com/Azure/go-autorest/autorest/azure/cli v0.4.0/go.mod h1:JljT387FplPzBA31vUcvsetLKF3pec5bdAxjVU4kI2s= github.com/Azure/go-autorest/autorest/azure/cli v0.4.2 h1:dMOmEJfkLKW/7JsokJqkyoYSgmR08hi9KrhjZb+JALY= github.com/Azure/go-autorest/autorest/azure/cli v0.4.2/go.mod h1:7qkJkT+j6b+hIpzMOwPChJhTqS8VbsqqgULzMNRugoM= +github.com/Azure/go-autorest/autorest/azure/cli v0.4.4 h1:iuooz5cZL6VRcO7DVSFYxRcouqn6bFVE/e77Wts50Zk= github.com/Azure/go-autorest/autorest/azure/cli v0.4.4/go.mod h1:yAQ2b6eP/CmLPnmLvxtT1ALIY3OR1oFcCqVBi8vHiTc= github.com/Azure/go-autorest/autorest/date v0.3.0 h1:7gUk1U5M/CQbp9WoqinNzJar+8KY+LPI6wiWrP/myHw= github.com/Azure/go-autorest/autorest/date v0.3.0/go.mod h1:BI0uouVdmngYNUzGWeSYnokU+TrmwEsOqdt8Y6sso74= @@ -239,6 +244,8 @@ github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69 github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c= github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I= github.com/golang-jwt/jwt/v4 v4.0.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg= +github.com/golang-jwt/jwt/v4 v4.1.0 h1:XUgk2Ex5veyVFVeLm0xhusUTQybEbexJXrvPNOKkSY0= +github.com/golang-jwt/jwt/v4 v4.1.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20160516000752-02826c3e7903/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= @@ -479,6 +486,8 @@ github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 h1:wnfcqULT+N github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82/go.mod h1:y54tfGmO3NKssKveTEFFzH8C/akrSOy/iW9qEAUDV84= github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= +github.com/manicminer/hamilton v0.35.0 h1:K72BHXLhlO+H/evI5iburLDfVe19bDaXO+hEIQEVkdg= +github.com/manicminer/hamilton v0.35.0/go.mod h1:IOYn2Dc9SUiZ7Ryw6c8Ay795vPPMnrCZe3MktS447dc= github.com/masterzen/simplexml v0.0.0-20160608183007-4572e39b1ab9/go.mod h1:kCEbxUJlNDEBNbdQMkPSp6yaKcRXVI6f4ddk8Riv4bc= github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 h1:2ZKn+w/BJeL43sCxI2jhPLRv73oVVOjEKZjKkflyqxg= github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786/go.mod h1:kCEbxUJlNDEBNbdQMkPSp6yaKcRXVI6f4ddk8Riv4bc= @@ -520,6 +529,7 @@ github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb/go.mod h1: github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-testing-interface v1.0.0 h1:fzU/JVNcaqHQEcVFAKeR41fkiLdIPrefOvVG1VZ96U0= github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= +github.com/mitchellh/go-testing-interface v1.0.4 h1:ZU1VNC02qyufSZsjjs7+khruk2fKvbQ3TwRV/IBCeFA= github.com/mitchellh/go-testing-interface v1.0.4/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= @@ -706,9 +716,11 @@ golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPh golang.org/x/crypto v0.0.0-20201002170205-7f63de1d35b0/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= +golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8= golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI= golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa h1:idItI2DDfCokpg0N51B2VtiLdJ4vAuXC9fnCb2gACo4= golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= @@ -791,6 +803,7 @@ golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210224082022-3d97a244fca7/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= From 27a34d6c2c85c63e68f8985263695956fb1c5159 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:28:47 +0100 Subject: [PATCH 355/644] internal/backend/remote-state/azure: updating the link to the client secret This redirects to the registry so we should point there directly --- internal/backend/remote-state/azure/arm_client.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/backend/remote-state/azure/arm_client.go b/internal/backend/remote-state/azure/arm_client.go index d99ef217a16a..c517c44bf7a0 100644 --- a/internal/backend/remote-state/azure/arm_client.go +++ b/internal/backend/remote-state/azure/arm_client.go @@ -67,7 +67,7 @@ func buildArmClient(ctx context.Context, config BackendConfig) (*ArmClient, erro CustomResourceManagerEndpoint: config.CustomResourceManagerEndpoint, MetadataHost: config.MetadataHost, Environment: config.Environment, - ClientSecretDocsLink: "https://www.terraform.io/docs/providers/azurerm/guides/service_principal_client_secret.html", + ClientSecretDocsLink: "https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/service_principal_client_secret", // Service Principal (Client Certificate) ClientCertPassword: config.ClientCertificatePassword, From 9f710558cef50599935a5e499743947dfd55e26b Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:40:21 +0100 Subject: [PATCH 356/644] internal/backend/remote-state/azure: adding a feature-toggle to use MSAL --- .../backend/remote-state/azure/arm_client.go | 38 ++++++++++++++++--- .../backend/remote-state/azure/backend.go | 8 ++++ 2 files changed, 41 insertions(+), 5 deletions(-) diff --git a/internal/backend/remote-state/azure/arm_client.go b/internal/backend/remote-state/azure/arm_client.go index c517c44bf7a0..85bbc4c5fae6 100644 --- a/internal/backend/remote-state/azure/arm_client.go +++ b/internal/backend/remote-state/azure/arm_client.go @@ -7,6 +7,8 @@ import ( "os" "time" + "github.com/manicminer/hamilton/environments" + "github.com/tombuildsstuff/giovanni/storage/2018-11-09/blob/blobs" "github.com/tombuildsstuff/giovanni/storage/2018-11-09/blob/containers" @@ -84,6 +86,7 @@ func buildArmClient(ctx context.Context, config BackendConfig) (*ArmClient, erro SupportsClientCertAuth: true, SupportsClientSecretAuth: true, SupportsManagedServiceIdentity: config.UseMsi, + UseMicrosoftGraph: config.UseMicrosoftGraph, } armConfig, err := builder.Build() if err != nil { @@ -95,18 +98,43 @@ func buildArmClient(ctx context.Context, config BackendConfig) (*ArmClient, erro return nil, err } - sender := sender.BuildSender("backend/remote-state/azure") - auth, err := armConfig.GetADALToken(ctx, sender, oauthConfig, env.TokenAudience) + hamiltonEnv, err := environments.EnvironmentFromString(config.Environment) if err != nil { return nil, err } - if config.UseAzureADAuthentication { - storageAuth, err := armConfig.GetADALToken(ctx, sender, oauthConfig, env.ResourceIdentifiers.Storage) + sender := sender.BuildSender("backend/remote-state/azure") + var auth autorest.Authorizer + if builder.UseMicrosoftGraph { + log.Printf("[DEBUG] Obtaining a MSAL / Microsoft Graph token for Resource Manager..") + auth, err = armConfig.GetMSALToken(ctx, hamiltonEnv.ResourceManager, sender, oauthConfig, env.TokenAudience) if err != nil { return nil, err } - client.azureAdStorageAuth = &storageAuth + } else { + log.Printf("[DEBUG] Obtaining a ADAL / Azure Active Directory Graph token for Resource Manager..") + auth, err = armConfig.GetADALToken(ctx, sender, oauthConfig, env.TokenAudience) + if err != nil { + return nil, err + } + } + + if config.UseAzureADAuthentication { + if builder.UseMicrosoftGraph { + log.Printf("[DEBUG] Obtaining a MSAL / Microsoft Graph token for Storage..") + storageAuth, err := armConfig.GetMSALToken(ctx, hamiltonEnv.Storage, sender, oauthConfig, env.ResourceIdentifiers.Storage) + if err != nil { + return nil, err + } + client.azureAdStorageAuth = &storageAuth + } else { + log.Printf("[DEBUG] Obtaining a ADAL / Azure Active Directory Graph token for Storage..") + storageAuth, err := armConfig.GetADALToken(ctx, sender, oauthConfig, env.ResourceIdentifiers.Storage) + if err != nil { + return nil, err + } + client.azureAdStorageAuth = &storageAuth + } } accountsClient := armStorage.NewAccountsClientWithBaseURI(env.ResourceManagerEndpoint, armConfig.SubscriptionID) diff --git a/internal/backend/remote-state/azure/backend.go b/internal/backend/remote-state/azure/backend.go index 889b1f7f825b..682e35427ed8 100644 --- a/internal/backend/remote-state/azure/backend.go +++ b/internal/backend/remote-state/azure/backend.go @@ -142,6 +142,12 @@ func New() backend.Backend { Description: "Should Terraform use AzureAD Authentication to access the Blob?", DefaultFunc: schema.EnvDefaultFunc("ARM_USE_AZUREAD", false), }, + "use_microsoft_graph": { + Type: schema.TypeBool, + Optional: true, + Description: "Should Terraform obtain an auth token from Microsoft Graph rather than Azure Active Directory?", + DefaultFunc: schema.EnvDefaultFunc("ARM_USE_MSGRAPH", false), + }, }, } @@ -181,6 +187,7 @@ type BackendConfig struct { TenantID string UseMsi bool UseAzureADAuthentication bool + UseMicrosoftGraph bool } func (b *Backend) configure(ctx context.Context) error { @@ -212,6 +219,7 @@ func (b *Backend) configure(ctx context.Context) error { TenantID: data.Get("tenant_id").(string), UseMsi: data.Get("use_msi").(bool), UseAzureADAuthentication: data.Get("use_azuread_auth").(bool), + UseMicrosoftGraph: data.Get("use_microsoft_graph").(bool), } armClient, err := buildArmClient(context.TODO(), config) From bf6c7c03815fd9c4b75ad36ec916dbe4237ad256 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:42:53 +0100 Subject: [PATCH 357/644] go mod tidy/vendor: hamilton is now directly used --- go.mod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/go.mod b/go.mod index f1bbba8126e8..0c462797b1fa 100644 --- a/go.mod +++ b/go.mod @@ -53,6 +53,7 @@ require ( github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 github.com/lib/pq v1.10.3 github.com/lusis/go-artifactory v0.0.0-20160115162124-7e4ce345df82 + github.com/manicminer/hamilton v0.35.0 github.com/masterzen/winrm v0.0.0-20200615185753-c42b5136ff88 github.com/mattn/go-isatty v0.0.12 github.com/mattn/go-shellwords v1.0.4 @@ -157,7 +158,6 @@ require ( github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect github.com/kr/pty v1.1.5 // indirect - github.com/manicminer/hamilton v0.35.0 // indirect github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/mattn/go-colorable v0.1.6 // indirect github.com/mitchellh/go-testing-interface v1.0.4 // indirect From a2cad7d579adb57ea14990779160134e69834082 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:43:39 +0100 Subject: [PATCH 358/644] internal/backend/remote-state/azure: prefixing the existing tests with ADAL --- .../remote-state/azure/backend_test.go | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/internal/backend/remote-state/azure/backend_test.go b/internal/backend/remote-state/azure/backend_test.go index 8ae20a31aeac..51dbc6106a60 100644 --- a/internal/backend/remote-state/azure/backend_test.go +++ b/internal/backend/remote-state/azure/backend_test.go @@ -65,8 +65,8 @@ func TestBackendAccessKeyBasic(t *testing.T) { backend.TestBackendStates(t, b) } -func TestBackendManagedServiceIdentityBasic(t *testing.T) { - testAccAzureBackendRunningInAzure(t) +func TestBackendSASTokenBasic(t *testing.T) { + testAccAzureBackend(t) rs := acctest.RandString(4) res := testResourceNames(rs, "testState") armClient := buildTestClient(t, res) @@ -78,14 +78,16 @@ func TestBackendManagedServiceIdentityBasic(t *testing.T) { t.Fatalf("Error creating Test Resources: %q", err) } + sasToken, err := buildSasToken(res.storageAccountName, res.storageAccountAccessKey) + if err != nil { + t.Fatalf("Error building SAS Token: %+v", err) + } + b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ "storage_account_name": res.storageAccountName, "container_name": res.storageContainerName, "key": res.storageKeyName, - "resource_group_name": res.resourceGroup, - "use_msi": true, - "subscription_id": os.Getenv("ARM_SUBSCRIPTION_ID"), - "tenant_id": os.Getenv("ARM_TENANT_ID"), + "sas_token": *sasToken, "environment": os.Getenv("ARM_ENVIRONMENT"), "endpoint": os.Getenv("ARM_ENDPOINT"), })).(*Backend) @@ -93,48 +95,44 @@ func TestBackendManagedServiceIdentityBasic(t *testing.T) { backend.TestBackendStates(t, b) } -func TestBackendSASTokenBasic(t *testing.T) { +func TestBackendADALAzureADAuthBasic(t *testing.T) { testAccAzureBackend(t) rs := acctest.RandString(4) res := testResourceNames(rs, "testState") + res.useAzureADAuth = true armClient := buildTestClient(t, res) ctx := context.TODO() err := armClient.buildTestResources(ctx, &res) defer armClient.destroyTestResources(ctx, res) if err != nil { + armClient.destroyTestResources(ctx, res) t.Fatalf("Error creating Test Resources: %q", err) } - sasToken, err := buildSasToken(res.storageAccountName, res.storageAccountAccessKey) - if err != nil { - t.Fatalf("Error building SAS Token: %+v", err) - } - b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ "storage_account_name": res.storageAccountName, "container_name": res.storageContainerName, "key": res.storageKeyName, - "sas_token": *sasToken, + "access_key": res.storageAccountAccessKey, "environment": os.Getenv("ARM_ENVIRONMENT"), "endpoint": os.Getenv("ARM_ENDPOINT"), + "use_azuread_auth": true, })).(*Backend) backend.TestBackendStates(t, b) } -func TestBackendAzureADAuthBasic(t *testing.T) { - testAccAzureBackend(t) +func TestBackendADALManagedServiceIdentityBasic(t *testing.T) { + testAccAzureBackendRunningInAzure(t) rs := acctest.RandString(4) res := testResourceNames(rs, "testState") - res.useAzureADAuth = true armClient := buildTestClient(t, res) ctx := context.TODO() err := armClient.buildTestResources(ctx, &res) defer armClient.destroyTestResources(ctx, res) if err != nil { - armClient.destroyTestResources(ctx, res) t.Fatalf("Error creating Test Resources: %q", err) } @@ -142,16 +140,18 @@ func TestBackendAzureADAuthBasic(t *testing.T) { "storage_account_name": res.storageAccountName, "container_name": res.storageContainerName, "key": res.storageKeyName, - "access_key": res.storageAccountAccessKey, + "resource_group_name": res.resourceGroup, + "use_msi": true, + "subscription_id": os.Getenv("ARM_SUBSCRIPTION_ID"), + "tenant_id": os.Getenv("ARM_TENANT_ID"), "environment": os.Getenv("ARM_ENVIRONMENT"), "endpoint": os.Getenv("ARM_ENDPOINT"), - "use_azuread_auth": true, })).(*Backend) backend.TestBackendStates(t, b) } -func TestBackendServicePrincipalClientCertificateBasic(t *testing.T) { +func TestBackendADALServicePrincipalClientCertificateBasic(t *testing.T) { testAccAzureBackend(t) clientCertPassword := os.Getenv("ARM_CLIENT_CERTIFICATE_PASSWORD") @@ -188,7 +188,7 @@ func TestBackendServicePrincipalClientCertificateBasic(t *testing.T) { backend.TestBackendStates(t, b) } -func TestBackendServicePrincipalClientSecretBasic(t *testing.T) { +func TestBackendADALServicePrincipalClientSecretBasic(t *testing.T) { testAccAzureBackend(t) rs := acctest.RandString(4) res := testResourceNames(rs, "testState") @@ -217,7 +217,7 @@ func TestBackendServicePrincipalClientSecretBasic(t *testing.T) { backend.TestBackendStates(t, b) } -func TestBackendServicePrincipalClientSecretCustomEndpoint(t *testing.T) { +func TestBackendADALServicePrincipalClientSecretCustomEndpoint(t *testing.T) { testAccAzureBackend(t) // this is only applicable for Azure Stack. From ffe9a41468e9299fa1218a271fdc5c1129a5a3ed Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:45:21 +0100 Subject: [PATCH 359/644] internal/backend/remote-state/azure: adding tests covering MSAL --- .../remote-state/azure/backend_test.go | 163 ++++++++++++++++++ .../remote-state/azure/helpers_test.go | 2 + 2 files changed, 165 insertions(+) diff --git a/internal/backend/remote-state/azure/backend_test.go b/internal/backend/remote-state/azure/backend_test.go index 51dbc6106a60..2411ddedb9b6 100644 --- a/internal/backend/remote-state/azure/backend_test.go +++ b/internal/backend/remote-state/azure/backend_test.go @@ -253,6 +253,169 @@ func TestBackendADALServicePrincipalClientSecretCustomEndpoint(t *testing.T) { backend.TestBackendStates(t, b) } +func TestBackendMSALAzureADAuthBasic(t *testing.T) { + testAccAzureBackend(t) + rs := acctest.RandString(4) + res := testResourceNames(rs, "testState") + res.useAzureADAuth = true + res.useMicrosoftGraph = true + armClient := buildTestClient(t, res) + + ctx := context.TODO() + err := armClient.buildTestResources(ctx, &res) + defer armClient.destroyTestResources(ctx, res) + if err != nil { + armClient.destroyTestResources(ctx, res) + t.Fatalf("Error creating Test Resources: %q", err) + } + + b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ + "storage_account_name": res.storageAccountName, + "container_name": res.storageContainerName, + "key": res.storageKeyName, + "access_key": res.storageAccountAccessKey, + "environment": os.Getenv("ARM_ENVIRONMENT"), + "endpoint": os.Getenv("ARM_ENDPOINT"), + "use_azuread_auth": true, + })).(*Backend) + + backend.TestBackendStates(t, b) +} + +func TestBackendMSALManagedServiceIdentityBasic(t *testing.T) { + testAccAzureBackendRunningInAzure(t) + rs := acctest.RandString(4) + res := testResourceNames(rs, "testState") + res.useMicrosoftGraph = true + armClient := buildTestClient(t, res) + + ctx := context.TODO() + err := armClient.buildTestResources(ctx, &res) + defer armClient.destroyTestResources(ctx, res) + if err != nil { + t.Fatalf("Error creating Test Resources: %q", err) + } + + b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ + "storage_account_name": res.storageAccountName, + "container_name": res.storageContainerName, + "key": res.storageKeyName, + "resource_group_name": res.resourceGroup, + "use_msi": true, + "subscription_id": os.Getenv("ARM_SUBSCRIPTION_ID"), + "tenant_id": os.Getenv("ARM_TENANT_ID"), + "environment": os.Getenv("ARM_ENVIRONMENT"), + "endpoint": os.Getenv("ARM_ENDPOINT"), + })).(*Backend) + + backend.TestBackendStates(t, b) +} + +func TestBackendMSALServicePrincipalClientCertificateBasic(t *testing.T) { + testAccAzureBackend(t) + + clientCertPassword := os.Getenv("ARM_CLIENT_CERTIFICATE_PASSWORD") + clientCertPath := os.Getenv("ARM_CLIENT_CERTIFICATE_PATH") + if clientCertPath == "" { + t.Skip("Skipping since `ARM_CLIENT_CERTIFICATE_PATH` is not specified!") + } + + rs := acctest.RandString(4) + res := testResourceNames(rs, "testState") + res.useMicrosoftGraph = true + armClient := buildTestClient(t, res) + + ctx := context.TODO() + err := armClient.buildTestResources(ctx, &res) + defer armClient.destroyTestResources(ctx, res) + if err != nil { + t.Fatalf("Error creating Test Resources: %q", err) + } + + b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ + "storage_account_name": res.storageAccountName, + "container_name": res.storageContainerName, + "key": res.storageKeyName, + "resource_group_name": res.resourceGroup, + "subscription_id": os.Getenv("ARM_SUBSCRIPTION_ID"), + "tenant_id": os.Getenv("ARM_TENANT_ID"), + "client_id": os.Getenv("ARM_CLIENT_ID"), + "client_certificate_password": clientCertPassword, + "client_certificate_path": clientCertPath, + "environment": os.Getenv("ARM_ENVIRONMENT"), + "endpoint": os.Getenv("ARM_ENDPOINT"), + })).(*Backend) + + backend.TestBackendStates(t, b) +} + +func TestBackendMSALServicePrincipalClientSecretBasic(t *testing.T) { + testAccAzureBackend(t) + rs := acctest.RandString(4) + res := testResourceNames(rs, "testState") + res.useMicrosoftGraph = true + armClient := buildTestClient(t, res) + + ctx := context.TODO() + err := armClient.buildTestResources(ctx, &res) + defer armClient.destroyTestResources(ctx, res) + if err != nil { + t.Fatalf("Error creating Test Resources: %q", err) + } + + b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ + "storage_account_name": res.storageAccountName, + "container_name": res.storageContainerName, + "key": res.storageKeyName, + "resource_group_name": res.resourceGroup, + "subscription_id": os.Getenv("ARM_SUBSCRIPTION_ID"), + "tenant_id": os.Getenv("ARM_TENANT_ID"), + "client_id": os.Getenv("ARM_CLIENT_ID"), + "client_secret": os.Getenv("ARM_CLIENT_SECRET"), + "environment": os.Getenv("ARM_ENVIRONMENT"), + "endpoint": os.Getenv("ARM_ENDPOINT"), + })).(*Backend) + + backend.TestBackendStates(t, b) +} + +func TestBackendMSALServicePrincipalClientSecretCustomEndpoint(t *testing.T) { + testAccAzureBackend(t) + + // this is only applicable for Azure Stack. + endpoint := os.Getenv("ARM_ENDPOINT") + if endpoint == "" { + t.Skip("Skipping as ARM_ENDPOINT isn't configured") + } + + rs := acctest.RandString(4) + res := testResourceNames(rs, "testState") + res.useMicrosoftGraph = true + armClient := buildTestClient(t, res) + + ctx := context.TODO() + err := armClient.buildTestResources(ctx, &res) + defer armClient.destroyTestResources(ctx, res) + if err != nil { + t.Fatalf("Error creating Test Resources: %q", err) + } + + b := backend.TestBackendConfig(t, New(), backend.TestWrapConfig(map[string]interface{}{ + "storage_account_name": res.storageAccountName, + "container_name": res.storageContainerName, + "key": res.storageKeyName, + "resource_group_name": res.resourceGroup, + "subscription_id": os.Getenv("ARM_SUBSCRIPTION_ID"), + "tenant_id": os.Getenv("ARM_TENANT_ID"), + "client_id": os.Getenv("ARM_CLIENT_ID"), + "client_secret": os.Getenv("ARM_CLIENT_SECRET"), + "environment": os.Getenv("ARM_ENVIRONMENT"), + "endpoint": endpoint, + })).(*Backend) + + backend.TestBackendStates(t, b) +} + func TestBackendAccessKeyLocked(t *testing.T) { testAccAzureBackend(t) rs := acctest.RandString(4) diff --git a/internal/backend/remote-state/azure/helpers_test.go b/internal/backend/remote-state/azure/helpers_test.go index c1d2ffd41f0d..dadb9aa26047 100644 --- a/internal/backend/remote-state/azure/helpers_test.go +++ b/internal/backend/remote-state/azure/helpers_test.go @@ -84,6 +84,7 @@ func buildTestClient(t *testing.T, res resourceNames) *ArmClient { StorageAccountName: res.storageAccountName, UseMsi: msiEnabled, UseAzureADAuthentication: res.useAzureADAuth, + UseMicrosoftGraph: res.useMicrosoftGraph, }) if err != nil { t.Fatalf("Failed to build ArmClient: %+v", err) @@ -127,6 +128,7 @@ type resourceNames struct { storageKeyName string storageAccountAccessKey string useAzureADAuth bool + useMicrosoftGraph bool } func testResourceNames(rString string, keyName string) resourceNames { From 1d9f7f19fc98144bfeb3e521d1a9c0578c9a9a58 Mon Sep 17 00:00:00 2001 From: tombuildsstuff Date: Wed, 17 Nov 2021 18:54:02 +0100 Subject: [PATCH 360/644] website: updating the docs for the Azure backend to highlight the `use_microsoft_graph` field --- .../settings/backends/azurerm.html.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index 36e95a2f8162..a5cf04e279c8 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -13,6 +13,8 @@ description: |- Stores the state as a Blob with the given Key within the Blob Container within [the Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction). This backend also supports state locking and consistency checking via native capabilities of Azure Blob Storage. +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. + ## Example Configuration When authenticating using the Azure CLI or a Service Principal (either with a Client Certificate or a Client Secret): @@ -219,11 +221,15 @@ When authenticating using the Managed Service Identity (MSI) - the following fie * `resource_group_name` - (Required) The Name of the Resource Group in which the Storage Account exists. +* `msi_endpoint` - (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. This can also be sourced from the `ARM_MSI_ENDPOINT` environment variable. +* * `subscription_id` - (Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the `ARM_SUBSCRIPTION_ID` environment variable. * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. -* `msi_endpoint` - (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. This can also be sourced from the `ARM_MSI_ENDPOINT` environment variable. +* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. + +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. * `use_msi` - (Optional) Should Managed Service Identity authentication be used? This can also be sourced from the `ARM_USE_MSI` environment variable. @@ -247,6 +253,10 @@ When authenticating using AzureAD Authentication - the following fields are also -> **Note:** When using AzureAD for Authentication to Storage you also need to ensure the `Storage Blob Data Owner` role is assigned. +* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. + +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. + --- When authenticating using a Service Principal with a Client Certificate - the following fields are also supported: @@ -263,6 +273,10 @@ When authenticating using a Service Principal with a Client Certificate - the fo * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. +* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. + +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. + --- When authenticating using a Service Principal with a Client Secret - the following fields are also supported: @@ -276,3 +290,7 @@ When authenticating using a Service Principal with a Client Secret - the followi * `subscription_id` - (Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the `ARM_SUBSCRIPTION_ID` environment variable. * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. + +* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. + +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. From a1c7c0dfa47098866a5945aeb3d2dd2f7037a4ca Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Wed, 17 Nov 2021 20:24:22 +0100 Subject: [PATCH 361/644] Update internal/backend/remote-state/azure/backend.go Co-authored-by: Tom Bamford --- internal/backend/remote-state/azure/backend.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/backend/remote-state/azure/backend.go b/internal/backend/remote-state/azure/backend.go index 682e35427ed8..e126da47d3e7 100644 --- a/internal/backend/remote-state/azure/backend.go +++ b/internal/backend/remote-state/azure/backend.go @@ -145,7 +145,7 @@ func New() backend.Backend { "use_microsoft_graph": { Type: schema.TypeBool, Optional: true, - Description: "Should Terraform obtain an auth token from Microsoft Graph rather than Azure Active Directory?", + Description: "Should Terraform obtain an MSAL auth token and use Microsoft Graph rather than Azure Active Directory?", DefaultFunc: schema.EnvDefaultFunc("ARM_USE_MSGRAPH", false), }, }, From d5404b6f33eb95e80127fb7ae0c6b344d9ecf760 Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Wed, 17 Nov 2021 20:26:58 +0100 Subject: [PATCH 362/644] Update website/docs/language/settings/backends/azurerm.html.md Co-authored-by: Tom Bamford --- website/docs/language/settings/backends/azurerm.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index a5cf04e279c8..caebdf891401 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -227,7 +227,7 @@ When authenticating using the Managed Service Identity (MSI) - the following fie * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. -* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. +* `use_microsoft_graph` - (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? Defaults to `false`. -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. From d81e93cc7d98686b02a90ea4afdc2c4ed645e826 Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Wed, 17 Nov 2021 20:27:05 +0100 Subject: [PATCH 363/644] Update website/docs/language/settings/backends/azurerm.html.md Co-authored-by: Tom Bamford --- website/docs/language/settings/backends/azurerm.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index caebdf891401..aac3f0b71113 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -253,7 +253,7 @@ When authenticating using AzureAD Authentication - the following fields are also -> **Note:** When using AzureAD for Authentication to Storage you also need to ensure the `Storage Blob Data Owner` role is assigned. -* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. +* `use_microsoft_graph` - (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? Defaults to `false`. -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. From b3645068efa13ad94fa0cff413876349aecfca0b Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Wed, 17 Nov 2021 20:27:35 +0100 Subject: [PATCH 364/644] Update website/docs/language/settings/backends/azurerm.html.md Co-authored-by: Tom Bamford --- website/docs/language/settings/backends/azurerm.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index aac3f0b71113..715423699ce4 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -273,7 +273,7 @@ When authenticating using a Service Principal with a Client Certificate - the fo * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. -* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. +* `use_microsoft_graph` - (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? Defaults to `false`. -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. From 890cabe4426f55a66aada0f035316636ff820d24 Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Wed, 17 Nov 2021 20:27:39 +0100 Subject: [PATCH 365/644] Update website/docs/language/settings/backends/azurerm.html.md Co-authored-by: Tom Bamford --- website/docs/language/settings/backends/azurerm.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index 715423699ce4..9179a555101a 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -291,6 +291,6 @@ When authenticating using a Service Principal with a Client Secret - the followi * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. -* `use_microsoft_graph` - (Optional) Should Microsoft Graph (MSAL) be used instead of Azure Active Directory Graph (ADAL) for authentication? Defaults to `false`. +* `use_microsoft_graph` - (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? Defaults to `false`. -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. From e5172fea9540846ab32b8e9448b1390ac89655b9 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 12 Nov 2021 15:17:27 -0800 Subject: [PATCH 366/644] cloud: DetectConfigChangeType helper This aims to encapsulate the somewhat-weird logic we currently use to distinguish between the various "terraform init" situations involving Terraform Cloud mode, in the hope of making codepaths that branch based on this slightly easier to read. This isn't yet used, but uses of it will follow in subsequent commits. --- internal/cloud/configchangemode_string.go | 37 ++++++ internal/cloud/migration.go | 106 +++++++++++++++++ internal/cloud/migration_test.go | 138 ++++++++++++++++++++++ 3 files changed, 281 insertions(+) create mode 100644 internal/cloud/configchangemode_string.go create mode 100644 internal/cloud/migration.go create mode 100644 internal/cloud/migration_test.go diff --git a/internal/cloud/configchangemode_string.go b/internal/cloud/configchangemode_string.go new file mode 100644 index 000000000000..b60692be15f1 --- /dev/null +++ b/internal/cloud/configchangemode_string.go @@ -0,0 +1,37 @@ +// Code generated by "stringer -type ConfigChangeMode"; DO NOT EDIT. + +package cloud + +import "strconv" + +func _() { + // An "invalid array index" compiler error signifies that the constant values have changed. + // Re-run the stringer command to generate them again. + var x [1]struct{} + _ = x[ConfigMigrationIn-8600] + _ = x[ConfigMigrationOut-8598] + _ = x[ConfigChangeInPlace-8635] + _ = x[ConfigChangeIrrelevant-129335] +} + +const ( + _ConfigChangeMode_name_0 = "ConfigMigrationOut" + _ConfigChangeMode_name_1 = "ConfigMigrationIn" + _ConfigChangeMode_name_2 = "ConfigChangeInPlace" + _ConfigChangeMode_name_3 = "ConfigChangeIrrelevant" +) + +func (i ConfigChangeMode) String() string { + switch { + case i == 8598: + return _ConfigChangeMode_name_0 + case i == 8600: + return _ConfigChangeMode_name_1 + case i == 8635: + return _ConfigChangeMode_name_2 + case i == 129335: + return _ConfigChangeMode_name_3 + default: + return "ConfigChangeMode(" + strconv.FormatInt(int64(i), 10) + ")" + } +} diff --git a/internal/cloud/migration.go b/internal/cloud/migration.go new file mode 100644 index 000000000000..069d1b28ebfd --- /dev/null +++ b/internal/cloud/migration.go @@ -0,0 +1,106 @@ +package cloud + +import ( + "github.com/hashicorp/terraform/internal/configs" + legacy "github.com/hashicorp/terraform/internal/legacy/terraform" +) + +// Most of the logic for migrating into and out of "cloud mode" actually lives +// in the "command" package as part of the general backend init mechanisms, +// but we have some cloud-specific helper functionality here. + +// ConfigChangeMode is a rough way to think about different situations that +// our backend change and state migration codepaths need to distinguish in +// the context of Cloud integration mode. +type ConfigChangeMode rune + +//go:generate go run golang.org/x/tools/cmd/stringer -type ConfigChangeMode + +const ( + // ConfigMigrationIn represents when the configuration calls for using + // Cloud mode but the working directory state disagrees. + ConfigMigrationIn ConfigChangeMode = '↘' + + // ConfigMigrationOut represents when the working directory state calls + // for using Cloud mode but the working directory state disagrees. + ConfigMigrationOut ConfigChangeMode = '↖' + + // ConfigChangeInPlace represents when both the working directory state + // and the config call for using Cloud mode, and so there might be + // (but won't necessarily be) cloud settings changing, but we don't + // need to do any actual migration. + ConfigChangeInPlace ConfigChangeMode = '↻' + + // ConfigChangeIrrelevant represents when the config and working directory + // state disagree but neither calls for using Cloud mode, and so the + // Cloud integration is not involved in dealing with this. + ConfigChangeIrrelevant ConfigChangeMode = '🤷' +) + +// DetectConfigChangeType encapsulates the fiddly logic for deciding what kind +// of Cloud configuration change we seem to be making, based on the existing +// working directory state (if any) and the current configuration. +// +// This is a pretty specialized sort of thing focused on finicky details of +// the way we currently model working directory settings and config, so its +// signature probably won't survive any non-trivial refactoring of how +// the CLI layer thinks about backends/state storage. +func DetectConfigChangeType(wdState *legacy.BackendState, config *configs.Backend, haveLocalStates bool) ConfigChangeMode { + // Although externally the cloud integration isn't really a "backend", + // internally we treat it a bit like one just to preserve all of our + // existing interfaces that assume backends. "cloud" is the placeholder + // name we use for it, even though that isn't a backend that's actually + // available for selection in the usual way. + wdIsCloud := wdState != nil && wdState.Type == "cloud" + configIsCloud := config != nil && config.Type == "cloud" + + // "uninit" here means that the working directory is totally uninitialized, + // even taking into account the possibility of implied local state that + // therefore doesn't typically require explicit "terraform init". + wdIsUninit := wdState == nil && !haveLocalStates + + switch { + case configIsCloud: + switch { + case wdIsCloud || wdIsUninit: + // If config has cloud and the working directory is completely + // uninitialized then we assume we're doing the initial activation + // of this working directory for an already-migrated-to-cloud + // remote state. + return ConfigChangeInPlace + default: + // Otherwise, we seem to be migrating into cloud mode from a backend. + return ConfigMigrationIn + } + default: + switch { + case wdIsCloud: + // If working directory is already cloud but config isn't, we're + // migrating away from cloud to a backend. + return ConfigMigrationOut + default: + // Otherwise, this situation seems to be something unrelated to + // cloud mode and so outside of our scope here. + return ConfigChangeIrrelevant + } + } + +} + +func (m ConfigChangeMode) InvolvesCloud() bool { + switch m { + case ConfigMigrationIn, ConfigMigrationOut, ConfigChangeInPlace: + return true + default: + return false + } +} + +func (m ConfigChangeMode) IsCloudMigration() bool { + switch m { + case ConfigMigrationIn, ConfigMigrationOut: + return true + default: + return false + } +} diff --git a/internal/cloud/migration_test.go b/internal/cloud/migration_test.go new file mode 100644 index 000000000000..f1ae0f48eca5 --- /dev/null +++ b/internal/cloud/migration_test.go @@ -0,0 +1,138 @@ +package cloud + +import ( + "testing" + + "github.com/hashicorp/terraform/internal/configs" + legacy "github.com/hashicorp/terraform/internal/legacy/terraform" +) + +func TestDetectConfigChangeType(t *testing.T) { + tests := map[string]struct { + stateType string + configType string + localStates bool + want ConfigChangeMode + wantInvolvesCloud bool + wantIsCloudMigration bool + }{ + "init cloud": { + ``, `cloud`, false, + ConfigChangeInPlace, + true, false, + }, + "reinit cloud": { + `cloud`, `cloud`, false, + ConfigChangeInPlace, + true, false, + }, + "migrate default local to cloud with existing local state": { + ``, `cloud`, true, + ConfigMigrationIn, + true, true, + }, + "migrate local to cloud": { + `local`, `cloud`, false, + ConfigMigrationIn, + true, true, + }, + "migrate remote to cloud": { + `local`, `cloud`, false, + ConfigMigrationIn, + true, true, + }, + "migrate cloud to local": { + `cloud`, `local`, false, + ConfigMigrationOut, + true, true, + }, + "migrate cloud to remote": { + `cloud`, `remote`, false, + ConfigMigrationOut, + true, true, + }, + "migrate cloud to default local": { + `cloud`, ``, false, + ConfigMigrationOut, + true, true, + }, + + // Various other cases can potentially be valid (decided by the + // Terraform CLI layer) but are irrelevant for Cloud mode purposes. + "init default local": { + ``, ``, false, + ConfigChangeIrrelevant, + false, false, + }, + "init default local with existing local state": { + ``, ``, true, + ConfigChangeIrrelevant, + false, false, + }, + "init remote backend": { + ``, `remote`, false, + ConfigChangeIrrelevant, + false, false, + }, + "init remote backend with existing local state": { + ``, `remote`, true, + ConfigChangeIrrelevant, + false, false, + }, + "reinit remote backend": { + `remote`, `remote`, false, + ConfigChangeIrrelevant, + false, false, + }, + "migrate local to remote backend": { + `local`, `remote`, false, + ConfigChangeIrrelevant, + false, false, + }, + "migrate remote to default local": { + `remote`, ``, false, + ConfigChangeIrrelevant, + false, false, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + var state *legacy.BackendState + var config *configs.Backend + if test.stateType != "" { + state = &legacy.BackendState{ + Type: test.stateType, + // everything else is irrelevant for our purposes here + } + } + if test.configType != "" { + config = &configs.Backend{ + Type: test.configType, + // everything else is irrelevant for our purposes here + } + } + got := DetectConfigChangeType(state, config, test.localStates) + + if got != test.want { + t.Errorf( + "wrong result\nstate type: %s\nconfig type: %s\nlocal states: %t\n\ngot: %s\nwant: %s", + test.stateType, test.configType, test.localStates, + got, test.want, + ) + } + if got, want := got.InvolvesCloud(), test.wantInvolvesCloud; got != want { + t.Errorf( + "wrong InvolvesCloud result\ngot: %t\nwant: %t", + got, want, + ) + } + if got, want := got.IsCloudMigration(), test.wantIsCloudMigration; got != want { + t.Errorf( + "wrong IsCloudMigration result\ngot: %t\nwant: %t", + got, want, + ) + } + }) + } +} From c28b57b4d6290d4da9108d625e03d9a75d3b29cc Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 16 Nov 2021 15:03:43 -0800 Subject: [PATCH 367/644] cloud/e2e: Additional context for failing to find expected output This just gives a little extra information to work with when trying to understand why a test failed. It doesn't change what any of the tests are actually trying to test. --- internal/cloud/e2e/apply_auto_approve_test.go | 4 +-- .../e2e/backend_apply_before_init_test.go | 4 +-- .../cloud/e2e/init_with_empty_tags_test.go | 4 +-- .../e2e/migrate_state_multi_to_tfc_test.go | 9 ++--- ...igrate_state_remote_backend_to_tfc_test.go | 36 +++++++++---------- .../e2e/migrate_state_single_to_tfc_test.go | 4 +-- .../e2e/migrate_state_tfc_to_other_test.go | 4 +-- .../e2e/migrate_state_tfc_to_tfc_test.go | 8 ++--- internal/cloud/e2e/run_variables_test.go | 4 +-- 9 files changed, 39 insertions(+), 38 deletions(-) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 9f086c88ea38..2a0e23682d95 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -212,9 +212,9 @@ func Test_terraform_apply_autoApprove(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index a5c9fee5a6ad..93c9483749f7 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -107,9 +107,9 @@ func Test_backend_apply_before_init(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/init_with_empty_tags_test.go b/internal/cloud/e2e/init_with_empty_tags_test.go index ca9743d5e4c3..6c03b10524ab 100644 --- a/internal/cloud/e2e/init_with_empty_tags_test.go +++ b/internal/cloud/e2e/init_with_empty_tags_test.go @@ -74,9 +74,9 @@ func Test_init_with_empty_tags(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index b325e218bf12..7a8128af0ddc 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -266,9 +266,10 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -554,9 +555,9 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 76ef0a34c771..4370c4e49a72 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -97,9 +97,9 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -216,9 +216,9 @@ func Test_migrate_remote_backend_name_to_tfc_same_name(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -343,9 +343,9 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -476,9 +476,9 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -600,9 +600,9 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -616,9 +616,9 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t // output that matches the input. if lenInputOutput-1 >= i { output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) + got, err := exp.ExpectString(output) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", output, err, got) } } } @@ -754,9 +754,9 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_multi_workspace(t * } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -879,9 +879,9 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_single_workspace(t } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -1035,9 +1035,9 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_multi_workspace(t * } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index becd882b9316..7dbaad2b704e 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -161,9 +161,9 @@ func Test_migrate_single_to_tfc(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index d99b5504e751..fc76dfd4270e 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -82,9 +82,9 @@ func Test_migrate_tfc_to_other(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 9419745e0f85..9265ced6d160 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -252,9 +252,9 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -512,9 +512,9 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatal(err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } diff --git a/internal/cloud/e2e/run_variables_test.go b/internal/cloud/e2e/run_variables_test.go index 07c6d869c641..77cc1514d2dc 100644 --- a/internal/cloud/e2e/run_variables_test.go +++ b/internal/cloud/e2e/run_variables_test.go @@ -116,9 +116,9 @@ func Test_cloud_run_variables(t *testing.T) { } if tfCmd.expectedCmdOutput != "" { - _, err := exp.ExpectString(tfCmd.expectedCmdOutput) + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatalf(`Expected command output "%s", but got %v `, tfCmd.expectedCmdOutput, err) + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } From bac59d2480569cfa213e7248ea2718a4024e70ad Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 12 Nov 2021 17:07:10 -0800 Subject: [PATCH 368/644] command/init: Be explicit that some options are not relevant for Cloud There are a few command line options for "terraform init" which are only relevant when working with traditional backends, with the Cloud integration previously just mostly ignoring them, or sometimes misbehaving slightly due to them creating an unreasonable situation. Now we'll catch these and return explicit errors, in order to be clear that these options are not needed nor supported in Cloud mode. --- .../e2e/backend_apply_before_init_test.go | 4 +- .../e2e/migrate_state_multi_to_tfc_test.go | 11 +- ...igrate_state_remote_backend_to_tfc_test.go | 26 +- .../e2e/migrate_state_single_to_tfc_test.go | 8 +- .../e2e/migrate_state_tfc_to_other_test.go | 2 +- .../e2e/migrate_state_tfc_to_tfc_test.go | 16 +- internal/command/init.go | 13 +- internal/command/init_test.go | 314 ++++++++++++++++++ internal/command/meta_backend.go | 268 ++++++++++----- internal/command/meta_backend_migrate.go | 42 ++- .../init-cloud-simple/init-cloud-simple.tf | 13 + 11 files changed, 594 insertions(+), 123 deletions(-) create mode 100644 internal/command/testdata/init-cloud-simple/init-cloud-simple.tf diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index 93c9483749f7..d8985264974d 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -28,7 +28,7 @@ func Test_backend_apply_before_init(t *testing.T) { commands: []tfCommand{ { command: []string{"apply"}, - expectedCmdOutput: `Terraform Cloud initialization required, please run "terraform init"`, + expectedCmdOutput: `Terraform Cloud initialization required: please run "terraform init"`, expectError: true, }, }, @@ -62,7 +62,7 @@ func Test_backend_apply_before_init(t *testing.T) { commands: []tfCommand{ { command: []string{"apply"}, - expectedCmdOutput: `Terraform Cloud initialization required, please run "terraform init"`, + expectedCmdOutput: `Terraform Cloud initialization required: please run "terraform init"`, expectError: true, }, }, diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index 7a8128af0ddc..f06c1597456d 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -60,7 +60,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ @@ -127,7 +127,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ @@ -195,7 +195,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ @@ -268,7 +268,6 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { if tfCmd.expectedCmdOutput != "" { got, err := exp.ExpectString(tfCmd.expectedCmdOutput) if err != nil { - t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) } } @@ -365,7 +364,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"dev", "1", "app-*"}, postInputOutput: []string{ @@ -470,7 +469,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"dev", "1", "app-*"}, postInputOutput: []string{ diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 4370c4e49a72..8da4e0f6e593 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -42,8 +42,8 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + command: []string{"init", "-ignore-remote-version"}, + expectedCmdOutput: `Should Terraform migrate your existing state?`, userInput: []string{"yes"}, postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, @@ -163,7 +163,7 @@ func Test_migrate_remote_backend_name_to_tfc_same_name(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, }, { @@ -283,8 +283,8 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + command: []string{"init", "-ignore-remote-version"}, + expectedCmdOutput: `Should Terraform migrate your existing state?`, userInput: []string{"yes"}, postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, @@ -414,11 +414,11 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, + `Should Terraform migrate your existing state?`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -544,8 +544,8 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + command: []string{"init", "-ignore-remote-version"}, + expectedCmdOutput: `Should Terraform migrate your existing state?`, userInput: []string{"yes"}, postInputOutput: []string{ `Terraform Cloud has been successfully initialized!`}, @@ -679,7 +679,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_multi_workspace(t * }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes"}, postInputOutput: []string{ @@ -822,11 +822,11 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_single_workspace(t }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"cloud-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, + `Should Terraform migrate your existing state?`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -961,7 +961,7 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_multi_workspace(t * }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Do you wish to proceed?`, userInput: []string{"yes"}, postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index 7dbaad2b704e..5bcf9c669737 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -47,8 +47,8 @@ func Test_migrate_single_to_tfc(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + command: []string{"init"}, + expectedCmdOutput: `Should Terraform migrate your existing state?`, userInput: []string{"yes"}, postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, @@ -96,11 +96,11 @@ func Test_migrate_single_to_tfc(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"new-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, + `Should Terraform migrate your existing state?`, `Terraform Cloud has been successfully initialized!`}, }, { diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index fc76dfd4270e..9de96ab01593 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -36,7 +36,7 @@ func Test_migrate_tfc_to_other(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Migrating state from Terraform Cloud to another backend is not yet implemented.`, expectError: true, }, diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 9265ced6d160..125c58d06dd8 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -69,8 +69,8 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy existing state to Terraform Cloud?`, + command: []string{"init", "-ignore-remote-version"}, + expectedCmdOutput: `Should Terraform migrate your existing state?`, userInput: []string{"yes"}, postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, @@ -127,11 +127,11 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, userInput: []string{"new-workspace", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, + `Should Terraform migrate your existing state?`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -196,7 +196,7 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state"}, + command: []string{"init"}, expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, expectError: true, userInput: []string{"new-workspace", "yes"}, @@ -367,11 +367,11 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, userInput: []string{"yes", "yes"}, postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, + `Should Terraform migrate your existing state?`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -446,7 +446,7 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-migrate-state", "-ignore-remote-version"}, + command: []string{"init", "-ignore-remote-version"}, expectedCmdOutput: `Would you like to rename your workspaces?`, userInput: []string{"1", "new-*", "1"}, postInputOutput: []string{ diff --git a/internal/command/init.go b/internal/command/init.go index a44fba3dce11..ac411e891d5a 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -213,7 +213,7 @@ func (c *InitCommand) Run(args []string) int { switch { case config.Module.CloudConfig != nil: - be, backendOutput, backendDiags := c.initCloud(config.Module) + be, backendOutput, backendDiags := c.initCloud(config.Module, flagConfigExtra) diags = diags.Append(backendDiags) if backendDiags.HasErrors() { c.showDiagnostics(diags) @@ -366,9 +366,18 @@ func (c *InitCommand) getModules(path string, earlyRoot *tfconfig.Module, upgrad return true, installAbort, diags } -func (c *InitCommand) initCloud(root *configs.Module) (be backend.Backend, output bool, diags tfdiags.Diagnostics) { +func (c *InitCommand) initCloud(root *configs.Module, extraConfig rawFlags) (be backend.Backend, output bool, diags tfdiags.Diagnostics) { c.Ui.Output(c.Colorize().Color("\n[reset][bold]Initializing Terraform Cloud...")) + if len(extraConfig.AllItems()) != 0 { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid command-line option", + "The -backend-config=... command line option is only for state backends, and is not applicable to Terraform Cloud-based configurations.\n\nTo change the set of workspaces associated with this configuration, edit the Cloud configuration block in the root module.", + )) + return nil, true, diags + } + backendConfig := root.CloudConfig.ToBackendConfig() opts := &BackendOpts{ diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 8a728bd99bbc..90da036f016d 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -17,6 +17,7 @@ import ( "github.com/mitchellh/cli" "github.com/zclconf/go-cty/cty" + "github.com/hashicorp/go-version" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" @@ -24,6 +25,7 @@ import ( "github.com/hashicorp/terraform/internal/getproviders" "github.com/hashicorp/terraform/internal/providercache" "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/states/statefile" "github.com/hashicorp/terraform/internal/states/statemgr" ) @@ -937,6 +939,318 @@ func TestInit_backendReinitConfigToExtra(t *testing.T) { } } +func TestInit_backendCloudInvalidOptions(t *testing.T) { + // There are various "terraform init" options that are only for + // traditional backends and not applicable to Terraform Cloud mode. + // For those, we want to return an explicit error rather than + // just silently ignoring them, so that users will be aware that + // Cloud mode has more of an expected "happy path" than the + // less-vertically-integrated backends do, and to avoid these + // unapplicable options becoming compatibility constraints for + // future evolution of Cloud mode. + + // We use the same starting fixture for all of these tests, but some + // of them will customize it a bit as part of their work. + setupTempDir := func(t *testing.T) func() { + t.Helper() + td := tempDir(t) + testCopyDir(t, testFixturePath("init-cloud-simple"), td) + unChdir := testChdir(t, td) + return func() { + unChdir() + os.RemoveAll(td) + } + } + + // Some of the tests need a non-empty placeholder state file to work + // with. + fakeState := states.BuildState(func(cb *states.SyncState) { + // Having a root module output value should be enough for this + // state file to be considered "non-empty" and thus a candidate + // for migration. + cb.SetOutputValue( + addrs.OutputValue{Name: "a"}.Absolute(addrs.RootModuleInstance), + cty.True, + false, + ) + }) + fakeStateFile := &statefile.File{ + Lineage: "boop", + Serial: 4, + TerraformVersion: version.Must(version.NewVersion("1.0.0")), + State: fakeState, + } + var fakeStateBuf bytes.Buffer + err := statefile.WriteForTest(fakeStateFile, &fakeStateBuf) + if err != nil { + t.Error(err) + } + fakeStateBytes := fakeStateBuf.Bytes() + + t.Run("-backend-config", func(t *testing.T) { + defer setupTempDir(t)() + + // We have -backend-config as a pragmatic way to dynamically set + // certain settings of backends that tend to vary depending on + // where Terraform is running, such as AWS authentication profiles + // that are naturally local only to the machine where Terraform is + // running. Those needs don't apply to Terraform Cloud, because + // the remote workspace encapsulates all of the details of how + // operations and state work in that case, and so the Cloud + // configuration is only about which workspaces we'll be working + // with. + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-backend-config=anything"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -backend-config=... command line option is only for state backends, and +is not applicable to Terraform Cloud-based configurations. + +To change the set of workspaces associated with this configuration, edit the +Cloud configuration block in the root module. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + t.Run("-reconfigure", func(t *testing.T) { + defer setupTempDir(t)() + + // The -reconfigure option was originally imagined as a way to force + // skipping state migration when migrating between backends, but it + // has a historical flaw that it doesn't work properly when the + // initial situation is the implicit local backend with a state file + // present. The Terraform Cloud migration path has some additional + // steps to take care of more details automatically, and so + // -reconfigure doesn't really make sense in that context, particularly + // with its design bug with the handling of the implicit local backend. + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-reconfigure"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -reconfigure option is for in-place reconfiguration of state backends +only, and is not needed when changing Terraform Cloud settings. + +When using Terraform Cloud, initialization automatically activates any new +Cloud configuration settings. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + t.Run("-reconfigure when migrating in", func(t *testing.T) { + defer setupTempDir(t)() + + // We have a slightly different error message for the case where we + // seem to be trying to migrate to Terraform Cloud with existing + // state or explicit backend already present. + + if err := os.WriteFile("terraform.tfstate", fakeStateBytes, 0644); err != nil { + t.Fatal(err) + } + + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-reconfigure"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -reconfigure option is unsupported when migrating to Terraform Cloud, +because activating Terraform Cloud involves some additional steps. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + t.Run("-migrate-state", func(t *testing.T) { + defer setupTempDir(t)() + + // In Cloud mode, migrating in or out always proposes migrating state + // and changing configuration while staying in cloud mode never migrates + // state, so this special option isn't relevant. + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-migrate-state"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -migrate-state option is for migration between state backends only, and +is not applicable when using Terraform Cloud. + +State storage is handled automatically by Terraform Cloud and so the state +storage location is not configurable. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + t.Run("-migrate-state when migrating in", func(t *testing.T) { + defer setupTempDir(t)() + + // We have a slightly different error message for the case where we + // seem to be trying to migrate to Terraform Cloud with existing + // state or explicit backend already present. + + if err := os.WriteFile("terraform.tfstate", fakeStateBytes, 0644); err != nil { + t.Fatal(err) + } + + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-migrate-state"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -migrate-state option is for migration between state backends only, and +is not applicable when using Terraform Cloud. + +Terraform Cloud migration has additional steps, configured by interactive +prompts. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + t.Run("-force-copy", func(t *testing.T) { + defer setupTempDir(t)() + + // In Cloud mode, migrating in or out always proposes migrating state + // and changing configuration while staying in cloud mode never migrates + // state, so this special option isn't relevant. + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-force-copy"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -force-copy option is for migration between state backends only, and is +not applicable when using Terraform Cloud. + +State storage is handled automatically by Terraform Cloud and so the state +storage location is not configurable. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + t.Run("-force-copy when migrating in", func(t *testing.T) { + defer setupTempDir(t)() + + // We have a slightly different error message for the case where we + // seem to be trying to migrate to Terraform Cloud with existing + // state or explicit backend already present. + + if err := os.WriteFile("terraform.tfstate", fakeStateBytes, 0644); err != nil { + t.Fatal(err) + } + + ui := cli.NewMockUi() + view, _ := testView(t) + c := &InitCommand{ + Meta: Meta{ + Ui: ui, + View: view, + }, + } + args := []string{"-force-copy"} + if code := c.Run(args); code == 0 { + t.Fatalf("unexpected success\n%s", ui.OutputWriter.String()) + } + + gotStderr := ui.ErrorWriter.String() + wantStderr := ` +Error: Invalid command-line option + +The -force-copy option is for migration between state backends only, and is +not applicable when using Terraform Cloud. + +Terraform Cloud migration has additional steps, configured by interactive +prompts. + +` + if diff := cmp.Diff(wantStderr, gotStderr); diff != "" { + t.Errorf("wrong error output\n%s", diff) + } + }) + +} + // make sure inputFalse stops execution on migrate func TestInit_inputFalse(t *testing.T) { td := tempDir(t) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 5c7f04df3242..ecc00a386304 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -603,7 +603,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di return nil, diags } - if !m.migrateState { + if s.Backend.Type != "cloud" && !m.migrateState { diags = diags.Append(migrateOrReconfigDiag) return nil, diags } @@ -618,7 +618,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di initReason := "Initial configuration of Terraform Cloud" diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Terraform Cloud initialization required, please run \"terraform init\"", + "Terraform Cloud initialization required: please run \"terraform init\"", fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), )) } else { @@ -670,39 +670,51 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di } log.Printf("[TRACE] Meta.Backend: backend configuration has changed (from type %q to type %q)", s.Backend.Type, c.Type) + cloudMode := cloud.DetectConfigChangeType(s.Backend, c, false) + initReason := "" - switch { - case c.Type == "cloud": - initReason = fmt.Sprintf("Backend configuration changed from %q to Terraform Cloud", s.Backend.Type) - case s.Backend.Type != c.Type: - initReason = fmt.Sprintf("Backend configuration changed from %q to %q", s.Backend.Type, c.Type) + switch cloudMode { + case cloud.ConfigMigrationIn: + initReason = fmt.Sprintf("Changed from backend %q to Terraform Cloud", s.Backend.Type) + case cloud.ConfigMigrationOut: + initReason = fmt.Sprintf("Changed from Terraform Cloud to backend %q", s.Backend.Type) + case cloud.ConfigChangeInPlace: + initReason = "Terraform Cloud configuration has changed" default: - initReason = fmt.Sprintf("Backend configuration changed for %q", c.Type) + switch { + case s.Backend.Type != c.Type: + initReason = fmt.Sprintf("Backend type changed from %q to %q", s.Backend.Type, c.Type) + default: + initReason = fmt.Sprintf("Configuration changed for backend %q", c.Type) + } } if !opts.Init { - if c.Type == "cloud" { + switch cloudMode { + case cloud.ConfigChangeInPlace: diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Terraform Cloud initialization required, please run \"terraform init\"", + "Terraform Cloud initialization required: please run \"terraform init\"", fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), )) - } else { + case cloud.ConfigMigrationIn: diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, - "Backend initialization required, please run \"terraform init\"", + "Terraform Cloud initialization required: please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInitCloudMigration), initReason), + )) + default: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Backend initialization required: please run \"terraform init\"", fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), )) } return nil, diags } - if !m.migrateState { - if c.Type == "cloud" { - diags = diags.Append(migrateOrReconfigDiagCloud) - } else { - diags = diags.Append(migrateOrReconfigDiag) - } + if !cloudMode.InvolvesCloud() && !m.migrateState { + diags = diags.Append(migrateOrReconfigDiag) return nil, diags } @@ -809,20 +821,29 @@ func (m *Meta) backendFromState() (backend.Backend, tfdiags.Diagnostics) { // Unconfiguring a backend (moving from backend => local). func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.LocalState, output bool) (backend.Backend, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + s := sMgr.State() + cloudMode := cloud.DetectConfigChangeType(s.Backend, c, false) + diags = diags.Append(m.assertSupportedCloudInitOptions(cloudMode)) + if diags.HasErrors() { + return nil, diags + } + // Get the backend type for output backendType := s.Backend.Type - if s.Backend.Type == "cloud" { - m.Ui.Output(strings.TrimSpace(outputBackendMigrateLocalFromCloud)) + if cloudMode == cloud.ConfigMigrationOut { + m.Ui.Output("Migrating from Terraform Cloud to local state.") } else { m.Ui.Output(fmt.Sprintf(strings.TrimSpace(outputBackendMigrateLocal), s.Backend.Type)) } // Grab a purely local backend to get the local state if it exists - localB, diags := m.Backend(&BackendOpts{ForceLocal: true, Init: true}) - if diags.HasErrors() { + localB, moreDiags := m.Backend(&BackendOpts{ForceLocal: true, Init: true}) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { return nil, diags } @@ -868,11 +889,7 @@ func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.Local // Configuring a backend for the first time. func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) { - // Get the backend - b, configVal, diags := m.backendInitFromConfig(c) - if diags.HasErrors() { - return nil, diags - } + var diags tfdiags.Diagnostics // Grab a purely local backend to get the local state if it exists localB, localBDiags := m.Backend(&BackendOpts{ForceLocal: true, Init: true}) @@ -908,6 +925,19 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local } } + cloudMode := cloud.DetectConfigChangeType(nil, c, len(localStates) > 0) + diags = diags.Append(m.assertSupportedCloudInitOptions(cloudMode)) + if diags.HasErrors() { + return nil, diags + } + + // Get the backend + b, configVal, moreDiags := m.backendInitFromConfig(c) + diags = diags.Append(moreDiags) + if diags.HasErrors() { + return nil, diags + } + if len(localStates) > 0 { // Perform the migration err = m.backendMigrateState(&backendMigrateOpts{ @@ -999,60 +1029,82 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local // Changing a previously saved backend. func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clistate.LocalState, output bool) (backend.Backend, tfdiags.Diagnostics) { - if output { - // Notify the user - m.Ui.Output(m.Colorize().Color(fmt.Sprintf( - "[reset]%s\n", - strings.TrimSpace(outputBackendReconfigure)))) - } + var diags tfdiags.Diagnostics // Get the old state s := sMgr.State() - // Get the backend - b, configVal, diags := m.backendInitFromConfig(c) + cloudMode := cloud.DetectConfigChangeType(s.Backend, c, false) + diags = diags.Append(m.assertSupportedCloudInitOptions(cloudMode)) if diags.HasErrors() { return nil, diags } - // no need to confuse the user if the backend types are the same - if s.Backend.Type != c.Type { - output := fmt.Sprintf(outputBackendMigrateChange, s.Backend.Type, c.Type) - if c.Type == "cloud" { - output = fmt.Sprintf(outputBackendMigrateChangeCloud, s.Backend.Type) + if output { + // Notify the user + switch cloudMode { + case cloud.ConfigChangeInPlace: + m.Ui.Output("Terraform Cloud configuration has changed.") + case cloud.ConfigMigrationIn: + m.Ui.Output(fmt.Sprintf("Migrating from backend %q to Terraform Cloud.", s.Backend.Type)) + case cloud.ConfigMigrationOut: + m.Ui.Output(fmt.Sprintf("Migrating from Terraform Cloud to backend %q.", c.Type)) + default: + if s.Backend.Type != c.Type { + output := fmt.Sprintf(outputBackendMigrateChange, s.Backend.Type, c.Type) + m.Ui.Output(m.Colorize().Color(fmt.Sprintf( + "[reset]%s\n", + strings.TrimSpace(output)))) + } else { + m.Ui.Output(m.Colorize().Color(fmt.Sprintf( + "[reset]%s\n", + strings.TrimSpace(outputBackendReconfigure)))) + } } - m.Ui.Output(m.Colorize().Color(fmt.Sprintf( - "[reset]%s\n", - strings.TrimSpace(output)))) } - // Grab the existing backend - oldB, oldBDiags := m.savedBackend(sMgr) - diags = diags.Append(oldBDiags) - if oldBDiags.HasErrors() { + // Get the backend + b, configVal, moreDiags := m.backendInitFromConfig(c) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { return nil, diags } - // Perform the migration - err := m.backendMigrateState(&backendMigrateOpts{ - SourceType: s.Backend.Type, - DestinationType: c.Type, - Source: oldB, - Destination: b, - }) - if err != nil { - diags = diags.Append(err) - return nil, diags - } + // If this is a migration into, out of, or irrelevant to Terraform Cloud + // mode then we will do state migration here. Otherwise, we just update + // the working directory initialization directly, because Terraform Cloud + // doesn't have configurable state storage anyway -- we're only changing + // which workspaces are relevant to this configuration, not where their + // state lives. + if cloudMode != cloud.ConfigChangeInPlace { + // Grab the existing backend + oldB, oldBDiags := m.savedBackend(sMgr) + diags = diags.Append(oldBDiags) + if oldBDiags.HasErrors() { + return nil, diags + } - if m.stateLock { - view := views.NewStateLocker(arguments.ViewHuman, m.View) - stateLocker := clistate.NewLocker(m.stateLockTimeout, view) - if err := stateLocker.Lock(sMgr, "backend from plan"); err != nil { - diags = diags.Append(fmt.Errorf("Error locking state: %s", err)) + // Perform the migration + err := m.backendMigrateState(&backendMigrateOpts{ + SourceType: s.Backend.Type, + DestinationType: c.Type, + Source: oldB, + Destination: b, + }) + if err != nil { + diags = diags.Append(err) return nil, diags } - defer stateLocker.Unlock() + + if m.stateLock { + view := views.NewStateLocker(arguments.ViewHuman, m.View) + stateLocker := clistate.NewLocker(m.stateLockTimeout, view) + if err := stateLocker.Lock(sMgr, "backend from plan"); err != nil { + diags = diags.Append(fmt.Errorf("Error locking state: %s", err)) + return nil, diags + } + defer stateLocker.Unlock() + } } configJSON, err := ctyjson.Marshal(configVal, b.ConfigSchema().ImpliedType()) @@ -1293,6 +1345,55 @@ func (m *Meta) remoteVersionCheck(b backend.Backend, workspace string) tfdiags.D return diags } +// assertSupportedCloudInitOptions returns diagnostics with errors if the +// init-related command line options (implied inside the Meta receiver) +// are incompatible with the given cloud configuration change mode. +func (m *Meta) assertSupportedCloudInitOptions(mode cloud.ConfigChangeMode) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + if mode.InvolvesCloud() { + log.Printf("[TRACE] Meta.Backend: Terraform Cloud mode initialization type: %s", mode) + if m.reconfigure { + if mode.IsCloudMigration() { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid command-line option", + "The -reconfigure option is unsupported when migrating to Terraform Cloud, because activating Terraform Cloud involves some additional steps.", + )) + } else { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid command-line option", + "The -reconfigure option is for in-place reconfiguration of state backends only, and is not needed when changing Terraform Cloud settings.\n\nWhen using Terraform Cloud, initialization automatically activates any new Cloud configuration settings.", + )) + } + } + if m.migrateState { + name := "-migrate-state" + if m.forceInitCopy { + // -force copy implies -migrate-state in "terraform init", + // so m.migrateState is forced to true in this case even if + // the user didn't actually specify it. We'll use the other + // name here to avoid being confusing, then. + name = "-force-copy" + } + if mode.IsCloudMigration() { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid command-line option", + fmt.Sprintf("The %s option is for migration between state backends only, and is not applicable when using Terraform Cloud.\n\nTerraform Cloud migration has additional steps, configured by interactive prompts.", name), + )) + } else { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid command-line option", + fmt.Sprintf("The %s option is for migration between state backends only, and is not applicable when using Terraform Cloud.\n\nState storage is handled automatically by Terraform Cloud and so the state storage location is not configurable.", name), + )) + } + } + } + return diags +} + //------------------------------------------------------------------- // Output constants and initialization code //------------------------------------------------------------------- @@ -1376,17 +1477,26 @@ hasn't changed and try again. At this point, no changes to your existing configuration or state have been made. ` +const errBackendInitCloudMigration = ` +Reason: %s. + +Migrating to Terraform Cloud requires reinitialization, to discover which Terraform Cloud workspaces belong to this configuration and to optionally migrate existing state to the corresponding Terraform Cloud workspaces. + +To re-initialize, run: + terraform init + +Terraform has not yet made changes to your existing configuration or state. +` + const errBackendInitCloud = ` -Reason: %s +Reason: %s. -Changes to the Terraform Cloud configuration block require reinitialization. -This allows Terraform to set up the new configuration, copy existing state, etc. -Please run "terraform init" with either the "-reconfigure" or "-migrate-state" -flags to use the current configuration. +Changes to the Terraform Cloud configuration block require reinitialization, to discover any changes to the available workspaces. -If the change reason above is incorrect, please verify your configuration -hasn't changed and try again. At this point, no changes to your existing -configuration or state have been made. +To re-initialize, run: + terraform init + +Terraform has not yet made changes to your existing configuration or state. ` const errBackendWriteSaved = ` @@ -1402,16 +1512,9 @@ const outputBackendMigrateChange = ` Terraform detected that the backend type changed from %q to %q. ` -const outputBackendMigrateChangeCloud = ` -Terraform detected that the backend type changed from %q to Terraform Cloud. -` - const outputBackendMigrateLocal = ` Terraform has detected you're unconfiguring your previously set %q backend. ` -const outputBackendMigrateLocalFromCloud = ` -Terraform has detected you're unconfiguring Terraform Cloud. -` const outputBackendReconfigure = ` [reset][bold]Backend configuration changed![reset] @@ -1444,10 +1547,3 @@ var migrateOrReconfigDiag = tfdiags.Sourceless( "A change in the backend configuration has been detected, which may require migrating existing state.\n\n"+ "If you wish to attempt automatic migration of the state, use \"terraform init -migrate-state\".\n"+ `If you wish to store the current configuration with no changes to the state, use "terraform init -reconfigure".`) - -var migrateOrReconfigDiagCloud = tfdiags.Sourceless( - tfdiags.Error, - "Terraform Cloud configuration changed", - "A change in the Terraform Cloud configuration has been detected, which may require migrating existing state.\n\n"+ - "If you wish to attempt automatic migration of the state, use \"terraform init -migrate-state\".\n"+ - `If you wish to store the current configuration with no changes to the state, use "terraform init -reconfigure".`) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 5fc65ae7dd35..800d45c9a8a5 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -569,10 +569,20 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { opts.sourceWorkspace = currentWorkspace log.Printf("[INFO] backendMigrateTFC: single-to-single migration from source %s to destination %q", opts.sourceWorkspace, opts.destinationWorkspace) - // Run normal single-to-single state migration + // Run normal single-to-single state migration. // This will handle both situations where the new cloud backend // configuration is using a workspace.name strategy or workspace.tags // strategy. + // + // We do prompt first though, because state migration is mandatory + // for moving to Cloud and the user should get an opportunity to + // confirm that first. + if migrate, err := m.promptSingleToCloudSingleStateMigration(opts); err != nil { + return err + } else if !migrate { + return nil //skip migrating but return successfully + } + return m.backendMigrateState_s_s(opts) } @@ -752,6 +762,23 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa return nil } +func (m *Meta) promptSingleToCloudSingleStateMigration(opts *backendMigrateOpts) (bool, error) { + migrate := opts.force + if !migrate { + var err error + migrate, err = m.confirm(&terraform.InputOpts{ + Id: "backend-migrate-state-single-to-cloud-single", + Query: "Do you wish to proceed?", + Description: strings.TrimSpace(tfcInputBackendMigrateStateSingleToCloudSingle), + }) + if err != nil { + return false, fmt.Errorf("Error asking for state migration action: %s", err) + } + } + + return migrate, nil +} + func (m *Meta) promptRemotePrefixToCloudTagsMigration(opts *backendMigrateOpts) error { migrate := opts.force if !migrate { @@ -937,6 +964,19 @@ strategy in your workspace configuration block instead. Enter "yes" to proceed or "no" to cancel. ` +const tfcInputBackendMigrateStateSingleToCloudSingle = ` +As part of migrating to Terraform Cloud, Terraform can optionally copy your +current workspace state to the configured Terraform Cloud workspace. + +Answer "yes" to copy the latest state snapshot to the configured +Terraform Cloud workspace. + +Answer "no" to ignore the existing state and just activate the configured +Terraform Cloud workspace with its existing state, if any. + +Should Terraform migrate your existing state? +` + const tfcInputBackendMigrateRemoteMultiToCloud = ` When migrating from the 'remote' backend to Terraform's native integration with Terraform Cloud, Terraform will automatically create or use existing diff --git a/internal/command/testdata/init-cloud-simple/init-cloud-simple.tf b/internal/command/testdata/init-cloud-simple/init-cloud-simple.tf new file mode 100644 index 000000000000..2493abe6b085 --- /dev/null +++ b/internal/command/testdata/init-cloud-simple/init-cloud-simple.tf @@ -0,0 +1,13 @@ +# This is a simple configuration with Terraform Cloud mode minimally +# activated, but it's suitable only for testing things that we can exercise +# without actually accessing Terraform Cloud, such as checking of invalid +# command-line options to "terraform init". + +terraform { + cloud { + organization = "PLACEHOLDER" + workspaces { + name = "PLACEHOLDER" + } + } +} From 27aa51687ea5d271b2fa68ea61bc52b7cfb09dd5 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 17 Nov 2021 11:53:20 -0600 Subject: [PATCH 369/644] Fix cloud e2e tests for updated migration flow --- ...igrate_state_remote_backend_to_tfc_test.go | 41 +++++++++------ .../e2e/migrate_state_single_to_tfc_test.go | 13 +++-- .../e2e/migrate_state_tfc_to_tfc_test.go | 51 +++++++------------ 3 files changed, 52 insertions(+), 53 deletions(-) diff --git a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go index 8da4e0f6e593..19d98ee6308c 100644 --- a/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_remote_backend_to_tfc_test.go @@ -29,8 +29,8 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { expectedCmdOutput: `Successfully configured the backend "remote"!`, }, { - command: []string{"apply", "-auto-approve"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + expectedCmdOutput: `Apply complete!`, }, }, }, @@ -43,9 +43,11 @@ func Test_migrate_remote_backend_name_to_tfc_name(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Should Terraform migrate your existing state?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + expectedCmdOutput: `Migrating from backend "remote" to Terraform Cloud.`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Should Terraform migrate your existing state?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -164,7 +166,11 @@ func Test_migrate_remote_backend_name_to_tfc_same_name(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, + expectedCmdOutput: `Migrating from backend "remote" to Terraform Cloud.`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Should Terraform migrate your existing state?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -284,9 +290,11 @@ func Test_migrate_remote_backend_name_to_tfc_name_different_org(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Should Terraform migrate your existing state?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + expectedCmdOutput: `Migrating from backend "remote" to Terraform Cloud.`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Should Terraform migrate your existing state?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -415,10 +423,11 @@ func Test_migrate_remote_backend_name_to_tfc_tags(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"cloud-workspace", "yes"}, + expectedCmdOutput: `Migrating from backend "remote" to Terraform Cloud.`, + userInput: []string{"yes", "cloud-workspace", "yes"}, postInputOutput: []string{ `Should Terraform migrate your existing state?`, + `Terraform Cloud requires all workspaces to be given an explicit name.`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -545,9 +554,10 @@ func Test_migrate_remote_backend_prefix_to_tfc_name_strategy_single_workspace(t commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Should Terraform migrate your existing state?`, - userInput: []string{"yes"}, + expectedCmdOutput: `Migrating from backend "remote" to Terraform Cloud.`, + userInput: []string{"yes", "yes"}, postInputOutput: []string{ + `Should Terraform migrate your existing state?`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -823,10 +833,11 @@ func Test_migrate_remote_backend_prefix_to_tfc_tags_strategy_single_workspace(t commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"cloud-workspace", "yes"}, + expectedCmdOutput: `Migrating from backend "remote" to Terraform Cloud.`, + userInput: []string{"yes", "cloud-workspace", "yes"}, postInputOutput: []string{ `Should Terraform migrate your existing state?`, + `Terraform Cloud requires all workspaces to be given an explicit name.`, `Terraform Cloud has been successfully initialized!`}, }, { diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index 5bcf9c669737..4865a780d5fc 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -48,9 +48,11 @@ func Test_migrate_single_to_tfc(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Should Terraform migrate your existing state?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + expectedCmdOutput: `Migrating from backend "local" to Terraform Cloud.`, + userInput: []string{"yes", "yes"}, + postInputOutput: []string{ + `Should Terraform migrate your existing state?`, + `Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "list"}, @@ -97,10 +99,11 @@ func Test_migrate_single_to_tfc(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"new-workspace", "yes"}, + expectedCmdOutput: `Migrating from backend "local" to Terraform Cloud.`, + userInput: []string{"yes", "new-workspace", "yes"}, postInputOutput: []string{ `Should Terraform migrate your existing state?`, + `Terraform Cloud requires all workspaces to be given an explicit name.`, `Terraform Cloud has been successfully initialized!`}, }, { diff --git a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go index 125c58d06dd8..f12dca41865e 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_tfc_test.go @@ -69,10 +69,8 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { }, commands: []tfCommand{ { - command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Should Terraform migrate your existing state?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, + command: []string{"init", "-ignore-remote-version"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -128,10 +126,10 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - userInput: []string{"new-workspace", "yes"}, + expectedCmdOutput: `There are no workspaces with the configured tags (app)`, + userInput: []string{"new-workspace"}, postInputOutput: []string{ - `Should Terraform migrate your existing state?`, + `Terraform can create a properly tagged workspace for you now.`, `Terraform Cloud has been successfully initialized!`}, }, { @@ -197,9 +195,11 @@ func Test_migrate_tfc_to_tfc_single_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init"}, - expectedCmdOutput: `Terraform Cloud requires all workspaces to be given an explicit name.`, - expectError: true, - userInput: []string{"new-workspace", "yes"}, + expectedCmdOutput: `There are no workspaces with the configured tags (app)`, + userInput: []string{"new-workspace"}, + postInputOutput: []string{ + `Terraform can create a properly tagged workspace for you now.`, + `Terraform Cloud has been successfully initialized!`}, }, }, }, @@ -341,10 +341,8 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { expectedCmdOutput: `Switched to workspace "app-staging".`, }, { - command: []string{"apply"}, - expectedCmdOutput: `Do you want to perform these actions in workspace "app-staging"?`, - userInput: []string{"yes"}, - postInputOutput: []string{`Apply complete!`}, + command: []string{"apply", "-auto-approve"}, + postInputOutput: []string{`Apply complete!`}, }, { command: []string{"output"}, @@ -368,20 +366,13 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Do you want to copy only your current workspace?`, - userInput: []string{"yes", "yes"}, - postInputOutput: []string{ - `Should Terraform migrate your existing state?`, - `Terraform Cloud has been successfully initialized!`}, + expectedCmdOutput: `Terraform Cloud has been successfully initialized!`, + postInputOutput: []string{`tag_val = "service"`}, }, { command: []string{"workspace", "show"}, expectedCmdOutput: `service`, // this comes from the `prep` function }, - { - command: []string{"output"}, - expectedCmdOutput: `tag_val = "app"`, - }, }, }, }, @@ -447,11 +438,9 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { commands: []tfCommand{ { command: []string{"init", "-ignore-remote-version"}, - expectedCmdOutput: `Would you like to rename your workspaces?`, - userInput: []string{"1", "new-*", "1"}, - postInputOutput: []string{ - `How would you like to rename your workspaces?`, - `Terraform Cloud has been successfully initialized!`}, + expectedCmdOutput: `There are no workspaces with the configured tags (billing)`, + userInput: []string{"new-app-prod"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, }, }, @@ -463,17 +452,13 @@ func Test_migrate_tfc_to_tfc_multiple_workspace(t *testing.T) { if err != nil { t.Fatal(err) } - if len(wsList.Items) != 2 { + if len(wsList.Items) != 1 { t.Logf("Expected the number of workspaces to be 2, but got %d", len(wsList.Items)) } _, empty := getWorkspace(wsList.Items, "new-app-prod") if empty { t.Fatalf("expected workspaces to include 'new-app-prod' but didn't.") } - _, empty = getWorkspace(wsList.Items, "new-app-staging") - if empty { - t.Fatalf("expected workspaces to include 'new-app-staging' but didn't.") - } }, }, } From 7d6d31eff83b6e75bd9a3eeceff5d016ef67fd5a Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 17 Nov 2021 12:43:37 -0800 Subject: [PATCH 370/644] command/init: Skip redundant state migration prompt in Cloud mode The specialized Terraform Cloud migration process asks right up top whether the user wants to migrate state, because there are various other questions contingent on that answer. Therefore we ought to just honor their earlier answer when we get to the point of actually doing the state migration, rather than prompting again. This is tricky because we're otherwise just reusing a codepath that's common to both modes. Hopefully we can find a better way to do this in a later commit, but for the moment our main motivation is minimizing risk to the very next release. --- internal/command/meta_backend_migrate.go | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 800d45c9a8a5..6bdff56eb54c 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -387,8 +387,18 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { // We have existing state moving into no state. Ask the user if // they'd like to do this. case !source.Empty() && destination.Empty(): - log.Print("[TRACE] backendMigrateState: destination workspace has empty state, so might copy source workspace state") - confirmFunc = m.backendMigrateEmptyConfirm + if opts.SourceType == "cloud" || opts.DestinationType == "cloud" { + // HACK: backendMigrateTFC has its own earlier prompt for + // whether to migrate state in the cloud case, so we'll skip + // this later prompt for Cloud, even though we do still need it + // for state backends. + confirmFunc = func(statemgr.Full, statemgr.Full, *backendMigrateOpts) (bool, error) { + return true, nil // the answer is implied to be "yes" if we reached this point + } + } else { + log.Print("[TRACE] backendMigrateState: destination workspace has empty state, so might copy source workspace state") + confirmFunc = m.backendMigrateEmptyConfirm + } // Both states are non-empty, meaning we need to determine which // state should be used and update accordingly. From 7aeaec9b48e4e84f898de28980ea7ffb1e0dcacb Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 17 Nov 2021 16:00:47 -0600 Subject: [PATCH 371/644] Update tests for new prompts * Remove double question to migrate * Remove parallelism (it has been flaky) * Add subtests to apply_auto_approve_test (it was overlooked before) --- internal/cloud/e2e/apply_auto_approve_test.go | 110 +++++++++--------- .../e2e/backend_apply_before_init_test.go | 5 +- .../cloud/e2e/init_with_empty_tags_test.go | 4 +- .../e2e/migrate_state_multi_to_tfc_test.go | 22 ++-- .../e2e/migrate_state_single_to_tfc_test.go | 2 +- .../e2e/migrate_state_tfc_to_other_test.go | 2 +- 6 files changed, 72 insertions(+), 73 deletions(-) diff --git a/internal/cloud/e2e/apply_auto_approve_test.go b/internal/cloud/e2e/apply_auto_approve_test.go index 2a0e23682d95..c31a1ad2fc1e 100644 --- a/internal/cloud/e2e/apply_auto_approve_test.go +++ b/internal/cloud/e2e/apply_auto_approve_test.go @@ -179,72 +179,76 @@ func Test_terraform_apply_autoApprove(t *testing.T) { }, }, } - for _, tc := range cases { - organization, cleanup := createOrganization(t) - defer cleanup() - exp, err := expect.NewConsole(defaultOpts()...) - if err != nil { - t.Fatal(err) - } - defer exp.Close() - - tmpDir, err := ioutil.TempDir("", "terraform-test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) + for name, tc := range cases { + tc := tc + t.Run(name, func(t *testing.T) { + // t.Parallel() + organization, cleanup := createOrganization(t) + defer cleanup() + exp, err := expect.NewConsole(defaultOpts()...) + if err != nil { + t.Fatal(err) + } + defer exp.Close() - tf := e2e.NewBinary(terraformBin, tmpDir) - tf.AddEnv(cliConfigFileEnv) - defer tf.Close() + tmpDir, err := ioutil.TempDir("", "terraform-test") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(tmpDir) - for _, op := range tc.operations { - op.prep(t, organization.Name, tf.WorkDir()) - for _, tfCmd := range op.commands { - cmd := tf.Cmd(tfCmd.command...) - cmd.Stdin = exp.Tty() - cmd.Stdout = exp.Tty() - cmd.Stderr = exp.Tty() + tf := e2e.NewBinary(terraformBin, tmpDir) + tf.AddEnv(cliConfigFileEnv) + defer tf.Close() - err = cmd.Start() - if err != nil { - t.Fatal(err) - } + for _, op := range tc.operations { + op.prep(t, organization.Name, tf.WorkDir()) + for _, tfCmd := range op.commands { + cmd := tf.Cmd(tfCmd.command...) + cmd.Stdin = exp.Tty() + cmd.Stdout = exp.Tty() + cmd.Stderr = exp.Tty() - if tfCmd.expectedCmdOutput != "" { - got, err := exp.ExpectString(tfCmd.expectedCmdOutput) + err = cmd.Start() if err != nil { - t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) + t.Fatal(err) } - } - lenInput := len(tfCmd.userInput) - lenInputOutput := len(tfCmd.postInputOutput) - if lenInput > 0 { - for i := 0; i < lenInput; i++ { - input := tfCmd.userInput[i] - exp.SendLine(input) - // use the index to find the corresponding - // output that matches the input. - if lenInputOutput-1 >= i { - output := tfCmd.postInputOutput[i] - _, err := exp.ExpectString(output) - if err != nil { - t.Fatal(err) + if tfCmd.expectedCmdOutput != "" { + got, err := exp.ExpectString(tfCmd.expectedCmdOutput) + if err != nil { + t.Fatalf("error while waiting for output\nwant: %s\nerror: %s\noutput\n%s", tfCmd.expectedCmdOutput, err, got) + } + } + + lenInput := len(tfCmd.userInput) + lenInputOutput := len(tfCmd.postInputOutput) + if lenInput > 0 { + for i := 0; i < lenInput; i++ { + input := tfCmd.userInput[i] + exp.SendLine(input) + // use the index to find the corresponding + // output that matches the input. + if lenInputOutput-1 >= i { + output := tfCmd.postInputOutput[i] + _, err := exp.ExpectString(output) + if err != nil { + t.Fatal(err) + } } } } - } - err = cmd.Wait() - if err != nil { - t.Fatal(err) + err = cmd.Wait() + if err != nil && !tfCmd.expectError { + t.Fatal(err) + } } } - } - if tc.validations != nil { - tc.validations(t, organization.Name) - } + if tc.validations != nil { + tc.validations(t, organization.Name) + } + }) } } diff --git a/internal/cloud/e2e/backend_apply_before_init_test.go b/internal/cloud/e2e/backend_apply_before_init_test.go index d8985264974d..9b4ff5508361 100644 --- a/internal/cloud/e2e/backend_apply_before_init_test.go +++ b/internal/cloud/e2e/backend_apply_before_init_test.go @@ -11,7 +11,7 @@ import ( func Test_backend_apply_before_init(t *testing.T) { skipIfMissingEnvVar(t) - t.Parallel() + // t.Parallel() skipWithoutRemoteTerraformVersion(t) cases := map[string]struct { @@ -74,7 +74,7 @@ func Test_backend_apply_before_init(t *testing.T) { for name, tc := range cases { tc := tc t.Run(name, func(t *testing.T) { - t.Parallel() + // t.Parallel() organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(defaultOpts()...) @@ -130,6 +130,7 @@ func Test_backend_apply_before_init(t *testing.T) { } } } + err = cmd.Wait() if err != nil && !tfCmd.expectError { t.Fatal(err) diff --git a/internal/cloud/e2e/init_with_empty_tags_test.go b/internal/cloud/e2e/init_with_empty_tags_test.go index 6c03b10524ab..c608e0973315 100644 --- a/internal/cloud/e2e/init_with_empty_tags_test.go +++ b/internal/cloud/e2e/init_with_empty_tags_test.go @@ -11,7 +11,7 @@ import ( func Test_init_with_empty_tags(t *testing.T) { skipIfMissingEnvVar(t) - t.Parallel() + // t.Parallel() skipWithoutRemoteTerraformVersion(t) cases := map[string]struct { @@ -41,7 +41,7 @@ func Test_init_with_empty_tags(t *testing.T) { for name, tc := range cases { tc := tc t.Run(name, func(t *testing.T) { - t.Parallel() + // t.Parallel() organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(defaultOpts()...) diff --git a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go index f06c1597456d..74b750f2cca7 100644 --- a/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_multi_to_tfc_test.go @@ -62,10 +62,8 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { { command: []string{"init"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, - userInput: []string{"yes", "yes"}, - postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, - `Terraform Cloud has been successfully initialized!`}, + userInput: []string{"yes"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "show"}, @@ -129,10 +127,8 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { { command: []string{"init"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, - userInput: []string{"yes", "yes"}, - postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, - `Terraform Cloud has been successfully initialized!`}, + userInput: []string{"yes"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "list"}, @@ -197,10 +193,8 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { { command: []string{"init"}, expectedCmdOutput: `Do you want to copy only your current workspace?`, - userInput: []string{"yes", "yes"}, - postInputOutput: []string{ - `Do you want to copy existing state to Terraform Cloud?`, - `Terraform Cloud has been successfully initialized!`}, + userInput: []string{"yes"}, + postInputOutput: []string{`Terraform Cloud has been successfully initialized!`}, }, { command: []string{"workspace", "select", "default"}, @@ -233,7 +227,7 @@ func Test_migrate_multi_to_tfc_cloud_name_strategy(t *testing.T) { for name, tc := range cases { tc := tc t.Run(name, func(t *testing.T) { - t.Parallel() + // t.Parallel() organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(defaultOpts()...) @@ -521,7 +515,7 @@ func Test_migrate_multi_to_tfc_cloud_tags_strategy(t *testing.T) { for name, tc := range cases { tc := tc t.Run(name, func(t *testing.T) { - t.Parallel() + // t.Parallel() organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(defaultOpts()...) diff --git a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go index 4865a780d5fc..064256aacbd6 100644 --- a/internal/cloud/e2e/migrate_state_single_to_tfc_test.go +++ b/internal/cloud/e2e/migrate_state_single_to_tfc_test.go @@ -131,7 +131,7 @@ func Test_migrate_single_to_tfc(t *testing.T) { for name, tc := range cases { tc := tc t.Run(name, func(t *testing.T) { - t.Parallel() + // t.Parallel() organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(defaultOpts()...) diff --git a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go index 9de96ab01593..4840a0f85fdf 100644 --- a/internal/cloud/e2e/migrate_state_tfc_to_other_test.go +++ b/internal/cloud/e2e/migrate_state_tfc_to_other_test.go @@ -49,7 +49,7 @@ func Test_migrate_tfc_to_other(t *testing.T) { for name, tc := range cases { tc := tc t.Run(name, func(t *testing.T) { - t.Parallel() + // t.Parallel() organization, cleanup := createOrganization(t) defer cleanup() exp, err := expect.NewConsole(defaultOpts()...) From 2fc4e068906518c362c810f30ce4386218e75b99 Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Thu, 18 Nov 2021 10:12:00 -0600 Subject: [PATCH 372/644] Fix failing lint check for deprecated x/crypto/openpgp library --- internal/getproviders/package_authentication.go | 3 +++ internal/getproviders/package_authentication_test.go | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/internal/getproviders/package_authentication.go b/internal/getproviders/package_authentication.go index 32e907deea55..4ebb8da6fcfa 100644 --- a/internal/getproviders/package_authentication.go +++ b/internal/getproviders/package_authentication.go @@ -9,6 +9,9 @@ import ( "log" "strings" + // TODO: replace crypto/openpgp since it is deprecated + // https://github.com/golang/go/issues/44226 + //lint:file-ignore SA1019 openpgp is deprecated but there are no good alternatives yet "golang.org/x/crypto/openpgp" openpgpArmor "golang.org/x/crypto/openpgp/armor" openpgpErrors "golang.org/x/crypto/openpgp/errors" diff --git a/internal/getproviders/package_authentication_test.go b/internal/getproviders/package_authentication_test.go index 06b7621e5bc2..45052b75d298 100644 --- a/internal/getproviders/package_authentication_test.go +++ b/internal/getproviders/package_authentication_test.go @@ -9,6 +9,10 @@ import ( "testing" "github.com/google/go-cmp/cmp" + + // TODO: replace crypto/openpgp since it is deprecated + // https://github.com/golang/go/issues/44226 + //lint:file-ignore SA1019 openpgp is deprecated but there are no good alternatives yet "golang.org/x/crypto/openpgp" ) From 2c29a05053ca40fbdf425bcc963d1f67efccbe36 Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Thu, 18 Nov 2021 13:10:15 -0600 Subject: [PATCH 373/644] Fix go.mod issues by running go mod tidy -go=1.16 && go mod tidy -go=1.17 --- go.mod | 8 ++++-- go.sum | 86 +++++++++++++++++++++++++++++++++++++++++++--------------- 2 files changed, 69 insertions(+), 25 deletions(-) diff --git a/go.mod b/go.mod index 0c462797b1fa..0de9e9d5d0c6 100644 --- a/go.mod +++ b/go.mod @@ -25,7 +25,7 @@ require ( github.com/go-test/deep v1.0.3 github.com/golang/mock v1.6.0 github.com/golang/protobuf v1.5.2 - github.com/google/go-cmp v0.5.5 + github.com/google/go-cmp v0.5.6 github.com/google/uuid v1.2.0 github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 github.com/gophercloud/utils v0.0.0-20200423144003-7c72efc7435d @@ -131,7 +131,6 @@ require ( github.com/dimchansky/utfbom v1.1.1 // indirect github.com/dylanmei/iso8601 v0.1.0 // indirect github.com/fatih/color v1.9.0 // indirect - github.com/form3tech-oss/jwt-go v3.2.2+incompatible // indirect github.com/go-logr/logr v0.4.0 // indirect github.com/gofrs/uuid v3.3.0+incompatible // indirect github.com/gogo/protobuf v1.3.2 // indirect @@ -152,11 +151,12 @@ require ( github.com/hashicorp/serf v0.9.5 // indirect github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect github.com/huandu/xstrings v1.3.2 // indirect - github.com/imdario/mergo v0.3.11 // indirect + github.com/imdario/mergo v0.3.12 // indirect github.com/json-iterator/go v1.1.10 // indirect github.com/jstemmer/go-junit-report v0.9.1 // indirect github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect + github.com/kr/pretty v0.2.1 // indirect github.com/kr/pty v1.1.5 // indirect github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect github.com/mattn/go-colorable v0.1.6 // indirect @@ -168,6 +168,7 @@ require ( github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect github.com/oklog/run v1.0.0 // indirect github.com/satori/go.uuid v1.2.0 // indirect + github.com/sergi/go-diff v1.2.0 // indirect github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a // indirect github.com/spf13/pflag v1.0.5 // indirect @@ -183,6 +184,7 @@ require ( golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/appengine v1.6.7 // indirect google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect + gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect gopkg.in/inf.v0 v0.9.1 // indirect gopkg.in/ini.v1 v1.42.0 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect diff --git a/go.sum b/go.sum index dc9672566d6c..eb92f2440008 100644 --- a/go.sum +++ b/go.sum @@ -11,6 +11,7 @@ cloud.google.com/go v0.53.0/go.mod h1:fp/UouUEsRkN6ryDKNW/Upv/JBKnv6WDthjR6+vze6 cloud.google.com/go v0.54.0/go.mod h1:1rq2OEkV3YMf6n/9ZvGWI3GWw0VoqH/1x2nd8Is/bPc= cloud.google.com/go v0.56.0/go.mod h1:jr7tqZxxKOVYizybht9+26Z/gUq7tiRzu+ACVAMbKVk= cloud.google.com/go v0.57.0/go.mod h1:oXiQ6Rzq3RAkkY7N6t3TcE6jE+CIBBbA36lwQ1JyzZs= +cloud.google.com/go v0.61.0/go.mod h1:XukKJg4Y7QsUu0Hxg3qQKUWR4VuWivmyMK2+rUyxAqw= cloud.google.com/go v0.62.0/go.mod h1:jmCYTdRCQuc1PHIIJ/maLInMho30T/Y0M4hTdTShOYc= cloud.google.com/go v0.65.0/go.mod h1:O5N8zS7uWy9vkA9vayVHs65eM1ubvY4h553ofrNHObY= cloud.google.com/go v0.72.0/go.mod h1:M+5Vjvlc2wnp6tjzE102Dw08nGShTscUx2nZMufOKPI= @@ -39,9 +40,6 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= github.com/Azure/azure-sdk-for-go v45.0.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/azure-sdk-for-go v47.1.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= -github.com/Azure/azure-sdk-for-go v51.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= -github.com/Azure/azure-sdk-for-go v52.5.0+incompatible h1:/NLBWHCnIHtZyLPc1P7WIqi4Te4CC23kIQyK3Ep/7lA= -github.com/Azure/azure-sdk-for-go v52.5.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/azure-sdk-for-go v59.2.0+incompatible h1:mbxiZy1K820hQ+dI+YIO/+a0wQDYqOu18BAGe4lXjVk= github.com/Azure/azure-sdk-for-go v59.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs= @@ -49,20 +47,15 @@ github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSW github.com/Azure/go-autorest/autorest v0.11.3/go.mod h1:JFgpikqFJ/MleTTxwepExTKnFUKKszPS8UavbQYUMuw= github.com/Azure/go-autorest/autorest v0.11.10/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= github.com/Azure/go-autorest/autorest v0.11.12/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= -github.com/Azure/go-autorest/autorest v0.11.18 h1:90Y4srNYrwOtAgVo3ndrQkTYn6kf1Eg/AjTFJ8Is2aM= -github.com/Azure/go-autorest/autorest v0.11.18/go.mod h1:dSiJPy22c3u0OtOKDNttNgqpNFY/GeWa7GH/Pz56QRA= github.com/Azure/go-autorest/autorest v0.11.21/go.mod h1:Do/yuMSW/13ayUkcVREpsMHGG+MvV81uzSCFgYPj4tM= github.com/Azure/go-autorest/autorest v0.11.22 h1:bXiQwDjrRmBQOE67bwlvUKAC1EU1yZTPQ38c+bstZws= github.com/Azure/go-autorest/autorest v0.11.22/go.mod h1:BAWYUWGPEtKPzjVkp0Q6an0MJcJDsoh5Z1BFAEFs4Xs= github.com/Azure/go-autorest/autorest/adal v0.9.0/go.mod h1:/c022QCutn2P7uY+/oQWWNcK9YU+MH96NgK+jErpbcg= github.com/Azure/go-autorest/autorest/adal v0.9.5/go.mod h1:B7KF7jKIeC9Mct5spmyCB/A8CG/sEz1vwIRGv/bbw7A= -github.com/Azure/go-autorest/autorest/adal v0.9.13 h1:Mp5hbtOePIzM8pJVRa3YLrWWmZtoxRXqUEzCfJt3+/Q= -github.com/Azure/go-autorest/autorest/adal v0.9.13/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= github.com/Azure/go-autorest/autorest/adal v0.9.14/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= github.com/Azure/go-autorest/autorest/adal v0.9.17 h1:esOPl2dhcz9P3jqBSJ8tPGEj2EqzPPT6zfyuloiogKY= github.com/Azure/go-autorest/autorest/adal v0.9.17/go.mod h1:XVVeme+LZwABT8K5Lc3hA4nAe8LDBVle26gTrguhhPQ= github.com/Azure/go-autorest/autorest/azure/cli v0.4.0/go.mod h1:JljT387FplPzBA31vUcvsetLKF3pec5bdAxjVU4kI2s= -github.com/Azure/go-autorest/autorest/azure/cli v0.4.2 h1:dMOmEJfkLKW/7JsokJqkyoYSgmR08hi9KrhjZb+JALY= github.com/Azure/go-autorest/autorest/azure/cli v0.4.2/go.mod h1:7qkJkT+j6b+hIpzMOwPChJhTqS8VbsqqgULzMNRugoM= github.com/Azure/go-autorest/autorest/azure/cli v0.4.4 h1:iuooz5cZL6VRcO7DVSFYxRcouqn6bFVE/e77Wts50Zk= github.com/Azure/go-autorest/autorest/azure/cli v0.4.4/go.mod h1:yAQ2b6eP/CmLPnmLvxtT1ALIY3OR1oFcCqVBi8vHiTc= @@ -96,16 +89,20 @@ github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3Q github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y= github.com/Masterminds/sprig v2.22.0+incompatible h1:z4yfnGrZ7netVz+0EDJ0Wi+5VZCSYp4Z0m2dk6cEM60= github.com/Masterminds/sprig v2.22.0+incompatible/go.mod h1:y6hNFY5UBTIWBxnzTeuNhlNS5hqE0NB0E6fgfo2Br3o= +github.com/Microsoft/go-winio v0.4.14/go.mod h1:qXqCSQ3Xa7+6tgxaGTIe4Kpcdsi+P8jBhyzoq1bpyYA= +github.com/Microsoft/go-winio v0.4.16/go.mod h1:XB6nPKklQyQ7GC9LdcBEcBl8PF76WugXOPRXwdLnMv0= github.com/Microsoft/go-winio v0.5.0 h1:Elr9Wn+sGKPlkaBvwu4mTrxtmOp3F3yV9qhaHbXGjwU= github.com/Microsoft/go-winio v0.5.0/go.mod h1:JPGBdM1cNvN/6ISo+n8V5iA4v8pBzdOpzfwIujj1a84= github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb06e3pkSAbeQ52E9H9iFoQsEEwGN64994WTCIhntQ= github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25 h1:hWfsqBaNZUHztXA78g7Y2Jj3rDQaTCZhhFwz43i2VlA= github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25/go.mod h1:68ORG0HSEWDuH5Eh73AFbYWZ1zT4Y+b0vhOa+vZRUdI= +github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo= github.com/PuerkitoBio/purell v1.1.1/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= github.com/QcloudApi/qcloud_sign_golang v0.0.0-20141224014652-e4130a326409/go.mod h1:1pk82RBxDY/JZnPQrtqHlUFfCctgdorsd9M06fMynOM= github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af h1:DBNMBMuMiWYu0b+8KMJuWmfCkcxl09JwdlqwDZZ6U14= github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af/go.mod h1:5Jv4cbFiHJMsVxt52+i0Ha45fjshj6wxYr1r19tB9bw= +github.com/acomagu/bufpipe v1.0.3/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4= github.com/agext/levenshtein v1.2.1/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/agext/levenshtein v1.2.2/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo= @@ -118,10 +115,13 @@ github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70 h1:FrF4ux github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70/go.mod h1:T/Aws4fEfogEE9v+HPhhw+CntffsBHJ8nXQCwKr0/g8= github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible h1:ABQ7FF+IxSFHDMOTtjCfmMDMHiCq6EsAoCV/9sFinaM= github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible/go.mod h1:LDQHRZylxvcg8H7wBIDfvO5g/cy4/sz1iucBlc2l3Jw= +github.com/andybalholm/crlf v0.0.0-20171020200849-670099aa064f/go.mod h1:k8feO4+kXDxro6ErPXBRTJ/ro2mf0SsFG8s7doP9kJE= +github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c= github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e h1:ptBAamGVd6CfRsUtyHD+goy2JGhv1QC32v3gqM8mYAM= github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e/go.mod h1:Yee4kTMuNiPYJ7nSNorELQMr1J33uOpXDMByNYhvtNk= github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0 h1:JaCC8jz0zdMLk2m+qCCVLLLM/PL93p84w4pK3aJWj60= github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0/go.mod h1:LzD22aAzDP8/dyiCKFp31He4m2GPjl0AFyzDtZzUu9M= +github.com/apparentlymart/go-cidr v1.0.1/go.mod h1:EBcsNrHc3zQeuaeCeCtQruQm+n9/YjEn/vI25Lg7Gwc= github.com/apparentlymart/go-cidr v1.1.0 h1:2mAhrMoF+nhXqxTzSZMUzDHkLjmIHC+Zzn4tdgBZjnU= github.com/apparentlymart/go-cidr v1.1.0/go.mod h1:EBcsNrHc3zQeuaeCeCtQruQm+n9/YjEn/vI25Lg7Gwc= github.com/apparentlymart/go-dump v0.0.0-20180507223929-23540a00eaa3/go.mod h1:oL81AME2rN47vu18xqj1S1jPIPuN7afo62yKTNn3XMM= @@ -131,6 +131,7 @@ github.com/apparentlymart/go-shquot v0.0.1 h1:MGV8lwxF4zw75lN7e0MGs7o6AFYn7L6AZa github.com/apparentlymart/go-shquot v0.0.1/go.mod h1:lw58XsE5IgUXZ9h0cxnypdx31p9mPFIVEQ9P3c7MlrU= github.com/apparentlymart/go-textseg v1.0.0 h1:rRmlIsPEEhUTIKQb7T++Nz/A5Q6C9IuX2wFoYVvnCs0= github.com/apparentlymart/go-textseg v1.0.0/go.mod h1:z96Txxhf3xSFMPmb5X/1W05FF/Nj9VFpLOpjS5yuumk= +github.com/apparentlymart/go-textseg/v12 v12.0.0/go.mod h1:S/4uRK2UtaQttw1GenVJEynmyUenKwP++x/+DdGV/Ec= github.com/apparentlymart/go-textseg/v13 v13.0.0 h1:Y+KvPE1NYz0xl601PVImeQfFyEy6iT90AvPUL1NNfNw= github.com/apparentlymart/go-textseg/v13 v13.0.0/go.mod h1:ZK2fH7c4NqDTLtiYLvIkEghdlcqw7yxLeM89kiTRPUo= github.com/apparentlymart/go-userdirs v0.0.0-20200915174352-b0c018a67c13 h1:JtuelWqyixKApmXm3qghhZ7O96P6NKpyrlSIe8Rwnhw= @@ -145,8 +146,10 @@ github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmV github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= +github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:lB+ZfQJz7igIIfQNfa7Ml4HSf2uFQQRzpGGRXenZAgY= github.com/aws/aws-sdk-go v1.15.78/go.mod h1:E3/ieXAlvM0XWO57iftYVDLLvQ824smPP3ATZkfNZeM= +github.com/aws/aws-sdk-go v1.25.3/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo= github.com/aws/aws-sdk-go v1.31.9/go.mod h1:5zCpMtNQVjRREroY7sYe8lOMRSxkhG6MZveU8YkpAk0= github.com/aws/aws-sdk-go v1.40.25 h1:Depnx7O86HWgOCLD5nMto6F9Ju85Q1QuFDnbpZYQWno= github.com/aws/aws-sdk-go v1.40.25/go.mod h1:585smgzpB/KqRA+K3y/NL/oYRqQvpNJYvLm+LY1U59Q= @@ -200,6 +203,7 @@ github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 h1:r1oACdS2XYiA github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1/go.mod h1:lcy9/2gH1jn/VCLouHA6tOEwLoNVd4GW6zhuKLmHC2Y= github.com/elazarl/goproxy v0.0.0-20180725130230-947c36da3153/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc= github.com/emicklei/go-restful v0.0.0-20170410110728-ff4f55a20633/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs= +github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o= github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4= github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98= @@ -210,10 +214,16 @@ github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLi github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s= github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU= -github.com/form3tech-oss/jwt-go v3.2.2+incompatible h1:TcekIExNqud5crz4xD2pavyTgWiPvpYe4Xau31I0PRk= +github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc= github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= +github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0= +github.com/go-git/gcfg v1.5.0/go.mod h1:5m20vg6GwYabIxaOonVkTdrILxQMpEShl1xiMF4ua+E= +github.com/go-git/go-billy/v5 v5.2.0/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0= +github.com/go-git/go-billy/v5 v5.3.1/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0= +github.com/go-git/go-git-fixtures/v4 v4.2.1/go.mod h1:K8zd3kDUAykwTdDCr+I0per6Y6vMiRR/nnVTBtavnB0= +github.com/go-git/go-git/v5 v5.4.2/go.mod h1:gQ1kArt6d+n+BGd+/B/I74HwRTLhth2+zti4ihgckDc= github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= @@ -293,8 +303,9 @@ github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= +github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ= +github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck= github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8= github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU= @@ -354,8 +365,6 @@ github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brv github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/go-azure-helpers v0.12.0/go.mod h1:Zc3v4DNeX6PDdy7NljlYpnrdac1++qNW0I4U+ofGwpg= -github.com/hashicorp/go-azure-helpers v0.14.0 h1:CdC2QqxK/Vk32YS5XMKXHjnpbtNIUCUv/PoSVQHx5jY= -github.com/hashicorp/go-azure-helpers v0.14.0/go.mod h1:kR7+sTDEb9TOp/O80ss1UEJg1t4/BHLD/U8wHLS4BGQ= github.com/hashicorp/go-azure-helpers v0.18.0 h1:hh+lFaURcQ0R12Pj0Ybn+dj6mTHU+I+ep/CAmXiYEvw= github.com/hashicorp/go-azure-helpers v0.18.0/go.mod h1:lZo52hYeyEoo4qpUUruaEec13bFyu8ldjX2zTFzVzss= github.com/hashicorp/go-checkpoint v0.5.0 h1:MFYpPZCnQqQTE18jFwSII6eUQrD/oxMFp3mlgcqk5mU= @@ -364,8 +373,11 @@ github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtng github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= +github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320/go.mod h1:EiZBMaudVLy8fmjf9Npq1dq9RalhveqZG5w/yz3mHWs= +github.com/hashicorp/go-getter v1.5.3/go.mod h1:BrrV/1clo8cCYu6mxvboYg+KutTiFnXjMEgDD8+i7ZI= github.com/hashicorp/go-getter v1.5.9 h1:b7ahZW50iQiUek/at3CvZhPK1/jiV6CtKcsJiR6E4R0= github.com/hashicorp/go-getter v1.5.9/go.mod h1:BrrV/1clo8cCYu6mxvboYg+KutTiFnXjMEgDD8+i7ZI= +github.com/hashicorp/go-hclog v0.0.0-20180709165350-ff2cf002a8dd/go.mod h1:9bjs9uLqI8l75knNv3lV1kA55veR+WUPSiKIWcQHudI= github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= github.com/hashicorp/go-hclog v0.12.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= github.com/hashicorp/go-hclog v0.14.1/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= @@ -380,6 +392,8 @@ github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHh github.com/hashicorp/go-multierror v1.1.0/go.mod h1:spPvp8C1qA32ftKqdAHm4hHTbPw+vmowP0z+KUhOZdA= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= +github.com/hashicorp/go-plugin v1.3.0/go.mod h1:F9eH4LrE/ZsRdbwhfjs9k9HoDUwAHnYtXdgmf1AVNs0= +github.com/hashicorp/go-plugin v1.4.1/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ= github.com/hashicorp/go-plugin v1.4.3 h1:DXmvivbWD5qdiBts9TpBC7BYL1Aia5sxbRgQB+v6UZM= github.com/hashicorp/go-plugin v1.4.3/go.mod h1:5fGEH17QVwTTcR0zV7yhDPLLmFX9YSZ38b18Udy6vYQ= github.com/hashicorp/go-retryablehttp v0.7.0 h1:eu1EI/mbirUgP5C8hVsTNaGZreBDlYiwC1FZWkvQPQ4= @@ -402,7 +416,6 @@ github.com/hashicorp/go-uuid v1.0.2/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/b github.com/hashicorp/go-version v1.0.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.1.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.2.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= -github.com/hashicorp/go-version v1.2.1/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/go-version v1.3.0 h1:McDWVJIU/y+u1BRV06dPaLfLCaT7fUTJLp5r04x7iNw= github.com/hashicorp/go-version v1.3.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= @@ -411,6 +424,7 @@ github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f h1:UdxlrJz4JOnY8W+DbLISwf2B8WXEolNRA8BGCwI9jws= github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f/go.mod h1:oZtUIOe8dh44I2q6ScRibXws4Ajl+d+nod3AaR9vL5w= github.com/hashicorp/hcl/v2 v2.0.0/go.mod h1:oVVDG71tEinNGYCxinCYadcmKU9bglqW9pV3txagJ90= +github.com/hashicorp/hcl/v2 v2.3.0/go.mod h1:d+FwDBbOLvpAM3Z6J7gPj/VoAGkNe/gm352ZhjJ/Zv8= github.com/hashicorp/hcl/v2 v2.10.1 h1:h4Xx4fsrRE26ohAk/1iGF/JBqRQbyUqu5Lvj60U54ys= github.com/hashicorp/hcl/v2 v2.10.1/go.mod h1:FwWsfWEjyV/CMj8s/gqAuiviY72rJ1/oayI9WftqcKg= github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d h1:9ARUJJ1VVynB176G1HCwleORqCaXm/Vx0uUi0dL26I0= @@ -423,6 +437,10 @@ github.com/hashicorp/serf v0.9.5 h1:EBWvyu9tcRszt3Bxp3KNssBMP1KuHWyO51lz9+786iM= github.com/hashicorp/serf v0.9.5/go.mod h1:UWDWwZeL5cuWDJdl0C6wrvrUwEqtQ4ZKBKKENpqIUyk= github.com/hashicorp/terraform-config-inspect v0.0.0-20210209133302-4fd17a0faac2 h1:l+bLFvHjqtgNQwWxwrFX9PemGAAO2P1AGZM7zlMNvCs= github.com/hashicorp/terraform-config-inspect v0.0.0-20210209133302-4fd17a0faac2/go.mod h1:Z0Nnk4+3Cy89smEbrq+sl1bxc9198gIP4I7wcQF6Kqs= +github.com/hashicorp/terraform-exec v0.14.0/go.mod h1:qrAASDq28KZiMPDnQ02sFS9udcqEkRly002EA2izXTA= +github.com/hashicorp/terraform-json v0.12.0/go.mod h1:pmbq9o4EuL43db5+0ogX10Yofv1nozM+wskr/bGFJpI= +github.com/hashicorp/terraform-plugin-go v0.4.0/go.mod h1:7u/6nt6vaiwcWE2GuJKbJwNlDFnf5n95xKw4hqIVr58= +github.com/hashicorp/terraform-plugin-sdk/v2 v2.8.0/go.mod h1:6KbP09YzlB++S6XSUKYl83WyoHVN4MgeoCbPRsdfCtA= github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 h1:HKLsbzeOsfXmKNpr3GiT18XAblV0BjCbzL8KQAMZGa0= github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734/go.mod h1:kNDNcF7sN4DocDLBkQYz73HGKwN1ANB1blq4lIYLYvg= github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM= @@ -434,12 +452,16 @@ github.com/huandu/xstrings v1.3.2/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/imdario/mergo v0.3.5/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA= -github.com/imdario/mergo v0.3.11 h1:3tnifQM4i+fbajXKBHXWEH+KvNHqojZ778UH75j3bGA= github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= +github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU= +github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4= github.com/jhump/protoreflect v1.6.0 h1:h5jfMVslIg6l29nsMs0D8Wj17RDVdNYti0vDN/PZZoE= github.com/jhump/protoreflect v1.6.0/go.mod h1:eaTn3RZAmMBcV0fifFvlm6VHNz3wSkYyXYWUh7ymB74= github.com/jmespath/go-jmespath v0.0.0-20160202185014-0b12d6b521d8/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= +github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= github.com/jmespath/go-jmespath v0.3.0/go.mod h1:9QtRXoHjLGCJ5IBSaohpXITPlowMeeYCZ7fLUTSywik= github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg= github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo= @@ -461,6 +483,7 @@ github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVY github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 h1:iQTw/8FWTuc7uiaSepXwyf3o52HaUYcV+Tu66S3F5GA= github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0/go.mod h1:1NbS8ALrpOvjt0rHPNLyCIeMtbizbir8U//inJ+zuB8= +github.com/kevinburke/ssh_config v0.0.0-20201106050909-4977a11b4351/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= @@ -469,8 +492,9 @@ github.com/klauspost/compress v1.11.2/go.mod h1:aoV0uJVorq1K+umq18yTdKaF57EivdYs github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= -github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs= github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI= +github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/pty v1.1.5 h1:hyz3dwM5QLc1Rfoz4FuWJQG5BN7tc6K1MndAUnGpQr4= github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA= @@ -493,6 +517,7 @@ github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 h1:2ZKn+w/BJeL github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786/go.mod h1:kCEbxUJlNDEBNbdQMkPSp6yaKcRXVI6f4ddk8Riv4bc= github.com/masterzen/winrm v0.0.0-20200615185753-c42b5136ff88 h1:cxuVcCvCLD9yYDbRCWw0jSgh1oT6P6mv3aJDKK5o7X4= github.com/masterzen/winrm v0.0.0-20200615185753-c42b5136ff88/go.mod h1:a2HXwefeat3evJHxFXSayvRHpYEPJYtErl4uIzfaUqY= +github.com/matryer/is v1.2.0/go.mod h1:2fLPjFQM9rhQ15aVEtbuwhJinnOqrmgXPNdZsdwlWXA= github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU= github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= github.com/mattn/go-colorable v0.1.6 h1:6Su7aK7lXmJ/U79bYtBjLNaha4Fs1Rg9plHpcH+vvnE= @@ -527,7 +552,6 @@ github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrk github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb h1:GRiLv4rgyqjqzxbhJke65IYUf4NCOOvrPOJbV/sPxkM= github.com/mitchellh/go-linereader v0.0.0-20190213213312-1b945b3263eb/go.mod h1:OaY7UOoTkkrX3wRwjpYRKafIkkyeD0UtweSHAWWiqQM= github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= -github.com/mitchellh/go-testing-interface v1.0.0 h1:fzU/JVNcaqHQEcVFAKeR41fkiLdIPrefOvVG1VZ96U0= github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-testing-interface v1.0.4 h1:ZU1VNC02qyufSZsjjs7+khruk2fKvbQ3TwRV/IBCeFA= github.com/mitchellh/go-testing-interface v1.0.4/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= @@ -558,10 +582,10 @@ github.com/mozillazg/go-httpheader v0.3.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK0 github.com/munnerz/goautoneg v0.0.0-20120707110453-a547fc61f48d/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw= -github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/nishanths/exhaustive v0.2.3 h1:+ANTMqRNrqwInnP9aszg/0jDo+zbXa4x66U19Bx/oTk= github.com/nishanths/exhaustive v0.2.3/go.mod h1:bhIX678Nx8inLM9PbpvK1yv6oGtoP8BfaIeMzgBNKvc= +github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce/go.mod h1:uFMI8w+ref4v2r9jz+c9i1IfIttS/OkmLfrk1jne5hs= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d/go.mod h1:YUTz3bUH2ZwIWBy3CJBeOBEugqcmXREj14T+iG/4k4U= github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw= @@ -607,9 +631,13 @@ github.com/satori/go.uuid v1.2.0 h1:0uYX9dsZ2yD7q2RtLRtPSdGDWzjeM3TbMJP9utgA0ww= github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529 h1:nn5Wsu0esKSJiIVhscUtVbo7ada43DJhG55ua/hjS5I= github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc= -github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ= +github.com/sebdah/goldie v1.0.0/go.mod h1:jXP4hmWywNEwZzhMuv2ccnqTSFpuq8iyQhtQdkkZBH4= github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= +github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= +github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= +github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= github.com/sirupsen/logrus v1.7.0 h1:ShrD1U9pZB12TX0cVy0DtePoCH97K8EtX+mg7ZARUtM= github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= @@ -654,12 +682,14 @@ github.com/tombuildsstuff/giovanni v0.15.1/go.mod h1:0TZugJPEtqzPlMpuJHYfXY6Dq2u github.com/ulikunitz/xz v0.5.8 h1:ERv8V6GKqVi23rgu5cj9pVfVzJbOqAY2Ntl88O6c2nQ= github.com/ulikunitz/xz v0.5.8/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= github.com/urfave/cli v1.20.0/go.mod h1:70zkFmudgCuE/ngEzBv17Jvp/497gISqfk5gWijbERA= -github.com/vmihailenco/msgpack v3.3.3+incompatible h1:wapg9xDUZDzGCNFlwc5SqI1rvcciqcxEHac4CYj89xI= github.com/vmihailenco/msgpack v3.3.3+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= +github.com/vmihailenco/msgpack v4.0.4+incompatible h1:dSLoQfGFAo3F6OoNhwUmLwVgaUXK79GlxNBwueZn0xI= +github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= github.com/vmihailenco/msgpack/v4 v4.3.12 h1:07s4sz9IReOgdikxLTKNbBdqDMLsjPKXwvCazn8G65U= github.com/vmihailenco/msgpack/v4 v4.3.12/go.mod h1:gborTTJjAo/GWTqqRjrLCn9pgNN+NXzzngzBKDPIqw4= github.com/vmihailenco/tagparser v0.1.1 h1:quXMXlA39OCbd2wAdTsGDlK9RkOk6Wuw+x37wVyIuWY= github.com/vmihailenco/tagparser v0.1.1/go.mod h1:OeAg3pn3UbLjkWt+rN9oFYB6u/cQgqMEUPoW2WPyhdI= +github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0= github.com/xanzy/ssh-agent v0.3.1 h1:AmzO1SSWxw73zxFZPRwaMN1MohDw8UyHnmuxyceTEGo= github.com/xanzy/ssh-agent v0.3.1/go.mod h1:QIE4lCeL7nkC25x+yA3LBIYfwCc1TFziCtG7cBAac6w= github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2 h1:eY9dn8+vbi4tKz5Qo6v2eYzo7kUS51QINcR5jNpbZS8= @@ -675,7 +705,9 @@ github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1 github.com/zclconf/go-cty v1.0.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.1.0/go.mod h1:xnAOWiHeOqg2nWS62VtQ7pbOu17FtxJNW8RLEih+O3s= github.com/zclconf/go-cty v1.2.0/go.mod h1:hOPWgoHbaTUnI5k4D2ld+GRpFJSCe6bCM7m1q/N4PQ8= +github.com/zclconf/go-cty v1.2.1/go.mod h1:hOPWgoHbaTUnI5k4D2ld+GRpFJSCe6bCM7m1q/N4PQ8= github.com/zclconf/go-cty v1.8.0/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk= +github.com/zclconf/go-cty v1.8.4/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk= github.com/zclconf/go-cty v1.10.0 h1:mp9ZXQeIcN8kAwuqorjH+Q+njbJKjLrvB2yIh4q7U+0= github.com/zclconf/go-cty v1.10.0/go.mod h1:vVKLxnk3puL4qRAv72AO+W99LUD4da90g3uUAzyuvAk= github.com/zclconf/go-cty-debug v0.0.0-20191215020915-b22d67c1ba0b h1:FosyBZYxY34Wul7O/MSKey3txpPYyCqVO5ZyceuQJEI= @@ -702,6 +734,7 @@ go.uber.org/zap v1.10.0 h1:ORx85nbTijNz8ljznvCMR1ZBIPKFn3jQrag10X2AsuM= go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190222235706-ffb98f73852f/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190426145343-a29dc8fdc734/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= @@ -716,8 +749,9 @@ golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPh golang.org/x/crypto v0.0.0-20201002170205-7f63de1d35b0/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= +golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= +golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8= -golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 h1:/UOmuWzQfxxo9UtlXMwuQU8CMgg1eZXqTRwkSQJWKOI= golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa h1:idItI2DDfCokpg0N51B2VtiLdJ4vAuXC9fnCb2gACo4= @@ -802,6 +836,7 @@ golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210224082022-3d97a244fca7/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210326060303-6b1517762897/go.mod h1:uSPa2vr4CLtc/ILN5odXGNXS6mhrKVzTaCXzk9m6W3k= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= @@ -817,7 +852,6 @@ golang.org/x/oauth2 v0.0.0-20201109201403-9fd604954f58/go.mod h1:KelEdhl1UZF7XfJ golang.org/x/oauth2 v0.0.0-20201208152858-08078c50e5b5/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210220000619-9bb904979d93/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= -golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84 h1:duBc5zuJsmJXYOVVE/6PxejI+N3AaCqKjtsoLn1Je5Q= golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c h1:pkQiBZBvdos9qq4wBAHqlzuZHEXo07pqV06ef90u1WI= golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= @@ -852,6 +886,7 @@ golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20190616124812-15dcb6c0061f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190922100055-0a153f010e69/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -885,9 +920,11 @@ golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210220050731-9a76102bfb43/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210305230114-8fe3ee5dd75b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210324051608-47abb6519492/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210502180810-71e4cd670f79/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -955,6 +992,7 @@ golang.org/x/tools v0.0.0-20200512131952-2bc93b1c0c88/go.mod h1:EkVYQZoAsY45+roY golang.org/x/tools v0.0.0-20200515010526-7d3b6ebf133d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200618134242-20370b0cb4b2/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= +golang.org/x/tools v0.0.0-20200713011307-fd294ab11aed/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200729194436-6467de6f59a7/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200804011535-6c149bb5ef0d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= golang.org/x/tools v0.0.0-20200825202427-b303f430e36d/go.mod h1:njjCfa9FT2d7l9Bc6FUM5FLjQPp3cFF28FI3qnDFljA= @@ -1031,6 +1069,7 @@ google.golang.org/genproto v0.0.0-20200511104702-f5ebc3bea380/go.mod h1:55QSHmfG google.golang.org/genproto v0.0.0-20200515170657-fc4c6c6a6587/go.mod h1:YsZOwe1myG/8QRHRsmBRE1LrgQY60beZKjly0O1fX9U= google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo= google.golang.org/genproto v0.0.0-20200618031413-b414f8b61790/go.mod h1:jDfRM7FcilCzHH/e9qn6dsT145K34l5v+OpcnNgKAAA= +google.golang.org/genproto v0.0.0-20200711021454-869866162049/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200729003335-053ba62fc06f/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200804131852-c06518451d9c/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200825200019-8632dd797987/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= @@ -1059,6 +1098,7 @@ google.golang.org/grpc v1.29.1/go.mod h1:itym6AZVZYACWQqET3MqgPpjcuV5QH3BxFS3Iji google.golang.org/grpc v1.30.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= google.golang.org/grpc v1.31.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= google.golang.org/grpc v1.31.1/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= +google.golang.org/grpc v1.32.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak= google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc= google.golang.org/grpc v1.34.0/go.mod h1:WotjhfgOW/POjDeRt8vscBtXq+2VjORFy659qA51WJ8= google.golang.org/grpc v1.35.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= @@ -1082,8 +1122,9 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU= gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= gopkg.in/cheggaaa/pb.v1 v1.0.25/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw= gopkg.in/cheggaaa/pb.v1 v1.0.27/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw= gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= @@ -1094,6 +1135,7 @@ gopkg.in/ini.v1 v1.42.0 h1:7N3gPTt50s8GuLortA00n8AqRTk75qOP98+mTPpgzRk= gopkg.in/ini.v1 v1.42.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= From 2d0349d9a4b107a567e353a9efb3582fcb491360 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 19 Nov 2021 11:53:36 -0500 Subject: [PATCH 374/644] cli: Fix diff for nested set unchanged elements Unchanged elements in nested attributes backed by sets were previously misrendered as empty objects. This commit removes the additional brackets and adds a count of unchanged elements. --- internal/command/format/diff.go | 10 +++++++++- internal/command/format/diff_test.go | 9 +++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index 4aafe9dbeb1c..b8e97c7c70a3 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -569,6 +569,8 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( p.buf.WriteString(" = [") + var unchanged int + for it := all.ElementIterator(); it.Next(); { _, val := it.Element() var action plans.Action @@ -598,12 +600,17 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( newValue = val } + if action == plans.NoOp { + unchanged++ + continue + } + p.buf.WriteString("\n") p.buf.WriteString(strings.Repeat(" ", indent+4)) p.writeActionSymbol(action) p.buf.WriteString("{") - if action != plans.NoOp && (p.pathForcesNewResource(path) || p.pathForcesNewResource(path[:len(path)-1])) { + if p.pathForcesNewResource(path) || p.pathForcesNewResource(path[:len(path)-1]) { p.buf.WriteString(p.color.Color(forcesNewResourceCaption)) } @@ -615,6 +622,7 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( p.buf.WriteString("},") } p.buf.WriteString("\n") + p.writeSkippedElems(unchanged, indent+4) p.buf.WriteString(strings.Repeat(" ", indent+2)) p.buf.WriteString("]") diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index 3ac77b11074f..fd7f16163cf6 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -2822,6 +2822,10 @@ func TestResourceChange_nestedSet(t *testing.T) { "mount_point": cty.StringVal("/var/diska"), "size": cty.NullVal(cty.String), }), + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diskb"), + "size": cty.StringVal("100GB"), + }), }), "root_block_device": cty.SetVal([]cty.Value{ cty.ObjectVal(map[string]cty.Value{ @@ -2838,6 +2842,10 @@ func TestResourceChange_nestedSet(t *testing.T) { "mount_point": cty.StringVal("/var/diska"), "size": cty.StringVal("50GB"), }), + cty.ObjectVal(map[string]cty.Value{ + "mount_point": cty.StringVal("/var/diskb"), + "size": cty.StringVal("100GB"), + }), }), "root_block_device": cty.SetVal([]cty.Value{ cty.ObjectVal(map[string]cty.Value{ @@ -2859,6 +2867,7 @@ func TestResourceChange_nestedSet(t *testing.T) { - { - mount_point = "/var/diska" -> null }, + # (1 unchanged element hidden) ] id = "i-02ae66f368e8518a9" From b562c4fb84922d1e802a6cb2c7ff1b60a8c10031 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 19 Nov 2021 13:06:34 -0500 Subject: [PATCH 375/644] cli: Fix nested set diff rendering indentation --- internal/command/format/diff.go | 6 ++-- internal/command/format/diff_test.go | 46 ++++++++++++++-------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index b8e97c7c70a3..0179bb2d7b1c 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -615,14 +615,14 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( } path := append(path, cty.IndexStep{Key: val}) - p.writeAttrsDiff(objS.Attributes, oldValue, newValue, indent+6, path, result) + p.writeAttrsDiff(objS.Attributes, oldValue, newValue, indent+8, path, result) p.buf.WriteString("\n") - p.buf.WriteString(strings.Repeat(" ", indent+4)) + p.buf.WriteString(strings.Repeat(" ", indent+6)) p.buf.WriteString("},") } p.buf.WriteString("\n") - p.writeSkippedElems(unchanged, indent+4) + p.writeSkippedElems(unchanged, indent+6) p.buf.WriteString(strings.Repeat(" ", indent+2)) p.buf.WriteString("]") diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index fd7f16163cf6..79ef60ff8c70 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -2800,8 +2800,8 @@ func TestResourceChange_nestedSet(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ + { - + mount_point = "/var/diska" - }, + + mount_point = "/var/diska" + }, ] id = "i-02ae66f368e8518a9" @@ -2861,13 +2861,13 @@ func TestResourceChange_nestedSet(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ + { - + mount_point = "/var/diska" - + size = "50GB" - }, + + mount_point = "/var/diska" + + size = "50GB" + }, - { - - mount_point = "/var/diska" -> null - }, - # (1 unchanged element hidden) + - mount_point = "/var/diska" -> null + }, + # (1 unchanged element hidden) ] id = "i-02ae66f368e8518a9" @@ -2925,13 +2925,13 @@ func TestResourceChange_nestedSet(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - { # forces replacement - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, + { # forces replacement - + mount_point = "/var/diskb" - + size = "50GB" - }, + + mount_point = "/var/diskb" + + size = "50GB" + }, ] id = "i-02ae66f368e8518a9" @@ -2982,9 +2982,9 @@ func TestResourceChange_nestedSet(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - { - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, ] id = "i-02ae66f368e8518a9" @@ -3071,9 +3071,9 @@ func TestResourceChange_nestedSet(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" + disks = [ + { - + mount_point = "/var/diska" - + size = "50GB" - }, + + mount_point = "/var/diska" + + size = "50GB" + }, ] id = "i-02ae66f368e8518a9" @@ -3127,9 +3127,9 @@ func TestResourceChange_nestedSet(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = [ - { - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, ] -> (known after apply) id = "i-02ae66f368e8518a9" From 33d7c1e6d652d092318a3509972c121a1a7565f5 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 19 Nov 2021 11:54:06 -0600 Subject: [PATCH 376/644] command/init: Add -cloud alias (of -backend) This fixes an issue where a user could not disable initialization of the 'cloud' configuration block (As is possible with -backend=false), as well as add some syntactic sugar around -backend by adding a mutually exclusive -cloud alias. --- internal/command/arguments/flags.go | 11 +++++++++++ internal/command/init.go | 27 +++++++++++++++++++++++---- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/internal/command/arguments/flags.go b/internal/command/arguments/flags.go index d36486d948f2..ae47bc6e0468 100644 --- a/internal/command/arguments/flags.go +++ b/internal/command/arguments/flags.go @@ -84,3 +84,14 @@ type FlagNameValue struct { func (f FlagNameValue) String() string { return fmt.Sprintf("%s=%q", f.Name, f.Value) } + +// FlagIsSet returns whether a flag is explicitly set in a set of flags +func FlagIsSet(flags *flag.FlagSet, name string) bool { + isSet := false + flags.Visit(func(f *flag.Flag) { + if f.Name == name { + isSet = true + } + }) + return isSet +} diff --git a/internal/command/init.go b/internal/command/init.go index ac411e891d5a..2ec67113032e 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -16,6 +16,7 @@ import ( "github.com/hashicorp/terraform/internal/backend" backendInit "github.com/hashicorp/terraform/internal/backend/init" "github.com/hashicorp/terraform/internal/cloud" + "github.com/hashicorp/terraform/internal/command/arguments" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/getproviders" @@ -34,13 +35,14 @@ type InitCommand struct { func (c *InitCommand) Run(args []string) int { var flagFromModule, flagLockfile string - var flagBackend, flagGet, flagUpgrade bool + var flagBackend, flagCloud, flagGet, flagUpgrade bool var flagPluginPath FlagStringSlice flagConfigExtra := newRawFlags("-backend-config") args = c.Meta.process(args) cmdFlags := c.Meta.extendedFlagSet("init") cmdFlags.BoolVar(&flagBackend, "backend", true, "") + cmdFlags.BoolVar(&flagCloud, "cloud", true, "") cmdFlags.Var(flagConfigExtra, "backend-config", "") cmdFlags.StringVar(&flagFromModule, "from-module", "", "copy the source of the given module into the directory before init") cmdFlags.BoolVar(&flagGet, "get", true, "") @@ -58,6 +60,19 @@ func (c *InitCommand) Run(args []string) int { return 1 } + backendFlagSet := arguments.FlagIsSet(cmdFlags, "backend") + cloudFlagSet := arguments.FlagIsSet(cmdFlags, "cloud") + + switch { + case backendFlagSet && cloudFlagSet: + c.Ui.Error("The -backend and -cloud options are aliases of one another and mutually-exclusive in their use") + return 1 + case backendFlagSet: + flagCloud = flagBackend + case cloudFlagSet: + flagBackend = flagCloud + } + if c.migrateState && c.reconfigure { c.Ui.Error("The -migrate-state and -reconfigure options are mutually-exclusive") return 1 @@ -212,7 +227,7 @@ func (c *InitCommand) Run(args []string) int { var back backend.Backend switch { - case config.Module.CloudConfig != nil: + case flagCloud && config.Module.CloudConfig != nil: be, backendOutput, backendDiags := c.initCloud(config.Module, flagConfigExtra) diags = diags.Append(backendDiags) if backendDiags.HasErrors() { @@ -992,6 +1007,7 @@ func (c *InitCommand) AutocompleteArgs() complete.Predictor { func (c *InitCommand) AutocompleteFlags() complete.Flags { return complete.Flags{ "-backend": completePredictBoolean, + "-cloud": completePredictBoolean, "-backend-config": complete.PredictFiles("*.tfvars"), // can also be key=value, but we can't "predict" that "-force-copy": complete.PredictNothing, "-from-module": completePredictModuleSource, @@ -1026,8 +1042,11 @@ Usage: terraform [global options] init [options] Options: - -backend=false Disable backend initialization for this configuration - and use the previously initialized backend instead. + -backend=false Disable backend or Terraform Cloud initialization for + this configuration and use what what was previously + initialized instead. + + aliases: -cloud=false -backend-config=path This can be either a path to an HCL file with key/value assignments (same format as terraform.tfvars) or a From a0c7c1dc8d1773f55a70a2acbe2f966e1e1057bc Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 19 Nov 2021 13:53:09 -0600 Subject: [PATCH 377/644] command/init: Adjust init help output Some of the wording here needed adjusting with the change that backends largely reflect state snapshot storage (removing 'enhanced' designation), and that a 'backend' is not necessarily always present. --- internal/command/init.go | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/internal/command/init.go b/internal/command/init.go index 2ec67113032e..f10779a68120 100644 --- a/internal/command/init.go +++ b/internal/command/init.go @@ -1048,14 +1048,16 @@ Options: aliases: -cloud=false - -backend-config=path This can be either a path to an HCL file with key/value + -backend-config=path Configuration to be merged with what is in the + configuration file's 'backend' block. This can be + either a path to an HCL file with key/value assignments (same format as terraform.tfvars) or a - 'key=value' format. This is merged with what is in the - configuration file. This can be specified multiple + 'key=value' format, and can be specified multiple times. The backend type must be in the configuration itself. - -force-copy Suppress prompts about copying state data. This is + -force-copy Suppress prompts about copying state data when + initializating a new state backend. This is equivalent to providing a "yes" to all confirmation prompts. @@ -1064,9 +1066,9 @@ Options: -get=false Disable downloading modules for this configuration. - -input=false Disable prompting for missing backend configuration - values. This will result in an error if the backend - configuration is not fully specified. + -input=false Disable interactive prompts. Note that some actions may + require interactive prompts and will error if input is + disabled. -lock=false Don't hold a state lock during backend migration. This is dangerous if others might concurrently run @@ -1081,10 +1083,10 @@ Options: automatic installation of plugins. This flag can be used multiple times. - -reconfigure Reconfigure the backend, ignoring any saved + -reconfigure Reconfigure a backend, ignoring any saved configuration. - -migrate-state Reconfigure the backend, and attempt to migrate any + -migrate-state Reconfigure a backend, and attempt to migrate any existing state. -upgrade Install the latest module and provider versions @@ -1095,8 +1097,12 @@ Options: -lockfile=MODE Set a dependency lockfile mode. Currently only "readonly" is valid. - -ignore-remote-version A rare option used for the remote backend only. See - the remote backend documentation for more information. + -ignore-remote-version A rare option used for Terraform Cloud and the remote backend + only. Set this to ignore checking that the local and remote + Terraform versions use compatible state representations, making + an operation proceed even when there is a potential mismatch. + See the documentation on configuring Terraform with + Terraform Cloud for more information. ` return strings.TrimSpace(helpText) From a8b9d086b201a0168b3286642b58a073c31d7b3a Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 19 Nov 2021 15:19:08 -0500 Subject: [PATCH 378/644] cli: Fix nested single and map diff rendering Indentation was out by two spaces. This is now consistent with the other displays of object/map values: four spaces for each nesting level. --- internal/command/format/diff.go | 14 +++---- internal/command/format/diff_test.go | 58 ++++++++++++++-------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index 0179bb2d7b1c..3d08109e545b 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -461,10 +461,10 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( if action != plans.NoOp && (p.pathForcesNewResource(path) || p.pathForcesNewResource(path[:len(path)-1])) { p.buf.WriteString(p.color.Color(forcesNewResourceCaption)) } - p.writeAttrsDiff(objS.Attributes, old, new, indent+2, path, result) - p.writeSkippedAttr(result.skippedAttributes, indent+4) + p.writeAttrsDiff(objS.Attributes, old, new, indent+4, path, result) + p.writeSkippedAttr(result.skippedAttributes, indent+6) p.buf.WriteString("\n") - p.buf.WriteString(strings.Repeat(" ", indent)) + p.buf.WriteString(strings.Repeat(" ", indent+2)) p.buf.WriteString("}") case configschema.NestingList: @@ -690,15 +690,15 @@ func (p *blockBodyDiffPrinter) writeNestedAttrDiff( } path := append(path, cty.IndexStep{Key: cty.StringVal(k)}) - p.writeAttrsDiff(objS.Attributes, oldValue, newValue, indent+6, path, result) - p.writeSkippedAttr(result.skippedAttributes, indent+8) + p.writeAttrsDiff(objS.Attributes, oldValue, newValue, indent+8, path, result) + p.writeSkippedAttr(result.skippedAttributes, indent+10) p.buf.WriteString("\n") - p.buf.WriteString(strings.Repeat(" ", indent+4)) + p.buf.WriteString(strings.Repeat(" ", indent+6)) p.buf.WriteString("},\n") } } - p.writeSkippedElems(unchanged, indent+4) + p.writeSkippedElems(unchanged, indent+6) p.buf.WriteString(strings.Repeat(" ", indent+2)) p.buf.WriteString("}") if !new.IsKnown() { diff --git a/internal/command/format/diff_test.go b/internal/command/format/diff_test.go index 79ef60ff8c70..466e72fd85f0 100644 --- a/internal/command/format/diff_test.go +++ b/internal/command/format/diff_test.go @@ -354,9 +354,9 @@ new line ExpectedOutput: ` # test_instance.example will be created + resource "test_instance" "example" { + conn_info = { - + password = (sensitive value) - + user = "not-secret" - } + + password = (sensitive value) + + user = "not-secret" + } + id = (known after apply) + password = (sensitive value) } @@ -3179,8 +3179,8 @@ func TestResourceChange_nestedMap(t *testing.T) { + ami = "ami-AFTER" + disks = { + "disk_a" = { - + mount_point = "/var/diska" - }, + + mount_point = "/var/diska" + }, } + id = "i-02ae66f368e8518a9" @@ -3226,8 +3226,8 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { + "disk_a" = { - + mount_point = "/var/diska" - }, + + mount_point = "/var/diska" + }, } id = "i-02ae66f368e8518a9" @@ -3279,9 +3279,9 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { ~ "disk_a" = { - + size = "50GB" - # (1 unchanged attribute hidden) - }, + + size = "50GB" + # (1 unchanged attribute hidden) + }, } id = "i-02ae66f368e8518a9" @@ -3342,10 +3342,10 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { + "disk_2" = { - + mount_point = "/var/disk2" - + size = "50GB" - }, - # (1 unchanged element hidden) + + mount_point = "/var/disk2" + + size = "50GB" + }, + # (1 unchanged element hidden) } id = "i-02ae66f368e8518a9" @@ -3409,9 +3409,9 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { ~ "disk_a" = { # forces replacement - ~ size = "50GB" -> "100GB" - # (1 unchanged attribute hidden) - }, + ~ size = "50GB" -> "100GB" + # (1 unchanged attribute hidden) + }, } id = "i-02ae66f368e8518a9" @@ -3460,9 +3460,9 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { - "disk_a" = { - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, } id = "i-02ae66f368e8518a9" @@ -3513,9 +3513,9 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { - "disk_a" = { - - mount_point = "/var/diska" -> null - - size = "50GB" -> null - }, + - mount_point = "/var/diska" -> null + - size = "50GB" -> null + }, } -> (known after apply) id = "i-02ae66f368e8518a9" @@ -3572,9 +3572,9 @@ func TestResourceChange_nestedMap(t *testing.T) { ~ ami = "ami-BEFORE" -> "ami-AFTER" ~ disks = { + "disk_a" = { - + mount_point = (sensitive) - + size = "50GB" - }, + + mount_point = (sensitive) + + size = "50GB" + }, } id = "i-02ae66f368e8518a9" @@ -4742,9 +4742,9 @@ func TestResourceChange_sensitiveVariable(t *testing.T) { ExpectedOutput: ` # test_instance.example must be replaced -/+ resource "test_instance" "example" { ~ conn_info = { # forces replacement - ~ password = (sensitive value) - # (1 unchanged attribute hidden) - } + ~ password = (sensitive value) + # (1 unchanged attribute hidden) + } id = "i-02ae66f368e8518a9" } `, From f63b6198ca78a16f2ebd895d7b40e1670e14dc31 Mon Sep 17 00:00:00 2001 From: Luces Huayhuaca <21225410+uturunku1@users.noreply.github.com> Date: Mon, 22 Nov 2021 13:32:34 -0800 Subject: [PATCH 379/644] Create a function for logic that assigns value to initReason var after changing backend configuration (#29967) * Create a function for logic that assigns value to initReason var after changing backend configuration Create func determineInitReason() for logic block that assigns value to initReason var after changing backend/cloud configuration block or migrating to a different type of backend configuration. Also clarify 'cloud' configuration block message to say 'Terraform Cloud configuration block has changed' instead of 'Terraform Cloud configuration has changed'. --- internal/command/meta_backend.go | 83 ++++++++++++++++++-------------- 1 file changed, 46 insertions(+), 37 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index ecc00a386304..4e0b095550f6 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -672,44 +672,10 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di cloudMode := cloud.DetectConfigChangeType(s.Backend, c, false) - initReason := "" - switch cloudMode { - case cloud.ConfigMigrationIn: - initReason = fmt.Sprintf("Changed from backend %q to Terraform Cloud", s.Backend.Type) - case cloud.ConfigMigrationOut: - initReason = fmt.Sprintf("Changed from Terraform Cloud to backend %q", s.Backend.Type) - case cloud.ConfigChangeInPlace: - initReason = "Terraform Cloud configuration has changed" - default: - switch { - case s.Backend.Type != c.Type: - initReason = fmt.Sprintf("Backend type changed from %q to %q", s.Backend.Type, c.Type) - default: - initReason = fmt.Sprintf("Configuration changed for backend %q", c.Type) - } - } - if !opts.Init { - switch cloudMode { - case cloud.ConfigChangeInPlace: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Terraform Cloud initialization required: please run \"terraform init\"", - fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), - )) - case cloud.ConfigMigrationIn: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Terraform Cloud initialization required: please run \"terraform init\"", - fmt.Sprintf(strings.TrimSpace(errBackendInitCloudMigration), initReason), - )) - default: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Backend initialization required: please run \"terraform init\"", - fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), - )) - } + //user ran another cmd that is not init but they are required to initialize because of a potential relevant change to their backend configuration + initDiag := m.determineInitReason(s.Backend.Type, c.Type, cloudMode) + diags = diags.Append(initDiag) return nil, diags } @@ -733,6 +699,49 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di } } +func (m *Meta) determineInitReason(previousBackendType string, currentBackendType string, cloudMode cloud.ConfigChangeMode) tfdiags.Diagnostics { + initReason := "" + switch cloudMode { + case cloud.ConfigMigrationIn: + initReason = fmt.Sprintf("Changed from backend %q to Terraform Cloud", previousBackendType) + case cloud.ConfigMigrationOut: + initReason = fmt.Sprintf("Changed from Terraform Cloud to backend %q", previousBackendType) + case cloud.ConfigChangeInPlace: + initReason = "Terraform Cloud configuration block has changed" + default: + switch { + case previousBackendType != currentBackendType: + initReason = fmt.Sprintf("Backend type changed from %q to %q", previousBackendType, currentBackendType) + default: + initReason = "Backend configuration block has changed" + } + } + + var diags tfdiags.Diagnostics + switch cloudMode { + case cloud.ConfigChangeInPlace: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Terraform Cloud initialization required: please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), + )) + case cloud.ConfigMigrationIn: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Terraform Cloud initialization required: please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInitCloudMigration), initReason), + )) + default: + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Backend initialization required: please run \"terraform init\"", + fmt.Sprintf(strings.TrimSpace(errBackendInit), initReason), + )) + } + + return diags +} + // backendFromState returns the initialized (not configured) backend directly // from the state. This should be used only when a user runs `terraform init // -backend=false`. This function returns a local backend if there is no state From 3cb12b5a52c52918391bf506df7bb5d8a9020f43 Mon Sep 17 00:00:00 2001 From: Dylan Staley <88163+dstaley@users.noreply.github.com> Date: Mon, 22 Nov 2021 15:47:36 -0800 Subject: [PATCH 380/644] migrate docs to mdx --- .../cli/auth/{index.html.md => index.mdx} | 18 +- .../cli/code/{index.html.md => index.mdx} | 25 +- .../{0.12upgrade.html.md => 0.12upgrade.mdx} | 19 +- .../{0.13upgrade.html.md => 0.13upgrade.mdx} | 13 +- .../cli/commands/{apply.html.md => apply.mdx} | 40 ++-- .../commands/{console.html.md => console.mdx} | 23 +- .../commands/{destroy.html.md => destroy.mdx} | 12 +- website/docs/cli/commands/env.html.md | 12 - website/docs/cli/commands/env.mdx | 12 + .../cli/commands/{fmt.html.md => fmt.mdx} | 12 +- ...{force-unlock.html.md => force-unlock.mdx} | 10 +- .../cli/commands/{get.html.md => get.mdx} | 10 +- .../cli/commands/{graph.html.md => graph.mdx} | 19 +- .../commands/{import.html.md => import.mdx} | 38 ++- .../cli/commands/{index.html.md => index.mdx} | 14 +- .../cli/commands/{init.html.md => init.mdx} | 48 ++-- .../cli/commands/{login.html.md => login.mdx} | 16 +- .../commands/{logout.html.md => logout.mdx} | 11 +- .../commands/{output.html.md => output.mdx} | 25 +- .../cli/commands/{plan.html.md => plan.mdx} | 123 +++++----- .../{providers.html.md => providers.mdx} | 10 +- .../providers/{lock.html.md => lock.mdx} | 56 +++-- .../providers/{mirror.html.md => mirror.mdx} | 8 +- .../providers/{schema.html.md => schema.mdx} | 14 +- .../cli/commands/{push.html.md => push.mdx} | 12 +- .../commands/{refresh.html.md => refresh.mdx} | 14 +- .../cli/commands/{show.html.md => show.mdx} | 15 +- .../state/{index.html.md => index.mdx} | 11 +- .../commands/state/{list.html.md => list.mdx} | 15 +- .../cli/commands/state/{mv.html.md => mv.mdx} | 40 ++-- .../commands/state/{pull.html.md => pull.mdx} | 11 +- website/docs/cli/commands/state/push.html.md | 50 ---- website/docs/cli/commands/state/push.mdx | 47 ++++ ...-provider.html.md => replace-provider.mdx} | 24 +- .../cli/commands/state/{rm.html.md => rm.mdx} | 31 ++- .../commands/state/{show.html.md => show.mdx} | 21 +- .../cli/commands/{taint.html.md => taint.mdx} | 26 +-- .../cli/commands/{test.html.md => test.mdx} | 9 +- .../commands/{untaint.html.md => untaint.mdx} | 20 +- .../{validate.html.md => validate.mdx} | 141 ++++++----- .../commands/{version.html.md => version.mdx} | 14 +- .../workspace/{delete.html.md => delete.mdx} | 11 +- .../workspace/{index.html.md => index.mdx} | 9 +- .../workspace/{list.html.md => list.mdx} | 7 +- .../workspace/{new.html.md => new.mdx} | 11 +- .../workspace/{select.html.md => select.mdx} | 7 +- .../workspace/{show.html.md => show.mdx} | 7 +- .../{config-file.html.md => config-file.mdx} | 84 +++---- ...bles.html.md => environment-variables.mdx} | 22 +- .../cli/config/{index.html.md => index.mdx} | 12 +- ...mportability.html.md => importability.mdx} | 6 +- .../cli/import/{index.html.md => index.mdx} | 14 +- .../cli/import/{usage.html.md => usage.mdx} | 13 +- website/docs/cli/{index.html.md => index.mdx} | 10 +- .../cli/init/{index.html.md => index.mdx} | 15 +- .../cli/inspect/{index.html.md => index.mdx} | 20 +- .../docs/cli/install/{apt.html.md => apt.mdx} | 13 +- .../docs/cli/install/{yum.html.md => yum.mdx} | 13 +- .../cli/plugins/{index.html.md => index.mdx} | 26 ++- .../plugins/{signing.html.md => signing.mdx} | 15 +- .../docs/cli/run/{index.html.md => index.mdx} | 18 +- .../cli/state/{index.html.md => index.mdx} | 20 +- .../state/{inspect.html.md => inspect.mdx} | 12 +- .../docs/cli/state/{move.html.md => move.mdx} | 16 +- .../state/{recover.html.md => recover.mdx} | 15 +- ...essing.html.md => resource-addressing.mdx} | 38 ++- .../cli/state/{taint.html.md => taint.mdx} | 12 +- .../workspaces/{index.html.md => index.mdx} | 36 +-- .../docs/configuration/expressions.html.md | 157 ------------- website/docs/configuration/expressions.mdx | 122 ++++++++++ website/docs/configuration/index.mdx | 5 + website/docs/configuration/modules.html.md | 54 ----- website/docs/configuration/modules.mdx | 40 ++++ website/docs/configuration/resources.html.md | 135 ----------- website/docs/configuration/resources.mdx | 94 ++++++++ .../{archiving.html.md => archiving.mdx} | 12 +- ...elpers.html.md => credentials-helpers.mdx} | 23 +- .../{debugging.html.md => debugging.mdx} | 11 +- website/docs/internals/graph.html.md | 121 ---------- website/docs/internals/graph.mdx | 123 ++++++++++ .../internals/{index.html.md => index.mdx} | 8 +- .../{json-format.html.md => json-format.mdx} | 19 +- website/docs/internals/lifecycle.html.md | 58 ----- website/docs/internals/lifecycle.mdx | 59 +++++ ...tocol.html.markdown => login-protocol.mdx} | 17 +- ...ble-ui.html.md => machine-readable-ui.mdx} | 35 ++- ...l.html.md => module-registry-protocol.mdx} | 36 ++- ...rovider-meta.html.md => provider-meta.mdx} | 9 +- ...d => provider-network-mirror-protocol.mdx} | 42 ++-- ...html.md => provider-registry-protocol.mdx} | 76 +++--- ...y.html.md => remote-service-discovery.mdx} | 12 +- ...r-as-blocks.html.md => attr-as-blocks.mdx} | 25 +- .../data-sources/{index.html.md => index.mdx} | 37 +-- ...dency-lock.html.md => dependency-lock.mdx} | 90 +++---- ...{conditionals.html.md => conditionals.mdx} | 10 +- ...amic-blocks.html.md => dynamic-blocks.mdx} | 23 +- .../expressions/{for.html.md => for.mdx} | 12 +- ...ction-calls.html.md => function-calls.mdx} | 26 ++- .../expressions/{index.html.md => index.mdx} | 34 +-- .../{operators.html.md => operators.mdx} | 12 +- .../{references.html.md => references.mdx} | 109 ++++----- .../expressions/{splat.html.md => splat.mdx} | 14 +- .../{strings.html.md => strings.mdx} | 64 ++--- ...nstraints.html.md => type-constraints.mdx} | 105 ++++----- .../expressions/{types.html.md => types.mdx} | 15 +- ...raints.html.md => version-constraints.mdx} | 16 +- .../files/{index.html.md => index.mdx} | 13 +- .../files/{override.html.md => override.mdx} | 9 +- .../functions/{abs.html.md => abs.mdx} | 8 +- .../{abspath.html.md => abspath.mdx} | 10 +- .../{alltrue.html.md => alltrue.mdx} | 3 +- .../{anytrue.html.md => anytrue.mdx} | 3 +- ...{base64decode.html.md => base64decode.mdx} | 18 +- ...{base64encode.html.md => base64encode.mdx} | 18 +- .../{base64gzip.html.md => base64gzip.mdx} | 9 +- ...{base64sha256.html.md => base64sha256.mdx} | 11 +- ...{base64sha512.html.md => base64sha512.mdx} | 11 +- .../{basename.html.md => basename.mdx} | 9 +- .../functions/{bcrypt.html.md => bcrypt.mdx} | 5 +- .../functions/{can.html.md => can.mdx} | 13 +- .../functions/{ceil.html.md => ceil.mdx} | 7 +- .../functions/{chomp.html.md => chomp.mdx} | 10 +- .../{chunklist.html.md => chunklist.mdx} | 5 +- .../{cidrhost.html.md => cidrhost.mdx} | 9 +- .../{cidrnetmask.html.md => cidrnetmask.mdx} | 5 +- .../{cidrsubnet.html.md => cidrsubnet.mdx} | 17 +- .../{cidrsubnets.html.md => cidrsubnets.mdx} | 15 +- .../{coalesce.html.md => coalesce.mdx} | 7 +- ...{coalescelist.html.md => coalescelist.mdx} | 7 +- .../docs/language/functions/compact.html.md | 23 -- website/docs/language/functions/compact.mdx | 21 ++ .../docs/language/functions/concat.html.md | 23 -- website/docs/language/functions/concat.mdx | 21 ++ .../{contains.html.md => contains.mdx} | 8 +- .../{csvdecode.html.md => csvdecode.mdx} | 12 +- .../{defaults.html.md => defaults.mdx} | 12 +- .../{dirname.html.md => dirname.mdx} | 12 +- .../{distinct.html.md => distinct.mdx} | 8 +- .../{element.html.md => element.mdx} | 14 +- .../functions/{file.html.md => file.mdx} | 11 +- .../{filebase64.html.md => filebase64.mdx} | 9 +- ...e64sha256.html.md => filebase64sha256.mdx} | 9 +- ...e64sha512.html.md => filebase64sha512.mdx} | 9 +- .../{fileexists.html.md => fileexists.mdx} | 10 +- .../{filemd5.html.md => filemd5.mdx} | 9 +- .../{fileset.html.md => fileset.mdx} | 14 +- .../{filesha1.html.md => filesha1.mdx} | 9 +- .../{filesha256.html.md => filesha256.mdx} | 9 +- .../{filesha512.html.md => filesha512.mdx} | 9 +- .../{flatten.html.md => flatten.mdx} | 14 +- .../functions/{floor.html.md => floor.mdx} | 7 +- .../functions/{format.html.md => format.mdx} | 9 +- .../language/functions/formatdate.html.md | 108 --------- .../docs/language/functions/formatdate.mdx | 106 +++++++++ .../{formatlist.html.md => formatlist.mdx} | 9 +- .../functions/{indent.html.md => indent.mdx} | 5 +- .../functions/{index.html.md => index.mdx} | 13 +- ...ex_function.html.md => index_function.mdx} | 10 +- .../functions/{join.html.md => join.mdx} | 7 +- .../{jsondecode.html.md => jsondecode.mdx} | 9 +- .../{jsonencode.html.md => jsonencode.mdx} | 12 +- .../functions/{keys.html.md => keys.mdx} | 10 +- .../functions/{length.html.md => length.mdx} | 8 +- .../functions/{list.html.md => list.mdx} | 14 +- .../functions/{log.html.md => log.mdx} | 8 +- .../functions/{lookup.html.md => lookup.mdx} | 10 +- .../functions/{lower.html.md => lower.mdx} | 14 +- .../functions/{map.html.md => map.mdx} | 14 +- .../{matchkeys.html.md => matchkeys.mdx} | 5 +- .../functions/{max.html.md => max.mdx} | 10 +- .../functions/{md5.html.md => md5.mdx} | 7 +- .../functions/{merge.html.md => merge.mdx} | 7 +- .../functions/{min.html.md => min.mdx} | 10 +- ...{nonsensitive.html.md => nonsensitive.mdx} | 10 +- .../functions/{one.html.md => one.mdx} | 7 +- .../{parseint.html.md => parseint.mdx} | 12 +- .../{pathexpand.html.md => pathexpand.mdx} | 5 +- website/docs/language/functions/pow.html.md | 20 -- website/docs/language/functions/pow.mdx | 18 ++ .../functions/{range.html.md => range.mdx} | 8 +- website/docs/language/functions/regex.html.md | 163 ------------- website/docs/language/functions/regex.mdx | 162 +++++++++++++ .../{regexall.html.md => regexall.mdx} | 14 +- .../{replace.html.md => replace.mdx} | 9 +- .../{reverse.html.md => reverse.mdx} | 10 +- .../{rsadecrypt.html.md => rsadecrypt.mdx} | 8 +- .../{sensitive.html.md => sensitive.mdx} | 10 +- ...tersection.html.md => setintersection.mdx} | 15 +- .../{setproduct.html.md => setproduct.mdx} | 19 +- .../{setsubtract.html.md => setsubtract.mdx} | 14 +- .../{setunion.html.md => setunion.mdx} | 15 +- .../functions/{sha1.html.md => sha1.mdx} | 7 +- .../functions/{sha256.html.md => sha256.mdx} | 10 +- .../functions/{sha512.html.md => sha512.mdx} | 9 +- .../functions/{signum.html.md => signum.mdx} | 8 +- .../functions/{slice.html.md => slice.mdx} | 10 +- .../functions/{sort.html.md => sort.mdx} | 5 +- .../functions/{split.html.md => split.mdx} | 7 +- .../functions/{strrev.html.md => strrev.mdx} | 10 +- .../functions/{substr.html.md => substr.mdx} | 5 +- .../functions/{sum.html.md => sum.mdx} | 8 +- ...{templatefile.html.md => templatefile.mdx} | 21 +- ...odebase64.html.md => textdecodebase64.mdx} | 20 +- ...odebase64.html.md => textencodebase64.mdx} | 19 +- .../{timeadd.html.md => timeadd.mdx} | 5 +- .../{timestamp.html.md => timestamp.mdx} | 9 +- .../functions/{title.html.md => title.mdx} | 9 +- .../functions/{tobool.html.md => tobool.mdx} | 8 +- .../functions/{tolist.html.md => tolist.mdx} | 8 +- .../functions/{tomap.html.md => tomap.mdx} | 8 +- .../{tonumber.html.md => tonumber.mdx} | 8 +- .../functions/{toset.html.md => toset.mdx} | 8 +- .../{tostring.html.md => tostring.mdx} | 8 +- .../{transpose.html.md => transpose.mdx} | 5 +- .../functions/{trim.html.md => trim.mdx} | 21 +- .../{trimprefix.html.md => trimprefix.mdx} | 11 +- .../{trimspace.html.md => trimspace.mdx} | 7 +- .../language/functions/trimsuffix.html.md | 26 --- .../docs/language/functions/trimsuffix.mdx | 25 ++ .../functions/{try.html.md => try.mdx} | 7 +- .../functions/{type.html.md => type.mdx} | 10 +- .../functions/{upper.html.md => upper.mdx} | 14 +- .../{urlencode.html.md => urlencode.mdx} | 8 +- .../functions/{uuid.html.md => uuid.mdx} | 14 +- .../functions/{uuidv5.html.md => uuidv5.mdx} | 26 +-- .../functions/{values.html.md => values.mdx} | 12 +- .../{yamldecode.html.md => yamldecode.mdx} | 11 +- .../{yamlencode.html.md => yamlencode.mdx} | 18 +- .../functions/{zipmap.html.md => zipmap.mdx} | 5 +- .../language/{index.html.md => index.mdx} | 17 +- .../{count.html.md => count.mdx} | 16 +- .../{depends_on.html.md => depends_on.mdx} | 9 +- .../{for_each.html.md => for_each.mdx} | 38 +-- .../language/meta-arguments/lifecycle.html.md | 116 --------- .../language/meta-arguments/lifecycle.mdx | 118 ++++++++++ ...providers.html.md => module-providers.mdx} | 16 +- ...provider.html.md => resource-provider.mdx} | 12 +- .../{composition.html.md => composition.mdx} | 8 +- .../develop/{index.html.md => index.mdx} | 28 +-- .../{providers.html.md => providers.mdx} | 16 +- .../develop/{publish.html.md => publish.mdx} | 18 +- .../{refactoring.html.md => refactoring.mdx} | 28 +-- .../{structure.html.md => structure.mdx} | 9 +- .../modules/{index.html.md => index.mdx} | 26 ++- .../modules/{sources.html.md => sources.mdx} | 47 ++-- .../modules/{syntax.html.md => syntax.mdx} | 38 +-- ...eriment.html.md => testing-experiment.mdx} | 4 +- ...onfiguration.html.md => configuration.mdx} | 27 +-- .../providers/{index.html.md => index.mdx} | 64 ++--- ...{requirements.html.md => requirements.mdx} | 41 ++-- .../{behavior.html.md => behavior.mdx} | 21 +- .../resources/{index.html.md => index.mdx} | 24 +- .../provisioners/{chef.html.md => chef.mdx} | 23 +- .../{connection.html.md => connection.mdx} | 35 +-- .../provisioners/{file.html.md => file.mdx} | 14 +- .../{habitat.html.md => habitat.mdx} | 20 +- .../resources/provisioners/index.html.md | 12 - .../language/resources/provisioners/index.mdx | 13 ++ .../{local-exec.html.md => local-exec.mdx} | 16 +- ...ull_resource.html.md => null_resource.mdx} | 18 +- .../{puppet.html.md => puppet.mdx} | 15 +- .../{remote-exec.html.md => remote-exec.mdx} | 22 +- .../provisioners/salt-masterless.html.md | 92 -------- .../provisioners/salt-masterless.mdx | 91 ++++++++ .../{syntax.html.md => syntax.mdx} | 26 ++- .../resources/{syntax.html.md => syntax.mdx} | 34 +-- .../{artifactory.html.md => artifactory.mdx} | 17 +- .../backends/{azurerm.html.md => azurerm.mdx} | 44 ++-- ...onfiguration.html.md => configuration.mdx} | 41 ++-- .../language/settings/backends/consul.html.md | 61 ----- .../language/settings/backends/consul.mdx | 58 +++++ .../backends/{cos.html.md => cos.mdx} | 29 ++- .../backends/{etcd.html.md => etcd.mdx} | 15 +- .../language/settings/backends/etcdv3.html.md | 57 ----- .../language/settings/backends/etcdv3.mdx | 54 +++++ .../backends/{gcs.html.md => gcs.mdx} | 65 +++--- .../language/settings/backends/http.html.md | 70 ------ .../docs/language/settings/backends/http.mdx | 67 ++++++ .../backends/{index.html.md => index.mdx} | 24 +- .../{kubernetes.html.md => kubernetes.mdx} | 16 +- .../backends/{local.html.md => local.mdx} | 33 ++- .../language/settings/backends/manta.html.md | 52 ----- .../docs/language/settings/backends/manta.mdx | 49 ++++ .../backends/{oss.html.md => oss.mdx} | 33 ++- .../language/settings/backends/pg.html.md | 92 -------- .../docs/language/settings/backends/pg.mdx | 89 +++++++ .../backends/{remote.html.md => remote.mdx} | 68 +++--- .../settings/backends/{s3.html.md => s3.mdx} | 17 +- .../backends/{swift.html.md => swift.mdx} | 20 +- .../settings/{index.html.md => index.mdx} | 21 +- .../state/{backends.html.md => backends.mdx} | 33 ++- .../state/{import.html.md => import.mdx} | 11 +- .../state/{index.html.md => index.mdx} | 28 +-- .../state/{locking.html.md => locking.mdx} | 15 +- .../state/{purpose.html.md => purpose.mdx} | 13 +- .../language/state/remote-state-data.html.md | 220 ------------------ .../docs/language/state/remote-state-data.mdx | 219 +++++++++++++++++ .../state/{remote.html.md => remote.mdx} | 17 +- ...sitive-data.html.md => sensitive-data.mdx} | 13 +- .../{workspaces.html.md => workspaces.mdx} | 51 ++-- ...onfiguration.html.md => configuration.mdx} | 13 +- .../syntax/{index.html.md => index.mdx} | 16 +- .../syntax/{json.html.md => json.mdx} | 19 +- .../syntax/{style.html.md => style.mdx} | 44 ++-- ....html.md => v1-compatibility-promises.mdx} | 115 +++++---- website/docs/language/values/index.html.md | 19 -- website/docs/language/values/index.mdx | 20 ++ .../values/{locals.html.md => locals.mdx} | 21 +- .../values/{outputs.html.md => outputs.mdx} | 26 +-- .../{variables.html.md => variables.mdx} | 68 +++--- ...ore-workflow.html.md => core-workflow.mdx} | 26 +-- website/guides/{index.html.md => index.mdx} | 6 +- ...l.md => terraform-integration-program.mdx} | 126 ++++------ ...erraform-provider-development-program.mdx} | 80 ++----- .../intro/{index.html.markdown => index.mdx} | 21 +- ...{use-cases.html.markdown => use-cases.mdx} | 11 +- .../intro/vs/{boto.html.markdown => boto.mdx} | 7 +- ...f-puppet.html.markdown => chef-puppet.mdx} | 9 +- ...ation.html.markdown => cloudformation.mdx} | 10 +- .../vs/{custom.html.markdown => custom.mdx} | 9 +- .../vs/{index.html.markdown => index.mdx} | 7 +- 321 files changed, 4229 insertions(+), 4608 deletions(-) rename website/docs/cli/auth/{index.html.md => index.mdx} (64%) rename website/docs/cli/code/{index.html.md => index.mdx} (65%) rename website/docs/cli/commands/{0.12upgrade.html.md => 0.12upgrade.mdx} (90%) rename website/docs/cli/commands/{0.13upgrade.html.md => 0.13upgrade.mdx} (92%) rename website/docs/cli/commands/{apply.html.md => apply.mdx} (82%) rename website/docs/cli/commands/{console.html.md => console.mdx} (77%) rename website/docs/cli/commands/{destroy.html.md => destroy.mdx} (78%) delete mode 100644 website/docs/cli/commands/env.html.md create mode 100644 website/docs/cli/commands/env.mdx rename website/docs/cli/commands/{fmt.html.md => fmt.mdx} (89%) rename website/docs/cli/commands/{force-unlock.html.md => force-unlock.mdx} (71%) rename website/docs/cli/commands/{get.html.md => get.mdx} (60%) rename website/docs/cli/commands/{graph.html.md => graph.mdx} (74%) rename website/docs/cli/commands/{import.html.md => import.mdx} (79%) rename website/docs/cli/commands/{index.html.md => index.mdx} (93%) rename website/docs/cli/commands/{init.html.md => init.mdx} (83%) rename website/docs/cli/commands/{login.html.md => login.mdx} (72%) rename website/docs/cli/commands/{logout.html.md => logout.mdx} (79%) rename website/docs/cli/commands/{output.html.md => output.mdx} (81%) rename website/docs/cli/commands/{plan.html.md => plan.mdx} (78%) rename website/docs/cli/commands/{providers.html.md => providers.mdx} (55%) rename website/docs/cli/commands/providers/{lock.html.md => lock.mdx} (76%) rename website/docs/cli/commands/providers/{mirror.html.md => mirror.mdx} (89%) rename website/docs/cli/commands/providers/{schema.html.md => schema.mdx} (93%) rename website/docs/cli/commands/{push.html.md => push.mdx} (61%) rename website/docs/cli/commands/{refresh.html.md => refresh.mdx} (88%) rename website/docs/cli/commands/{show.html.md => show.mdx} (81%) rename website/docs/cli/commands/state/{index.html.md => index.mdx} (82%) rename website/docs/cli/commands/state/{list.html.md => list.mdx} (84%) rename website/docs/cli/commands/state/{mv.html.md => mv.mdx} (81%) rename website/docs/cli/commands/state/{pull.html.md => pull.mdx} (77%) delete mode 100644 website/docs/cli/commands/state/push.html.md create mode 100644 website/docs/cli/commands/state/push.mdx rename website/docs/cli/commands/state/{replace-provider.html.md => replace-provider.mdx} (65%) rename website/docs/cli/commands/state/{rm.html.md => rm.mdx} (80%) rename website/docs/cli/commands/state/{show.html.md => show.mdx} (78%) rename website/docs/cli/commands/{taint.html.md => taint.mdx} (73%) rename website/docs/cli/commands/{test.html.md => test.mdx} (52%) rename website/docs/cli/commands/{untaint.html.md => untaint.mdx} (78%) rename website/docs/cli/commands/{validate.html.md => validate.mdx} (56%) rename website/docs/cli/commands/{version.html.md => version.mdx} (75%) rename website/docs/cli/commands/workspace/{delete.html.md => delete.mdx} (81%) rename website/docs/cli/commands/workspace/{index.html.md => index.mdx} (60%) rename website/docs/cli/commands/workspace/{list.html.md => list.mdx} (64%) rename website/docs/cli/commands/workspace/{new.html.md => new.mdx} (83%) rename website/docs/cli/commands/workspace/{select.html.md => select.mdx} (69%) rename website/docs/cli/commands/workspace/{show.html.md => show.mdx} (57%) rename website/docs/cli/config/{config-file.html.md => config-file.mdx} (86%) rename website/docs/cli/config/{environment-variables.html.md => environment-variables.mdx} (88%) rename website/docs/cli/config/{index.html.md => index.mdx} (68%) rename website/docs/cli/import/{importability.html.md => importability.mdx} (82%) rename website/docs/cli/import/{index.html.md => index.mdx} (81%) rename website/docs/cli/import/{usage.html.md => usage.mdx} (90%) rename website/docs/cli/{index.html.md => index.mdx} (67%) rename website/docs/cli/init/{index.html.md => index.mdx} (85%) rename website/docs/cli/inspect/{index.html.md => index.mdx} (63%) rename website/docs/cli/install/{apt.html.md => apt.mdx} (94%) rename website/docs/cli/install/{yum.html.md => yum.mdx} (91%) rename website/docs/cli/plugins/{index.html.md => index.mdx} (65%) rename website/docs/cli/plugins/{signing.html.md => signing.mdx} (70%) rename website/docs/cli/run/{index.html.md => index.mdx} (82%) rename website/docs/cli/state/{index.html.md => index.mdx} (66%) rename website/docs/cli/state/{inspect.html.md => inspect.mdx} (58%) rename website/docs/cli/state/{move.html.md => move.mdx} (69%) rename website/docs/cli/state/{recover.html.md => recover.mdx} (65%) rename website/docs/cli/state/{resource-addressing.html.md => resource-addressing.mdx} (69%) rename website/docs/cli/state/{taint.html.md => taint.mdx} (68%) rename website/docs/cli/workspaces/{index.html.md => index.mdx} (68%) delete mode 100644 website/docs/configuration/expressions.html.md create mode 100644 website/docs/configuration/expressions.mdx create mode 100644 website/docs/configuration/index.mdx delete mode 100644 website/docs/configuration/modules.html.md create mode 100644 website/docs/configuration/modules.mdx delete mode 100644 website/docs/configuration/resources.html.md create mode 100644 website/docs/configuration/resources.mdx rename website/docs/internals/{archiving.html.md => archiving.mdx} (75%) rename website/docs/internals/{credentials-helpers.html.md => credentials-helpers.mdx} (89%) rename website/docs/internals/{debugging.html.md => debugging.mdx} (89%) delete mode 100644 website/docs/internals/graph.html.md create mode 100644 website/docs/internals/graph.mdx rename website/docs/internals/{index.html.md => index.mdx} (68%) rename website/docs/internals/{json-format.html.md => json-format.mdx} (96%) delete mode 100644 website/docs/internals/lifecycle.html.md create mode 100644 website/docs/internals/lifecycle.mdx rename website/docs/internals/{login-protocol.html.markdown => login-protocol.mdx} (92%) rename website/docs/internals/{machine-readable-ui.html.md => machine-readable-ui.mdx} (94%) rename website/docs/internals/{module-registry-protocol.html.md => module-registry-protocol.mdx} (87%) rename website/docs/internals/{provider-meta.html.md => provider-meta.mdx} (96%) rename website/docs/internals/{provider-network-mirror-protocol.html.md => provider-network-mirror-protocol.mdx} (87%) rename website/docs/internals/{provider-registry-protocol.html.md => provider-registry-protocol.mdx} (84%) rename website/docs/internals/{remote-service-discovery.html.md => remote-service-discovery.mdx} (91%) rename website/docs/language/{attr-as-blocks.html.md => attr-as-blocks.mdx} (89%) rename website/docs/language/data-sources/{index.html.md => index.mdx} (86%) rename website/docs/language/{dependency-lock.html.md => dependency-lock.mdx} (82%) rename website/docs/language/expressions/{conditionals.html.md => conditionals.mdx} (87%) rename website/docs/language/expressions/{dynamic-blocks.html.md => dynamic-blocks.mdx} (88%) rename website/docs/language/expressions/{for.html.md => for.mdx} (94%) rename website/docs/language/expressions/{function-calls.html.md => function-calls.mdx} (81%) rename website/docs/language/expressions/{index.html.md => index.mdx} (67%) rename website/docs/language/expressions/{operators.html.md => operators.mdx} (92%) rename website/docs/language/expressions/{references.html.md => references.mdx} (80%) rename website/docs/language/expressions/{splat.html.md => splat.mdx} (89%) rename website/docs/language/expressions/{strings.html.md => strings.mdx} (80%) rename website/docs/language/expressions/{type-constraints.html.md => type-constraints.mdx} (75%) rename website/docs/language/expressions/{types.html.md => types.mdx} (92%) rename website/docs/language/expressions/{version-constraints.html.md => version-constraints.mdx} (85%) rename website/docs/language/files/{index.html.md => index.mdx} (84%) rename website/docs/language/files/{override.html.md => override.mdx} (95%) rename website/docs/language/functions/{abs.html.md => abs.mdx} (61%) rename website/docs/language/functions/{abspath.html.md => abspath.mdx} (67%) rename website/docs/language/functions/{alltrue.html.md => alltrue.mdx} (89%) rename website/docs/language/functions/{anytrue.html.md => anytrue.mdx} (90%) rename website/docs/language/functions/{base64decode.html.md => base64decode.mdx} (67%) rename website/docs/language/functions/{base64encode.html.md => base64encode.mdx} (70%) rename website/docs/language/functions/{base64gzip.html.md => base64gzip.mdx} (78%) rename website/docs/language/functions/{base64sha256.html.md => base64sha256.mdx} (72%) rename website/docs/language/functions/{base64sha512.html.md => base64sha512.mdx} (73%) rename website/docs/language/functions/{basename.html.md => basename.mdx} (80%) rename website/docs/language/functions/{bcrypt.html.md => bcrypt.mdx} (90%) rename website/docs/language/functions/{can.html.md => can.mdx} (83%) rename website/docs/language/functions/{ceil.html.md => ceil.mdx} (63%) rename website/docs/language/functions/{chomp.html.md => chomp.mdx} (56%) rename website/docs/language/functions/{chunklist.html.md => chunklist.mdx} (80%) rename website/docs/language/functions/{cidrhost.html.md => cidrhost.mdx} (87%) rename website/docs/language/functions/{cidrnetmask.html.md => cidrnetmask.mdx} (88%) rename website/docs/language/functions/{cidrsubnet.html.md => cidrsubnet.mdx} (91%) rename website/docs/language/functions/{cidrsubnets.html.md => cidrsubnets.mdx} (86%) rename website/docs/language/functions/{coalesce.html.md => coalesce.mdx} (85%) rename website/docs/language/functions/{coalescelist.html.md => coalescelist.mdx} (75%) delete mode 100644 website/docs/language/functions/compact.html.md create mode 100644 website/docs/language/functions/compact.mdx delete mode 100644 website/docs/language/functions/concat.html.md create mode 100644 website/docs/language/functions/concat.mdx rename website/docs/language/functions/{contains.html.md => contains.mdx} (54%) rename website/docs/language/functions/{csvdecode.html.md => csvdecode.mdx} (89%) rename website/docs/language/functions/{defaults.html.md => defaults.mdx} (93%) rename website/docs/language/functions/{dirname.html.md => dirname.mdx} (76%) rename website/docs/language/functions/{distinct.html.md => distinct.mdx} (60%) rename website/docs/language/functions/{element.html.md => element.mdx} (64%) rename website/docs/language/functions/{file.html.md => file.mdx} (79%) rename website/docs/language/functions/{filebase64.html.md => filebase64.mdx} (84%) rename website/docs/language/functions/{filebase64sha256.html.md => filebase64sha256.mdx} (53%) rename website/docs/language/functions/{filebase64sha512.html.md => filebase64sha512.mdx} (53%) rename website/docs/language/functions/{fileexists.html.md => fileexists.mdx} (68%) rename website/docs/language/functions/{filemd5.html.md => filemd5.mdx} (55%) rename website/docs/language/functions/{fileset.html.md => fileset.mdx} (82%) rename website/docs/language/functions/{filesha1.html.md => filesha1.mdx} (54%) rename website/docs/language/functions/{filesha256.html.md => filesha256.mdx} (54%) rename website/docs/language/functions/{filesha512.html.md => filesha512.mdx} (54%) rename website/docs/language/functions/{flatten.html.md => flatten.mdx} (87%) rename website/docs/language/functions/{floor.html.md => floor.mdx} (62%) rename website/docs/language/functions/{format.html.md => format.mdx} (95%) delete mode 100644 website/docs/language/functions/formatdate.html.md create mode 100644 website/docs/language/functions/formatdate.mdx rename website/docs/language/functions/{formatlist.html.md => formatlist.mdx} (81%) rename website/docs/language/functions/{indent.html.md => indent.mdx} (84%) rename website/docs/language/functions/{index.html.md => index.mdx} (76%) rename website/docs/language/functions/{index_function.html.md => index_function.mdx} (52%) rename website/docs/language/functions/{join.html.md => join.mdx} (71%) rename website/docs/language/functions/{jsondecode.html.md => jsondecode.mdx} (83%) rename website/docs/language/functions/{jsonencode.html.md => jsonencode.mdx} (78%) rename website/docs/language/functions/{keys.html.md => keys.mdx} (55%) rename website/docs/language/functions/{length.html.md => length.mdx} (81%) rename website/docs/language/functions/{list.html.md => list.mdx} (55%) rename website/docs/language/functions/{log.html.md => log.mdx} (65%) rename website/docs/language/functions/{lookup.html.md => lookup.mdx} (65%) rename website/docs/language/functions/{lower.html.md => lower.mdx} (52%) rename website/docs/language/functions/{map.html.md => map.mdx} (57%) rename website/docs/language/functions/{matchkeys.html.md => matchkeys.mdx} (93%) rename website/docs/language/functions/{max.html.md => max.mdx} (52%) rename website/docs/language/functions/{md5.html.md => md5.mdx} (81%) rename website/docs/language/functions/{merge.html.md => merge.mdx} (86%) rename website/docs/language/functions/{min.html.md => min.mdx} (52%) rename website/docs/language/functions/{nonsensitive.html.md => nonsensitive.mdx} (95%) rename website/docs/language/functions/{one.html.md => one.mdx} (94%) rename website/docs/language/functions/{parseint.html.md => parseint.mdx} (81%) rename website/docs/language/functions/{pathexpand.html.md => pathexpand.mdx} (93%) delete mode 100644 website/docs/language/functions/pow.html.md create mode 100644 website/docs/language/functions/pow.mdx rename website/docs/language/functions/{range.html.md => range.mdx} (93%) delete mode 100644 website/docs/language/functions/regex.html.md create mode 100644 website/docs/language/functions/regex.mdx rename website/docs/language/functions/{regexall.html.md => regexall.mdx} (80%) rename website/docs/language/functions/{replace.html.md => replace.mdx} (75%) rename website/docs/language/functions/{reverse.html.md => reverse.mdx} (53%) rename website/docs/language/functions/{rsadecrypt.html.md => rsadecrypt.mdx} (79%) rename website/docs/language/functions/{sensitive.html.md => sensitive.mdx} (79%) rename website/docs/language/functions/{setintersection.html.md => setintersection.mdx} (57%) rename website/docs/language/functions/{setproduct.html.md => setproduct.mdx} (91%) rename website/docs/language/functions/{setsubtract.html.md => setsubtract.mdx} (58%) rename website/docs/language/functions/{setunion.html.md => setunion.mdx} (55%) rename website/docs/language/functions/{sha1.html.md => sha1.mdx} (82%) rename website/docs/language/functions/{sha256.html.md => sha256.mdx} (73%) rename website/docs/language/functions/{sha512.html.md => sha512.mdx} (74%) rename website/docs/language/functions/{signum.html.md => signum.mdx} (50%) rename website/docs/language/functions/{slice.html.md => slice.mdx} (61%) rename website/docs/language/functions/{sort.html.md => sort.mdx} (78%) rename website/docs/language/functions/{split.html.md => split.mdx} (72%) rename website/docs/language/functions/{strrev.html.md => strrev.mdx} (63%) rename website/docs/language/functions/{substr.html.md => substr.mdx} (84%) rename website/docs/language/functions/{sum.html.md => sum.mdx} (67%) rename website/docs/language/functions/{templatefile.html.md => templatefile.mdx} (85%) rename website/docs/language/functions/{textdecodebase64.html.md => textdecodebase64.mdx} (75%) rename website/docs/language/functions/{textencodebase64.html.md => textencodebase64.mdx} (76%) rename website/docs/language/functions/{timeadd.html.md => timeadd.mdx} (88%) rename website/docs/language/functions/{timestamp.html.md => timestamp.mdx} (79%) rename website/docs/language/functions/{title.html.md => title.mdx} (58%) rename website/docs/language/functions/{tobool.html.md => tobool.mdx} (80%) rename website/docs/language/functions/{tolist.html.md => tolist.mdx} (80%) rename website/docs/language/functions/{tomap.html.md => tomap.mdx} (76%) rename website/docs/language/functions/{tonumber.html.md => tonumber.mdx} (77%) rename website/docs/language/functions/{toset.html.md => toset.mdx} (83%) rename website/docs/language/functions/{tostring.html.md => tostring.mdx} (76%) rename website/docs/language/functions/{transpose.html.md => transpose.mdx} (75%) rename website/docs/language/functions/{trim.html.md => trim.mdx} (53%) rename website/docs/language/functions/{trimprefix.html.md => trimprefix.mdx} (57%) rename website/docs/language/functions/{trimspace.html.md => trimspace.mdx} (69%) delete mode 100644 website/docs/language/functions/trimsuffix.html.md create mode 100644 website/docs/language/functions/trimsuffix.mdx rename website/docs/language/functions/{try.html.md => try.mdx} (95%) rename website/docs/language/functions/{type.html.md => type.mdx} (87%) rename website/docs/language/functions/{upper.html.md => upper.mdx} (52%) rename website/docs/language/functions/{urlencode.html.md => urlencode.mdx} (80%) rename website/docs/language/functions/{uuid.html.md => uuid.mdx} (70%) rename website/docs/language/functions/{uuidv5.html.md => uuidv5.mdx} (65%) rename website/docs/language/functions/{values.html.md => values.mdx} (53%) rename website/docs/language/functions/{yamldecode.html.md => yamldecode.mdx} (89%) rename website/docs/language/functions/{yamlencode.html.md => yamlencode.mdx} (80%) rename website/docs/language/functions/{zipmap.html.md => zipmap.mdx} (85%) rename website/docs/language/{index.html.md => index.mdx} (89%) rename website/docs/language/meta-arguments/{count.html.md => count.mdx} (89%) rename website/docs/language/meta-arguments/{depends_on.html.md => depends_on.mdx} (91%) rename website/docs/language/meta-arguments/{for_each.html.md => for_each.mdx} (83%) delete mode 100644 website/docs/language/meta-arguments/lifecycle.html.md create mode 100644 website/docs/language/meta-arguments/lifecycle.mdx rename website/docs/language/meta-arguments/{module-providers.html.md => module-providers.mdx} (88%) rename website/docs/language/meta-arguments/{resource-provider.html.md => resource-provider.mdx} (78%) rename website/docs/language/modules/develop/{composition.html.md => composition.mdx} (98%) rename website/docs/language/modules/develop/{index.html.md => index.mdx} (77%) rename website/docs/language/modules/develop/{providers.html.md => providers.mdx} (94%) rename website/docs/language/modules/develop/{publish.html.md => publish.mdx} (76%) rename website/docs/language/modules/develop/{refactoring.html.md => refactoring.mdx} (94%) rename website/docs/language/modules/develop/{structure.html.md => structure.mdx} (95%) rename website/docs/language/modules/{index.html.md => index.mdx} (71%) rename website/docs/language/modules/{sources.html.md => sources.mdx} (92%) rename website/docs/language/modules/{syntax.html.md => syntax.mdx} (83%) rename website/docs/language/modules/{testing-experiment.html.md => testing-experiment.mdx} (99%) rename website/docs/language/providers/{configuration.html.md => configuration.mdx} (86%) rename website/docs/language/providers/{index.html.md => index.mdx} (54%) rename website/docs/language/providers/{requirements.html.md => requirements.mdx} (91%) rename website/docs/language/resources/{behavior.html.md => behavior.mdx} (86%) rename website/docs/language/resources/{index.html.md => index.mdx} (55%) rename website/docs/language/resources/provisioners/{chef.html.md => chef.mdx} (93%) rename website/docs/language/resources/provisioners/{connection.html.md => connection.mdx} (80%) rename website/docs/language/resources/provisioners/{file.html.md => file.mdx} (89%) rename website/docs/language/resources/provisioners/{habitat.html.md => habitat.mdx} (94%) delete mode 100644 website/docs/language/resources/provisioners/index.html.md create mode 100644 website/docs/language/resources/provisioners/index.mdx rename website/docs/language/resources/provisioners/{local-exec.html.md => local-exec.mdx} (83%) rename website/docs/language/resources/provisioners/{null_resource.html.md => null_resource.mdx} (68%) rename website/docs/language/resources/provisioners/{puppet.html.md => puppet.mdx} (93%) rename website/docs/language/resources/provisioners/{remote-exec.html.md => remote-exec.mdx} (67%) delete mode 100644 website/docs/language/resources/provisioners/salt-masterless.html.md create mode 100644 website/docs/language/resources/provisioners/salt-masterless.mdx rename website/docs/language/resources/provisioners/{syntax.html.md => syntax.mdx} (93%) rename website/docs/language/resources/{syntax.html.md => syntax.mdx} (83%) rename website/docs/language/settings/backends/{artifactory.html.md => artifactory.mdx} (67%) rename website/docs/language/settings/backends/{azurerm.html.md => azurerm.mdx} (96%) rename website/docs/language/settings/backends/{configuration.html.md => configuration.mdx} (82%) delete mode 100644 website/docs/language/settings/backends/consul.html.md create mode 100644 website/docs/language/settings/backends/consul.mdx rename website/docs/language/settings/backends/{cos.html.md => cos.mdx} (52%) rename website/docs/language/settings/backends/{etcd.html.md => etcd.mdx} (61%) delete mode 100644 website/docs/language/settings/backends/etcdv3.html.md create mode 100644 website/docs/language/settings/backends/etcdv3.mdx rename website/docs/language/settings/backends/{gcs.html.md => gcs.mdx} (53%) delete mode 100644 website/docs/language/settings/backends/http.html.md create mode 100644 website/docs/language/settings/backends/http.mdx rename website/docs/language/settings/backends/{index.html.md => index.mdx} (83%) rename website/docs/language/settings/backends/{kubernetes.html.md => kubernetes.mdx} (88%) rename website/docs/language/settings/backends/{local.html.md => local.mdx} (71%) delete mode 100644 website/docs/language/settings/backends/manta.html.md create mode 100644 website/docs/language/settings/backends/manta.mdx rename website/docs/language/settings/backends/{oss.html.md => oss.mdx} (91%) delete mode 100644 website/docs/language/settings/backends/pg.html.md create mode 100644 website/docs/language/settings/backends/pg.mdx rename website/docs/language/settings/backends/{remote.html.md => remote.mdx} (77%) rename website/docs/language/settings/backends/{s3.html.md => s3.mdx} (96%) rename website/docs/language/settings/backends/{swift.html.md => swift.mdx} (91%) rename website/docs/language/settings/{index.html.md => index.mdx} (84%) rename website/docs/language/state/{backends.html.md => backends.mdx} (69%) rename website/docs/language/state/{import.html.md => import.mdx} (59%) rename website/docs/language/state/{index.html.md => index.mdx} (77%) rename website/docs/language/state/{locking.html.md => locking.mdx} (77%) rename website/docs/language/state/{purpose.html.md => purpose.mdx} (93%) delete mode 100644 website/docs/language/state/remote-state-data.html.md create mode 100644 website/docs/language/state/remote-state-data.mdx rename website/docs/language/state/{remote.html.md => remote.mdx} (84%) rename website/docs/language/state/{sensitive-data.html.md => sensitive-data.mdx} (79%) rename website/docs/language/state/{workspaces.html.md => workspaces.mdx} (84%) rename website/docs/language/syntax/{configuration.html.md => configuration.mdx} (92%) rename website/docs/language/syntax/{index.html.md => index.mdx} (53%) rename website/docs/language/syntax/{json.html.md => json.mdx} (95%) rename website/docs/language/syntax/{style.html.md => style.mdx} (76%) rename website/docs/language/{v1-compatibility-promises.html.md => v1-compatibility-promises.mdx} (88%) delete mode 100644 website/docs/language/values/index.html.md create mode 100644 website/docs/language/values/index.mdx rename website/docs/language/values/{locals.html.md => locals.mdx} (74%) rename website/docs/language/values/{outputs.html.md => outputs.mdx} (87%) rename website/docs/language/values/{variables.html.md => variables.mdx} (87%) rename website/guides/{core-workflow.html.md => core-workflow.mdx} (93%) rename website/guides/{index.html.md => index.mdx} (86%) rename website/guides/{terraform-integration-program.html.md => terraform-integration-program.mdx} (61%) rename website/guides/{terraform-provider-development-program.html.md => terraform-provider-development-program.mdx} (56%) rename website/intro/{index.html.markdown => index.mdx} (76%) rename website/intro/{use-cases.html.markdown => use-cases.mdx} (96%) rename website/intro/vs/{boto.html.markdown => boto.mdx} (81%) rename website/intro/vs/{chef-puppet.html.markdown => chef-puppet.mdx} (80%) rename website/intro/vs/{cloudformation.html.markdown => cloudformation.mdx} (87%) rename website/intro/vs/{custom.html.markdown => custom.mdx} (88%) rename website/intro/vs/{index.html.markdown => index.mdx} (80%) diff --git a/website/docs/cli/auth/index.html.md b/website/docs/cli/auth/index.mdx similarity index 64% rename from website/docs/cli/auth/index.html.md rename to website/docs/cli/auth/index.mdx index cb61fbcdf47f..3d09a4f933f7 100644 --- a/website/docs/cli/auth/index.html.md +++ b/website/docs/cli/auth/index.mdx @@ -1,21 +1,23 @@ --- -layout: "docs" -page_title: "Authentication - Terraform CLI" -description: "Documentation about the login and logout commands that help automate getting an API token for your Terraform Cloud account." +page_title: Authentication - Terraform CLI +description: >- + Documentation about the login and logout commands that help automate getting + an API token for your Terraform Cloud account. +sidebar_title: Authentication --- # CLI Authentication > **Hands-on:** Try the [Authenticate the CLI with Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-login?in=terraform/cloud&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. -[Terraform Cloud](/docs/cloud/index.html) and -[Terraform Enterprise](/docs/enterprise/index.html) are platforms that perform +[Terraform Cloud](/cloud-docs/) and +[Terraform Enterprise](/enterprise/) are platforms that perform Terraform runs to provision infrastructure, offering a collaboration-focused environment that makes it easier for teams to use Terraform together. (For expediency, the content below refers to both products as "Terraform Cloud.") Terraform CLI integrates with Terraform Cloud in several ways — it can be a -front-end for [CLI-driven runs](/docs/cloud/run/cli.html) in Terraform Cloud, +front-end for [CLI-driven runs](/cloud-docs/run/cli) in Terraform Cloud, and can also use Terraform Cloud as a state backend and a private module registry. All of these integrations require you to authenticate Terraform CLI with your Terraform Cloud account. @@ -26,5 +28,5 @@ Terraform Cloud user account. For details, see: -- [The `terraform login` command](/docs/cli/commands/login.html) -- [The `terraform logout` command](/docs/cli/commands/logout.html) +- [The `terraform login` command](/cli/commands/login) +- [The `terraform logout` command](/cli/commands/logout) diff --git a/website/docs/cli/code/index.html.md b/website/docs/cli/code/index.mdx similarity index 65% rename from website/docs/cli/code/index.html.md rename to website/docs/cli/code/index.mdx index bf858dd6ba42..ba1a408c05ae 100644 --- a/website/docs/cli/code/index.html.md +++ b/website/docs/cli/code/index.mdx @@ -1,12 +1,14 @@ --- -layout: "docs" -page_title: "Writing and Modifying Code - Terraform CLI" -description: "Learn commands that help validate, format, and upgrade code written in the Terraform Configuration Language." +page_title: Writing and Modifying Code - Terraform CLI +description: >- + Learn commands that help validate, format, and upgrade code written in the + Terraform Configuration Language. +sidebar_title: Writing and Modifying Code --- # Writing and Modifying Terraform Code -The [Terraform language](/docs/language/index.html) is Terraform's primary +The [Terraform language](/language/) is Terraform's primary user interface, and all of Terraform's workflows rely on configurations written in the Terraform language. @@ -14,18 +16,17 @@ Terraform CLI includes several commands to make Terraform code more convenient to work with. Integrating these commands into your editing workflow can potentially save you time and effort. -- [The `terraform console` command](/docs/cli/commands/console.html) starts an +- [The `terraform console` command](/cli/commands/console) starts an interactive shell for evaluating Terraform - [expressions](/docs/language/expressions/index.html), which can be a faster way + [expressions](/language/expressions/), which can be a faster way to verify that a particular resource argument results in the value you expect. - -- [The `terraform fmt` command](/docs/cli/commands/fmt.html) rewrites Terraform +- [The `terraform fmt` command](/cli/commands/fmt) rewrites Terraform configuration files to a canonical format and style, so you don't have to waste time making minor adjustments for readability and consistency. It works well as a pre-commit hook in your version control system. -- [The `terraform validate` command](/docs/cli/commands/validate.html) validates the +- [The `terraform validate` command](/cli/commands/validate) validates the syntax and arguments of the Terraform configuration files in a directory, including argument and attribute names and types for resources and modules. The `plan` and `apply` commands automatically validate a configuration before @@ -33,12 +34,12 @@ potentially save you time and effort. workflow, but it can be very useful as a pre-commit hook or as part of a continuous integration pipeline. -- [The `0.13upgrade` command](/docs/cli/commands/0.13upgrade.html) and - [the `0.12upgrade` command](/docs/cli/commands/0.12upgrade.html) can automatically +- [The `0.13upgrade` command](/cli/commands/0.13upgrade) and + [the `0.12upgrade` command](/cli/commands/0.12upgrade) can automatically modify the configuration files in a Terraform module to help deal with major syntax changes that occurred in the 0.13 and 0.12 releases of Terraform. Both of these commands are only available in the Terraform version they are associated with, and you are expected to upgrade older code to be compatible with 0.12 before attempting to make it compatible with 0.13. For more detailed information about updating code for new Terraform versions, see the [upgrade - guides](/upgrade-guides/index.html) in the Terraform language docs. + guides](/upgrade-guides/) in the Terraform language docs. diff --git a/website/docs/cli/commands/0.12upgrade.html.md b/website/docs/cli/commands/0.12upgrade.mdx similarity index 90% rename from website/docs/cli/commands/0.12upgrade.html.md rename to website/docs/cli/commands/0.12upgrade.mdx index 59ff0de44f1b..192a1103e828 100644 --- a/website/docs/cli/commands/0.12upgrade.html.md +++ b/website/docs/cli/commands/0.12upgrade.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: 0.12upgrade" -sidebar_current: "docs-commands-012upgrade" -description: |- - The 0.12upgrade subcommand automatically rewrites existing configurations for Terraform 0.12 compatibility. +page_title: 'Command: 0.12upgrade' +description: >- + The 0.12upgrade subcommand automatically rewrites existing configurations for + Terraform 0.12 compatibility. --- # Command: 0.12upgrade @@ -12,7 +11,7 @@ The `terraform 0.12upgrade` command applies several automatic upgrade rules to help prepare a module that was written for Terraform v0.11 to be used with Terraform v0.12. --> **This command is available only in Terraform v0.12 releases.** For more information, see [the Terraform v0.12 upgrade guide](https://www.terraform.io/upgrade-guides/0-12.html). +-> **This command is available only in Terraform v0.12 releases.** For more information, see [the Terraform v0.12 upgrade guide](/upgrade-guides/0-12). ## Usage @@ -71,13 +70,13 @@ the change. Once upgraded the configuration will no longer be compatible with Terraform v0.11 and earlier. When upgrading a shared module that is called from multiple configurations, you may need to -[fix existing configurations to a previous version](/docs/language/modules/syntax.html#version) +[fix existing configurations to a previous version](/language/modules/syntax#version) to allow for a gradual upgrade. If the module is published via -[a Terraform registry](/docs/registry/), assign a new _major_ version number +[a Terraform registry](/registry/), assign a new _major_ version number to the upgraded module source to represent the fact that this is a breaking change for v0.11 callers. If a module is installed directly from a version control system such as Git, -[use specific revisions](https://www.terraform.io/docs/language/modules/sources.html#selecting-a-revision) +[use specific revisions](/language/modules/sources#selecting-a-revision) to control which version is used by which caller. The command-line options are all optional. The available options are: @@ -107,8 +106,8 @@ On Mac OS X, the `find` included with the system does not support the `-printf` ``` brew install findutils ``` -Once installed, run the above command line using `gfind` instead of `find`. +Once installed, run the above command line using `gfind` instead of `find`. Note that the above includes the `-yes` option to override the interactive prompt, so be sure you have a clean work tree before running it. diff --git a/website/docs/cli/commands/0.13upgrade.html.md b/website/docs/cli/commands/0.13upgrade.mdx similarity index 92% rename from website/docs/cli/commands/0.13upgrade.html.md rename to website/docs/cli/commands/0.13upgrade.mdx index 52ff420671bc..d8697a65372d 100644 --- a/website/docs/cli/commands/0.13upgrade.html.md +++ b/website/docs/cli/commands/0.13upgrade.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: 0.13upgrade" -sidebar_current: "docs-commands-013upgrade" -description: |- - The 0.13upgrade subcommand updates existing configurations to use the new provider source features from Terraform 0.13. +page_title: 'Command: 0.13upgrade' +description: >- + The 0.13upgrade subcommand updates existing configurations to use the new + provider source features from Terraform 0.13. --- # Command: 0.13upgrade @@ -12,7 +11,7 @@ The `terraform 0.13upgrade` command updates existing configuration to add an explicit `source` attribute for each provider used in a given module. The provider source settings are stored in a `required_providers` block. --> **This command is available only in Terraform v0.13 releases.** For more information, see [the Terraform v0.13 upgrade guide](https://www.terraform.io/upgrade-guides/0-13.html). +-> **This command is available only in Terraform v0.13 releases.** For more information, see [the Terraform v0.13 upgrade guide](/upgrade-guides/0-13). ## Usage @@ -23,7 +22,7 @@ providers are in use for a module, detect the source address for those providers where possible, and record this information in a [`required_providers` block][required-providers]. -[required-providers]: /docs/language/providers/requirements.html +[required-providers]: /language/providers/requirements ~> Note: the command ignores `.tf.json` files and override files in the module. diff --git a/website/docs/cli/commands/apply.html.md b/website/docs/cli/commands/apply.mdx similarity index 82% rename from website/docs/cli/commands/apply.html.md rename to website/docs/cli/commands/apply.mdx index 09172c542a0f..ece491cdc2f0 100644 --- a/website/docs/cli/commands/apply.html.md +++ b/website/docs/cli/commands/apply.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: apply" -sidebar_current: "docs-commands-apply" -description: "The terraform apply command executes the actions proposed in a Terraform plan to create, update, or destroy infrastructure." +page_title: 'Command: apply' +description: >- + The terraform apply command executes the actions proposed in a Terraform plan + to create, update, or destroy infrastructure. --- # Command: apply @@ -33,15 +33,15 @@ you pass it the filename of a previously-saved plan file. ### Automatic Plan Mode In the default case, with no saved plan file, `terraform apply` creates its own -plan of action, in the same way that [`terraform plan`](./plan.html) would. +plan of action, in the same way that [`terraform plan`](/cli/commands/plan) would. Terraform will propose the plan to you and prompt you to approve it before taking the described actions, unless you waive that prompt by using the `-auto-approve` option. When performing its own plan, `terraform apply` supports all of the same -[planning modes](./plan.html#planning-modes) and -[planning options](./plan.html#planning-options) that `terraform plan` would +[planning modes](/cli/commands/plan#planning-modes) and +[planning options](/cli/commands/plan#planning-options) that `terraform plan` would accept, so you can customize how Terraform will create the plan. ### Saved Plan Mode @@ -49,7 +49,7 @@ accept, so you can customize how Terraform will create the plan. If you pass the filename of a previously-saved plan file, `terraform apply` performs exactly the steps specified by that plan file. It does not prompt for approval; if you want to inspect a plan file before applying it, you can use -[`terraform show`](./show.html). +[`terraform show`](/cli/commands/show). When using a saved plan, none of the planning modes or planning options linked above are supported; these options only affect Terraform's decisions about which @@ -61,8 +61,8 @@ decisions. When run without a saved plan file, `terraform apply` supports all of `terraform plan`'s planning modes and planning options. For details, see: -- [Planning Modes](./plan.html#planning-modes) -- [Planning Options](./plan.html#planning-options) +* [Planning Modes](/cli/commands/plan#planning-modes) +* [Planning Options](/cli/commands/plan#planning-options) ### Apply Options @@ -70,7 +70,7 @@ The following options allow you to change various details about how the apply command executes and reports on the apply operation. If you are running `terraform apply` _without_ a previously-saved plan file, these options are _in addition to_ the planning modes and planning options described for -[`terraform plan`](./plan.html). +[`terraform plan`](/cli/commands/plan). * `-auto-approve` - Skips interactive approval of plan before applying. This option is ignored when you pass a previously-saved plan file, because @@ -95,11 +95,11 @@ _in addition to_ the planning modes and planning options described for variable values to continue. To enable this flag, you must also either enable the `-auto-approve` flag or specify a previously-saved plan. - [machine-readable-ui]: /docs/internals/machine-readable-ui.html + [machine-readable-ui]: /internals/machine-readable-ui * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -111,13 +111,13 @@ _in addition to_ the planning modes and planning options described for rendered by a system that cannot interpret terminal formatting. * `-parallelism=n` - Limit the number of concurrent operation as Terraform - [walks the graph](/docs/internals/graph.html#walking-the-graph). Defaults to - 10. + [walks the graph](/internals/graph#walking-the-graph). Defaults to + 10\. For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform apply` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Passing a Different Configuration Directory @@ -127,7 +127,7 @@ that directory as the root module instead of the current working directory. That usage was deprecated in Terraform v0.14 and removed in Terraform v0.15. If your workflow relies on overriding the root module directory, use -[the `-chdir` global option](./#switching-working-directory-with-chdir) +[the `-chdir` global option](/cli/commands/#switching-working-directory-with-chdir) instead, which works across all commands and makes Terraform consistently look in the given directory for all files it would normally read or write in the current working directory. @@ -135,6 +135,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/cli/config/environment-variables#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/console.html.md b/website/docs/cli/commands/console.mdx similarity index 77% rename from website/docs/cli/commands/console.html.md rename to website/docs/cli/commands/console.mdx index 23682b56209d..9168a45e32a3 100644 --- a/website/docs/cli/commands/console.html.md +++ b/website/docs/cli/commands/console.mdx @@ -1,37 +1,36 @@ --- -layout: "docs" -page_title: "Command: console" -sidebar_current: "docs-commands-console" -description: "The terraform console command provides an interactive console for - evaluating expressions." +page_title: 'Command: console' +description: >- + The terraform console command provides an interactive console for evaluating + expressions. --- # Command: console The `terraform console` command provides an interactive console for -evaluating [expressions](/docs/language/expressions/index.html). +evaluating [expressions](/language/expressions/). ## Usage Usage: `terraform console [options]` This command provides an interactive command-line console for evaluating and -experimenting with [expressions](/docs/language/expressions/index.html). +experimenting with [expressions](/language/expressions/). This is useful for testing interpolations before using them in configurations, and for interacting with any values currently saved in -[state](/docs/language/state/index.html). +[state](/language/state/). If the current state is empty or has not yet been created, the console can be used to experiment with the expression syntax and -[built-in functions](/docs/language/functions/index.html). +[built-in functions](/language/functions/). You can close the console with the `exit` command or by pressing Control-C or Control-D. For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform console` accepts the legacy command line option -[`-state`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`](/language/settings/backends/local#command-line-arguments). ## Scripting @@ -52,7 +51,7 @@ tolist([ ## Remote State -If [remote state](/docs/language/state/remote.html) is used by the current backend, +If [remote state](/language/state/remote) is used by the current backend, Terraform will read the state for the current workspace from the backend before evaluating any expressions. diff --git a/website/docs/cli/commands/destroy.html.md b/website/docs/cli/commands/destroy.mdx similarity index 78% rename from website/docs/cli/commands/destroy.html.md rename to website/docs/cli/commands/destroy.mdx index 4e45bbe3d095..beb9782ebfd5 100644 --- a/website/docs/cli/commands/destroy.html.md +++ b/website/docs/cli/commands/destroy.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: destroy" -sidebar_current: "docs-commands-destroy" -description: "The terraform destroy command destroys all objects managed by a Terraform configuration." +page_title: 'Command: destroy' +description: >- + The terraform destroy command destroys all objects managed by a Terraform + configuration. --- # Command: destroy @@ -27,7 +27,7 @@ terraform apply -destroy ``` For that reason, this command accepts most of the options that -[`terraform apply`](./apply.html) accepts, although it does +[`terraform apply`](/cli/commands/apply) accepts, although it does not accept a plan file argument and forces the selection of the "destroy" planning mode. @@ -38,7 +38,7 @@ destroying would be, by running the following command: terraform plan -destroy ``` -This will run [`terraform plan`](./plan.html) in _destroy_ mode, showing +This will run [`terraform plan`](/cli/commands/plan) in _destroy_ mode, showing you the proposed destroy changes without executing them. -> **Note:** The `-destroy` option to `terraform apply` exists only in diff --git a/website/docs/cli/commands/env.html.md b/website/docs/cli/commands/env.html.md deleted file mode 100644 index bbaacc530d0e..000000000000 --- a/website/docs/cli/commands/env.html.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: "docs" -page_title: "Command: env" -sidebar_current: "docs-commands-envcmd" -description: "The terraform env command is a deprecated form of the terraform workspace command." ---- - -# Command: env - -The `terraform env` command is deprecated. -[The `terraform workspace` command](/docs/cli/commands/workspace/index.html) -should be used instead. diff --git a/website/docs/cli/commands/env.mdx b/website/docs/cli/commands/env.mdx new file mode 100644 index 000000000000..08b3139dfa2a --- /dev/null +++ b/website/docs/cli/commands/env.mdx @@ -0,0 +1,12 @@ +--- +page_title: 'Command: env' +description: >- + The terraform env command is a deprecated form of the terraform workspace + command. +--- + +# Command: env + +The `terraform env` command is deprecated. +[The `terraform workspace` command](/cli/commands/workspace/) +should be used instead. diff --git a/website/docs/cli/commands/fmt.html.md b/website/docs/cli/commands/fmt.mdx similarity index 89% rename from website/docs/cli/commands/fmt.html.md rename to website/docs/cli/commands/fmt.mdx index b25a476b4efe..c6868d733f9f 100644 --- a/website/docs/cli/commands/fmt.html.md +++ b/website/docs/cli/commands/fmt.mdx @@ -1,15 +1,15 @@ --- -layout: "docs" -page_title: "Command: fmt" -sidebar_current: "docs-commands-fmt" -description: "The terraform fmt command rewrites configuration files to a canonical format and style." +page_title: 'Command: fmt' +description: >- + The terraform fmt command rewrites configuration files to a canonical format + and style. --- # Command: fmt The `terraform fmt` command is used to rewrite Terraform configuration files to a canonical format and style. This command applies a subset of -the [Terraform language style conventions](/docs/language/syntax/style.html), +the [Terraform language style conventions](/language/syntax/style), along with other minor adjustments for readability. Other Terraform commands that generate Terraform configuration will produce @@ -58,5 +58,5 @@ The command-line flags are all optional. The list of available flags are: * `-write=false` - Don't overwrite the input files. (This is implied by `-check` or when the input is STDIN.) * `-diff` - Display diffs of formatting changes * `-check` - Check if the input is formatted. Exit status will be 0 if - all input is properly formatted and non-zero otherwise. + all input is properly formatted and non-zero otherwise. * `-recursive` - Also process files in subdirectories. By default, only the given directory (or current directory) is processed. diff --git a/website/docs/cli/commands/force-unlock.html.md b/website/docs/cli/commands/force-unlock.mdx similarity index 71% rename from website/docs/cli/commands/force-unlock.html.md rename to website/docs/cli/commands/force-unlock.mdx index 0ad7a6285703..735eec48968d 100644 --- a/website/docs/cli/commands/force-unlock.html.md +++ b/website/docs/cli/commands/force-unlock.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: force-unlock" -sidebar_current: "docs-commands-force-unlock" -description: "The terraform force-unlock command unlocks the state for a configuration. It does not modify your infrastructure." +page_title: 'Command: force-unlock' +description: >- + The terraform force-unlock command unlocks the state for a configuration. It + does not modify your infrastructure. --- # Command: force-unlock @@ -27,4 +27,4 @@ process. Options: -* `-force` - Don't ask for input for unlock confirmation. +* `-force` - Don't ask for input for unlock confirmation. diff --git a/website/docs/cli/commands/get.html.md b/website/docs/cli/commands/get.mdx similarity index 60% rename from website/docs/cli/commands/get.html.md rename to website/docs/cli/commands/get.mdx index 47f4e6cfa4f3..7dd5f199c0ba 100644 --- a/website/docs/cli/commands/get.html.md +++ b/website/docs/cli/commands/get.mdx @@ -1,14 +1,12 @@ --- -layout: "docs" -page_title: "Command: get" -sidebar_current: "docs-commands-get" -description: "The terraform get command downloads and updates modules." +page_title: 'Command: get' +description: The terraform get command downloads and updates modules. --- # Command: get The `terraform get` command is used to download and update -[modules](/docs/language/modules/develop/index.html) mentioned in the root module. +[modules](/language/modules/develop/) mentioned in the root module. ## Usage @@ -21,6 +19,6 @@ repository. The `get` command supports the following option: * `-update` - If specified, modules that are already downloaded will be - checked for updates and the updates will be downloaded if present. + checked for updates and the updates will be downloaded if present. * `-no-color` - Disable text coloring in the output. diff --git a/website/docs/cli/commands/graph.html.md b/website/docs/cli/commands/graph.mdx similarity index 74% rename from website/docs/cli/commands/graph.html.md rename to website/docs/cli/commands/graph.mdx index cfc915667c66..969c6e5dbe1a 100644 --- a/website/docs/cli/commands/graph.html.md +++ b/website/docs/cli/commands/graph.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: graph" -sidebar_current: "docs-commands-graph" -description: "The terraform graph command generates a visual representation of a configuration or execution plan that you can use to generate charts." +page_title: 'Command: graph' +description: >- + The terraform graph command generates a visual representation of a + configuration or execution plan that you can use to generate charts. --- # Command: graph @@ -12,7 +12,6 @@ representation of either a configuration or execution plan. The output is in the DOT format, which can be used by [GraphViz](http://www.graphviz.org) to generate charts. - ## Usage Usage: `terraform graph [options]` @@ -33,16 +32,16 @@ argument. Options: * `-plan=tfplan` - Render graph using the specified plan file instead of the - configuration in the current directory. + configuration in the current directory. * `-draw-cycles` - Highlight any cycles in the graph with colored edges. - This helps when diagnosing cycle errors. + This helps when diagnosing cycle errors. * `-type=plan` - Type of graph to output. Can be: `plan`, `plan-destroy`, `apply`, - `validate`, `input`, `refresh`. + `validate`, `input`, `refresh`. * `-module-depth=n` - (deprecated) In prior versions of Terraform, specified the - depth of modules to show in the output. + depth of modules to show in the output. ## Generating Images @@ -55,4 +54,4 @@ $ terraform graph | dot -Tsvg > graph.svg ``` Here is an example graph output: -![Graph Example](docs/graph-example.png) +![Graph Example](/img/docs/graph-example.png) diff --git a/website/docs/cli/commands/import.html.md b/website/docs/cli/commands/import.mdx similarity index 79% rename from website/docs/cli/commands/import.html.md rename to website/docs/cli/commands/import.mdx index 7c26b1758ec1..0bf0bae26c06 100644 --- a/website/docs/cli/commands/import.html.md +++ b/website/docs/cli/commands/import.mdx @@ -1,8 +1,6 @@ --- -layout: "docs" -page_title: "Command: import" -sidebar_current: "docs-commands-import" -description: "The terraform import command brings existing resources into Terraform state." +page_title: 'Command: import' +description: The terraform import command brings existing resources into Terraform state. --- # Command: import @@ -10,7 +8,7 @@ description: "The terraform import command brings existing resources into Terraf > **Hands-on:** Try the [Import Terraform Configuration](https://learn.hashicorp.com/tutorials/terraform/state-import?in=terraform/state&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. The `terraform import` command is used to -[import existing resources](/docs/cli/import/index.html) +[import existing resources](/cli/import/) into Terraform. ## Usage @@ -20,7 +18,7 @@ Usage: `terraform import [options] ADDRESS ID` Import will find the existing resource from ID and import it into your Terraform state at the given ADDRESS. -ADDRESS must be a valid [resource address](/docs/cli/state/resource-addressing.html). +ADDRESS must be a valid [resource address](/cli/state/resource-addressing). Because any resource address is valid, the import command can import resources into modules as well as directly into the root of your state. @@ -36,7 +34,7 @@ itself having created all objects. If you import existing objects into Terraform be careful to import each remote object to only one Terraform resource address. If you import the same object multiple times, Terraform may exhibit unwanted behavior. For more information on this assumption, see -[the State section](/docs/language/state/index.html). +[the State section](/language/state/). The command-line flags are all optional. The list of available flags are: @@ -48,29 +46,29 @@ The command-line flags are all optional. The list of available flags are: * `-input=true` - Whether to ask for input for provider configuration. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=0s` - Duration to retry a state lock. * `-no-color` - If specified, output won't contain any color. * `-parallelism=n` - Limit the number of concurrent operation as Terraform - [walks the graph](/docs/internals/graph.html#walking-the-graph). Defaults + [walks the graph](/internals/graph#walking-the-graph). Defaults to 10. * `-provider=provider` - **Deprecated** Override the provider configuration to -use when importing the object. By default, Terraform uses the provider specified -in the configuration for the target resource, and that is the best behavior in most cases. + use when importing the object. By default, Terraform uses the provider specified + in the configuration for the target resource, and that is the best behavior in most cases. * `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag can be set multiple times. Variable values are interpreted as - [literal expressions](/docs/language/expressions/types.html) in the + [literal expressions](/language/expressions/types) in the Terraform language, so list and map values can be specified via this flag. This is only useful with the `-config` flag. * `-var-file=foo` - Set variables in the Terraform configuration from - a [variable file](/docs/language/values/variables.html#variable-definitions-tfvars-files). If + a [variable file](/language/values/variables#variable-definitions-tfvars-files). If a `terraform.tfvars` or any `.auto.tfvars` files are present in the current directory, they will be automatically loaded. `terraform.tfvars` is loaded first and the `.auto.tfvars` files after in alphabetical order. Any files @@ -79,15 +77,15 @@ in the configuration for the target resource, and that is the best behavior in m useful with the `-config` flag. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform import` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform import` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Provider Configuration @@ -135,7 +133,7 @@ $ terraform import module.foo.aws_instance.bar i-abcd1234 ## Example: Import into Resource configured with count The example below will import an AWS instance into the first instance of the `aws_instance` resource named `baz` configured with -[`count`](/docs/language/meta-arguments/count.html): +[`count`](/language/meta-arguments/count): ```shell $ terraform import 'aws_instance.baz[0]' i-abcd1234 @@ -144,7 +142,7 @@ $ terraform import 'aws_instance.baz[0]' i-abcd1234 ## Example: Import into Resource configured with for_each The example below will import an AWS instance into the `"example"` instance of the `aws_instance` resource named `baz` configured with -[`for_each`](/docs/language/meta-arguments/for_each.html): +[`for_each`](/language/meta-arguments/for_each): Linux, Mac OS, and UNIX: diff --git a/website/docs/cli/commands/index.html.md b/website/docs/cli/commands/index.mdx similarity index 93% rename from website/docs/cli/commands/index.html.md rename to website/docs/cli/commands/index.mdx index 6fb5919a77ba..99ba47df6b6b 100644 --- a/website/docs/cli/commands/index.html.md +++ b/website/docs/cli/commands/index.mdx @@ -1,8 +1,6 @@ --- -layout: "docs" -page_title: "Basic CLI Features" -sidebar_current: "docs-commands" -description: "An introduction to the terraform command and its available subcommands." +page_title: Basic CLI Features +description: An introduction to the terraform command and its available subcommands. --- # Basic CLI Features @@ -17,8 +15,8 @@ of this page. We refer to the `terraform` command line tool as "Terraform CLI" elsewhere in the documentation. This terminology is often used to distinguish it from other components you might use in the Terraform product family, such as -[Terraform Cloud](/docs/cloud/) or -the various [Terraform providers](/docs/language/providers/index.html), which +[Terraform Cloud](/cloud-docs/) or +the various [Terraform providers](/language/providers/), which are developed and released separately from Terraform CLI. To view a list of the commands available in your current Terraform version, @@ -100,7 +98,7 @@ will be read or written in the given directory instead. There are two exceptions where Terraform will use the original working directory even when you specify `-chdir=...`: -* Settings in the [CLI Configuration](/docs/cli/config/config-file.html) are not for a specific +* Settings in the [CLI Configuration](/cli/config/config-file) are not for a specific subcommand and Terraform processes them before acting on the `-chdir` option. @@ -153,7 +151,7 @@ Checkpoint itself can be entirely disabled for all HashiCorp products by setting the environment variable `CHECKPOINT_DISABLE` to any non-empty value. Alternatively, settings in -[the CLI configuration file](/docs/cli/config/config-file.html) can be used to +[the CLI configuration file](/cli/config/config-file) can be used to disable checkpoint features. The following checkpoint-related settings are supported in this file: diff --git a/website/docs/cli/commands/init.html.md b/website/docs/cli/commands/init.mdx similarity index 83% rename from website/docs/cli/commands/init.html.md rename to website/docs/cli/commands/init.mdx index 6a62906a5440..47b38e528667 100644 --- a/website/docs/cli/commands/init.html.md +++ b/website/docs/cli/commands/init.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: init" -sidebar_current: "docs-commands-init" -description: "The terraform init command initializes a working directory containing configuration files and installs plugins for required providers." +page_title: 'Command: init' +description: >- + The terraform init command initializes a working directory containing + configuration files and installs plugins for required providers. --- # Command: init @@ -74,7 +74,7 @@ activating credentials) before running `terraform init`. ## Backend Initialization During init, the root configuration directory is consulted for -[backend configuration](/docs/language/settings/backends/configuration.html) and the chosen backend +[backend configuration](/language/settings/backends/configuration) and the chosen backend is initialized using the given configuration settings. Re-running init with an already-initialized backend will update the working @@ -96,14 +96,14 @@ when the working directory was already previously initialized for a particular backend. The `-backend-config=...` option can be used for -[partial backend configuration](/docs/language/settings/backends/configuration.html#partial-configuration), +[partial backend configuration](/language/settings/backends/configuration#partial-configuration), in situations where the backend settings are dynamic or sensitive and so cannot be statically specified in the configuration file. ## Child Module Installation During init, the configuration is searched for `module` blocks, and the source -code for referenced [modules](/docs/language/modules/develop/index.html) is retrieved from the locations +code for referenced [modules](/language/modules/develop/) is retrieved from the locations given in their `source` arguments. Re-running init with modules already installed will install the sources for @@ -128,13 +128,13 @@ third-party provider registry, `terraform init` will automatically find, download, and install the necessary provider plugins. If you cannot or do not wish to install providers from their origin registries, you can customize how Terraform installs providers using -[the provider installation settings in the CLI configuration](/docs/cli/config/config-file.html#provider-installation). +[the provider installation settings in the CLI configuration](/cli/config/config-file#provider-installation). For more information about specifying which providers are required for each -of your modules, see [Provider Requirements](/docs/language/providers/requirements.html). +of your modules, see [Provider Requirements](/language/providers/requirements). After successful installation, Terraform writes information about the selected -providers to [the dependency lock file](/docs/language/dependency-lock.html). +providers to [the dependency lock file](/language/dependency-lock). You should commit this file to your version control system to ensure that when you run `terraform init` again in future Terraform will select exactly the same provider versions. Use the `-upgrade` option if you want Terraform @@ -142,31 +142,31 @@ to ignore the dependency lock file and consider installing newer versions. You can modify `terraform init`'s plugin behavior with the following options: -- `-upgrade` Upgrade all previously-selected plugins to the newest version +* `-upgrade` Upgrade all previously-selected plugins to the newest version that complies with the configuration's version constraints. This will cause Terraform to ignore any selections recorded in the dependency lock file, and to take the newest available version matching the configured version constraints. -- `-get-plugins=false` — Skip plugin installation. - - -> Note: Since Terraform 0.13, this option has been superseded by the - [`provider_installation`](/docs/cli/config/config-file.html#provider-installation) and - [`plugin_cache_dir`](/docs/cli/config/config-file.html#plugin_cache_dir) settings. - It should not be used in Terraform versions 0.13+, and this option - was removed in Terraform 0.15. -- `-plugin-dir=PATH` — Force plugin installation to read plugins _only_ from +* `-get-plugins=false` — Skip plugin installation. + + -> Note: Since Terraform 0.13, this option has been superseded by the + [`provider_installation`](/cli/config/config-file#provider-installation) and + [`plugin_cache_dir`](/cli/config/config-file#plugin_cache_dir) settings. + It should not be used in Terraform versions 0.13+, and this option + was removed in Terraform 0.15. +* `-plugin-dir=PATH` — Force plugin installation to read plugins _only_ from the specified directory, as if it had been configured as a `filesystem_mirror` in the CLI configuration. If you intend to routinely use a particular filesystem mirror then we recommend - [configuring Terraform's installation methods globally](/docs/cli/config/config-file.html#provider-installation). + [configuring Terraform's installation methods globally](/cli/config/config-file#provider-installation). You can use `-plugin-dir` as a one-time override for exceptional situations, such as if you are testing a local build of a provider plugin you are currently developing. -- `-lockfile=MODE` Set a dependency lockfile mode. +* `-lockfile=MODE` Set a dependency lockfile mode. The valid values for the lockfile mode are as follows: -- readonly: suppress the lockfile changes, but verify checksums against the +* readonly: suppress the lockfile changes, but verify checksums against the information already recorded. It conflicts with the `-upgrade` flag. If you update the lockfile with third-party dependency management tools, it would be useful to control when it changes explicitly. @@ -192,7 +192,7 @@ that directory as the root module instead of the current working directory. That usage is still supported in Terraform v0.14, but is now deprecated and we plan to remove it in Terraform v0.15. If your workflow relies on overriding the root module directory, use -[the `-chdir` global option](./#switching-working-directory-with-chdir) +[the `-chdir` global option](/cli/commands/#switching-working-directory-with-chdir) instead, which works across all commands and makes Terraform consistently look in the given directory for all files it would normally read or write in the current working directory. @@ -200,6 +200,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/cli/config/environment-variables#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/login.html.md b/website/docs/cli/commands/login.mdx similarity index 72% rename from website/docs/cli/commands/login.html.md rename to website/docs/cli/commands/login.mdx index 8af1ef7a474f..86e1fcfee966 100644 --- a/website/docs/cli/commands/login.html.md +++ b/website/docs/cli/commands/login.mdx @@ -1,9 +1,9 @@ --- -layout: "docs" -page_title: "Command: login" -sidebar_current: "docs-commands-login" -description: |- - The terraform login command can be used to automatically obtain and save an API token for Terraform Cloud, Terraform Enterprise, or any other host that offers Terraform services. +page_title: 'Command: login' +description: >- + The terraform login command can be used to automatically obtain and save an + API token for Terraform Cloud, Terraform Enterprise, or any other host that + offers Terraform services. --- # Command: login @@ -15,7 +15,7 @@ API token for Terraform Cloud, Terraform Enterprise, or any other host that offe where it is possible to launch a web browser on the same host where Terraform is running. If you are running Terraform in an unattended automation scenario, you can -[configure credentials manually in the CLI configuration](https://www.terraform.io/docs/cli/config/config-file.html#credentials). +[configure credentials manually in the CLI configuration](/cli/config/config-file#credentials). ## Usage @@ -34,12 +34,12 @@ not as desired. If you don't wish to store your API token in the default location, you can optionally configure a -[credentials helper program](/docs/cli/config/config-file.html#credentials-helpers) which knows +[credentials helper program](/cli/config/config-file#credentials-helpers) which knows how to store and later retrieve credentials in some other system, such as your organization's existing secrets management system. ## Login Server Support The `terraform login` command works with any server supporting the -[login protocol](/docs/internals/login-protocol.html), including Terraform Cloud +[login protocol](/internals/login-protocol), including Terraform Cloud and Terraform Enterprise. diff --git a/website/docs/cli/commands/logout.html.md b/website/docs/cli/commands/logout.mdx similarity index 79% rename from website/docs/cli/commands/logout.html.md rename to website/docs/cli/commands/logout.mdx index 15656fba9acc..dbec4bc757a0 100644 --- a/website/docs/cli/commands/logout.html.md +++ b/website/docs/cli/commands/logout.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: logout" -sidebar_current: "docs-commands-logout" -description: |- - The terraform logout command is used to remove credentials stored by terraform login. +page_title: 'Command: logout' +description: >- + The terraform logout command is used to remove credentials stored by terraform + login. --- # Command: logout @@ -26,5 +25,5 @@ the remote server, so it will remain valid until manually revoked. By default, Terraform will remove the token stored in plain text in a local CLI configuration file called `credentials.tfrc.json`. If you have configured a -[credentials helper program](/docs/cli/config/config-file.html#credentials-helpers), Terraform +[credentials helper program](/cli/config/config-file#credentials-helpers), Terraform will use the helper's `forget` command to remove it. diff --git a/website/docs/cli/commands/output.html.md b/website/docs/cli/commands/output.mdx similarity index 81% rename from website/docs/cli/commands/output.html.md rename to website/docs/cli/commands/output.mdx index a09725e212eb..2fe970ba7234 100644 --- a/website/docs/cli/commands/output.html.md +++ b/website/docs/cli/commands/output.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: output" -sidebar_current: "docs-commands-output" -description: |- - The `terraform output` command is used to extract the value of an output variable from the state file. +page_title: 'Command: output' +description: >- + The `terraform output` command is used to extract the value of an output + variable from the state file. --- # Command: output @@ -22,20 +21,20 @@ output is printed. The command-line flags are all optional. The list of available flags are: * `-json` - If specified, the outputs are formatted as a JSON object, with - a key per output. If `NAME` is specified, only the output specified will be - returned. This can be piped into tools such as `jq` for further processing. + a key per output. If `NAME` is specified, only the output specified will be + returned. This can be piped into tools such as `jq` for further processing. * `-raw` - If specified, Terraform will convert the specified output value to a - string and print that string directly to the output, without any special - formatting. This can be convenient when working with shell scripts, but - it only supports string, number, and boolean values. Use `-json` instead - for processing complex data types. + string and print that string directly to the output, without any special + formatting. This can be convenient when working with shell scripts, but + it only supports string, number, and boolean values. Use `-json` instead + for processing complex data types. * `-no-color` - If specified, output won't contain any color. * `-state=path` - Path to the state file. Defaults to "terraform.tfstate". - Ignored when [remote state](/docs/language/state/remote.html) is used. + Ignored when [remote state](/language/state/remote) is used. -> **Note:** When using the `-json` or `-raw` command-line flag, any sensitive values in Terraform state will be displayed in plain text. For more information, -see [Sensitive Data in State](/docs/language/state/sensitive-data.html). +see [Sensitive Data in State](/language/state/sensitive-data). ## Examples diff --git a/website/docs/cli/commands/plan.html.md b/website/docs/cli/commands/plan.mdx similarity index 78% rename from website/docs/cli/commands/plan.html.md rename to website/docs/cli/commands/plan.mdx index cdb3bbe277d0..61f5833c550c 100644 --- a/website/docs/cli/commands/plan.html.md +++ b/website/docs/cli/commands/plan.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: plan" -sidebar_current: "docs-commands-plan" -description: "The terraform plan command creates an execution plan with a preview of the changes that Terraform will make to your infrastructure." +page_title: 'Command: plan' +description: >- + The terraform plan command creates an execution plan with a preview of the + changes that Terraform will make to your infrastructure. --- # Command: plan @@ -31,12 +31,12 @@ to be taken. If you are using Terraform directly in an interactive terminal and you expect to apply the changes Terraform proposes, you can alternatively run -[`terraform apply`](./apply.html) directly. By default, the "apply" command +[`terraform apply`](/cli/commands/apply) directly. By default, the "apply" command automatically generates a new plan and prompts for you to approve it. You can use the optional `-out=FILE` option to save the generated plan to a file on disk, which you can later execute by passing the file to -[`terraform apply`](./apply.html) as an extra argument. This two-step workflow +[`terraform apply`](/cli/commands/apply) as an extra argument. This two-step workflow is primarily intended for when [running Terraform in automation](https://learn.hashicorp.com/tutorials/terraform/automate-terraform?in=terraform/automation&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). @@ -74,9 +74,9 @@ The remaining sections on this page describe the various options: * **[Planning Options](#planning-options)**: Alongside the special planning modes, there are also some options you can set in order to customize the planning process for unusual needs. - * **[Resource Targeting](#resource-targeting)** is one particular - special planning option that has some important caveats associated - with it. + * **[Resource Targeting](#resource-targeting)** is one particular + special planning option that has some important caveats associated + with it. * **[Other Options](#other-options)**: These change the behavior of the planning command itself, rather than customizing the content of the generated plan. @@ -94,7 +94,7 @@ a different intended outcome: for situations like transient development environments, where the managed objects cease to be useful once the development task is complete. - Activate destroy mode using the `-destroy` command line option. + Activate destroy mode using the `-destroy` command line option. * **Refresh-only mode:** creates a plan whose goal is only to update the Terraform state and any root module output values to match changes made to @@ -103,7 +103,7 @@ a different intended outcome: workflow (e.g. while responding to an incident) and you now need to reconcile Terraform's records with those changes. - Activate refresh-only mode using the `-refresh-only` command line option. + Activate refresh-only mode using the `-refresh-only` command line option. In situations where we need to discuss the default planning mode that Terraform uses when none of the alternative modes are selected, we refer to it as @@ -118,7 +118,7 @@ one alternative mode at the same time. -> **Note:** In Terraform v0.15 and earlier, the `-destroy` option is supported only by the `terraform plan` command, and not by the `terraform apply` command. To create and apply a plan in destroy mode in -earlier versions you must run [`terraform destroy`](./destroy.html). +earlier versions you must run [`terraform destroy`](/cli/commands/destroy). -> **Note:** The `-refresh-only` option is available only in Terraform v0.15.4 and later. @@ -140,62 +140,62 @@ the previous section, are also available with the same meanings on * `-refresh=false` - Disables the default behavior of synchronizing the Terraform state with remote objects before checking for configuration changes. - This option can potentially make the planning operation faster by reducing - the number of remote API requests, but it comes at the expense of having - Terraform not take into account any changes that might've happened outside - of Terraform, and thus the resulting plan may not be complete or correct. + This option can potentially make the planning operation faster by reducing + the number of remote API requests, but it comes at the expense of having + Terraform not take into account any changes that might've happened outside + of Terraform, and thus the resulting plan may not be complete or correct. - This option is not available in the "refresh only" planning mode, because - it would effectively disable the entirety of the planning operation in that - case. + This option is not available in the "refresh only" planning mode, because + it would effectively disable the entirety of the planning operation in that + case. * `-replace=ADDRESS` - Instructs Terraform to plan to replace the single resource instance with the given address. If the given instance would normally have caused only an "update" action, or no action at all, then Terraform will choose a "replace" action instead. - You can use this option if you have learned that a particular remote object - has become degraded in some way. If you are using immutable infrastructure - patterns then you may wish to respond to that by replacing the - malfunctioning object with a new object that has the same configuration. + You can use this option if you have learned that a particular remote object + has become degraded in some way. If you are using immutable infrastructure + patterns then you may wish to respond to that by replacing the + malfunctioning object with a new object that has the same configuration. - This option is allowed only in the normal planning mode, so this option - is incompatible with the `-destroy` option. + This option is allowed only in the normal planning mode, so this option + is incompatible with the `-destroy` option. - The `-replace=...` option is available only from Terraform v0.15.2 onwards. - For earlier versions, you can achieve a similar effect (with some caveats) - using [`terraform taint`](./taint.html). + The `-replace=...` option is available only from Terraform v0.15.2 onwards. + For earlier versions, you can achieve a similar effect (with some caveats) + using [`terraform taint`](/cli/commands/taint). * `-target=ADDRESS` - Instructs Terraform to focus its planning efforts only on resource instances which match the given address and on any objects that those instances depend on. - This command is for exceptional use only. See - [Resource Targeting](#resource-targeting) - below for more information. + This command is for exceptional use only. See + [Resource Targeting](#resource-targeting) + below for more information. * `-var 'NAME=VALUE'` - Sets a value for a single - [input variable](/docs/language/values/variables.html) declared in the + [input variable](/language/values/variables) declared in the root module of the configuration. Use this option multiple times to set more than one variable. For more information see [Input Variables on the Command Line](#input-variables-on-the-command-line), below. * `-var-file=FILENAME` - Sets values for potentially many - [input variables](/docs/language/values/variables.html) declared in the + [input variables](/language/values/variables) declared in the root module of the configuration, using definitions from a - ["tfvars" file](/docs/language/values/variables.html#variable-definitions-tfvars-files). + ["tfvars" file](/language/values/variables#variable-definitions-tfvars-files). Use this option multiple times to include values from more than one file. There are several other ways to set values for input variables in the root module, aside from the `-var` and `-var-file` options. For more information, see -[Assigning Values to Root Module Variables](/docs/language/values/variables.html#assigning-values-to-root-module-variables). +[Assigning Values to Root Module Variables](/language/values/variables#assigning-values-to-root-module-variables). ### Input Variables on the Command Line You can use the `-var` command line option to specify values for -[input variables](/docs/language/values/variables.html) declared in your +[input variables](/language/values/variables) declared in your root module. However, to do so will require writing a command line that is parsable both @@ -242,7 +242,7 @@ so we do not recommend using Terraform with PowerShell when you are on Windows. Use Windows Command Prompt instead. The appropriate syntax for writing the variable value is different depending -on the variable's [type constraint](/docs/language/expressions/type-constraints.html). +on the variable's [type constraint](/language/expressions/type-constraints). The primitive types `string`, `number`, and `bool` all expect a direct string value with no special punctuation except that required by your shell, as shown in the above examples. For all other type constraints, including list, @@ -262,8 +262,7 @@ terraform plan -var "name=[\"a\", \"b\", \"c\"]" Similar constraints apply when setting input variables using environment variables. For more information on the various methods for setting root module input variables, see -[Assigning Values to Root Module Variables](/docs/language/values/variables.html#assigning-values-to-root-module-variables). - +[Assigning Values to Root Module Variables](/language/values/variables#assigning-values-to-root-module-variables). ### Resource Targeting @@ -271,7 +270,7 @@ input variables, see You can use the `-target` option to focus Terraform's attention on only a subset of resources. -You can use [resource address syntax](/docs/cli/state/resource-addressing.html) +You can use [resource address syntax](/cli/state/resource-addressing) to specify the constraint. Terraform interprets the resource address as follows: * If the given address identifies one specific resource instance, Terraform @@ -296,14 +295,14 @@ that those selections depend on either directly or indirectly. This targeting capability is provided for exceptional circumstances, such as recovering from mistakes or working around Terraform limitations. It -is *not recommended* to use `-target` for routine operations, since this can +is _not recommended_ to use `-target` for routine operations, since this can lead to undetected configuration drift and confusion about how the true state of resources relates to configuration. Instead of using `-target` as a means to operate on isolated portions of very large configurations, prefer instead to break large configurations into several smaller configurations that can each be independently applied. -[Data sources](/docs/language/data-sources/index.html) can be used to access +[Data sources](/language/data-sources/) can be used to access information about resources created in other configurations, allowing a complex system architecture to be broken down into more manageable parts that can be updated independently. @@ -339,11 +338,11 @@ The available options are: This implies `-input=false`, so the configuration must have no unassigned variable values to continue. - [machine-readable-ui]: /docs/internals/machine-readable-ui.html + [machine-readable-ui]: /internals/machine-readable-ui * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -359,28 +358,28 @@ The available options are: the planned changes, and to some other Terraform commands that can work with saved plan files. - Terraform will allow any filename for the plan file, but a typical - convention is to name it `tfplan`. **Do not** name the file with a suffix - that Terraform recognizes as another file format; if you use a `.tf` suffix - then Terraform will try to interpret the file as a configuration source - file, which will then cause syntax errors for subsequent commands. + Terraform will allow any filename for the plan file, but a typical + convention is to name it `tfplan`. **Do not** name the file with a suffix + that Terraform recognizes as another file format; if you use a `.tf` suffix + then Terraform will try to interpret the file as a configuration source + file, which will then cause syntax errors for subsequent commands. - The generated file is not in any standard format intended for consumption - by other software, but the file _does_ contain your full configuration, - all of the values associated with planned changes, and all of the plan - options including the input variables. If your plan includes any sort of - sensitive data, even if obscured in Terraform's terminal output, it will - be saved in cleartext in the plan file. You should therefore treat any - saved plan files as potentially-sensitive artifacts. + The generated file is not in any standard format intended for consumption + by other software, but the file _does_ contain your full configuration, + all of the values associated with planned changes, and all of the plan + options including the input variables. If your plan includes any sort of + sensitive data, even if obscured in Terraform's terminal output, it will + be saved in cleartext in the plan file. You should therefore treat any + saved plan files as potentially-sensitive artifacts. * `-parallelism=n` - Limit the number of concurrent operations as Terraform - [walks the graph](/docs/internals/graph.html#walking-the-graph). Defaults + [walks the graph](/internals/graph#walking-the-graph). Defaults to 10. For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform plan` accepts the legacy command line option -[`-state`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`](/language/settings/backends/local#command-line-arguments). ### Passing a Different Configuration Directory @@ -390,7 +389,7 @@ module instead of the current working directory. That usage was deprecated in Terraform v0.14 and removed in Terraform v0.15. If your workflow relies on overriding the root module directory, use -[the `-chdir` global option](./#switching-working-directory-with-chdir) +[the `-chdir` global option](/cli/commands/#switching-working-directory-with-chdir) instead, which works across all commands and makes Terraform consistently look in the given directory for all files it would normally read or write in the current working directory. @@ -398,6 +397,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/cli/config/environment-variables#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/providers.html.md b/website/docs/cli/commands/providers.mdx similarity index 55% rename from website/docs/cli/commands/providers.html.md rename to website/docs/cli/commands/providers.mdx index a39d0ee0ff7b..9d2b6c722134 100644 --- a/website/docs/cli/commands/providers.html.md +++ b/website/docs/cli/commands/providers.mdx @@ -1,14 +1,14 @@ --- -layout: "docs" -page_title: "Command: providers" -sidebar_current: "docs-commands-providers" -description: "The terraform providers command prints information about the providers required in the current configuration." +page_title: 'Command: providers' +description: >- + The terraform providers command prints information about the providers + required in the current configuration. --- # Command: providers The `terraform providers` command shows information about the -[provider requirements](/docs/language/providers/requirements.html) of the +[provider requirements](/language/providers/requirements) of the configuration in the current working directory, as an aid to understanding where each requirement was detected from. diff --git a/website/docs/cli/commands/providers/lock.html.md b/website/docs/cli/commands/providers/lock.mdx similarity index 76% rename from website/docs/cli/commands/providers/lock.html.md rename to website/docs/cli/commands/providers/lock.mdx index b9a48fae7d2e..7e7ccced2bfe 100644 --- a/website/docs/cli/commands/providers/lock.html.md +++ b/website/docs/cli/commands/providers/lock.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: providers lock" -sidebar_current: "docs-commands-providers-lock" +page_title: 'Command: providers lock' description: |- The `terraform providers lock` command adds new provider selection information to the dependency lock file without initializing the referenced providers. @@ -11,31 +9,31 @@ description: |- The `terraform providers lock` consults upstream registries (by default) in order to write provider dependency information into -[the dependency lock file](/docs/language/dependency-lock.html). +[the dependency lock file](/language/dependency-lock). The common way to update the dependency lock file is as a side-effect of normal provider installation during -[`terraform init`](/docs/cli/commands/init.html), but there are several situations where that +[`terraform init`](/cli/commands/init), but there are several situations where that automatic approach may not be sufficient: * If you are running Terraform in an environment that uses - [alternative provider installation methods](/docs/cli/config/config-file.html#provider-installation), + [alternative provider installation methods](/cli/config/config-file#provider-installation), such as filesystem or network mirrors, normal provider installation will not access the origin registry for a provider and therefore Terraform will not be able to populate all of the possible package checksums for the selected provider versions. - If you use `terraform lock` to write the official release checksums for a - provider into the dependency lock file then future `terraform init` runs - will verify the packages available in your selected mirror against the - official checksums previously recorded, giving additional certainty that - the mirror is serving the provider packages it is claiming to. + If you use `terraform lock` to write the official release checksums for a + provider into the dependency lock file then future `terraform init` runs + will verify the packages available in your selected mirror against the + official checksums previously recorded, giving additional certainty that + the mirror is serving the provider packages it is claiming to. * If your team runs Terraform across a number of different platforms (e.g. on both Windows and Linux) and the upstream registry for a provider is unable to provide signed checksums using the latest hashing scheme, subsequent runs of Terraform on other platforms may - [add additional checksums to the lock file](/docs/language/dependency-lock.html#new-provider-package-checksums). + [add additional checksums to the lock file](/language/dependency-lock#new-provider-package-checksums). You can avoid that by pre-populating hashes for all of the platforms you intend to use, using the `terraform providers lock` command. @@ -49,17 +47,17 @@ With no additional command line arguments, `terraform providers lock` will analyze the configuration in the current working directory to find all of the providers it depends on, and it will fetch the necessary data about those providers from their origin registries and then update -[the dependency lock file](/docs/language/dependency-lock.html) to +[the dependency lock file](/language/dependency-lock) to include a selected version for each provider and all of the package checksums that are covered by the provider developer's cryptographic signature. ~> **Warning:** The `terraform providers lock` command prints information - about what it has fetched and whether each package was signed using a - cryptographic signature, but it cannot automatically verify that the - providers are trustworthy and that they comply with your local system - policies or relevant regulations. Review the signing key information - in the output to confirm that you trust all of the signers before committing - the updated lock file to your version control system. +about what it has fetched and whether each package was signed using a +cryptographic signature, but it cannot automatically verify that the +providers are trustworthy and that they comply with your local system +policies or relevant regulations. Review the signing key information +in the output to confirm that you trust all of the signers before committing +the updated lock file to your version control system. If you list one or more provider source addresses on the command line then `terraform providers lock` will restrict its work only to those providers, @@ -74,21 +72,21 @@ You can customize the default behavior using the following additional option: * `-net-mirror=URL` - Direct Terraform to look for provider packages in the given network mirror service, instead of in upstream registries. The given URL must implement - [the Terraform provider network mirror protocol](/docs/internals/provider-network-mirror-protocol.html). + [the Terraform provider network mirror protocol](/internals/provider-network-mirror-protocol). * `-platform=OS_ARCH` - Specify a platform you intend to use to work with this Terraform configuration. Terraform will ensure that the providers are all available for the given platform and will save enough package checksums in the lock file to support _at least_ the specified platforms. - - Use this option multiple times to include checksums for multiple target - systems. - Target platform names consist of an operating system and a CPU - architecture. For example, `linux_amd64` selects the Linux operating system - running on an AMD64 or x86_64 CPU. + Use this option multiple times to include checksums for multiple target + systems. - There is more detail on this option in the following section. + Target platform names consist of an operating system and a CPU + architecture. For example, `linux_amd64` selects the Linux operating system + running on an AMD64 or x86_64 CPU. + + There is more detail on this option in the following section. ## Specifying Target Platforms @@ -150,7 +148,7 @@ multiple times and specify a different subset of your providers each time. The `-fs-mirror` and `-net-mirror` options have the same meaning as `filesystem_mirror` and `network_mirror` blocks in -[the provider installation methods configuration](/docs/cli/config/config-file.html#provider-installation), +[the provider installation methods configuration](/cli/config/config-file#provider-installation), but specify only a single method in order to be explicit about where you intend to derive the package checksum information from. @@ -167,4 +165,4 @@ If you wish, you can publish your in-house providers via an in-house provider registry, which will then allow locking and installation of those providers without any special options or additional CLI configuration. For more information, see -[the provider registry protocol](/docs/internals/provider-registry-protocol.html). +[the provider registry protocol](/internals/provider-registry-protocol). diff --git a/website/docs/cli/commands/providers/mirror.html.md b/website/docs/cli/commands/providers/mirror.mdx similarity index 89% rename from website/docs/cli/commands/providers/mirror.html.md rename to website/docs/cli/commands/providers/mirror.mdx index b0827837e446..d6f9c8c8c852 100644 --- a/website/docs/cli/commands/providers/mirror.html.md +++ b/website/docs/cli/commands/providers/mirror.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: providers mirror" -sidebar_current: "docs-commands-providers-mirror" +page_title: 'Command: providers mirror' description: |- The `terraform providers mirror` command downloads the providers required for the current configuration and copies them into a directory in the local @@ -19,7 +17,7 @@ from provider registries as part of initializing the current working directory. Sometimes Terraform is running in an environment where that isn't possible, such as on an isolated network without access to the Terraform Registry. In that case, -[explicit installation method configuration](/docs/cli/config/config-file.html#explicit-installation-method-configuration) +[explicit installation method configuration](/cli/config/config-file#explicit-installation-method-configuration) allows you to configure Terraform, when running on a particular system, to consult only a local filesystem directory where you've created a local mirror of the necessary plugins, and to skip accessing the upstream registry at all. @@ -41,7 +39,7 @@ themselves. Terraform will also generate various `.json` index files which contain suitable responses to implement -[the network mirror protocol](/docs/internals/provider-network-mirror-protocol.html), +[the network mirror protocol](/internals/provider-network-mirror-protocol), if you upload the resulting directory to a static website host. Terraform ignores those index files when using the directory as a filesystem mirror, because the directory entries themselves are authoritative in that case. diff --git a/website/docs/cli/commands/providers/schema.html.md b/website/docs/cli/commands/providers/schema.mdx similarity index 93% rename from website/docs/cli/commands/providers/schema.html.md rename to website/docs/cli/commands/providers/schema.mdx index 2a3dddc1338e..fbdeafc70f69 100644 --- a/website/docs/cli/commands/providers/schema.html.md +++ b/website/docs/cli/commands/providers/schema.mdx @@ -1,9 +1,9 @@ --- -layout: "docs" -page_title: "Command: providers schema" -sidebar_current: "docs-commands-providers-schema" -description: |- - The `terraform providers schema` command prints detailed schemas for the providers used +page_title: 'Command: providers schema' +description: >- + The `terraform providers schema` command prints detailed schemas for the + providers used + in the current configuration. --- @@ -19,7 +19,7 @@ Usage: `terraform providers schema [options]` The list of available flags are: -* `-json` - Displays the schemas in a machine-readable, JSON format. +- `-json` - Displays the schemas in a machine-readable, JSON format. Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. @@ -34,7 +34,7 @@ value `"1.0"`. The semantics of this version are: version. We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +[the Terraform 1.0 Compatibility Promises](/language/v1-compatibility-promises). ## Format Summary diff --git a/website/docs/cli/commands/push.html.md b/website/docs/cli/commands/push.mdx similarity index 61% rename from website/docs/cli/commands/push.html.md rename to website/docs/cli/commands/push.mdx index bc093a85cb9a..7eb66776e917 100644 --- a/website/docs/cli/commands/push.html.md +++ b/website/docs/cli/commands/push.mdx @@ -1,16 +1,14 @@ --- -layout: "docs" -page_title: "Command: push" -sidebar_current: "docs-commands-push" -description: |- - DISCONTINUED. Terraform Cloud and the modern "remote" backend have replaced the old `terraform push` command. +page_title: 'Command: push' +description: >- + DISCONTINUED. Terraform Cloud and the modern "remote" backend have replaced + the old `terraform push` command. --- # Command: push -!> **Important:** The `terraform push` command is no longer functional. Its functionality was replaced and surpassed by [the `remote` backend](/docs/language/settings/backends/remote.html), which works with current versions of Terraform Cloud. The `remote` backend allows you to run remote operations directly from the command line, and displays real-time output from the remote run environment. +!> **Important:** The `terraform push` command is no longer functional. Its functionality was replaced and surpassed by [the `remote` backend](/language/settings/backends/remote), which works with current versions of Terraform Cloud. The `remote` backend allows you to run remote operations directly from the command line, and displays real-time output from the remote run environment. The `terraform push` command was an early implementation of remote Terraform runs. It allowed teams to push a configuration to a remote run environment in a discontinued version of Terraform Enterprise. The legacy Terraform Enterprise version that supported `terraform push` is no longer available, and there are no remaining instances of that version in operation. Without a service to push to, the command is now completely non-functional. - diff --git a/website/docs/cli/commands/refresh.html.md b/website/docs/cli/commands/refresh.mdx similarity index 88% rename from website/docs/cli/commands/refresh.html.md rename to website/docs/cli/commands/refresh.mdx index 55a007f38e20..f882e567dac9 100644 --- a/website/docs/cli/commands/refresh.html.md +++ b/website/docs/cli/commands/refresh.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: refresh" -sidebar_current: "docs-commands-refresh" +page_title: 'Command: refresh' description: |- The `terraform refresh` command reads the current settings from all managed remote objects and updates the Terraform state to match. @@ -14,19 +12,19 @@ description: |- The `terraform refresh` command reads the current settings from all managed remote objects and updates the Terraform state to match. -~> *Warning:* This command is deprecated, because its default behavior is +~> _Warning:_ This command is deprecated, because its default behavior is unsafe if you have misconfigured credentials for any of your providers. See below for more information and recommended alternatives. This won't modify your real remote objects, but it will modify the -[Terraform state](/docs/language/state/). +[Terraform state](/language/state/). You shouldn't typically need to use this command, because Terraform automatically performs the same refreshing actions as a part of creating a plan in both the -[`terraform plan`](./plan.html) +[`terraform plan`](/cli/commands/plan) and -[`terraform apply`](./apply.html) +[`terraform apply`](/cli/commands/apply) commands. This command is here primarily for backward compatibility, but we don't recommend using it because it provides no opportunity to review the effects of the operation before updating the state. @@ -42,7 +40,7 @@ terraform apply -refresh-only -auto-approve ``` Consequently, it supports all of the same options as -[`terraform apply`](./apply.html) except that it does not accept a saved +[`terraform apply`](/cli/commands/apply) except that it does not accept a saved plan file, it doesn't allow selecting a planning mode other than "refresh only", and `-auto-approve` is always enabled. diff --git a/website/docs/cli/commands/show.html.md b/website/docs/cli/commands/show.mdx similarity index 81% rename from website/docs/cli/commands/show.html.md rename to website/docs/cli/commands/show.mdx index 45bc6fa3f7d2..f956db19ba1d 100644 --- a/website/docs/cli/commands/show.html.md +++ b/website/docs/cli/commands/show.mdx @@ -1,9 +1,10 @@ --- -layout: "docs" -page_title: "Command: show" -sidebar_current: "docs-commands-show" -description: |- - The `terraform show` command is used to provide human-readable output from a state or plan file. This can be used to inspect a plan to ensure that the planned operations are expected, or to inspect the current state as Terraform sees it. +page_title: 'Command: show' +description: >- + The `terraform show` command is used to provide human-readable output from a + state or plan file. This can be used to inspect a plan to ensure that the + planned operations are expected, or to inspect the current state as Terraform + sees it. --- # Command: show @@ -18,7 +19,7 @@ flag. -> **Note:** When using the `-json` command-line flag, any sensitive values in Terraform state will be displayed in plain text. For more information, see -[Sensitive Data in State](/docs/language/state/sensitive-data.html). +[Sensitive Data in State](/language/state/sensitive-data). ## JSON Output @@ -34,7 +35,7 @@ was written, the state needs to be upgraded before it can be displayed with `-refresh=false`. If you are viewing a state file, run `terraform refresh` first. -The output format is covered in detail in [JSON Output Format](/docs/internals/json-format.html). +The output format is covered in detail in [JSON Output Format](/internals/json-format). ## Usage diff --git a/website/docs/cli/commands/state/index.html.md b/website/docs/cli/commands/state/index.mdx similarity index 82% rename from website/docs/cli/commands/state/index.html.md rename to website/docs/cli/commands/state/index.mdx index 38e2028d9d31..a39344b59935 100644 --- a/website/docs/cli/commands/state/index.html.md +++ b/website/docs/cli/commands/state/index.mdx @@ -1,16 +1,13 @@ --- -layout: "docs" -page_title: "Command: state" -sidebar_current: "docs-commands-state-index" -description: |- - The `terraform state` command is used for advanced state management. +page_title: 'Command: state' +description: The `terraform state` command is used for advanced state management. --- # State Command The `terraform state` command is used for advanced state management. As your Terraform usage becomes more advanced, there are some cases where -you may need to modify the [Terraform state](/docs/language/state/index.html). +you may need to modify the [Terraform state](/language/state/). Rather than modify the state directly, the `terraform state` commands can be used in many cases instead. @@ -35,7 +32,7 @@ written to disk and the CLI usage is the same as if it were local state. All `terraform state` subcommands that modify the state write backup files. The path of these backup file can be controlled with `-backup`. -Subcommands that are read-only (such as [list](/docs/cli/commands/state/list.html)) +Subcommands that are read-only (such as [list](/cli/commands/state/list)) do not write any backup files since they aren't modifying the state. Note that backups for state modification _can not be disabled_. Due to diff --git a/website/docs/cli/commands/state/list.html.md b/website/docs/cli/commands/state/list.mdx similarity index 84% rename from website/docs/cli/commands/state/list.html.md rename to website/docs/cli/commands/state/list.mdx index a7b78c94b620..38f48bbe603a 100644 --- a/website/docs/cli/commands/state/list.html.md +++ b/website/docs/cli/commands/state/list.mdx @@ -1,15 +1,14 @@ --- -layout: "docs" -page_title: "Command: state list" -sidebar_current: "docs-commands-state-sub-list" -description: |- - The terraform state list command is used to list resources within a Terraform state. +page_title: 'Command: state list' +description: >- + The terraform state list command is used to list resources within a Terraform + state. --- # Command: state list The `terraform state list` command is used to list resources within a -[Terraform state](/docs/language/state/index.html). +[Terraform state](/language/state/). ## Usage @@ -25,12 +24,12 @@ within modules are listed last. For complex infrastructures, the state can contain thousands of resources. To filter these, provide one or more patterns to the command. Patterns are -in [resource addressing format](/docs/cli/state/resource-addressing.html). +in [resource addressing format](/cli/state/resource-addressing). The command-line flags are all optional. The list of available flags are: * `-state=path` - Path to the state file. Defaults to "terraform.tfstate". - Ignored when [remote state](/docs/language/state/remote.html) is used. + Ignored when [remote state](/language/state/remote) is used. * `-id=id` - ID of resources to show. Ignored when unset. ## Example: All Resources diff --git a/website/docs/cli/commands/state/mv.html.md b/website/docs/cli/commands/state/mv.mdx similarity index 81% rename from website/docs/cli/commands/state/mv.html.md rename to website/docs/cli/commands/state/mv.mdx index 2cf2f8cd6c8d..17ee50370fe4 100644 --- a/website/docs/cli/commands/state/mv.html.md +++ b/website/docs/cli/commands/state/mv.mdx @@ -1,14 +1,13 @@ --- -layout: "docs" -page_title: "Command: state mv" -sidebar_current: "docs-commands-state-sub-mv" -description: |- - The `terraform state mv` command changes bindings in Terraform state, associating existing remote objects with new resource instances. +page_title: 'Command: state mv' +description: >- + The `terraform state mv` command changes bindings in Terraform state, + associating existing remote objects with new resource instances. --- # Command: state mv -The main function of [Terraform state](/docs/language/state/index.html) is +The main function of [Terraform state](/language/state/) is to track the bindings between resource instance addresses in your configuration and the remote objects they represent. Normally Terraform automatically updates the state in response to actions taken when applying a plan, such as @@ -29,7 +28,7 @@ remote objects currently associated with the source to be tracked instead by the destination. Both the source and destination addresses must use -[resource address syntax](/docs/cli/state/resource-addressing.html), and +[resource address syntax](/cli/state/resource-addressing), and they must both refer to the same kind of object: you can only move a resource instance to another resource instance, a whole module instance to another whole module instance, etc. Furthermore, if you are moving a resource or @@ -45,7 +44,7 @@ object and create a new object at the new address, and so `terraform state mv` allows you to override that interpretation by pre-emptively attaching the existing object to the new address in Terraform. -~> *Warning:* If you are using Terraform in a collaborative environment, you +~> _Warning:_ If you are using Terraform in a collaborative environment, you must ensure that when you are using `terraform state mv` for a code refactoring purpose you communicate carefully with your coworkers to ensure that nobody makes any other changes between your configuration change and your @@ -59,8 +58,8 @@ This command also accepts the following options: address without actually "forgetting" any of them. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -68,23 +67,22 @@ This command also accepts the following options: unit letter, such as "3s" for three seconds. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform state mv` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). -The legacy options [`-backup` and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments) +The legacy options [`-backup` and `-backup-out`](/language/settings/backends/local#command-line-arguments) operate on a local state file only. Configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) -must specify a local state file with the [`-state`](/docs/language/settings/backends/local.html#command-line-arguments) -option in order to use the [`-backup` and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments) +[the `remote` backend](/language/settings/backends/remote) +must specify a local state file with the [`-state`](/language/settings/backends/local#command-line-arguments) +option in order to use the [`-backup` and `-backup-out`](/language/settings/backends/local#command-line-arguments) options. - For configurations using -[the `local` state mv](/docs/language/settings/backends/local.html) only, +[the `local` state mv](/language/settings/backends/local) only, `terraform state mv` also accepts the legacy options -[`-state`, `-state-out`, `-backup`, and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, `-backup`, and `-backup-out`](/language/settings/backends/local#command-line-arguments). ## Example: Rename a Resource @@ -136,7 +134,7 @@ terraform state mv module.app module.parent.module.app ## Example: Move a Particular Instance of a Resource using `count` -A resource defined with [the `count` meta-argument](/docs/language/meta-arguments/count.html) +A resource defined with [the `count` meta-argument](/language/meta-arguments/count) has multiple instances that are each identified by an integer. You can select a particular instance by including an explicit index in your given address: @@ -161,7 +159,7 @@ The above examples show the typical quoting syntax for Unix-style shells. ## Example: Move a Resource configured with for_each -A resource defined with [the `for_each` meta-argument](/docs/language/meta-arguments/for_each.html) +A resource defined with [the `for_each` meta-argument](/language/meta-arguments/for_each) has multiple instances that are each identified by an string. You can select a particular instance by including an explicit key in your given address. diff --git a/website/docs/cli/commands/state/pull.html.md b/website/docs/cli/commands/state/pull.mdx similarity index 77% rename from website/docs/cli/commands/state/pull.html.md rename to website/docs/cli/commands/state/pull.mdx index ad52c96b6f60..5fc5a7ba3d87 100644 --- a/website/docs/cli/commands/state/pull.html.md +++ b/website/docs/cli/commands/state/pull.mdx @@ -1,15 +1,14 @@ --- -layout: "docs" -page_title: "Command: state pull" -sidebar_current: "docs-commands-state-sub-pull" -description: |- - The `terraform state pull` command is used to manually download and output the state from remote state. +page_title: 'Command: state pull' +description: >- + The `terraform state pull` command is used to manually download and output the + state from remote state. --- # Command: state pull The `terraform state pull` command is used to manually download and output -the state from [remote state](/docs/language/state/remote.html). This command also +the state from [remote state](/language/state/remote). This command also works with local state. ## Usage diff --git a/website/docs/cli/commands/state/push.html.md b/website/docs/cli/commands/state/push.html.md deleted file mode 100644 index 2ba8f21da9f7..000000000000 --- a/website/docs/cli/commands/state/push.html.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: "docs" -page_title: "Command: state push" -sidebar_current: "docs-commands-state-sub-push" -description: |- - The `terraform state push` command pushes items to the Terraform state. ---- - -# Command: state push - -The `terraform state push` command is used to manually upload a local -state file to [remote state](/docs/language/state/remote.html). This command also -works with local state. - -This command should rarely be used. It is meant only as a utility in case -manual intervention is necessary with the remote state. - -## Usage - -Usage: `terraform state push [options] PATH` - -This command will push the state specified by PATH to the currently -configured [backend](/docs/language/settings/backends/index.html). - -If PATH is "-" then the state data to push is read from stdin. This data -is loaded completely into memory and verified prior to being written to -the destination state. - -Terraform will perform a number of safety checks to prevent you from -making changes that appear to be unsafe: - - * **Differing lineage**: If the "lineage" value in the state differs, - Terraform will not allow you to push the state. A differing lineage - suggests that the states are completely different and you may lose - data. - - * **Higher remote serial**: If the "serial" value in the destination state - is higher than the state being pushed, Terraform will prevent the push. - A higher serial suggests that data is in the destination state that isn't - accounted for in the local state being pushed. - -Both of these safety checks can be disabled with the `-force` flag. -**This is not recommended.** If you disable the safety checks and are -pushing state, the destination state will be overwritten. - -For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) -only, `terraform state push` -also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). diff --git a/website/docs/cli/commands/state/push.mdx b/website/docs/cli/commands/state/push.mdx new file mode 100644 index 000000000000..ea3d9898aa95 --- /dev/null +++ b/website/docs/cli/commands/state/push.mdx @@ -0,0 +1,47 @@ +--- +page_title: 'Command: state push' +description: The `terraform state push` command pushes items to the Terraform state. +--- + +# Command: state push + +The `terraform state push` command is used to manually upload a local +state file to [remote state](/language/state/remote). This command also +works with local state. + +This command should rarely be used. It is meant only as a utility in case +manual intervention is necessary with the remote state. + +## Usage + +Usage: `terraform state push [options] PATH` + +This command will push the state specified by PATH to the currently +configured [backend](/language/settings/backends/). + +If PATH is "-" then the state data to push is read from stdin. This data +is loaded completely into memory and verified prior to being written to +the destination state. + +Terraform will perform a number of safety checks to prevent you from +making changes that appear to be unsafe: + +- **Differing lineage**: If the "lineage" value in the state differs, + Terraform will not allow you to push the state. A differing lineage + suggests that the states are completely different and you may lose + data. + +- **Higher remote serial**: If the "serial" value in the destination state + is higher than the state being pushed, Terraform will prevent the push. + A higher serial suggests that data is in the destination state that isn't + accounted for in the local state being pushed. + +Both of these safety checks can be disabled with the `-force` flag. +**This is not recommended.** If you disable the safety checks and are +pushing state, the destination state will be overwritten. + +For configurations using +[the `remote` backend](/language/settings/backends/remote) +only, `terraform state push` +also accepts the option +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). diff --git a/website/docs/cli/commands/state/replace-provider.html.md b/website/docs/cli/commands/state/replace-provider.mdx similarity index 65% rename from website/docs/cli/commands/state/replace-provider.html.md rename to website/docs/cli/commands/state/replace-provider.mdx index 21befd99e46c..6bbd7195eb11 100644 --- a/website/docs/cli/commands/state/replace-provider.html.md +++ b/website/docs/cli/commands/state/replace-provider.mdx @@ -1,15 +1,14 @@ --- -layout: "docs" -page_title: "Command: state replace-provider" -sidebar_current: "docs-commands-state-sub-replace-provider" -description: |- - The `terraform state replace-provider` command replaces the provider for resources in the Terraform state. +page_title: 'Command: state replace-provider' +description: >- + The `terraform state replace-provider` command replaces the provider for + resources in the Terraform state. --- # Command: state replace-provider The `terraform state replace-provider` command is used to replace the provider -for resources in a [Terraform state](/docs/language/state/index.html). +for resources in a [Terraform state](/language/state/). ## Usage @@ -28,22 +27,21 @@ This command also accepts the following options: * `-auto-approve` - Skip interactive approval. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=0s` - Duration to retry a state lock. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform state replace-provider` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` state rm](/docs/language/settings/backends/local.html) only, +[the `local` state rm](/language/settings/backends/local) only, `terraform state replace-provider` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). - +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Example diff --git a/website/docs/cli/commands/state/rm.html.md b/website/docs/cli/commands/state/rm.mdx similarity index 80% rename from website/docs/cli/commands/state/rm.html.md rename to website/docs/cli/commands/state/rm.mdx index 131c31a815f3..635a363a9bc6 100644 --- a/website/docs/cli/commands/state/rm.html.md +++ b/website/docs/cli/commands/state/rm.mdx @@ -1,14 +1,13 @@ --- -layout: "docs" -page_title: "Command: state rm" -sidebar_current: "docs-commands-state-sub-rm" -description: |- - The `terraform state rm` command removes bindings from the Terraform state, causing Terraform to "forget about" existing objects. +page_title: 'Command: state rm' +description: >- + The `terraform state rm` command removes bindings from the Terraform state, + causing Terraform to "forget about" existing objects. --- # Command: state rm -The main function of [Terraform state](/docs/language/state/index.html) is +The main function of [Terraform state](/language/state/) is to track the bindings between resource instance addresses in your configuration and the remote objects they represent. Normally Terraform automatically updates the state in response to actions taken when applying a plan, such as @@ -24,13 +23,13 @@ to exist in the remote system. Usage: `terraform state rm [options] ADDRESS...` Terraform will search the state for any instances matching the given -[resource address](/docs/cli/state/resource-addressing.html), and remove +[resource address](/cli/state/resource-addressing), and remove the record of each one so that Terraform will no longer be tracking the corresponding remote objects. This means that although the objects will still continue to exist in the remote system, a subsequent -[`terraform plan`](../plan.html) +[`terraform plan`](/cli/commands/plan) will include an action to create a new object for each of the "forgotten" instances. Depending on the constraints imposed by the remote system, creating those objects might fail if their names or other identifiers conflict with @@ -42,8 +41,8 @@ This command also accepts the following options: address without actually "forgetting" any of them. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -51,15 +50,15 @@ This command also accepts the following options: unit letter, such as "3s" for three seconds. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform state rm` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` state rm](/docs/language/settings/backends/local.html) only, +[the `local` state rm](/language/settings/backends/local) only, `terraform state rm` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Example: Remove all Instances of a Resource @@ -94,7 +93,7 @@ $ terraform state rm 'module.foo' ## Example: Remove a Particular Instance of a Resource using `count` -A resource defined with [the `count` meta-argument](/docs/language/meta-arguments/count.html) +A resource defined with [the `count` meta-argument](/language/meta-arguments/count) has multiple instances that are each identified by an integer. You can select a particular instance by including an explicit index in your given address: @@ -109,7 +108,7 @@ The above shows the typical quoting syntax for Unix-style shells. ## Example: Remove a Particular Instance of a Resource using `for_each` -A resource defined with [the `for_each` meta-argument](/docs/language/meta-arguments/for_each.html) +A resource defined with [the `for_each` meta-argument](/language/meta-arguments/for_each) has multiple instances that are each identified by an string. You can select a particular instance by including an explicit key in your given address. diff --git a/website/docs/cli/commands/state/show.html.md b/website/docs/cli/commands/state/show.mdx similarity index 78% rename from website/docs/cli/commands/state/show.html.md rename to website/docs/cli/commands/state/show.mdx index 2c665ba64004..a973b88c5cfc 100644 --- a/website/docs/cli/commands/state/show.html.md +++ b/website/docs/cli/commands/state/show.mdx @@ -1,16 +1,15 @@ --- -layout: "docs" -page_title: "Command: state show" -sidebar_current: "docs-commands-state-sub-show" -description: |- - The `terraform state show` command is used to show the attributes of a single resource in the Terraform state. +page_title: 'Command: state show' +description: >- + The `terraform state show` command is used to show the attributes of a single + resource in the Terraform state. --- # Command: state show The `terraform state show` command is used to show the attributes of a single resource in the -[Terraform state](/docs/language/state/index.html). +[Terraform state](/language/state/). ## Usage @@ -21,16 +20,16 @@ state file that matches the given address. This command requires an address that points to a single resource in the state. Addresses are -in [resource addressing format](/docs/cli/state/resource-addressing.html). +in [resource addressing format](/cli/state/resource-addressing). The command-line flags are all optional. The list of available flags are: * `-state=path` - Path to the state file. Defaults to "terraform.tfstate". - Ignored when [remote state](/docs/language/state/remote.html) is used. + Ignored when [remote state](/language/state/remote) is used. The output of `terraform state show` is intended for human consumption, not programmatic consumption. To extract state data for use in other software, use -[`terraform show -json`](/docs/cli/commands/show.html#json-output) and decode the result +[`terraform show -json`](/cli/commands/show#json-output) and decode the result using the documented structure. ## Example: Show a Resource @@ -61,7 +60,7 @@ $ terraform state show 'module.foo.packet_device.worker' ## Example: Show a Resource configured with count The example below shows the first instance of a `packet_device` resource named `worker` configured with -[`count`](/docs/language/meta-arguments/count.html): +[`count`](/language/meta-arguments/count): ```shell $ terraform state show 'packet_device.worker[0]' @@ -70,7 +69,7 @@ $ terraform state show 'packet_device.worker[0]' ## Example: Show a Resource configured with for_each The example below shows the `"example"` instance of a `packet_device` resource named `worker` configured with -[`for_each`](/docs/language/meta-arguments/for_each.html): +[`for_each`](/language/meta-arguments/for_each): Linux, Mac OS, and UNIX: diff --git a/website/docs/cli/commands/taint.html.md b/website/docs/cli/commands/taint.mdx similarity index 73% rename from website/docs/cli/commands/taint.html.md rename to website/docs/cli/commands/taint.mdx index aeffa1d7bcdb..f0fcf1b1a39c 100644 --- a/website/docs/cli/commands/taint.html.md +++ b/website/docs/cli/commands/taint.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: taint" -sidebar_current: "docs-commands-taint" +page_title: 'Command: taint' description: |- The `terraform taint` command informs Terraform that a particular object is damaged or degraded. @@ -14,12 +12,12 @@ become degraded or damaged. Terraform represents this by marking the object as "tainted" in the Terraform state, in which case Terraform will propose to replace it in the next plan you create. -~> *Warning:* This command is deprecated, because there are better alternatives +~> _Warning:_ This command is deprecated, because there are better alternatives available in Terraform v0.15.2 and later. See below for more details. If your intent is to force replacement of a particular object even though there are no configuration changes that would require it, we recommend instead -to use the `-replace` option with [`terraform apply`](./apply.html). +to use the `-replace` option with [`terraform apply`](/cli/commands/apply). For example: ``` @@ -44,13 +42,13 @@ Usage: `terraform taint [options] address` The `address` argument is the address of the resource to mark as tainted. The address is in -[the resource address syntax](/docs/cli/state/resource-addressing.html) syntax, +[the resource address syntax](/cli/state/resource-addressing) syntax, as shown in the output from other commands, such as: - * `aws_instance.foo` - * `aws_instance.bar[1]` - * `aws_instance.baz[\"key\"]` (quotes in resource addresses must be escaped on the command line, so that they will not be interpreted by your shell) - * `module.foo.module.bar.aws_instance.qux` +* `aws_instance.foo` +* `aws_instance.bar[1]` +* `aws_instance.baz[\"key\"]` (quotes in resource addresses must be escaped on the command line, so that they will not be interpreted by your shell) +* `module.foo.module.bar.aws_instance.qux` This command accepts the following options: @@ -68,12 +66,12 @@ This command accepts the following options: unit letter, such as "3s" for three seconds. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform taint` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform taint` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). diff --git a/website/docs/cli/commands/test.html.md b/website/docs/cli/commands/test.mdx similarity index 52% rename from website/docs/cli/commands/test.html.md rename to website/docs/cli/commands/test.mdx index 7edd1fb1b6c4..282c2171053f 100644 --- a/website/docs/cli/commands/test.html.md +++ b/website/docs/cli/commands/test.mdx @@ -1,15 +1,12 @@ --- -layout: "docs" -page_title: "Command: test" -sidebar_current: "docs-commands-test" -description: |- - Part of the ongoing design research for module integration testing. +page_title: 'Command: test' +description: Part of the ongoing design research for module integration testing. --- # Command: test The `terraform test` command is currently serving as part of -[the module integration testing experiment](/docs/language/modules/testing-experiment.html). +[the module integration testing experiment](/language/modules/testing-experiment). It's not ready for routine use, but if you'd be interested in trying the prototype functionality then we'd love to hear your feedback. See the diff --git a/website/docs/cli/commands/untaint.html.md b/website/docs/cli/commands/untaint.mdx similarity index 78% rename from website/docs/cli/commands/untaint.html.md rename to website/docs/cli/commands/untaint.mdx index 12793958b81b..85e210a6a3e4 100644 --- a/website/docs/cli/commands/untaint.html.md +++ b/website/docs/cli/commands/untaint.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: untaint" -sidebar_current: "docs-commands-untaint" +page_title: 'Command: untaint' description: |- The `terraform untaint` command tells Terraform that an object is functioning correctly, even though its creation failed or it was previously manually @@ -18,7 +16,7 @@ a multi-step "create" action, because Terraform can't be sure that the object was left in a fully-functional state. You can also manually mark an object as "tainted" using the deprecated command -[`terraform taint`](./taint.html), although we no longer recommend that +[`terraform taint`](/cli/commands/taint), although we no longer recommend that workflow. If Terraform currently considers a particular object as tainted but you've @@ -40,7 +38,7 @@ terraform apply -replace="aws_instance.example[0]" Usage: `terraform untaint [options] address` -The `address` argument is a [resource address](/docs/cli/state/resource-addressing.html) +The `address` argument is a [resource address](/cli/state/resource-addressing) identifying a particular resource instance which is currently tainted. This command also accepts the following options: @@ -51,8 +49,8 @@ This command also accepts the following options: the state. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -64,12 +62,12 @@ This command also accepts the following options: rendered by a system that cannot interpret terminal formatting. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform untaint` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform untaint` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). diff --git a/website/docs/cli/commands/validate.html.md b/website/docs/cli/commands/validate.mdx similarity index 56% rename from website/docs/cli/commands/validate.html.md rename to website/docs/cli/commands/validate.mdx index e81da01b27a4..fbbb03971699 100644 --- a/website/docs/cli/commands/validate.html.md +++ b/website/docs/cli/commands/validate.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: validate" -sidebar_current: "docs-commands-validate" -description: |- - The `terraform validate` command is used to validate the syntax of the terraform files. +page_title: 'Command: validate' +description: >- + The `terraform validate` command is used to validate the syntax of the + terraform files. --- # Command: validate @@ -39,11 +38,11 @@ Usage: `terraform validate [options]` This command accepts the following options: -- `-json` - Produce output in a machine-readable JSON format, suitable for +* `-json` - Produce output in a machine-readable JSON format, suitable for use in text editor integrations and other automated systems. Always disables color. -- `-no-color` - If specified, output won't contain any color. +* `-no-color` - If specified, output won't contain any color. ## JSON Output Format @@ -60,15 +59,15 @@ JSON, which it should then treat as a generic error case. The output includes a `format_version` key, which as of Terraform 1.1.0 has value `"1.0"`. The semantics of this version are: -- We will increment the minor version, e.g. `"1.1"`, for backward-compatible +* We will increment the minor version, e.g. `"1.1"`, for backward-compatible changes or additions. Ignore any object properties with unrecognized names to remain forward-compatible with future minor versions. -- We will increment the major version, e.g. `"2.0"`, for changes that are not +* We will increment the major version, e.g. `"2.0"`, for changes that are not backward-compatible. Reject any input which reports an unsupported major version. We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +[the Terraform 1.0 Compatibility Promises](/language/v1-compatibility-promises). In the normal case, Terraform will print a JSON object to the standard output stream. The top-level JSON object will have the following properties: @@ -95,93 +94,93 @@ The nested objects in `diagnostics` have the following properties: * `severity` (string): A string keyword, currently either `"error"` or `"warning"`, indicating the diagnostic severity. - The presence of errors causes Terraform to consider a configuration to be - invalid, while warnings are just advice or caveats to the user which do not - block working with the configuration. Later versions of Terraform may - introduce new severity keywords, so consumers should be prepared to accept - and ignore severity values they don't understand. + The presence of errors causes Terraform to consider a configuration to be + invalid, while warnings are just advice or caveats to the user which do not + block working with the configuration. Later versions of Terraform may + introduce new severity keywords, so consumers should be prepared to accept + and ignore severity values they don't understand. * `summary` (string): A short description of the nature of the problem that the diagnostic is reporting. - In Terraform's usual human-oriented diagnostic messages, the summary serves - as a sort of "heading" for the diagnostic, printed after the "Error:" or - "Warning:" indicator. + In Terraform's usual human-oriented diagnostic messages, the summary serves + as a sort of "heading" for the diagnostic, printed after the "Error:" or + "Warning:" indicator. - Summaries are typically short, single sentences, but can sometimes be longer - as a result of returning errors from subsystems that are not designed to - return full diagnostics, where the entire error message therefore becomes the - summary. In those cases, the summary might include newline characters which - a renderer should honor when presenting the message visually to a user. + Summaries are typically short, single sentences, but can sometimes be longer + as a result of returning errors from subsystems that are not designed to + return full diagnostics, where the entire error message therefore becomes the + summary. In those cases, the summary might include newline characters which + a renderer should honor when presenting the message visually to a user. * `detail` (string): An optional additional message giving more detail about the problem. - In Terraform's usual human-oriented diagnostic messages, the detail provides - the paragraphs of text that appear after the heading and the source location - reference. - - Detail messages are often multiple paragraphs and possibly interspersed with - non-paragraph lines, so tools which aim to present detail messages to the - user should distinguish between lines without leading spaces, treating them - as paragraphs, and lines with leading spaces, treating them as preformatted - text. Renderers should then soft-wrap the paragraphs to fit the width of the - rendering container, but leave the preformatted lines unwrapped. - - Some Terraform detail messages currently contain an approximation of bullet - lists using ASCII characters to mark the bullets. This is not currently a - contractural formatting convention and so renderers should avoid depending on - it and should instead treat those lines as either paragraphs or preformatted - text per the rules above. A future version of this format may define some - additional rules for processing other text conventions, but will do so within - the bounds of the rules above to achieve backward-compatibility. + In Terraform's usual human-oriented diagnostic messages, the detail provides + the paragraphs of text that appear after the heading and the source location + reference. + + Detail messages are often multiple paragraphs and possibly interspersed with + non-paragraph lines, so tools which aim to present detail messages to the + user should distinguish between lines without leading spaces, treating them + as paragraphs, and lines with leading spaces, treating them as preformatted + text. Renderers should then soft-wrap the paragraphs to fit the width of the + rendering container, but leave the preformatted lines unwrapped. + + Some Terraform detail messages currently contain an approximation of bullet + lists using ASCII characters to mark the bullets. This is not currently a + contractural formatting convention and so renderers should avoid depending on + it and should instead treat those lines as either paragraphs or preformatted + text per the rules above. A future version of this format may define some + additional rules for processing other text conventions, but will do so within + the bounds of the rules above to achieve backward-compatibility. * `range` (object): An optional object referencing a portion of the configuration source code that the diagnostic message relates to. For errors, this will typically indicate the bounds of the specific block header, attribute, or expression which was detected as invalid. - A source range is an object with a property `filename` which gives the - filename as a relative path from the current working directory, and then - two properties `start` and `end` which are both themselves objects - describing source positions, as described below. + A source range is an object with a property `filename` which gives the + filename as a relative path from the current working directory, and then + two properties `start` and `end` which are both themselves objects + describing source positions, as described below. - Not all diagnostic messages are connected with specific portions of the - configuration, so `range` will be omitted or `null` for diagnostic messages - where it isn't relevant. + Not all diagnostic messages are connected with specific portions of the + configuration, so `range` will be omitted or `null` for diagnostic messages + where it isn't relevant. * `snippet` (object): An optional object including an excerpt of the configuration source code that the diagnostic message relates to. - The snippet information includes: + The snippet information includes: - * `context` (string): An optional summary of the root context of the - diagnostic. For example, this might be the resource block containing the - expression which triggered the diagnostic. For some diagnostics this - information is not available, and then this property will be `null`. + * `context` (string): An optional summary of the root context of the + diagnostic. For example, this might be the resource block containing the + expression which triggered the diagnostic. For some diagnostics this + information is not available, and then this property will be `null`. - * `code` (string): A snippet of Terraform configuration including the - source of the diagnostic. This can be multiple lines and may include - additional configuration source code around the expression which - triggered the diagnostic. + * `code` (string): A snippet of Terraform configuration including the + source of the diagnostic. This can be multiple lines and may include + additional configuration source code around the expression which + triggered the diagnostic. - * `start_line` (number): A one-based line count representing the position - in the source file at which the `code` excerpt begins. This is not - necessarily the same value as `range.start.line`, as it is possible for - `code` to include one or more lines of context before the source of the - diagnostic. + * `start_line` (number): A one-based line count representing the position + in the source file at which the `code` excerpt begins. This is not + necessarily the same value as `range.start.line`, as it is possible for + `code` to include one or more lines of context before the source of the + diagnostic. - * `highlight_start_offset` (number): A zero-based character offset into the - `code` string, pointing at the start of the expression which triggered - the diagnostic. + * `highlight_start_offset` (number): A zero-based character offset into the + `code` string, pointing at the start of the expression which triggered + the diagnostic. - * `highlight_end_offset` (number): A zero-based character offset into the - `code` string, pointing at the end of the expression which triggered the - diagnostic. + * `highlight_end_offset` (number): A zero-based character offset into the + `code` string, pointing at the end of the expression which triggered the + diagnostic. - * `values` (array of objects): Contains zero or more expression values - which may be useful in understanding the source of a diagnostic in a - complex expression. These expression value objects are described below. + * `values` (array of objects): Contains zero or more expression values + which may be useful in understanding the source of a diagnostic in a + complex expression. These expression value objects are described below. ### Source Position diff --git a/website/docs/cli/commands/version.html.md b/website/docs/cli/commands/version.mdx similarity index 75% rename from website/docs/cli/commands/version.html.md rename to website/docs/cli/commands/version.mdx index 91798380180f..44b1db006fdd 100644 --- a/website/docs/cli/commands/version.html.md +++ b/website/docs/cli/commands/version.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: version" -sidebar_current: "docs-commands-version" -description: "The terraform version command displays the Terraform version and the version of all installed plugins." +page_title: 'Command: version' +description: >- + The terraform version command displays the Terraform version and the version + of all installed plugins. --- # Command: version @@ -16,12 +16,12 @@ Usage: `terraform version [options]` With no additional arguments, `version` will display the version of Terraform, the platform it's installed on, installed providers, and the results of upgrade -and security checks [unless disabled](/docs/cli/commands/index.html#upgrade-and-security-bulletin-checks). +and security checks [unless disabled](/cli/commands/#upgrade-and-security-bulletin-checks). This command has one optional flag: * `-json` - If specified, the version information is formatted as a JSON object, - and no upgrade or security information is included. + and no upgrade or security information is included. -> **Note:** Platform information was added to the `version` command in Terraform 0.15. @@ -51,4 +51,4 @@ $ terraform version -json }, "terraform_outdated": true } -``` \ No newline at end of file +``` diff --git a/website/docs/cli/commands/workspace/delete.html.md b/website/docs/cli/commands/workspace/delete.mdx similarity index 81% rename from website/docs/cli/commands/workspace/delete.html.md rename to website/docs/cli/commands/workspace/delete.mdx index 3fd077631cf0..cadfa6459e9c 100644 --- a/website/docs/cli/commands/workspace/delete.html.md +++ b/website/docs/cli/commands/workspace/delete.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace delete" -sidebar_current: "docs-commands-workspace-sub-delete" -description: |- - The terraform workspace delete command is used to delete a workspace. +page_title: 'Command: workspace delete' +description: The terraform workspace delete command is used to delete a workspace. --- # Command: workspace delete @@ -31,8 +28,8 @@ The command-line flags are all optional. The only supported flag is: * `-force` - Delete the workspace even if its state is not empty. Defaults to false. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Duration to retry a state lock. Default 0s. ## Example diff --git a/website/docs/cli/commands/workspace/index.html.md b/website/docs/cli/commands/workspace/index.mdx similarity index 60% rename from website/docs/cli/commands/workspace/index.html.md rename to website/docs/cli/commands/workspace/index.mdx index 6237a4133fc7..2d67b1d7c550 100644 --- a/website/docs/cli/commands/workspace/index.html.md +++ b/website/docs/cli/commands/workspace/index.mdx @@ -1,15 +1,12 @@ --- -layout: "docs" -page_title: "Command: workspace" -sidebar_current: "docs-commands-workspace-index" -description: "The workspace command helps you manage workspaces." - +page_title: 'Command: workspace' +description: The workspace command helps you manage workspaces. --- # Command: workspace The `terraform workspace` command is used to manage -[workspaces](/docs/language/state/workspaces.html). +[workspaces](/language/state/workspaces). This command is a container for further subcommands. These subcommands are listed in the navigation bar. diff --git a/website/docs/cli/commands/workspace/list.html.md b/website/docs/cli/commands/workspace/list.mdx similarity index 64% rename from website/docs/cli/commands/workspace/list.html.md rename to website/docs/cli/commands/workspace/list.mdx index 2114a60c66d7..d7d2e6eee285 100644 --- a/website/docs/cli/commands/workspace/list.html.md +++ b/website/docs/cli/commands/workspace/list.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace list" -sidebar_current: "docs-commands-workspace-sub-list" -description: |- - The terraform workspace list command is used to list all existing workspaces. +page_title: 'Command: workspace list' +description: The terraform workspace list command is used to list all existing workspaces. --- # Command: workspace list diff --git a/website/docs/cli/commands/workspace/new.html.md b/website/docs/cli/commands/workspace/new.mdx similarity index 83% rename from website/docs/cli/commands/workspace/new.html.md rename to website/docs/cli/commands/workspace/new.mdx index ef2e73ecf47d..28b4d1c30d4e 100644 --- a/website/docs/cli/commands/workspace/new.html.md +++ b/website/docs/cli/commands/workspace/new.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace new" -sidebar_current: "docs-commands-workspace-sub-new" -description: |- - The terraform workspace new command is used to create a new workspace. +page_title: 'Command: workspace new' +description: The terraform workspace new command is used to create a new workspace. --- # Command: workspace new @@ -23,8 +20,8 @@ will be copied to initialize the state for this new workspace. The command-line flags are all optional. The supported flags are: * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Duration to retry a state lock. Default 0s. * `-state=path` - Path to an existing state file to initialize the state of this environment. diff --git a/website/docs/cli/commands/workspace/select.html.md b/website/docs/cli/commands/workspace/select.mdx similarity index 69% rename from website/docs/cli/commands/workspace/select.html.md rename to website/docs/cli/commands/workspace/select.mdx index 08170a61eff6..f22f7aabeb6c 100644 --- a/website/docs/cli/commands/workspace/select.html.md +++ b/website/docs/cli/commands/workspace/select.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace select" -sidebar_current: "docs-commands-workspace-sub-select" -description: |- - The terraform workspace select command is used to choose a workspace. +page_title: 'Command: workspace select' +description: The terraform workspace select command is used to choose a workspace. --- # Command: workspace select diff --git a/website/docs/cli/commands/workspace/show.html.md b/website/docs/cli/commands/workspace/show.mdx similarity index 57% rename from website/docs/cli/commands/workspace/show.html.md rename to website/docs/cli/commands/workspace/show.mdx index 7cd7d5b5d140..c6063f22fddc 100644 --- a/website/docs/cli/commands/workspace/show.html.md +++ b/website/docs/cli/commands/workspace/show.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace show" -sidebar_current: "docs-commands-workspace-sub-show" -description: |- - The terraform workspace show command is used to output the current workspace. +page_title: 'Command: workspace show' +description: The terraform workspace show command is used to output the current workspace. --- # Command: workspace show diff --git a/website/docs/cli/config/config-file.html.md b/website/docs/cli/config/config-file.mdx similarity index 86% rename from website/docs/cli/config/config-file.html.md rename to website/docs/cli/config/config-file.mdx index 1aa83c40ef2b..105f503e73e9 100644 --- a/website/docs/cli/config/config-file.html.md +++ b/website/docs/cli/config/config-file.mdx @@ -1,15 +1,15 @@ --- -layout: "docs" -page_title: "CLI Configuration" -sidebar_current: "docs-commands-cli-config" -description: "Learn to use the CLI configuration file to customize your CLI settings, including credentials, plugin caching, provider installation methods, etc." +page_title: CLI Configuration +description: >- + Learn to use the CLI configuration file to customize your CLI settings, + including credentials, plugin caching, provider installation methods, etc. --- # CLI Configuration File (`.terraformrc` or `terraform.rc`) The CLI configuration file configures per-user settings for CLI behaviors, which apply across all Terraform working directories. This is separate from -[your infrastructure configuration](/docs/language/index.html). +[your infrastructure configuration](/language/). ## Locations @@ -31,7 +31,7 @@ as just `terraform.rc`. Use `dir` from PowerShell or Command Prompt to confirm the filename. The location of the Terraform CLI configuration file can also be specified -using the `TF_CLI_CONFIG_FILE` [environment variable](/docs/cli/config/environment-variables.html). +using the `TF_CLI_CONFIG_FILE` [environment variable](/cli/config/environment-variables). Any such file should follow the naming pattern `*.tfrc`. ## Configuration File Syntax @@ -50,38 +50,38 @@ disable_checkpoint = true The following settings can be set in the CLI configuration file: -- `credentials` - configures credentials for use with Terraform Cloud or +* `credentials` - configures credentials for use with Terraform Cloud or Terraform Enterprise. See [Credentials](#credentials) below for more information. -- `credentials_helper` - configures an external helper program for the storage +* `credentials_helper` - configures an external helper program for the storage and retrieval of credentials for Terraform Cloud or Terraform Enterprise. See [Credentials Helpers](#credentials-helpers) below for more information. -- `disable_checkpoint` — when set to `true`, disables - [upgrade and security bulletin checks](/docs/cli/commands/index.html#upgrade-and-security-bulletin-checks) +* `disable_checkpoint` — when set to `true`, disables + [upgrade and security bulletin checks](/cli/commands/#upgrade-and-security-bulletin-checks) that require reaching out to HashiCorp-provided network services. -- `disable_checkpoint_signature` — when set to `true`, allows the upgrade and +* `disable_checkpoint_signature` — when set to `true`, allows the upgrade and security bulletin checks described above but disables the use of an anonymous id used to de-duplicate warning messages. -- `plugin_cache_dir` — enables +* `plugin_cache_dir` — enables [plugin caching](#provider-plugin-cache) and specifies, as a string, the location of the plugin cache directory. -- `provider_installation` - customizes the installation methods used by +* `provider_installation` - customizes the installation methods used by `terraform init` when installing provider plugins. See [Provider Installation](#provider-installation) below for more information. ## Credentials -[Terraform Cloud](/docs/cloud/index.html) provides a number of remote network +[Terraform Cloud](/cloud-docs/) provides a number of remote network services for use with Terraform, and -[Terraform Enterprise](/docs/enterprise/index.html) allows hosting those +[Terraform Enterprise](/enterprise/) allows hosting those services inside your own infrastructure. For example, these systems offer both -[remote operations](/docs/cloud/run/cli.html) and a -[private module registry](/docs/cloud/registry/index.html). +[remote operations](/cloud-docs/run/cli) and a +[private module registry](/cloud-docs/registry/). When interacting with Terraform-specific network services, Terraform expects to find API tokens in CLI configuration files in `credentials` blocks: @@ -92,7 +92,7 @@ credentials "app.terraform.io" { } ``` -If you are running the Terraform CLI interactively on a computer with a web browser, you can use [the `terraform login` command](/docs/cli/commands/login.html) +If you are running the Terraform CLI interactively on a computer with a web browser, you can use [the `terraform login` command](/cli/commands/login) to get credentials and automatically save them in the CLI configuration. If not, you can manually write `credentials` blocks. @@ -104,9 +104,9 @@ giving the API token to use for that host. ~> **Important:** If you are using Terraform Cloud or Terraform Enterprise, the token provided must be either a -[user token](/docs/cloud/users-teams-organizations/users.html#api-tokens) +[user token](/cloud-docs/users-teams-organizations/users#api-tokens) or a -[team token](/docs/cloud/users-teams-organizations/api-tokens.html#team-api-tokens); +[team token](/cloud-docs/users-teams-organizations/api-tokens#team-api-tokens); organization tokens cannot be used for command-line Terraform actions. -> **Note:** The credentials hostname must match the hostname in your module @@ -144,7 +144,7 @@ for a specific hostname by writing a `credentials` block alongside the Terraform does not include any credentials helpers in the main distribution. To learn how to write and install your own credentials helpers to integrate with existing in-house credentials management systems, see -[the guide to Credentials Helper internals](/docs/internals/credentials-helpers.html). +[the guide to Credentials Helper internals](/internals/credentials-helpers). ## Provider Installation @@ -216,36 +216,36 @@ The following are the two supported installation method types: providers. This method requires the additional argument `path` to indicate which directory to look in. - Terraform expects the given directory to contain a nested directory structure - where the path segments together provide metadata about the available - providers. The following two directory structures are supported: + Terraform expects the given directory to contain a nested directory structure + where the path segments together provide metadata about the available + providers. The following two directory structures are supported: - * Packed layout: `HOSTNAME/NAMESPACE/TYPE/terraform-provider-TYPE_VERSION_TARGET.zip` - is the distribution zip file obtained from the provider's origin registry. - * Unpacked layout: `HOSTNAME/NAMESPACE/TYPE/VERSION/TARGET` is a directory - containing the result of extracting the provider's distribution zip file. + * Packed layout: `HOSTNAME/NAMESPACE/TYPE/terraform-provider-TYPE_VERSION_TARGET.zip` + is the distribution zip file obtained from the provider's origin registry. + * Unpacked layout: `HOSTNAME/NAMESPACE/TYPE/VERSION/TARGET` is a directory + containing the result of extracting the provider's distribution zip file. - In both layouts, the `VERSION` is a string like `2.0.0` and the `TARGET` - specifies a particular target platform using a format like `darwin_amd64`, - `linux_arm`, `windows_amd64`, etc. + In both layouts, the `VERSION` is a string like `2.0.0` and the `TARGET` + specifies a particular target platform using a format like `darwin_amd64`, + `linux_arm`, `windows_amd64`, etc. - If you use the unpacked layout, Terraform will attempt to create a symbolic - link to the mirror directory when installing the provider, rather than - creating a deep copy of the directory. The packed layout prevents this - because Terraform must extract the zip file during installation. + If you use the unpacked layout, Terraform will attempt to create a symbolic + link to the mirror directory when installing the provider, rather than + creating a deep copy of the directory. The packed layout prevents this + because Terraform must extract the zip file during installation. - You can include multiple `filesystem_mirror` blocks in order to specify - several different directories to search. + You can include multiple `filesystem_mirror` blocks in order to specify + several different directories to search. * `network_mirror`: consult a particular HTTPS server for copies of providers, regardless of which registry host they belong to. This method requires the additional argument `url` to indicate the mirror base URL, which should use the `https:` scheme and end with a trailing slash. - Terraform expects the given URL to be a base URL for an implementation of - [the provider network mirror protocol](/docs/internals/provider-network-mirror-protocol.html), - which is designed to be relatively easy to implement using typical static - website hosting mechanisms. + Terraform expects the given URL to be a base URL for an implementation of + [the provider network mirror protocol](/internals/provider-network-mirror-protocol), + which is designed to be relatively easy to implement using typical static + website hosting mechanisms. ~> **Warning:** Don't configure `network_mirror` URLs that you do not trust. Provider mirror servers are subject to TLS certificate checks to verify @@ -402,7 +402,7 @@ provider_installation { With development overrides in effect, the `terraform init` command will still attempt to select a suitable published version of your provider to install and record in -[the dependency lock file](/docs/language/dependency-lock.html) +[the dependency lock file](/language/dependency-lock) for future use, but other commands like `terraform apply` will disregard the lock file's entry for `hashicorp/null` and will use the given directory instead. Once your new changes are included in a diff --git a/website/docs/cli/config/environment-variables.html.md b/website/docs/cli/config/environment-variables.mdx similarity index 88% rename from website/docs/cli/config/environment-variables.html.md rename to website/docs/cli/config/environment-variables.mdx index 55997e97ea34..ffe749ec6a59 100644 --- a/website/docs/cli/config/environment-variables.html.md +++ b/website/docs/cli/config/environment-variables.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Environment Variables" -sidebar_current: "docs-commands-environment-variables" -description: "Learn to use environment variables to change Terraform's default behavior. Configure log content and output, set variables, and more." +page_title: Environment Variables +description: >- + Learn to use environment variables to change Terraform's default behavior. + Configure log content and output, set variables, and more. --- # Environment Variables @@ -27,7 +27,7 @@ To disable, either unset it, or set it to `off`. For example: export TF_LOG=off ``` -For more on debugging Terraform, check out the section on [Debugging](/docs/internals/debugging.html). +For more on debugging Terraform, check out the section on [Debugging](/internals/debugging). ## TF_LOG_PATH @@ -37,7 +37,7 @@ This specifies where the log should persist its output to. Note that even when ` export TF_LOG_PATH=./terraform.log ``` -For more on debugging Terraform, check out the section on [Debugging](/docs/internals/debugging.html). +For more on debugging Terraform, check out the section on [Debugging](/internals/debugging). ## TF_INPUT @@ -58,9 +58,10 @@ export TF_VAR_alist='[1,2,3]' export TF_VAR_amap='{ foo = "bar", baz = "qux" }' ``` -For more on how to use `TF_VAR_name` in context, check out the section on [Variable Configuration](/docs/language/values/variables.html). +For more on how to use `TF_VAR_name` in context, check out the section on [Variable Configuration](/language/values/variables). ## TF_CLI_ARGS and TF_CLI_ARGS_name + The value of `TF_CLI_ARGS` will specify additional arguments to the @@ -113,8 +114,7 @@ export TF_WORKSPACE=your_workspace Using this environment variable is recommended only for non-interactive usage, since in a local shell environment it can be easy to forget the variable is set and apply changes to the wrong state. -For more information regarding workspaces, check out the section on [Using Workspaces] -(https://www.terraform.io/docs/language/state/workspaces.html). +For more information regarding workspaces, check out the section on [Using Workspaces](/language/state/workspaces). ## TF_IN_AUTOMATION @@ -145,7 +145,7 @@ export TF_REGISTRY_CLIENT_TIMEOUT=15 ## TF_CLI_CONFIG_FILE -The location of the [Terraform CLI configuration file](/docs/cli/config/config-file.html). +The location of the [Terraform CLI configuration file](/cli/config/config-file). ```shell export TF_CLI_CONFIG_FILE="$HOME/.terraformrc-custom" @@ -159,4 +159,4 @@ If `TF_IGNORE` is set to "trace", Terraform will output debug messages to displa export TF_IGNORE=trace ``` -For more details on `.terraformignore`, please see [Excluding Files from Upload with .terraformignore](/docs/language/settings/backends/remote.html#excluding-files-from-upload-with-terraformignore). +For more details on `.terraformignore`, please see [Excluding Files from Upload with .terraformignore](/language/settings/backends/remote#excluding-files-from-upload-with-terraformignore). diff --git a/website/docs/cli/config/index.html.md b/website/docs/cli/config/index.mdx similarity index 68% rename from website/docs/cli/config/index.html.md rename to website/docs/cli/config/index.mdx index afe00e8f2fb8..8261c614f888 100644 --- a/website/docs/cli/config/index.html.md +++ b/website/docs/cli/config/index.mdx @@ -1,7 +1,9 @@ --- -layout: "docs" -page_title: "CLI Configuration - Terraform CLI" -description: "Find documentation about the CLI config file and customizing Terraform environment variables." +page_title: CLI Configuration - Terraform CLI +description: >- + Find documentation about the CLI config file and customizing Terraform + environment variables. +sidebar_title: CLI Configuration --- # CLI Configuration @@ -15,9 +17,9 @@ most of the global settings relate to advanced or automated workflows, or unusual environmental conditions like running Terraform on an airgapped instance. -- The [CLI config file](/docs/cli/config/config-file.html) configures provider +- The [CLI config file](/cli/config/config-file) configures provider installation and security features. -- Several [environment variables](/docs/cli/config/environment-variables.html) can +- Several [environment variables](/cli/config/environment-variables) can configure Terraform's inputs and outputs; this includes some alternate ways to provide information that is usually passed on the command line or read from the state of the shell. diff --git a/website/docs/cli/import/importability.html.md b/website/docs/cli/import/importability.mdx similarity index 82% rename from website/docs/cli/import/importability.html.md rename to website/docs/cli/import/importability.mdx index 79d78d90a2e6..88a200a4e1ad 100644 --- a/website/docs/cli/import/importability.html.md +++ b/website/docs/cli/import/importability.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Import: Resource Importability" -sidebar_current: "docs-import-importability" +page_title: 'Import: Resource Importability' description: |- Each resource in Terraform must implement some basic logic to become importable. As a result, not all Terraform resources are currently importable. @@ -21,4 +19,4 @@ you're interested in contributing that functionality, the Terraform team would be grateful. To make a resource importable, please see -[Extending Terraform: Resources — Import](/docs/extend/resources/import.html). +[Extending Terraform: Resources — Import](/plugin/sdkv2/resources/import). diff --git a/website/docs/cli/import/index.html.md b/website/docs/cli/import/index.mdx similarity index 81% rename from website/docs/cli/import/index.html.md rename to website/docs/cli/import/index.mdx index b06c668fc0df..c1e3b33ad05d 100644 --- a/website/docs/cli/import/index.html.md +++ b/website/docs/cli/import/index.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Import" -sidebar_current: "docs-import" -description: "Terraform can import and manage existing infrastructure. This can help you transition your infrastructure to Terraform." +page_title: Import +description: >- + Terraform can import and manage existing infrastructure. This can help you + transition your infrastructure to Terraform. --- # Import @@ -23,12 +23,12 @@ itself having created all objects. If you import existing objects into Terraform be careful to import each remote object to only one Terraform resource address. If you import the same object multiple times, Terraform may exhibit unwanted behavior. For more information on this assumption, see -[the State section](/docs/language/state/index.html). +[the State section](/language/state/). ## Currently State Only The current implementation of Terraform import can only import resources -into the [state](/docs/language/state/index.html). It does not generate configuration. A future +into the [state](/language/state/). It does not generate configuration. A future version of Terraform will also generate configuration. Because of this, prior to running `terraform import` it is necessary to write @@ -41,7 +41,7 @@ importing existing resources. ## Remote Backends When using Terraform import on the command line with a [remote -backend](/docs/language/settings/backends/remote.html), such as Terraform Cloud, the import +backend](/language/settings/backends/remote), such as Terraform Cloud, the import command runs locally, unlike commands such as apply, which run inside your Terraform Cloud environment. Because of this, the import command will not have access to information from the remote backend, such as workspace variables. diff --git a/website/docs/cli/import/usage.html.md b/website/docs/cli/import/usage.mdx similarity index 90% rename from website/docs/cli/import/usage.html.md rename to website/docs/cli/import/usage.mdx index 4fdc5452d02e..b631dfd8ef27 100644 --- a/website/docs/cli/import/usage.html.md +++ b/website/docs/cli/import/usage.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Import: Usage" -sidebar_current: "docs-import-usage" -description: |- - The `terraform import` command is used to import existing infrastructure. +page_title: 'Import: Usage' +description: The `terraform import` command is used to import existing infrastructure. --- # Import Usage @@ -23,7 +20,7 @@ itself having created all objects. If you import existing objects into Terraform be careful to import each remote object to only one Terraform resource address. If you import the same object multiple times, Terraform may exhibit unwanted behavior. For more information on this assumption, see -[the State section](/docs/language/state/index.html). +[the State section](/language/state/). To import a resource, first write a resource block for it in your configuration, establishing the name by which it will be known to Terraform: @@ -57,7 +54,7 @@ Terraform state. It is also possible to import to resources in child modules, using their paths, and to single instances of a resource with `count` or `for_each` set. See -[_Resource Addressing_](/docs/cli/state/resource-addressing.html) for more +[_Resource Addressing_](/cli/state/resource-addressing) for more details on how to specify a target resource. The syntax of the given ID is dependent on the resource type being imported. @@ -83,4 +80,4 @@ a `resource` block in configuration for each secondary resource. If this is not done, Terraform will plan to destroy the imported objects on the next run. If you want to rename or otherwise move the imported resources, the -[state management commands](/docs/cli/commands/state/index.html) can be used. +[state management commands](/cli/commands/state/) can be used. diff --git a/website/docs/cli/index.html.md b/website/docs/cli/index.mdx similarity index 67% rename from website/docs/cli/index.html.md rename to website/docs/cli/index.mdx index f52fb1bc5e9a..e4638311a500 100644 --- a/website/docs/cli/index.html.md +++ b/website/docs/cli/index.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Terraform CLI Documentation" -sidebar_current: "docs-home" -description: "Learn how to use Terraform's CLI-based workflows. You can use the CLI alone or in conjunction with Terraform Cloud or Terraform Enterprise." +page_title: Terraform CLI Documentation +description: >- + Learn how to use Terraform's CLI-based workflows. You can use the CLI alone or + in conjunction with Terraform Cloud or Terraform Enterprise. --- # Terraform CLI Documentation @@ -16,4 +16,4 @@ Cloud or Terraform Enterprise. Notably, this documentation does not cover the syntax and usage of the Terraform language. For that, see the -[Terraform Language Documentation](/docs/language/index.html). +[Terraform Language Documentation](/language/). diff --git a/website/docs/cli/init/index.html.md b/website/docs/cli/init/index.mdx similarity index 85% rename from website/docs/cli/init/index.html.md rename to website/docs/cli/init/index.mdx index 1fc581e3f235..58c8837d6aa7 100644 --- a/website/docs/cli/init/index.html.md +++ b/website/docs/cli/init/index.mdx @@ -1,14 +1,17 @@ --- -layout: "docs" -page_title: "Initializing Working Directories - Terraform CLI" -description: "Working directories contain configurations, settings, cached plugins and modules, and state data. Learn how to initialize and manage working directories." +page_title: Initializing Working Directories - Terraform CLI +description: >- + Working directories contain configurations, settings, cached plugins and + modules, and state data. Learn how to initialize and manage working + directories. +sidebar_title: Initializing Working Directories --- # Initializing Working Directories Terraform expects to be invoked from a working directory that contains configuration files written in -[the Terraform language](/docs/language/index.html). Terraform uses +[the Terraform language](/language/). Terraform uses configuration content from this directory, and also uses the directory to store settings, cached plugins and modules, and sometimes state data. @@ -23,7 +26,7 @@ A Terraform working directory typically contains: configuration is expected to change over time. - A hidden `.terraform` directory, which Terraform uses to manage cached provider plugins and modules, record which - [workspace](/docs/cli/workspaces/index.html) is currently active, and + [workspace](/cli/workspaces/) is currently active, and record the last known backend configuration in case it needs to migrate state on the next run. This directory is automatically managed by Terraform, and is created during initialization. @@ -48,7 +51,7 @@ plugins, and downloading modules. Under some conditions (usually when changing from one backend to another), it might ask the user for guidance or confirmation. -For details, see [the `terraform init` command](/docs/cli/commands/init.html). +For details, see [the `terraform init` command](/cli/commands/init). ## Reinitialization diff --git a/website/docs/cli/inspect/index.html.md b/website/docs/cli/inspect/index.mdx similarity index 63% rename from website/docs/cli/inspect/index.html.md rename to website/docs/cli/inspect/index.mdx index 3fac82ed52b1..2dd1c5fd7cc8 100644 --- a/website/docs/cli/inspect/index.html.md +++ b/website/docs/cli/inspect/index.mdx @@ -1,7 +1,9 @@ --- -layout: "docs" -page_title: "Inspecting Infrastructure - Terraform CLI" -description: "Learn commands to inspect dependency information, outputs, etc. Use them for integration or to understand your infrastructure." +page_title: Inspecting Infrastructure - Terraform CLI +description: >- + Learn commands to inspect dependency information, outputs, etc. Use them for + integration or to understand your infrastructure. +sidebar_title: Inspecting Infrastructure --- # Inspecting Infrastructure @@ -16,19 +18,19 @@ Terraform CLI includes some commands for inspecting or transforming this data. You can use these to integrate other tools with Terraform's infrastructure data, or just to gain a deeper or more holistic understanding of your infrastructure. -- [The `terraform graph` command](/docs/cli/commands/graph.html) creates a visual +- [The `terraform graph` command](/cli/commands/graph) creates a visual representation of a configuration or a set of planned changes. -- [The `terraform output` command](/docs/cli/commands/output.html) can get the - values for the top-level [output values](/docs/language/values/outputs.html) of +- [The `terraform output` command](/cli/commands/output) can get the + values for the top-level [output values](/language/values/outputs) of a configuration, which are often helpful when making use of the infrastructure Terraform has provisioned. -- [The `terraform show` command](/docs/cli/commands/show.html) can generate +- [The `terraform show` command](/cli/commands/show) can generate human-readable versions of a state file or plan file, or generate machine-readable versions that can be integrated with other tools. -- [The `terraform state list` command](/docs/cli/commands/state/list.html) can list +- [The `terraform state list` command](/cli/commands/state/list) can list the resources being managed by the current working directory and workspace, providing a complete or filtered list. -- [The `terraform state show` command](/docs/cli/commands/state/show.html) can print +- [The `terraform state show` command](/cli/commands/state/show) can print all of the attributes of a given resource being managed by the current working directory and workspace, including generated read-only attributes like the unique ID assigned by the cloud provider. diff --git a/website/docs/cli/install/apt.html.md b/website/docs/cli/install/apt.mdx similarity index 94% rename from website/docs/cli/install/apt.html.md rename to website/docs/cli/install/apt.mdx index 5b88b9613f23..c662fa9dce1f 100644 --- a/website/docs/cli/install/apt.html.md +++ b/website/docs/cli/install/apt.mdx @@ -1,9 +1,8 @@ --- -layout: "downloads" -page_title: "APT Packages for Debian and Ubuntu" -sidebar_current: "docs-cli-install-apt" -description: |- - The HashiCorp APT repositories contain distribution-specific Terraform packages for both Debian and Ubuntu systems. +page_title: APT Packages for Debian and Ubuntu +description: >- + The HashiCorp APT repositories contain distribution-specific Terraform + packages for both Debian and Ubuntu systems. --- # APT Packages for Debian and Ubuntu @@ -16,7 +15,7 @@ Debian and Ubuntu systems, which allow you to install Terraform using the `apt install` command or any other APT frontend. If you are instead using Red Hat Enterprise Linux, CentOS, or Fedora, you -might prefer to [install Terraform from our Yum repositories](yum.html). +might prefer to [install Terraform from our Yum repositories](/cli/install/yum). -> **Note:** The APT repositories discussed on this page are generic HashiCorp repositories that contain packages for a variety of different HashiCorp @@ -67,7 +66,7 @@ architecture, which is also sometimes known as `x86_64`. There are no official packages available for other architectures, such as `arm64`. If you wish to use Terraform on a non-`amd64` system, -[download a normal release `.zip` file](/downloads.html) instead. +[download a normal release `.zip` file](/downloads) instead. ## Supported Debian and Ubuntu Releases diff --git a/website/docs/cli/install/yum.html.md b/website/docs/cli/install/yum.mdx similarity index 91% rename from website/docs/cli/install/yum.html.md rename to website/docs/cli/install/yum.mdx index 45e88e0eb445..accc2d3f3d9b 100644 --- a/website/docs/cli/install/yum.html.md +++ b/website/docs/cli/install/yum.mdx @@ -1,9 +1,8 @@ --- -layout: "downloads" -page_title: "Yum Packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux" -sidebar_current: "docs-cli-install-yum" -description: |- - The HashiCorp Yum repositories contain distribution-specific Terraform packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux systems. +page_title: 'Yum Packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux' +description: >- + The HashiCorp Yum repositories contain distribution-specific Terraform + packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux systems. --- # Yum/DNF Packages for RHEL, CentOS, and Fedora @@ -16,7 +15,7 @@ RedHat Enterprise Linux, Fedora, and Amazon Linux systems, which allow you to install Terraform using the `yum install` or `dnf install` commands. If you are instead using Debian or Ubuntu, you -might prefer to [install Terraform from our APT repositories](apt.html). +might prefer to [install Terraform from our APT repositories](/cli/install/apt). -> **Note:** The Yum repositories discussed on this page are generic HashiCorp repositories that contain packages for a variety of different HashiCorp @@ -64,7 +63,7 @@ architecture, which is also sometimes known as `amd64`. There are no official packages available for other architectures, such as `aarch64`. If you wish to use Terraform on a non-`x86_64` system, -[download a normal release `.zip` file](/downloads.html) instead. +[download a normal release `.zip` file](/downloads) instead. ## Supported Distribution Releases diff --git a/website/docs/cli/plugins/index.html.md b/website/docs/cli/plugins/index.mdx similarity index 65% rename from website/docs/cli/plugins/index.html.md rename to website/docs/cli/plugins/index.mdx index 95edb225ec1d..7b12e945a1a5 100644 --- a/website/docs/cli/plugins/index.html.md +++ b/website/docs/cli/plugins/index.mdx @@ -1,14 +1,16 @@ --- -layout: "docs" -page_title: "Managing Plugins - Terraform CLI" -description: "Commands to install, configure, and show information about providers. Also commands to reduce install effort in air-gapped environments." +page_title: Managing Plugins - Terraform CLI +description: >- + Commands to install, configure, and show information about providers. Also + commands to reduce install effort in air-gapped environments. +sidebar_title: Managing Plugins --- # Managing Plugins Terraform relies on plugins called "providers" in order to manage various types of resources. (For more information about providers, see -[Providers](/docs/language/providers/index.html) in the Terraform +[Providers](/language/providers/) in the Terraform language docs.) -> **Note:** Providers are currently the only plugin type most Terraform users @@ -16,8 +18,8 @@ will interact with. Terraform also supports third-party provisioner plugins, but we discourage their use. Terraform downloads and/or installs any providers -[required](/docs/language/providers/requirements.html) by a configuration -when [initializing](/docs/cli/init/index.html) a working directory. By default, +[required](/language/providers/requirements) by a configuration +when [initializing](/cli/init/) a working directory. By default, this works without any additional interaction but requires network access to download providers from their source registry. @@ -31,29 +33,29 @@ environments. Terraform's configuration file includes options for caching downloaded plugins, or explicitly specifying a local or HTTPS mirror to install plugins from. For -more information, see [CLI Config File](/docs/cli/config/config-file.html). +more information, see [CLI Config File](/cli/config/config-file). ## Getting Plugin Information -Use the [`terraform providers`](/docs/cli/commands/providers.html) command to get information +Use the [`terraform providers`](/cli/commands/providers) command to get information about the providers required by the current working directory's configuration. -Use the [`terraform version`](/docs/cli/commands/version.html) command (or +Use the [`terraform version`](/cli/commands/version) command (or `terraform -version`) to show the specific provider versions installed for the current working directory. -Use the [`terraform providers schema`](/docs/cli/commands/providers/schema.html) command to +Use the [`terraform providers schema`](/cli/commands/providers/schema) command to get machine-readable information about the resources and configuration options offered by each provider. ## Managing Plugin Installation -Use the [`terraform providers mirror`](/docs/cli/commands/providers/mirror.html) command to +Use the [`terraform providers mirror`](/cli/commands/providers/mirror) command to download local copies of every provider required by the current working directory's configuration. This directory will use the nested directory layout that Terraform expects when installing plugins from a local source, so you can transfer it directly to an airgapped system that runs Terraform. -Use the [`terraform providers lock`](/docs/cli/commands/providers/lock.html) command +Use the [`terraform providers lock`](/cli/commands/providers/lock) command to update the lock file that Terraform uses to ensure predictable runs when using ambiguous provider version constraints. diff --git a/website/docs/cli/plugins/signing.html.md b/website/docs/cli/plugins/signing.mdx similarity index 70% rename from website/docs/cli/plugins/signing.html.md rename to website/docs/cli/plugins/signing.mdx index 9c82157d3f58..cdcd546d68f5 100644 --- a/website/docs/cli/plugins/signing.html.md +++ b/website/docs/cli/plugins/signing.mdx @@ -1,7 +1,8 @@ --- -layout: "docs" -page_title: "Plugin Signing" -description: "Learn about the types of signatures providers can have on the Terraform Registry." +page_title: Plugin Signing +description: >- + Learn about the types of signatures providers can have on the Terraform + Registry. --- @@ -14,11 +15,11 @@ Terraform providers installed from the Registry are cryptographically signed, an * **Signed by HashiCorp** - are built, signed, and supported by HashiCorp. * **Signed by Trusted Partners** - are built, signed, and supported by a third party. HashiCorp has -verified the ownership of the private key and we provide a chain of trust to the CLI to verify this -programatically. + verified the ownership of the private key and we provide a chain of trust to the CLI to verify this + programatically. * **Self-signed** - are built, signed, and supported by a third party. HashiCorp does not provide a -verification or chain of trust for the signature. You may obtain and validate fingerprints manually -if you want to ensure you are using a binary you can trust. + verification or chain of trust for the signature. You may obtain and validate fingerprints manually + if you want to ensure you are using a binary you can trust. Terraform does **NOT** support fetching and using unsigned binaries, but you can manually install unsigned binaries. You should take extreme care when doing so as no programatic authentication is performed. diff --git a/website/docs/cli/run/index.html.md b/website/docs/cli/run/index.mdx similarity index 82% rename from website/docs/cli/run/index.html.md rename to website/docs/cli/run/index.mdx index 0d0770a34ac0..a3f8872797e6 100644 --- a/website/docs/cli/run/index.html.md +++ b/website/docs/cli/run/index.mdx @@ -1,14 +1,14 @@ --- -layout: "docs" -page_title: "Provisioning Infrastructure - Terraform CLI" -description: "Learn about commands for core provisioning tasks: plan, apply, and destroy." +page_title: Provisioning Infrastructure - Terraform CLI +description: 'Learn about commands for core provisioning tasks: plan, apply, and destroy.' +sidebar_title: Provisioning Infrastructure --- # Provisioning Infrastructure with Terraform Terraform's primary function is to create, modify, and destroy infrastructure resources to match the desired state described in a -[Terraform configuration](/docs/language/index.html). +[Terraform configuration](/language/). When people refer to "running Terraform," they generally mean performing these provisioning actions in order to affect real infrastructure objects. The @@ -17,8 +17,8 @@ actions, but these basic provisioning tasks are the core of Terraform. Terraform's provisioning workflow relies on three commands: `plan`, `apply`, and `destroy`. All of these commands require an -[initialized](/docs/cli/init/index.html) working directory, and all of them act -only upon the currently selected [workspace](/docs/cli/workspaces/index.html). +[initialized](/cli/init/) working directory, and all of them act +only upon the currently selected [workspace](/cli/workspaces/). ## Planning @@ -39,7 +39,7 @@ resulting actions are as expected. However, `terraform plan` can also save its plan as a runnable artifact, which `terraform apply` can use to carry out those exact changes. -For details, see [the `terraform plan` command](/docs/cli/commands/plan.html). +For details, see [the `terraform plan` command](/cli/commands/plan). ## Applying @@ -55,7 +55,7 @@ running a new plan. You can use this to reliably perform an exact set of pre-approved changes, even if the configuration or the state of the real infrastructure has changed in the minutes since the original plan was created. -For details, see [the `terraform apply` command](/docs/cli/commands/apply.html). +For details, see [the `terraform apply` command](/cli/commands/apply). ## Destroying @@ -69,4 +69,4 @@ and then running an apply, except that it doesn't require editing the configuration. This is more convenient if you intend to provision similar resources at a later date. -For details, see [the `terraform destroy` command](/docs/cli/commands/destroy.html). +For details, see [the `terraform destroy` command](/cli/commands/destroy). diff --git a/website/docs/cli/state/index.html.md b/website/docs/cli/state/index.mdx similarity index 66% rename from website/docs/cli/state/index.html.md rename to website/docs/cli/state/index.mdx index 7f12fea4f501..803e15a0387d 100644 --- a/website/docs/cli/state/index.html.md +++ b/website/docs/cli/state/index.mdx @@ -1,14 +1,16 @@ --- -layout: "docs" -page_title: "Manipulating State - Terraform CLI" -description: "State data tracks which real-world object corresponds to each resource. Inspect state, move or import resources, and more." +page_title: Manipulating State - Terraform CLI +description: >- + State data tracks which real-world object corresponds to each resource. + Inspect state, move or import resources, and more. +sidebar_title: Manipulating State --- # Manipulating Terraform State > **Hands-on:** Try the [Manage Resources in Terraform State](https://learn.hashicorp.com/tutorials/terraform/state-cli?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. -Terraform uses [state data](/docs/language/state/index.html) to remember which +Terraform uses [state data](/language/state/) to remember which real-world object corresponds to each resource in the configuration; this allows it to modify an existing object when its resource declaration changes. @@ -20,12 +22,12 @@ infrastructure. Terraform CLI supports several workflows for interacting with state: -- [Inspecting State](/docs/cli/state/inspect.html) -- [Forcing Re-creation (Tainting)](/docs/cli/state/taint.html) -- [Moving Resources](/docs/cli/state/move.html) +- [Inspecting State](/cli/state/inspect) +- [Forcing Re-creation (Tainting)](/cli/state/taint) +- [Moving Resources](/cli/state/move) - Importing Pre-existing Resources (documented in the - [Importing Infrastructure](/docs/cli/import/index.html) section) -- [Disaster Recovery](/docs/cli/state/recover.html) + [Importing Infrastructure](/cli/import/) section) +- [Disaster Recovery](/cli/state/recover) ~> **Important:** Modifying state data outside a normal plan or apply can cause Terraform to lose track of managed resources, which might waste money, annoy diff --git a/website/docs/cli/state/inspect.html.md b/website/docs/cli/state/inspect.mdx similarity index 58% rename from website/docs/cli/state/inspect.html.md rename to website/docs/cli/state/inspect.mdx index 382cd37a24f8..12439d8229df 100644 --- a/website/docs/cli/state/inspect.html.md +++ b/website/docs/cli/state/inspect.mdx @@ -1,7 +1,7 @@ --- -layout: "docs" -page_title: "Inspecting State - Terraform CLI" -description: "Commands that allow you to read and update state." +page_title: Inspecting State - Terraform CLI +description: Commands that allow you to read and update state. +sidebar_title: Inspecting State --- # Inspecting State @@ -9,14 +9,14 @@ description: "Commands that allow you to read and update state." Terraform includes some commands for reading and updating state without taking any other actions. -- [The `terraform state list` command](/docs/cli/commands/state/list.html) +- [The `terraform state list` command](/cli/commands/state/list) shows the resource addresses for every resource Terraform knows about in a configuration, optionally filtered by partial resource address. -- [The `terraform state show` command](/docs/cli/commands/state/show.html) +- [The `terraform state show` command](/cli/commands/state/show) displays detailed state data about one resource. -- [The `terraform refresh` command](/docs/cli/commands/refresh.html) updates +- [The `terraform refresh` command](/cli/commands/refresh) updates state data to match the real-world condition of the managed resources. This is done automatically during plans and applies, but not when interacting with state directly. diff --git a/website/docs/cli/state/move.html.md b/website/docs/cli/state/move.mdx similarity index 69% rename from website/docs/cli/state/move.html.md rename to website/docs/cli/state/move.mdx index 4eb654fd348d..f39a192c393b 100644 --- a/website/docs/cli/state/move.html.md +++ b/website/docs/cli/state/move.mdx @@ -1,13 +1,15 @@ --- -layout: "docs" -page_title: "Moving Resources - Terraform CLI" -description: "Commands that allow you to manage the way that resources are tracked in state. They are helpful when you move or change resources." +page_title: Moving Resources - Terraform CLI +description: >- + Commands that allow you to manage the way that resources are tracked in state. + They are helpful when you move or change resources. +sidebar_title: Moving Resources --- # Moving Resources Terraform's state associates each real-world object with a configured resource -at a specific [resource address](/docs/cli/state/resource-addressing.html). This +at a specific [resource address](/cli/state/resource-addressing). This is seamless when changing a resource's attributes, but Terraform will lose track of a resource if you change its name, move it to a different module, or change its provider. @@ -20,17 +22,17 @@ In cases where it's important to preserve an existing infrastructure object, you can explicitly tell Terraform to associate it with a different configured resource. -- [The `terraform state mv` command](/docs/cli/commands/state/mv.html) changes +- [The `terraform state mv` command](/cli/commands/state/mv) changes which resource address in your configuration is associated with a particular real-world object. Use this to preserve an object when renaming a resource, or when moving a resource into or out of a child module. -- [The `terraform state rm` command](/docs/cli/commands/state/rm.html) tells +- [The `terraform state rm` command](/cli/commands/state/rm) tells Terraform to stop managing a resource as part of the current working directory and workspace, _without_ destroying the corresponding real-world object. (You can later use `terraform import` to start managing that resource in a different workspace or a different Terraform configuration.) -- [The `terraform state replace-provider` command](/docs/cli/commands/state/replace-provider.html) +- [The `terraform state replace-provider` command](/cli/commands/state/replace-provider) transfers existing resources to a new provider without requiring them to be re-created. diff --git a/website/docs/cli/state/recover.html.md b/website/docs/cli/state/recover.mdx similarity index 65% rename from website/docs/cli/state/recover.html.md rename to website/docs/cli/state/recover.mdx index 29e289c427c2..dc2b0cb29921 100644 --- a/website/docs/cli/state/recover.html.md +++ b/website/docs/cli/state/recover.mdx @@ -1,7 +1,9 @@ --- -layout: "docs" -page_title: "Recovering from State Disasters - Terraform CLI" -descriptin: "Commands that allow you to restore state backups and override Terraform state protections." +page_title: Recovering from State Disasters - Terraform CLI +descriptin: >- + Commands that allow you to restore state backups and override Terraform state + protections. +sidebar_title: Recovering from State Disasters --- # Recovering from State Disasters @@ -10,7 +12,7 @@ If something has gone horribly wrong (possibly due to accidents when performing other state manipulation actions), you might need to take drastic actions with your state data. -- [The `terraform force-unlock` command](/docs/cli/commands/force-unlock.html) can +- [The `terraform force-unlock` command](/cli/commands/force-unlock) can override the protections Terraform uses to prevent two processes from modifying state at the same time. You might need this if a Terraform process (like a normal apply) is unexpectedly terminated (like by the complete @@ -18,8 +20,7 @@ your state data. state backend. Do not run this until you are completely certain what happened to the process that caused the lock to get stuck. -- [The `terraform state pull` command](/docs/cli/commands/state/pull.html) and - [the `terraform state push` command](/docs/cli/commands/state/push.html) can +- [The `terraform state pull` command](/cli/commands/state/pull) and + [the `terraform state push` command](/cli/commands/state/push) can directly read and write entire state files from and to the configured backend. You might need this for obtaining or restoring a state backup. - diff --git a/website/docs/cli/state/resource-addressing.html.md b/website/docs/cli/state/resource-addressing.mdx similarity index 69% rename from website/docs/cli/state/resource-addressing.html.md rename to website/docs/cli/state/resource-addressing.mdx index 72b987a8393a..07f3039c067e 100644 --- a/website/docs/cli/state/resource-addressing.html.md +++ b/website/docs/cli/state/resource-addressing.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Internals: Resource Address" -sidebar_current: "docs-internals-resource-addressing" +page_title: 'Internals: Resource Address' description: |- A resource address is a string that identifies zero or more resource instances in your overall configuration. @@ -32,12 +30,12 @@ A module path addresses a module within the tree of modules. It takes the form: module.module_name[module index] ``` - * `module` - Module keyword indicating a child module (non-root). Multiple `module` - keywords in a path indicate nesting. - * `module_name` - User-defined name of the module. - * `[module index]` - (Optional) [Index](#index-values-for-modules-and-resources) - to select an instance from a module call that has multiple instances, - surrounded by square bracket characters (`[` and `]`). +- `module` - Module keyword indicating a child module (non-root). Multiple `module` + keywords in a path indicate nesting. +- `module_name` - User-defined name of the module. +- `[module index]` - (Optional) [Index](#index-values-for-modules-and-resources) + to select an instance from a module call that has multiple instances, + surrounded by square bracket characters (`[` and `]`). An address without a resource spec, i.e. `module.foo` applies to every resource within the module if a single module, or all instances of a module if a module has multiple instances. @@ -64,11 +62,11 @@ It has the following syntax: resource_type.resource_name[instance index] ``` - * `resource_type` - Type of the resource being addressed. - * `resource_name` - User-defined name of the resource. - * `[instance index]` - (Optional) [Index](#index-values-for-modules-and-resources) - to select an instance from a resource that has multiple instances, - surrounded by square bracket characters (`[` and `]`). +- `resource_type` - Type of the resource being addressed. +- `resource_name` - User-defined name of the resource. +- `[instance index]` - (Optional) [Index](#index-values-for-modules-and-resources) + to select an instance from a resource that has multiple instances, + surrounded by square bracket characters (`[` and `]`). -> In Terraform v0.12 and later, a resource spec without a module path prefix matches only resources in the root module. In earlier versions, a resource spec @@ -79,12 +77,12 @@ in any descendent module. The following specifications apply to index values on modules and resources with multiple instances: - * `[N]` where `N` is a `0`-based numerical index into a resource with multiple - instances specified by the `count` meta-argument. Omitting an index when - addressing a resource where `count > 1` means that the address references - all instances. - * `["INDEX"]` where `INDEX` is a alphanumerical key index into a resource with - multiple instances specified by the `for_each` meta-argument. +- `[N]` where `N` is a `0`-based numerical index into a resource with multiple + instances specified by the `count` meta-argument. Omitting an index when + addressing a resource where `count > 1` means that the address references + all instances. +- `["INDEX"]` where `INDEX` is a alphanumerical key index into a resource with + multiple instances specified by the `for_each` meta-argument. ## Examples diff --git a/website/docs/cli/state/taint.html.md b/website/docs/cli/state/taint.mdx similarity index 68% rename from website/docs/cli/state/taint.html.md rename to website/docs/cli/state/taint.mdx index cea1281449d8..9d145205ee32 100644 --- a/website/docs/cli/state/taint.html.md +++ b/website/docs/cli/state/taint.mdx @@ -1,7 +1,7 @@ --- -layout: "docs" -page_title: "Forcing Re-creation of Resources (Tainting) - Terraform CLI" -description: "Commands that allow you to destroy and re-create resources manually." +page_title: Forcing Re-creation of Resources (Tainting) - Terraform CLI +description: Commands that allow you to destroy and re-create resources manually. +sidebar_title: Forcing Re-creation of Resources (Tainting) --- # Forcing Re-creation of Resources (Tainting) @@ -17,10 +17,10 @@ happen during creation; for example, a virtual machine that configures itself with `cloud-init` on startup might no longer meet your needs if the cloud-init configuration changes. -- [The `terraform taint` command](/docs/cli/commands/taint.html) tells Terraform to +- [The `terraform taint` command](/cli/commands/taint) tells Terraform to destroy and re-create a particular resource during the next apply, regardless of whether its resource arguments would normally require that. -- [The `terraform untaint` command](/docs/cli/commands/untaint.html) undoes a +- [The `terraform untaint` command](/cli/commands/untaint) undoes a previous taint, or can preserve a resource that was automatically tainted due - to failed [provisioners](/docs/language/resources/provisioners/syntax.html). + to failed [provisioners](/language/resources/provisioners/syntax). diff --git a/website/docs/cli/workspaces/index.html.md b/website/docs/cli/workspaces/index.mdx similarity index 68% rename from website/docs/cli/workspaces/index.html.md rename to website/docs/cli/workspaces/index.mdx index e8a5dcb5e64b..c20eb40d0829 100644 --- a/website/docs/cli/workspaces/index.html.md +++ b/website/docs/cli/workspaces/index.mdx @@ -1,28 +1,30 @@ --- -layout: "docs" -page_title: "Managing Workspaces - Terraform CLI" -description: "Commands to list, select, create, and output workspaces. Workspaces help manage different groups of resources with one configuration." +page_title: Managing Workspaces - Terraform CLI +description: >- + Commands to list, select, create, and output workspaces. Workspaces help + manage different groups of resources with one configuration. +sidebar_title: Managing Workspaces --- # Managing Workspaces In Terraform CLI, _workspaces_ are separate instances of -[state data](/docs/language/state/index.html) that can be used from the same working +[state data](/language/state/) that can be used from the same working directory. You can use workspaces to manage multiple non-overlapping groups of resources with the same configuration. -- Every [initialized working directory](/docs/cli/init/index.html) has at least +- Every [initialized working directory](/cli/init/) has at least one workspace. (If you haven't created other workspaces, it is a workspace named `default`.) - For a given working directory, only one workspace can be _selected_ at a time. -- Most Terraform commands (including [provisioning](/docs/cli/run/index.html) - and [state manipulation](/docs/cli/state/index.html) commands) only interact +- Most Terraform commands (including [provisioning](/cli/run/) + and [state manipulation](/cli/state/) commands) only interact with the currently selected workspace. -- Use [the `terraform workspace select` command](/docs/cli/commands/workspace/select.html) +- Use [the `terraform workspace select` command](/cli/commands/workspace/select) to change the currently selected workspace. -- Use the [`terraform workspace list`](/docs/cli/commands/workspace/list.html), - [`terraform workspace new`](/docs/cli/commands/workspace/new.html), and - [`terraform workspace delete`](/docs/cli/commands/workspace/delete.html) commands +- Use the [`terraform workspace list`](/cli/commands/workspace/list), + [`terraform workspace new`](/cli/commands/workspace/new), and + [`terraform workspace delete`](/cli/commands/workspace/delete) commands to manage the available workspaces in the current working directory. -> **Note:** Terraform Cloud and Terraform CLI both have features called @@ -35,19 +37,19 @@ Since most of the resources you can manage with Terraform don't include a unique name as part of their configuration, it's common to use the same Terraform configuration to provision multiple groups of similar resources. -Terraform relies on [state](/docs/language/state/index.html) to associate resources with +Terraform relies on [state](/language/state/) to associate resources with real-world objects, so if you run the same configuration multiple times with completely separate state data, Terraform can manage many non-overlapping groups of resources. In some cases you'll want to change -[variable values](/docs/language/values/variables.html) for these different +[variable values](/language/values/variables) for these different resource collections (like when specifying differences between staging and production deployments), and in other cases you might just want many instances of a particular infrastructure pattern. The simplest way to maintain multiple instances of a configuration with completely separate state data is to use multiple -[working directories](/docs/cli/init/index.html) (with different -[backend](/docs/language/settings/backends/configuration.html) configurations per directory, if you +[working directories](/cli/init/) (with different +[backend](/language/settings/backends/configuration) configurations per directory, if you aren't using the default `local` backend). However, this isn't always the most _convenient_ way to handle separate states. @@ -71,9 +73,9 @@ data, run history, and settings. These two kinds of workspaces are different, but related. When using Terraform CLI as a frontend for Terraform Cloud, you associate the current working directory with one or more remote workspaces by configuring -[the `remote` backend](/docs/language/settings/backends/remote.html). If you associate the +[the `remote` backend](/language/settings/backends/remote). If you associate the directory with multiple workspaces (using a name prefix), you can use the `terraform workspace` commands to select which remote workspace to use. For more information about using Terraform CLI with Terraform Cloud, see -[CLI-driven Runs](/docs/cloud/run/cli.html) in the Terraform Cloud docs. +[CLI-driven Runs](/cloud-docs/run/cli) in the Terraform Cloud docs. diff --git a/website/docs/configuration/expressions.html.md b/website/docs/configuration/expressions.html.md deleted file mode 100644 index 801253dcc19e..000000000000 --- a/website/docs/configuration/expressions.html.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -layout: "language" -page_title: "Expressions Landing Page - Configuration Language" -sidebar_current: "docs-config-expressions" ---- - -# Expressions Landing Page - -To improve navigation, we've split the old Expressions page into several smaller -pages. - - - - - - - -## Types and Values, Literal Expressions, Indices and Attributes - -Terraform's types are `string`, `number`, `bool`, `list`, `tuple`, `map`, -`object`, and `null`. - -This information has moved to -[Types and Values](/docs/language/expressions/types.html). - -
      - - - - - - - - - - -## References to Named Values (Resource Attributes, Variables, etc.) - -You can refer to certain values by name, like `var.some_variable` or -`aws_instance.example.ami`. - -This information has moved to -[References to Values](/docs/language/expressions/references.html). - -
      - - - - - - - - -## Arithmetic and Logical Operators - -Operators are expressions that transform other expressions, like adding two -numbers (`+`) or comparing two values to get a bool (`==`, `>=`, etc.). - -This information has moved to -[Operators](/docs/language/expressions/operators.html). - -
      - - - -## Conditional Expressions - -The `condition ? true_val : false_val` expression chooses between two -expressions based on a bool condition. - -This information has moved to -[Conditional Expressions](/docs/language/expressions/conditionals.html). - -
      - - - - - - -## Function Calls - -Terraform's functions can be called like `function_name(arg1, arg2)`. - -This information has moved to -[Function Calls](/docs/language/expressions/function-calls.html). - -
      - - - - - -## `for` Expressions - -Expressions like `[for s in var.list : upper(s)]` can transform a complex type -value into another complex type value. - -This information has moved to -[For Expressions](/docs/language/expressions/for.html). - -
      - - - - - - -## Splat Expressions - -Expressions like `var.list[*].id` can extract simpler collections from complex -collections. - -This information has moved to -[Splat Expressions](/docs/language/expressions/splat.html). - -
      - - - - - - -## `dynamic` Blocks - -The special `dynamic` block type serves the same purpose as a `for` expression, -except it creates multiple repeatable nested blocks instead of a complex value. - -This information has moved to -[Dynamic Blocks](/docs/language/expressions/dynamic-blocks.html). - -
      - - - - - - - - -## String Literals and String Templates - -Strings can be `"double-quoted"` or - -```hcl -< diff --git a/website/docs/configuration/expressions.mdx b/website/docs/configuration/expressions.mdx new file mode 100644 index 000000000000..67bebe8592e5 --- /dev/null +++ b/website/docs/configuration/expressions.mdx @@ -0,0 +1,122 @@ +--- +page_title: Expressions Landing Page - Configuration Language +sidebar_title: Expressions Landing Page +--- + +# Expressions Landing Page + +To improve navigation, we've split the old Expressions page into several smaller +pages. + + + +## Types and Values, Literal Expressions, Indices and Attributes + +Terraform's types are `string`, `number`, `bool`, `list`, `tuple`, `map`, +`object`, and `null`. + +This information has moved to +[Types and Values](/language/expressions/types). + +
      + + + +## References to Named Values (Resource Attributes, Variables, etc.) + +You can refer to certain values by name, like `var.some_variable` or +`aws_instance.example.ami`. + +This information has moved to +[References to Values](/language/expressions/references). + +
      + + + +## Arithmetic and Logical Operators + +Operators are expressions that transform other expressions, like adding two +numbers (`+`) or comparing two values to get a bool (`==`, `>=`, etc.). + +This information has moved to +[Operators](/language/expressions/operators). + +
      + +## Conditional Expressions + +The `condition ? true_val : false_val` expression chooses between two +expressions based on a bool condition. + +This information has moved to +[Conditional Expressions](/language/expressions/conditionals). + +
      + + + +## Function Calls + +Terraform's functions can be called like `function_name(arg1, arg2)`. + +This information has moved to +[Function Calls](/language/expressions/function-calls). + +
      + + + +## `for` Expressions + +Expressions like `[for s in var.list : upper(s)]` can transform a complex type +value into another complex type value. + +This information has moved to +[For Expressions](/language/expressions/for). + +
      + + + +## Splat Expressions + +Expressions like `var.list[*].id` can extract simpler collections from complex +collections. + +This information has moved to +[Splat Expressions](/language/expressions/splat). + +
      + + + +## `dynamic` Blocks + +The special `dynamic` block type serves the same purpose as a `for` expression, +except it creates multiple repeatable nested blocks instead of a complex value. + +This information has moved to +[Dynamic Blocks](/language/expressions/dynamic-blocks). + +
      + + + +## String Literals and String Templates + +Strings can be `"double-quoted"` or + +```hcl +< diff --git a/website/docs/configuration/index.mdx b/website/docs/configuration/index.mdx new file mode 100644 index 000000000000..046abeac20cb --- /dev/null +++ b/website/docs/configuration/index.mdx @@ -0,0 +1,5 @@ +--- +page_title: Terraform Configuration +--- + +# Terraform Configuration diff --git a/website/docs/configuration/modules.html.md b/website/docs/configuration/modules.html.md deleted file mode 100644 index 1dbcf06a14db..000000000000 --- a/website/docs/configuration/modules.html.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: "language" -page_title: "Modules Landing Page - Configuration Language" ---- - -# Modules Landing Page - -To improve navigation, we've split the old Modules page into several smaller -pages. - - - - - - - - -## Syntax and Elements of Module Blocks - -This information has moved to -[Module Blocks](/docs/language/modules/syntax.html). - -
      - - - - - -## Multiple Instances with `count` and `for_each` - -This information has moved to -[`count`](/docs/language/meta-arguments/count.html) and -[`for_each`](/docs/language/meta-arguments/for_each.html). - -
      - - - - - - - - - - -## Handling Provider Configurations in Re-usable Modules - -This information has moved to -[The `providers` Meta-Argument](/docs/language/meta-arguments/module-providers.html) -(for users of re-usable modules) and -[Providers Within Modules](/docs/language/modules/develop/providers.html) -(for module developers). - -
      diff --git a/website/docs/configuration/modules.mdx b/website/docs/configuration/modules.mdx new file mode 100644 index 000000000000..1718f821e32c --- /dev/null +++ b/website/docs/configuration/modules.mdx @@ -0,0 +1,40 @@ +--- +page_title: Modules Landing Page - Configuration Language +sidebar_title: Modules Landing Page +--- + +# Modules Landing Page + +To improve navigation, we've split the old Modules page into several smaller +pages. + + + +## Syntax and Elements of Module Blocks + +This information has moved to +[Module Blocks](/language/modules/syntax). + +
      + + + +## Multiple Instances with `count` and `for_each` + +This information has moved to +[`count`](/language/meta-arguments/count) and +[`for_each`](/language/meta-arguments/for_each). + +
      + + + +## Handling Provider Configurations in Re-usable Modules + +This information has moved to +[The `providers` Meta-Argument](/language/meta-arguments/module-providers) +(for users of re-usable modules) and +[Providers Within Modules](/language/modules/develop/providers) +(for module developers). + +
      diff --git a/website/docs/configuration/resources.html.md b/website/docs/configuration/resources.html.md deleted file mode 100644 index 87ae1bf5f439..000000000000 --- a/website/docs/configuration/resources.html.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -layout: "language" -page_title: "Resources Landing Page - Configuration Language" ---- - -# Resources Landing Page - -To improve navigation, we've split the old Resources page into several smaller -pages. - - - - - - - - - - -## Syntax and Elements of Resource Blocks - -This information has moved to -[Resource Blocks](/docs/language/resources/syntax.html). - -
      - - - - - - - - -## Details of Resource Behavior - -This information has moved to -[Resource Behavior](/docs/language/resources/behavior.html). - -
      - - - -## Resource Meta-Arguments - -Each resource meta-argument has moved to its own page: - -- [`depends_on`](/docs/language/meta-arguments/depends_on.html) -- [`count`](/docs/language/meta-arguments/count.html) -- [`for_each`](/docs/language/meta-arguments/for_each.html) -- [`provider`](/docs/language/meta-arguments/resource-provider.html) -- [`lifecycle`](/docs/language/meta-arguments/lifecycle.html) -- [Provisioners](/docs/language/resources/provisioners/index.html) - -
      - - - - - -### `depends_on` - -This information has moved to -[`depends_on`](/docs/language/meta-arguments/depends_on.html). - -
      - - - - - - - - - - - -### `count` - -This information has moved to -[`count`](/docs/language/meta-arguments/count.html). - -
      - - - - - - - - - - - -### `for_each` - -This information has moved to -[`for_each`](/docs/language/meta-arguments/for_each.html). - -
      - - - - - -### `provider` - -This information has moved to -[`provider`](/docs/language/meta-arguments/resource-provider.html). - -
      - - - - - - - - -### `lifecycle` - -This information has moved to -[`lifecycle`](/docs/language/meta-arguments/lifecycle.html). - -
      - - - - - -### Provisioners - -This information has moved to -[Provisioners](/docs/language/resources/provisioners/index.html). - -
      diff --git a/website/docs/configuration/resources.mdx b/website/docs/configuration/resources.mdx new file mode 100644 index 000000000000..67e9ad67c5d7 --- /dev/null +++ b/website/docs/configuration/resources.mdx @@ -0,0 +1,94 @@ +--- +page_title: Resources Landing Page - Configuration Language +sidebar_title: Resources Landing Page +--- + +# Resources Landing Page + +To improve navigation, we've split the old Resources page into several smaller +pages. + + + +## Syntax and Elements of Resource Blocks + +This information has moved to +[Resource Blocks](/language/resources/syntax). + +
      + + + +## Details of Resource Behavior + +This information has moved to +[Resource Behavior](/language/resources/behavior). + +
      + +## Resource Meta-Arguments + +Each resource meta-argument has moved to its own page: + +- [`depends_on`](/language/meta-arguments/depends_on) +- [`count`](/language/meta-arguments/count) +- [`for_each`](/language/meta-arguments/for_each) +- [`provider`](/language/meta-arguments/resource-provider) +- [`lifecycle`](/language/meta-arguments/lifecycle) +- [Provisioners](/language/resources/provisioners/) + +
      + + + +### `depends_on` + +This information has moved to +[`depends_on`](/language/meta-arguments/depends_on). + +
      + + + +### `count` + +This information has moved to +[`count`](/language/meta-arguments/count). + +
      + + + +### `for_each` + +This information has moved to +[`for_each`](/language/meta-arguments/for_each). + +
      + + + +### `provider` + +This information has moved to +[`provider`](/language/meta-arguments/resource-provider). + +
      + + + +### `lifecycle` + +This information has moved to +[`lifecycle`](/language/meta-arguments/lifecycle). + +
      + + + +### Provisioners + +This information has moved to +[Provisioners](/language/resources/provisioners/). + +
      diff --git a/website/docs/internals/archiving.html.md b/website/docs/internals/archiving.mdx similarity index 75% rename from website/docs/internals/archiving.html.md rename to website/docs/internals/archiving.mdx index 6c9cad0f179d..d1a153b81a8d 100644 --- a/website/docs/internals/archiving.html.md +++ b/website/docs/internals/archiving.mdx @@ -1,9 +1,9 @@ --- -layout: "docs" -page_title: "Archiving Providers" -sidebar_current: "docs-internals" -description: |- - Terraform is built on a plugin-based architecture, much of which is maintained by our user community. Occasionally, unmaintained providers may archived to reduce confusion for users and developers. +page_title: Archiving Providers +description: >- + Terraform is built on a plugin-based architecture, much of which is maintained + by our user community. Occasionally, unmaintained providers may archived to + reduce confusion for users and developers. --- This function maps -[Terraform language values](/docs/language/expressions/types.html) +[Terraform language values](/language/expressions/types) to YAML tags in the following way: | Terraform type | YAML type | @@ -77,12 +75,12 @@ mean that this is rarely a problem in practice. `yamlencode` always uses YAML's "block style" for mappings and sequences, unless the mapping or sequence is empty. To generate flow-style YAML, use -[`jsonencode`](./jsonencode.html) instead: YAML flow-style is a superset +[`jsonencode`](/language/functions/jsonencode) instead: YAML flow-style is a superset of JSON syntax. ## Related Functions -- [`jsonencode`](./jsonencode.html) is a similar operation using JSON instead +- [`jsonencode`](/language/functions/jsonencode) is a similar operation using JSON instead of YAML. -- [`yamldecode`](./yamldecode.html) performs the opposite operation, _decoding_ +- [`yamldecode`](/language/functions/yamldecode) performs the opposite operation, _decoding_ a YAML string to obtain its represented value. diff --git a/website/docs/language/functions/zipmap.html.md b/website/docs/language/functions/zipmap.mdx similarity index 85% rename from website/docs/language/functions/zipmap.html.md rename to website/docs/language/functions/zipmap.mdx index d37926f74010..77df4ab30118 100644 --- a/website/docs/language/functions/zipmap.html.md +++ b/website/docs/language/functions/zipmap.mdx @@ -1,10 +1,9 @@ --- -layout: "language" -page_title: "zipmap - Functions - Configuration Language" -sidebar_current: "docs-funcs-collection-zipmap" +page_title: zipmap - Functions - Configuration Language description: |- The zipmap function constructs a map from a list of keys and a corresponding list of values. +sidebar_title: zipmap --- # `zipmap` Function diff --git a/website/docs/language/index.html.md b/website/docs/language/index.mdx similarity index 89% rename from website/docs/language/index.html.md rename to website/docs/language/index.mdx index 6494298909ed..329bdf9cf670 100644 --- a/website/docs/language/index.html.md +++ b/website/docs/language/index.mdx @@ -1,16 +1,17 @@ --- -layout: "language" -page_title: "Overview - Configuration Language" -description: "You can use the Terraform language to write configuration files that tell Terraform how to manage a collection of infrastructure." - +page_title: Overview - Configuration Language +description: >- + You can use the Terraform language to write configuration files that tell + Terraform how to manage a collection of infrastructure. +sidebar_title: Overview --- # Terraform Language Documentation This is the documentation for Terraform's configuration language. It is relevant -to users of [Terraform CLI](/docs/cli/index.html), -[Terraform Cloud](/docs/cloud/index.html), and -[Terraform Enterprise](/docs/enterprise/index.html). Terraform's language is +to users of [Terraform CLI](/cli/), +[Terraform Cloud](/cloud-docs/), and +[Terraform Enterprise](/enterprise/). Terraform's language is its primary user interface. Configuration files you write in Terraform language tell Terraform what plugins to install, what infrastructure to create, and what data to fetch. Terraform language also lets you define dependencies @@ -22,7 +23,7 @@ configuration block. ## About the Terraform Language The main purpose of the Terraform language is declaring -[resources](/docs/language/resources/index.html), which represent infrastructure objects. All other +[resources](/language/resources/), which represent infrastructure objects. All other language features exist only to make the definition of resources more flexible and convenient. diff --git a/website/docs/language/meta-arguments/count.html.md b/website/docs/language/meta-arguments/count.mdx similarity index 89% rename from website/docs/language/meta-arguments/count.html.md rename to website/docs/language/meta-arguments/count.mdx index ed188d9249a5..0d594831c4ef 100644 --- a/website/docs/language/meta-arguments/count.html.md +++ b/website/docs/language/meta-arguments/count.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "The count Meta-Argument - Configuration Language" -description: "Count helps you efficiently manage nearly identical infrastructure resources without writing a separate block for each one." +page_title: The count Meta-Argument - Configuration Language +description: >- + Count helps you efficiently manage nearly identical infrastructure resources + without writing a separate block for each one. +sidebar_title: The count Meta-Argument --- # The `count` Meta-Argument @@ -13,14 +15,14 @@ previous versions can only use it with resources. > **Hands-on:** Try the [Manage Similar Resources With Count](https://learn.hashicorp.com/tutorials/terraform/count?in=terraform/0-13&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. -By default, a [resource block](/docs/language/resources/syntax.html) configures one real +By default, a [resource block](/language/resources/syntax) configures one real infrastructure object. (Similarly, a -[module block](/docs/language/modules/syntax.html) includes a +[module block](/language/modules/syntax) includes a child module's contents into the configuration one time.) However, sometimes you want to manage several similar objects (like a fixed pool of compute instances) without writing a separate block for each one. Terraform has two ways to do this: -`count` and [`for_each`](/docs/language/meta-arguments/for_each.html). +`count` and [`for_each`](/language/meta-arguments/for_each). If a resource or module block includes a `count` argument whose value is a whole number, Terraform will create that many instances. @@ -59,7 +61,7 @@ This object has one attribute: ## Using Expressions in `count` -The `count` meta-argument accepts numeric [expressions](/docs/language/expressions/index.html). +The `count` meta-argument accepts numeric [expressions](/language/expressions/). However, unlike most arguments, the `count` value must be known _before_ Terraform performs any remote resource actions. This means `count` can't refer to any resource attributes that aren't known until after a diff --git a/website/docs/language/meta-arguments/depends_on.html.md b/website/docs/language/meta-arguments/depends_on.mdx similarity index 91% rename from website/docs/language/meta-arguments/depends_on.html.md rename to website/docs/language/meta-arguments/depends_on.mdx index 7224007c732a..38a49c1b0885 100644 --- a/website/docs/language/meta-arguments/depends_on.html.md +++ b/website/docs/language/meta-arguments/depends_on.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "The depends_on Meta-Argument - Configuration Language" -description: "The depends_on meta-argument allows you to handle hidden resource or module dependencies." +page_title: The depends_on Meta-Argument - Configuration Language +description: >- + The depends_on meta-argument allows you to handle hidden resource or module + dependencies. +sidebar_title: The depends_on Meta-Argument --- # The `depends_on` Meta-Argument @@ -74,4 +76,3 @@ and thus before it can safely evaluate expressions. The `depends_on` argument should be used only as a last resort. When using it, always include a comment explaining why it is being used, to help future maintainers understand the purpose of the additional dependency. - diff --git a/website/docs/language/meta-arguments/for_each.html.md b/website/docs/language/meta-arguments/for_each.mdx similarity index 83% rename from website/docs/language/meta-arguments/for_each.html.md rename to website/docs/language/meta-arguments/for_each.mdx index 088f424faa86..63f8f4548a2a 100644 --- a/website/docs/language/meta-arguments/for_each.html.md +++ b/website/docs/language/meta-arguments/for_each.mdx @@ -1,19 +1,21 @@ --- -layout: "language" -page_title: "The for_each Meta-Argument - Configuration Language" -description: "The for_each meta-argument allows you to manage similar infrastructure resources without writing a separate block for each one." +page_title: The for_each Meta-Argument - Configuration Language +description: >- + The for_each meta-argument allows you to manage similar infrastructure + resources without writing a separate block for each one. +sidebar_title: The for_each Meta-Argument --- # The `for_each` Meta-Argument -By default, a [resource block](/docs/language/resources/syntax.html) configures one real +By default, a [resource block](/language/resources/syntax) configures one real infrastructure object (and similarly, a -[module block](/docs/language/modules/syntax.html) includes a +[module block](/language/modules/syntax) includes a child module's contents into the configuration one time). However, sometimes you want to manage several similar objects (like a fixed pool of compute instances) without writing a separate block for each one. Terraform has two ways to do this: -[`count`](/docs/language/meta-arguments/count.html) and `for_each`. +[`count`](/language/meta-arguments/count) and `for_each`. > **Hands-on:** Try the [Manage Similar Resources With For Each](https://learn.hashicorp.com/tutorials/terraform/for-each?in=terraform/configuration-language) tutorial on HashiCorp Learn. @@ -108,16 +110,16 @@ that cannot be determined before apply, and a `-target` may be needed. including `uuid`, `bcrypt`, or `timestamp`, as their evaluation is deferred during the main evaluation step. -Sensitive values, such as [sensitive input variables](https://www.terraform.io/docs/language/values/variables.html#suppressing-values-in-cli-output), -[sensitive outputs](https://www.terraform.io/docs/language/values/outputs.html#sensitive-suppressing-values-in-cli-output), -or [sensitive resource attributes](https://www.terraform.io/docs/language/expressions/references.html#sensitive-resource-attributes), +Sensitive values, such as [sensitive input variables](/language/values/variables#suppressing-values-in-cli-output), +[sensitive outputs](/language/values/outputs#sensitive-suppressing-values-in-cli-output), +or [sensitive resource attributes](/language/expressions/references#sensitive-resource-attributes), cannot be used as arguments to `for_each`. The value used in `for_each` is used to identify the resource instance and will always be disclosed in UI output, which is why sensitive values are not allowed. Attempts to use sensitive values as `for_each` arguments will result in an error. If you transform a value containing sensitive data into an argument to be used in `for_each`, be aware that -[most functions in Terraform will return a sensitive result if given an argument with any sensitive content](https://www.terraform.io/docs/language/expressions/function-calls.html#using-sensitive-data-as-function-arguments). +[most functions in Terraform will return a sensitive result if given an argument with any sensitive content](/language/expressions/function-calls#using-sensitive-data-as-function-arguments). In many cases, you can achieve similar results to a function used for this purpose by using a `for` expression. For example, if you would like to call `keys(local.map)`, where `local.map` is an object with sensitive values (but non-sensitive keys), you can create a @@ -125,7 +127,7 @@ value to pass to `for_each` with `toset([for k,v in local.map : k])`. ## Using Expressions in `for_each` -The `for_each` meta-argument accepts map or set [expressions](/docs/language/expressions/index.html). +The `for_each` meta-argument accepts map or set [expressions](/language/expressions/). However, unlike most arguments, the `for_each` value must be known _before_ Terraform performs any remote resource actions. This means `for_each` can't refer to any resource attributes that aren't known until after a @@ -134,7 +136,7 @@ an object is created). The `for_each` value must be a map or set with one element per desired resource instance. When providing a set, you must use an expression that -explicitly returns a set value, like the [`toset`](/docs/language/functions/toset.html) +explicitly returns a set value, like the [`toset`](/language/functions/toset) function; to prevent unwanted surprises during conversion, the `for_each` argument does not implicitly convert lists or tuples to sets. If you need to declare resource instances based on a nested @@ -142,11 +144,11 @@ data structure or combinations of elements from multiple data structures you can use Terraform expressions and functions to derive a suitable value. For example: -* Transform a multi-level nested structure into a flat list by - [using nested `for` expressions with the `flatten` function](/docs/language/functions/flatten.html#flattening-nested-structures-for-for_each). -* Produce an exhaustive list of combinations of elements from two or more +- Transform a multi-level nested structure into a flat list by + [using nested `for` expressions with the `flatten` function](/language/functions/flatten#flattening-nested-structures-for-for_each). +- Produce an exhaustive list of combinations of elements from two or more collections by - [using the `setproduct` function inside a `for` expression](/docs/language/functions/setproduct.html#finding-combinations-for-for_each). + [using the `setproduct` function inside a `for` expression](/language/functions/setproduct#finding-combinations-for-for_each). ### Chaining `for_each` Between Resources @@ -226,7 +228,7 @@ as a whole. ## Using Sets The Terraform language doesn't have a literal syntax for -[set values](/docs/language/expressions/type-constraints.html#collection-types), but you can use the `toset` +[set values](/language/expressions/type-constraints#collection-types), but you can use the `toset` function to explicitly convert a list of strings to a set: ```hcl @@ -255,7 +257,7 @@ removes any duplicate elements. `toset(["b", "a", "b"])` will produce a set containing only `"a"` and `"b"` in no particular order; the second `"b"` is discarded. -If you are writing a module with an [input variable](/docs/language/values/variables.html) that +If you are writing a module with an [input variable](/language/values/variables) that will be used as a set of strings for `for_each`, you can set its type to `set(string)` to avoid the need for an explicit type conversion: diff --git a/website/docs/language/meta-arguments/lifecycle.html.md b/website/docs/language/meta-arguments/lifecycle.html.md deleted file mode 100644 index 840ab71a5ea1..000000000000 --- a/website/docs/language/meta-arguments/lifecycle.html.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -layout: "language" -page_title: "The lifecycle Meta-Argument - Configuration Language" -description: "The meta-arguments in a lifecycle block allow you to customize resource behavior." ---- - -# The `lifecycle` Meta-Argument - -> **Hands-on:** Try the [Lifecycle Management](https://learn.hashicorp.com/tutorials/terraform/resource-lifecycle?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. - -The general lifecycle for resources is described in the -[Resource Behavior](/docs/language/resources/behavior.html) page. Some details of -that behavior can be customized using the special nested `lifecycle` block -within a resource block body: - -```hcl -resource "azurerm_resource_group" "example" { - # ... - - lifecycle { - create_before_destroy = true - } -} -``` - -## Syntax and Arguments - -`lifecycle` is a nested block that can appear within a resource block. -The `lifecycle` block and its contents are meta-arguments, available -for all `resource` blocks regardless of type. - -The following arguments can be used within a `lifecycle` block: - -* `create_before_destroy` (bool) - By default, when Terraform must change - a resource argument that cannot be updated in-place due to - remote API limitations, Terraform will instead destroy the existing object - and then create a new replacement object with the new configured arguments. - - The `create_before_destroy` meta-argument changes this behavior so that - the new replacement object is created _first,_ and the prior object - is destroyed after the replacement is created. - - This is an opt-in behavior because many remote object types have unique - name requirements or other constraints that must be accommodated for - both a new and an old object to exist concurrently. Some resource types - offer special options to append a random suffix onto each object name to - avoid collisions, for example. Terraform CLI cannot automatically activate - such features, so you must understand the constraints for each resource - type before using `create_before_destroy` with it. - - Destroy provisioners of this resource will not run if `create_before_destroy` - is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. - -* `prevent_destroy` (bool) - This meta-argument, when set to `true`, will - cause Terraform to reject with an error any plan that would destroy the - infrastructure object associated with the resource, as long as the argument - remains present in the configuration. - - This can be used as a measure of safety against the accidental replacement - of objects that may be costly to reproduce, such as database instances. - However, it will make certain configuration changes impossible to apply, - and will prevent the use of the `terraform destroy` command once such - objects are created, and so this option should be used sparingly. - - Since this argument must be present in configuration for the protection to - apply, note that this setting does not prevent the remote object from - being destroyed if the `resource` block were removed from configuration - entirely: in that case, the `prevent_destroy` setting is removed along - with it, and so Terraform will allow the destroy operation to succeed. - -* `ignore_changes` (list of attribute names) - By default, Terraform detects - any difference in the current settings of a real infrastructure object - and plans to update the remote object to match configuration. - - The `ignore_changes` feature is intended to be used when a resource is - created with references to data that may change in the future, but should - not affect said resource after its creation. In some rare cases, settings - of a remote object are modified by processes outside of Terraform, which - Terraform would then attempt to "fix" on the next run. In order to make - Terraform share management responsibilities of a single object with a - separate process, the `ignore_changes` meta-argument specifies resource - attributes that Terraform should ignore when planning updates to the - associated remote object. - - The arguments corresponding to the given attribute names are considered - when planning a _create_ operation, but are ignored when planning an - _update_. The arguments are the relative address of the attributes in the - resource. Map and list elements can be referenced using index notation, - like `tags["Name"]` and `list[0]` respectively. - - ```hcl - resource "aws_instance" "example" { - # ... - - lifecycle { - ignore_changes = [ - # Ignore changes to tags, e.g. because a management agent - # updates these based on some ruleset managed elsewhere. - tags, - ] - } - } - ``` - - Instead of a list, the special keyword `all` may be used to instruct - Terraform to ignore _all_ attributes, which means that Terraform can - create and destroy the remote object but will never propose updates to it. - - Only attributes defined by the resource type can be ignored. - `ignore_changes` cannot be applied to itself or to any other meta-arguments. - -## Literal Values Only - -The `lifecycle` settings all affect how Terraform constructs and traverses -the dependency graph. As a result, only literal values can be used because -the processing happens too early for arbitrary expression evaluation. diff --git a/website/docs/language/meta-arguments/lifecycle.mdx b/website/docs/language/meta-arguments/lifecycle.mdx new file mode 100644 index 000000000000..c7d6d8729afd --- /dev/null +++ b/website/docs/language/meta-arguments/lifecycle.mdx @@ -0,0 +1,118 @@ +--- +page_title: The lifecycle Meta-Argument - Configuration Language +description: >- + The meta-arguments in a lifecycle block allow you to customize resource + behavior. +sidebar_title: The lifecycle Meta-Argument +--- + +# The `lifecycle` Meta-Argument + +> **Hands-on:** Try the [Lifecycle Management](https://learn.hashicorp.com/tutorials/terraform/resource-lifecycle?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. + +The general lifecycle for resources is described in the +[Resource Behavior](/language/resources/behavior) page. Some details of +that behavior can be customized using the special nested `lifecycle` block +within a resource block body: + +```hcl +resource "azurerm_resource_group" "example" { + # ... + + lifecycle { + create_before_destroy = true + } +} +``` + +## Syntax and Arguments + +`lifecycle` is a nested block that can appear within a resource block. +The `lifecycle` block and its contents are meta-arguments, available +for all `resource` blocks regardless of type. + +The following arguments can be used within a `lifecycle` block: + +* `create_before_destroy` (bool) - By default, when Terraform must change + a resource argument that cannot be updated in-place due to + remote API limitations, Terraform will instead destroy the existing object + and then create a new replacement object with the new configured arguments. + + The `create_before_destroy` meta-argument changes this behavior so that + the new replacement object is created _first,_ and the prior object + is destroyed after the replacement is created. + + This is an opt-in behavior because many remote object types have unique + name requirements or other constraints that must be accommodated for + both a new and an old object to exist concurrently. Some resource types + offer special options to append a random suffix onto each object name to + avoid collisions, for example. Terraform CLI cannot automatically activate + such features, so you must understand the constraints for each resource + type before using `create_before_destroy` with it. + + Destroy provisioners of this resource will not run if `create_before_destroy` + is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. + +* `prevent_destroy` (bool) - This meta-argument, when set to `true`, will + cause Terraform to reject with an error any plan that would destroy the + infrastructure object associated with the resource, as long as the argument + remains present in the configuration. + + This can be used as a measure of safety against the accidental replacement + of objects that may be costly to reproduce, such as database instances. + However, it will make certain configuration changes impossible to apply, + and will prevent the use of the `terraform destroy` command once such + objects are created, and so this option should be used sparingly. + + Since this argument must be present in configuration for the protection to + apply, note that this setting does not prevent the remote object from + being destroyed if the `resource` block were removed from configuration + entirely: in that case, the `prevent_destroy` setting is removed along + with it, and so Terraform will allow the destroy operation to succeed. + +* `ignore_changes` (list of attribute names) - By default, Terraform detects + any difference in the current settings of a real infrastructure object + and plans to update the remote object to match configuration. + + The `ignore_changes` feature is intended to be used when a resource is + created with references to data that may change in the future, but should + not affect said resource after its creation. In some rare cases, settings + of a remote object are modified by processes outside of Terraform, which + Terraform would then attempt to "fix" on the next run. In order to make + Terraform share management responsibilities of a single object with a + separate process, the `ignore_changes` meta-argument specifies resource + attributes that Terraform should ignore when planning updates to the + associated remote object. + + The arguments corresponding to the given attribute names are considered + when planning a _create_ operation, but are ignored when planning an + _update_. The arguments are the relative address of the attributes in the + resource. Map and list elements can be referenced using index notation, + like `tags["Name"]` and `list[0]` respectively. + + ```hcl + resource "aws_instance" "example" { + # ... + + lifecycle { + ignore_changes = [ + # Ignore changes to tags, e.g. because a management agent + # updates these based on some ruleset managed elsewhere. + tags, + ] + } + } + ``` + + Instead of a list, the special keyword `all` may be used to instruct + Terraform to ignore _all_ attributes, which means that Terraform can + create and destroy the remote object but will never propose updates to it. + + Only attributes defined by the resource type can be ignored. + `ignore_changes` cannot be applied to itself or to any other meta-arguments. + +## Literal Values Only + +The `lifecycle` settings all affect how Terraform constructs and traverses +the dependency graph. As a result, only literal values can be used because +the processing happens too early for arbitrary expression evaluation. diff --git a/website/docs/language/meta-arguments/module-providers.html.md b/website/docs/language/meta-arguments/module-providers.mdx similarity index 88% rename from website/docs/language/meta-arguments/module-providers.html.md rename to website/docs/language/meta-arguments/module-providers.mdx index 0103fd0302a9..c57f387c055c 100644 --- a/website/docs/language/meta-arguments/module-providers.html.md +++ b/website/docs/language/meta-arguments/module-providers.mdx @@ -1,14 +1,16 @@ --- -layout: "language" -page_title: "The Module providers Meta-Argument - Configuration Language" -description: "The providers meta-argument specifies which provider configurations from a parent module are available in a child module." +page_title: The Module providers Meta-Argument - Configuration Language +description: >- + The providers meta-argument specifies which provider configurations from a + parent module are available in a child module. +sidebar_title: The Module providers Meta-Argument --- # The Module `providers` Meta-Argument -In a [module call](/docs/language/modules/syntax.html) block, the +In a [module call](/language/modules/syntax) block, the optional `providers` meta-argument specifies which -[provider configurations](/docs/language/providers/configuration.html) from the parent +[provider configurations](/language/providers/configuration) from the parent module will be available inside the child module. ```hcl @@ -37,7 +39,7 @@ module "example" { ## Default Behavior: Inherit Default Providers -If the child module does not declare any [configuration aliases](/docs/language/modules/develop/providers.html#provider-aliases-within-modules), +If the child module does not declare any [configuration aliases](/language/modules/develop/providers#provider-aliases-within-modules), the `providers` argument is optional. If you omit it, a child module inherits all of the _default_ provider configurations from its parent module. (Default provider configurations are ones that don't use the `alias` argument.) @@ -122,4 +124,4 @@ names it needs. For more details and guidance about working with providers inside a re-usable child module, see -[Module Development: Providers Within Modules](/docs/language/modules/develop/providers.html). +[Module Development: Providers Within Modules](/language/modules/develop/providers). diff --git a/website/docs/language/meta-arguments/resource-provider.html.md b/website/docs/language/meta-arguments/resource-provider.mdx similarity index 78% rename from website/docs/language/meta-arguments/resource-provider.html.md rename to website/docs/language/meta-arguments/resource-provider.mdx index 21eaad48d47b..8a7576150706 100644 --- a/website/docs/language/meta-arguments/resource-provider.html.md +++ b/website/docs/language/meta-arguments/resource-provider.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "The Resource provider Meta-Argument - Configuration Language" -description: "The provider meta-argument specifies the provider configuration Terraform should use for a resource, overriding Terraform's default behavior." +page_title: The Resource provider Meta-Argument - Configuration Language +description: >- + The provider meta-argument specifies the provider configuration Terraform + should use for a resource, overriding Terraform's default behavior. +sidebar_title: The Resource provider Meta-Argument --- # The Resource `provider` Meta-Argument @@ -10,7 +12,7 @@ The `provider` meta-argument specifies which provider configuration to use for a overriding Terraform's default behavior of selecting one based on the resource type name. Its value should be an unquoted `.` reference. -As described in [Provider Configuration](/docs/language/providers/configuration.html), you can optionally +As described in [Provider Configuration](/language/providers/configuration), you can optionally create multiple configurations for a single provider (usually to manage resources in different regions of multi-region services). Each provider can have one default configuration, and any number of alternate configurations that @@ -52,7 +54,7 @@ ensure that the provider is fully configured before any resource actions are taken. The `provider` meta-argument expects -[a `.` reference](/docs/language/providers/configuration.html#referring-to-alternate-provider-configurations), +[a `.` reference](/language/providers/configuration#referring-to-alternate-provider-configurations), which does not need to be quoted. Arbitrary expressions are not permitted for `provider` because it must be resolved while Terraform is constructing the dependency graph, before it is safe to evaluate expressions. diff --git a/website/docs/language/modules/develop/composition.html.md b/website/docs/language/modules/develop/composition.mdx similarity index 98% rename from website/docs/language/modules/develop/composition.html.md rename to website/docs/language/modules/develop/composition.mdx index 96c2da68579e..fdfa02c1d32d 100644 --- a/website/docs/language/modules/develop/composition.html.md +++ b/website/docs/language/modules/develop/composition.mdx @@ -1,7 +1,5 @@ --- -layout: "language" -page_title: "Module Composition" -sidebar_current: "docs-modules-composition" +page_title: Module Composition description: |- Module composition allows infrastructure to be described from modular building blocks. @@ -310,7 +308,7 @@ Most modules contain `resource` blocks and thus describe infrastructure to be created and managed. It may sometimes be useful to write modules that do not describe any new infrastructure at all, but merely retrieve information about existing infrastructure that was created elsewhere using -[data sources](/docs/language/data-sources/index.html). +[data sources](/language/data-sources/). As with conventional modules, we suggest using this technique only when the module raises the level of abstraction in some way, in this case by @@ -346,7 +344,7 @@ data sources, or it could read saved information from a Consul cluster using [`consul_keys`](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/keys), or it might read the outputs directly from the state of the configuration that manages the network using -[`terraform_remote_state`](https://www.terraform.io/docs/language/state/remote-state-data.html). +[`terraform_remote_state`](/language/state/remote-state-data). The key benefit of this approach is that the source of this information can change over time without updating every configuration that depends on it. diff --git a/website/docs/language/modules/develop/index.html.md b/website/docs/language/modules/develop/index.mdx similarity index 77% rename from website/docs/language/modules/develop/index.html.md rename to website/docs/language/modules/develop/index.mdx index 98b28ea7c576..6494cae4e047 100644 --- a/website/docs/language/modules/develop/index.html.md +++ b/website/docs/language/modules/develop/index.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Creating Modules" -sidebar_current: "docs-modules" -description: "Modules are containers for multiple resources that are used together in a configuration. Learn when to create modules and about module structure." +page_title: Creating Modules +description: >- + Modules are containers for multiple resources that are used together in a + configuration. Learn when to create modules and about module structure. --- # Creating Modules @@ -14,27 +14,27 @@ Modules can be used to create lightweight abstractions, so that you can describe your infrastructure in terms of its architecture, rather than directly in terms of physical objects. -The `.tf` files in your working directory when you run [`terraform plan`](/docs/cli/commands/plan.html) -or [`terraform apply`](/docs/cli/commands/apply.html) together form the _root_ -module. That module may [call other modules](/docs/language/modules/syntax.html#calling-a-child-module) +The `.tf` files in your working directory when you run [`terraform plan`](/cli/commands/plan) +or [`terraform apply`](/cli/commands/apply) together form the _root_ +module. That module may [call other modules](/language/modules/syntax#calling-a-child-module) and connect them together by passing output values from one to input values of another. -To learn how to _use_ modules, see [the Modules configuration section](/docs/language/modules/index.html). +To learn how to _use_ modules, see [the Modules configuration section](/language/modules/). This section is about _creating_ re-usable modules that other configurations can include using `module` blocks. ## Module structure Re-usable modules are defined using all of the same -[configuration language](/docs/language/index.html) concepts we use in root modules. +[configuration language](/language/) concepts we use in root modules. Most commonly, modules use: -* [Input variables](/docs/language/values/variables.html) to accept values from +* [Input variables](/language/values/variables) to accept values from the calling module. -* [Output values](/docs/language/values/outputs.html) to return results to the +* [Output values](/language/values/outputs) to return results to the calling module, which it can then use to populate arguments elsewhere. -* [Resources](/docs/language/resources/index.html) to define one or more +* [Resources](/language/resources/) to define one or more infrastructure objects that the module will manage. To define a module, create a new directory for it and place one or more `.tf` @@ -44,7 +44,7 @@ be re-used by lots of configurations you may wish to place it in its own version control repository. Modules can also call other modules using a `module` block, but we recommend -keeping the module tree relatively flat and using [module composition](./composition.html) +keeping the module tree relatively flat and using [module composition](/language/modules/develop/composition) as an alternative to a deeply-nested tree of modules, because this makes the individual modules easier to re-use in different combinations. @@ -72,7 +72,7 @@ calling module instead. ## Refactoring module resources -You can include [refactoring blocks](refactoring.html) to record how resource +You can include [refactoring blocks](/language/modules/develop/refactoring) to record how resource names and module structure have changed from previous module versions. Terraform uses that information during planning to reinterpret existing objects as if they had been created at the corresponding new addresses, eliminating a diff --git a/website/docs/language/modules/develop/providers.html.md b/website/docs/language/modules/develop/providers.mdx similarity index 94% rename from website/docs/language/modules/develop/providers.html.md rename to website/docs/language/modules/develop/providers.mdx index fd5db189aede..7ae63cf3204a 100644 --- a/website/docs/language/modules/develop/providers.html.md +++ b/website/docs/language/modules/develop/providers.mdx @@ -1,6 +1,6 @@ --- -layout: "language" -page_title: "Providers Within Modules - Configuration Language" +page_title: Providers Within Modules - Configuration Language +sidebar_title: Providers Within Modules --- # Providers Within Modules @@ -45,10 +45,10 @@ to reintroduce the provider configuration. ## Provider Version Constraints in Modules Although provider _configurations_ are shared between modules, each module must -declare its own [provider requirements](/docs/language/providers/requirements.html), so that +declare its own [provider requirements](/language/providers/requirements), so that Terraform can ensure that there is a single version of the provider that is compatible with all modules in the configuration and to specify the -[source address](/docs/language/providers/requirements.html#source-addresses) that serves as +[source address](/language/providers/requirements#source-addresses) that serves as the global (module-agnostic) identifier for a provider. To declare that a module requires particular versions of a specific provider, @@ -71,7 +71,7 @@ however, specify any of the configuration settings that determine what remote endpoints the provider will access, such as an AWS region; configuration settings come from provider _configurations_, and a particular overall Terraform configuration can potentially have -[several different configurations for the same provider](/docs/language/providers/configuration.html#alias-multiple-provider-configurations). +[several different configurations for the same provider](/language/providers/configuration#alias-multiple-provider-configurations). ## Provider Aliases Within Modules @@ -133,10 +133,10 @@ resource "aws_s3_bucket" "example" { We recommend using this approach when a single configuration for each provider is sufficient for an entire configuration. -~> **Note:** Only provider configurations are inherited by child modules, not provider source or version requirements. Each module must [declare its own provider requirements](/docs/language/providers/requirements.html). This is especially important for non-HashiCorp providers. +~> **Note:** Only provider configurations are inherited by child modules, not provider source or version requirements. Each module must [declare its own provider requirements](/language/providers/requirements). This is especially important for non-HashiCorp providers. In more complex situations there may be -[multiple provider configurations](/docs/language/providers/configuration.html#alias-multiple-provider-configurations), +[multiple provider configurations](/language/providers/configuration#alias-multiple-provider-configurations), or a child module may need to use different provider settings than its parent. For such situations, you must pass providers explicitly. @@ -173,7 +173,7 @@ module "example" { ``` The `providers` argument within a `module` block is similar to -[the `provider` argument](/docs/language/meta-arguments/resource-provider.html) +[the `provider` argument](/language/meta-arguments/resource-provider) within a resource, but is a map rather than a single string because a module may contain resources from many different providers. diff --git a/website/docs/language/modules/develop/publish.html.md b/website/docs/language/modules/develop/publish.mdx similarity index 76% rename from website/docs/language/modules/develop/publish.html.md rename to website/docs/language/modules/develop/publish.mdx index 2f1419dbbaba..6a5e0992d6d5 100644 --- a/website/docs/language/modules/develop/publish.html.md +++ b/website/docs/language/modules/develop/publish.mdx @@ -1,20 +1,17 @@ --- -layout: "language" -page_title: "Publishing Modules" -sidebar_current: "docs-modules-publish" -description: |- - A module is a container for multiple resources that are used together. +page_title: Publishing Modules +description: A module is a container for multiple resources that are used together. --- # Publishing Modules If you've built a module that you intend to be reused, we recommend -[publishing the module](/docs/registry/modules/publish.html) on the +[publishing the module](/registry/modules/publish) on the [Terraform Registry](https://registry.terraform.io). This will version your module, generate documentation, and more. Published modules can be easily consumed by Terraform, and users can -[constrain module versions](/docs/language/modules/syntax.html#version) +[constrain module versions](/language/modules/syntax#version) for safe and predictable updates. The following example shows how a caller might use a module from the Terraform Registry: @@ -25,21 +22,20 @@ module "consul" { ``` If you do not wish to publish your modules in the public registry, you can -instead use a [private registry](/docs/registry/private.html) to get +instead use a [private registry](/registry/private) to get the same benefits. We welcome contributions of Terraform modules from our community members, partners, and customers. Our ecosystem is made richer by each new module created or an existing one updated, as they reflect the wide range of experience and technical requirements of the community that uses them. Our cloud provider partners often seek to develop specific modules for popular or challenging use cases on their platform and utilize them as valuable learning experiences to empathize with their users. Similarly, our community module developers incorporate a variety of opinions and use cases from the broader Terraform community. Both types of modules have their place in the Terraform registry, accessible to practitioners who can decide which modules best fit their requirements. - ## Distribution via other sources Although the registry is the native mechanism for distributing re-usable modules, Terraform can also install modules from -[various other sources](/docs/language/modules/sources.html). The alternative sources +[various other sources](/language/modules/sources). The alternative sources do not support the first-class versioning mechanism, but some sources have their own mechanisms for selecting particular VCS commits, etc. We recommend that modules distributed via other protocols still use the -[standard module structure](/docs/language/modules/develop/structure.html) so that they can +[standard module structure](/language/modules/develop/structure) so that they can be used in a similar way as a registry module or be published on the registry at a later time. diff --git a/website/docs/language/modules/develop/refactoring.html.md b/website/docs/language/modules/develop/refactoring.mdx similarity index 94% rename from website/docs/language/modules/develop/refactoring.html.md rename to website/docs/language/modules/develop/refactoring.mdx index a7381a4c4809..56d53db192e5 100644 --- a/website/docs/language/modules/develop/refactoring.html.md +++ b/website/docs/language/modules/develop/refactoring.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Refactoring" -sidebar_current: "docs-modules-recactoring" -description: |- - How to make backward-compatible changes to modules already in use. +page_title: Refactoring +description: How to make backward-compatible changes to modules already in use. --- # Refactoring @@ -12,7 +9,7 @@ description: |- only in Terraform v1.1 and later. When working with earlier Terraform versions, or for refactoring actions too complex to express as `moved` blocks, you could use -[the `terraform state mv` CLI command](/docs/cli/commands/state/mv.html) +[the `terraform state mv` CLI command](/cli/commands/state/mv) as a separate step instead. In shared modules and long-lived configurations, you may eventually outgrow @@ -126,7 +123,7 @@ resource "aws_instance" "a" { Applying this configuration would lead to Terraform creating an object bound to the address `aws_instance.a`. -Later, you use [`for_each`](../../meta-arguments/for_each.html) with this +Later, you use [`for_each`](/language/meta-arguments/for_each) with this resource to systematically declare multiple instances. To preserve an object that was previously associated with `aws_instance.a` alone, you must add a `moved` block to specify which instance key the object will take in the new @@ -260,7 +257,7 @@ Applying this configuration would cause Terraform to create objects whose addresses begin with `module.a`. In later module versions, you may need to use -[`count`](../../meta-arguments/count.html) with this resource to systematically +[`count`](/language/meta-arguments/count) with this resource to systematically declare multiple instances. To preserve an object that was previously associated with `aws_instance.a` alone, you can add a `moved` block to specify which instance key that object will take in the new configuration: @@ -324,8 +321,8 @@ To achieve this refactoring without replacing existing objects bound to the old resource addresses, you must: 1. Write module "x", copying over the two resources it should contain. -2. Write module "y", copying over the one resource it should contain. -3. Edit the original module to no longer include any of these resources, and +1. Write module "y", copying over the one resource it should contain. +1. Edit the original module to no longer include any of these resources, and instead to contain only shim configuration to migrate existing users. The new modules "x" and "y" should contain only `resource` blocks: @@ -397,13 +394,13 @@ typical rule that a parent module sees its child module as a "closed box", unaware of exactly which resources are declared inside it. This compromise assumes that all three of these modules are maintained by the same people and distributed together in a single -[module package](../sources.html#modules-in-package-sub-directories). +[module package](/language/modules/sources#modules-in-package-sub-directories). -To reduce [coupling](https://en.wikipedia.org/wiki/Coupling_(computer_programming)) +To reduce [coupling](https://en.wikipedia.org/wiki/Coupling_\(computer_programming\)) between separately-packaged modules, Terraform only allows declarations of moves between modules in the same package. In other words, Terraform would not have allowed moving into `module.x` above if the `source` address of -that call had not been a [local path](../sources.html#local-paths). +that call had not been a [local path](/language/modules/sources#local-paths). Terraform resolves module references in `moved` blocks relative to the module instance they are defined in. For example, if the original module above were @@ -426,16 +423,15 @@ moved { ## Removing `moved` Blocks -Over time, a long-lasting module may accumulate many `moved` blocks. +Over time, a long-lasting module may accumulate many `moved` blocks. -Removing a `moved` block is a generally breaking change because any configurations that refer to the old address will plan to delete that existing object instead of move it. We strongly recommend that you retain all historical `moved` blocks from earlier versions of your modules to preserve the upgrade path for users of any previous version. +Removing a `moved` block is a generally breaking change because any configurations that refer to the old address will plan to delete that existing object instead of move it. We strongly recommend that you retain all historical `moved` blocks from earlier versions of your modules to preserve the upgrade path for users of any previous version. If you do decide to remove `moved` blocks, proceed with caution. It can be safe to remove `moved` blocks when you are maintaining private modules within an organization and you are certain that all users have successfully run `terraform apply` with your new module version. If you need to rename or move the same object twice, we recommend documenting the full history using _chained_ `moved` blocks, where the new block refers to the existing block: - ```hcl moved { from = aws_instance.a diff --git a/website/docs/language/modules/develop/structure.html.md b/website/docs/language/modules/develop/structure.mdx similarity index 95% rename from website/docs/language/modules/develop/structure.html.md rename to website/docs/language/modules/develop/structure.mdx index 6aed2b2651e7..dbe2db33c3c6 100644 --- a/website/docs/language/modules/develop/structure.html.md +++ b/website/docs/language/modules/develop/structure.mdx @@ -1,6 +1,5 @@ --- -layout: "language" -page_title: "Standard Module Structure" +page_title: Standard Module Structure --- # Standard Module Structure @@ -54,8 +53,8 @@ don't need to do any extra work to follow the standard structure. * **Variables and outputs should have descriptions.** All variables and outputs should have one or two sentence descriptions that explain their purpose. This is used for documentation. See the documentation for - [variable configuration](/docs/language/values/variables.html) and - [output configuration](/docs/language/values/outputs.html) for more details. + [variable configuration](/language/values/variables) and + [output configuration](/language/values/outputs) for more details. * **Nested modules**. Nested modules should exist under the `modules/` subdirectory. Any nested module with a `README.md` is considered usable @@ -75,7 +74,7 @@ don't need to do any extra work to follow the standard structure. again separately. If a repository or package contains multiple nested modules, they should - ideally be [composable](./composition.html) by the caller, rather than + ideally be [composable](/language/modules/develop/composition) by the caller, rather than calling directly to each other and creating a deeply-nested tree of modules. * **Examples**. Examples of using the module should exist under the diff --git a/website/docs/language/modules/index.html.md b/website/docs/language/modules/index.mdx similarity index 71% rename from website/docs/language/modules/index.html.md rename to website/docs/language/modules/index.mdx index a1c1227689a8..768b3c7604af 100644 --- a/website/docs/language/modules/index.html.md +++ b/website/docs/language/modules/index.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "Modules Overview - Configuration Language" -description: "Modules are containers for multiple resources that are used together in a configuration. Find resources for using, developing, and publishing modules." +page_title: Modules Overview - Configuration Language +description: >- + Modules are containers for multiple resources that are used together in a + configuration. Find resources for using, developing, and publishing modules. +sidebar_title: Modules Overview --- # Modules @@ -43,27 +45,27 @@ download them automatically if you specify the appropriate source and version in a module call block. Also, members of your organization might produce modules specifically crafted -for your own infrastructure needs. [Terraform Cloud](/docs/cloud/index.html) and -[Terraform Enterprise](/docs/enterprise/index.html) both include a private +for your own infrastructure needs. [Terraform Cloud](/cloud-docs/) and +[Terraform Enterprise](/enterprise/) both include a private module registry for sharing modules internally within your organization. ## Using Modules -- [Module Blocks](/docs/language/modules/syntax.html) documents the syntax for +- [Module Blocks](/language/modules/syntax) documents the syntax for calling a child module from a parent module, including meta-arguments like `for_each`. -- [Module Sources](/docs/language/modules/sources.html) documents what kinds of paths, +- [Module Sources](/language/modules/sources) documents what kinds of paths, addresses, and URIs can be used in the `source` argument of a module block. - The Meta-Arguments section documents special arguments that can be used with every module, including - [`providers`](/docs/language/meta-arguments/module-providers.html), - [`depends_on`](/docs/language/meta-arguments/depends_on.html), - [`count`](/docs/language/meta-arguments/count.html), - and [`for_each`](/docs/language/meta-arguments/for_each.html). + [`providers`](/language/meta-arguments/module-providers), + [`depends_on`](/language/meta-arguments/depends_on), + [`count`](/language/meta-arguments/count), + and [`for_each`](/language/meta-arguments/for_each). ## Developing Modules For information about developing reusable modules, see -[Module Development](/docs/language/modules/develop/index.html). +[Module Development](/language/modules/develop/). diff --git a/website/docs/language/modules/sources.html.md b/website/docs/language/modules/sources.mdx similarity index 92% rename from website/docs/language/modules/sources.html.md rename to website/docs/language/modules/sources.mdx index b9db802faf3e..1af189b9426a 100644 --- a/website/docs/language/modules/sources.html.md +++ b/website/docs/language/modules/sources.mdx @@ -1,13 +1,14 @@ --- -layout: "language" -page_title: "Module Sources" -sidebar_current: "docs-modules-sources" -description: "The source argument tells Terraform where to find child modules's configurations in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS." +page_title: Module Sources +description: >- + The source argument tells Terraform where to find child modules's + configurations in locations like GitHub, the Terraform Registry, Bitbucket, + Git, Mercurial, S3, and GCS. --- # Module Sources -The `source` argument in [a `module` block](/docs/language/modules/syntax.html) +The `source` argument in [a `module` block](/language/modules/syntax) tells Terraform where to find the source code for the desired child module. Terraform uses this during the module installation step of `terraform init` @@ -16,28 +17,28 @@ used by other Terraform commands. > **Hands-on:** Try our HashiCorp Learn tutorials to use modules from [the > registry](https://learn.hashicorp.com/tutorials/terraform/module-use) ->or [locally](https://learn.hashicorp.com/tutorials/terraform/module-create). +> or [locally](https://learn.hashicorp.com/tutorials/terraform/module-create). The module installer supports installation from a number of different source types, as listed below. - * [Local paths](#local-paths) +* [Local paths](#local-paths) - * [Terraform Registry](#terraform-registry) +* [Terraform Registry](#terraform-registry) - * [GitHub](#github) +* [GitHub](#github) - * [Bitbucket](#bitbucket) +* [Bitbucket](#bitbucket) - * Generic [Git](#generic-git-repository), [Mercurial](#generic-mercurial-repository) repositories +* Generic [Git](#generic-git-repository), [Mercurial](#generic-mercurial-repository) repositories - * [HTTP URLs](#http-urls) +* [HTTP URLs](#http-urls) - * [S3 buckets](#s3-bucket) +* [S3 buckets](#s3-bucket) - * [GCS buckets](#gcs-bucket) +* [GCS buckets](#gcs-bucket) - * [Modules in Package Sub-directories](#modules-in-package-sub-directories) +* [Modules in Package Sub-directories](#modules-in-package-sub-directories) Each of these is described in the following sections. Module source addresses use a _URL-like_ syntax, but with extensions to support unambiguous selection @@ -99,10 +100,10 @@ to get started with Terraform and find modules created by others in the community. You can also use a -[private registry](/docs/registry/private.html), either +[private registry](/registry/private), either via the built-in feature from Terraform Cloud, or by running a custom service that implements -[the module registry protocol](/docs/registry/api.html). +[the module registry protocol](/registry/api-docs). Modules on the public Terraform Registry can be referenced using a registry source address of the form `//`, with each @@ -138,13 +139,13 @@ the `remote` backend. Registry modules support versioning. You can provide a specific version as shown in the above examples, or use flexible -[version constraints](/docs/language/modules/syntax.html#version). +[version constraints](/language/modules/syntax#version). You can learn more about the registry at the -[Terraform Registry documentation](/docs/registry/modules/use.html#using-modules). +[Terraform Registry documentation](/registry/modules/use#using-modules). To access modules from a private registry, you may need to configure an access -token [in the CLI config](/docs/cli/config/config-file.html#credentials). Use the +token [in the CLI config](/cli/config/config-file#credentials). Use the same hostname as used in the module source string. For a private registry within Terraform Cloud, use the same authentication token as you would use with the Enterprise API or command-line clients. @@ -231,7 +232,7 @@ to select a suitable source of credentials for your environment. If your Terraform configuration will be used within [Terraform Cloud](https://www.hashicorp.com/products/terraform), only SSH key authentication is supported, and -[keys can be configured on a per-workspace basis](/docs/cloud/workspaces/ssh-keys.html). +[keys can be configured on a per-workspace basis](/cloud-docs/workspaces/settings/ssh-keys). ### Selecting a Revision @@ -266,7 +267,6 @@ module "storage" { } ``` - If you use the `ssh://` URL scheme then Terraform will assume that the colon marks the beginning of a port number, rather than the beginning of the path. This matches how Git itself interprets these different forms, aside from @@ -297,7 +297,7 @@ repositories without interactive prompts. If your Terraform configuration will be used within [Terraform Cloud](https://www.hashicorp.com/products/terraform), only SSH key authentication is supported, and -[keys can be configured on a per-workspace basis](/docs/cloud/workspaces/ssh-keys.html). +[keys can be configured on a per-workspace basis](/cloud-docs/workspaces/settings/ssh-keys). ### Selecting a Revision @@ -427,7 +427,6 @@ The module installer uses Google Cloud SDK to authenticate with GCS. To set cred * If you're running Terraform from a GCE instance, default credentials are automatically available. See [Creating and Enabling Service Accounts](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances) for Instances for more details * On your computer, you can make your Google identity available by running `gcloud auth application-default login`. - ## Modules in Package Sub-directories When the source of a module is a version control repository or archive file diff --git a/website/docs/language/modules/syntax.html.md b/website/docs/language/modules/syntax.mdx similarity index 83% rename from website/docs/language/modules/syntax.html.md rename to website/docs/language/modules/syntax.mdx index 83c98fcba8c6..3b5e37831cae 100644 --- a/website/docs/language/modules/syntax.html.md +++ b/website/docs/language/modules/syntax.mdx @@ -1,8 +1,10 @@ --- -layout: "language" -page_title: "Modules - Configuration Language" -sidebar_current: "docs-config-modules" -description: "Modules are containers for multiple resources that are used together in configurations. Learn how to call one module from another and access module output." +page_title: Modules - Configuration Language +description: >- + Modules are containers for multiple resources that are used together in + configurations. Learn how to call one module from another and access module + output. +sidebar_title: Modules --- # Module Blocks @@ -22,13 +24,13 @@ in separate configurations, allowing resource configurations to be packaged and re-used. This page describes how to call one module from another. For more information -about creating re-usable child modules, see [Module Development](/docs/language/modules/develop/index.html). +about creating re-usable child modules, see [Module Development](/language/modules/develop/). ## Calling a Child Module To _call_ a module means to include the contents of that module into the configuration with specific values for its -[input variables](/docs/language/values/variables.html). Modules are called +[input variables](/language/values/variables). Modules are called from within other modules using `module` blocks: ```hcl @@ -52,7 +54,7 @@ Module calls use the following kinds of arguments: - The `version` argument is recommended for modules from a registry. -- Most other arguments correspond to [input variables](/docs/language/values/variables.html) +- Most other arguments correspond to [input variables](/language/values/variables) defined by the module. (The `servers` argument in the example above is one of these.) @@ -66,7 +68,7 @@ Terraform. Its value is either the path to a local directory containing the module's configuration files, or a remote module source that Terraform should download and use. This value must be a literal string with no template sequences; arbitrary expressions are not allowed. For more information on -possible values for this argument, see [Module Sources](/docs/language/modules/sources.html). +possible values for this argument, see [Module Sources](/language/modules/sources). The same source address can be specified in multiple `module` blocks to create multiple copies of the resources defined within, possibly with different @@ -94,14 +96,14 @@ module "consul" { } ``` -The `version` argument accepts a [version constraint string](/docs/language/expressions/version-constraints.html). +The `version` argument accepts a [version constraint string](/language/expressions/version-constraints). Terraform will use the newest installed version of the module that meets the constraint; if no acceptable versions are installed, it will download the newest version that meets the constraint. Version constraints are supported only for modules installed from a module registry, such as the public [Terraform Registry](https://registry.terraform.io/) -or [Terraform Cloud's private module registry](/docs/cloud/registry/index.html). +or [Terraform Cloud's private module registry](/cloud-docs/registry/). Other module sources can provide their own versioning mechanisms within the source string itself, or might not support versions at all. In particular, modules sourced from local file paths do not support `version`; since @@ -115,22 +117,22 @@ optional meta-arguments that have special meaning across all modules, described in more detail in the following pages: - `count` - Creates multiple instances of a module from a single `module` block. - See [the `count` page](/docs/language/meta-arguments/count.html) + See [the `count` page](/language/meta-arguments/count) for details. - `for_each` - Creates multiple instances of a module from a single `module` block. See - [the `for_each` page](/docs/language/meta-arguments/for_each.html) + [the `for_each` page](/language/meta-arguments/for_each) for details. - `providers` - Passes provider configurations to a child module. See - [the `providers` page](/docs/language/meta-arguments/module-providers.html) + [the `providers` page](/language/meta-arguments/module-providers) for details. If not specified, the child module inherits all of the default (un-aliased) provider configurations from the calling module. - `depends_on` - Creates explicit dependencies between the entire module and the listed targets. See - [the `depends_on` page](/docs/language/meta-arguments/depends_on.html) + [the `depends_on` page](/language/meta-arguments/depends_on) for details. In addition to the above, the `lifecycle` argument is not currently used by @@ -140,7 +142,7 @@ Terraform but is reserved for planned future features. The resources defined in a module are encapsulated, so the calling module cannot access their attributes directly. However, the child module can -declare [output values](/docs/language/values/outputs.html) to selectively +declare [output values](/language/values/outputs) to selectively export certain values to be accessed by the calling module. For example, if the `./app-cluster` module referenced in the example above @@ -156,7 +158,7 @@ resource "aws_elb" "example" { ``` For more information about referring to named values, see -[Expressions](/docs/language/expressions/index.html). +[Expressions](/language/expressions/). ## Transferring Resource State Into Modules @@ -166,7 +168,7 @@ result, Terraform plans to destroy all resource instances at the old address and create new instances at the new address. To preserve existing objects, you can use -[refactoring blocks](develop/refactoring.html) to record the old and new +[refactoring blocks](/language/modules/develop/refactoring) to record the old and new addresses for each resource instance. This directs Terraform to treat existing objects at the old addresses as if they had originally been created at the corresponding new addresses. @@ -176,7 +178,7 @@ corresponding new addresses. You may have an object that needs to be replaced with a new object for a reason that isn't automatically visible to Terraform, such as if a particular virtual machine is running on degraded underlying hardware. In this case, you can use -[the `-replace=...` planning option](/docs/cli/commands/plan.html#replace-address) +[the `-replace=...` planning option](/cli/commands/plan#replace-address) to force Terraform to propose replacing that object. If the object belongs to a resource within a nested module, specify the full diff --git a/website/docs/language/modules/testing-experiment.html.md b/website/docs/language/modules/testing-experiment.mdx similarity index 99% rename from website/docs/language/modules/testing-experiment.html.md rename to website/docs/language/modules/testing-experiment.mdx index 6b2bb7fcee9e..a3b5328cfa25 100644 --- a/website/docs/language/modules/testing-experiment.html.md +++ b/website/docs/language/modules/testing-experiment.mdx @@ -1,6 +1,6 @@ --- -layout: "language" -page_title: "Module Testing Experiment - Configuration Language" +page_title: Module Testing Experiment - Configuration Language +sidebar_title: Module Testing Experiment --- # Module Testing Experiment diff --git a/website/docs/language/providers/configuration.html.md b/website/docs/language/providers/configuration.mdx similarity index 86% rename from website/docs/language/providers/configuration.html.md rename to website/docs/language/providers/configuration.mdx index 8251bce1900a..495a0c668023 100644 --- a/website/docs/language/providers/configuration.html.md +++ b/website/docs/language/providers/configuration.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Provider Configuration - Configuration Language" -sidebar_current: "docs-config-providers" -description: "Learn how to set up providers, including how to use the alias meta-argument to specify multiple configurations for a single provider." +page_title: Provider Configuration - Configuration Language +description: >- + Learn how to set up providers, including how to use the alias meta-argument to + specify multiple configurations for a single provider. +sidebar_title: Provider Configuration --- # Provider Configuration @@ -16,7 +17,7 @@ configure settings for providers. Additionally, all Terraform configurations must declare which providers they require so that Terraform can install and use them. The -[Provider Requirements](/docs/language/providers/requirements.html) +[Provider Requirements](/language/providers/requirements) page documents how to declare providers so Terraform can install them. ## Provider Configuration @@ -24,8 +25,8 @@ page documents how to declare providers so Terraform can install them. Provider configurations belong in the root module of a Terraform configuration. (Child modules receive their provider configurations from the root module; for more information, see -[The Module `providers` Meta-Argument](/docs/language/meta-arguments/module-providers.html) -and [Module Development: Providers Within Modules](/docs/language/modules/develop/providers.html).) +[The Module `providers` Meta-Argument](/language/meta-arguments/module-providers) +and [Module Development: Providers Within Modules](/language/modules/develop/providers).) A provider configuration is created using a `provider` block: @@ -37,7 +38,7 @@ provider "google" { ``` The name given in the block header (`"google"` in this example) is the -[local name](/docs/language/providers/requirements.html#local-names) of the provider to +[local name](/language/providers/requirements#local-names) of the provider to configure. This provider should already be included in a `required_providers` block. @@ -46,7 +47,7 @@ the provider. Most arguments in this section are defined by the provider itself; in this example both `project` and `region` are specific to the `google` provider. -You can use [expressions](/docs/language/expressions/index.html) in the values of these +You can use [expressions](/language/expressions/) in the values of these configuration arguments, but can only reference values that are known before the configuration is applied. This means you can safely reference input variables, but not attributes exported by resources (with an exception for resource @@ -68,7 +69,7 @@ and available for all `provider` blocks: - [`alias`, for using the same provider with different configurations for different resources][inpage-alias] - [`version`, which we no longer recommend][inpage-versions] (use - [provider requirements](/docs/language/providers/requirements.html) instead) + [provider requirements](/language/providers/requirements) instead) Unlike many other objects in the Terraform language, a `provider` block may be omitted if its contents would otherwise be empty. Terraform assumes an @@ -175,7 +176,7 @@ module "aws_vpc" { ``` Modules have some special requirements when passing in providers; see -[The Module `providers` Meta-Argument](/docs/language/meta-arguments/module-providers.html) +[The Module `providers` Meta-Argument](/language/meta-arguments/module-providers) for more details. In most cases, only _root modules_ should define provider configurations, with all child modules obtaining their provider configurations from their parents. @@ -188,11 +189,11 @@ from their parents. The `version` meta-argument specifies a version constraint for a provider, and works the same way as the `version` argument in a -[`required_providers` block](/docs/language/providers/requirements.html). The version +[`required_providers` block](/language/providers/requirements). The version constraint in a provider configuration is only used if `required_providers` does not include one for that provider. **The `version` argument in provider configurations is deprecated.** In Terraform 0.13 and later, always declare provider version constraints in -[the `required_providers` block](/docs/language/providers/requirements.html). The `version` +[the `required_providers` block](/language/providers/requirements). The `version` argument will be removed in a future version of Terraform. diff --git a/website/docs/language/providers/index.html.md b/website/docs/language/providers/index.mdx similarity index 54% rename from website/docs/language/providers/index.html.md rename to website/docs/language/providers/index.mdx index fd95e66e54fb..5568fdd70076 100644 --- a/website/docs/language/providers/index.html.md +++ b/website/docs/language/providers/index.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "Providers - Configuration Language" -description: "An overview of how to install and use providers, Terraform plugins that interact with services, cloud providers, and other APIs." +page_title: Providers - Configuration Language +description: >- + An overview of how to install and use providers, Terraform plugins that + interact with services, cloud providers, and other APIs. +sidebar_title: Providers --- # Providers @@ -17,8 +19,8 @@ configuration (like endpoint URLs or cloud regions) before they can be used. ## What Providers Do -Each provider adds a set of [resource types](/docs/language/resources/index.html) -and/or [data sources](/docs/language/data-sources/index.html) that Terraform can +Each provider adds a set of [resource types](/language/resources/) +and/or [data sources](/language/data-sources/) that Terraform can manage. Every resource type is implemented by a provider; without providers, Terraform @@ -50,20 +52,20 @@ Provider documentation in the Registry is versioned; you can use the version menu in the header to change which version you're viewing. For details about writing, generating, and previewing provider documentation, -see the [provider publishing documentation](/docs/registry/providers/docs.html). +see the [provider publishing documentation](/registry/providers/docs). ## How to Use Providers To use resources from a given provider, you need to include some information about it in your configuration. See the following pages for details: -- [Provider Requirements](/docs/language/providers/requirements.html) +- [Provider Requirements](/language/providers/requirements) documents how to declare providers so Terraform can install them. -- [Provider Configuration](/docs/language/providers/configuration.html) +- [Provider Configuration](/language/providers/configuration) documents how to configure settings for providers. -- [Dependency Lock File](/docs/language/dependency-lock.html) +- [Dependency Lock File](/language/dependency-lock) documents an additional HCL file that can be included with a configuration, which tells Terraform to always use a specific set of provider versions. @@ -72,18 +74,18 @@ about it in your configuration. See the following pages for details: - Terraform Cloud and Terraform Enterprise install providers as part of every run. - Terraform CLI finds and installs providers when - [initializing a working directory](/docs/cli/init/index.html). It can + [initializing a working directory](/cli/init/). It can automatically download providers from a Terraform registry, or load them from a local mirror or cache. If you are using a persistent working directory, you must reinitialize whenever you change a configuration's providers. - To save time and bandwidth, Terraform CLI supports an optional plugin - cache. You can enable the cache using the `plugin_cache_dir` setting in - [the CLI configuration file](/docs/cli/config/config-file.html). + To save time and bandwidth, Terraform CLI supports an optional plugin + cache. You can enable the cache using the `plugin_cache_dir` setting in + [the CLI configuration file](/cli/config/config-file). To ensure Terraform always installs the same provider versions for a given configuration, you can use Terraform CLI to create a -[dependency lock file](/docs/language/dependency-lock.html) +[dependency lock file](/language/dependency-lock) and commit it to version control along with your configuration. If a lock file is present, Terraform Cloud, CLI, and Enterprise will all obey it when installing providers. @@ -100,42 +102,14 @@ are published by platform maintainers, and some are published by users and volunteers. The provider listings use the following badges to indicate who develops and maintains a given provider. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      TierDescriptionNamespace
      Official providers are owned and maintained by HashiCorp hashicorp
      Verified providers are owned and maintained by third-party technology partners. Providers in this tier indicate HashiCorp has verified the authenticity of the Provider’s publisher, and that the partner is a member of the HashiCorp Technology Partner Program.Third-party organization, e.g. mongodb/mongodbatlas
      Community providers are published to the Terraform Registry by individual maintainers, groups of maintainers, or other members of the Terraform community.
      Maintainer’s individual or organization account, e.g. DeviaVir/gsuite
      Archived Providers are Official or Verified Providers that are no longer maintained by HashiCorp or the community. This may occur if an API is deprecated or interest was low.hashicorp or third-party
      - + +

      ## How to Develop Providers Providers are written in Go, using the Terraform Plugin SDK. For more information on developing providers, see: -- The [Plugin Development](/docs/extend/index.html) documentation +- The [Plugin Development](/plugin/) documentation - The [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) collection on HashiCorp Learn diff --git a/website/docs/language/providers/requirements.html.md b/website/docs/language/providers/requirements.mdx similarity index 91% rename from website/docs/language/providers/requirements.html.md rename to website/docs/language/providers/requirements.mdx index 6e8b995c4df7..df5118ac1394 100644 --- a/website/docs/language/providers/requirements.html.md +++ b/website/docs/language/providers/requirements.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "Provider Requirements - Configuration Language" -description: "Providers are plugins that allow Terraform to interact with services, cloud providers, and other APIs. Learn how to declare providers in a configuration." +page_title: Provider Requirements - Configuration Language +description: >- + Providers are plugins that allow Terraform to interact with services, cloud + providers, and other APIs. Learn how to declare providers in a configuration. +sidebar_title: Provider Requirements --- # Provider Requirements @@ -15,7 +17,7 @@ so Terraform can install them. Additionally, some providers require configuration (like endpoint URLs or cloud regions) before they can be used. The [Provider -Configuration](/docs/language/providers/configuration.html) page documents how +Configuration](/language/providers/configuration) page documents how to configure settings for providers. -> **Note:** This page is about a feature of Terraform 0.13 and later; it also @@ -43,7 +45,7 @@ terraform { ``` The `required_providers` block must be nested inside the top-level -[`terraform` block](/docs/language/settings/index.html) (which can also contain other settings). +[`terraform` block](/language/settings/) (which can also contain other settings). Each argument in the `required_providers` block enables one provider. The key determines the provider's [local name](#local-names) (its unique identifier @@ -66,8 +68,8 @@ Requirements](#v0-12-compatible-provider-requirements) below. Each provider has two identifiers: -- A unique _source address,_ which is only used when requiring a provider. -- A _local name,_ which is used everywhere else in a Terraform module. +* A unique _source address,_ which is only used when requiring a provider. +* A _local name,_ which is used everywhere else in a Terraform module. -> **Note:** Prior to Terraform 0.13, providers only had local names, since Terraform could only automatically download providers distributed by HashiCorp. @@ -80,7 +82,7 @@ Local names must be unique per-module. Outside of the `required_providers` block, Terraform configurations always refer to providers by their local names. For example, the following configuration declares `mycloud` as the local name for `mycorp/mycloud`, then uses that local -name when [configuring the provider](/docs/language/providers/configuration.html): +name when [configuring the provider](/language/providers/configuration): ```hcl terraform { @@ -131,11 +133,11 @@ follows: * **Type:** A short name for the platform or system the provider manages. Must be unique within a particular namespace on a particular registry host. - The type is usually the provider's preferred local name. (There are - exceptions; for example, - [`hashicorp/google-beta`](https://registry.terraform.io/providers/hashicorp/google-beta/latest) - is an alternate release channel for `hashicorp/google`, so its preferred - local name is `google`. If in doubt, check the provider's documentation.) + The type is usually the provider's preferred local name. (There are + exceptions; for example, + [`hashicorp/google-beta`](https://registry.terraform.io/providers/hashicorp/google-beta/latest) + is an alternate release channel for `hashicorp/google`, so its preferred + local name is `google`. If in doubt, check the provider's documentation.) For example, [the official HTTP provider](https://registry.terraform.io/providers/hashicorp/http) @@ -150,7 +152,6 @@ version is used. This display version omits the source host when it is the public registry, so you may see the shortened version `"hashicorp/random"` instead of `"registry.terraform.io/hashicorp/random"`. - -> **Note:** If you omit the `source` argument when requiring a provider, Terraform uses an implied source address of `registry.terraform.io/hashicorp/`. This is a backward compatibility @@ -210,7 +211,7 @@ avoiding typing. Each provider plugin has its own set of available versions, allowing the functionality of the provider to evolve over time. Each provider dependency you -declare should have a [version constraint](/docs/language/expressions/version-constraints.html) given in +declare should have a [version constraint](/language/expressions/version-constraints) given in the `version` argument so Terraform can select a single version per provider that all modules are compatible with. @@ -220,7 +221,7 @@ a version constraint for every provider your module depends on. To ensure Terraform always installs the same provider versions for a given configuration, you can use Terraform CLI to create a -[dependency lock file](/docs/language/dependency-lock.html) +[dependency lock file](/language/dependency-lock) and commit it to version control along with your configuration. If a lock file is present, Terraform Cloud, CLI, and Enterprise will all obey it when installing providers. @@ -272,7 +273,7 @@ incompatibilities, and let the root module manage the maximum version. While most Terraform providers are distributed separately as plugins, there is currently one provider that is built in to Terraform itself, which provides -[the `terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +[the `terraform_remote_state` data source](/language/state/remote-state-data). Because this provider is built in to Terraform, you don't need to declare it in the `required_providers` block in order to use its features. However, for @@ -301,11 +302,11 @@ publishing them on the public Terraform Registry. One option for distributing such a provider is to run an in-house _private_ registry, by implementing -[the provider registry protocol](/docs/internals/provider-registry-protocol.html). +[the provider registry protocol](/internals/provider-registry-protocol). Running an additional service just to distribute a single provider internally may be undesirable, so Terraform also supports -[other provider installation methods](/docs/cli/config/config-file.html#provider-installation), +[other provider installation methods](/cli/config/config-file#provider-installation), including placing provider plugins directly in specific directories in the local filesystem, via _filesystem mirrors_. @@ -334,7 +335,7 @@ terraform { To make version 1.0.0 of this provider available for installation from the local filesystem, choose one of the -[implied local mirror directories](/docs/cli/config/config-file.html#implied-local-mirror-directories) +[implied local mirror directories](/cli/config/config-file#implied-local-mirror-directories) and create a directory structure under it like this: ``` diff --git a/website/docs/language/resources/behavior.html.md b/website/docs/language/resources/behavior.mdx similarity index 86% rename from website/docs/language/resources/behavior.html.md rename to website/docs/language/resources/behavior.mdx index 1f8b4c249bf2..44b9eadfb0b6 100644 --- a/website/docs/language/resources/behavior.html.md +++ b/website/docs/language/resources/behavior.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "Resource Behavior - Configuration Language" -description: "Learn how Terraform uses resource blocks to create infrastructure objects. Also learn about resource dependencies and how to access resource attributes." +page_title: Resource Behavior - Configuration Language +description: >- + Learn how Terraform uses resource blocks to create infrastructure objects. + Also learn about resource dependencies and how to access resource attributes. +sidebar_title: Resource Behavior --- # Resource Behavior @@ -19,7 +21,7 @@ match the configuration. When Terraform creates a new infrastructure object represented by a `resource` block, the identifier for that real object is saved in Terraform's -[state](/docs/language/state/index.html), allowing it to be updated and destroyed +[state](/language/state/), allowing it to be updated and destroyed in response to future changes. For resource blocks that already have an associated infrastructure object in the state, Terraform compares the actual configuration of the object with the arguments given in the @@ -43,7 +45,7 @@ customized on a per-resource basis. ## Accessing Resource Attributes -[Expressions](/docs/language/expressions/index.html) within a Terraform module can access +[Expressions](/language/expressions/) within a Terraform module can access information about resources in the same module, and you can use that information to help configure other resources. Use the `..` syntax to reference a resource attribute in an expression. @@ -53,7 +55,7 @@ read-only attributes with information obtained from the remote API; this often includes things that can't be known until the resource is created, like the resource's unique random ID. -Many providers also include [data sources](/docs/language/data-sources/index.html), +Many providers also include [data sources](/language/data-sources/), which are a special type of resource used only for looking up information. For a list of the attributes a resource or data source type provides, consult @@ -61,7 +63,7 @@ its documentation; these are generally included in a second list below its list of configurable arguments. For more information about referencing resource attributes in expressions, see -[Expressions: References to Resource Attributes](/docs/language/expressions/references.html#references-to-resource-attributes). +[Expressions: References to Resource Attributes](/language/expressions/references#references-to-resource-attributes). ## Resource Dependencies @@ -74,7 +76,7 @@ resource's configuration just requires information generated by another resource. Most resource dependencies are handled automatically. Terraform analyses any -[expressions](/docs/language/expressions/index.html) within a `resource` block to find references +[expressions](/language/expressions/) within a `resource` block to find references to other objects, and treats those references as implicit ordering requirements when creating, updating, or destroying resources. Since most resources with behavioral dependencies on other resources also refer to those resources' data, @@ -85,7 +87,7 @@ example, if Terraform must manage access control policies _and_ take actions that require those policies to be present, there is a hidden dependency between the access policy and a resource whose creation depends on it. In these rare cases, -[the `depends_on` meta-argument](/docs/language/meta-arguments/depends_on.html) +[the `depends_on` meta-argument](/language/meta-arguments/depends_on) can explicitly specify a dependency. ## Local-only Resources @@ -106,4 +108,3 @@ connect together other resources. The behavior of local-only resources is the same as all other resources, but their result data exists only within the Terraform state. "Destroying" such a resource means only to remove it from the state, discarding its data. - diff --git a/website/docs/language/resources/index.html.md b/website/docs/language/resources/index.mdx similarity index 55% rename from website/docs/language/resources/index.html.md rename to website/docs/language/resources/index.mdx index 4de70b7d4144..c99606fe4d4f 100644 --- a/website/docs/language/resources/index.html.md +++ b/website/docs/language/resources/index.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "Resources Overview - Configuration Language" -description: "Resources describe infrastructure objects in Terraform configurations. Find documentation for resource syntax, behavior, and meta-arguments." +page_title: Resources Overview - Configuration Language +description: >- + Resources describe infrastructure objects in Terraform configurations. Find + documentation for resource syntax, behavior, and meta-arguments. +sidebar_title: Resources Overview --- # Resources @@ -13,22 +15,22 @@ Each resource block describes one or more infrastructure objects, such as virtual networks, compute instances, or higher-level components such as DNS records. -- [Resource Blocks](/docs/language/resources/syntax.html) documents +- [Resource Blocks](/language/resources/syntax) documents the syntax for declaring resources. -- [Resource Behavior](/docs/language/resources/behavior.html) explains in +- [Resource Behavior](/language/resources/behavior) explains in more detail how Terraform handles resource declarations when applying a configuration. - The Meta-Arguments section documents special arguments that can be used with every resource type, including - [`depends_on`](/docs/language/meta-arguments/depends_on.html), - [`count`](/docs/language/meta-arguments/count.html), - [`for_each`](/docs/language/meta-arguments/for_each.html), - [`provider`](/docs/language/meta-arguments/resource-provider.html), - and [`lifecycle`](/docs/language/meta-arguments/lifecycle.html). + [`depends_on`](/language/meta-arguments/depends_on), + [`count`](/language/meta-arguments/count), + [`for_each`](/language/meta-arguments/for_each), + [`provider`](/language/meta-arguments/resource-provider), + and [`lifecycle`](/language/meta-arguments/lifecycle). -- [Provisioners](/docs/language/resources/provisioners/index.html) +- [Provisioners](/language/resources/provisioners/) documents configuring post-creation actions for a resource using the `provisioner` and `connection` blocks. Since provisioners are non-declarative and potentially unpredictable, we strongly recommend that you treat them as a diff --git a/website/docs/language/resources/provisioners/chef.html.md b/website/docs/language/resources/provisioners/chef.mdx similarity index 93% rename from website/docs/language/resources/provisioners/chef.html.md rename to website/docs/language/resources/provisioners/chef.mdx index e420b9a386c7..9ec4887e2cb3 100644 --- a/website/docs/language/resources/provisioners/chef.html.md +++ b/website/docs/language/resources/provisioners/chef.mdx @@ -1,18 +1,17 @@ --- -layout: "language" -page_title: "Provisioner: chef" -sidebar_current: "docs-provisioners-chef" -description: |- - The `chef` provisioner installs, configures and runs the Chef client on a resource. +page_title: 'Provisioner: chef' +description: >- + The `chef` provisioner installs, configures and runs the Chef client on a + resource. --- # Chef Provisioner The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh` and `winrm` type -[connections](/docs/language/resources/provisioners/connection.html). +[connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). ## Requirements @@ -68,7 +67,7 @@ The following arguments are supported: * `attributes_json (string)` - (Optional) A raw JSON string with initial node attributes for the new node. These can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `channel (string)` - (Optional) The Chef Client release channel to install from. If not set, the `stable` channel will be used. @@ -127,7 +126,7 @@ The following arguments are supported: * `prevent_sudo (boolean)` - (Optional) Prevent the use of the `sudo` command while installing, configuring and running the initial Chef Client run. This option is only used with `ssh` type - [connections](/docs/language/resources/provisioners/connection.html). + [connections](/language/resources/provisioners/connection). * `recreate_client (boolean)` - (Optional) If `true`, first delete any existing Chef Node and Client before registering the new Chef Client. @@ -145,7 +144,7 @@ The following arguments are supported: * `secret_key (string)` - (Optional) The contents of the secret key that is used by the Chef Client to decrypt data bags on the Chef Server. The key will be uploaded to the remote machine. This can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `server_url (string)` - (Required) The URL to the Chef server. This includes the path to the organization. See the example. @@ -167,11 +166,11 @@ The following arguments are supported: * `user_key (string)` - (Required) The contents of the user key that will be used to authenticate with the Chef Server. This can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `vault_json (string)` - (Optional) A raw JSON string with Chef Vaults and Items to which the new node should have access. These can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `version (string)` - (Optional) The Chef Client version to install on the remote machine. If not set, the latest available version will be installed. diff --git a/website/docs/language/resources/provisioners/connection.html.md b/website/docs/language/resources/provisioners/connection.mdx similarity index 80% rename from website/docs/language/resources/provisioners/connection.html.md rename to website/docs/language/resources/provisioners/connection.mdx index 762c37a91063..704012199ae3 100644 --- a/website/docs/language/resources/provisioners/connection.html.md +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provisioner Connection Settings" -sidebar_current: "docs-provisioners-connection" -description: "The connection block allows you to manage provisioner connection defaults for SSH and WinRM." +page_title: Provisioner Connection Settings +description: >- + The connection block allows you to manage provisioner connection defaults for + SSH and WinRM. --- # Provisioner Connection Settings @@ -12,7 +12,7 @@ expect a nested `connection` block with details about how to connect. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). -> **Note:** In Terraform 0.11 and earlier, providers could set default values for some connection settings, so that `connection` blocks could sometimes be @@ -28,9 +28,9 @@ below explicitly set to verify against a specific key or signing CA. Connection blocks don't take a block label, and can be nested within either a `resource` or a `provisioner`. -- A `connection` block nested directly within a `resource` affects all of +* A `connection` block nested directly within a `resource` affects all of that resource's provisioners. -- A `connection` block nested in a `provisioner` block only affects that +* A `connection` block nested in a `provisioner` block only affects that provisioner, and overrides any resource-level connection settings. One use case for providing multiple connections is to have an initial @@ -85,10 +85,10 @@ block would create a dependency cycle. **The following arguments are supported by all connection types:** * `type` - The connection type that should be used. Valid types are `ssh` and `winrm`. - Defaults to `ssh`. + Defaults to `ssh`. * `user` - The user that we should use for the connection. - Defaults to `root` when using type `ssh` and defaults to `Administrator` when using type `winrm`. + Defaults to `root` when using type `ssh` and defaults to `Administrator` when using type `winrm`. * `password` - The password we should use for the connection. In some cases this is specified by the provider. @@ -96,10 +96,10 @@ block would create a dependency cycle. * `host` - (Required) The address of the resource to connect to. * `port` - The port to connect to. - Defaults to `22` when using type `ssh` and defaults to `5985` when using type `winrm`. + Defaults to `22` when using type `ssh` and defaults to `5985` when using type `winrm`. * `timeout` - The timeout to wait for the connection to become available. Should be provided as a string like `30s` or `5m`. - Defaults to 5 minutes. + Defaults to 5 minutes. * `script_path` - The path used to copy scripts meant for remote execution. @@ -107,24 +107,25 @@ block would create a dependency cycle. * `private_key` - The contents of an SSH key to use for the connection. These can be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). This takes + [the `file` function](/language/functions/file). This takes preference over the password if provided. * `certificate` - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `private_key`. These can - be loaded from a file on disk using the [the `file` function](/docs/language/functions/file.html). + be loaded from a file on disk using the [the `file` function](/language/functions/file). * `agent` - Set to `false` to disable using `ssh-agent` to authenticate. On Windows the only supported SSH authentication agent is - [Pageant](http://the.earth.li/~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). + [Pageant](http://the.earth.li/\~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). * `agent_identity` - The preferred identity from the ssh agent for authentication. * `host_key` - The public key from the remote host or the signing CA, used to verify the connection. + * `target_platform` - The target platform to connect to. Valid values are `windows` and `unix`. Defaults to `unix` if not set. - If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` + If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` **Additional arguments only supported by the `winrm` connection type:** @@ -160,9 +161,9 @@ The `ssh` connection also supports the following fields to facilitate connnectio * `bastion_private_key` - The contents of an SSH key file to use for the bastion host. These can be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). Defaults to the value of the `private_key` field. * `bastion_certificate` - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `bastion_private_key`. These can be loaded from - a file on disk using the [the `file` function](/docs/language/functions/file.html). + a file on disk using the [the `file` function](/language/functions/file). diff --git a/website/docs/language/resources/provisioners/file.html.md b/website/docs/language/resources/provisioners/file.mdx similarity index 89% rename from website/docs/language/resources/provisioners/file.html.md rename to website/docs/language/resources/provisioners/file.mdx index 05b494e5b2d0..06b22758b49c 100644 --- a/website/docs/language/resources/provisioners/file.html.md +++ b/website/docs/language/resources/provisioners/file.mdx @@ -1,20 +1,20 @@ --- -layout: "language" -page_title: "Provisioner: file" -sidebar_current: "docs-provisioners-file" -description: |- - The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner supports both `ssh` and `winrm` type connections. +page_title: 'Provisioner: file' +description: >- + The `file` provisioner is used to copy files or directories from the machine + executing Terraform to the newly created resource. The `file` provisioner + supports both `ssh` and `winrm` type connections. --- # File Provisioner The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner -supports both `ssh` and `winrm` type [connections](/docs/language/resources/provisioners/connection.html). +supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). ## Example usage diff --git a/website/docs/language/resources/provisioners/habitat.html.md b/website/docs/language/resources/provisioners/habitat.mdx similarity index 94% rename from website/docs/language/resources/provisioners/habitat.html.md rename to website/docs/language/resources/provisioners/habitat.mdx index 66af5a655f94..c8ab535d14f1 100644 --- a/website/docs/language/resources/provisioners/habitat.html.md +++ b/website/docs/language/resources/provisioners/habitat.mdx @@ -1,22 +1,21 @@ --- -layout: "language" -page_title: "Provisioner: habitat" -sidebar_current: "docs-provisioners-habitat" -description: |- - The `habitat` provisioner installs the Habitat supervisor, and loads configured services. +page_title: 'Provisioner: habitat' +description: >- + The `habitat` provisioner installs the Habitat supervisor, and loads + configured services. --- # Habitat Provisioner The `habitat` provisioner installs the [Habitat](https://habitat.sh) supervisor and loads configured services. This provisioner only supports Linux targets using the `ssh` connection type at this time. -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). ## Requirements The `habitat` provisioner has some prerequisites for specific connection types: -- For `ssh` type connections, we assume a few tools to be available on the remote host: +* For `ssh` type connections, we assume a few tools to be available on the remote host: * `curl` * `tee` * `setsid` - Only if using the `unmanaged` service type. @@ -50,6 +49,7 @@ resource "aws_instance" "redis" { There are 2 configuration levels, `supervisor` and `service`. Configuration placed directly within the `provisioner` block are supervisor configurations, and a provisioner can define zero or more services to run, and each service will have a `service` block within the `provisioner`. A `service` block can also contain zero or more `bind` blocks to create service group bindings. ### Supervisor Arguments + * `accept_license (bool)` - (Required) Set to true to accept [Habitat end user license agreement](https://www.chef.io/end-user-license-agreement/) * `version (string)` - (Optional) The Habitat version to install on the remote machine. If not specified, the latest available version is used. * `auto_update (bool)` - (Optional) If set to `true`, the supervisor will auto-update itself as soon as new releases are available on the specified `channel`. @@ -66,7 +66,7 @@ There are 2 configuration levels, `supervisor` and `service`. Configuration pla * `ring_key (string)` - (Optional) The name of the ring key for encrypting gossip ring communication (Defaults to no encryption) * `ring_key_content (string)` - (Optional) The key content. Only needed if using ring encryption and want the provisioner to take care of uploading and importing it. Easiest to source from a file (eg `ring_key_content = "${file("conf/foo-123456789.sym.key")}"`) (Defaults to none) * `ctl_secret (string)` - (Optional) Specify a secret to use (from `hab sup secret generate`) for control gateway communication between hab client(s) and the supervisor. (Defaults to none) -* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to https://bldr.habitat.sh) +* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to ) * `channel (string)` - (Optional) The release channel in the Builder service to use. (Defaults to `stable`) * `events (string)` - (Optional) Name of the service group running a Habitat EventSrv to forward Supervisor and service event data to. (Defaults to none) * `organization (string)` - (Optional) The organization that the Supervisor and it's subsequent services are part of. (Defaults to `default`) @@ -74,6 +74,7 @@ There are 2 configuration levels, `supervisor` and `service`. Configuration pla * `builder_auth_token (string)` - (Optional) The builder authorization token when using a private origin. (Defaults to none) ### Service Arguments + * `name (string)` - (Required) The Habitat package identifier of the service to run. (ie `core/haproxy` or `core/redis/3.2.4/20171002182640`) * `binds (array)` - (Optional) An array of bind specifications. (ie `binds = ["backend:nginx.default"]`) * `bind` - (Optional) An alternative way of declaring binds. This method can be easier to deal with when populating values from other values or variable inputs without having to do string interpolation. The following example is equivalent to `binds = ["backend:nginx.default"]`: @@ -85,12 +86,13 @@ bind { group = "default" } ``` + * `topology (string)` - (Optional) Topology to start service in. Possible values `standalone` or `leader`. (Defaults to `standalone`) * `strategy (string)` - (Optional) Update strategy to use. Possible values `at-once`, `rolling` or `none`. (Defaults to `none`) * `user_toml (string)` - (Optional) TOML formatted user configuration for the service. Easiest to source from a file (eg `user_toml = "${file("conf/redis.toml")}"`). (Defaults to none) * `channel (string)` - (Optional) The release channel in the Builder service to use. (Defaults to `stable`) * `group (string)` - (Optional) The service group to join. (Defaults to `default`) -* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to https://bldr.habitat.sh) +* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to ) * `application (string)` - (Optional) The application name. (Defaults to none) * `environment (string)` - (Optional) The environment name. (Defaults to none) * `service_key (string)` - (Optional) The key content of a service private key, if using service group encryption. Easiest to source from a file (eg `service_key = "${file("conf/redis.default@org-123456789.box.key")}"`) (Defaults to none) diff --git a/website/docs/language/resources/provisioners/index.html.md b/website/docs/language/resources/provisioners/index.html.md deleted file mode 100644 index 2a22e2dd2eb7..000000000000 --- a/website/docs/language/resources/provisioners/index.html.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: "language" -page_title: "Provisioners Overview - Configuration Language" -description: "Provisioners model specific actions on a local or remote machine to prepare servers or other infrastructure for service." ---- - -# Provisioners - -Provisioners can be used to model specific actions on the local machine or on a -remote machine in order to prepare servers or other infrastructure objects for -service. - diff --git a/website/docs/language/resources/provisioners/index.mdx b/website/docs/language/resources/provisioners/index.mdx new file mode 100644 index 000000000000..29d295c25ec2 --- /dev/null +++ b/website/docs/language/resources/provisioners/index.mdx @@ -0,0 +1,13 @@ +--- +page_title: Provisioners Overview - Configuration Language +description: >- + Provisioners model specific actions on a local or remote machine to prepare + servers or other infrastructure for service. +sidebar_title: Provisioners Overview +--- + +# Provisioners + +Provisioners can be used to model specific actions on the local machine or on a +remote machine in order to prepare servers or other infrastructure objects for +service. diff --git a/website/docs/language/resources/provisioners/local-exec.html.md b/website/docs/language/resources/provisioners/local-exec.mdx similarity index 83% rename from website/docs/language/resources/provisioners/local-exec.html.md rename to website/docs/language/resources/provisioners/local-exec.mdx index 1feded8c7a6c..02eec0ef7994 100644 --- a/website/docs/language/resources/provisioners/local-exec.html.md +++ b/website/docs/language/resources/provisioners/local-exec.mdx @@ -1,9 +1,9 @@ --- -layout: "language" -page_title: "Provisioner: local-exec" -sidebar_current: "docs-provisioners-local" -description: |- - The `local-exec` provisioner invokes a local executable after a resource is created. This invokes a process on the machine running Terraform, not on the resource. See the `remote-exec` provisioner to run commands on the resource. +page_title: 'Provisioner: local-exec' +description: >- + The `local-exec` provisioner invokes a local executable after a resource is + created. This invokes a process on the machine running Terraform, not on the + resource. See the `remote-exec` provisioner to run commands on the resource. --- # local-exec Provisioner @@ -11,7 +11,7 @@ description: |- The `local-exec` provisioner invokes a local executable after a resource is created. This invokes a process on the machine running Terraform, not on the resource. See the `remote-exec` -[provisioner](/docs/language/resources/provisioners/remote-exec.html) to run commands on the +[provisioner](/language/resources/provisioners/remote-exec) to run commands on the resource. Note that even though the resource will be fully created when the provisioner is @@ -20,7 +20,7 @@ system services such as `sshd` may not be started yet on compute resources. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). ## Example usage @@ -45,7 +45,7 @@ The following arguments are supported: * `working_dir` - (Optional) If provided, specifies the working directory where `command` will be executed. It can be provided as a relative path to the - current working directory or as an absolute path. The directory must exist. + current working directory or as an absolute path. The directory must exist. * `interpreter` - (Optional) If provided, this is a list of interpreter arguments used to execute the command. The first argument is the diff --git a/website/docs/language/resources/provisioners/null_resource.html.md b/website/docs/language/resources/provisioners/null_resource.mdx similarity index 68% rename from website/docs/language/resources/provisioners/null_resource.html.md rename to website/docs/language/resources/provisioners/null_resource.mdx index 4d9f53712c14..3e7b3fd65ae6 100644 --- a/website/docs/language/resources/provisioners/null_resource.html.md +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provisioners Without a Resource" -sidebar_current: "docs-provisioners-null-resource" -description: "A null_resource allows you to configure provisioners that are not directly associated with a single existing resource." +page_title: Provisioners Without a Resource +description: >- + A null_resource allows you to configure provisioners that are not directly + associated with a single existing resource. --- # Provisioners Without a Resource @@ -14,8 +14,8 @@ resource, you can associate them with a `null_resource`. Instances of [`null_resource`][null] are treated like normal resources, but they don't do anything. Like with any other resource, you can configure -[provisioners](/docs/language/resources/provisioners/syntax.html) and [connection -details](/docs/language/resources/provisioners/connection.html) on a `null_resource`. You can also +[provisioners](/language/resources/provisioners/syntax) and [connection +details](/language/resources/provisioners/connection) on a `null_resource`. You can also use its `triggers` argument and any meta-arguments to control exactly where in the dependency graph its provisioners will run. @@ -54,6 +54,6 @@ resource "null_resource" "cluster" { In addition to meta-arguments supported by all resources, `null_resource` supports the following specific arguments: - * `triggers` - A map of values which should cause this set of provisioners to - re-run. Values are meant to be interpolated references to variables or - attributes of other resources. +- `triggers` - A map of values which should cause this set of provisioners to + re-run. Values are meant to be interpolated references to variables or + attributes of other resources. diff --git a/website/docs/language/resources/provisioners/puppet.html.md b/website/docs/language/resources/provisioners/puppet.mdx similarity index 93% rename from website/docs/language/resources/provisioners/puppet.html.md rename to website/docs/language/resources/provisioners/puppet.mdx index 0e5005256435..e0894c271f9b 100644 --- a/website/docs/language/resources/provisioners/puppet.html.md +++ b/website/docs/language/resources/provisioners/puppet.mdx @@ -1,18 +1,17 @@ --- -layout: "language" -page_title: "Provisioner: puppet" -sidebar_current: "docs-provisioners-puppet" -description: |- - The `puppet` provisioner installs, configures and runs the Puppet agent on a resource. +page_title: 'Provisioner: puppet' +description: >- + The `puppet` provisioner installs, configures and runs the Puppet agent on a + resource. --- # Puppet Provisioner The `puppet` provisioner installs, configures and runs the Puppet agent on a remote resource. The `puppet` provisioner supports both `ssh` and `winrm` type -[connections](/docs/language/resources/provisioners/connection.html). +[connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). ## Requirements @@ -76,7 +75,7 @@ The following arguments are supported: a certificate from the Puppet master CA (defaults to the FQDN of the resource). -* `extension_requests (map)` - (Optional) A map of [extension +* `extension_requests (map)` - (Optional) A map of [extension requests](https://puppet.com/docs/puppet/latest/ssl_attributes_extensions.html#concept-932) to be embedded in the certificate signing request before it is sent to the Puppet master CA and then transferred to the final certificate when the CSR diff --git a/website/docs/language/resources/provisioners/remote-exec.html.md b/website/docs/language/resources/provisioners/remote-exec.mdx similarity index 67% rename from website/docs/language/resources/provisioners/remote-exec.html.md rename to website/docs/language/resources/provisioners/remote-exec.mdx index 19e771989de8..4b4d94274a8f 100644 --- a/website/docs/language/resources/provisioners/remote-exec.html.md +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -1,9 +1,11 @@ --- -layout: "language" -page_title: "Provisioner: remote-exec" -sidebar_current: "docs-provisioners-remote" -description: |- - The `remote-exec` provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc. To invoke a local process, see the `local-exec` provisioner instead. The `remote-exec` provisioner supports both `ssh` and `winrm` type connections. +page_title: 'Provisioner: remote-exec' +description: >- + The `remote-exec` provisioner invokes a script on a remote resource after it + is created. This can be used to run a configuration management tool, bootstrap + into a cluster, etc. To invoke a local process, see the `local-exec` + provisioner instead. The `remote-exec` provisioner supports both `ssh` and + `winrm` type connections. --- # remote-exec Provisioner @@ -11,13 +13,13 @@ description: |- The `remote-exec` provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc. To invoke a local process, see the `local-exec` -[provisioner](/docs/language/resources/provisioners/local-exec.html) instead. The `remote-exec` -provisioner requires a [connection](/docs/language/resources/provisioners/connection.html) +[provisioner](/language/resources/provisioners/local-exec) instead. The `remote-exec` +provisioner requires a [connection](/language/resources/provisioners/connection) and supports both `ssh` and `winrm`. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). ## Example usage @@ -58,14 +60,14 @@ The following arguments are supported: that will be copied to the remote resource and then executed. They are executed in the order they are provided. This cannot be provided with `inline` or `script`. --> **Note:** Since `inline` is implemented by concatenating commands into a script, [`on_failure`](/docs/language/resources/provisioners/syntax.html#failure-behavior) applies only to the final command in the list. In particular, with `on_failure = fail` (the default behaviour) earlier commands will be allowed to fail, and later commands will also execute. If this behaviour is not desired, consider using `"set -o errexit"` as the first command. +-> **Note:** Since `inline` is implemented by concatenating commands into a script, [`on_failure`](/language/resources/provisioners/syntax#failure-behavior) applies only to the final command in the list. In particular, with `on_failure = fail` (the default behaviour) earlier commands will be allowed to fail, and later commands will also execute. If this behaviour is not desired, consider using `"set -o errexit"` as the first command. ## Script Arguments You cannot pass any arguments to scripts using the `script` or `scripts` arguments to this provisioner. If you want to specify arguments, upload the script with the -[file provisioner](/docs/language/resources/provisioners/file.html) +[file provisioner](/language/resources/provisioners/file) and then use `inline` to call it. Example: ```hcl diff --git a/website/docs/language/resources/provisioners/salt-masterless.html.md b/website/docs/language/resources/provisioners/salt-masterless.html.md deleted file mode 100644 index 6cdb4f326006..000000000000 --- a/website/docs/language/resources/provisioners/salt-masterless.html.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: "language" -page_title: "Provisioner: salt-masterless" -sidebar_current: "docs-provisioners-salt-masterless" -description: |- - The salt-masterless Terraform provisioner provisions machines built by Terraform ---- - -# Salt Masterless Provisioner - -Type: `salt-masterless` - -The `salt-masterless` Terraform provisioner provisions machines built by Terraform -using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/docs/language/resources/provisioners/connection.html). - -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). - -## Requirements - -The `salt-masterless` provisioner has some prerequisites. `cURL` must be available on the remote host. - -## Example usage - -The example below is fully functional. - -```hcl - -provisioner "salt-masterless" { - "local_state_tree" = "/srv/salt" -} -``` - -## Argument Reference - -The reference of available configuration options is listed below. The only -required argument is the path to your local salt state tree. - -Optional: - -- `bootstrap_args` (string) - Arguments to send to the bootstrap script. Usage - is somewhat documented on - [github](https://github.com/saltstack/salt-bootstrap), but the [script - itself](https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh) - has more detailed usage instructions. By default, no arguments are sent to - the script. - -- `disable_sudo` (boolean) - By default, the bootstrap install command is prefixed with `sudo`. When using a - Docker builder, you will likely want to pass `true` since `sudo` is often not pre-installed. - -- `remote_pillar_roots` (string) - The path to your remote [pillar - roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). - default: `/srv/pillar`. This option cannot be used with `minion_config`. - -- `remote_state_tree` (string) - The path to your remote [state - tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). - default: `/srv/salt`. This option cannot be used with `minion_config`. - -- `local_pillar_roots` (string) - The path to your local [pillar - roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). - This will be uploaded to the `remote_pillar_roots` on the remote. - -- `local_state_tree` (string) - The path to your local [state - tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). - This will be uploaded to the `remote_state_tree` on the remote. - -- `custom_state` (string) - A state to be run instead of `state.highstate`. - Defaults to `state.highstate` if unspecified. - -- `minion_config_file` (string) - The path to your local [minion config - file](http://docs.saltstack.com/ref/configuration/minion.html). This will be - uploaded to the `/etc/salt` on the remote. This option overrides the - `remote_state_tree` or `remote_pillar_roots` options. - -- `skip_bootstrap` (boolean) - By default the salt provisioner runs [salt - bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set - this to true to skip this step. - -- `temp_config_dir` (string) - Where your local state tree will be copied - before moving to the `/srv/salt` directory. Default is `/tmp/salt`. - -- `no_exit_on_failure` (boolean) - Terraform will exit if the `salt-call` command - fails. Set this option to true to ignore Salt failures. - -- `log_level` (string) - Set the logging level for the `salt-call` run. - -- `salt_call_args` (string) - Additional arguments to pass directly to `salt-call`. See - [salt-call](https://docs.saltstack.com/ref/cli/salt-call.html) documentation for more - information. By default no additional arguments (besides the ones Terraform generates) - are passed to `salt-call`. - -- `salt_bin_dir` (string) - Path to the `salt-call` executable. Useful if it is not - on the PATH. diff --git a/website/docs/language/resources/provisioners/salt-masterless.mdx b/website/docs/language/resources/provisioners/salt-masterless.mdx new file mode 100644 index 000000000000..d24532177f99 --- /dev/null +++ b/website/docs/language/resources/provisioners/salt-masterless.mdx @@ -0,0 +1,91 @@ +--- +page_title: 'Provisioner: salt-masterless' +description: >- + The salt-masterless Terraform provisioner provisions machines built by + Terraform +--- + +# Salt Masterless Provisioner + +Type: `salt-masterless` + +The `salt-masterless` Terraform provisioner provisions machines built by Terraform +using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/language/resources/provisioners/connection). + +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). + +## Requirements + +The `salt-masterless` provisioner has some prerequisites. `cURL` must be available on the remote host. + +## Example usage + +The example below is fully functional. + +```hcl + +provisioner "salt-masterless" { + "local_state_tree" = "/srv/salt" +} +``` + +## Argument Reference + +The reference of available configuration options is listed below. The only +required argument is the path to your local salt state tree. + +Optional: + +- `bootstrap_args` (string) - Arguments to send to the bootstrap script. Usage + is somewhat documented on + [github](https://github.com/saltstack/salt-bootstrap), but the [script + itself](https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh) + has more detailed usage instructions. By default, no arguments are sent to + the script. + +- `disable_sudo` (boolean) - By default, the bootstrap install command is prefixed with `sudo`. When using a + Docker builder, you will likely want to pass `true` since `sudo` is often not pre-installed. + +- `remote_pillar_roots` (string) - The path to your remote [pillar + roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). + default: `/srv/pillar`. This option cannot be used with `minion_config`. + +- `remote_state_tree` (string) - The path to your remote [state + tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). + default: `/srv/salt`. This option cannot be used with `minion_config`. + +- `local_pillar_roots` (string) - The path to your local [pillar + roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). + This will be uploaded to the `remote_pillar_roots` on the remote. + +- `local_state_tree` (string) - The path to your local [state + tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). + This will be uploaded to the `remote_state_tree` on the remote. + +- `custom_state` (string) - A state to be run instead of `state.highstate`. + Defaults to `state.highstate` if unspecified. + +- `minion_config_file` (string) - The path to your local [minion config + file](http://docs.saltstack.com/ref/configuration/minion.html). This will be + uploaded to the `/etc/salt` on the remote. This option overrides the + `remote_state_tree` or `remote_pillar_roots` options. + +- `skip_bootstrap` (boolean) - By default the salt provisioner runs [salt + bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set + this to true to skip this step. + +- `temp_config_dir` (string) - Where your local state tree will be copied + before moving to the `/srv/salt` directory. Default is `/tmp/salt`. + +- `no_exit_on_failure` (boolean) - Terraform will exit if the `salt-call` command + fails. Set this option to true to ignore Salt failures. + +- `log_level` (string) - Set the logging level for the `salt-call` run. + +- `salt_call_args` (string) - Additional arguments to pass directly to `salt-call`. See + [salt-call](https://docs.saltstack.com/ref/cli/salt-call.html) documentation for more + information. By default no additional arguments (besides the ones Terraform generates) + are passed to `salt-call`. + +- `salt_bin_dir` (string) - Path to the `salt-call` executable. Useful if it is not + on the PATH. diff --git a/website/docs/language/resources/provisioners/syntax.html.md b/website/docs/language/resources/provisioners/syntax.mdx similarity index 93% rename from website/docs/language/resources/provisioners/syntax.html.md rename to website/docs/language/resources/provisioners/syntax.mdx index 0ba9d9d007f3..421e5d2eec2b 100644 --- a/website/docs/language/resources/provisioners/syntax.html.md +++ b/website/docs/language/resources/provisioners/syntax.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provisioners" -sidebar_current: "docs-provisioners" -description: "Provisioners run scripts on a local or remote machine during resource creation or destruction. Learn how to declare provisioners in a configuration." +page_title: Provisioners +description: >- + Provisioners run scripts on a local or remote machine during resource creation + or destruction. Learn how to declare provisioners in a configuration. --- # Provisioners @@ -161,7 +161,7 @@ resource "aws_instance" "web" { The `local-exec` provisioner requires no other configuration, but most other provisioners must connect to the remote system using SSH or WinRM. -You must include [a `connection` block](./connection.html) so that Terraform +You must include [a `connection` block](/language/resources/provisioners/connection) so that Terraform will know how to communicate with the server. Terraform includes several built-in provisioners; use the navigation sidebar to @@ -193,8 +193,8 @@ block would create a dependency cycle. ## Suppressing Provisioner Logs in CLI Output The configuration for a `provisioner` block may use sensitive values, such as -[`sensitive` variables](/docs/language/values/variables.html#suppressing-values-in-cli-output) or -[`sensitive` output values](/docs/language/values/outputs.html#sensitive-suppressing-values-in-cli-output). +[`sensitive` variables](/language/values/variables#suppressing-values-in-cli-output) or +[`sensitive` output values](/language/values/outputs#sensitive-suppressing-values-in-cli-output). In this case, all log output from the provisioner is automatically suppressed to prevent the sensitive values from being displayed. @@ -236,8 +236,10 @@ fail, Terraform will error and rerun the provisioners again on the next `terraform apply`. Due to this behavior, care should be taken for destroy provisioners to be safe to run multiple times. - Destroy provisioners of this resource will not run if `create_before_destroy` - is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. +``` +Destroy provisioners of this resource will not run if `create_before_destroy` +is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. +``` Destroy-time provisioners can only run if they remain in the configuration at the time a resource is destroyed. If a resource block with a destroy-time @@ -288,10 +290,10 @@ By default, provisioners that fail will also cause the Terraform apply itself to fail. The `on_failure` setting can be used to change this. The allowed values are: -- `continue` - Ignore the error and continue with creation or destruction. +* `continue` - Ignore the error and continue with creation or destruction. -- `fail` - Raise an error and stop applying (the default behavior). If this is a creation provisioner, - taint the resource. +* `fail` - Raise an error and stop applying (the default behavior). If this is a creation provisioner, + taint the resource. Example: diff --git a/website/docs/language/resources/syntax.html.md b/website/docs/language/resources/syntax.mdx similarity index 83% rename from website/docs/language/resources/syntax.html.md rename to website/docs/language/resources/syntax.mdx index 456e937794aa..9aefe8bacd24 100644 --- a/website/docs/language/resources/syntax.html.md +++ b/website/docs/language/resources/syntax.mdx @@ -1,8 +1,10 @@ --- -layout: "language" -page_title: "Resources - Configuration Language" -sidebar_current: "docs-config-resources" -description: "Resources correspond to infrastructure objects like virtual networks or compute instances. Learn about resource types, syntax, behavior, and arguments." +page_title: Resources - Configuration Language +description: >- + Resources correspond to infrastructure objects like virtual networks or + compute instances. Learn about resource types, syntax, behavior, and + arguments. +sidebar_title: Resources --- # Resource Blocks @@ -52,7 +54,7 @@ attributes the resource supports. ### Providers -Each resource type is implemented by a [provider](/docs/language/providers/requirements.html), +Each resource type is implemented by a [provider](/language/providers/requirements), which is a plugin for Terraform that offers a collection of resource types. A provider usually provides resources to manage a single cloud or on-premises infrastructure platform. Providers are distributed separately from Terraform @@ -65,16 +67,16 @@ access their remote APIs, and the root module must provide that configuration. For more information, see: -- [Provider Requirements](/docs/language/providers/requirements.html), for declaring which +- [Provider Requirements](/language/providers/requirements), for declaring which providers a module uses. -- [Provider Configuration](/docs/language/providers/configuration.html), for configuring provider settings. +- [Provider Configuration](/language/providers/configuration), for configuring provider settings. Terraform usually automatically determines which provider to use based on a resource type's name. (By convention, resource type names start with their provider's preferred local name.) When using multiple configurations of a provider (or non-preferred local provider names), you must use the `provider` meta-argument to manually choose an alternate provider configuration. See -[the `provider` meta-argument](/docs/language/meta-arguments/resource-provider.html) for more details. +[the `provider` meta-argument](/language/meta-arguments/resource-provider) for more details. ### Resource Arguments @@ -83,7 +85,7 @@ selected resource type. The resource type's documentation lists which arguments are available and how their values should be formatted. The values for resource arguments can make full use of -[expressions](/docs/language/expressions/index.html) and other dynamic Terraform +[expressions](/language/expressions/) and other dynamic Terraform language features. There are also some _meta-arguments_ that are defined by Terraform itself @@ -114,7 +116,7 @@ public provider docs. For more information about how Terraform manages resources when applying a configuration, see -[Resource Behavior](/docs/language/resources/behavior.html). +[Resource Behavior](/language/resources/behavior). ## Meta-Arguments @@ -123,12 +125,12 @@ any resource type to change the behavior of resources. The following meta-arguments are documented on separate pages: -- [`depends_on`, for specifying hidden dependencies](/docs/language/meta-arguments/depends_on.html) -- [`count`, for creating multiple resource instances according to a count](/docs/language/meta-arguments/count.html) -- [`for_each`, to create multiple instances according to a map, or set of strings](/docs/language/meta-arguments/for_each.html) -- [`provider`, for selecting a non-default provider configuration](/docs/language/meta-arguments/resource-provider.html) -- [`lifecycle`, for lifecycle customizations](/docs/language/meta-arguments/lifecycle.html) -- [`provisioner` and `connection`, for taking extra actions after resource creation](/docs/language/resources/provisioners/index.html) +- [`depends_on`, for specifying hidden dependencies](/language/meta-arguments/depends_on) +- [`count`, for creating multiple resource instances according to a count](/language/meta-arguments/count) +- [`for_each`, to create multiple instances according to a map, or set of strings](/language/meta-arguments/for_each) +- [`provider`, for selecting a non-default provider configuration](/language/meta-arguments/resource-provider) +- [`lifecycle`, for lifecycle customizations](/language/meta-arguments/lifecycle) +- [`provisioner` and `connection`, for taking extra actions after resource creation](/language/resources/provisioners/) ## Operation Timeouts diff --git a/website/docs/language/settings/backends/artifactory.html.md b/website/docs/language/settings/backends/artifactory.mdx similarity index 67% rename from website/docs/language/settings/backends/artifactory.html.md rename to website/docs/language/settings/backends/artifactory.mdx index 2e19dea8900d..b800dd040bc2 100644 --- a/website/docs/language/settings/backends/artifactory.html.md +++ b/website/docs/language/settings/backends/artifactory.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: artifactory" -sidebar_current: "docs-backends-types-standard-artifactory" -description: |- - Terraform can store state in artifactory. +page_title: 'Backend Type: artifactory' +description: Terraform can store state in artifactory. --- # artifactory @@ -52,8 +49,8 @@ data "terraform_remote_state" "foo" { The following configuration options / environment variables are supported: - * `username` / `ARTIFACTORY_USERNAME` (Required) - The username - * `password` / `ARTIFACTORY_PASSWORD` (Required) - The password - * `url` / `ARTIFACTORY_URL` (Required) - The URL. Note that this is the base url to artifactory not the full repo and subpath. - * `repo` (Required) - The repository name - * `subpath` (Required) - Path within the repository +- `username` / `ARTIFACTORY_USERNAME` (Required) - The username +- `password` / `ARTIFACTORY_PASSWORD` (Required) - The password +- `url` / `ARTIFACTORY_URL` (Required) - The URL. Note that this is the base url to artifactory not the full repo and subpath. +- `repo` (Required) - The repository name +- `subpath` (Required) - Path within the repository diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.mdx similarity index 96% rename from website/docs/language/settings/backends/azurerm.html.md rename to website/docs/language/settings/backends/azurerm.mdx index 9179a555101a..01d5a15fd975 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.mdx @@ -1,10 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: azurerm" -sidebar_current: "docs-backends-types-standard-azurerm" -description: |- - Terraform can store state remotely in Azure Blob Storage. - +page_title: 'Backend Type: azurerm' +description: Terraform can store state remotely in Azure Blob Storage. --- # azurerm @@ -13,7 +9,7 @@ description: |- Stores the state as a Blob with the given Key within the Blob Container within [the Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction). This backend also supports state locking and consistency checking via native capabilities of Azure Blob Storage. --> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. ## Example Configuration @@ -30,7 +26,7 @@ terraform { } ``` ---- +*** When authenticating using Managed Service Identity (MSI): @@ -48,7 +44,7 @@ terraform { } ``` ---- +*** When authenticating using Azure AD Authentication: @@ -67,7 +63,7 @@ terraform { -> **Note:** When using AzureAD for Authentication to Storage you also need to ensure the `Storage Blob Data Owner` role is assigned. ---- +*** When authenticating using the Access Key associated with the Storage Account: @@ -85,7 +81,7 @@ terraform { } ``` ---- +*** When authenticating using a SAS Token associated with the Storage Account: @@ -103,7 +99,7 @@ terraform { } ``` --> **NOTE:** When using a Service Principal or an Access Key - we recommend using a [Partial Configuration](/docs/language/settings/backends/configuration.html#partial-configuration) for the credentials. +-> **NOTE:** When using a Service Principal or an Access Key - we recommend using a [Partial Configuration](/language/settings/backends/configuration#partial-configuration) for the credentials. ## Data Source Configuration @@ -120,7 +116,7 @@ data "terraform_remote_state" "foo" { } ``` ---- +*** When authenticating using Managed Service Identity (MSI): @@ -139,7 +135,7 @@ data "terraform_remote_state" "foo" { } ``` ---- +*** When authenticating using AzureAD Authentication: @@ -159,7 +155,7 @@ data "terraform_remote_state" "foo" { -> **Note:** When using AzureAD for Authentication to Storage you also need to ensure the `Storage Blob Data Owner` role is assigned. ---- +*** When authenticating using the Access Key associated with the Storage Account: @@ -178,7 +174,7 @@ data "terraform_remote_state" "foo" { } ``` ---- +*** When authenticating using a SAS Token associated with the Storage Account: @@ -215,14 +211,16 @@ The following configuration options are supported: * `snapshot` - (Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use? Defaults to `false`. This value can also be sourced from the `ARM_SNAPSHOT` environment variable. ---- +*** When authenticating using the Managed Service Identity (MSI) - the following fields are also supported: * `resource_group_name` - (Required) The Name of the Resource Group in which the Storage Account exists. * `msi_endpoint` - (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. This can also be sourced from the `ARM_MSI_ENDPOINT` environment variable. -* + +* + * `subscription_id` - (Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the `ARM_SUBSCRIPTION_ID` environment variable. * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. @@ -233,19 +231,19 @@ When authenticating using the Managed Service Identity (MSI) - the following fie * `use_msi` - (Optional) Should Managed Service Identity authentication be used? This can also be sourced from the `ARM_USE_MSI` environment variable. ---- +*** When authenticating using a SAS Token associated with the Storage Account - the following fields are also supported: * `sas_token` - (Optional) The SAS Token used to access the Blob Storage Account. This can also be sourced from the `ARM_SAS_TOKEN` environment variable. ---- +*** When authenticating using the Storage Account's Access Key - the following fields are also supported: * `access_key` - (Optional) The Access Key used to access the Blob Storage Account. This can also be sourced from the `ARM_ACCESS_KEY` environment variable. ---- +*** When authenticating using AzureAD Authentication - the following fields are also supported: @@ -257,7 +255,7 @@ When authenticating using AzureAD Authentication - the following fields are also -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. ---- +*** When authenticating using a Service Principal with a Client Certificate - the following fields are also supported: @@ -277,7 +275,7 @@ When authenticating using a Service Principal with a Client Certificate - the fo -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. ---- +*** When authenticating using a Service Principal with a Client Secret - the following fields are also supported: diff --git a/website/docs/language/settings/backends/configuration.html.md b/website/docs/language/settings/backends/configuration.mdx similarity index 82% rename from website/docs/language/settings/backends/configuration.html.md rename to website/docs/language/settings/backends/configuration.mdx index 886413e7ef78..daff89d756c1 100644 --- a/website/docs/language/settings/backends/configuration.html.md +++ b/website/docs/language/settings/backends/configuration.mdx @@ -1,13 +1,12 @@ --- -layout: "language" -page_title: "Backend Configuration - Configuration Language" +page_title: Backend Configuration - Configuration Language +sidebar_title: Backend Configuration --- # Backend Configuration - Each Terraform configuration can specify a backend, which defines exactly where -and how operations are performed, where [state](/docs/language/state/index.html) +and how operations are performed, where [state](/language/state/) snapshots are stored, etc. Most non-trivial Terraform configurations configure a remote backend so that multiple people can work with the same infrastructure. @@ -70,25 +69,25 @@ automatically by an automation script running Terraform. When some or all of the arguments are omitted, we call this a _partial configuration_. With a partial configuration, the remaining configuration arguments must be -provided as part of [the initialization process](/docs/cli/init/index.html). +provided as part of [the initialization process](/cli/init/). There are several ways to supply the remaining arguments: - * **File**: A configuration file may be specified via the `init` command line. - To specify a file, use the `-backend-config=PATH` option when running - `terraform init`. If the file contains secrets it may be kept in - a secure data store, such as [Vault](https://www.vaultproject.io/), - in which case it must be downloaded to the local disk before running Terraform. +- **File**: A configuration file may be specified via the `init` command line. + To specify a file, use the `-backend-config=PATH` option when running + `terraform init`. If the file contains secrets it may be kept in + a secure data store, such as [Vault](https://www.vaultproject.io/), + in which case it must be downloaded to the local disk before running Terraform. - * **Command-line key/value pairs**: Key/value pairs can be specified via the - `init` command line. Note that many shells retain command-line flags in a - history file, so this isn't recommended for secrets. To specify a single - key/value pair, use the `-backend-config="KEY=VALUE"` option when running - `terraform init`. +- **Command-line key/value pairs**: Key/value pairs can be specified via the + `init` command line. Note that many shells retain command-line flags in a + history file, so this isn't recommended for secrets. To specify a single + key/value pair, use the `-backend-config="KEY=VALUE"` option when running + `terraform init`. - * **Interactively**: Terraform will interactively ask you for the required - values, unless interactive input is disabled. Terraform will not prompt for - optional values. +- **Interactively**: Terraform will interactively ask you for the required + values, unless interactive input is disabled. Terraform will not prompt for + optional values. If backend settings are provided in multiple locations, the top-level settings are merged such that any command-line options override the settings @@ -153,12 +152,12 @@ both the configuration itself as well as the type of backend (for example from "consul" to "s3"). Terraform will automatically detect any changes in your configuration -and request a [reinitialization](/docs/cli/init/index.html). As part of +and request a [reinitialization](/cli/init/). As part of the reinitialization process, Terraform will ask if you'd like to migrate your existing state to the new configuration. This allows you to easily switch from one backend to another. -If you're using multiple [workspaces](/docs/language/state/workspaces.html), +If you're using multiple [workspaces](/language/state/workspaces), Terraform can copy all workspaces to the destination. If Terraform detects you have multiple workspaces, it will ask if this is what you want to do. @@ -169,7 +168,7 @@ want to migrate your state. You can respond "no" in this scenario. If you no longer want to use any backend, you can simply remove the configuration from the file. Terraform will detect this like any other -change and prompt you to [reinitialize](/docs/cli/init/index.html). +change and prompt you to [reinitialize](/cli/init/). As part of the reinitialization, Terraform will ask if you'd like to migrate your state back down to normal local state. Once this is complete then diff --git a/website/docs/language/settings/backends/consul.html.md b/website/docs/language/settings/backends/consul.html.md deleted file mode 100644 index d2f921454018..000000000000 --- a/website/docs/language/settings/backends/consul.html.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: consul" -sidebar_current: "docs-backends-types-standard-consul" -description: |- - Terraform can store state in Consul. ---- - -# consul - -**Kind: Standard (with locking)** - -Stores the state in the [Consul](https://www.consul.io/) KV store at a given path. - -This backend supports [state locking](/docs/language/state/locking.html). - -## Example Configuration - -```hcl -terraform { - backend "consul" { - address = "consul.example.com" - scheme = "https" - path = "full/path" - } -} -``` - -Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "consul" - config = { - path = "full/path" - } -} -``` - -## Configuration variables - -The following configuration options / environment variables are supported: - - * `path` - (Required) Path in the Consul KV store - * `access_token` / `CONSUL_HTTP_TOKEN` - (Required) Access token - * `address` / `CONSUL_HTTP_ADDR` - (Optional) DNS name and port of your Consul endpoint specified in the - format `dnsname:port`. Defaults to the local agent HTTP listener. - * `scheme` - (Optional) Specifies what protocol to use when talking to the given - `address`, either `http` or `https`. SSL support can also be triggered - by setting then environment variable `CONSUL_HTTP_SSL` to `true`. - * `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent. - * `http_auth` / `CONSUL_HTTP_AUTH` - (Optional) HTTP Basic Authentication credentials to be used when - communicating with Consul, in the format of either `user` or `user:pass`. - * `gzip` - (Optional) `true` to compress the state data using gzip, or `false` (the default) to leave it uncompressed. - * `lock` - (Optional) `false` to disable locking. This defaults to true, but will require session permissions with Consul and at least kv write permissions on `$path/.lock` to perform locking. - * `ca_file` / `CONSUL_CACERT` - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. - * `cert_file` / `CONSUL_CLIENT_CERT` - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file`. - * `key_file` / `CONSUL_CLIENT_KEY` - (Optional) A path to a PEM-encoded private key, required if `cert_file` is specified. diff --git a/website/docs/language/settings/backends/consul.mdx b/website/docs/language/settings/backends/consul.mdx new file mode 100644 index 000000000000..3f2a0d0046d8 --- /dev/null +++ b/website/docs/language/settings/backends/consul.mdx @@ -0,0 +1,58 @@ +--- +page_title: 'Backend Type: consul' +description: Terraform can store state in Consul. +--- + +# consul + +**Kind: Standard (with locking)** + +Stores the state in the [Consul](https://www.consul.io/) KV store at a given path. + +This backend supports [state locking](/language/state/locking). + +## Example Configuration + +```hcl +terraform { + backend "consul" { + address = "consul.example.com" + scheme = "https" + path = "full/path" + } +} +``` + +Note that for the access credentials we recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration). + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "consul" + config = { + path = "full/path" + } +} +``` + +## Configuration variables + +The following configuration options / environment variables are supported: + +- `path` - (Required) Path in the Consul KV store +- `access_token` / `CONSUL_HTTP_TOKEN` - (Required) Access token +- `address` / `CONSUL_HTTP_ADDR` - (Optional) DNS name and port of your Consul endpoint specified in the + format `dnsname:port`. Defaults to the local agent HTTP listener. +- `scheme` - (Optional) Specifies what protocol to use when talking to the given + `address`, either `http` or `https`. SSL support can also be triggered + by setting then environment variable `CONSUL_HTTP_SSL` to `true`. +- `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent. +- `http_auth` / `CONSUL_HTTP_AUTH` - (Optional) HTTP Basic Authentication credentials to be used when + communicating with Consul, in the format of either `user` or `user:pass`. +- `gzip` - (Optional) `true` to compress the state data using gzip, or `false` (the default) to leave it uncompressed. +- `lock` - (Optional) `false` to disable locking. This defaults to true, but will require session permissions with Consul and at least kv write permissions on `$path/.lock` to perform locking. +- `ca_file` / `CONSUL_CACERT` - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. +- `cert_file` / `CONSUL_CLIENT_CERT` - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file`. +- `key_file` / `CONSUL_CLIENT_KEY` - (Optional) A path to a PEM-encoded private key, required if `cert_file` is specified. diff --git a/website/docs/language/settings/backends/cos.html.md b/website/docs/language/settings/backends/cos.mdx similarity index 52% rename from website/docs/language/settings/backends/cos.html.md rename to website/docs/language/settings/backends/cos.mdx index cef18670c275..43131c111cb6 100644 --- a/website/docs/language/settings/backends/cos.html.md +++ b/website/docs/language/settings/backends/cos.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "Backend Type: cos" -sidebar_current: "docs-backends-types-standard-cos" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: cos' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # COS @@ -11,7 +10,7 @@ description: |- **Kind: Standard (with locking)** Stores the state as an object in a configurable prefix in a given bucket on [Tencent Cloud Object Storage](https://intl.cloud.tencent.com/product/cos) (COS). -This backend also supports [state locking](/docs/language/state/locking.html). +This backend also supports [state locking](/language/state/locking). ~> **Warning!** It is highly recommended that you enable [Object Versioning](https://intl.cloud.tencent.com/document/product/436/19883) on the COS bucket to allow for state recovery in the case of accidental deletions and human error. @@ -33,7 +32,7 @@ Terraform state will be written into the file `terraform/state/terraform.tfstate ## Data Source Configuration -To make use of the COS remote state in another configuration, use the [`terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +To make use of the COS remote state in another configuration, use the [`terraform_remote_state` data source](/language/state/remote-state-data). ```hcl data "terraform_remote_state" "foo" { @@ -51,11 +50,11 @@ data "terraform_remote_state" "foo" { The following configuration options or environment variables are supported: - * `secret_id` - (Optional) Secret id of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_ID`. - * `secret_key` - (Optional) Secret key of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_KEY`. - * `region` - (Optional) The region of the COS bucket. It supports environment variables `TENCENTCLOUD_REGION`. - * `bucket` - (Required) The name of the COS bucket. You shall manually create it first. - * `prefix` - (Optional) The directory for saving the state file in bucket. Default to "env:". - * `key` - (Optional) The path for saving the state file in bucket. Defaults to `terraform.tfstate`. - * `encrypt` - (Optional) Whether to enable server side encryption of the state file. If it is true, COS will use 'AES256' encryption algorithm to encrypt state file. - * `acl` - (Optional) Object ACL to be applied to the state file, allows `private` and `public-read`. Defaults to `private`. +- `secret_id` - (Optional) Secret id of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_ID`. +- `secret_key` - (Optional) Secret key of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_KEY`. +- `region` - (Optional) The region of the COS bucket. It supports environment variables `TENCENTCLOUD_REGION`. +- `bucket` - (Required) The name of the COS bucket. You shall manually create it first. +- `prefix` - (Optional) The directory for saving the state file in bucket. Default to "env:". +- `key` - (Optional) The path for saving the state file in bucket. Defaults to `terraform.tfstate`. +- `encrypt` - (Optional) Whether to enable server side encryption of the state file. If it is true, COS will use 'AES256' encryption algorithm to encrypt state file. +- `acl` - (Optional) Object ACL to be applied to the state file, allows `private` and `public-read`. Defaults to `private`. diff --git a/website/docs/language/settings/backends/etcd.html.md b/website/docs/language/settings/backends/etcd.mdx similarity index 61% rename from website/docs/language/settings/backends/etcd.html.md rename to website/docs/language/settings/backends/etcd.mdx index 792b7354c577..024a4e00ef9f 100644 --- a/website/docs/language/settings/backends/etcd.html.md +++ b/website/docs/language/settings/backends/etcd.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: etcd" -sidebar_current: "docs-backends-types-standard-etcdv2" -description: |- - Terraform can store state remotely in etcd 2.x. +page_title: 'Backend Type: etcd' +description: Terraform can store state remotely in etcd 2.x. --- # etcd @@ -39,7 +36,7 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: - * `path` - (Required) The path where to store the state - * `endpoints` - (Required) A space-separated list of the etcd endpoints - * `username` - (Optional) The username - * `password` - (Optional) The password +- `path` - (Required) The path where to store the state +- `endpoints` - (Required) A space-separated list of the etcd endpoints +- `username` - (Optional) The username +- `password` - (Optional) The password diff --git a/website/docs/language/settings/backends/etcdv3.html.md b/website/docs/language/settings/backends/etcdv3.html.md deleted file mode 100644 index 318a7b405df3..000000000000 --- a/website/docs/language/settings/backends/etcdv3.html.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: etcdv3" -sidebar_current: "docs-backends-types-standard-etcdv3" -description: |- - Terraform can store state remotely in etcd 3.x. ---- - -# etcdv3 - -**Kind: Standard (with locking)** - -Stores the state in the [etcd](https://etcd.io/) KV store with a given prefix. - -This backend supports [state locking](/docs/language/state/locking.html). - -## Example Configuration - -```hcl -terraform { - backend "etcdv3" { - endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] - lock = true - prefix = "terraform-state/" - } -} -``` - -Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "etcdv3" - config = { - endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] - lock = true - prefix = "terraform-state/" - } -} -``` - -## Configuration variables - -The following configuration options / environment variables are supported: - - * `endpoints` - (Required) The list of 'etcd' endpoints which to connect to. - * `username` / `ETCDV3_USERNAME` - (Optional) Username used to connect to the etcd cluster. - * `password` / `ETCDV3_PASSWORD` - (Optional) Password used to connect to the etcd cluster. - * `prefix` - (Optional) An optional prefix to be added to keys when to storing state in etcd. Defaults to `""`. - * `lock` - (Optional) Whether to lock state access. Defaults to `true`. - * `cacert_path` - (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers. - * `cert_path` - (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification. - * `key_path` - (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification. - * `max_request_bytes` - (Optional) The max request size to send to etcd. This can be increased to enable storage of larger state. You must set the corresponding server-side flag [--max-request-bytes](https://etcd.io/docs/current/dev-guide/limit/#request-size-limit) as well and the value should be less than the client setting. Defaults to `2097152` (2.0 MiB). **Please Note:** Increasing etcd's request size limit may negatively impact overall latency. diff --git a/website/docs/language/settings/backends/etcdv3.mdx b/website/docs/language/settings/backends/etcdv3.mdx new file mode 100644 index 000000000000..9b3a8842f408 --- /dev/null +++ b/website/docs/language/settings/backends/etcdv3.mdx @@ -0,0 +1,54 @@ +--- +page_title: 'Backend Type: etcdv3' +description: Terraform can store state remotely in etcd 3.x. +--- + +# etcdv3 + +**Kind: Standard (with locking)** + +Stores the state in the [etcd](https://etcd.io/) KV store with a given prefix. + +This backend supports [state locking](/language/state/locking). + +## Example Configuration + +```hcl +terraform { + backend "etcdv3" { + endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] + lock = true + prefix = "terraform-state/" + } +} +``` + +Note that for the access credentials we recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration). + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "etcdv3" + config = { + endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] + lock = true + prefix = "terraform-state/" + } +} +``` + +## Configuration variables + +The following configuration options / environment variables are supported: + +- `endpoints` - (Required) The list of 'etcd' endpoints which to connect to. +- `username` / `ETCDV3_USERNAME` - (Optional) Username used to connect to the etcd cluster. +- `password` / `ETCDV3_PASSWORD` - (Optional) Password used to connect to the etcd cluster. +- `prefix` - (Optional) An optional prefix to be added to keys when to storing state in etcd. Defaults to `""`. +- `lock` - (Optional) Whether to lock state access. Defaults to `true`. +- `cacert_path` - (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers. +- `cert_path` - (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification. +- `key_path` - (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification. +- `max_request_bytes` - (Optional) The max request size to send to etcd. This can be increased to enable storage of larger state. You must set the corresponding server-side flag [--max-request-bytes](https://etcd.io/docs/current/dev-guide/limit/#request-size-limit) as well and the value should be less than the client setting. Defaults to `2097152` (2.0 MiB). **Please Note:** Increasing etcd's request size limit may negatively impact overall latency. diff --git a/website/docs/language/settings/backends/gcs.html.md b/website/docs/language/settings/backends/gcs.mdx similarity index 53% rename from website/docs/language/settings/backends/gcs.html.md rename to website/docs/language/settings/backends/gcs.mdx index 1d869579e281..c6a27e87b693 100644 --- a/website/docs/language/settings/backends/gcs.html.md +++ b/website/docs/language/settings/backends/gcs.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "Backend Type: gcs" -sidebar_current: "docs-backends-types-standard-gcs" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: gcs' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # gcs @@ -11,7 +10,7 @@ description: |- **Kind: Standard (with locking)** Stores the state as an object in a configurable prefix in a pre-existing bucket on [Google Cloud Storage](https://cloud.google.com/storage/) (GCS). -This backend also supports [state locking](/docs/language/state/locking.html). The bucket must exist prior to configuring the backend. +This backend also supports [state locking](/language/state/locking). The bucket must exist prior to configuring the backend. ~> **Warning!** It is highly recommended that you enable [Object Versioning](https://cloud.google.com/storage/docs/object-versioning) @@ -78,30 +77,30 @@ Terraform can impersonate a Google Service Account as described [here](https://c The following configuration options are supported: - * `bucket` - (Required) The name of the GCS bucket. This name must be - globally unique. For more information, see [Bucket Naming - Guidelines](https://cloud.google.com/storage/docs/bucketnaming.html#requirements). - * `credentials` / `GOOGLE_BACKEND_CREDENTIALS` / `GOOGLE_CREDENTIALS` - - (Optional) Local path to Google Cloud Platform account credentials in JSON - format. If unset, [Google Application Default - Credentials](https://developers.google.com/identity/protocols/application-default-credentials) - are used. The provided credentials must have Storage Object Admin role on the bucket. - **Warning**: if using the Google Cloud Platform provider as well, it will - also pick up the `GOOGLE_CREDENTIALS` environment variable. - * `impersonate_service_account` - (Optional) The service account to impersonate for accessing the State Bucket. - You must have `roles/iam.serviceAccountTokenCreator` role on that account for the impersonation to succeed. - If you are using a delegation chain, you can specify that using the `impersonate_service_account_delegates` field. - Alternatively, this can be specified using the `GOOGLE_IMPERSONATE_SERVICE_ACCOUNT` environment - variable. - * `impersonate_service_account_delegates` - (Optional) The delegation chain for an impersonating a service account as described [here](https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials#sa-credentials-delegated). - * `access_token` - (Optional) A temporary [OAuth 2.0 access token] obtained - from the Google Authorization server, i.e. the `Authorization: Bearer` token - used to authenticate HTTP requests to GCP APIs. This is an alternative to - `credentials`. If both are specified, `access_token` will be used over the - `credentials` field. - * `prefix` - (Optional) GCS prefix inside the bucket. Named states for - workspaces are stored in an object called `/.tfstate`. - * `encryption_key` / `GOOGLE_ENCRYPTION_KEY` - (Optional) A 32 byte base64 - encoded 'customer supplied encryption key' used to encrypt all state. For - more information see [Customer Supplied Encryption - Keys](https://cloud.google.com/storage/docs/encryption#customer-supplied). +- `bucket` - (Required) The name of the GCS bucket. This name must be + globally unique. For more information, see [Bucket Naming + Guidelines](https://cloud.google.com/storage/docs/bucketnaming.html#requirements). +- `credentials` / `GOOGLE_BACKEND_CREDENTIALS` / `GOOGLE_CREDENTIALS` - + (Optional) Local path to Google Cloud Platform account credentials in JSON + format. If unset, [Google Application Default + Credentials](https://developers.google.com/identity/protocols/application-default-credentials) + are used. The provided credentials must have Storage Object Admin role on the bucket. + **Warning**: if using the Google Cloud Platform provider as well, it will + also pick up the `GOOGLE_CREDENTIALS` environment variable. +- `impersonate_service_account` - (Optional) The service account to impersonate for accessing the State Bucket. + You must have `roles/iam.serviceAccountTokenCreator` role on that account for the impersonation to succeed. + If you are using a delegation chain, you can specify that using the `impersonate_service_account_delegates` field. + Alternatively, this can be specified using the `GOOGLE_IMPERSONATE_SERVICE_ACCOUNT` environment + variable. +- `impersonate_service_account_delegates` - (Optional) The delegation chain for an impersonating a service account as described [here](https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials#sa-credentials-delegated). +- `access_token` - (Optional) A temporary \[OAuth 2.0 access token] obtained + from the Google Authorization server, i.e. the `Authorization: Bearer` token + used to authenticate HTTP requests to GCP APIs. This is an alternative to + `credentials`. If both are specified, `access_token` will be used over the + `credentials` field. +- `prefix` - (Optional) GCS prefix inside the bucket. Named states for + workspaces are stored in an object called `/.tfstate`. +- `encryption_key` / `GOOGLE_ENCRYPTION_KEY` - (Optional) A 32 byte base64 + encoded 'customer supplied encryption key' used to encrypt all state. For + more information see [Customer Supplied Encryption + Keys](https://cloud.google.com/storage/docs/encryption#customer-supplied). diff --git a/website/docs/language/settings/backends/http.html.md b/website/docs/language/settings/backends/http.html.md deleted file mode 100644 index e87903c4458e..000000000000 --- a/website/docs/language/settings/backends/http.html.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: http" -sidebar_current: "docs-backends-types-standard-http" -description: |- - Terraform can store state remotely at any valid HTTP endpoint. ---- - -# http - -**Kind: Standard (with optional locking)** - -Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client. - -State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable. - -When locking support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The endpoint should -return a 423: Locked or 409: Conflict with the holding lock info when it's already taken, 200: OK for success. Any other status -will be considered an error. The ID of the holding lock info will be added as a query parameter to state updates requests. - -## Example Usage - -```hcl -terraform { - backend "http" { - address = "http://myrest.api.com/foo" - lock_address = "http://myrest.api.com/foo" - unlock_address = "http://myrest.api.com/foo" - } -} -``` - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "http" - config = { - address = "http://my.rest.api.com" - } -} -``` - -## Configuration variables - -The following configuration options / environment variables are supported: - - * `address` / `TF_HTTP_ADDRESS` - (Required) The address of the REST endpoint - * `update_method` / `TF_HTTP_UPDATE_METHOD` - (Optional) HTTP method to use - when updating state. Defaults to `POST`. - * `lock_address` / `TF_HTTP_LOCK_ADDRESS` - (Optional) The address of the lock - REST endpoint. Defaults to disabled. - * `lock_method` / `TF_HTTP_LOCK_METHOD` - (Optional) The HTTP method to use - when locking. Defaults to `LOCK`. - * `unlock_address` / `TF_HTTP_UNLOCK_ADDRESS` - (Optional) The address of the - unlock REST endpoint. Defaults to disabled. - * `unlock_method` / `TF_HTTP_UNLOCK_METHOD` - (Optional) The HTTP method to use - when unlocking. Defaults to `UNLOCK`. - * `username` / `TF_HTTP_USERNAME` - (Optional) The username for HTTP basic - authentication - * `password` / `TF_HTTP_PASSWORD` - (Optional) The password for HTTP basic - authentication - * `skip_cert_verification` - (Optional) Whether to skip TLS verification. - Defaults to `false`. - * `retry_max` / `TF_HTTP_RETRY_MAX` – (Optional) The number of HTTP request - retries. Defaults to `2`. - * `retry_wait_min` / `TF_HTTP_RETRY_WAIT_MIN` – (Optional) The minimum time in - seconds to wait between HTTP request attempts. Defaults to `1`. - * `retry_wait_max` / `TF_HTTP_RETRY_WAIT_MAX` – (Optional) The maximum time in - seconds to wait between HTTP request attempts. Defaults to `30`. diff --git a/website/docs/language/settings/backends/http.mdx b/website/docs/language/settings/backends/http.mdx new file mode 100644 index 000000000000..0a49527861c9 --- /dev/null +++ b/website/docs/language/settings/backends/http.mdx @@ -0,0 +1,67 @@ +--- +page_title: 'Backend Type: http' +description: Terraform can store state remotely at any valid HTTP endpoint. +--- + +# http + +**Kind: Standard (with optional locking)** + +Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client. + +State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable. + +When locking support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The endpoint should +return a 423: Locked or 409: Conflict with the holding lock info when it's already taken, 200: OK for success. Any other status +will be considered an error. The ID of the holding lock info will be added as a query parameter to state updates requests. + +## Example Usage + +```hcl +terraform { + backend "http" { + address = "http://myrest.api.com/foo" + lock_address = "http://myrest.api.com/foo" + unlock_address = "http://myrest.api.com/foo" + } +} +``` + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "http" + config = { + address = "http://my.rest.api.com" + } +} +``` + +## Configuration variables + +The following configuration options / environment variables are supported: + +- `address` / `TF_HTTP_ADDRESS` - (Required) The address of the REST endpoint +- `update_method` / `TF_HTTP_UPDATE_METHOD` - (Optional) HTTP method to use + when updating state. Defaults to `POST`. +- `lock_address` / `TF_HTTP_LOCK_ADDRESS` - (Optional) The address of the lock + REST endpoint. Defaults to disabled. +- `lock_method` / `TF_HTTP_LOCK_METHOD` - (Optional) The HTTP method to use + when locking. Defaults to `LOCK`. +- `unlock_address` / `TF_HTTP_UNLOCK_ADDRESS` - (Optional) The address of the + unlock REST endpoint. Defaults to disabled. +- `unlock_method` / `TF_HTTP_UNLOCK_METHOD` - (Optional) The HTTP method to use + when unlocking. Defaults to `UNLOCK`. +- `username` / `TF_HTTP_USERNAME` - (Optional) The username for HTTP basic + authentication +- `password` / `TF_HTTP_PASSWORD` - (Optional) The password for HTTP basic + authentication +- `skip_cert_verification` - (Optional) Whether to skip TLS verification. + Defaults to `false`. +- `retry_max` / `TF_HTTP_RETRY_MAX` – (Optional) The number of HTTP request + retries. Defaults to `2`. +- `retry_wait_min` / `TF_HTTP_RETRY_WAIT_MIN` – (Optional) The minimum time in + seconds to wait between HTTP request attempts. Defaults to `1`. +- `retry_wait_max` / `TF_HTTP_RETRY_WAIT_MAX` – (Optional) The maximum time in + seconds to wait between HTTP request attempts. Defaults to `30`. diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.mdx similarity index 83% rename from website/docs/language/settings/backends/index.html.md rename to website/docs/language/settings/backends/index.mdx index 5a8a75359ae1..b2e416ed7fa4 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.mdx @@ -1,19 +1,21 @@ --- -layout: "language" -page_title: "Backend Overview - Configuration Language" -description: "A backend defines where and how Terraform performs operations, such as where it stores state files. Learn about recommended backends and how backends work." +page_title: Backend Overview - Configuration Language +description: >- + A backend defines where and how Terraform performs operations, such as where + it stores state files. Learn about recommended backends and how backends work. +sidebar_title: Backend Overview --- # Backends Each Terraform configuration can specify a backend, which defines where -and how operations are performed, where [state](/docs/language/state/index.html) +and how operations are performed, where [state](/language/state/) snapshots are stored, etc. The rest of this page introduces the concept of backends; the other pages in this section document how to configure and use backends. -- [Backend Configuration](/docs/language/settings/backends/configuration.html) documents the form +- [Backend Configuration](/language/settings/backends/configuration) documents the form of a `backend` block, which selects and configures a backend for a Terraform configuration. - This section also includes a page for each of Terraform's built-in backends, @@ -25,19 +27,19 @@ this section document how to configure and use backends. - If you are still learning how to use Terraform, we recommend using the default `local` backend, which requires no configuration. - If you and your team are using Terraform to manage meaningful infrastructure, - we recommend using the `remote` backend with [Terraform Cloud](/docs/cloud/index.html) - or [Terraform Enterprise](/docs/enterprise/index.html). + we recommend using the `remote` backend with [Terraform Cloud](/cloud-docs/) + or [Terraform Enterprise](/enterprise/). ## Where Backends are Used -Backend configuration is only used by [Terraform CLI](/docs/cli/index.html). +Backend configuration is only used by [Terraform CLI](/cli/). Terraform Cloud and Terraform Enterprise always use their own state storage when performing Terraform runs, so they ignore any backend block in the configuration. But since it's common to -[use Terraform CLI alongside Terraform Cloud](/docs/cloud/run/cli.html) -(and since certain state operations, like [tainting](/docs/cli/commands/taint.html), +[use Terraform CLI alongside Terraform Cloud](/cloud-docs/run/cli) +(and since certain state operations, like [tainting](/cli/commands/taint), can only be performed on the CLI), we recommend that Terraform Cloud users include a backend block in their configurations and configure the `remote` backend to use the relevant Terraform Cloud workspace(s). @@ -59,7 +61,7 @@ There are two areas of Terraform's behavior that are determined by the backend: ### State -Terraform uses persistent [state](/docs/language/state/index.html) data to keep track of +Terraform uses persistent [state](/language/state/) data to keep track of the resources it manages. Since it needs the state in order to know which real-world infrastructure objects correspond to the resources in a configuration, everyone working with a given collection of infrastructure diff --git a/website/docs/language/settings/backends/kubernetes.html.md b/website/docs/language/settings/backends/kubernetes.mdx similarity index 88% rename from website/docs/language/settings/backends/kubernetes.html.md rename to website/docs/language/settings/backends/kubernetes.mdx index 71d80e24fe56..cb475018b022 100644 --- a/website/docs/language/settings/backends/kubernetes.html.md +++ b/website/docs/language/settings/backends/kubernetes.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: Kubernetes" -sidebar_current: "docs-backends-types-standard-kubernetes" -description: |- - Terraform can store state remotely in Kubernetes and lock that state. +page_title: 'Backend Type: Kubernetes' +description: Terraform can store state remotely in Kubernetes and lock that state. --- # kubernetes @@ -27,14 +24,13 @@ terraform { This assumes the user/service account running terraform has [permissions](https://kubernetes.io/docs/reference/access-authn-authz/authorization/) to read/write secrets in the [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) used to store the secret. -If the `config_path` or `config_paths` attribute is set the backend will attempt to use a [kubeconfig file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) to gain access to the cluster. +If the `config_path` or `config_paths` attribute is set the backend will attempt to use a [kubeconfig file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) to gain access to the cluster. -If the `in_cluster_config` flag is set the backend will attempt to use a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) to access the cluster. This can be used if Terraform is being run from within a pod running in the Kubernetes cluster. +If the `in_cluster_config` flag is set the backend will attempt to use a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) to access the cluster. This can be used if Terraform is being run from within a pod running in the Kubernetes cluster. For most use cases either `in_cluster_config`, `config_path`, or `config_paths` will need to be set. If all flags are set the configuration at `config_path` will be used. -Note that for the access credentials we recommend using a [partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - +Note that for the access credentials we recommend using a [partial configuration](/language/settings/backends/configuration#partial-configuration). ## Example Referencing @@ -69,7 +65,7 @@ The following configuration options are supported: * `config_context_auth_info` - (Optional) Authentication info context of the kube config (name of the kubeconfig user, `--user` flag in `kubectl`). Can be sourced from `KUBE_CTX_AUTH_INFO`. * `config_context_cluster` - (Optional) Cluster context of the kube config (name of the kubeconfig cluster, `--cluster` flag in `kubectl`). Can be sourced from `KUBE_CTX_CLUSTER`. * `token` - (Optional) Token of your service account. Can be sourced from `KUBE_TOKEN`. -* `exec` - (Optional) Configuration block to use an [exec-based credential plugin] (https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins), e.g. call an external command to receive user credentials. +* `exec` - (Optional) Configuration block to use an [exec-based credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins), e.g. call an external command to receive user credentials. * `api_version` - (Required) API version to use when decoding the ExecCredentials resource, e.g. `client.authentication.k8s.io/v1beta1`. * `command` - (Required) Command to execute. * `args` - (Optional) List of arguments to pass when executing the plugin. diff --git a/website/docs/language/settings/backends/local.html.md b/website/docs/language/settings/backends/local.mdx similarity index 71% rename from website/docs/language/settings/backends/local.html.md rename to website/docs/language/settings/backends/local.mdx index f2829d3a4298..d2f5d18a0ae6 100644 --- a/website/docs/language/settings/backends/local.html.md +++ b/website/docs/language/settings/backends/local.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "Backend Type: local" -sidebar_current: "docs-backends-types-enhanced-local" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: local' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # local @@ -39,9 +38,9 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: - * `path` - (Optional) The path to the `tfstate` file. This defaults to - "terraform.tfstate" relative to the root module by default. - * `workspace_dir` - (Optional) The path to non-default workspaces. +* `path` - (Optional) The path to the `tfstate` file. This defaults to + "terraform.tfstate" relative to the root module by default. +* `workspace_dir` - (Optional) The path to non-default workspaces. ## Command Line Arguments @@ -58,17 +57,17 @@ additional arguments: * `-state-out=FILENAME` - overrides the state filename when _writing_ new state snapshots. - If you use `-state` without also using `-state-out` then Terraform will - use the `-state` filename for both `-state` and `-state-out`, which means - Terraform will overwrite the input file if it creates a new state snapshot. + If you use `-state` without also using `-state-out` then Terraform will + use the `-state` filename for both `-state` and `-state-out`, which means + Terraform will overwrite the input file if it creates a new state snapshot. * `-backup=FILENAME` - overrides the default filename that the local backend would normally choose dynamically to create backup files when it writes new state. - If you use `-state` without also using `-backup` then Terraform will use - the `-state` filename as a filename prefix for generating a backup filename. - You can use `-backup=-` (that is, set the filename to just the ASCII - dash character) to disable the creation of backup files altogether. + If you use `-state` without also using `-backup` then Terraform will use + the `-state` filename as a filename prefix for generating a backup filename. + You can use `-backup=-` (that is, set the filename to just the ASCII + dash character) to disable the creation of backup files altogether. These three options are preserved for backward-compatibility with earlier workflows that predated the introduction of built-in remote state, where @@ -78,7 +77,7 @@ the three arguments would typically all be paths within a temporary directory used just for one operation. Because these old workflows predate the introduction of the possibility of -[multiple workspaces](/docs/language/state/workspaces.html), setting them +[multiple workspaces](/language/state/workspaces), setting them overrides Terraform's usual behavior of selecting a different state filename based on the selected workspace. If you use all three of these options then the selected workspace has no effect on which filenames Terraform will select @@ -90,7 +89,7 @@ backend type selected. We do not recommend using these options in new systems, even if you are running Terraform in automation. Instead, -[select a different backend which supports remote state](./) and configure it +[select a different backend which supports remote state](/language/settings/backends) and configure it within your root module, which ensures that everyone working on your configuration will automatically retrieve and store state in the correct shared location without any special command line options. diff --git a/website/docs/language/settings/backends/manta.html.md b/website/docs/language/settings/backends/manta.html.md deleted file mode 100644 index ef82e5602ff4..000000000000 --- a/website/docs/language/settings/backends/manta.html.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: manta" -sidebar_current: "docs-backends-types-standard-manta" -description: |- - Terraform can store state in manta. ---- - -# manta - -**Kind: Standard (with locking within Manta)** - -Stores the state as an artifact in [Manta](https://www.joyent.com/manta). - -## Example Configuration - -```hcl -terraform { - backend "manta" { - path = "random/path" - object_name = "terraform.tfstate" - } -} -``` - -Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "manta" - config = { - path = "random/path" - object_name = "terraform.tfstate" - } -} -``` - -## Configuration variables - -The following configuration options are supported: - - * `account` - (Required) This is the name of the Manta account. It can also be provided via the `SDC_ACCOUNT` or `TRITON_ACCOUNT` environment variables. - * `user` - (Optional) The username of the Triton account used to authenticate with the Triton API. It can also be provided via the `SDC_USER` or `TRITON_USER` environment variables. - * `url` - (Optional) The Manta API Endpoint. It can also be provided via the `MANTA_URL` environment variable. Defaults to `https://us-east.manta.joyent.com`. - * `key_material` - (Optional) This is the private key of an SSH key associated with the Triton account to be used. If this is not set, the private key corresponding to the fingerprint in key_id must be available via an SSH Agent. Can be set via the `SDC_KEY_MATERIAL` or `TRITON_KEY_MATERIAL` environment variables. - * `key_id` - (Required) This is the fingerprint of the public key matching the key specified in key_path. It can be obtained via the command ssh-keygen -l -E md5 -f /path/to/key. Can be set via the `SDC_KEY_ID` or `TRITON_KEY_ID` environment variables. - * `insecure_skip_tls_verify` - (Optional) This allows skipping TLS verification of the Triton endpoint. It is useful when connecting to a temporary Triton installation such as Cloud-On-A-Laptop which does not generally use a certificate signed by a trusted root CA. Defaults to `false`. - * `path` - (Required) The path relative to your private storage directory (`/$MANTA_USER/stor`) where the state file will be stored. **Please Note:** If this path does not exist, then the backend will create this folder location as part of backend creation. - * `object_name` - (Optional) The name of the state file (defaults to `terraform.tfstate`) diff --git a/website/docs/language/settings/backends/manta.mdx b/website/docs/language/settings/backends/manta.mdx new file mode 100644 index 000000000000..1c1ecf469263 --- /dev/null +++ b/website/docs/language/settings/backends/manta.mdx @@ -0,0 +1,49 @@ +--- +page_title: 'Backend Type: manta' +description: Terraform can store state in manta. +--- + +# manta + +**Kind: Standard (with locking within Manta)** + +Stores the state as an artifact in [Manta](https://www.joyent.com/manta). + +## Example Configuration + +```hcl +terraform { + backend "manta" { + path = "random/path" + object_name = "terraform.tfstate" + } +} +``` + +Note that for the access credentials we recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration). + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "manta" + config = { + path = "random/path" + object_name = "terraform.tfstate" + } +} +``` + +## Configuration variables + +The following configuration options are supported: + +- `account` - (Required) This is the name of the Manta account. It can also be provided via the `SDC_ACCOUNT` or `TRITON_ACCOUNT` environment variables. +- `user` - (Optional) The username of the Triton account used to authenticate with the Triton API. It can also be provided via the `SDC_USER` or `TRITON_USER` environment variables. +- `url` - (Optional) The Manta API Endpoint. It can also be provided via the `MANTA_URL` environment variable. Defaults to `https://us-east.manta.joyent.com`. +- `key_material` - (Optional) This is the private key of an SSH key associated with the Triton account to be used. If this is not set, the private key corresponding to the fingerprint in key_id must be available via an SSH Agent. Can be set via the `SDC_KEY_MATERIAL` or `TRITON_KEY_MATERIAL` environment variables. +- `key_id` - (Required) This is the fingerprint of the public key matching the key specified in key_path. It can be obtained via the command ssh-keygen -l -E md5 -f /path/to/key. Can be set via the `SDC_KEY_ID` or `TRITON_KEY_ID` environment variables. +- `insecure_skip_tls_verify` - (Optional) This allows skipping TLS verification of the Triton endpoint. It is useful when connecting to a temporary Triton installation such as Cloud-On-A-Laptop which does not generally use a certificate signed by a trusted root CA. Defaults to `false`. +- `path` - (Required) The path relative to your private storage directory (`/$MANTA_USER/stor`) where the state file will be stored. **Please Note:** If this path does not exist, then the backend will create this folder location as part of backend creation. +- `object_name` - (Optional) The name of the state file (defaults to `terraform.tfstate`) diff --git a/website/docs/language/settings/backends/oss.html.md b/website/docs/language/settings/backends/oss.mdx similarity index 91% rename from website/docs/language/settings/backends/oss.html.md rename to website/docs/language/settings/backends/oss.mdx index e2a0adc12b8e..03513d1c2660 100644 --- a/website/docs/language/settings/backends/oss.html.md +++ b/website/docs/language/settings/backends/oss.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: oss" -sidebar_current: "docs-backends-types-standard-oss" -description: |- - Terraform can store state remotely in OSS and lock that state with OSS. +page_title: 'Backend Type: oss' +description: Terraform can store state remotely in OSS and lock that state with OSS. --- # OSS @@ -38,12 +35,11 @@ a [OTS Instance](https://registry.terraform.io/providers/aliyun/alicloud/latest/ a [OTS TableStore](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/ots_table) called `statelock`. The Terraform state will be written into the file `path/mystate/version-1.tfstate`. The `TableStore` must have a primary key named `LockID` of type `String`. - ## Data Source Configuration To make use of the OSS remote state in another configuration, use the [`terraform_remote_state` data -source](/docs/language/state/remote-state-data.html). +source](/language/state/remote-state-data). ```hcl terraform { @@ -78,29 +74,48 @@ data "terraform_remote_state" "network" { The following configuration options or environment variables are supported: * `access_key` - (Optional) Alibaba Cloud access key. It supports environment variables `ALICLOUD_ACCESS_KEY` and `ALICLOUD_ACCESS_KEY_ID`. + * `secret_key` - (Optional) Alibaba Cloud secret access key. It supports environment variables `ALICLOUD_SECRET_KEY` and `ALICLOUD_ACCESS_KEY_SECRET`. + * `security_token` - (Optional) STS access token. It supports environment variable `ALICLOUD_SECURITY_TOKEN`. + * `ecs_role_name` - (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. + * `region` - (Optional) The region of the OSS bucket. It supports environment variables `ALICLOUD_REGION` and `ALICLOUD_DEFAULT_REGION`. + * `endpoint` - (Optional) A custom endpoint for the OSS API. It supports environment variables `ALICLOUD_OSS_ENDPOINT` and `OSS_ENDPOINT`. + * `bucket` - (Required) The name of the OSS bucket. + * `prefix` - (Opeional) The path directory of the state file will be stored. Default to "env:". + * `key` - (Optional) The name of the state file. Defaults to `terraform.tfstate`. + * `tablestore_endpoint` / `ALICLOUD_TABLESTORE_ENDPOINT` - (Optional) A custom endpoint for the TableStore API. + * `tablestore_table` - (Optional) A TableStore table for state locking and consistency. The table must have a primary key named `LockID` of type `String`. + * `sts_endpoint` - (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable `ALICLOUD_STS_ENDPOINT`. + * `encrypt` - (Optional) Whether to enable server side encryption of the state file. If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file. + * `acl` - (Optional) [Object ACL](https://www.alibabacloud.com/help/doc-detail/52284.htm) to be applied to the state file. + * `shared_credentials_file` - (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the `ALICLOUD_SHARED_CREDENTIALS_FILE` environment variable. If this is not set and a profile is specified, `~/.aliyun/config.json` will be used. + * `profile` - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable. + * `assume_role_role_arn` - (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable `ALICLOUD_ASSUME_ROLE_ARN`. Terraform executes configuration on account with provided credentials. + * `assume_role_policy` - (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. + * `assume_role_session_name` - (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. -* `assume_role_session_expiration` - (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. + +* `assume_role_session_expiration` - (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. * `assume_role` - (**Deprecated as of 1.1.0+**, Available in 0.12.6+) If provided with a role ARN, will attempt to assume this role using the supplied credentials. It will be ignored when `assume_role_role_arn` is specified. @@ -113,6 +128,6 @@ The following configuration options or environment variables are supported: * `session_name` - (Optional) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. - * `session_expiration` - (Optional) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. + * `session_expiration` - (Optional) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. -> **Note:** If you want to store state in the custom OSS endpoint, you can specify an environment variable `OSS_ENDPOINT`, like "oss-cn-beijing-internal.aliyuncs.com" diff --git a/website/docs/language/settings/backends/pg.html.md b/website/docs/language/settings/backends/pg.html.md deleted file mode 100644 index 934345f34b3b..000000000000 --- a/website/docs/language/settings/backends/pg.html.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: pg" -sidebar_current: "docs-backends-types-standard-pg" -description: |- - Terraform can store state remotely in a Postgres database with locking. ---- - -# pg - -**Kind: Standard (with locking)** - -Stores the state in a [Postgres database](https://www.postgresql.org) version 10 or newer. - -This backend supports [state locking](/docs/language/state/locking.html). - -## Example Configuration - -```hcl -terraform { - backend "pg" { - conn_str = "postgres://user:pass@db.example.com/terraform_backend" - } -} -``` - -Before initializing the backend with `terraform init`, the database must already exist: - -``` -createdb terraform_backend -``` - -This `createdb` command is found in [Postgres client applications](https://www.postgresql.org/docs/10/reference-client.html) which are installed along with the database server. - -We recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration) -for the `conn_str` variable, because it typically contains access credentials that should not be committed to source control: - -```hcl -terraform { - backend "pg" {} -} -``` - -Then, set the credentials when initializing the configuration: - -``` -terraform init -backend-config="conn_str=postgres://user:pass@db.example.com/terraform_backend" -``` - -To use a Postgres server running on the same machine as Terraform, configure localhost with SSL disabled: - -``` -terraform init -backend-config="conn_str=postgres://localhost/terraform_backend?sslmode=disable" -``` - -## Data Source Configuration - -To make use of the pg remote state in another configuration, use the [`terraform_remote_state` data source](/docs/language/state/remote-state-data.html). - -```hcl -data "terraform_remote_state" "network" { - backend = "pg" - config = { - conn_str = "postgres://localhost/terraform_backend" - } -} -``` - -## Configuration Variables - -The following configuration options or environment variables are supported: - - * `conn_str` - (Required) Postgres connection string; a `postgres://` URL - * `schema_name` - Name of the automatically-managed Postgres schema, default `terraform_remote_state`. - * `skip_schema_creation` - If set to `true`, the Postgres schema must already exist. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator. - * `skip_table_creation` - If set to `true`, the Postgres table must already exist. Terraform won't try to create the table, this is useful when it has already been created by a database administrator. - * `skip_index_creation` - If set to `true`, the Postgres index must already exist. Terraform won't try to create the index, this is useful when it has already been created by a database administrator. - -## Technical Design - -This backend creates one table **states** in the automatically-managed Postgres schema configured by the `schema_name` variable. - -The table is keyed by the [workspace](/docs/language/state/workspaces.html) name. If workspaces are not in use, the name `default` is used. - -Locking is supported using [Postgres advisory locks](https://www.postgresql.org/docs/9.5/explicit-locking.html#ADVISORY-LOCKS). [`force-unlock`](https://www.terraform.io/docs/cli/commands/force-unlock.html) is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the [`pg_locks` system view](https://www.postgresql.org/docs/9.5/view-pg-locks.html). - -The **states** table contains: - - * a serial integer `id`, used as the key for advisory locks - * the workspace `name` key as *text* with a unique index - * the Terraform state `data` as *text* diff --git a/website/docs/language/settings/backends/pg.mdx b/website/docs/language/settings/backends/pg.mdx new file mode 100644 index 000000000000..870350ce6f91 --- /dev/null +++ b/website/docs/language/settings/backends/pg.mdx @@ -0,0 +1,89 @@ +--- +page_title: 'Backend Type: pg' +description: Terraform can store state remotely in a Postgres database with locking. +--- + +# pg + +**Kind: Standard (with locking)** + +Stores the state in a [Postgres database](https://www.postgresql.org) version 10 or newer. + +This backend supports [state locking](/language/state/locking). + +## Example Configuration + +```hcl +terraform { + backend "pg" { + conn_str = "postgres://user:pass@db.example.com/terraform_backend" + } +} +``` + +Before initializing the backend with `terraform init`, the database must already exist: + +``` +createdb terraform_backend +``` + +This `createdb` command is found in [Postgres client applications](https://www.postgresql.org/docs/10/reference-client.html) which are installed along with the database server. + +We recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration) +for the `conn_str` variable, because it typically contains access credentials that should not be committed to source control: + +```hcl +terraform { + backend "pg" {} +} +``` + +Then, set the credentials when initializing the configuration: + +``` +terraform init -backend-config="conn_str=postgres://user:pass@db.example.com/terraform_backend" +``` + +To use a Postgres server running on the same machine as Terraform, configure localhost with SSL disabled: + +``` +terraform init -backend-config="conn_str=postgres://localhost/terraform_backend?sslmode=disable" +``` + +## Data Source Configuration + +To make use of the pg remote state in another configuration, use the [`terraform_remote_state` data source](/language/state/remote-state-data). + +```hcl +data "terraform_remote_state" "network" { + backend = "pg" + config = { + conn_str = "postgres://localhost/terraform_backend" + } +} +``` + +## Configuration Variables + +The following configuration options or environment variables are supported: + +- `conn_str` - (Required) Postgres connection string; a `postgres://` URL +- `schema_name` - Name of the automatically-managed Postgres schema, default `terraform_remote_state`. +- `skip_schema_creation` - If set to `true`, the Postgres schema must already exist. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator. +- `skip_table_creation` - If set to `true`, the Postgres table must already exist. Terraform won't try to create the table, this is useful when it has already been created by a database administrator. +- `skip_index_creation` - If set to `true`, the Postgres index must already exist. Terraform won't try to create the index, this is useful when it has already been created by a database administrator. + +## Technical Design + +This backend creates one table **states** in the automatically-managed Postgres schema configured by the `schema_name` variable. + +The table is keyed by the [workspace](/language/state/workspaces) name. If workspaces are not in use, the name `default` is used. + +Locking is supported using [Postgres advisory locks](https://www.postgresql.org/docs/9.5/explicit-locking.html#ADVISORY-LOCKS). [`force-unlock`](/cli/commands/force-unlock) is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the [`pg_locks` system view](https://www.postgresql.org/docs/9.5/view-pg-locks.html). + +The **states** table contains: + +- a serial integer `id`, used as the key for advisory locks +- the workspace `name` key as _text_ with a unique index +- the Terraform state `data` as _text_ diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.mdx similarity index 77% rename from website/docs/language/settings/backends/remote.html.md rename to website/docs/language/settings/backends/remote.mdx index 1c26169b87d3..d9d1508078c3 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "Backend Type: remote" -sidebar_current: "docs-backends-types-enhanced-remote" -description: |- - Terraform can store the state and run operations remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: remote' +description: >- + Terraform can store the state and run operations remotely, making it easier to + version and work with in a team. --- # remote @@ -18,7 +17,7 @@ backend. This backend requires either a Terraform Cloud account on The remote backend stores Terraform state and may be used to run operations in Terraform Cloud. When using full remote operations, operations like `terraform plan` or `terraform apply` can be executed in Terraform -Cloud's run environment, with log output streaming to the local terminal. Remote plans and applies use variable values from the associated Terraform Cloud workspace. +Cloud's run environment, with log output streaming to the local terminal. Remote plans and applies use variable values from the associated Terraform Cloud workspace. Terraform Cloud can also be used with local operations, in which case only state is stored in the Terraform Cloud backend. @@ -59,7 +58,7 @@ determines which mode it uses: all of the desired remote workspace names. For example, set `prefix = "networking-"` to use Terraform cloud workspaces with names like `networking-dev` and `networking-prod`. This is helpful when - mapping multiple Terraform CLI [workspaces](/docs/language/state/workspaces.html) + mapping multiple Terraform CLI [workspaces](/language/state/workspaces) used in a single Terraform configuration to multiple Terraform Cloud workspaces. @@ -70,7 +69,7 @@ the Terraform CLI workspace `prod` within the current configuration. Remote Terraform operations such as `plan` and `apply` executed against that Terraform CLI workspace will be executed in the Terraform Cloud workspace `networking-prod`. -Additionally, the [`${terraform.workspace}`](/docs/language/state/workspaces.html#current-workspace-interpolation) +Additionally, the [`${terraform.workspace}`](/language/state/workspaces#current-workspace-interpolation) interpolation sequence should be removed from Terraform configurations that run remote operations against Terraform Cloud workspaces. The reason for this is that each Terraform Cloud workspace currently only uses the single `default` Terraform @@ -94,8 +93,8 @@ running any remote operations against them. ## Example Configurations -> **Note:** We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/cli/commands/login.html) or manually configuring - `credentials` in the [CLI config file](/docs/cli/config/config-file.html#credentials). +[`terraform login`](/cli/commands/login) or manually configuring +`credentials` in the [CLI config file](/cli/config/config-file#credentials). ### Basic Configuration @@ -171,26 +170,26 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: -* `hostname` - (Optional) The remote backend hostname to connect to. Defaults +- `hostname` - (Optional) The remote backend hostname to connect to. Defaults to app.terraform.io. -* `organization` - (Required) The name of the organization containing the +- `organization` - (Required) The name of the organization containing the targeted workspace(s). -* `token` - (Optional) The token used to authenticate with the remote backend. +- `token` - (Optional) The token used to authenticate with the remote backend. We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/cli/commands/login.html) or manually configuring + [`terraform login`](/cli/commands/login) or manually configuring `credentials` in the - [CLI config file](/docs/cli/config/config-file.html#credentials). -* `workspaces` - (Required) A block specifying which remote workspace(s) to use. + [CLI config file](/cli/config/config-file#credentials). +- `workspaces` - (Required) A block specifying which remote workspace(s) to use. The `workspaces` block supports the following keys: - * `name` - (Optional) The full name of one remote workspace. When configured, + - `name` - (Optional) The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with `prefix`. - * `prefix` - (Optional) A prefix used in the names of one or more remote + - `prefix` - (Optional) A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in Terraform Cloud, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with `name`. - + -> **Note:** You must use the `name` key when configuring a `terraform_remote_state` data source that retrieves state from another Terraform Cloud workspace. The `prefix` key is only intended for use when configuring an instance of the remote backend. @@ -201,38 +200,37 @@ For configurations that include a `backend "remote"` block, commands that make local modifications to Terraform state and then push them back up to the remote workspace accept the following option to modify that behavior: -* `-ignore-remote-version` - Override checking that the local and remote +- `-ignore-remote-version` - Override checking that the local and remote Terraform versions agree, making an operation proceed even when there is a mismatch. - Normally state-modification operations require using a local version of - Terraform CLI which is compatible with the Terraform version selected - for the remote workspace as part of its settings. This is to avoid the - local operation creating a new state snapshot which the workspace's - remote execution environment would then be unable to decode. + Normally state-modification operations require using a local version of + Terraform CLI which is compatible with the Terraform version selected + for the remote workspace as part of its settings. This is to avoid the + local operation creating a new state snapshot which the workspace's + remote execution environment would then be unable to decode. - Overriding this check can result in a Terraform Cloud workspace that is - no longer able to complete remote operations, so we recommend against - using this option. + Overriding this check can result in a Terraform Cloud workspace that is + no longer able to complete remote operations, so we recommend against + using this option. ## Excluding Files from Upload with .terraformignore -> **Version note:** `.terraformignore` support was added in Terraform 0.12.11. -When executing a remote `plan` or `apply` in a [CLI-driven run](/docs/cloud/run/cli.html), +When executing a remote `plan` or `apply` in a [CLI-driven run](/cloud-docs/run/cli), an archive of your configuration directory is uploaded to Terraform Cloud. You can define paths to ignore from upload via a `.terraformignore` file at the root of your configuration directory. If this file is not present, the archive will exclude the following by default: -* .git/ directories -* .terraform/ directories (exclusive of .terraform/modules) +- .git/ directories +- .terraform/ directories (exclusive of .terraform/modules) The `.terraformignore` file can include rules as one would include in a [.gitignore file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) - -* Comments (starting with `#`) or blank lines are ignored -* End a pattern with a forward slash / to specify a directory -* Negate a pattern by starting it with an exclamation point `!` +- Comments (starting with `#`) or blank lines are ignored +- End a pattern with a forward slash / to specify a directory +- Negate a pattern by starting it with an exclamation point `!` Note that unlike `.gitignore`, only the `.terraformignore` at the root of the configuration directory is considered. diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.mdx similarity index 96% rename from website/docs/language/settings/backends/s3.html.md rename to website/docs/language/settings/backends/s3.mdx index e043701f445b..ea9d233264c5 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: s3" -sidebar_current: "docs-backends-types-standard-s3" -description: |- - Terraform can store state remotely in S3 and lock that state with DynamoDB. +page_title: 'Backend Type: s3' +description: Terraform can store state remotely in S3 and lock that state with DynamoDB. --- # S3 @@ -37,7 +34,7 @@ This assumes we have a bucket created called `mybucket`. The Terraform state is written to the key `path/to/my/key`. Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). +[partial configuration](/language/settings/backends/configuration#partial-configuration). ### S3 Bucket Permissions @@ -108,7 +105,7 @@ This is seen in the following AWS IAM Statement: To make use of the S3 remote state in another configuration, use the [`terraform_remote_state` data -source](/docs/language/state/remote-state-data.html). +source](/language/state/remote-state-data). ```hcl data "terraform_remote_state" "network" { @@ -183,7 +180,7 @@ The following configuration is optional: The following configuration is required: * `bucket` - (Required) Name of the S3 Bucket. -* `key` - (Required) Path to the state file inside the S3 Bucket. When using a non-default [workspace](/docs/language/state/workspaces.html), the state path will be `/workspace_key_prefix/workspace_name/key` (see also the `workspace_key_prefix` configuration). +* `key` - (Required) Path to the state file inside the S3 Bucket. When using a non-default [workspace](/language/state/workspaces), the state path will be `/workspace_key_prefix/workspace_name/key` (see also the `workspace_key_prefix` configuration). The following configuration is optional: @@ -215,7 +212,7 @@ The S3 backend can be used in a number of different ways that make different tradeoffs between convenience, security, and isolation in such an organization. This section describes one such approach that aims to find a good compromise between these tradeoffs, allowing use of -[Terraform's workspaces feature](/docs/language/state/workspaces.html) to switch +[Terraform's workspaces feature](/language/state/workspaces) to switch conveniently between multiple isolated deployments of the same configuration. Use this section as a starting-point for your approach, but note that @@ -321,7 +318,7 @@ provider "aws" { If workspace IAM roles are centrally managed and shared across many separate Terraform configurations, the role ARNs could also be obtained via a data -source such as [`terraform_remote_state`](/docs/language/state/remote-state-data.html) +source such as [`terraform_remote_state`](/language/state/remote-state-data) to avoid repeating these values. ### Creating and Selecting Workspaces diff --git a/website/docs/language/settings/backends/swift.html.md b/website/docs/language/settings/backends/swift.mdx similarity index 91% rename from website/docs/language/settings/backends/swift.html.md rename to website/docs/language/settings/backends/swift.mdx index 8bc3d783a3e3..97bd33c264ec 100644 --- a/website/docs/language/settings/backends/swift.html.md +++ b/website/docs/language/settings/backends/swift.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: swift" -sidebar_current: "docs-backends-types-standard-swift" -description: |- - Terraform can store state remotely in Swift. +page_title: 'Backend Type: swift' +description: Terraform can store state remotely in Swift. --- # swift @@ -12,7 +9,7 @@ description: |- Stores the state as an artifact in [Swift](http://docs.openstack.org/developer/swift/latest/). -~> Warning! It is highly recommended that you enable [Object Versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) by setting the [`archive_container`](https://www.terraform.io/docs/language/settings/backends/swift.html#archive_container) configuration. This allows for state recovery in the case of accidental deletions and human error. +~> Warning! It is highly recommended that you enable [Object Versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) by setting the [`archive_container`](/language/settings/backends/swift#archive_container) configuration. This allows for state recovery in the case of accidental deletions and human error. ## Example Configuration @@ -24,10 +21,11 @@ terraform { } } ``` + This will create a container called `terraform-state` and an object within that container called `tfstate.tf`. It will enable versioning using the `terraform-state-archive` container to contain the older version. For the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). +[partial configuration](/language/settings/backends/configuration#partial-configuration). ## Data Source Configuration @@ -46,7 +44,7 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: * `auth_url` - (Optional) The Identity authentication URL. If omitted, the - `OS_AUTH_URL` environment variable is used. + `OS_AUTH_URL` environment variable is used. * `cloud` - (Optional; required if `auth_url` is not specified) An entry in a `clouds.yaml` file. See the OpenStack `os-client-config` @@ -55,7 +53,7 @@ The following configuration options are supported: environment variable is used. * `region_name` - (Optional) - The region in which to store `terraform.tfstate`. If - omitted, the `OS_REGION_NAME` environment variable is used. + omitted, the `OS_REGION_NAME` environment variable is used. * `container` - (Required) The name of the container to create for storing the Terraform state file. @@ -137,10 +135,10 @@ The following configuration options are supported: certificate. If omitted, the `OS_CACERT` environment variable is used. * `cert` - (Optional) Specify client certificate file for SSL client authentication. - If omitted the `OS_CERT` environment variable is used. + If omitted the `OS_CERT` environment variable is used. * `key` - (Optional) Specify client private key file for SSL client authentication. - If omitted the `OS_KEY` environment variable is used. + If omitted the `OS_KEY` environment variable is used. * `endpoint_type` - (Optional) Specify which type of endpoint to use from the service catalog. It can be set using the OS_ENDPOINT_TYPE environment diff --git a/website/docs/language/settings/index.html.md b/website/docs/language/settings/index.mdx similarity index 84% rename from website/docs/language/settings/index.html.md rename to website/docs/language/settings/index.mdx index 5fa8949ac764..1f06019e609d 100644 --- a/website/docs/language/settings/index.html.md +++ b/website/docs/language/settings/index.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Terraform Settings - Configuration Language" -sidebar_current: "docs-config-terraform" -description: "The terraform block allows you to configure Terraform behavior, including the Terraform version, backend, and required providers." +page_title: Terraform Settings - Configuration Language +description: >- + The terraform block allows you to configure Terraform behavior, including the + Terraform version, backend, and required providers. +sidebar_title: Terraform Settings --- # Terraform Settings @@ -34,20 +35,20 @@ following sections. The nested `backend` block configures which backend Terraform should use. The syntax and behavior of the `backend` block is described in [Backend -Configuration](/docs/language/settings/backends/configuration.html). +Configuration](/language/settings/backends/configuration). ## Specifying a Required Terraform Version > **Hands-on:** Try the [Manage Terraform Versions](https://learn.hashicorp.com/tutorials/terraform/versions?in=terraform/configuration-language) or [Manage Terraform Versions in Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-versions?in=terraform/cloud) tutorials on HashiCorp Learn. The `required_version` setting accepts a [version constraint -string,](/docs/language/expressions/version-constraints.html) which specifies which versions of Terraform +string,](/language/expressions/version-constraints) which specifies which versions of Terraform can be used with your configuration. If the running version of Terraform doesn't match the constraints specified, Terraform will produce an error and exit without taking any further actions. -When you use [child modules](/docs/language/modules/index.html), each module can specify its own +When you use [child modules](/language/modules/), each module can specify its own version requirements. The requirements of all modules in the tree must be satisfied. @@ -58,7 +59,7 @@ a minimum Terraform version that has behavior expected by the configuration. The `required_version` setting applies only to the version of Terraform CLI. Terraform's resource types are implemented by provider plugins, whose release cycles are independent of Terraform CLI and of each other. -Use [the `required_providers` block](/docs/language/providers/requirements.html) to manage +Use [the `required_providers` block](/language/providers/requirements) to manage the expected versions for each provider you use. ## Specifying Provider Requirements @@ -80,7 +81,7 @@ terraform { } ``` -For more information, see [Provider Requirements](/docs/language/providers/requirements.html). +For more information, see [Provider Requirements](/language/providers/requirements). ## Experimental Language Features @@ -125,4 +126,4 @@ provider a module is using, if the provider defines a schema for it. This allows the provider to receive module-specific information, and is primarily intended for modules distributed by the same vendor as the associated provider. -For more information, see [Provider Metadata](/docs/internals/provider-meta.html). +For more information, see [Provider Metadata](/internals/provider-meta). diff --git a/website/docs/language/state/backends.html.md b/website/docs/language/state/backends.mdx similarity index 69% rename from website/docs/language/state/backends.html.md rename to website/docs/language/state/backends.mdx index da957173d725..a630dbd3ebdc 100644 --- a/website/docs/language/state/backends.html.md +++ b/website/docs/language/state/backends.mdx @@ -1,15 +1,14 @@ --- -layout: "language" -page_title: "Backends: State Storage and Locking" -sidebar_current: "docs-backends-state" -description: |- - Backends are configured directly in Terraform files in the `terraform` section. +page_title: 'Backends: State Storage and Locking' +description: >- + Backends are configured directly in Terraform files in the `terraform` + section. --- # State Storage and Locking Backends are responsible for storing state and providing an API for -[state locking](/docs/language/state/locking.html). State locking is optional. +[state locking](/language/state/locking). State locking is optional. Despite the state being stored remotely, all Terraform commands such as `terraform console`, the `terraform state` operations, `terraform taint`, @@ -47,15 +46,15 @@ overwrite the remote state. This can be used to do manual fixups if necessary. When manually pushing state, Terraform will attempt to protect you from some potentially dangerous situations: - * **Differing lineage**: The "lineage" is a unique ID assigned to a state - when it is created. If a lineage is different, then it means the states - were created at different times and its very likely you're modifying a - different state. Terraform will not allow this. +- **Differing lineage**: The "lineage" is a unique ID assigned to a state + when it is created. If a lineage is different, then it means the states + were created at different times and its very likely you're modifying a + different state. Terraform will not allow this. - * **Higher serial**: Every state has a monotonically increasing "serial" - number. If the destination state has a higher serial, Terraform will - not allow you to write it since it means that changes have occurred since - the state you're attempting to write. +- **Higher serial**: Every state has a monotonically increasing "serial" + number. If the destination state has a higher serial, Terraform will + not allow you to write it since it means that changes have occurred since + the state you're attempting to write. Both of these protections can be bypassed with the `-force` flag if you're confident you're making the right decision. Even if using the `-force` flag, @@ -64,12 +63,12 @@ prior to forcing the overwrite. ## State Locking -Backends are responsible for supporting [state locking](/docs/language/state/locking.html) +Backends are responsible for supporting [state locking](/language/state/locking) if possible. Not all backends support locking. The -[documentation for each backend](/docs/language/settings/backends/index.html) +[documentation for each backend](/language/settings/backends/) includes details on whether it supports locking or not. For more information on state locking, view the -[page dedicated to state locking](/docs/language/state/locking.html). +[page dedicated to state locking](/language/state/locking). diff --git a/website/docs/language/state/import.html.md b/website/docs/language/state/import.mdx similarity index 59% rename from website/docs/language/state/import.html.md rename to website/docs/language/state/import.mdx index 1334269e92e9..9646c32df472 100644 --- a/website/docs/language/state/import.html.md +++ b/website/docs/language/state/import.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "State: Import Existing Resources" -sidebar_current: "docs-state-import" -description: |- - Terraform stores state which caches the known state of the world the last time Terraform ran. +page_title: 'State: Import Existing Resources' +description: >- + Terraform stores state which caches the known state of the world the last time + Terraform ran. --- # Import Existing Resources @@ -12,4 +11,4 @@ Terraform is able to import existing infrastructure. This allows you take resources you've created by some other means and bring it under Terraform management. To learn more about this, please visit the -[pages dedicated to import](/docs/cli/import/index.html). +[pages dedicated to import](/cli/import/). diff --git a/website/docs/language/state/index.html.md b/website/docs/language/state/index.mdx similarity index 77% rename from website/docs/language/state/index.html.md rename to website/docs/language/state/index.mdx index 67072eab237d..0b8dd3a80b41 100644 --- a/website/docs/language/state/index.html.md +++ b/website/docs/language/state/index.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "State" -sidebar_current: "docs-state" -description: "An introduction to state, information that Terraform uses to map resources to a configuration, track metadata, and improve performance." +page_title: State +description: >- + An introduction to state, information that Terraform uses to map resources to + a configuration, track metadata, and improve performance. --- # State @@ -17,7 +17,7 @@ but it can also be stored remotely, which works better in a team environment. Terraform uses this local state to create plans and make changes to your infrastructure. Prior to any operation, Terraform does a -[refresh](/docs/cli/commands/refresh.html) to update the state with the +[refresh](/cli/commands/refresh) to update the state with the real infrastructure. The primary purpose of Terraform state is to store bindings between objects in @@ -28,13 +28,13 @@ resource instance, and then potentially update or delete that object in response to future configuration changes. For more information on why Terraform requires state and why Terraform cannot -function without state, please see the page [state purpose](/docs/language/state/purpose.html). +function without state, please see the page [state purpose](/language/state/purpose). ## Inspection and Modification While the format of the state files are just JSON, direct file editing of the state is discouraged. Terraform provides the -[terraform state](/docs/cli/commands/state/index.html) command to perform +[terraform state](/cli/commands/state/) command to perform basic modifications of the state using the CLI. The CLI usage and output of the state commands is structured to be @@ -67,13 +67,13 @@ in new versions. Alternatively, there are several integration points which produce JSON output that is specifically intended for consumption by external software: -* [The `terraform output` command](/docs/cli/commands/output.html) -has a `-json` option, for obtaining either the full set of root module output -values or a specific named output value from the latest state snapshot. -* [The `terraform show` command](/docs/cli/commands/show.html) has a `-json` -option for inspecting the latest state snapshot in full, and also for -inspecting saved plan files which include a copy of the prior state at the -time the plan was made. +* [The `terraform output` command](/cli/commands/output) + has a `-json` option, for obtaining either the full set of root module output + values or a specific named output value from the latest state snapshot. +* [The `terraform show` command](/cli/commands/show) has a `-json` + option for inspecting the latest state snapshot in full, and also for + inspecting saved plan files which include a copy of the prior state at the + time the plan was made. A typical way to use these in situations where Terraform is running in automation is to run them immediately after a successful `terraform apply` diff --git a/website/docs/language/state/locking.html.md b/website/docs/language/state/locking.mdx similarity index 77% rename from website/docs/language/state/locking.html.md rename to website/docs/language/state/locking.mdx index 739a4b8c41d0..c21b0aee1d23 100644 --- a/website/docs/language/state/locking.html.md +++ b/website/docs/language/state/locking.mdx @@ -1,14 +1,13 @@ --- -layout: "language" -page_title: "State: Locking" -sidebar_current: "docs-state-locking" -description: |- - Terraform stores state which caches the known state of the world the last time Terraform ran. +page_title: 'State: Locking' +description: >- + Terraform stores state which caches the known state of the world the last time + Terraform ran. --- # State Locking -If supported by your [backend](/docs/language/settings/backends/index.html), Terraform will lock your +If supported by your [backend](/language/settings/backends/), Terraform will lock your state for all operations that could write state. This prevents others from acquiring the lock and potentially corrupting your state. @@ -22,12 +21,12 @@ a status message. If Terraform doesn't output a message, state locking is still occurring if your backend supports it. Not all backends support locking. The -[documentation for each backend](/docs/language/settings/backends/index.html) +[documentation for each backend](/language/settings/backends/) includes details on whether it supports locking or not. ## Force Unlock -Terraform has a [force-unlock command](/docs/cli/commands/force-unlock.html) +Terraform has a [force-unlock command](/cli/commands/force-unlock) to manually unlock the state if unlocking failed. **Be very careful with this command.** If you unlock the state when someone diff --git a/website/docs/language/state/purpose.html.md b/website/docs/language/state/purpose.mdx similarity index 93% rename from website/docs/language/state/purpose.html.md rename to website/docs/language/state/purpose.mdx index 44bfef6d1963..95e8f09d4fa3 100644 --- a/website/docs/language/state/purpose.html.md +++ b/website/docs/language/state/purpose.mdx @@ -1,9 +1,10 @@ --- -layout: "language" -page_title: "State" -sidebar_current: "docs-state-purpose" -description: |- - Terraform must store state about your managed infrastructure and configuration. This state is used by Terraform to map real world resources to your configuration, keep track of metadata, and to improve performance for large infrastructures. +page_title: State +description: >- + Terraform must store state about your managed infrastructure and + configuration. This state is used by Terraform to map real world resources to + your configuration, keep track of metadata, and to improve performance for + large infrastructures. --- # Purpose of Terraform State @@ -105,7 +106,7 @@ started, but when using Terraform in a team it is important for everyone to be working with the same state so that operations will be applied to the same remote objects. -[Remote state](/docs/language/state/remote.html) is the recommended solution +[Remote state](/language/state/remote) is the recommended solution to this problem. With a fully-featured state backend, Terraform can use remote locking as a measure to avoid two or more different users accidentally running Terraform at the same time, and thus ensure that each Terraform run diff --git a/website/docs/language/state/remote-state-data.html.md b/website/docs/language/state/remote-state-data.html.md deleted file mode 100644 index 10e51460068a..000000000000 --- a/website/docs/language/state/remote-state-data.html.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -layout: "language" -page_title: "The terraform_remote_state Data Source" -sidebar_current: "docs-terraform-datasource-remote-state" -description: |- - Retrieves the root module output values from a Terraform state snapshot stored in a remote backend. ---- - -# The `terraform_remote_state` Data Source - -[backends]: /docs/backends/index.html - -The `terraform_remote_state` data source retrieves the root module output values -from some other Terraform configuration, using the latest state snapshot from -the remote backend. - -This data source is built into Terraform, and is always available; you do not -need to require or configure a provider in order to use it. - --> **Note:** This data source is implemented by a built-in provider, whose -[source address](/docs/language/providers/requirements.html#source-addresses) -is `terraform.io/builtin/terraform`. That provider does not include any other -resources or data sources. - -## Alternative Ways to Share Data Between Configurations - -Sharing data with root module outputs is convenient, but it has drawbacks. -Although `terraform_remote_state` only exposes output values, its user must have -access to the entire state snapshot, which often includes some sensitive -information. - -When possible, we recommend explicitly publishing data for external consumption -to a separate location instead of accessing it via remote state. This lets you -apply different access controls for shared information and state snapshots. - -To share data explicitly between configurations, you can use pairs of managed -resource types and data sources in various providers, including (but not -limited to) the following: - -| System | Publish with... | Read with... | -|--|--|--| -| Alibaba Cloud DNS
      (for IP addresses and hostnames) | [`alicloud_alidns_record` resource type](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/alidns_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Amazon Route53
      (for IP addresses and hostnames) | [`aws_route53_record` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Amazon S3 | [`aws_s3_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) | [`aws_s3_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket_object) | -| Amazon SSM Parameter Store | [`aws_ssm_parameter` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | [`aws_ssm_parameter` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | -| Azure Automation | [`azurerm_automation_variable_string` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/automation_variable_string) | [`azurerm_automation_variable_string` data source](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/automation_variable_string) | -| Azure DNS
      (for IP addresses and hostnames) | [`azurerm_dns_a_record` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_a_record), etc | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Google Cloud DNS
      (for IP addresses and hostnames) | [`google_dns_record_set` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/dns_record_set) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Google Cloud Storage | [`google_storage_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket_object) | [`google_storage_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/storage_bucket_object) and [`http` data source](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | -| HashiCorp Consul | [`consul_key_prefix` resource type](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/key_prefix) | [`consul_key_prefix` data source](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key_prefix) | -| HashiCorp Terraform Cloud | Normal `outputs` terraform block | [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) | -| Kubernetes | [`kubernetes_config_map` resource type](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | [`kubernetes_config_map` data source](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/config_map) | -| OCI Object Storage | [`oci_objectstorage_bucket` resource type](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/objectstorage_object) | [`oci_objectstorage_bucket` data source](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/objectstorage_object) | - --> These are some common options from the Official Terraform providers, but -there are too many configuration storage options for us to list them all -here, including some in partner and community providers. -Any pair of managed resource type and corresponding data source can potentially -be used to share data between Terraform configurations. See individual provider -documentation to find other possibilities. - -A key advantage of using a separate explicit configuration store instead of -`terraform_remote_state` is that the data can potentially also be read by -systems other than Terraform, such as configuration management or scheduler -systems within your compute instances. For that reason, we recommend selecting -a configuration store that your other infrastructure could potentially make -use of. For example: - -* If you wish to share IP addresses and hostnames, you could publish them as -normal DNS `A`, `AAAA`, `CNAME`, and `SRV` records in a private DNS zone and -then configure your other infrastructure to refer to that zone so you can -find infrastructure objects via your system's built-in DNS resolver. -* If you use HashiCorp Consul then publishing data to the Consul key/value -store or Consul service catalog can make that data also accessible via -[Consul Template](https://github.com/hashicorp/consul-template) -or the -[HashiCorp Nomad](https://www.nomadproject.io/docs/job-specification/template) -`template` stanza. -* If you use Kubernetes then you can -[make Config Maps available to your Pods](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/). - -Some of the data stores listed above are specifically designed for storing -small configuration values, while others are generic blob storage systems. For -those generic systems, you can use -[the `jsonencode` function](https://www.terraform.io/docs/language/functions/jsonencode.html) -and -[the `jsondecode` function](https://www.terraform.io/docs/language/functions/jsondecode.html) respectively -to store and retrieve structured data. - -You can encapsulate the implementation details of retrieving your published -configuration data by writing a -[data-only module](/docs/language/modules/develop/composition.html#data-only-modules) -containing the necessary data source configuration and any necessary -post-processing such as JSON decoding. You can then change that module later -if you switch to a different strategy for sharing data between multiple -Terraform configurations. - -## Usage with Terraform Cloud/Enterprise - -When trying to access remote state outputs in Terraform Cloud/Enterprise, it is recommended to use the `tfe_outputs` data source in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) instead of relying the `terraform_remote_state` data source. - -See the [full documentation](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) for the `tfe_outputs` data source for more details. - -## Example Usage (`remote` Backend) - -```hcl -data "terraform_remote_state" "vpc" { - backend = "remote" - - config = { - organization = "hashicorp" - workspaces = { - name = "vpc-prod" - } - } -} - -# Terraform >= 0.12 -resource "aws_instance" "foo" { - # ... - subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id -} - -# Terraform <= 0.11 -resource "aws_instance" "foo" { - # ... - subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" -} -``` - -## Example Usage (`local` Backend) - -```hcl -data "terraform_remote_state" "vpc" { - backend = "local" - - config = { - path = "..." - } -} - -# Terraform >= 0.12 -resource "aws_instance" "foo" { - # ... - subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id -} - -# Terraform <= 0.11 -resource "aws_instance" "foo" { - # ... - subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" -} -``` - -## Argument Reference - -The following arguments are supported: - -* `backend` - (Required) The remote backend to use. -* `workspace` - (Optional) The Terraform workspace to use, if the backend - supports workspaces. -* `config` - (Optional; object) The configuration of the remote backend. - Although this argument is listed as optional, most backends require - some configuration. - - The `config` object can use any arguments that would be valid in the - equivalent `terraform { backend "" { ... } }` block. See - [the documentation of your chosen backend](/docs/language/settings/backends/index.html) - for details. - - -> **Note:** If the backend configuration requires a nested block, specify - it here as a normal attribute with an object value. (For example, - `workspaces = { ... }` instead of `workspaces { ... }`.) -* `defaults` - (Optional; object) Default values for outputs, in case the state - file is empty or lacks a required output. - -## Attributes Reference - -In addition to the above, the following attributes are exported: - -* (v0.12+) `outputs` - An object containing every root-level - [output](/docs/language/values/outputs.html) in the remote state. -* (<= v0.11) `` - Each root-level [output](/docs/language/values/outputs.html) - in the remote state appears as a top level attribute on the data source. - -## Root Outputs Only - -Only the root-level output values from the remote state snapshot are exposed -for use elsewhere in your module. Resource data and output values from nested -modules are not accessible. - -If you wish to make a nested module output value accessible as a root module -output value, you must explicitly configure a passthrough in the root module. -For example: - -For example: - -```hcl -module "app" { - source = "..." -} - -output "app_value" { - # This syntax is for Terraform 0.12 or later. - value = module.app.example -} -``` - -In this example, the output value named `example` from the "app" module is -available as the `app_value` root module output value. If this configuration -didn't include the `output "app_value"` block then the data would not be -accessible via `terraform_remote_state`. - -~> **Warning:** Although `terraform_remote_state` doesn't expose any other -state snapshot information for use in configuration, the state snapshot data -is a single object and so any user or server which has enough access to read -the root module output values will also always have access to the full state -snapshot data by direct network requests. Don't use `terraform_remote_state` -if any of the resources in your configuration work with data that you consider -sensitive. diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx new file mode 100644 index 000000000000..1da4b1fb3e0a --- /dev/null +++ b/website/docs/language/state/remote-state-data.mdx @@ -0,0 +1,219 @@ +--- +page_title: The terraform_remote_state Data Source +description: >- + Retrieves the root module output values from a Terraform state snapshot stored + in a remote backend. +--- + +# The `terraform_remote_state` Data Source + +[backends]: /backends/ + +The `terraform_remote_state` data source retrieves the root module output values +from some other Terraform configuration, using the latest state snapshot from +the remote backend. + +This data source is built into Terraform, and is always available; you do not +need to require or configure a provider in order to use it. + +-> **Note:** This data source is implemented by a built-in provider, whose +[source address](/language/providers/requirements#source-addresses) +is `terraform.io/builtin/terraform`. That provider does not include any other +resources or data sources. + +## Alternative Ways to Share Data Between Configurations + +Sharing data with root module outputs is convenient, but it has drawbacks. +Although `terraform_remote_state` only exposes output values, its user must have +access to the entire state snapshot, which often includes some sensitive +information. + +When possible, we recommend explicitly publishing data for external consumption +to a separate location instead of accessing it via remote state. This lets you +apply different access controls for shared information and state snapshots. + +To share data explicitly between configurations, you can use pairs of managed +resource types and data sources in various providers, including (but not +limited to) the following: + +| System | Publish with... | Read with... | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Alibaba Cloud DNS
      (for IP addresses and hostnames) | [`alicloud_alidns_record` resource type](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/alidns_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Amazon Route53
      (for IP addresses and hostnames) | [`aws_route53_record` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Amazon S3 | [`aws_s3_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) | [`aws_s3_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket_object) | +| Amazon SSM Parameter Store | [`aws_ssm_parameter` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | [`aws_ssm_parameter` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | +| Azure Automation | [`azurerm_automation_variable_string` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/automation_variable_string) | [`azurerm_automation_variable_string` data source](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/automation_variable_string) | +| Azure DNS
      (for IP addresses and hostnames) | [`azurerm_dns_a_record` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_a_record), etc | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Google Cloud DNS
      (for IP addresses and hostnames) | [`google_dns_record_set` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/dns_record_set) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Google Cloud Storage | [`google_storage_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket_object) | [`google_storage_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/storage_bucket_object) and [`http` data source](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | +| HashiCorp Consul | [`consul_key_prefix` resource type](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/key_prefix) | [`consul_key_prefix` data source](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key_prefix) | +| HashiCorp Terraform Cloud | Normal `outputs` terraform block | [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) | +| Kubernetes | [`kubernetes_config_map` resource type](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | [`kubernetes_config_map` data source](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/config_map) | +| OCI Object Storage | [`oci_objectstorage_bucket` resource type](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/objectstorage_object) | [`oci_objectstorage_bucket` data source](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/objectstorage_object) | + +-> These are some common options from the Official Terraform providers, but +there are too many configuration storage options for us to list them all +here, including some in partner and community providers. +Any pair of managed resource type and corresponding data source can potentially +be used to share data between Terraform configurations. See individual provider +documentation to find other possibilities. + +A key advantage of using a separate explicit configuration store instead of +`terraform_remote_state` is that the data can potentially also be read by +systems other than Terraform, such as configuration management or scheduler +systems within your compute instances. For that reason, we recommend selecting +a configuration store that your other infrastructure could potentially make +use of. For example: + +* If you wish to share IP addresses and hostnames, you could publish them as + normal DNS `A`, `AAAA`, `CNAME`, and `SRV` records in a private DNS zone and + then configure your other infrastructure to refer to that zone so you can + find infrastructure objects via your system's built-in DNS resolver. +* If you use HashiCorp Consul then publishing data to the Consul key/value + store or Consul service catalog can make that data also accessible via + [Consul Template](https://github.com/hashicorp/consul-template) + or the + [HashiCorp Nomad](https://www.nomadproject.io/docs/job-specification/template) + `template` stanza. +* If you use Kubernetes then you can + [make Config Maps available to your Pods](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/). + +Some of the data stores listed above are specifically designed for storing +small configuration values, while others are generic blob storage systems. For +those generic systems, you can use +[the `jsonencode` function](/language/functions/jsonencode) +and +[the `jsondecode` function](/language/functions/jsondecode) respectively +to store and retrieve structured data. + +You can encapsulate the implementation details of retrieving your published +configuration data by writing a +[data-only module](/language/modules/develop/composition#data-only-modules) +containing the necessary data source configuration and any necessary +post-processing such as JSON decoding. You can then change that module later +if you switch to a different strategy for sharing data between multiple +Terraform configurations. + +## Usage with Terraform Cloud/Enterprise + +When trying to access remote state outputs in Terraform Cloud/Enterprise, it is recommended to use the `tfe_outputs` data source in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) instead of relying the `terraform_remote_state` data source. + +See the [full documentation](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) for the `tfe_outputs` data source for more details. + +## Example Usage (`remote` Backend) + +```hcl +data "terraform_remote_state" "vpc" { + backend = "remote" + + config = { + organization = "hashicorp" + workspaces = { + name = "vpc-prod" + } + } +} + +# Terraform >= 0.12 +resource "aws_instance" "foo" { + # ... + subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id +} + +# Terraform <= 0.11 +resource "aws_instance" "foo" { + # ... + subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" +} +``` + +## Example Usage (`local` Backend) + +```hcl +data "terraform_remote_state" "vpc" { + backend = "local" + + config = { + path = "..." + } +} + +# Terraform >= 0.12 +resource "aws_instance" "foo" { + # ... + subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id +} + +# Terraform <= 0.11 +resource "aws_instance" "foo" { + # ... + subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backend` - (Required) The remote backend to use. +* `workspace` - (Optional) The Terraform workspace to use, if the backend + supports workspaces. +* `config` - (Optional; object) The configuration of the remote backend. + Although this argument is listed as optional, most backends require + some configuration. + + The `config` object can use any arguments that would be valid in the + equivalent `terraform { backend "" { ... } }` block. See + [the documentation of your chosen backend](/language/settings/backends/) + for details. + + -> **Note:** If the backend configuration requires a nested block, specify + it here as a normal attribute with an object value. (For example, + `workspaces = { ... }` instead of `workspaces { ... }`.) +* `defaults` - (Optional; object) Default values for outputs, in case the state + file is empty or lacks a required output. + +## Attributes Reference + +In addition to the above, the following attributes are exported: + +* (v0.12+) `outputs` - An object containing every root-level + [output](/language/values/outputs) in the remote state. +* (<= v0.11) `` - Each root-level [output](/language/values/outputs) + in the remote state appears as a top level attribute on the data source. + +## Root Outputs Only + +Only the root-level output values from the remote state snapshot are exposed +for use elsewhere in your module. Resource data and output values from nested +modules are not accessible. + +If you wish to make a nested module output value accessible as a root module +output value, you must explicitly configure a passthrough in the root module. +For example: + +For example: + +```hcl +module "app" { + source = "..." +} + +output "app_value" { + # This syntax is for Terraform 0.12 or later. + value = module.app.example +} +``` + +In this example, the output value named `example` from the "app" module is +available as the `app_value` root module output value. If this configuration +didn't include the `output "app_value"` block then the data would not be +accessible via `terraform_remote_state`. + +~> **Warning:** Although `terraform_remote_state` doesn't expose any other +state snapshot information for use in configuration, the state snapshot data +is a single object and so any user or server which has enough access to read +the root module output values will also always have access to the full state +snapshot data by direct network requests. Don't use `terraform_remote_state` +if any of the resources in your configuration work with data that you consider +sensitive. diff --git a/website/docs/language/state/remote.html.md b/website/docs/language/state/remote.mdx similarity index 84% rename from website/docs/language/state/remote.html.md rename to website/docs/language/state/remote.mdx index 998b479452fd..f06dd22f048d 100644 --- a/website/docs/language/state/remote.html.md +++ b/website/docs/language/state/remote.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "State: Remote Storage" -sidebar_current: "docs-state-remote" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'State: Remote Storage' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # Remote State @@ -19,13 +18,13 @@ which can then be shared between all members of a team. Terraform supports storing state in [Terraform Cloud](https://www.hashicorp.com/products/terraform/), [HashiCorp Consul](https://www.consul.io/), Amazon S3, Azure Blob Storage, Google Cloud Storage, Alibaba Cloud OSS, and more. -Remote state is implemented by a [backend](/docs/language/settings/backends/index.html), +Remote state is implemented by a [backend](/language/settings/backends/), which you can configure in your configuration's root module. ## Delegation and Teamwork Remote state allows you to share -[output values](/docs/language/values/outputs.html) with other configurations. +[output values](/language/values/outputs) with other configurations. This allows your infrastructure to be decomposed into smaller components. Put another way, remote state also allows teams to share infrastructure @@ -39,7 +38,7 @@ you can expose things such as VPC IDs, subnets, NAT instance IDs, etc. through remote state and have other Terraform states consume that. For example usage, see -[the `terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +[the `terraform_remote_state` data source](/language/state/remote-state-data). While remote state can be a convenient, built-in mechanism for sharing data between configurations, you may prefer to use more general stores to @@ -53,7 +52,7 @@ another that consumes those values using ## Locking and Teamwork For fully-featured remote backends, Terraform can also use -[state locking](/docs/language/state/locking.html) to prevent concurrent runs of +[state locking](/language/state/locking) to prevent concurrent runs of Terraform against the same state. [Terraform Cloud by HashiCorp](https://www.hashicorp.com/products/terraform/) diff --git a/website/docs/language/state/sensitive-data.html.md b/website/docs/language/state/sensitive-data.mdx similarity index 79% rename from website/docs/language/state/sensitive-data.html.md rename to website/docs/language/state/sensitive-data.mdx index 49f5c1270675..73cb17b98fd7 100644 --- a/website/docs/language/state/sensitive-data.html.md +++ b/website/docs/language/state/sensitive-data.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "State: Sensitive Data" -sidebar_current: "docs-state-sensitive-data" -description: |- - Sensitive data in Terraform state. +page_title: 'State: Sensitive Data' +description: Sensitive data in Terraform state. --- # Sensitive Data in State @@ -15,7 +12,7 @@ passwords. When using local state, state is stored in plain-text JSON files. -When using [remote state](/docs/language/state/remote.html), state is only ever held in +When using [remote state](/language/state/remote), state is only ever held in memory when used by Terraform. It may be encrypted at rest, but this depends on the specific remote state backend. @@ -30,10 +27,10 @@ and some backends can be configured to encrypt the state data at rest. For example: -- [Terraform Cloud](/docs/cloud/index.html) always encrypts state at rest and +- [Terraform Cloud](/cloud-docs/) always encrypts state at rest and protects it with TLS in transit. Terraform Cloud also knows the identity of the user requesting state and maintains a history of state changes. This can - be used to control access and track activity. [Terraform Enterprise](/docs/enterprise/index.html) + be used to control access and track activity. [Terraform Enterprise](/enterprise/) also supports detailed audit logging. - The S3 backend supports encryption at rest when the `encrypt` option is enabled. IAM policies and logging can be used to identify any invalid access. diff --git a/website/docs/language/state/workspaces.html.md b/website/docs/language/state/workspaces.mdx similarity index 84% rename from website/docs/language/state/workspaces.html.md rename to website/docs/language/state/workspaces.mdx index a675d8edde67..2ab0c7976323 100644 --- a/website/docs/language/state/workspaces.html.md +++ b/website/docs/language/state/workspaces.mdx @@ -1,16 +1,15 @@ --- -layout: "language" -page_title: "State: Workspaces" -sidebar_current: "docs-state-workspaces" -description: |- - Workspaces allow the use of multiple states with a single configuration directory. +page_title: 'State: Workspaces' +description: >- + Workspaces allow the use of multiple states with a single configuration + directory. --- # Workspaces -Each Terraform configuration has an associated [backend](/docs/language/settings/backends/index.html) +Each Terraform configuration has an associated [backend](/language/settings/backends/) that defines how operations are executed and where persistent data such as -[the Terraform state](https://www.terraform.io/docs/language/state/purpose.html) are +[the Terraform state](/language/state/purpose) are stored. The persistent data stored in the backend belongs to a _workspace_. Initially @@ -25,17 +24,17 @@ credentials. Multiple workspaces are currently supported by the following backends: - * [AzureRM](/docs/language/settings/backends/azurerm.html) - * [Consul](/docs/language/settings/backends/consul.html) - * [COS](/docs/language/settings/backends/cos.html) - * [etcdv3](/docs/language/settings/backends/etcdv3.html) - * [GCS](/docs/language/settings/backends/gcs.html) - * [Kubernetes](/docs/language/settings/backends/kubernetes.html) - * [Local](/docs/language/settings/backends/local.html) - * [Manta](/docs/language/settings/backends/manta.html) - * [Postgres](/docs/language/settings/backends/pg.html) - * [Remote](/docs/language/settings/backends/remote.html) - * [S3](/docs/language/settings/backends/s3.html) +* [AzureRM](/language/settings/backends/azurerm) +* [Consul](/language/settings/backends/consul) +* [COS](/language/settings/backends/cos) +* [etcdv3](/language/settings/backends/etcdv3) +* [GCS](/language/settings/backends/gcs) +* [Kubernetes](/language/settings/backends/kubernetes) +* [Local](/language/settings/backends/local) +* [Manta](/language/settings/backends/manta) +* [Postgres](/language/settings/backends/pg) +* [Remote](/language/settings/backends/remote) +* [S3](/language/settings/backends/s3) In the 0.9 line of Terraform releases, this concept was known as "environment". It was renamed in 0.10 based on feedback about confusion caused by the @@ -44,10 +43,10 @@ organizations that use Terraform. -> **Note**: The Terraform CLI workspace concept described in this document is different from but related to the Terraform Cloud -[workspace](/docs/cloud/workspaces/index.html) concept. +[workspace](/cloud-docs/workspaces/) concept. If you use multiple Terraform CLI workspaces in a single Terraform configuration and are migrating that configuration to Terraform Cloud, see this [migration -document](/docs/cloud/migrate/workspaces.html). +document](/cloud-docs/migrate/workspaces). ## Using Workspaces @@ -82,7 +81,7 @@ Within your Terraform configuration, you may include the name of the current workspace using the `${terraform.workspace}` interpolation sequence. This can be used anywhere interpolations are allowed. However, it should **not** be used in remote operations against Terraform Cloud workspaces. For an -explanation, see the [remote backend](/docs/language/settings/backends/remote.html#workspaces) +explanation, see the [remote backend](/language/settings/backends/remote#workspaces) document. Referencing the current workspace is useful for changing behavior based @@ -147,7 +146,7 @@ In this case, the backend used for each deployment often belongs to that deployment, with different credentials and access controls. Named workspaces are _not_ a suitable isolation mechanism for this scenario. -Instead, use one or more [re-usable modules](/docs/language/modules/develop/index.html) to +Instead, use one or more [re-usable modules](/language/modules/develop/) to represent the common elements, and then represent each instance as a separate configuration that instantiates those common elements in the context of a different backend. In that case, the root module of each configuration will @@ -177,7 +176,7 @@ another using paired resources types and data sources. For example: * If a Terraform state for one configuration is stored in a remote backend that is accessible to other configurations then - [`terraform_remote_state`](/docs/language/state/remote-state-data.html) + [`terraform_remote_state`](/language/state/remote-state-data) can be used to directly consume its root module outputs from those other configurations. This creates a tighter coupling between configurations, but avoids the need for the "producer" configuration to explicitly @@ -195,9 +194,9 @@ local-only `terraform.tfstate`; some teams commit these files to version control, although using a remote backend instead is recommended when there are multiple collaborators. -For [remote state](/docs/language/state/remote.html), the workspaces are stored -directly in the configured [backend](/docs/language/settings/backends/index.html). For example, if you -use [Consul](/docs/language/settings/backends/consul.html), the workspaces are stored +For [remote state](/language/state/remote), the workspaces are stored +directly in the configured [backend](/language/settings/backends/). For example, if you +use [Consul](/language/settings/backends/consul), the workspaces are stored by appending the workspace name to the state path. To ensure that workspace names are stored correctly and safely in all backends, the name must be valid to use in a URL path segment without escaping. diff --git a/website/docs/language/syntax/configuration.html.md b/website/docs/language/syntax/configuration.mdx similarity index 92% rename from website/docs/language/syntax/configuration.html.md rename to website/docs/language/syntax/configuration.mdx index 5dd06b28ef8e..d00e3b341ecb 100644 --- a/website/docs/language/syntax/configuration.html.md +++ b/website/docs/language/syntax/configuration.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Syntax - Configuration Language" -sidebar_current: "docs-config-syntax" -description: "Key constructs of the native Terraform language syntax, including identifiers, arguments, blocks, and comments." +page_title: Syntax - Configuration Language +description: >- + Key constructs of the native Terraform language syntax, including identifiers, + arguments, blocks, and comments. +sidebar_title: Syntax --- # Configuration Syntax @@ -15,7 +16,7 @@ those constructs are built from. This page describes the _native syntax_ of the Terraform language, which is a rich language designed to be relatively easy for humans to read and write. The constructs in the Terraform language can also be expressed in -[JSON syntax](/docs/language/syntax/json.html), which is harder for humans +[JSON syntax](/language/syntax/json), which is harder for humans to read and edit but easier to generate and parse programmatically. This low-level syntax of the Terraform language is defined in terms of a @@ -46,7 +47,7 @@ after the equals sign is the argument's value. The context where the argument appears determines what value types are valid (for example, each resource type has a schema that defines the types of its arguments), but many arguments accept arbitrary -[expressions](/docs/language/expressions/index.html), which allow the value to +[expressions](/language/expressions/), which allow the value to either be specified literally or generated from other values programmatically. -> **Note:** Terraform's configuration language is based on a more general diff --git a/website/docs/language/syntax/index.html.md b/website/docs/language/syntax/index.mdx similarity index 53% rename from website/docs/language/syntax/index.html.md rename to website/docs/language/syntax/index.mdx index ccd8a67d950e..b3d7c1644f99 100644 --- a/website/docs/language/syntax/index.html.md +++ b/website/docs/language/syntax/index.mdx @@ -1,7 +1,9 @@ --- -layout: "language" -page_title: "Syntax Overview - Configuration Language" -description: "Terraform language syntax for both the native and JSON variants. Also learn formatting conventions that you can enforce with terraform fmt." +page_title: Syntax Overview - Configuration Language +description: >- + Terraform language syntax for both the native and JSON variants. Also learn + formatting conventions that you can enforce with terraform fmt. +sidebar_title: Syntax Overview --- # Syntax @@ -10,13 +12,13 @@ The majority of the Terraform language documentation focuses on the practical uses of the language and the specific constructs it uses. The pages in this section offer a more abstract view of the Terraform language. -- [Configuration Syntax](/docs/language/syntax/configuration.html) describes the native +- [Configuration Syntax](/language/syntax/configuration) describes the native grammar of the Terraform language. -- [JSON Configuration Syntax](/docs/language/syntax/json.html) documents +- [JSON Configuration Syntax](/language/syntax/json) documents how to represent Terraform language constructs in the pure JSON variant of the Terraform language. Terraform's JSON syntax is unfriendly to humans, but can be very useful when generating infrastructure as code with other systems that don't have a readily available HCL library. -- [Style Conventions](/docs/language/syntax/style.html) documents some commonly +- [Style Conventions](/language/syntax/style) documents some commonly accepted formatting guidelines for Terraform code. These conventions can be - enforced automatically with [`terraform fmt`](/docs/cli/commands/fmt.html). + enforced automatically with [`terraform fmt`](/cli/commands/fmt). diff --git a/website/docs/language/syntax/json.html.md b/website/docs/language/syntax/json.mdx similarity index 95% rename from website/docs/language/syntax/json.html.md rename to website/docs/language/syntax/json.mdx index 32a69578eac4..2527511faf43 100644 --- a/website/docs/language/syntax/json.html.md +++ b/website/docs/language/syntax/json.mdx @@ -1,14 +1,15 @@ --- -layout: "language" -page_title: "JSON Configuration Syntax - Configuration Language" -sidebar_current: "docs-config-syntax-json" -description: "Learn about the JSON-compatible language syntax, including file structure, expression mapping, block mapping, and block-type-specific exceptions." +page_title: JSON Configuration Syntax - Configuration Language +description: >- + Learn about the JSON-compatible language syntax, including file structure, + expression mapping, block mapping, and block-type-specific exceptions. +sidebar_title: JSON Configuration Syntax --- # JSON Configuration Syntax Most Terraform configurations are written in -[the native Terraform language syntax](/docs/language/syntax/configuration.html), which is designed to be +[the native Terraform language syntax](/language/syntax/configuration), which is designed to be relatively easy for humans to read and update. Terraform also supports an alternative syntax that is JSON-compatible. This @@ -92,7 +93,7 @@ different (see the [block-type-specific exceptions](#block-type-specific-excepti correspond either to argument names or to nested block type names. * Where a property corresponds to an argument that accepts - [arbitrary expressions](/docs/language/expressions/index.html) in the native syntax, the + [arbitrary expressions](/language/expressions/) in the native syntax, the property value is mapped to an expression as described under [_Expression Mapping_](#expression-mapping) below. For arguments that do _not_ accept arbitrary expressions, the interpretation of the property @@ -109,7 +110,7 @@ different (see the [block-type-specific exceptions](#block-type-specific-excepti ## Expression Mapping Since JSON grammar is not able to represent all of the Terraform language -[expression syntax](/docs/language/expressions/index.html), JSON values interpreted as expressions +[expression syntax](/language/expressions/), JSON values interpreted as expressions are mapped as follows: | JSON | Terraform Language Interpretation | @@ -121,7 +122,7 @@ are mapped as follows: | Array | Each element is mapped per this table, producing a `tuple(...)` value with suitable element types. | | Null | A literal `null`. | -[string template]: /docs/language/expressions/strings.html#string-templates +[string template]: /language/expressions/strings#string-templates When a JSON string is encountered in a location where arbitrary expressions are expected, its value is first parsed as a [string template][] @@ -259,7 +260,7 @@ preserved exactly. ### Comment Properties Although we do not recommend hand-editing of JSON syntax configuration files --- this format is primarily intended for programmatic generation and consumption -- +\-- this format is primarily intended for programmatic generation and consumption -- a limited form of _comments_ are allowed inside JSON objects that represent block bodies using a special property name: diff --git a/website/docs/language/syntax/style.html.md b/website/docs/language/syntax/style.mdx similarity index 76% rename from website/docs/language/syntax/style.html.md rename to website/docs/language/syntax/style.mdx index bbbf090f7596..0e9701d40715 100644 --- a/website/docs/language/syntax/style.html.md +++ b/website/docs/language/syntax/style.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Style Conventions - Configuration Language" -sidebar_current: "docs-config-style" -description: "Learn recommended formatting conventions for the Terraform language and a command to automatically enforce them." +page_title: Style Conventions - Configuration Language +description: >- + Learn recommended formatting conventions for the Terraform language and a + command to automatically enforce them. +sidebar_title: Style Conventions --- # Style Conventions @@ -14,17 +15,17 @@ for consistency between files and modules written by different teams. Automatic source code formatting tools may apply these conventions automatically. --> **Note**: You can enforce these conventions automatically by running [`terraform fmt`](/docs/cli/commands/fmt.html). +-> **Note**: You can enforce these conventions automatically by running [`terraform fmt`](/cli/commands/fmt). * Indent two spaces for each nesting level. * When multiple arguments with single-line values appear on consecutive lines at the same nesting level, align their equals signs: - ```hcl - ami = "abc123" - instance_type = "t2.micro" - ``` + ```hcl + ami = "abc123" + instance_type = "t2.micro" + ``` * When both arguments and blocks appear together inside a block body, place all of the arguments together at the top and then place nested @@ -39,22 +40,22 @@ automatically. meta-argument blocks _last_ and separate them from other blocks with one blank line. - ```hcl - resource "aws_instance" "example" { - count = 2 # meta-argument first + ```hcl + resource "aws_instance" "example" { + count = 2 # meta-argument first - ami = "abc123" - instance_type = "t2.micro" + ami = "abc123" + instance_type = "t2.micro" - network_interface { - # ... - } + network_interface { + # ... + } - lifecycle { # meta-argument block last - create_before_destroy = true - } + lifecycle { # meta-argument block last + create_before_destroy = true } - ``` + } + ``` * Top-level blocks should always be separated from one another by one blank line. Nested blocks should also be separated by blank lines, except @@ -68,4 +69,3 @@ automatically. `ephemeral_block_device` on `aws_instance` form a family of block types describing AWS block devices, and can therefore be grouped together and mixed.) - diff --git a/website/docs/language/v1-compatibility-promises.html.md b/website/docs/language/v1-compatibility-promises.mdx similarity index 88% rename from website/docs/language/v1-compatibility-promises.html.md rename to website/docs/language/v1-compatibility-promises.mdx index a44a8b3f63ee..1c01f991d77e 100644 --- a/website/docs/language/v1-compatibility-promises.html.md +++ b/website/docs/language/v1-compatibility-promises.mdx @@ -1,7 +1,5 @@ --- -layout: "language" -page_title: "Terraform v1.0 Compatibility Promises" -sidebar_current: "docs-v1-compatibility" +page_title: Terraform v1.0 Compatibility Promises description: |- From Terraform v1.0 onwards the Terraform team promises to preserve backward compatibility for most of the Terraform language and the primary CLI @@ -68,35 +66,35 @@ The following top-level blocks and their defined "meta-arguments" (that is, arguments defined by Terraform Core rather than by external plugins such as providers) will retain their current functionality: -* [`resource`](/docs/language/resources/) and - [`data`](/docs/language/data-sources/) blocks to +* [`resource`](/language/resources/) and + [`data`](/language/data-sources/) blocks to declare resources, including their nested block types `lifecycle`, `connection`, and `provisioner`, and their meta-argument `provider`. -* [`module`](/docs/language/modules/syntax.html) blocks to call other modules, +* [`module`](/language/modules/syntax) blocks to call other modules, and its meta-argument `providers`. -* The [`count`](/docs/language/meta-arguments/count.html), - [`for_each`](/docs/language/meta-arguments/for_each.html), and - [`depends_on`](/docs/language/meta-arguments/depends_on.html) meta-arguments +* The [`count`](/language/meta-arguments/count), + [`for_each`](/language/meta-arguments/for_each), and + [`depends_on`](/language/meta-arguments/depends_on) meta-arguments in `resource`, `data`, and `module` blocks. -* [`provider`](/docs/language/providers/configuration.html) blocks to configure +* [`provider`](/language/providers/configuration) blocks to configure providers, and the `alias` meta-argument. -* [`variable`](/docs/language/values/variables.html#declaring-an-input-variable), - [`output`](/docs/language/values/outputs.html#declaring-an-output-value), and - [`locals`](/docs/language/values/locals.html#declaring-a-local-value) blocks +* [`variable`](/language/values/variables#declaring-an-input-variable), + [`output`](/language/values/outputs#declaring-an-output-value), and + [`locals`](/language/values/locals#declaring-a-local-value) blocks for declaring the various kinds of named values in a module. -* [`terraform`](/docs/language/settings/) blocks, including the nested - [`required_version`](/docs/language/settings/index.html#specifying-a-required-terraform-version) +* [`terraform`](/language/settings/) blocks, including the nested + [`required_version`](/language/settings/#specifying-a-required-terraform-version) and - [`required_providers`](/docs/language/providers/requirements.html#requiring-providers) + [`required_providers`](/language/providers/requirements#requiring-providers) arguments, and nested - [`backend`](/docs/language/settings/backends/configuration.html#using-a-backend-block) + [`backend`](/language/settings/backends/configuration#using-a-backend-block) blocks for backend configuration. We also intend to keep compatibility with all -[expression operators](/docs/language/expressions/) and -[built-in functions](/docs/language/functions/), with the exception of +[expression operators](/language/expressions/) and +[built-in functions](/language/functions/), with the exception of references to -[`terraform.workspace`](/docs/language/expressions/references.html#terraform-workspace), +[`terraform.workspace`](/language/expressions/references#terraform-workspace), whose behavior may change as part of future changes to the workspace model. We intend to retain broad compatibility with Terraform language features, with @@ -104,17 +102,17 @@ a few specific caveats: * We consider a configuration to be valid if Terraform can create and apply a plan for it without reporting any errors. - - A configuration that currently produces errors might generate different - errors or exhibit other non-error behaviors in a future version of - Terraform. A configuration that generates errors during the apply phase - might generate similar errors at an earlier phase in future, because - we generally consider it better to detect errors in as early a phase as - possible. - - Generally-speaking, the compatibility promises described in this document - apply only to valid configurations. Handling of invalid configurations is - always subject to change in future Terraform releases. + + A configuration that currently produces errors might generate different + errors or exhibit other non-error behaviors in a future version of + Terraform. A configuration that generates errors during the apply phase + might generate similar errors at an earlier phase in future, because + we generally consider it better to detect errors in as early a phase as + possible. + + Generally-speaking, the compatibility promises described in this document + apply only to valid configurations. Handling of invalid configurations is + always subject to change in future Terraform releases. * If the actual behavior of a feature differs from what we explicitly documented as the feature's behavior, we will usually treat that as a bug and change the feature to match the documentation, although we will avoid @@ -192,18 +190,18 @@ if you are still using a Terraform v1.x release. ### Provider Installation Methods Terraform normally installs providers from a provider registry implementing -[the Provider Registry Protocol](/docs/internals/provider-registry-protocol.html), +[the Provider Registry Protocol](/internals/provider-registry-protocol), version 1. All Terraform v1.x releases will remain compatible with that protocol, and so correctly-implemented provider registries will stay compatible. Terraform also supports installation of providers from -[local filesystem directories](/docs/cli/config/config-file.html#filesystem_mirror) +[local filesystem directories](/cli/config/config-file#filesystem_mirror) (filesystem mirrors) and from -[network mirrors](/docs/cli/config/config-file.html#network_mirror) -(implementing [the Provider Mirror Protocol](/docs/internals/provider-network-mirror-protocol.html). +[network mirrors](/cli/config/config-file#network_mirror) +(implementing [the Provider Mirror Protocol](/internals/provider-network-mirror-protocol). All Terraform v1.x releases will remain compatible with those installation methods, including -[the Implied Local Mirror Directories](/docs/cli/config/config-file.html#implied-local-mirror-directories). +[the Implied Local Mirror Directories](/cli/config/config-file#implied-local-mirror-directories). Specific provider registries or network mirrors are run independently from Terraform itself and so their own behaviors are not subject to these @@ -239,11 +237,11 @@ and of Terraform itself. ### Module Installation Methods Terraform supports installing child modules from a number of different -[module source types](/docs/language/modules/sources.html). We will continue +[module source types](/language/modules/sources). We will continue to support all of the existing source types throughout the v1.x releases. One of the supported source types is a module registry implementing -[the Module Registry Protocol](/docs/internals/module-registry-protocol.html) +[the Module Registry Protocol](/internals/module-registry-protocol) version 1. All Terraform v1.x releases will remain compatible with correct implementations of that protocol. @@ -286,6 +284,7 @@ For historical reasons, all supported state storage backends are included as part of Terraform CLI but not all are supported directly by the Terraform Team. Only the following backends maintained by the Terraform team are subject to compatibility promises: + * `local` (the default, when you are not using remote state) * `http` @@ -388,7 +387,7 @@ As noted above, compatibility with external software is limited to explicitly-machine-readable output (`-json` and `-raw` modes) and exit codes. Any natural-language output from these commands might change in later releases. -* [`init`](/docs/cli/commands/init.html) +* [`init`](/cli/commands/init) * `-backend=false` * `-backend-config=FILE` * `-backend-config="KEY=VALUE"` @@ -400,10 +399,10 @@ Any natural-language output from these commands might change in later releases. * `-plugin-dir=DIR` * `-reconfigure` * `-upgrade` -* [`validate`](/docs/cli/commands/validate.html) +* [`validate`](/cli/commands/validate) * `-json` * `-no-color` -* [`plan`](/docs/cli/commands/plan.html) +* [`plan`](/cli/commands/plan) * `-compact-warnings` * `-destroy` * `-detailed-exitcode` @@ -420,7 +419,7 @@ Any natural-language output from these commands might change in later releases. * `-target=ADDRESS` * `-var 'NAME=VALUE'` * `-var-file=FILE` -* [`apply`](/docs/cli/commands/apply.html) +* [`apply`](/cli/commands/apply) * `-auto-approve` * `-compact-warnings` * `-lock=false` @@ -435,53 +434,53 @@ Any natural-language output from these commands might change in later releases. * `-target=ADDRESS` * `-var 'NAME=VALUE'` * `-var-file=FILE` -* [`show`](/docs/cli/commands/show.html) +* [`show`](/cli/commands/show) * `-no-color` * `-json` * (both with and without a plan file) -* [`providers`](/docs/cli/commands/providers.html) (with no subcommand) -* [`providers lock`](/docs/cli/commands/providers/lock.html) +* [`providers`](/cli/commands/providers) (with no subcommand) +* [`providers lock`](/cli/commands/providers/lock) * `-fs-mirror=PATH` * `-net-mirror=URL` * `-platform=OS_ARCH` -* [`providers mirror`](/docs/cli/commands/providers/mirror.html) +* [`providers mirror`](/cli/commands/providers/mirror) * `-platform=OS_ARCH` -* [`providers schema`](/docs/cli/commands/providers/schema.html) +* [`providers schema`](/cli/commands/providers/schema) * `-json` -* [`fmt`](/docs/cli/commands/fmt.html) +* [`fmt`](/cli/commands/fmt) * `-list=false` * `-write=false` * `-diff` * `-recursive` * `-check` -* [`version`](/docs/cli/commands/version.html) +* [`version`](/cli/commands/version) * `-json` -* [`output`](/docs/cli/commands/output.html) +* [`output`](/cli/commands/output) * `-no-color` * `-json` * `-raw` -* [`taint`](/docs/cli/commands/taint.html) +* [`taint`](/cli/commands/taint) * `-allow-missing` * `-lock=false` * `-lock-timeout=DURATION` * `-ignore-remote-version` -* [`untaint`](/docs/cli/commands/untaint.html) +* [`untaint`](/cli/commands/untaint) * `-allow-missing` * `-lock=false` * `-lock-timeout=DURATION` * `-ignore-remote-version` -* [`force-unlock`](/docs/cli/commands/force-unlock.html) +* [`force-unlock`](/cli/commands/force-unlock) * `-force` -* [`state list`](/docs/cli/commands/state/list.html) +* [`state list`](/cli/commands/state/list) * `-id=ID` -* [`state pull`](/docs/cli/commands/state/pull.html) -* [`state push`](/docs/cli/commands/state/push.html) +* [`state pull`](/cli/commands/state/pull) +* [`state push`](/cli/commands/state/push) * `-force` * `-lock=false` * `-lock-timeout=DURATION` -* [`state show`](/docs/cli/commands/state/show.html) +* [`state show`](/cli/commands/state/show) * `-ignore-remote-version` -* [`login`](/docs/cli/commands/login.html) +* [`login`](/cli/commands/login) For commands or options not in the above list, we will still avoid breaking changes where possible, but can't promise full compatibility throughout the diff --git a/website/docs/language/values/index.html.md b/website/docs/language/values/index.html.md deleted file mode 100644 index 3074f965c80b..000000000000 --- a/website/docs/language/values/index.html.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: "language" -page_title: "Variables and Outputs" -description: "An overview of input variables, output values, and local values in Terraform language." ---- - -# Variables and Outputs - -The Terraform language includes a few kinds of blocks for requesting or -publishing named values. - -- [Input Variables](/docs/language/values/variables.html) serve as parameters for - a Terraform module, so users can customize behavior without editing the source. - -- [Output Values](/docs/language/values/outputs.html) are like return values for a - Terraform module. - -- [Local Values](/docs/language/values/locals.html) are a convenience feature for - assigning a short name to an expression. diff --git a/website/docs/language/values/index.mdx b/website/docs/language/values/index.mdx new file mode 100644 index 000000000000..d271492c3150 --- /dev/null +++ b/website/docs/language/values/index.mdx @@ -0,0 +1,20 @@ +--- +page_title: Variables and Outputs +description: >- + An overview of input variables, output values, and local values in Terraform + language. +--- + +# Variables and Outputs + +The Terraform language includes a few kinds of blocks for requesting or +publishing named values. + +- [Input Variables](/language/values/variables) serve as parameters for + a Terraform module, so users can customize behavior without editing the source. + +- [Output Values](/language/values/outputs) are like return values for a + Terraform module. + +- [Local Values](/language/values/locals) are a convenience feature for + assigning a short name to an expression. diff --git a/website/docs/language/values/locals.html.md b/website/docs/language/values/locals.mdx similarity index 74% rename from website/docs/language/values/locals.html.md rename to website/docs/language/values/locals.mdx index a487698bfce4..41813cc21dd0 100644 --- a/website/docs/language/values/locals.html.md +++ b/website/docs/language/values/locals.mdx @@ -1,25 +1,26 @@ --- -layout: "language" -page_title: "Local Values - Configuration Language" -sidebar_current: "docs-config-locals" -description: "Local values assign a name to an expression that can be used multiple times within a Terraform module." +page_title: Local Values - Configuration Language +description: >- + Local values assign a name to an expression that can be used multiple times + within a Terraform module. +sidebar_title: Local Values --- # Local Values > **Hands-on:** Try the [Simplify Terraform Configuration with -Locals](https://learn.hashicorp.com/tutorials/terraform/locals?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) -tutorial on HashiCorp Learn. +> Locals](https://learn.hashicorp.com/tutorials/terraform/locals?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) +> tutorial on HashiCorp Learn. -A local value assigns a name to an [expression](/docs/language/expressions/index.html), +A local value assigns a name to an [expression](/language/expressions/), so you can use it multiple times within a module without repeating it. If you're familiar with traditional programming languages, it can be useful to compare Terraform modules to function definitions: -- [Input variables](./variables.html) are like function arguments. -- [Output values](./outputs.html) are like function return values. +- [Input variables](/language/values/variables) are like function arguments. +- [Output values](/language/values/outputs) are like function return values. - Local values are like a function's temporary local variables. -> **Note:** For brevity, local values are often referred to as just "locals" @@ -59,7 +60,7 @@ locals { ## Using Local Values Once a local value is declared, you can reference it in -[expressions](/docs/language/expressions/index.html) as `local.`. +[expressions](/language/expressions/) as `local.`. -> **Note:** Local values are _created_ by a `locals` block (plural), but you _reference_ them as attributes on an object named `local` (singular). Make sure diff --git a/website/docs/language/values/outputs.html.md b/website/docs/language/values/outputs.mdx similarity index 87% rename from website/docs/language/values/outputs.html.md rename to website/docs/language/values/outputs.mdx index 824929fd5b6b..2cd32a977582 100644 --- a/website/docs/language/values/outputs.html.md +++ b/website/docs/language/values/outputs.mdx @@ -1,9 +1,7 @@ --- -layout: "language" -page_title: "Output Values - Configuration Language" -sidebar_current: "docs-config-outputs" -description: |- - Output values are the return values of a Terraform module. +page_title: Output Values - Configuration Language +description: Output values are the return values of a Terraform module. +sidebar_title: Output Values --- # Output Values @@ -13,8 +11,8 @@ command line, and can expose information for other Terraform configurations to use. Output values are similar to return values in programming languages. > **Hands-on:** Try the [Output Data From -Terraform](https://learn.hashicorp.com/tutorials/terraform/outputs) -tutorial on HashiCorp Learn. +> Terraform](https://learn.hashicorp.com/tutorials/terraform/outputs) +> tutorial on HashiCorp Learn. Output values have several uses: @@ -22,9 +20,9 @@ Output values have several uses: to a parent module. - A root module can use outputs to print certain values in the CLI output after running `terraform apply`. -- When using [remote state](/docs/language/state/remote.html), root module outputs can be +- When using [remote state](/language/state/remote), root module outputs can be accessed by other configurations via a - [`terraform_remote_state` data source](/docs/language/state/remote-state-data.html). + [`terraform_remote_state` data source](/language/state/remote-state-data). Resource instances managed by Terraform each export attributes whose values can be used elsewhere in configuration. Output values are a way to expose some @@ -45,11 +43,11 @@ output "instance_ip_addr" { ``` The label immediately after the `output` keyword is the name, which must be a -valid [identifier](/docs/language/syntax/configuration.html#identifiers). In a root module, this name is +valid [identifier](/language/syntax/configuration#identifiers). In a root module, this name is displayed to the user; in a child module, it can be used to access the output's value. -The `value` argument takes an [expression](/docs/language/expressions/index.html) +The `value` argument takes an [expression](/language/expressions/) whose result is to be returned to the user. In this example, the expression refers to the `private_ip` attribute exposed by an `aws_instance` resource defined elsewhere in this module (not shown). Any valid expression is allowed @@ -156,10 +154,10 @@ value in the list of outputs at the end of `terraform apply`. However, the value could still display in the CLI output for other reasons, like if the value is referenced in an expression for a resource argument. -Terraform will still record sensitive values in the [state](/docs/language/state/index.html), +Terraform will still record sensitive values in the [state](/language/state/), and so anyone who can access the state data will have access to the sensitive values in cleartext. For more information, see -[_Sensitive Data in State_](/docs/language/state/sensitive-data.html). +[_Sensitive Data in State_](/language/state/sensitive-data). @@ -175,7 +173,7 @@ correctly determine the dependencies between resources defined in different modules. Just as with -[resource dependencies](/docs/language/resources/behavior.html#resource-dependencies), +[resource dependencies](/language/resources/behavior#resource-dependencies), Terraform analyzes the `value` expression for an output value and automatically determines a set of dependencies, but in less-common cases there are dependencies that cannot be recognized implicitly. In these rare cases, the diff --git a/website/docs/language/values/variables.html.md b/website/docs/language/values/variables.mdx similarity index 87% rename from website/docs/language/values/variables.html.md rename to website/docs/language/values/variables.mdx index a983192be0db..848ec9661b15 100644 --- a/website/docs/language/values/variables.html.md +++ b/website/docs/language/values/variables.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Input Variables - Configuration Language" -sidebar_current: "docs-config-variables" -description: "Input variables allow you to customize modules without altering their source code. Learn how to declare, define, and reference variables in configurations." +page_title: Input Variables - Configuration Language +description: >- + Input variables allow you to customize modules without altering their source + code. Learn how to declare, define, and reference variables in configurations. +sidebar_title: Input Variables --- # Input Variables @@ -15,22 +16,22 @@ Terraform configurations, making your module composable and reusable. When you declare variables in the root module of your configuration, you can set their values using CLI options and environment variables. -When you declare them in [child modules](/docs/language/modules/index.html), +When you declare them in [child modules](/language/modules/), the calling module should pass values in the `module` block. If you're familiar with traditional programming languages, it can be useful to compare Terraform modules to function definitions: -- Input variables are like function arguments. -- [Output values](./outputs.html) are like function return values. -- [Local values](./locals.html) are like a function's temporary local variables. +* Input variables are like function arguments. +* [Output values](/language/values/outputs) are like function return values. +* [Local values](/language/values/locals) are like a function's temporary local variables. -> **Note:** For brevity, input variables are often referred to as just "variables" or "Terraform variables" when it is clear from context what sort of variable is being discussed. Other kinds of variables in Terraform include _environment variables_ (set by the shell where Terraform runs) and _expression variables_ (used to indirectly represent a value in an -[expression](/docs/language/expressions/index.html)). +[expression](/language/expressions/)). ## Declaring an Input Variable @@ -68,23 +69,23 @@ be unique among all variables in the same module. This name is used to assign a value to the variable from outside and to reference the variable's value from within the module. -The name of a variable can be any valid [identifier](/docs/language/syntax/configuration.html#identifiers) +The name of a variable can be any valid [identifier](/language/syntax/configuration#identifiers) _except_ the following: `source`, `version`, `providers`, `count`, `for_each`, `lifecycle`, `depends_on`, `locals`. These names are reserved for meta-arguments in -[module configuration blocks](/docs/language/modules/syntax.html), and cannot be +[module configuration blocks](/language/modules/syntax), and cannot be declared as variable names. ## Arguments Terraform CLI defines the following optional arguments for variable declarations: -- [`default`][inpage-default] - A default value which then makes the variable optional. -- [`type`][inpage-type] - This argument specifies what value types are accepted for the variable. -- [`description`][inpage-description] - This specifies the input variable's documentation. -- [`validation`][inpage-validation] - A block to define validation rules, usually in addition to type constraints. -- [`sensitive`][inpage-sensitive] - Limits Terraform UI output when the variable is used in configuration. -- [`nullable`][inpage-nullable] - Specify if the variable can be `null` within the module. +* [`default`][inpage-default] - A default value which then makes the variable optional. +* [`type`][inpage-type] - This argument specifies what value types are accepted for the variable. +* [`description`][inpage-description] - This specifies the input variable's documentation. +* [`validation`][inpage-validation] - A block to define validation rules, usually in addition to type constraints. +* [`sensitive`][inpage-sensitive] - Limits Terraform UI output when the variable is used in configuration. +* [`nullable`][inpage-nullable] - Specify if the variable can be `null` within the module. ### Default values @@ -101,7 +102,7 @@ configuration. [inpage-type]: #type-constraints The `type` argument in a `variable` block allows you to restrict the -[type of value](/docs/language/expressions/types.html) that will be accepted as +[type of value](/language/expressions/types) that will be accepted as the value for a variable. If no type constraint is set then a value of any type is accepted. @@ -128,7 +129,7 @@ collections: The keyword `any` may be used to indicate that any type is acceptable. For more information on the meaning and behavior of these different types, as well as detailed information about automatic conversion of complex types, see -[Type Constraints](/docs/language/expressions/types.html). +[Type Constraints](/language/expressions/types). If both the `type` and `default` arguments are specified, the given default value must be convertible to the specified type. @@ -182,7 +183,7 @@ The expression can refer only to the variable that the condition applies to, and _must not_ produce errors. If the failure of an expression is the basis of the validation decision, use -[the `can` function](/docs/language/functions/can.html) to detect such errors. For example: +[the `can` function](/language/functions/can) to detect such errors. For example: ```hcl variable "image_id" { @@ -217,10 +218,10 @@ Setting a variable as `sensitive` prevents Terraform from showing its value in the `plan` or `apply` output, when you use that variable elsewhere in your configuration. -Terraform will still record sensitive values in the [state](/docs/language/state/index.html), +Terraform will still record sensitive values in the [state](/language/state/), and so anyone who can access the state data will have access to the sensitive values in cleartext. For more information, see -[_Sensitive Data in State_](/docs/language/state/sensitive-data.html). +[_Sensitive Data in State_](/language/state/sensitive-data). Declare a variable as sensitive by setting the `sensitive` argument to `true`: @@ -271,13 +272,13 @@ disclosing the content of one block might imply the content of a sibling block. ``` A provider can also -[declare an attribute as sensitive](/docs/extend/best-practices/sensitive-state.html#using-the-sensitive-flag), +[declare an attribute as sensitive](/plugin/sdkv2/best-practices/sensitive-state#using-the-sensitive-flag), which will cause Terraform to hide it from regular output regardless of how you assign it a value. For more information, see -[Sensitive Resource Attributes](/docs/language/expressions/references.html#sensitive-resource-attributes). +[Sensitive Resource Attributes](/language/expressions/references#sensitive-resource-attributes). If you use a sensitive value from as part of an -[output value](/docs/language/values/outputs.html) then Terraform will require +[output value](/language/values/outputs) then Terraform will require you to also mark the output value itself as sensitive, to confirm that you intended to export it. @@ -334,11 +335,10 @@ For variables of collection or structural types, such as lists or objects, the caller may still use `null` in nested elements or attributes, as long as the collection or structure itself is not null. - ## Using Input Variable Values Within the module that declared a variable, its value can be accessed from -within [expressions](/docs/language/expressions/index.html) as `var.`, +within [expressions](/language/expressions/) as `var.`, where `` matches the label given in the declaration block: -> **Note:** Input variables are _created_ by a `variable` block, but you @@ -359,7 +359,7 @@ the module where it was declared. When variables are declared in the root module of your configuration, they can be set in a number of ways: -* [In a Terraform Cloud workspace](/docs/cloud/workspaces/variables.html). +* [In a Terraform Cloud workspace](/cloud-docs/workspaces/variables). * Individually, with the `-var` command line option. * In variable definitions (`.tfvars`) files, either specified on the command line or automatically loaded. @@ -368,7 +368,7 @@ can be set in a number of ways: The following sections describe these options in more detail. This section does not apply to _child_ modules, where values for input variables are instead assigned in the configuration of their parent module, as described in -[_Modules_](/docs/language/modules/index.html). +[_Modules_](/language/modules/). ### Variables on the Command Line @@ -384,7 +384,7 @@ terraform apply -var='image_id_map={"us-east-1":"ami-abc123","us-east-2":"ami-de The above examples show appropriate syntax for Unix-style shells, such as on Linux or macOS. For more information on shell quoting, including additional examples for Windows Command Prompt, see -[Input Variables on the Command Line](/docs/cli/commands/plan.html#input-variables-on-the-command-line). +[Input Variables on the Command Line](/cli/commands/plan#input-variables-on-the-command-line). You can use the `-var` option multiple times in a single command to set several different variables. @@ -403,7 +403,7 @@ terraform apply -var-file="testing.tfvars" ``` -> **Note:** This is how Terraform Cloud passes -[workspace variables](/docs/cloud/workspaces/variables.html) to Terraform. +[workspace variables](/cloud-docs/workspaces/variables) to Terraform. A variable definitions file uses the same basic syntax as Terraform language files, but consists only of variable name assignments: @@ -457,7 +457,7 @@ and lower case letters as in the above example. When variable values are provided in a variable definitions file, you can use Terraform's usual syntax for -[literal expressions](/docs/language/expressions/types.html#literal-expressions) +[literal expressions](/language/expressions/types#literal-expressions) to assign complex-typed values, like lists and maps. Some special rules apply to the `-var` command line option and to environment @@ -483,7 +483,7 @@ For readability, and to avoid the need to worry about shell escaping, we recommend always setting complex variable values via variable definitions files. For more information on quoting and escaping for `-var` arguments, see -[Input Variables on the Command Line](/docs/cli/commands/plan.html#input-variables-on-the-command-line). +[Input Variables on the Command Line](/cli/commands/plan#input-variables-on-the-command-line). ### Values for Undeclared Variables @@ -516,7 +516,7 @@ Will cause Terraform to warn you that there is no variable declared `"mosse"`, w you spot this mistake. If you use `.tfvars` files across multiple configurations and expect to continue to see this warning, -you can use the [`-compact-warnings`](https://www.terraform.io/docs/cli/commands/plan.html#compact-warnings) +you can use the [`-compact-warnings`](/cli/commands/plan#compact-warnings) option to simplify your output. If you provide values for undeclared variables on the [command line](#variables-on-the-command-line), diff --git a/website/guides/core-workflow.html.md b/website/guides/core-workflow.mdx similarity index 93% rename from website/guides/core-workflow.html.md rename to website/guides/core-workflow.mdx index 2cd010ee58e6..982b026a8b5d 100644 --- a/website/guides/core-workflow.html.md +++ b/website/guides/core-workflow.mdx @@ -1,9 +1,7 @@ --- -layout: "intro" -page_title: "The Core Terraform Workflow - Guides" -sidebar_current: "guides-core-workflow" -description: |- - An overview of how individuals, teams, and organizations can use Terraform. +page_title: The Core Terraform Workflow - Guides +description: 'An overview of how individuals, teams, and organizations can use Terraform. ' +sidebar_title: The Core Terraform Workflow --- # The Core Terraform Workflow @@ -11,8 +9,8 @@ description: |- The core Terraform workflow has three steps: 1. **Write** - Author infrastructure as code. -2. **Plan** - Preview changes before applying. -3. **Apply** - Provision reproducible infrastructure. +1. **Plan** - Preview changes before applying. +1. **Apply** - Provision reproducible infrastructure. This guide walks through how each of these three steps plays out in the context of working as an individual practitioner, how they evolve when a team is @@ -184,7 +182,7 @@ requests should include an attached copy of speculative plan output generated by the change author. Others arrange for their CI system to post speculative plan output to pull requests automatically. -![Screenshot of Pull Request with manually posted Terraform plan output](guides/core-workflow/manually-pasted-plan-output.png) +![Screenshot of Pull Request with manually posted Terraform plan output](/img/docs/manually-pasted-plan-output.png) In addition to reviewing the plan for the proper expression of its author's intent, the team can also make an evaluation whether they want this change to @@ -233,7 +231,7 @@ for a better experience at each step. Terraform Cloud provides a centralized and secure location for storing input variables and state while also bringing back a tight feedback loop for speculative plans for config authors. Terraform configuration interacts with -Terraform Cloud via the ["remote" backend](/docs/language/settings/backends/remote.html). +Terraform Cloud via the ["remote" backend](/language/settings/backends/remote). ``` terraform { @@ -283,14 +281,14 @@ request indicate while the plan is in progress. Once the plan is complete, the status update indicates whether there were any changes in the speculative plan, right from the pull request view. -![Screenshot of Pull Request with resource changes in the status update](guides/core-workflow/pull-request.png) +![Screenshot of Pull Request with resource changes in the status update](/img/docs/pull-request.png) For certain types of changes, this information is all that's needed for a team member to be able to approve the pull request. When a teammate needs to do a full review of the plan, clicking the link to Terraform Cloud brings up a view that allows them to quickly analyze the full plan details. -![Screenshot of Pull Request run in Terraform Cloud](guides/core-workflow/pr-plan.png) +![Screenshot of Pull Request run in Terraform Cloud](/img/docs/pr-plan.png) This page allows the reviewer to quickly determine if the plan is matching the config author's intent and evaluate the risk of the change. @@ -300,17 +298,17 @@ config author's intent and evaluate the risk of the change. After merge, Terraform Cloud presents the concrete plan to the team for review and approval. -![Screenshot of concrete plan](guides/core-workflow/concrete-plan.png) +![Screenshot of concrete plan](/img/docs/concrete-plan.png) The team can discuss any outstanding questions about the plan before the change is made. -![Screenshot of back-and-forth in Terraform Cloud comments](guides/core-workflow/plan-comments.png) +![Screenshot of back-and-forth in Terraform Cloud comments](/img/docs/plan-comments.png) Once the Apply is confirmed, Terraform Cloud displays the progress live to anyone who'd like to watch. -![Screenshot of in-progress Apply](guides/core-workflow/in-progress-apply.png) +![Screenshot of in-progress Apply](/img/docs/in-progress-apply.png) Contact us at technologypartners@hashicorp.com with any questions or feedback. +-> Contact us at with any questions or feedback. diff --git a/website/guides/terraform-provider-development-program.html.md b/website/guides/terraform-provider-development-program.mdx similarity index 56% rename from website/guides/terraform-provider-development-program.html.md rename to website/guides/terraform-provider-development-program.mdx index 59d5ffc645d1..5b0ec0edd398 100644 --- a/website/guides/terraform-provider-development-program.html.md +++ b/website/guides/terraform-provider-development-program.mdx @@ -1,8 +1,9 @@ --- -layout: "extend" -page_title: "Terraform Provider Development Program" -sidebar_current: "guides-terraform-provider-development-program" -description: This guide is intended for vendors who're interested in having their platform supported by Terraform. The guide walks vendors through the steps involved in creating a provider and applying for it to be included with Terraform. +page_title: Terraform Provider Development Program +description: >- + This guide is intended for vendors who're interested in having their platform + supported by Terraform. The guide walks vendors through the steps involved in + creating a provider and applying for it to be included with Terraform. --- # Terraform Provider Development Program @@ -11,10 +12,9 @@ The Terraform Provider Development Program facilitates vendors in creating and p The Verified badge helps users easily identify and discover integrations developed and maintained directly by an integration’s vendor, establishing a level of trust for our users. This program is intended to be largely self-serve, with links to information sources, clearly defined steps, and checkpoints detailed below. -![Verified Provider Card](/assets/images/docs/verified-card.png) - --> **Building your own provider?** If you're building your own provider and aren't interested in having HashiCorp officially verify and regularly monitor your provider, please refer to the [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_medium=WEB_IOhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_offer=ARTICLE_PAGEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_content=DOCS) collection on HashiCorp Learn and the [Extending Terraform](https://www.terraform.io/docs/extend/index.html) section of the documentation. +![Verified Provider Card](/img/docs/verified-card.png) +-> **Building your own provider?** If you're building your own provider and aren't interested in having HashiCorp officially verify and regularly monitor your provider, please refer to the [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_medium=WEB_IOhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_offer=ARTICLE_PAGEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_content=DOCS) collection on HashiCorp Learn and the [Extending Terraform](/plugin/) section of the documentation. ## What is a Terraform Provider? @@ -24,72 +24,41 @@ A Terraform Provider represents an integration that is responsible for understan All providers integrate into and operate with Terraform exactly the same way. The table below is intended to help users understand who develops, and maintains a particular provider. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      TierDescriptionNamespace
      Official providers are owned and maintained by HashiCorp hashicorp
      Verified providers are owned and maintained by third-party technology partners. Providers in this tier indicate HashiCorp has verified the authenticity of the Provider’s publisher, and that the partner is a member of the HashiCorp Technology Partner Program.Third-party organization, e.g. mongodb/mongodbatlas
      Community providers are published to the Terraform Registry by individual maintainers, groups of maintainers, or other members of the Terraform community.
      Maintainer’s individual or organization account, e.g. DeviaVir/gsuite
      Archived Providers are Official or Verified Providers that are no longer maintained by HashiCorp or the community. This may occur if an API is deprecated or interest was low.hashicorp or third-party
      +

      - --> **Note:** This document focuses on the "Verified" Tier in the table above. Community contributors interested in contributing to existing providers or building new providers should refer to the [Publishing a Provider](https://www.terraform.io/docs/registry/providers/publishing.html) section of our documentation. - +-> **Note:** This document focuses on the "Verified" Tier in the table above. Community contributors interested in contributing to existing providers or building new providers should refer to the [Publishing a Provider](/registry/providers/publishing) section of our documentation. ## Provider Development Process The provider development process is divided into five steps below. By following these steps, providers can be developed alongside HashiCorp to ensure new providers are able to be published in Terraform as quickly as possible. -![Provider Development Process](/assets/images/docs/program-steps.png) +![Provider Development Process](/img/docs/program-steps.png) 1. **Apply**: Initial contact between vendor and HashiCorp -2. **Prepare**: Follow documentation while developing the provider -3. **Verify**: Share public GPG key with HashiCorp -4. **Publish**: Release the provider on the Registry -5. **Support**: Ongoing maintenance and support of the provider by the vendor. +1. **Prepare**: Follow documentation while developing the provider +1. **Verify**: Share public GPG key with HashiCorp +1. **Publish**: Release the provider on the Registry +1. **Support**: Ongoing maintenance and support of the provider by the vendor. ### 1. Apply -Please begin by completing our HashiCorp Technology Partner application: https://www.hashicorp.com/ecosystem/become-a-partner/#technology +Please begin by completing our HashiCorp Technology Partner application: Terraform has a large and active ecosystem of partners that may have already started working on the same provider. We'll do our best to connect similar parties to avoid duplicate efforts, and prepare for a successful and impactful launch of the integration. Once you have applied, a member of the HashiCorp Alliances team will be in touch, and will ask for your organization to sign our Technology Partner Agreement. - ### 2. Prepare -Detailed instructions for preparing a provider for publishing are available in our Registry documentation. Please see [Preparing your Provider](https://www.terraform.io/docs/registry/providers/publishing.html#preparing-your-provider). In order to provide a consistent and quality experience for users, please make sure detailed documentation for your provider is included. You can find more information on how to build and structure [provider documentation here](https://www.terraform.io/docs/registry/providers/docs.html). +Detailed instructions for preparing a provider for publishing are available in our Registry documentation. Please see [Preparing your Provider](/registry/providers/publishing#preparing-your-provider). In order to provide a consistent and quality experience for users, please make sure detailed documentation for your provider is included. You can find more information on how to build and structure [provider documentation here](/registry/providers/docs). We’ve found the provider development process to be fairly straightforward and simple when you pay close attention and follow the resources below. If you have not developed a provider before and are looking for some help in developing one, you may choose to leverage one of the following development agencies which have developed Terraform providers in the past and are familiar with the requirements and process: -| Partner | Email | Website | -|--------------------|:-----------------------------|:---------------------| -| Crest Data Systems | malhar@crestdatasys.com | www.crestdatasys.com | -| DigitalOnUs | hashicorp@digitalonus.com | www.digitalonus.com | -| Akava | bd@akava.io | www.akava.io | -| OpenCredo | hashicorp@opencredo.com | www.opencredo.com | +| Partner | Email | Website | +| ------------------ | :-------------------------- | :-------------------------------------------------- | +| Crest Data Systems | | [www.crestdatasys.com](http://www.crestdatasys.com) | +| DigitalOnUs | | [www.digitalonus.com](http://www.digitalonus.com) | +| Akava | | [www.akava.io](http://www.akava.io) | +| OpenCredo | | [www.opencredo.com](http://www.opencredo.com) | -> **Important:** All Terraform providers listed as Verified must contain one of the following open source licenses: @@ -109,14 +78,13 @@ We’ve found the provider development process to be fairly straightforward and - Microsoft Public License (MS-PL) - MIT - ### 3. Verify At this stage, it is expected that the provider is fully developed, all tests and documentation are in place, and your provider is ready for publishing. In this step, HashiCorp will verify the source and authenticity of the namespace being used to publish the provider by signing your GPG key with a trust signature. -> **Important:** This step requires that you have signed and accepted our Technology Partner Agreement. If you have not received this, please see step #1 above. -Please send your public key to terraform-registry@hashicorp.com, indicating you are a partner seeking verification, and a HashiCorp employee will be in touch to help verify, and add your key. +Please send your public key to , indicating you are a partner seeking verification, and a HashiCorp employee will be in touch to help verify, and add your key. To export your public key in ASCII-armor format, use the following command: @@ -126,7 +94,7 @@ $ gpg --armor --export "{Key ID or email address}" ### 4. Publish -Once the verification step is complete please follow the steps on [Publishing a Provider](https://www.terraform.io/docs/registry/providers/publishing.html). This step does not require additional involvement from HashiCorp as publishing is a fully self-service process in the [Terraform Registry](https://registry.terraform.io). +Once the verification step is complete please follow the steps on [Publishing a Provider](/registry/providers/publishing). This step does not require additional involvement from HashiCorp as publishing is a fully self-service process in the [Terraform Registry](https://registry.terraform.io). Once completed, your provider should be visible in the Terraform Registry and usable in Terraform. Please confirm that everything looks good, and that documentation is rendering properly. diff --git a/website/intro/index.html.markdown b/website/intro/index.mdx similarity index 76% rename from website/intro/index.html.markdown rename to website/intro/index.mdx index 8327f5e10372..898bb69d7503 100644 --- a/website/intro/index.html.markdown +++ b/website/intro/index.mdx @@ -1,9 +1,8 @@ --- -layout: "intro" -page_title: "Introduction" -sidebar_current: "what" -description: |- - Learn what Terraform is, what problems it can solve, and how it compares to existing software. +page_title: Introduction +description: >- + Learn what Terraform is, what problems it can solve, and how it compares to + existing software. --- # Introduction to Terraform @@ -12,15 +11,13 @@ Terraform is an infrastructure as code (IaC) tool that allows you to build, chan Below, HashiCorp co-founder and CTO Armon Dadgar describes how Terraform can help solve common infrastructure challenges. - - - + + + ## Key Features ### Infrastructure as Code -You describe your infrastructure using Terraform's high-level [configuration language](/language/) in human-readable, declarative configuration files. This allows you to create a blueprint that you can version, share, and reuse. +You describe your infrastructure using Terraform's high-level [configuration language](/docs/language/index.html) in human-readable, declarative configuration files. This allows you to create a blueprint that you can version, share, and reuse. ### Execution Plans @@ -31,8 +34,10 @@ Terraform builds a resource graph and creates or modifies non-dependent resource Terraform can apply complex changesets to your infrastructure with minimal human interaction. When you update configuration files, Terraform determines what changed and creates incremental execution plans that respect dependencies. + + ## Next Steps -- Learn about common [Terraform use cases](/intro/use-cases). -- Learn [how Terraform compares to and complements other tools](/intro/vs/). +- Learn about common [Terraform use cases](/intro/use-cases.html). +- Learn [how Terraform compares to and complements other tools](/intro/vs/index.html). - Try the [Terraform: Get Started](https://learn.hashicorp.com/collections/terraform/aws-get-started) tutorials on HashiCorp Learn. diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.html.markdown similarity index 96% rename from website/intro/use-cases.mdx rename to website/intro/use-cases.html.markdown index 411fec47c8cf..9ef2aa82c5c8 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.html.markdown @@ -1,13 +1,14 @@ --- -page_title: Use Cases -description: >- - Learn common use cases for Terraform including managing Heroku apps, - self-service clusters, and multi-cloud deployments. +layout: "intro" +page_title: "Use Cases" +sidebar_current: "use-cases" +description: |- + Learn common use cases for Terraform including managing Heroku apps, self-service clusters, and multi-cloud deployments. --- # Use Cases -This page lists a subset of use cases for [Terraform](/intro/). +This page lists a subset of use cases for [Terraform](/intro/index.html). ## Multi-Cloud Deployment diff --git a/website/intro/vs/boto.mdx b/website/intro/vs/boto.html.markdown similarity index 81% rename from website/intro/vs/boto.mdx rename to website/intro/vs/boto.html.markdown index de008b8dced4..524893fefc7c 100644 --- a/website/intro/vs/boto.mdx +++ b/website/intro/vs/boto.html.markdown @@ -1,6 +1,9 @@ --- -page_title: 'Terraform vs. Boto, Fog, etc.' -description: 'How Terraform compares to cloud provider client libraries like Boto and Fog. ' +layout: "intro" +page_title: "Terraform vs. Boto, Fog, etc." +sidebar_current: "vs-other-boto" +description: |- + How Terraform compares to cloud provider client libraries like Boto and Fog. --- # Terraform vs. Boto, Fog, etc. diff --git a/website/intro/vs/chef-puppet.mdx b/website/intro/vs/chef-puppet.html.markdown similarity index 80% rename from website/intro/vs/chef-puppet.mdx rename to website/intro/vs/chef-puppet.html.markdown index c846ffac7b36..128ceac4741e 100644 --- a/website/intro/vs/chef-puppet.mdx +++ b/website/intro/vs/chef-puppet.html.markdown @@ -1,8 +1,9 @@ --- -page_title: 'Terraform vs. Chef, Puppet, etc.' -description: >- - How Terraform compares to configuration management tools like Chef and - Puppet. +layout: "intro" +page_title: "Terraform vs. Chef, Puppet, etc." +sidebar_current: "vs-other-chef" +description: |- + How Terraform compares to configuration management tools like Chef and Puppet. --- # Terraform vs. Chef, Puppet, etc. diff --git a/website/intro/vs/cloudformation.mdx b/website/intro/vs/cloudformation.html.markdown similarity index 87% rename from website/intro/vs/cloudformation.mdx rename to website/intro/vs/cloudformation.html.markdown index a677ec089a3b..def42de5ba23 100644 --- a/website/intro/vs/cloudformation.mdx +++ b/website/intro/vs/cloudformation.html.markdown @@ -1,9 +1,9 @@ --- -page_title: 'Terraform vs. CloudFormation, Heat, etc.' -description: >- - How Terraform compares to other infrastructure as code tools like - CloudFormation and Heat. Terraform can simultaneously manage multiple cloud - providers (AWS, OpenStack, etc.) and services (Cloudflare, DNSimple, etc.). +layout: "intro" +page_title: "Terraform vs. CloudFormation, Heat, etc." +sidebar_current: "vs-other-cloudformation" +description: |- + How Terraform compares to other infrastructure as code tools like CloudFormation and Heat. Terraform can simultaneously manage multiple cloud providers (AWS, OpenStack, etc.) and services (Cloudflare, DNSimple, etc.). --- # Terraform vs. CloudFormation, Heat, etc. diff --git a/website/intro/vs/custom.mdx b/website/intro/vs/custom.html.markdown similarity index 88% rename from website/intro/vs/custom.mdx rename to website/intro/vs/custom.html.markdown index 8b381c6dfe5a..94b25a2febc5 100644 --- a/website/intro/vs/custom.mdx +++ b/website/intro/vs/custom.html.markdown @@ -1,8 +1,9 @@ --- -page_title: Terraform vs. Custom Solutions -description: >- - Why Terraform is easier to use and maintain than custom, internal - infrastructure solutions. +layout: "intro" +page_title: "Terraform vs. Custom Solutions" +sidebar_current: "vs-other-custom" +description: |- + Why Terraform is easier to use and maintain than custom, internal infrastructure solutions. --- # Terraform vs. Custom Solutions diff --git a/website/intro/vs/index.mdx b/website/intro/vs/index.html.markdown similarity index 80% rename from website/intro/vs/index.mdx rename to website/intro/vs/index.html.markdown index bc0d6dc9c1d8..462e326fbc58 100644 --- a/website/intro/vs/index.mdx +++ b/website/intro/vs/index.html.markdown @@ -1,6 +1,9 @@ --- -page_title: Terraform vs. Other Software -description: An overview of how Terraform compares to other software and tools. +layout: "intro" +page_title: "Terraform vs. Other Software" +sidebar_current: "vs-other" +description: |- + An overview of how Terraform compares to other software and tools. --- # Terraform vs. Other Software From 419676cb69f4134a99124545afce12e742d506cf Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Mon, 22 Nov 2021 13:17:04 -0600 Subject: [PATCH 382/644] Cloud integration requires input for migrations We cannot programmatically migrate workspaces to Terraform Cloud without prompts, so `-input=false` should not be allowed in those cases. There are 4 scenarios where we need input from a user to complete migrating workspaces to Terraform Cloud. 1.) Migrate from a single local workspace to Terraform Cloud * Terraform config for a local backend. Implicit local (no backend specified) is fine. * `terraform init` and `terraform apply` * Change the Terraform config to use the cloud block * `terraform init -input=false` * You should now see an error message 2.) Migrate from a remote backend with a prefix to Terraform Cloud with tags * Create a workspace in Terraform Cloud manually. The name should include a prefix, like "app-one" * Have the terraform config use `backend "remote"` with a prefix set to "app-" * `terraform init` and `terraform apply` * Update the Terraform config to use a cloud block with `tags = ["app"]`. There should not be a prefix defined in the config now. * `terraform init -input=false` * You should now see an error message 3.) Migrate from multiple local workspaces to a single Terraform Cloud workspace * Create one or many local workspaces * `terraform init` and `terraform apply` in each * Change the Terraform config to use the cloud block * `terraform init -input=false` * You should now see an error message 4.) Migrate to Terraform Cloud and ask for a workspace name * Create several local workspaces * `terraform init` and `terraform apply` in each * Change the Terraform config to use the cloud block with tags * `terraform init -input=false` * You should now see an error message --- internal/command/init_test.go | 2 +- internal/command/meta_backend_migrate.go | 26 +++++++++++++++++++++++- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/internal/command/init_test.go b/internal/command/init_test.go index 90da036f016d..a96e0e9d6661 100644 --- a/internal/command/init_test.go +++ b/internal/command/init_test.go @@ -1310,7 +1310,7 @@ func TestInit_inputFalse(t *testing.T) { } errMsg := ui.ErrorWriter.String() - if !strings.Contains(errMsg, "input disabled") { + if !strings.Contains(errMsg, "interactive input is disabled") { t.Fatal("expected input disabled error, got", errMsg) } diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 6bdff56eb54c..5b476ff2b019 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -415,7 +415,7 @@ func (m *Meta) backendMigrateState_s_s(opts *backendMigrateOpts) error { // Abort if we can't ask for input. if !m.input { log.Print("[TRACE] backendMigrateState: can't prompt for input, so aborting migration") - return errors.New("error asking for state migration action: input disabled") + return errors.New(strings.TrimSpace(errInteractiveInputDisabled)) } // Confirm with the user whether we want to copy state over @@ -773,6 +773,10 @@ func (m *Meta) backendMigrateState_S_TFC(opts *backendMigrateOpts, sourceWorkspa } func (m *Meta) promptSingleToCloudSingleStateMigration(opts *backendMigrateOpts) (bool, error) { + if !m.input { + log.Print("[TRACE] backendMigrateState: can't prompt for input, so aborting migration") + return false, errors.New(strings.TrimSpace(errInteractiveInputDisabled)) + } migrate := opts.force if !migrate { var err error @@ -790,6 +794,10 @@ func (m *Meta) promptSingleToCloudSingleStateMigration(opts *backendMigrateOpts) } func (m *Meta) promptRemotePrefixToCloudTagsMigration(opts *backendMigrateOpts) error { + if !m.input { + log.Print("[TRACE] backendMigrateState: can't prompt for input, so aborting migration") + return errors.New(strings.TrimSpace(errInteractiveInputDisabled)) + } migrate := opts.force if !migrate { var err error @@ -812,6 +820,10 @@ func (m *Meta) promptRemotePrefixToCloudTagsMigration(opts *backendMigrateOpts) // Multi-state to single state. func (m *Meta) promptMultiToSingleCloudMigration(opts *backendMigrateOpts) error { + if !m.input { + log.Print("[TRACE] backendMigrateState: can't prompt for input, so aborting migration") + return errors.New(strings.TrimSpace(errInteractiveInputDisabled)) + } migrate := opts.force if !migrate { var err error @@ -839,6 +851,10 @@ func (m *Meta) promptNewWorkspaceName(destinationType string) (string, error) { message := fmt.Sprintf("[reset][bold][yellow]The %q backend configuration only allows "+ "named workspaces![reset]", destinationType) if destinationType == "cloud" { + if !m.input { + log.Print("[TRACE] backendMigrateState: can't prompt for input, so aborting migration") + return "", errors.New(strings.TrimSpace(errInteractiveInputDisabled)) + } message = `[reset][bold][yellow]Terraform Cloud requires all workspaces to be given an explicit name.[reset]` } name, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ @@ -854,6 +870,8 @@ func (m *Meta) promptNewWorkspaceName(destinationType string) (string, error) { } func (m *Meta) promptMultiStateMigrationPattern(sourceType string) (string, error) { + // This is not the first prompt a user would be presented with in the migration to TFC, so no + // guard on m.input is needed here. renameWorkspaces, err := m.UIInput().Input(context.Background(), &terraform.InputOpts{ Id: "backend-migrate-multistate-to-tfc", Query: fmt.Sprintf("[reset][bold][yellow]%s[reset]", "Would you like to rename your workspaces?"), @@ -941,6 +959,12 @@ Migrating state from Terraform Cloud to another backend is not yet implemented. Please use the API to do this: https://www.terraform.io/docs/cloud/api/state-versions.html ` +const errInteractiveInputDisabled = ` +Can't ask approval for state migration when interactive input is disabled. + +Please remove the "-input=false" option and try again. +` + const tfcInputBackendMigrateMultiToMultiPattern = ` Enter a pattern with an asterisk (*) to rename all workspaces based on their previous names. The asterisk represents the current workspace name. From ffcb167bce05c4eebc8d1b91f59251c1c210333f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josef=20=C5=A0im=C3=A1nek?= Date: Wed, 24 Nov 2021 20:19:24 +0100 Subject: [PATCH 383/644] Update go test commands in .github/CONTRIBUTING.md. --- .github/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6a22f15cf285..6114a69135f4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -172,8 +172,8 @@ go test ./... As you make your changes, you can re-run the above command to ensure that the tests are *still* passing. If you are working only on a specific Go package, you can speed up your testing cycle by testing only that single package, or packages under a particular package prefix: ``` -go test ./command/... -go test ./addrs +go test ./internal/command/... +go test ./internal/addrs ``` ## Acceptance Tests: Testing interactions with external services From 5ddf5e1f7d1bf57e4314c38837469982786128e9 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 24 Nov 2021 15:23:20 -0500 Subject: [PATCH 384/644] core: Fix schema loading for deleted resources Resource instances removed from the configuration would previously use the implied provider address. This is correct for default providers, but incorrect for those from other namespaces or hosts. The fix here is to use the stored provider config if it is present. --- .../node_resource_abstract_instance.go | 3 ++ .../node_resource_abstract_instance_test.go | 30 +++++++++++++++++-- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index d2b6489be3dc..91b24cd669b8 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -136,6 +136,9 @@ func (n *NodeAbstractResourceInstance) Provider() addrs.Provider { if n.Config != nil { return n.Config.Provider } + if n.storedProviderConfig.Provider.Type != "" { + return n.storedProviderConfig.Provider + } return addrs.ImpliedProviderForUnqualifiedType(n.Addr.Resource.ContainingResource().ImpliedProvider()) } diff --git a/internal/terraform/node_resource_abstract_instance_test.go b/internal/terraform/node_resource_abstract_instance_test.go index 0d4c23fc923a..dca1cb52f0f5 100644 --- a/internal/terraform/node_resource_abstract_instance_test.go +++ b/internal/terraform/node_resource_abstract_instance_test.go @@ -13,9 +13,10 @@ import ( func TestNodeAbstractResourceInstanceProvider(t *testing.T) { tests := []struct { - Addr addrs.AbsResourceInstance - Config *configs.Resource - Want addrs.Provider + Addr addrs.AbsResourceInstance + Config *configs.Resource + StoredProviderConfig addrs.AbsProviderConfig + Want addrs.Provider }{ { Addr: addrs.Resource{ @@ -87,6 +88,28 @@ func TestNodeAbstractResourceInstanceProvider(t *testing.T) { Type: "happycloud", }, }, + { + Addr: addrs.Resource{ + Mode: addrs.DataResourceMode, + Type: "null_resource", + Name: "baz", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + Config: nil, + StoredProviderConfig: addrs.AbsProviderConfig{ + Module: addrs.RootModule, + Provider: addrs.Provider{ + Hostname: addrs.DefaultProviderRegistryHost, + Namespace: "awesomecorp", + Type: "null", + }, + }, + // The stored provider config overrides the default behavior. + Want: addrs.Provider{ + Hostname: addrs.DefaultProviderRegistryHost, + Namespace: "awesomecorp", + Type: "null", + }, + }, } for _, test := range tests { @@ -104,6 +127,7 @@ func TestNodeAbstractResourceInstanceProvider(t *testing.T) { NodeAbstractResource: NodeAbstractResource{ Config: test.Config, }, + storedProviderConfig: test.StoredProviderConfig, } got := node.Provider() if got != test.Want { From ecc8bcfe5b2551737a234ebf78a7df1123ad56d7 Mon Sep 17 00:00:00 2001 From: Jonathan Ballet Date: Thu, 25 Nov 2021 16:35:03 +0100 Subject: [PATCH 385/644] Improve `.terraformignore` doc formatting This helps to distinguish what is a `/` (as a directory separator) from a "/" (as in "his/her"). --- website/docs/language/settings/backends/remote.html.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.html.md index 1c26169b87d3..a011993a0c88 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.html.md @@ -223,15 +223,15 @@ When executing a remote `plan` or `apply` in a [CLI-driven run](/docs/cloud/run/ an archive of your configuration directory is uploaded to Terraform Cloud. You can define paths to ignore from upload via a `.terraformignore` file at the root of your configuration directory. If this file is not present, the archive will exclude the following by default: -* .git/ directories -* .terraform/ directories (exclusive of .terraform/modules) +* `.git/` directories +* `.terraform/` directories (exclusive of `.terraform/modules`) The `.terraformignore` file can include rules as one would include in a -[.gitignore file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) +[`.gitignore` file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) * Comments (starting with `#`) or blank lines are ignored -* End a pattern with a forward slash / to specify a directory +* End a pattern with a forward slash `/` to specify a directory * Negate a pattern by starting it with an exclamation point `!` Note that unlike `.gitignore`, only the `.terraformignore` at the root of the configuration From fbed52a353b3c91095ed6940d2f0a44f93924653 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 24 Nov 2021 17:30:42 -0500 Subject: [PATCH 386/644] configs: Add sensitive marks for nested attributes Object values returned from providers have their attributes marked as sensitive based on the provider schema. This was not fully implemented for nested attribute types, which is corrected in this commit. --- internal/configs/configschema/implied_type.go | 7 +- .../configs/configschema/implied_type_test.go | 95 ++++++++++++++++++ internal/configs/configschema/marks.go | 90 +++++++++++++++++ internal/configs/configschema/marks_test.go | 97 +++++++++++++++++-- 4 files changed, 277 insertions(+), 12 deletions(-) diff --git a/internal/configs/configschema/implied_type.go b/internal/configs/configschema/implied_type.go index 1a19a8c07a28..0a1dc75f9631 100644 --- a/internal/configs/configschema/implied_type.go +++ b/internal/configs/configschema/implied_type.go @@ -44,6 +44,9 @@ func (b *Block) ContainsSensitive() bool { if attrS.Sensitive { return true } + if attrS.NestedType != nil && attrS.NestedType.ContainsSensitive() { + return true + } } for _, blockS := range b.BlockTypes { if blockS.ContainsSensitive() { @@ -108,8 +111,8 @@ func (o *Object) ContainsSensitive() bool { if attrS.Sensitive { return true } - if attrS.NestedType != nil { - return attrS.NestedType.ContainsSensitive() + if attrS.NestedType != nil && attrS.NestedType.ContainsSensitive() { + return true } } return false diff --git a/internal/configs/configschema/implied_type_test.go b/internal/configs/configschema/implied_type_test.go index 0fd8b01b5772..6e3c0de72258 100644 --- a/internal/configs/configschema/implied_type_test.go +++ b/internal/configs/configschema/implied_type_test.go @@ -154,6 +154,70 @@ func TestBlockImpliedType(t *testing.T) { } } +func TestBlockContainsSensitive(t *testing.T) { + tests := map[string]struct { + Schema *Block + Want bool + }{ + "object contains sensitive": { + &Block{ + Attributes: map[string]*Attribute{ + "sensitive": {Sensitive: true}, + }, + }, + true, + }, + "no sensitive attrs": { + &Block{ + Attributes: map[string]*Attribute{ + "insensitive": {}, + }, + }, + false, + }, + "nested object contains sensitive": { + &Block{ + Attributes: map[string]*Attribute{ + "nested": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "sensitive": {Sensitive: true}, + }, + }, + }, + }, + }, + true, + }, + "nested obj, no sensitive attrs": { + &Block{ + Attributes: map[string]*Attribute{ + "nested": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "public": {}, + }, + }, + }, + }, + }, + false, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + got := test.Schema.ContainsSensitive() + if got != test.Want { + t.Errorf("wrong result\ngot: %#v\nwant: %#v", got, test.Want) + } + }) + } + +} + func TestObjectImpliedType(t *testing.T) { tests := map[string]struct { Schema *Object @@ -353,6 +417,37 @@ func TestObjectContainsSensitive(t *testing.T) { }, false, }, + "several nested objects, one contains sensitive": { + &Object{ + Attributes: map[string]*Attribute{ + "alpha": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "nonsensitive": {}, + }, + }, + }, + "beta": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "sensitive": {Sensitive: true}, + }, + }, + }, + "gamma": { + NestedType: &Object{ + Nesting: NestingSingle, + Attributes: map[string]*Attribute{ + "nonsensitive": {}, + }, + }, + }, + }, + }, + true, + }, } for name, test := range tests { diff --git a/internal/configs/configschema/marks.go b/internal/configs/configschema/marks.go index aa07a41a10f7..c581b187b943 100644 --- a/internal/configs/configschema/marks.go +++ b/internal/configs/configschema/marks.go @@ -12,6 +12,8 @@ import ( // blocks are descended (if present in the given value). func (b *Block) ValueMarks(val cty.Value, path cty.Path) []cty.PathValueMarks { var pvm []cty.PathValueMarks + + // We can mark attributes as sensitive even if the value is null for name, attrS := range b.Attributes { if attrS.Sensitive { // Create a copy of the path, with this step added, to add to our PathValueMarks slice @@ -25,9 +27,28 @@ func (b *Block) ValueMarks(val cty.Value, path cty.Path) []cty.PathValueMarks { } } + // If the value is null, no other marks are possible if val.IsNull() { return pvm } + + // Extract marks for nested attribute type values + for name, attrS := range b.Attributes { + // If the attribute has no nested type, or the nested type doesn't + // contain any sensitive attributes, skip inspecting it + if attrS.NestedType == nil || !attrS.NestedType.ContainsSensitive() { + continue + } + + // Create a copy of the path, with this step added, to add to our PathValueMarks slice + attrPath := make(cty.Path, len(path), len(path)+1) + copy(attrPath, path) + attrPath = append(path, cty.GetAttrStep{Name: name}) + + pvm = append(pvm, attrS.NestedType.ValueMarks(val.GetAttr(name), attrPath)...) + } + + // Extract marks for nested blocks for name, blockS := range b.BlockTypes { // If our block doesn't contain any sensitive attributes, skip inspecting it if !blockS.Block.ContainsSensitive() { @@ -59,3 +80,72 @@ func (b *Block) ValueMarks(val cty.Value, path cty.Path) []cty.PathValueMarks { } return pvm } + +// ValueMarks returns a set of path value marks for a given value and path, +// based on the sensitive flag for each attribute within the nested attribute. +// Attributes with nested types are descended (if present in the given value). +func (o *Object) ValueMarks(val cty.Value, path cty.Path) []cty.PathValueMarks { + var pvm []cty.PathValueMarks + + if val.IsNull() || !val.IsKnown() { + return pvm + } + + for name, attrS := range o.Attributes { + // Skip attributes which can never produce sensitive path value marks + if !attrS.Sensitive && (attrS.NestedType == nil || !attrS.NestedType.ContainsSensitive()) { + continue + } + + switch o.Nesting { + case NestingSingle, NestingGroup: + // Create a path to this attribute + attrPath := make(cty.Path, len(path), len(path)+1) + copy(attrPath, path) + attrPath = append(path, cty.GetAttrStep{Name: name}) + + if attrS.Sensitive { + // If the entire attribute is sensitive, mark it so + pvm = append(pvm, cty.PathValueMarks{ + Path: attrPath, + Marks: cty.NewValueMarks(marks.Sensitive), + }) + } else { + // The attribute has a nested type which contains sensitive + // attributes, so recurse + pvm = append(pvm, attrS.NestedType.ValueMarks(val.GetAttr(name), attrPath)...) + } + case NestingList, NestingMap, NestingSet: + // For nested attribute types which have a non-single nesting mode, + // we add path value marks for each element of the collection + for it := val.ElementIterator(); it.Next(); { + idx, attrEV := it.Element() + attrV := attrEV.GetAttr(name) + + // Create a path to this element of the attribute's collection. Note + // that the path is extended in opposite order to the iteration order + // of the loops: index into the collection, then the contained + // attribute name. This is because we have one type + // representing multiple collection elements. + attrPath := make(cty.Path, len(path), len(path)+2) + copy(attrPath, path) + attrPath = append(path, cty.IndexStep{Key: idx}, cty.GetAttrStep{Name: name}) + + if attrS.Sensitive { + // If the entire attribute is sensitive, mark it so + pvm = append(pvm, cty.PathValueMarks{ + Path: attrPath, + Marks: cty.NewValueMarks(marks.Sensitive), + }) + } else { + // The attribute has a nested type which contains sensitive + // attributes, so recurse + pvm = append(pvm, attrS.NestedType.ValueMarks(attrV, attrPath)...) + } + } + default: + panic(fmt.Sprintf("unsupported nesting mode %s", attrS.NestedType.Nesting)) + } + } + return pvm +} diff --git a/internal/configs/configschema/marks_test.go b/internal/configs/configschema/marks_test.go index b4895ea91071..2077e5e805b0 100644 --- a/internal/configs/configschema/marks_test.go +++ b/internal/configs/configschema/marks_test.go @@ -1,7 +1,6 @@ package configschema import ( - "fmt" "testing" "github.com/hashicorp/terraform/internal/lang/marks" @@ -19,6 +18,20 @@ func TestBlockValueMarks(t *testing.T) { Type: cty.String, Sensitive: true, }, + "nested": { + NestedType: &Object{ + Attributes: map[string]*Attribute{ + "boop": { + Type: cty.String, + }, + "honk": { + Type: cty.String, + Sensitive: true, + }, + }, + Nesting: NestingList, + }, + }, }, BlockTypes: map[string]*NestedBlock{ @@ -40,34 +53,46 @@ func TestBlockValueMarks(t *testing.T) { }, } - for _, tc := range []struct { + testCases := map[string]struct { given cty.Value expect cty.Value }{ - { + "unknown object": { cty.UnknownVal(schema.ImpliedType()), cty.UnknownVal(schema.ImpliedType()), }, - { + "null object": { cty.NullVal(schema.ImpliedType()), cty.NullVal(schema.ImpliedType()), }, - { + "object with unknown attributes and blocks": { cty.ObjectVal(map[string]cty.Value{ "sensitive": cty.UnknownVal(cty.String), "unsensitive": cty.UnknownVal(cty.String), - "list": cty.UnknownVal(schema.BlockTypes["list"].ImpliedType()), + "nested": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "boop": cty.String, + "honk": cty.String, + }))), + "list": cty.UnknownVal(schema.BlockTypes["list"].ImpliedType()), }), cty.ObjectVal(map[string]cty.Value{ "sensitive": cty.UnknownVal(cty.String).Mark(marks.Sensitive), "unsensitive": cty.UnknownVal(cty.String), - "list": cty.UnknownVal(schema.BlockTypes["list"].ImpliedType()), + "nested": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "boop": cty.String, + "honk": cty.String, + }))), + "list": cty.UnknownVal(schema.BlockTypes["list"].ImpliedType()), }), }, - { + "object with block value": { cty.ObjectVal(map[string]cty.Value{ "sensitive": cty.NullVal(cty.String), "unsensitive": cty.UnknownVal(cty.String), + "nested": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "boop": cty.String, + "honk": cty.String, + }))), "list": cty.ListVal([]cty.Value{ cty.ObjectVal(map[string]cty.Value{ "sensitive": cty.UnknownVal(cty.String), @@ -82,6 +107,10 @@ func TestBlockValueMarks(t *testing.T) { cty.ObjectVal(map[string]cty.Value{ "sensitive": cty.NullVal(cty.String).Mark(marks.Sensitive), "unsensitive": cty.UnknownVal(cty.String), + "nested": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "boop": cty.String, + "honk": cty.String, + }))), "list": cty.ListVal([]cty.Value{ cty.ObjectVal(map[string]cty.Value{ "sensitive": cty.UnknownVal(cty.String).Mark(marks.Sensitive), @@ -94,8 +123,56 @@ func TestBlockValueMarks(t *testing.T) { }), }), }, - } { - t.Run(fmt.Sprintf("%#v", tc.given), func(t *testing.T) { + "object with known values and nested attribute": { + cty.ObjectVal(map[string]cty.Value{ + "sensitive": cty.StringVal("foo"), + "unsensitive": cty.StringVal("bar"), + "nested": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "boop": cty.StringVal("foo"), + "honk": cty.StringVal("bar"), + }), + cty.ObjectVal(map[string]cty.Value{ + "boop": cty.NullVal(cty.String), + "honk": cty.NullVal(cty.String), + }), + cty.ObjectVal(map[string]cty.Value{ + "boop": cty.UnknownVal(cty.String), + "honk": cty.UnknownVal(cty.String), + }), + }), + "list": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "sensitive": cty.String, + "unsensitive": cty.String, + }))), + }), + cty.ObjectVal(map[string]cty.Value{ + "sensitive": cty.StringVal("foo").Mark(marks.Sensitive), + "unsensitive": cty.StringVal("bar"), + "nested": cty.ListVal([]cty.Value{ + cty.ObjectVal(map[string]cty.Value{ + "boop": cty.StringVal("foo"), + "honk": cty.StringVal("bar").Mark(marks.Sensitive), + }), + cty.ObjectVal(map[string]cty.Value{ + "boop": cty.NullVal(cty.String), + "honk": cty.NullVal(cty.String).Mark(marks.Sensitive), + }), + cty.ObjectVal(map[string]cty.Value{ + "boop": cty.UnknownVal(cty.String), + "honk": cty.UnknownVal(cty.String).Mark(marks.Sensitive), + }), + }), + "list": cty.NullVal(cty.List(cty.Object(map[string]cty.Type{ + "sensitive": cty.String, + "unsensitive": cty.String, + }))), + }), + }, + } + + for name, tc := range testCases { + t.Run(name, func(t *testing.T) { got := tc.given.MarkWithPaths(schema.ValueMarks(tc.given, nil)) if !got.RawEquals(tc.expect) { t.Fatalf("\nexpected: %#v\ngot: %#v\n", tc.expect, got) From fba26b10ee3c81e081651564194cf173497491df Mon Sep 17 00:00:00 2001 From: Daniel Murphy <15730032+DanHatesNumbers@users.noreply.github.com> Date: Fri, 26 Nov 2021 16:57:48 +0000 Subject: [PATCH 387/644] Fix example for values-representation in docs for JSON Format internals The `root_module.resources[].sensitive_values` key in the example output was incorrectly named and clashed with the regular `root_module.resources[].values` key. --- website/docs/internals/json-format.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index cd4e2213a481..c5ea13bd139f 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -272,7 +272,7 @@ The following example illustrates the structure of a ``: // "sensitive_values" is the JSON representation of the sensitivity of // the resource's attribute values. Only attributes which are sensitive // are included in this structure. - "values": { + "sensitive_values": { "id": true, } } From 6a454f11a74504fcfd92750ea45cb3ead37e84cd Mon Sep 17 00:00:00 2001 From: Ted Behling Date: Mon, 29 Nov 2021 17:00:02 -0500 Subject: [PATCH 388/644] Add newer Debian & Ubuntu versions to repo list The HashiCorp APT server supports several distro releases that were not in this list, leading to a false impression that they aren't supported. Note, Ubuntu has a new release twice a year, so periodic maintenance is needed here. --- website/docs/cli/install/apt.html.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/docs/cli/install/apt.html.md b/website/docs/cli/install/apt.html.md index 5b88b9613f23..44cc5bc0ecb0 100644 --- a/website/docs/cli/install/apt.html.md +++ b/website/docs/cli/install/apt.html.md @@ -77,11 +77,14 @@ following distribution releases: * Debian 8 (`jessie`) * Debian 9 (`stretch`) * Debian 10 (`buster`) +* Debian 11 (`bullseye`) * Ubuntu 16.04 (`xenial`) * Ubuntu 18.04 (`bionic`) * Ubuntu 19.10 (`eoam`) * Ubuntu 20.04 (`focal`) * Ubuntu 20.10 (`groovy`) +* Ubuntu 21.04 (`hirsute`) +* Ubuntu 21.10 (`impish`) No repositories are available for other Debian or Ubuntu versions or any other APT-based Linux distributions. If you add the repository using From b1c071bb57d807a17d0b82c5fb828e5219adb49e Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Mon, 29 Nov 2021 23:45:35 +0000 Subject: [PATCH 389/644] pass hclog logger to retryable client --- internal/backend/remote-state/http/backend.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/internal/backend/remote-state/http/backend.go b/internal/backend/remote-state/http/backend.go index a3f98c05ac66..863e3f00f1a5 100644 --- a/internal/backend/remote-state/http/backend.go +++ b/internal/backend/remote-state/http/backend.go @@ -4,6 +4,7 @@ import ( "context" "crypto/tls" "fmt" + "log" "net/http" "net/url" "time" @@ -12,6 +13,7 @@ import ( "github.com/hashicorp/go-retryablehttp" "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/legacy/helper/schema" + "github.com/hashicorp/terraform/internal/logging" "github.com/hashicorp/terraform/internal/states/remote" "github.com/hashicorp/terraform/internal/states/statemgr" ) @@ -161,6 +163,7 @@ func (b *Backend) configure(ctx context.Context) error { rClient.RetryMax = data.Get("retry_max").(int) rClient.RetryWaitMin = time.Duration(data.Get("retry_wait_min").(int)) * time.Second rClient.RetryWaitMax = time.Duration(data.Get("retry_wait_max").(int)) * time.Second + rClient.Logger = log.New(logging.LogOutput(), "", log.Flags()) b.client = &httpClient{ URL: updateURL, From affe2c329561f40f13c0e94f4570321977527a77 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 30 Nov 2021 14:30:44 -0800 Subject: [PATCH 390/644] addrs: Expose the registry address parser's error messages Previously we ended up losing all of the error message detail produced by the registry address parser, because we treated any registry address failure as cause to parse the address as a go-getter-style remote address instead. That led to terrible feedback in the situation where the user _was_ trying to write a module address but it was invalid in some way. Although we can't really tighten this up in the default case due to our compatibility promises, it's never been valid to use the "version" argument with anything other than a registry address and so as a compromise here we'll use the presence of "version" as a heuristic for user intent to parse the source address as a registry address, and thus we can return a registry-address-specific error message in that case and thus give more direct feedback about what was wrong. This unfortunately won't help someone trying to install from the registry _without_ a version constraint, but I didn't want to let perfect be the enemy of the good here, particularly since we recommend using version constraints with registry modules anyway; indeed, that's one of the main benefits of using a registry rather than a remote source directly. --- internal/addrs/module_source.go | 82 +++++++++++++++---- internal/addrs/module_source_test.go | 25 +++++- internal/configs/module_call.go | 56 +++++++++---- ...ule-invalid-registry-source-with-module.tf | 5 ++ .../module-local-source-with-version.tf | 5 ++ internal/earlyconfig/config_build.go | 29 +++++-- internal/initwd/module_install.go | 2 +- internal/initwd/module_install_test.go | 21 ++++- 8 files changed, 180 insertions(+), 45 deletions(-) create mode 100644 internal/configs/testdata/error-files/module-invalid-registry-source-with-module.tf create mode 100644 internal/configs/testdata/error-files/module-local-source-with-version.tf diff --git a/internal/addrs/module_source.go b/internal/addrs/module_source.go index bad32ba38981..c42bc9f04459 100644 --- a/internal/addrs/module_source.go +++ b/internal/addrs/module_source.go @@ -46,18 +46,36 @@ var moduleSourceLocalPrefixes = []string{ "..\\", } +// ParseModuleSource parses a module source address as given in the "source" +// argument inside a "module" block in the configuration. +// +// For historical reasons this syntax is a bit overloaded, supporting three +// different address types: +// - Local paths starting with either ./ or ../, which are special because +// Terraform considers them to belong to the same "package" as the caller. +// - Module registry addresses, given as either NAMESPACE/NAME/SYSTEM or +// HOST/NAMESPACE/NAME/SYSTEM, in which case the remote registry serves +// as an indirection over the third address type that follows. +// - Various URL-like and other heuristically-recognized strings which +// we currently delegate to the external library go-getter. +// +// There is some ambiguity between the module registry addresses and go-getter's +// very liberal heuristics and so this particular function will typically treat +// an invalid registry address as some other sort of remote source address +// rather than returning an error. If you know that you're expecting a +// registry address in particular, use ParseModuleSourceRegistry instead, which +// can therefore expose more detailed error messages about registry address +// parsing in particular. func ParseModuleSource(raw string) (ModuleSource, error) { - for _, prefix := range moduleSourceLocalPrefixes { - if strings.HasPrefix(raw, prefix) { - localAddr, err := parseModuleSourceLocal(raw) - if err != nil { - // This is to make sure we really return a nil ModuleSource in - // this case, rather than an interface containing the zero - // value of ModuleSourceLocal. - return nil, err - } - return localAddr, nil + if isModuleSourceLocal(raw) { + localAddr, err := parseModuleSourceLocal(raw) + if err != nil { + // This is to make sure we really return a nil ModuleSource in + // this case, rather than an interface containing the zero + // value of ModuleSourceLocal. + return nil, err } + return localAddr, nil } // For historical reasons, whether an address is a registry @@ -71,7 +89,7 @@ func ParseModuleSource(raw string) (ModuleSource, error) { // the registry source parse error gets returned to the caller, // which is annoying but has been true for many releases // without it posing a serious problem in practice.) - if ret, err := parseModuleSourceRegistry(raw); err == nil { + if ret, err := ParseModuleSourceRegistry(raw); err == nil { return ret, nil } @@ -150,6 +168,15 @@ func parseModuleSourceLocal(raw string) (ModuleSourceLocal, error) { return ModuleSourceLocal(clean), nil } +func isModuleSourceLocal(raw string) bool { + for _, prefix := range moduleSourceLocalPrefixes { + if strings.HasPrefix(raw, prefix) { + return true + } + } + return false +} + func (s ModuleSourceLocal) moduleSource() {} func (s ModuleSourceLocal) String() string { @@ -195,6 +222,30 @@ const DefaultModuleRegistryHost = svchost.Hostname("registry.terraform.io") var moduleRegistryNamePattern = regexp.MustCompile("^[0-9A-Za-z](?:[0-9A-Za-z-_]{0,62}[0-9A-Za-z])?$") var moduleRegistryTargetSystemPattern = regexp.MustCompile("^[0-9a-z]{1,64}$") +// ParseModuleSourceRegistry is a variant of ParseModuleSource which only +// accepts module registry addresses, and will reject any other address type. +// +// Use this instead of ParseModuleSource if you know from some other surrounding +// context that an address is intended to be a registry address rather than +// some other address type, which will then allow for better error reporting +// due to the additional information about user intent. +func ParseModuleSourceRegistry(raw string) (ModuleSource, error) { + // Before we delegate to the "real" function we'll just make sure this + // doesn't look like a local source address, so we can return a better + // error message for that situation. + if isModuleSourceLocal(raw) { + return ModuleSourceRegistry{}, fmt.Errorf("can't use local directory %q as a module registry address", raw) + } + + ret, err := parseModuleSourceRegistry(raw) + if err != nil { + // This is to make sure we return a nil ModuleSource, rather than + // a non-nil ModuleSource containing a zero-value ModuleSourceRegistry. + return nil, err + } + return ret, nil +} + func parseModuleSourceRegistry(raw string) (ModuleSourceRegistry, error) { var err error @@ -298,11 +349,10 @@ func parseModuleRegistryTargetSystem(given string) (string, error) { // Similar to the names in provider source addresses, we defined these // to be compatible with what filesystems and typical remote systems // like GitHub allow in names. Unfortunately we didn't end up defining - // these exactly equivalently: provider names can only use dashes as - // punctuation, whereas module names can use underscores. So here we're - // using some regular expressions from the original module source - // implementation, rather than using the IDNA rules as we do in - // ParseProviderPart. + // these exactly equivalently: provider names can't use dashes or + // underscores. So here we're using some regular expressions from the + // original module source implementation, rather than using the IDNA rules + // as we do in ParseProviderPart. if !moduleRegistryTargetSystemPattern.MatchString(given) { return "", fmt.Errorf("must be between one and 64 ASCII letters or digits") diff --git a/internal/addrs/module_source_test.go b/internal/addrs/module_source_test.go index 480ca50fba5e..9604c33744bd 100644 --- a/internal/addrs/module_source_test.go +++ b/internal/addrs/module_source_test.go @@ -488,10 +488,14 @@ func TestParseModuleSourceRegistry(t *testing.T) { input: `foo/var/baz/qux`, wantErr: `invalid module registry hostname: must contain at least one dot`, }, - "invalid target system": { + "invalid target system characters": { input: `foo/var/no-no-no`, wantErr: `invalid target system "no-no-no": must be between one and 64 ASCII letters or digits`, }, + "invalid target system length": { + input: `foo/var/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaah`, + wantErr: `invalid target system "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaah": must be between one and 64 ASCII letters or digits`, + }, "invalid namespace": { input: `boop!/var/baz`, wantErr: `invalid namespace "boop!": must be between one and 64 characters, including ASCII letters, digits, dashes, and underscores, where dashes and underscores may not be the prefix or suffix`, @@ -518,11 +522,23 @@ func TestParseModuleSourceRegistry(t *testing.T) { input: `bitbucket.org/HashiCorp/Consul/aws`, wantErr: `can't use "bitbucket.org" as a module registry host, because it's reserved for installing directly from version control repositories`, }, + "local path from current dir": { + // Can't use a local path when we're specifically trying to parse + // a _registry_ source address. + input: `./boop`, + wantErr: `can't use local directory "./boop" as a module registry address`, + }, + "local path from parent dir": { + // Can't use a local path when we're specifically trying to parse + // a _registry_ source address. + input: `../boop`, + wantErr: `can't use local directory "../boop" as a module registry address`, + }, } for name, test := range tests { t.Run(name, func(t *testing.T) { - addr, err := parseModuleSourceRegistry(test.input) + addrI, err := ParseModuleSourceRegistry(test.input) if test.wantErr != "" { switch { @@ -538,6 +554,11 @@ func TestParseModuleSourceRegistry(t *testing.T) { t.Fatalf("unexpected error: %s", err.Error()) } + addr, ok := addrI.(ModuleSourceRegistry) + if !ok { + t.Fatalf("wrong address type %T; want %T", addrI, addr) + } + if got, want := addr.String(), test.wantString; got != want { t.Errorf("wrong String() result\ngot: %s\nwant: %s", got, want) } diff --git a/internal/configs/module_call.go b/internal/configs/module_call.go index 5d887dac0862..3ec42ec01a17 100644 --- a/internal/configs/module_call.go +++ b/internal/configs/module_call.go @@ -59,15 +59,35 @@ func decodeModuleBlock(block *hcl.Block, override bool) (*ModuleCall, hcl.Diagno }) } + haveVersionArg := false + if attr, exists := content.Attributes["version"]; exists { + var versionDiags hcl.Diagnostics + mc.Version, versionDiags = decodeVersionConstraint(attr) + diags = append(diags, versionDiags...) + haveVersionArg = true + } + if attr, exists := content.Attributes["source"]; exists { mc.SourceSet = true mc.SourceAddrRange = attr.Expr.Range() valDiags := gohcl.DecodeExpression(attr.Expr, nil, &mc.SourceAddrRaw) diags = append(diags, valDiags...) if !valDiags.HasErrors() { - addr, err := addrs.ParseModuleSource(mc.SourceAddrRaw) + var addr addrs.ModuleSource + var err error + if haveVersionArg { + addr, err = addrs.ParseModuleSourceRegistry(mc.SourceAddrRaw) + } else { + addr, err = addrs.ParseModuleSource(mc.SourceAddrRaw) + } mc.SourceAddr = addr if err != nil { + // NOTE: We leave mc.SourceAddr as nil for any situation where the + // source attribute is invalid, so any code which tries to carefully + // use the partial result of a failed config decode must be + // resilient to that. + mc.SourceAddr = nil + // NOTE: In practice it's actually very unlikely to end up here, // because our source address parser can turn just about any string // into some sort of remote package address, and so for most errors @@ -87,25 +107,27 @@ func decodeModuleBlock(block *hcl.Block, override bool) (*ModuleCall, hcl.Diagno Subject: mc.SourceAddrRange.Ptr(), }) default: - diags = append(diags, &hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Invalid module source address", - Detail: fmt.Sprintf("Failed to parse module source address: %s.", err), - Subject: mc.SourceAddrRange.Ptr(), - }) + if haveVersionArg { + // In this case we'll include some extra context that + // we assumed a registry source address due to the + // version argument. + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid registry module source address", + Detail: fmt.Sprintf("Failed to parse module registry address: %s.\n\nTerraform assumed that you intended a module registry source address because you also set the argument \"version\", which applies only to registry modules.", err), + Subject: mc.SourceAddrRange.Ptr(), + }) + } else { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid module source address", + Detail: fmt.Sprintf("Failed to parse module source address: %s.", err), + Subject: mc.SourceAddrRange.Ptr(), + }) + } } } } - // NOTE: We leave mc.SourceAddr as nil for any situation where the - // source attribute is invalid, so any code which tries to carefully - // use the partial result of a failed config decode must be - // resilient to that. - } - - if attr, exists := content.Attributes["version"]; exists { - var versionDiags hcl.Diagnostics - mc.Version, versionDiags = decodeVersionConstraint(attr) - diags = append(diags, versionDiags...) } if attr, exists := content.Attributes["count"]; exists { diff --git a/internal/configs/testdata/error-files/module-invalid-registry-source-with-module.tf b/internal/configs/testdata/error-files/module-invalid-registry-source-with-module.tf new file mode 100644 index 000000000000..0029be8f4af3 --- /dev/null +++ b/internal/configs/testdata/error-files/module-invalid-registry-source-with-module.tf @@ -0,0 +1,5 @@ + +module "test" { + source = "---.com/HashiCorp/Consul/aws" # ERROR: Invalid registry module source address + version = "1.0.0" # Makes Terraform assume "source" is a module address +} diff --git a/internal/configs/testdata/error-files/module-local-source-with-version.tf b/internal/configs/testdata/error-files/module-local-source-with-version.tf new file mode 100644 index 000000000000..f570d65fe97c --- /dev/null +++ b/internal/configs/testdata/error-files/module-local-source-with-version.tf @@ -0,0 +1,5 @@ + +module "test" { + source = "../boop" # ERROR: Invalid registry module source address + version = "1.0.0" # Makes Terraform assume "source" is a module address +} diff --git a/internal/earlyconfig/config_build.go b/internal/earlyconfig/config_build.go index 807d9cd77e85..dd84cf9cccbf 100644 --- a/internal/earlyconfig/config_build.go +++ b/internal/earlyconfig/config_build.go @@ -43,7 +43,10 @@ func buildChildModules(parent *Config, walker ModuleWalker) (map[string]*Config, path[len(path)-1] = call.Name var vc version.Constraints + haveVersionArg := false if strings.TrimSpace(call.Version) != "" { + haveVersionArg = true + var err error vc, err = version.NewConstraint(call.Version) if err != nil { @@ -56,13 +59,27 @@ func buildChildModules(parent *Config, walker ModuleWalker) (map[string]*Config, } } - sourceAddr, err := addrs.ParseModuleSource(call.Source) + var sourceAddr addrs.ModuleSource + var err error + if haveVersionArg { + sourceAddr, err = addrs.ParseModuleSourceRegistry(call.Source) + } else { + sourceAddr, err = addrs.ParseModuleSource(call.Source) + } if err != nil { - diags = diags.Append(wrapDiagnostic(tfconfig.Diagnostic{ - Severity: tfconfig.DiagError, - Summary: "Invalid module source address", - Detail: fmt.Sprintf("Module %q (declared at %s line %d) has invalid source address %q: %s.", callName, call.Pos.Filename, call.Pos.Line, call.Source, err), - })) + if haveVersionArg { + diags = diags.Append(wrapDiagnostic(tfconfig.Diagnostic{ + Severity: tfconfig.DiagError, + Summary: "Invalid registry module source address", + Detail: fmt.Sprintf("Module %q (declared at %s line %d) has invalid source address %q: %s.\n\nTerraform assumed that you intended a module registry source address because you also set the argument \"version\", which applies only to registry modules.", callName, call.Pos.Filename, call.Pos.Line, call.Source, err), + })) + } else { + diags = diags.Append(wrapDiagnostic(tfconfig.Diagnostic{ + Severity: tfconfig.DiagError, + Summary: "Invalid module source address", + Detail: fmt.Sprintf("Module %q (declared at %s line %d) has invalid source address %q: %s.", callName, call.Pos.Filename, call.Pos.Line, call.Source, err), + })) + } // If we didn't have a valid source address then we can't continue // down the module tree with this one. continue diff --git a/internal/initwd/module_install.go b/internal/initwd/module_install.go index c5355ee9670c..e9ee4953183c 100644 --- a/internal/initwd/module_install.go +++ b/internal/initwd/module_install.go @@ -547,7 +547,7 @@ func (i *ModuleInstaller) installGoGetterModule(ctx context.Context, req *earlyc diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Invalid version constraint", - fmt.Sprintf("Cannot apply a version constraint to module %q (at %s:%d) because it has a non Registry URL.", req.Name, req.CallPos.Filename, req.CallPos.Line), + fmt.Sprintf("Cannot apply a version constraint to module %q (at %s:%d) because it doesn't come from a module registry.", req.Name, req.CallPos.Filename, req.CallPos.Line), )) return nil, diags } diff --git a/internal/initwd/module_install_test.go b/internal/initwd/module_install_test.go index 534ef5840b9e..b05c5619f665 100644 --- a/internal/initwd/module_install_test.go +++ b/internal/initwd/module_install_test.go @@ -192,7 +192,12 @@ func TestModuleInstaller_invalid_version_constraint_error(t *testing.T) { if !diags.HasErrors() { t.Fatal("expected error") } else { - assertDiagnosticSummary(t, diags, "Invalid version constraint") + // We use the presence of the "version" argument as a heuristic for + // user intent to use a registry module, and so we intentionally catch + // this as an invalid registry module address rather than an invalid + // version constraint, so we can surface the specific address parsing + // error instead of a generic version constraint error. + assertDiagnosticSummary(t, diags, "Invalid registry module source address") } } @@ -210,7 +215,12 @@ func TestModuleInstaller_invalidVersionConstraintGetter(t *testing.T) { if !diags.HasErrors() { t.Fatal("expected error") } else { - assertDiagnosticSummary(t, diags, "Invalid version constraint") + // We use the presence of the "version" argument as a heuristic for + // user intent to use a registry module, and so we intentionally catch + // this as an invalid registry module address rather than an invalid + // version constraint, so we can surface the specific address parsing + // error instead of a generic version constraint error. + assertDiagnosticSummary(t, diags, "Invalid registry module source address") } } @@ -228,7 +238,12 @@ func TestModuleInstaller_invalidVersionConstraintLocal(t *testing.T) { if !diags.HasErrors() { t.Fatal("expected error") } else { - assertDiagnosticSummary(t, diags, "Invalid version constraint") + // We use the presence of the "version" argument as a heuristic for + // user intent to use a registry module, and so we intentionally catch + // this as an invalid registry module address rather than an invalid + // version constraint, so we can surface the specific address parsing + // error instead of a generic version constraint error. + assertDiagnosticSummary(t, diags, "Invalid registry module source address") } } From 5facaf89702ec8e25e9f3a0b78b9f00139945fb4 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 1 Dec 2021 08:42:01 -0500 Subject: [PATCH 391/644] update hcl@v2.11.0 --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 0de9e9d5d0c6..307f64f49129 100644 --- a/go.mod +++ b/go.mod @@ -45,7 +45,7 @@ require ( github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f - github.com/hashicorp/hcl/v2 v2.10.1 + github.com/hashicorp/hcl/v2 v2.11.0 github.com/hashicorp/terraform-config-inspect v0.0.0-20210209133302-4fd17a0faac2 github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 github.com/jmespath/go-jmespath v0.4.0 diff --git a/go.sum b/go.sum index eb92f2440008..73bc85bb71b7 100644 --- a/go.sum +++ b/go.sum @@ -425,8 +425,8 @@ github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f h1:UdxlrJz4JOnY8W+Db github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f/go.mod h1:oZtUIOe8dh44I2q6ScRibXws4Ajl+d+nod3AaR9vL5w= github.com/hashicorp/hcl/v2 v2.0.0/go.mod h1:oVVDG71tEinNGYCxinCYadcmKU9bglqW9pV3txagJ90= github.com/hashicorp/hcl/v2 v2.3.0/go.mod h1:d+FwDBbOLvpAM3Z6J7gPj/VoAGkNe/gm352ZhjJ/Zv8= -github.com/hashicorp/hcl/v2 v2.10.1 h1:h4Xx4fsrRE26ohAk/1iGF/JBqRQbyUqu5Lvj60U54ys= -github.com/hashicorp/hcl/v2 v2.10.1/go.mod h1:FwWsfWEjyV/CMj8s/gqAuiviY72rJ1/oayI9WftqcKg= +github.com/hashicorp/hcl/v2 v2.11.0 h1:qrAukIMNDDcnTeJvPbFmT7zMt5Z+EwQdW4O1nD/2g2Y= +github.com/hashicorp/hcl/v2 v2.11.0/go.mod h1:FwWsfWEjyV/CMj8s/gqAuiviY72rJ1/oayI9WftqcKg= github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d h1:9ARUJJ1VVynB176G1HCwleORqCaXm/Vx0uUi0dL26I0= github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d/go.mod h1:Yog5+CPEM3c99L1CL2CFCYoSzgWm5vTU58idbRUaLik= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= From d72a413ef833d4882fcb15d7436fba4a35d53741 Mon Sep 17 00:00:00 2001 From: Luces Huayhuaca <21225410+uturunku1@users.noreply.github.com> Date: Wed, 1 Dec 2021 08:53:47 -0800 Subject: [PATCH 392/644] command/meta_backend: Prompt to select workspace before saving backend config (#29945) When terraform detects that a user has no workspaces that map to their current configuration, it will prompt the user to create a new workspace and enter a value name. If the user ignores the prompt and exits it, the legacy backend (terraform.tfstate) will be left in a awkward state: 1. This saved backend config will show a diff for the JSON attributes "serial", "tags" and "hash" 2. "Terraform workspace list" will show an empty list 3. "Terraform apply" will run successfully using the previous workspace, from the previous config, not the one from the current saved backend config 4. The cloud config is not reflective of the current working directory Solution: If the user exits the prompt, the saved backend config should not be updated because they did not select a new workspace. They are back at the beginning where they are force to re run the init cmd again before proceeding with new changes. --- internal/command/meta_backend.go | 58 ++++++++++++++++++++++---------- 1 file changed, 41 insertions(+), 17 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 4e0b095550f6..825de47e6188 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -97,14 +97,6 @@ func (m *Meta) Backend(opts *BackendOpts) (backend.Enhanced, tfdiags.Diagnostics b, backendDiags = m.backendFromConfig(opts) diags = diags.Append(backendDiags) - if opts.Init && b != nil && !diags.HasErrors() { - // Its possible that the currently selected workspace doesn't exist, so - // we call selectWorkspace to ensure an existing workspace is selected. - if err := m.selectWorkspace(b); err != nil { - diags = diags.Append(err) - } - } - if diags.HasErrors() { return nil, diags } @@ -232,8 +224,11 @@ func (m *Meta) selectWorkspace(b backend.Backend) error { Query: "\n[reset][bold][yellow]No workspaces found.[reset]", Description: fmt.Sprintf(inputCloudInitCreateWorkspace, strings.Join(c.WorkspaceMapping.Tags, ", ")), }) + if err != nil { + return fmt.Errorf("Couldn't create initial workspace: %w", err) + } name = strings.TrimSpace(name) - if err != nil || name == "" { + if name == "" { return fmt.Errorf("Couldn't create initial workspace: no name provided") } log.Printf("[TRACE] Meta.selectWorkspace: selecting the new TFC workspace requested by the user (%s)", name) @@ -610,7 +605,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di return m.backend_c_r_S(c, cHash, sMgr, true) - // Configuring a backend for the first time. + // Configuring a backend for the first time or -reconfigure flag was used case c != nil && s.Backend.Empty(): log.Printf("[TRACE] Meta.Backend: moving from default local state only to %q backend", c.Type) if !opts.Init { @@ -631,9 +626,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di } return nil, diags } - - return m.backend_C_r_s(c, cHash, sMgr) - + return m.backend_C_r_s(c, cHash, sMgr, opts) // Potentially changing a backend configuration case c != nil && !s.Backend.Empty(): // We are not going to migrate if... @@ -643,7 +636,15 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di // AND we're not providing any overrides. An override can mean a change overriding an unchanged backend block (indicated by the hash value). if (uint64(cHash) == s.Backend.Hash) && (!opts.Init || opts.ConfigOverride == nil) { log.Printf("[TRACE] Meta.Backend: using already-initialized, unchanged %q backend configuration", c.Type) - return m.savedBackend(sMgr) + savedBackend, diags := m.savedBackend(sMgr) + // Verify that selected workspace exist. Otherwise prompt user to create one + if opts.Init && savedBackend != nil { + if err := m.selectWorkspace(savedBackend); err != nil { + diags = diags.Append(err) + return nil, diags + } + } + return savedBackend, diags } // If our configuration (the result of both the literal configuration and given @@ -665,6 +666,13 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di if moreDiags.HasErrors() { return nil, diags } + // Verify that selected workspace exist. Otherwise prompt user to create one + if opts.Init && savedBackend != nil { + if err := m.selectWorkspace(savedBackend); err != nil { + diags = diags.Append(err) + return nil, diags + } + } return savedBackend, diags } @@ -685,7 +693,7 @@ func (m *Meta) backendFromConfig(opts *BackendOpts) (backend.Backend, tfdiags.Di } log.Printf("[WARN] backend config has changed since last init") - return m.backend_C_r_S_changed(c, cHash, sMgr, true) + return m.backend_C_r_S_changed(c, cHash, sMgr, true, opts) default: diags = diags.Append(fmt.Errorf( @@ -897,7 +905,7 @@ func (m *Meta) backend_c_r_S(c *configs.Backend, cHash int, sMgr *clistate.Local } // Configuring a backend for the first time. -func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.LocalState) (backend.Backend, tfdiags.Diagnostics) { +func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.LocalState, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // Grab a purely local backend to get the local state if it exists @@ -1017,6 +1025,14 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local Hash: uint64(cHash), } + // Verify that selected workspace exist. Otherwise prompt user to create one + if opts.Init && b != nil { + if err := m.selectWorkspace(b); err != nil { + diags = diags.Append(err) + return nil, diags + } + } + if err := sMgr.WriteState(s); err != nil { diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err)) return nil, diags @@ -1037,7 +1053,7 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local } // Changing a previously saved backend. -func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clistate.LocalState, output bool) (backend.Backend, tfdiags.Diagnostics) { +func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clistate.LocalState, output bool, opts *BackendOpts) (backend.Backend, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics // Get the old state @@ -1133,6 +1149,14 @@ func (m *Meta) backend_C_r_S_changed(c *configs.Backend, cHash int, sMgr *clista Hash: uint64(cHash), } + // Verify that selected workspace exist. Otherwise prompt user to create one + if opts.Init && b != nil { + if err := m.selectWorkspace(b); err != nil { + diags = diags.Append(err) + return b, diags + } + } + if err := sMgr.WriteState(s); err != nil { diags = diags.Append(fmt.Errorf(errBackendWriteSaved, err)) return nil, diags From e08a02e7bf3b042aa31dbb703c6cf500cd3b294e Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 1 Dec 2021 11:09:46 -0600 Subject: [PATCH 393/644] Fixes Issue #29959, Apply w/o init error message When going from a local backend to Terraform Cloud, if you skip the `terraform init` and run `terraform apply` this will give the user more clear instructions. --- internal/command/meta_backend.go | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index 825de47e6188..dafea1a7761c 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -737,7 +737,7 @@ func (m *Meta) determineInitReason(previousBackendType string, currentBackendTyp diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Terraform Cloud initialization required: please run \"terraform init\"", - fmt.Sprintf(strings.TrimSpace(errBackendInitCloudMigration), initReason), + fmt.Sprintf(strings.TrimSpace(errBackendInitCloud), initReason), )) default: diags = diags.Append(tfdiags.Sourceless( @@ -1510,17 +1510,6 @@ hasn't changed and try again. At this point, no changes to your existing configuration or state have been made. ` -const errBackendInitCloudMigration = ` -Reason: %s. - -Migrating to Terraform Cloud requires reinitialization, to discover which Terraform Cloud workspaces belong to this configuration and to optionally migrate existing state to the corresponding Terraform Cloud workspaces. - -To re-initialize, run: - terraform init - -Terraform has not yet made changes to your existing configuration or state. -` - const errBackendInitCloud = ` Reason: %s. From 09291295e273870bfbf756938512b938b8619484 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Wed, 1 Dec 2021 12:29:33 -0500 Subject: [PATCH 394/644] update hcl@v2.11.1 --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 307f64f49129..b41a9a32298b 100644 --- a/go.mod +++ b/go.mod @@ -45,7 +45,7 @@ require ( github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f - github.com/hashicorp/hcl/v2 v2.11.0 + github.com/hashicorp/hcl/v2 v2.11.1 github.com/hashicorp/terraform-config-inspect v0.0.0-20210209133302-4fd17a0faac2 github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 github.com/jmespath/go-jmespath v0.4.0 diff --git a/go.sum b/go.sum index 73bc85bb71b7..fba0b54b9b40 100644 --- a/go.sum +++ b/go.sum @@ -425,8 +425,8 @@ github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f h1:UdxlrJz4JOnY8W+Db github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f/go.mod h1:oZtUIOe8dh44I2q6ScRibXws4Ajl+d+nod3AaR9vL5w= github.com/hashicorp/hcl/v2 v2.0.0/go.mod h1:oVVDG71tEinNGYCxinCYadcmKU9bglqW9pV3txagJ90= github.com/hashicorp/hcl/v2 v2.3.0/go.mod h1:d+FwDBbOLvpAM3Z6J7gPj/VoAGkNe/gm352ZhjJ/Zv8= -github.com/hashicorp/hcl/v2 v2.11.0 h1:qrAukIMNDDcnTeJvPbFmT7zMt5Z+EwQdW4O1nD/2g2Y= -github.com/hashicorp/hcl/v2 v2.11.0/go.mod h1:FwWsfWEjyV/CMj8s/gqAuiviY72rJ1/oayI9WftqcKg= +github.com/hashicorp/hcl/v2 v2.11.1 h1:yTyWcXcm9XB0TEkyU/JCRU6rYy4K+mgLtzn2wlrJbcc= +github.com/hashicorp/hcl/v2 v2.11.1/go.mod h1:FwWsfWEjyV/CMj8s/gqAuiviY72rJ1/oayI9WftqcKg= github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d h1:9ARUJJ1VVynB176G1HCwleORqCaXm/Vx0uUi0dL26I0= github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d/go.mod h1:Yog5+CPEM3c99L1CL2CFCYoSzgWm5vTU58idbRUaLik= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= From c706c8f92b4867a144f735ef821811ac40b374b8 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 1 Dec 2021 10:22:05 -0600 Subject: [PATCH 395/644] Do not ask to migrate empty default workspace When migrating from an explicit local backend to Terraform Cloud, we ask if you want to migrate the state. If there is no state to migrate we should not ask if they want to migrate the emptiness. --- internal/command/meta_backend_migrate.go | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/internal/command/meta_backend_migrate.go b/internal/command/meta_backend_migrate.go index 5b476ff2b019..8cd011eff077 100644 --- a/internal/command/meta_backend_migrate.go +++ b/internal/command/meta_backend_migrate.go @@ -579,6 +579,21 @@ func (m *Meta) backendMigrateTFC(opts *backendMigrateOpts) error { opts.sourceWorkspace = currentWorkspace log.Printf("[INFO] backendMigrateTFC: single-to-single migration from source %s to destination %q", opts.sourceWorkspace, opts.destinationWorkspace) + + // If the current workspace is has no state we do not need to ask + // if they want to migrate the state. + sourceState, err := opts.Source.StateMgr(currentWorkspace) + if err != nil { + return err + } + if err := sourceState.RefreshState(); err != nil { + return err + } + if sourceState.State().Empty() { + log.Printf("[INFO] backendMigrateTFC: skipping migration because source %s is empty", opts.sourceWorkspace) + return nil + } + // Run normal single-to-single state migration. // This will handle both situations where the new cloud backend // configuration is using a workspace.name strategy or workspace.tags From 5d7cb81c0cb9980d8d686f2d1c0a59bbc408acb2 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 1 Dec 2021 13:10:54 -0500 Subject: [PATCH 396/644] lang: Redact sensitive values from function errors Some function errors include values derived from arguments. This commit is the result of a manual audit of these errors, which resulted in: - Adding a helper function to redact sensitive values; - Applying that helper function where errors include values derived from possibly-sensitive arguments; - Cleaning up other errors which need not include those values, or were otherwise incorrect. --- internal/lang/funcs/collection.go | 4 +- internal/lang/funcs/collection_test.go | 41 ++++++ internal/lang/funcs/encoding.go | 22 +-- internal/lang/funcs/encoding_test.go | 40 +++++ internal/lang/funcs/filesystem.go | 89 ++++++----- internal/lang/funcs/filesystem_test.go | 138 +++++++++++++----- internal/lang/funcs/number.go | 24 +-- internal/lang/funcs/number_test.go | 88 ++++++++--- internal/lang/funcs/redact.go | 20 +++ internal/lang/funcs/redact_test.go | 51 +++++++ .../lang/funcs/testdata/unreadable/foobar | 0 11 files changed, 394 insertions(+), 123 deletions(-) create mode 100644 internal/lang/funcs/redact.go create mode 100644 internal/lang/funcs/redact_test.go create mode 100644 internal/lang/funcs/testdata/unreadable/foobar diff --git a/internal/lang/funcs/collection.go b/internal/lang/funcs/collection.go index f9b3e6ae4271..0272b2463649 100644 --- a/internal/lang/funcs/collection.go +++ b/internal/lang/funcs/collection.go @@ -311,8 +311,8 @@ var LookupFunc = function.New(&function.Spec{ return defaultVal.WithMarks(markses...), nil } - return cty.UnknownVal(cty.DynamicPseudoType).WithMarks(markses...), fmt.Errorf( - "lookup failed to find '%s'", lookupKey) + return cty.UnknownVal(cty.DynamicPseudoType), fmt.Errorf( + "lookup failed to find key %s", redactIfSensitive(lookupKey, keyMarks)) }, }) diff --git a/internal/lang/funcs/collection_test.go b/internal/lang/funcs/collection_test.go index 3ca3f9181b3a..2a1927acfee2 100644 --- a/internal/lang/funcs/collection_test.go +++ b/internal/lang/funcs/collection_test.go @@ -5,6 +5,7 @@ import ( "math" "testing" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/zclconf/go-cty/cty" ) @@ -899,6 +900,46 @@ func TestLookup(t *testing.T) { } } +func TestLookup_error(t *testing.T) { + simpleMap := cty.MapVal(map[string]cty.Value{ + "foo": cty.StringVal("bar"), + }) + + tests := map[string]struct { + Values []cty.Value + WantErr string + }{ + "failed to find non-sensitive key": { + []cty.Value{ + simpleMap, + cty.StringVal("boop"), + }, + `lookup failed to find key "boop"`, + }, + "failed to find sensitive key": { + []cty.Value{ + simpleMap, + cty.StringVal("boop").Mark(marks.Sensitive), + }, + "lookup failed to find key (sensitive value)", + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + _, err := Lookup(test.Values...) + + if err == nil { + t.Fatal("succeeded; want error") + } + + if err.Error() != test.WantErr { + t.Errorf("wrong error\ngot: %#v\nwant: %#v", err, test.WantErr) + } + }) + } +} + func TestMatchkeys(t *testing.T) { tests := []struct { Keys cty.Value diff --git a/internal/lang/funcs/encoding.go b/internal/lang/funcs/encoding.go index 27fc2a29c39c..2e67ebc8bccc 100644 --- a/internal/lang/funcs/encoding.go +++ b/internal/lang/funcs/encoding.go @@ -18,22 +18,24 @@ import ( var Base64DecodeFunc = function.New(&function.Spec{ Params: []function.Parameter{ { - Name: "str", - Type: cty.String, + Name: "str", + Type: cty.String, + AllowMarked: true, }, }, Type: function.StaticReturnType(cty.String), Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) { - s := args[0].AsString() + str, strMarks := args[0].Unmark() + s := str.AsString() sDec, err := base64.StdEncoding.DecodeString(s) if err != nil { - return cty.UnknownVal(cty.String), fmt.Errorf("failed to decode base64 data '%s'", s) + return cty.UnknownVal(cty.String), fmt.Errorf("failed to decode base64 data %s", redactIfSensitive(s, strMarks)) } if !utf8.Valid([]byte(sDec)) { - log.Printf("[DEBUG] the result of decoding the provided string is not valid UTF-8: %s", sDec) + log.Printf("[DEBUG] the result of decoding the provided string is not valid UTF-8: %s", redactIfSensitive(sDec, strMarks)) return cty.UnknownVal(cty.String), fmt.Errorf("the result of decoding the provided string is not valid UTF-8") } - return cty.StringVal(string(sDec)), nil + return cty.StringVal(string(sDec)).WithMarks(strMarks), nil }, }) @@ -125,7 +127,7 @@ var TextDecodeBase64Func = function.New(&function.Spec{ case base64.CorruptInputError: return cty.UnknownVal(cty.String), function.NewArgErrorf(0, "the given value is has an invalid base64 symbol at offset %d", int(err)) default: - return cty.UnknownVal(cty.String), function.NewArgErrorf(0, "invalid source string: %T", err) + return cty.UnknownVal(cty.String), function.NewArgErrorf(0, "invalid source string: %w", err) } } @@ -156,13 +158,13 @@ var Base64GzipFunc = function.New(&function.Spec{ var b bytes.Buffer gz := gzip.NewWriter(&b) if _, err := gz.Write([]byte(s)); err != nil { - return cty.UnknownVal(cty.String), fmt.Errorf("failed to write gzip raw data: '%s'", s) + return cty.UnknownVal(cty.String), fmt.Errorf("failed to write gzip raw data: %w", err) } if err := gz.Flush(); err != nil { - return cty.UnknownVal(cty.String), fmt.Errorf("failed to flush gzip writer: '%s'", s) + return cty.UnknownVal(cty.String), fmt.Errorf("failed to flush gzip writer: %w", err) } if err := gz.Close(); err != nil { - return cty.UnknownVal(cty.String), fmt.Errorf("failed to close gzip writer: '%s'", s) + return cty.UnknownVal(cty.String), fmt.Errorf("failed to close gzip writer: %w", err) } return cty.StringVal(base64.StdEncoding.EncodeToString(b.Bytes())), nil }, diff --git a/internal/lang/funcs/encoding_test.go b/internal/lang/funcs/encoding_test.go index 2aa45a374a2e..2e05784e828b 100644 --- a/internal/lang/funcs/encoding_test.go +++ b/internal/lang/funcs/encoding_test.go @@ -4,6 +4,7 @@ import ( "fmt" "testing" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/zclconf/go-cty/cty" ) @@ -18,6 +19,11 @@ func TestBase64Decode(t *testing.T) { cty.StringVal("abc123!?$*&()'-=@~"), false, }, + { + cty.StringVal("YWJjMTIzIT8kKiYoKSctPUB+").Mark(marks.Sensitive), + cty.StringVal("abc123!?$*&()'-=@~").Mark(marks.Sensitive), + false, + }, { // Invalid base64 data decoding cty.StringVal("this-is-an-invalid-base64-data"), cty.UnknownVal(cty.String), @@ -50,6 +56,40 @@ func TestBase64Decode(t *testing.T) { } } +func TestBase64Decode_error(t *testing.T) { + tests := map[string]struct { + String cty.Value + WantErr string + }{ + "invalid base64": { + cty.StringVal("dfg"), + `failed to decode base64 data "dfg"`, + }, + "sensitive invalid base64": { + cty.StringVal("dfg").Mark(marks.Sensitive), + `failed to decode base64 data (sensitive value)`, + }, + "invalid utf-8": { + cty.StringVal("whee"), + "the result of decoding the provided string is not valid UTF-8", + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + _, err := Base64Decode(test.String) + + if err == nil { + t.Fatal("succeeded; want error") + } + + if err.Error() != test.WantErr { + t.Errorf("wrong error result\ngot: %#v\nwant: %#v", err.Error(), test.WantErr) + } + }) + } +} + func TestBase64Encode(t *testing.T) { tests := []struct { String cty.Value diff --git a/internal/lang/funcs/filesystem.go b/internal/lang/funcs/filesystem.go index 846b86110f70..01e090a5b3f2 100644 --- a/internal/lang/funcs/filesystem.go +++ b/internal/lang/funcs/filesystem.go @@ -23,14 +23,16 @@ func MakeFileFunc(baseDir string, encBase64 bool) function.Function { return function.New(&function.Spec{ Params: []function.Parameter{ { - Name: "path", - Type: cty.String, + Name: "path", + Type: cty.String, + AllowMarked: true, }, }, Type: function.StaticReturnType(cty.String), Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) { - path := args[0].AsString() - src, err := readFileBytes(baseDir, path) + pathArg, pathMarks := args[0].Unmark() + path := pathArg.AsString() + src, err := readFileBytes(baseDir, path, pathMarks) if err != nil { err = function.NewArgError(0, err) return cty.UnknownVal(cty.String), err @@ -39,12 +41,12 @@ func MakeFileFunc(baseDir string, encBase64 bool) function.Function { switch { case encBase64: enc := base64.StdEncoding.EncodeToString(src) - return cty.StringVal(enc), nil + return cty.StringVal(enc).WithMarks(pathMarks), nil default: if !utf8.Valid(src) { - return cty.UnknownVal(cty.String), fmt.Errorf("contents of %s are not valid UTF-8; use the filebase64 function to obtain the Base64 encoded contents or the other file functions (e.g. filemd5, filesha256) to obtain file hashing results instead", path) + return cty.UnknownVal(cty.String), fmt.Errorf("contents of %s are not valid UTF-8; use the filebase64 function to obtain the Base64 encoded contents or the other file functions (e.g. filemd5, filesha256) to obtain file hashing results instead", redactIfSensitive(path, pathMarks)) } - return cty.StringVal(string(src)), nil + return cty.StringVal(string(src)).WithMarks(pathMarks), nil } }, }) @@ -67,8 +69,9 @@ func MakeTemplateFileFunc(baseDir string, funcsCb func() map[string]function.Fun params := []function.Parameter{ { - Name: "path", - Type: cty.String, + Name: "path", + Type: cty.String, + AllowMarked: true, }, { Name: "vars", @@ -76,10 +79,10 @@ func MakeTemplateFileFunc(baseDir string, funcsCb func() map[string]function.Fun }, } - loadTmpl := func(fn string) (hcl.Expression, error) { + loadTmpl := func(fn string, marks cty.ValueMarks) (hcl.Expression, error) { // We re-use File here to ensure the same filename interpretation // as it does, along with its other safety checks. - tmplVal, err := File(baseDir, cty.StringVal(fn)) + tmplVal, err := File(baseDir, cty.StringVal(fn).WithMarks(marks)) if err != nil { return nil, err } @@ -159,7 +162,9 @@ func MakeTemplateFileFunc(baseDir string, funcsCb func() map[string]function.Fun // We'll render our template now to see what result type it produces. // A template consisting only of a single interpolation an potentially // return any type. - expr, err := loadTmpl(args[0].AsString()) + + pathArg, pathMarks := args[0].Unmark() + expr, err := loadTmpl(pathArg.AsString(), pathMarks) if err != nil { return cty.DynamicPseudoType, err } @@ -170,11 +175,13 @@ func MakeTemplateFileFunc(baseDir string, funcsCb func() map[string]function.Fun return val.Type(), err }, Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) { - expr, err := loadTmpl(args[0].AsString()) + pathArg, pathMarks := args[0].Unmark() + expr, err := loadTmpl(pathArg.AsString(), pathMarks) if err != nil { return cty.DynamicVal, err } - return renderTmpl(expr, args[1]) + result, err := renderTmpl(expr, args[1]) + return result.WithMarks(pathMarks), err }, }) @@ -186,16 +193,18 @@ func MakeFileExistsFunc(baseDir string) function.Function { return function.New(&function.Spec{ Params: []function.Parameter{ { - Name: "path", - Type: cty.String, + Name: "path", + Type: cty.String, + AllowMarked: true, }, }, Type: function.StaticReturnType(cty.Bool), Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) { - path := args[0].AsString() + pathArg, pathMarks := args[0].Unmark() + path := pathArg.AsString() path, err := homedir.Expand(path) if err != nil { - return cty.UnknownVal(cty.Bool), fmt.Errorf("failed to expand ~: %s", err) + return cty.UnknownVal(cty.Bool), fmt.Errorf("failed to expand ~: %w", err) } if !filepath.IsAbs(path) { @@ -208,17 +217,17 @@ func MakeFileExistsFunc(baseDir string) function.Function { fi, err := os.Stat(path) if err != nil { if os.IsNotExist(err) { - return cty.False, nil + return cty.False.WithMarks(pathMarks), nil } - return cty.UnknownVal(cty.Bool), fmt.Errorf("failed to stat %s", path) + return cty.UnknownVal(cty.Bool), fmt.Errorf("failed to stat %s", redactIfSensitive(path, pathMarks)) } if fi.Mode().IsRegular() { - return cty.True, nil + return cty.True.WithMarks(pathMarks), nil } return cty.False, fmt.Errorf("%s is not a regular file, but %q", - path, fi.Mode().String()) + redactIfSensitive(path, pathMarks), fi.Mode().String()) }, }) } @@ -229,18 +238,24 @@ func MakeFileSetFunc(baseDir string) function.Function { return function.New(&function.Spec{ Params: []function.Parameter{ { - Name: "path", - Type: cty.String, + Name: "path", + Type: cty.String, + AllowMarked: true, }, { - Name: "pattern", - Type: cty.String, + Name: "pattern", + Type: cty.String, + AllowMarked: true, }, }, Type: function.StaticReturnType(cty.Set(cty.String)), Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) { - path := args[0].AsString() - pattern := args[1].AsString() + pathArg, pathMarks := args[0].Unmark() + path := pathArg.AsString() + patternArg, patternMarks := args[1].Unmark() + pattern := patternArg.AsString() + + marks := []cty.ValueMarks{pathMarks, patternMarks} if !filepath.IsAbs(path) { path = filepath.Join(baseDir, path) @@ -253,7 +268,7 @@ func MakeFileSetFunc(baseDir string) function.Function { matches, err := doublestar.Glob(pattern) if err != nil { - return cty.UnknownVal(cty.Set(cty.String)), fmt.Errorf("failed to glob pattern (%s): %s", pattern, err) + return cty.UnknownVal(cty.Set(cty.String)), fmt.Errorf("failed to glob pattern %s: %w", redactIfSensitive(pattern, marks...), err) } var matchVals []cty.Value @@ -261,7 +276,7 @@ func MakeFileSetFunc(baseDir string) function.Function { fi, err := os.Stat(match) if err != nil { - return cty.UnknownVal(cty.Set(cty.String)), fmt.Errorf("failed to stat (%s): %s", match, err) + return cty.UnknownVal(cty.Set(cty.String)), fmt.Errorf("failed to stat %s: %w", redactIfSensitive(match, marks...), err) } if !fi.Mode().IsRegular() { @@ -272,7 +287,7 @@ func MakeFileSetFunc(baseDir string) function.Function { match, err = filepath.Rel(path, match) if err != nil { - return cty.UnknownVal(cty.Set(cty.String)), fmt.Errorf("failed to trim path of match (%s): %s", match, err) + return cty.UnknownVal(cty.Set(cty.String)), fmt.Errorf("failed to trim path of match %s: %w", redactIfSensitive(match, marks...), err) } // Replace any remaining file separators with forward slash (/) @@ -283,10 +298,10 @@ func MakeFileSetFunc(baseDir string) function.Function { } if len(matchVals) == 0 { - return cty.SetValEmpty(cty.String), nil + return cty.SetValEmpty(cty.String).WithMarks(marks...), nil } - return cty.SetVal(matchVals), nil + return cty.SetVal(matchVals).WithMarks(marks...), nil }, }) } @@ -355,7 +370,7 @@ var PathExpandFunc = function.New(&function.Spec{ func openFile(baseDir, path string) (*os.File, error) { path, err := homedir.Expand(path) if err != nil { - return nil, fmt.Errorf("failed to expand ~: %s", err) + return nil, fmt.Errorf("failed to expand ~: %w", err) } if !filepath.IsAbs(path) { @@ -368,12 +383,12 @@ func openFile(baseDir, path string) (*os.File, error) { return os.Open(path) } -func readFileBytes(baseDir, path string) ([]byte, error) { +func readFileBytes(baseDir, path string, marks cty.ValueMarks) ([]byte, error) { f, err := openFile(baseDir, path) if err != nil { if os.IsNotExist(err) { // An extra Terraform-specific hint for this situation - return nil, fmt.Errorf("no file exists at %s; this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource", path) + return nil, fmt.Errorf("no file exists at %s; this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource", redactIfSensitive(path, marks)) } return nil, err } @@ -381,7 +396,7 @@ func readFileBytes(baseDir, path string) ([]byte, error) { src, err := ioutil.ReadAll(f) if err != nil { - return nil, fmt.Errorf("failed to read %s", path) + return nil, fmt.Errorf("failed to read file: %w", err) } return src, nil diff --git a/internal/lang/funcs/filesystem_test.go b/internal/lang/funcs/filesystem_test.go index b91b52b1ed1a..4e673984bbbe 100644 --- a/internal/lang/funcs/filesystem_test.go +++ b/internal/lang/funcs/filesystem_test.go @@ -2,9 +2,11 @@ package funcs import ( "fmt" + "os" "path/filepath" "testing" + "github.com/hashicorp/terraform/internal/lang/marks" homedir "github.com/mitchellh/go-homedir" "github.com/zclconf/go-cty/cty" "github.com/zclconf/go-cty/cty/function" @@ -15,22 +17,32 @@ func TestFile(t *testing.T) { tests := []struct { Path cty.Value Want cty.Value - Err bool + Err string }{ { cty.StringVal("testdata/hello.txt"), cty.StringVal("Hello World"), - false, + ``, }, { cty.StringVal("testdata/icon.png"), cty.NilVal, - true, // Not valid UTF-8 + `contents of "testdata/icon.png" are not valid UTF-8; use the filebase64 function to obtain the Base64 encoded contents or the other file functions (e.g. filemd5, filesha256) to obtain file hashing results instead`, + }, + { + cty.StringVal("testdata/icon.png").Mark(marks.Sensitive), + cty.NilVal, + `contents of (sensitive value) are not valid UTF-8; use the filebase64 function to obtain the Base64 encoded contents or the other file functions (e.g. filemd5, filesha256) to obtain file hashing results instead`, }, { cty.StringVal("testdata/missing"), cty.NilVal, - true, // no file exists + `no file exists at "testdata/missing"; this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource`, + }, + { + cty.StringVal("testdata/missing").Mark(marks.Sensitive), + cty.NilVal, + `no file exists at (sensitive value); this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource`, }, } @@ -38,10 +50,13 @@ func TestFile(t *testing.T) { t.Run(fmt.Sprintf("File(\".\", %#v)", test.Path), func(t *testing.T) { got, err := File(".", test.Path) - if test.Err { + if test.Err != "" { if err == nil { t.Fatal("succeeded; want error") } + if got, want := err.Error(), test.Err; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } return } else if err != nil { t.Fatalf("unexpected error: %s", err) @@ -71,13 +86,19 @@ func TestTemplateFile(t *testing.T) { cty.StringVal("testdata/icon.png"), cty.EmptyObjectVal, cty.NilVal, - `contents of testdata/icon.png are not valid UTF-8; use the filebase64 function to obtain the Base64 encoded contents or the other file functions (e.g. filemd5, filesha256) to obtain file hashing results instead`, + `contents of "testdata/icon.png" are not valid UTF-8; use the filebase64 function to obtain the Base64 encoded contents or the other file functions (e.g. filemd5, filesha256) to obtain file hashing results instead`, }, { cty.StringVal("testdata/missing"), cty.EmptyObjectVal, cty.NilVal, - `no file exists at testdata/missing; this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource`, + `no file exists at "testdata/missing"; this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource`, + }, + { + cty.StringVal("testdata/secrets.txt").Mark(marks.Sensitive), + cty.EmptyObjectVal, + cty.NilVal, + `no file exists at (sensitive value); this function works only with files that are distributed as part of the configuration source code, so if this file will be created by a resource in this configuration you must instead obtain this result from an attribute of that resource`, }, { cty.StringVal("testdata/hello.tmpl"), @@ -197,33 +218,61 @@ func TestFileExists(t *testing.T) { tests := []struct { Path cty.Value Want cty.Value - Err bool + Err string }{ { cty.StringVal("testdata/hello.txt"), cty.BoolVal(true), - false, + ``, }, { - cty.StringVal(""), // empty path + cty.StringVal(""), cty.BoolVal(false), - true, + `"." is not a regular file, but "drwxr-xr-x"`, + }, + { + cty.StringVal("testdata").Mark(marks.Sensitive), + cty.BoolVal(false), + `(sensitive value) is not a regular file, but "drwxr-xr-x"`, }, { cty.StringVal("testdata/missing"), cty.BoolVal(false), - false, // no file exists + ``, + }, + { + cty.StringVal("testdata/unreadable/foobar"), + cty.BoolVal(false), + `failed to stat "testdata/unreadable/foobar"`, + }, + { + cty.StringVal("testdata/unreadable/foobar").Mark(marks.Sensitive), + cty.BoolVal(false), + `failed to stat (sensitive value)`, }, } + // Ensure "unreadable" directory cannot be listed during the test run + fi, err := os.Lstat("testdata/unreadable") + if err != nil { + t.Fatal(err) + } + os.Chmod("testdata/unreadable", 0000) + defer func(mode os.FileMode) { + os.Chmod("testdata/unreadable", mode) + }(fi.Mode()) + for _, test := range tests { t.Run(fmt.Sprintf("FileExists(\".\", %#v)", test.Path), func(t *testing.T) { got, err := FileExists(".", test.Path) - if test.Err { + if test.Err != "" { if err == nil { t.Fatal("succeeded; want error") } + if got, want := err.Error(), test.Err; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } return } else if err != nil { t.Fatalf("unexpected error: %s", err) @@ -241,49 +290,49 @@ func TestFileSet(t *testing.T) { Path cty.Value Pattern cty.Value Want cty.Value - Err bool + Err string }{ { cty.StringVal("."), cty.StringVal("testdata*"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), cty.StringVal("testdata"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), cty.StringVal("{testdata,missing}"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), cty.StringVal("testdata/missing"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), cty.StringVal("testdata/missing*"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), cty.StringVal("*/missing"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), cty.StringVal("**/missing"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("."), @@ -291,7 +340,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -299,7 +348,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -307,7 +356,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -316,7 +365,7 @@ func TestFileSet(t *testing.T) { cty.StringVal("testdata/hello.tmpl"), cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -325,7 +374,7 @@ func TestFileSet(t *testing.T) { cty.StringVal("testdata/hello.tmpl"), cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -333,7 +382,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -341,7 +390,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -350,7 +399,7 @@ func TestFileSet(t *testing.T) { cty.StringVal("testdata/hello.tmpl"), cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -359,7 +408,7 @@ func TestFileSet(t *testing.T) { cty.StringVal("testdata/hello.tmpl"), cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), @@ -368,31 +417,37 @@ func TestFileSet(t *testing.T) { cty.StringVal("testdata/hello.tmpl"), cty.StringVal("testdata/hello.txt"), }), - false, + ``, }, { cty.StringVal("."), cty.StringVal("["), cty.SetValEmpty(cty.String), - true, + `failed to glob pattern "[": syntax error in pattern`, + }, + { + cty.StringVal("."), + cty.StringVal("[").Mark(marks.Sensitive), + cty.SetValEmpty(cty.String), + `failed to glob pattern (sensitive value): syntax error in pattern`, }, { cty.StringVal("."), cty.StringVal("\\"), cty.SetValEmpty(cty.String), - true, + `failed to glob pattern "\\": syntax error in pattern`, }, { cty.StringVal("testdata"), cty.StringVal("missing"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("testdata"), cty.StringVal("missing*"), cty.SetValEmpty(cty.String), - false, + ``, }, { cty.StringVal("testdata"), @@ -400,7 +455,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("hello.txt"), }), - false, + ``, }, { cty.StringVal("testdata"), @@ -408,7 +463,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("hello.txt"), }), - false, + ``, }, { cty.StringVal("testdata"), @@ -416,7 +471,7 @@ func TestFileSet(t *testing.T) { cty.SetVal([]cty.Value{ cty.StringVal("hello.txt"), }), - false, + ``, }, { cty.StringVal("testdata"), @@ -425,7 +480,7 @@ func TestFileSet(t *testing.T) { cty.StringVal("hello.tmpl"), cty.StringVal("hello.txt"), }), - false, + ``, }, } @@ -433,10 +488,13 @@ func TestFileSet(t *testing.T) { t.Run(fmt.Sprintf("FileSet(\".\", %#v, %#v)", test.Path, test.Pattern), func(t *testing.T) { got, err := FileSet(".", test.Path, test.Pattern) - if test.Err { + if test.Err != "" { if err == nil { t.Fatal("succeeded; want error") } + if got, want := err.Error(), test.Err; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } return } else if err != nil { t.Fatalf("unexpected error: %s", err) diff --git a/internal/lang/funcs/number.go b/internal/lang/funcs/number.go index 43effec128cf..d958706102ed 100644 --- a/internal/lang/funcs/number.go +++ b/internal/lang/funcs/number.go @@ -95,12 +95,14 @@ var SignumFunc = function.New(&function.Spec{ var ParseIntFunc = function.New(&function.Spec{ Params: []function.Parameter{ { - Name: "number", - Type: cty.DynamicPseudoType, + Name: "number", + Type: cty.DynamicPseudoType, + AllowMarked: true, }, { - Name: "base", - Type: cty.Number, + Name: "base", + Type: cty.Number, + AllowMarked: true, }, }, @@ -116,11 +118,13 @@ var ParseIntFunc = function.New(&function.Spec{ var base int var err error - if err = gocty.FromCtyValue(args[0], &numstr); err != nil { + numArg, numMarks := args[0].Unmark() + if err = gocty.FromCtyValue(numArg, &numstr); err != nil { return cty.UnknownVal(cty.String), function.NewArgError(0, err) } - if err = gocty.FromCtyValue(args[1], &base); err != nil { + baseArg, baseMarks := args[1].Unmark() + if err = gocty.FromCtyValue(baseArg, &base); err != nil { return cty.UnknownVal(cty.Number), function.NewArgError(1, err) } @@ -135,13 +139,13 @@ var ParseIntFunc = function.New(&function.Spec{ if !ok { return cty.UnknownVal(cty.Number), function.NewArgErrorf( 0, - "cannot parse %q as a base %d integer", - numstr, - base, + "cannot parse %s as a base %s integer", + redactIfSensitive(numstr, numMarks), + redactIfSensitive(base, baseMarks), ) } - parsedNum := cty.NumberVal((&big.Float{}).SetInt(num)) + parsedNum := cty.NumberVal((&big.Float{}).SetInt(num)).WithMarks(numMarks, baseMarks) return parsedNum, nil }, diff --git a/internal/lang/funcs/number_test.go b/internal/lang/funcs/number_test.go index b467a429fa03..260e0127cea8 100644 --- a/internal/lang/funcs/number_test.go +++ b/internal/lang/funcs/number_test.go @@ -4,6 +4,7 @@ import ( "fmt" "testing" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/zclconf/go-cty/cty" ) @@ -187,139 +188,175 @@ func TestParseInt(t *testing.T) { Num cty.Value Base cty.Value Want cty.Value - Err bool + Err string }{ { cty.StringVal("128"), cty.NumberIntVal(10), cty.NumberIntVal(128), - false, + ``, + }, + { + cty.StringVal("128").Mark(marks.Sensitive), + cty.NumberIntVal(10), + cty.NumberIntVal(128).Mark(marks.Sensitive), + ``, + }, + { + cty.StringVal("128"), + cty.NumberIntVal(10).Mark(marks.Sensitive), + cty.NumberIntVal(128).Mark(marks.Sensitive), + ``, + }, + { + cty.StringVal("128").Mark(marks.Sensitive), + cty.NumberIntVal(10).Mark(marks.Sensitive), + cty.NumberIntVal(128).Mark(marks.Sensitive), + ``, + }, + { + cty.StringVal("128").Mark(marks.Raw), + cty.NumberIntVal(10).Mark(marks.Sensitive), + cty.NumberIntVal(128).WithMarks(cty.NewValueMarks(marks.Raw, marks.Sensitive)), + ``, }, { cty.StringVal("-128"), cty.NumberIntVal(10), cty.NumberIntVal(-128), - false, + ``, }, { cty.StringVal("00128"), cty.NumberIntVal(10), cty.NumberIntVal(128), - false, + ``, }, { cty.StringVal("-00128"), cty.NumberIntVal(10), cty.NumberIntVal(-128), - false, + ``, }, { cty.StringVal("FF00"), cty.NumberIntVal(16), cty.NumberIntVal(65280), - false, + ``, }, { cty.StringVal("ff00"), cty.NumberIntVal(16), cty.NumberIntVal(65280), - false, + ``, }, { cty.StringVal("-FF00"), cty.NumberIntVal(16), cty.NumberIntVal(-65280), - false, + ``, }, { cty.StringVal("00FF00"), cty.NumberIntVal(16), cty.NumberIntVal(65280), - false, + ``, }, { cty.StringVal("-00FF00"), cty.NumberIntVal(16), cty.NumberIntVal(-65280), - false, + ``, }, { cty.StringVal("1011111011101111"), cty.NumberIntVal(2), cty.NumberIntVal(48879), - false, + ``, }, { cty.StringVal("aA"), cty.NumberIntVal(62), cty.NumberIntVal(656), - false, + ``, }, { cty.StringVal("Aa"), cty.NumberIntVal(62), cty.NumberIntVal(2242), - false, + ``, }, { cty.StringVal("999999999999999999999999999999999999999999999999999999999999"), cty.NumberIntVal(10), cty.MustParseNumberVal("999999999999999999999999999999999999999999999999999999999999"), - false, + ``, }, { cty.StringVal("FF"), cty.NumberIntVal(10), cty.UnknownVal(cty.Number), - true, + `cannot parse "FF" as a base 10 integer`, + }, + { + cty.StringVal("FF").Mark(marks.Sensitive), + cty.NumberIntVal(10), + cty.UnknownVal(cty.Number), + `cannot parse (sensitive value) as a base 10 integer`, + }, + { + cty.StringVal("FF").Mark(marks.Sensitive), + cty.NumberIntVal(10).Mark(marks.Sensitive), + cty.UnknownVal(cty.Number), + `cannot parse (sensitive value) as a base (sensitive value) integer`, }, { cty.StringVal("00FF"), cty.NumberIntVal(10), cty.UnknownVal(cty.Number), - true, + `cannot parse "00FF" as a base 10 integer`, }, { cty.StringVal("-00FF"), cty.NumberIntVal(10), cty.UnknownVal(cty.Number), - true, + `cannot parse "-00FF" as a base 10 integer`, }, { cty.NumberIntVal(2), cty.NumberIntVal(10), cty.UnknownVal(cty.Number), - true, + `first argument must be a string, not number`, }, { cty.StringVal("1"), cty.NumberIntVal(63), cty.UnknownVal(cty.Number), - true, + `base must be a whole number between 2 and 62 inclusive`, }, { cty.StringVal("1"), cty.NumberIntVal(-1), cty.UnknownVal(cty.Number), - true, + `base must be a whole number between 2 and 62 inclusive`, }, { cty.StringVal("1"), cty.NumberIntVal(1), cty.UnknownVal(cty.Number), - true, + `base must be a whole number between 2 and 62 inclusive`, }, { cty.StringVal("1"), cty.NumberIntVal(0), cty.UnknownVal(cty.Number), - true, + `base must be a whole number between 2 and 62 inclusive`, }, { cty.StringVal("1.2"), cty.NumberIntVal(10), cty.UnknownVal(cty.Number), - true, + `cannot parse "1.2" as a base 10 integer`, }, } @@ -327,10 +364,13 @@ func TestParseInt(t *testing.T) { t.Run(fmt.Sprintf("parseint(%#v, %#v)", test.Num, test.Base), func(t *testing.T) { got, err := ParseInt(test.Num, test.Base) - if test.Err { + if test.Err != "" { if err == nil { t.Fatal("succeeded; want error") } + if got, want := err.Error(), test.Err; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } return } else if err != nil { t.Fatalf("unexpected error: %s", err) diff --git a/internal/lang/funcs/redact.go b/internal/lang/funcs/redact.go new file mode 100644 index 000000000000..bbec3f0a1bd1 --- /dev/null +++ b/internal/lang/funcs/redact.go @@ -0,0 +1,20 @@ +package funcs + +import ( + "fmt" + + "github.com/hashicorp/terraform/internal/lang/marks" + "github.com/zclconf/go-cty/cty" +) + +func redactIfSensitive(value interface{}, markses ...cty.ValueMarks) string { + if marks.Has(cty.DynamicVal.WithMarks(markses...), marks.Sensitive) { + return "(sensitive value)" + } + switch v := value.(type) { + case string: + return fmt.Sprintf("%q", v) + default: + return fmt.Sprintf("%v", v) + } +} diff --git a/internal/lang/funcs/redact_test.go b/internal/lang/funcs/redact_test.go new file mode 100644 index 000000000000..b45721fb99c2 --- /dev/null +++ b/internal/lang/funcs/redact_test.go @@ -0,0 +1,51 @@ +package funcs + +import ( + "testing" + + "github.com/hashicorp/terraform/internal/lang/marks" + "github.com/zclconf/go-cty/cty" +) + +func TestRedactIfSensitive(t *testing.T) { + testCases := map[string]struct { + value interface{} + marks []cty.ValueMarks + want string + }{ + "sensitive string": { + value: "foo", + marks: []cty.ValueMarks{cty.NewValueMarks(marks.Sensitive)}, + want: "(sensitive value)", + }, + "raw non-sensitive string": { + value: "foo", + marks: []cty.ValueMarks{cty.NewValueMarks(marks.Raw)}, + want: `"foo"`, + }, + "raw sensitive string": { + value: "foo", + marks: []cty.ValueMarks{cty.NewValueMarks(marks.Raw), cty.NewValueMarks(marks.Sensitive)}, + want: "(sensitive value)", + }, + "sensitive number": { + value: 12345, + marks: []cty.ValueMarks{cty.NewValueMarks(marks.Sensitive)}, + want: "(sensitive value)", + }, + "non-sensitive number": { + value: 12345, + marks: []cty.ValueMarks{}, + want: "12345", + }, + } + + for name, tc := range testCases { + t.Run(name, func(t *testing.T) { + got := redactIfSensitive(tc.value, tc.marks...) + if got != tc.want { + t.Errorf("wrong result, got %v, want %v", got, tc.want) + } + }) + } +} diff --git a/internal/lang/funcs/testdata/unreadable/foobar b/internal/lang/funcs/testdata/unreadable/foobar new file mode 100644 index 000000000000..e69de29bb2d1 From 7756023564f006658a9bdef2a21a0005c4702b2b Mon Sep 17 00:00:00 2001 From: Axel Neergaard Date: Fri, 3 Dec 2021 18:02:31 +0100 Subject: [PATCH 397/644] Docs: Change misspelling of variable in documentation The variable example for `.tfvars` include a spelling error making the `terraform` and `hcl` examples mismatch. --- website/docs/language/values/variables.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/values/variables.html.md b/website/docs/language/values/variables.html.md index a983192be0db..249327032d75 100644 --- a/website/docs/language/values/variables.html.md +++ b/website/docs/language/values/variables.html.md @@ -509,7 +509,7 @@ variable "moose" { And the following `.tfvars` file: ```hcl -mosse = "Moose" +moose = "Moose" ``` Will cause Terraform to warn you that there is no variable declared `"mosse"`, which can help From 4f634bf8db9efae66b6e0113678b60eaf3a3b77d Mon Sep 17 00:00:00 2001 From: Aleks Saul Date: Thu, 11 Nov 2021 16:53:33 -0500 Subject: [PATCH 398/644] Website/Docs: debian install - run apt update first Apologies for not creating an issue first but it seemed like a simple docs change. `apt install terraform` requires the `apt update` before terraform can be installed. --- website/docs/cli/install/apt.html.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/website/docs/cli/install/apt.html.md b/website/docs/cli/install/apt.html.md index 5b88b9613f23..2603a8c762c0 100644 --- a/website/docs/cli/install/apt.html.md +++ b/website/docs/cli/install/apt.html.md @@ -50,13 +50,10 @@ The above command line uses the following sub-shell commands: * `lsb_release -cs` to find the distribution release codename for your current system, such as `buster`, `groovy`, or `sid`. -`apt-add-repository` usually automatically runs `apt update` as part of its -work to fetch the new package indices, but if it does not, you will need to -manually do so before the packages will be available. - To install Terraform from the new repository: ```bash +sudo apt update sudo apt install terraform ``` From 0771a214d8e19513bdaac338b7b28c8b50eaa202 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 6 Dec 2021 14:28:34 -0500 Subject: [PATCH 399/644] skip provider resolution when there are errors If there are errors loading the configuration, don't try to resolve the provider names, as those names may not even be valid. --- internal/configs/config_build.go | 10 +++++++--- .../config-diagnostics/invalid-provider/errors | 1 + .../config-diagnostics/invalid-provider/main.tf | 3 +++ .../config-diagnostics/invalid-provider/mod/main.tf | 2 ++ .../config-diagnostics/invalid-provider/warnings | 1 + 5 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 internal/configs/testdata/config-diagnostics/invalid-provider/errors create mode 100644 internal/configs/testdata/config-diagnostics/invalid-provider/main.tf create mode 100644 internal/configs/testdata/config-diagnostics/invalid-provider/mod/main.tf create mode 100644 internal/configs/testdata/config-diagnostics/invalid-provider/warnings diff --git a/internal/configs/config_build.go b/internal/configs/config_build.go index e7ebe5021352..96dcbed25c1c 100644 --- a/internal/configs/config_build.go +++ b/internal/configs/config_build.go @@ -23,9 +23,13 @@ func BuildConfig(root *Module, walker ModuleWalker) (*Config, hcl.Diagnostics) { cfg.Root = cfg // Root module is self-referential. cfg.Children, diags = buildChildModules(cfg, walker) - // Now that the config is built, we can connect the provider names to all - // the known types for validation. - cfg.resolveProviderTypes() + // Skip provider resolution if there are any errors, since the provider + // configurations themselves may not be valid. + if !diags.HasErrors() { + // Now that the config is built, we can connect the provider names to all + // the known types for validation. + cfg.resolveProviderTypes() + } diags = append(diags, validateProviderConfigs(nil, cfg, false)...) diff --git a/internal/configs/testdata/config-diagnostics/invalid-provider/errors b/internal/configs/testdata/config-diagnostics/invalid-provider/errors new file mode 100644 index 000000000000..359d47600b20 --- /dev/null +++ b/internal/configs/testdata/config-diagnostics/invalid-provider/errors @@ -0,0 +1 @@ +main.tf:1,1-20: Invalid provider local name; crash_es is an invalid provider local name diff --git a/internal/configs/testdata/config-diagnostics/invalid-provider/main.tf b/internal/configs/testdata/config-diagnostics/invalid-provider/main.tf new file mode 100644 index 000000000000..ba846846994e --- /dev/null +++ b/internal/configs/testdata/config-diagnostics/invalid-provider/main.tf @@ -0,0 +1,3 @@ +module "mod" { + source = "./mod" +} diff --git a/internal/configs/testdata/config-diagnostics/invalid-provider/mod/main.tf b/internal/configs/testdata/config-diagnostics/invalid-provider/mod/main.tf new file mode 100644 index 000000000000..f50ced1fe327 --- /dev/null +++ b/internal/configs/testdata/config-diagnostics/invalid-provider/mod/main.tf @@ -0,0 +1,2 @@ +provider "crash_es" { +} diff --git a/internal/configs/testdata/config-diagnostics/invalid-provider/warnings b/internal/configs/testdata/config-diagnostics/invalid-provider/warnings new file mode 100644 index 000000000000..8bdc68eebf85 --- /dev/null +++ b/internal/configs/testdata/config-diagnostics/invalid-provider/warnings @@ -0,0 +1 @@ +Empty provider configuration blocks are not required From 529a2c34dfd14d8b41c9d5caf68415ec750dd825 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Tue, 7 Dec 2021 17:09:13 -0500 Subject: [PATCH 400/644] Update note and add learn call out --- .../language/modules/develop/refactoring.html.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/website/docs/language/modules/develop/refactoring.html.md b/website/docs/language/modules/develop/refactoring.html.md index a7381a4c4809..22f548ec4046 100644 --- a/website/docs/language/modules/develop/refactoring.html.md +++ b/website/docs/language/modules/develop/refactoring.html.md @@ -8,12 +8,9 @@ description: |- # Refactoring -~> **Note:** Explicit refactoring declarations with `moved` blocks will work -only in Terraform v1.1 and later. When working with earlier Terraform versions, -or for refactoring actions too complex to express as `moved` blocks, you could -use -[the `terraform state mv` CLI command](/docs/cli/commands/state/mv.html) -as a separate step instead. +-> **Note:** Explicit refactoring declarations with `moved` blocks is available in Terraform v1.1 and later. For earlier Terraform versions or for refactoring actions too complex to express as `moved` blocks, you can +use the [`terraform state mv` CLI command](/docs/cli/commands/state/mv.html) +as a separate step. In shared modules and long-lived configurations, you may eventually outgrow your initial module structure and resource names. For example, you might decide @@ -29,6 +26,8 @@ When you add `moved` blocks in your configuration to record where you've historically moved or renamed an object, Terraform treats an existing object at the old address as if it now belongs to the new address. +> **Hands On:** Try the [Use Configuration to Move Resources](https://learn.hashicorp.com/tutorials/terraform/move-config) tutorial on HashiCorp Learn. + ## `moved` Block Syntax A `moved` block expects no labels and contains only `from` and `to` arguments: @@ -426,9 +425,9 @@ moved { ## Removing `moved` Blocks -Over time, a long-lasting module may accumulate many `moved` blocks. +Over time, a long-lasting module may accumulate many `moved` blocks. -Removing a `moved` block is a generally breaking change because any configurations that refer to the old address will plan to delete that existing object instead of move it. We strongly recommend that you retain all historical `moved` blocks from earlier versions of your modules to preserve the upgrade path for users of any previous version. +Removing a `moved` block is a generally breaking change because any configurations that refer to the old address will plan to delete that existing object instead of move it. We strongly recommend that you retain all historical `moved` blocks from earlier versions of your modules to preserve the upgrade path for users of any previous version. If you do decide to remove `moved` blocks, proceed with caution. It can be safe to remove `moved` blocks when you are maintaining private modules within an organization and you are certain that all users have successfully run `terraform apply` with your new module version. From f521ba6cd747d8c44b35c3c2b22082e01357c756 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 7 Dec 2021 15:07:22 -0600 Subject: [PATCH 401/644] Remove 'enhanced' backend type distinction As explained in the changes: The 'enhanced' backend terminology, which only truly pertains to the 'remote' backend with a single API (Terraform Cloud/Enterprise's), has been found to be a confusing vestige which need only be explained in the context of the 'remote' backend. These changes reorient the explanation(s) of backends to pertain more directly to their primary purpose, which is storage of state snapshots (and not implementing operations). That Terraform operations are still _implemented_ by the literal `Backend` and `Enhanced` interfaces is inconsequential a user of Terraform, an internal detail. --- docs/architecture.md | 29 ++--- internal/backend/backend.go | 7 +- .../settings/backends/artifactory.html.md | 4 +- .../settings/backends/azurerm.html.md | 4 +- .../settings/backends/configuration.html.md | 16 ++- .../language/settings/backends/consul.html.md | 2 - .../language/settings/backends/cos.html.md | 5 +- .../language/settings/backends/etcd.html.md | 4 +- .../language/settings/backends/etcdv3.html.md | 2 - .../language/settings/backends/gcs.html.md | 6 +- .../language/settings/backends/http.html.md | 10 +- .../language/settings/backends/index.html.md | 109 +++++------------- .../settings/backends/kubernetes.html.md | 4 +- .../language/settings/backends/manta.html.md | 4 +- .../language/settings/backends/oss.html.md | 4 +- .../language/settings/backends/pg.html.md | 2 - .../language/settings/backends/remote.html.md | 31 ++--- .../language/settings/backends/s3.html.md | 2 - .../language/settings/backends/swift.html.md | 4 +- .../language/settings/terraform-cloud.html.md | 37 ++++++ website/layouts/language.erb | 13 +-- 21 files changed, 138 insertions(+), 161 deletions(-) create mode 100644 website/docs/language/settings/terraform-cloud.html.md diff --git a/docs/architecture.md b/docs/architecture.md index 2f060b266f43..0c93b16f1d7c 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -61,29 +61,22 @@ Backends that are able to execute operations additionally implement the command-handling code calls `Operation` with the operation it has constructed, and then the backend is responsible for executing that action. -Most backends do _not_ implement this interface, and so the `command` package -wraps these backends in an instance of +Backends that execute operations, however, do so as an architectural implementation detail and not a +general feature of backends. That is, the term 'backend' as a Terraform feature is used to refer to +a plugin that determines where Terraform stores its state snapshots - only the default `local` +backend and Terraform Cloud's backends (`remote`, `cloud`) perform operations. + +Thus, most backends do _not_ implement this interface, and so the `command` package wraps these +backends in an instance of [`local.Local`](https://pkg.go.dev/github.com/hashicorp/terraform/internal/backend/local#Local), -causing the operation to be executed locally within the `terraform` process -itself, which (at the time of writing) is currently the only way an operation -can be executed. +causing the operation to be executed locally within the `terraform` process itself. ## Backends -A _backend_ has a number of responsibilities in Terraform: - -* Execute operations (e.g. plan, apply) -* Store state -* Store workspace-defined variables (in the future; not yet implemented) - -As described above, the `local.Local` implementation -- named `local` from the -user's standpoint -- is the only backend which implements _all_ functionality. -Backends that cannot execute operations (at the time of writing, all except -`local`) can be wrapped inside `local.Local` to perform operations locally -while storing the [state](https://www.terraform.io/docs/state/index.html) -elsewhere. +A _backend_ determines where Terraform should store its state snapshots. -To execute an operation locally, the `local` backend uses a _state manager_ +As described above, the `local` backend also executes operations on behalf of most other +backends. It uses a _state manager_ (either [`statemgr.Filesystem`](https://pkg.go.dev/github.com/hashicorp/terraform/internal/states/statemgr#Filesystem) if the local backend is being used directly, or an implementation provided by whatever diff --git a/internal/backend/backend.go b/internal/backend/backend.go index 9f1855eb291f..4124b2abdb8c 100644 --- a/internal/backend/backend.go +++ b/internal/backend/backend.go @@ -118,9 +118,10 @@ type Backend interface { // Enhanced implements additional behavior on top of a normal backend. // -// Enhanced backends allow customizing the behavior of Terraform operations. -// This allows Terraform to potentially run operations remotely, load -// configurations from external sources, etc. +// 'Enhanced' backends are an implementation detail only, and are no longer reflected as an external +// 'feature' of backends. In other words, backends refer to plugins for remote state snapshot +// storage only, and the Enhanced interface here is a necessary vestige of the 'local' and +// remote/cloud backends only. type Enhanced interface { Backend diff --git a/website/docs/language/settings/backends/artifactory.html.md b/website/docs/language/settings/backends/artifactory.html.md index 2e19dea8900d..d3cdf789fbc3 100644 --- a/website/docs/language/settings/backends/artifactory.html.md +++ b/website/docs/language/settings/backends/artifactory.html.md @@ -8,8 +8,6 @@ description: |- # artifactory -**Kind: Standard (with no locking)** - Stores the state as an artifact in a given repository in [Artifactory](https://www.jfrog.com/artifactory/). @@ -19,6 +17,8 @@ configurations may be kept at different subpaths within the repository. -> **Note:** The URL must include the path to the Artifactory installation. It will likely end in `/artifactory`. +This backend does **not** support [state locking](/docs/language/state/locking.html). + ## Example Configuration ```hcl diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index 9179a555101a..632f6d2c6cbd 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -9,9 +9,9 @@ description: |- # azurerm -**Kind: Standard (with state locking)** +Stores the state as a Blob with the given Key within the Blob Container within [the Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction). -Stores the state as a Blob with the given Key within the Blob Container within [the Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction). This backend also supports state locking and consistency checking via native capabilities of Azure Blob Storage. +This backend supports state locking and consistency checking via native capabilities of Azure Blob Storage. -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. diff --git a/website/docs/language/settings/backends/configuration.html.md b/website/docs/language/settings/backends/configuration.html.md index 886413e7ef78..dc848d3bc354 100644 --- a/website/docs/language/settings/backends/configuration.html.md +++ b/website/docs/language/settings/backends/configuration.html.md @@ -5,11 +5,17 @@ page_title: "Backend Configuration - Configuration Language" # Backend Configuration +Each Terraform configuration can specify a backend, which defines where +[state](/docs/language/state/index.html) snapshots are stored. -Each Terraform configuration can specify a backend, which defines exactly where -and how operations are performed, where [state](/docs/language/state/index.html) -snapshots are stored, etc. Most non-trivial Terraform configurations configure -a remote backend so that multiple people can work with the same infrastructure. +Backend configuration is not needed when using Terraform Cloud, because +Terraform Cloud automatically manages state in the workspaces your configuration +is associated with. If your configuration includes +[a `cloud` block](/docs/language/settings/terraform-cloud.html), +it cannot include a `backend` block. + +Most non-trivial Terraform configurations store state remotely so that multiple +people can work with the same infrastructure. ## Using a Backend Block @@ -45,7 +51,7 @@ See the list of backend types in the navigation sidebar for details about each s ### Default Backend -If a configuration includes no backend block, Terraform defaults to using the `local` backend, which performs operations on the local system and stores state as a plain file in the current working directory. +If a configuration includes no backend block, Terraform defaults to using the `local` backend, which stores state as a plain file in the current working directory. ## Initialization diff --git a/website/docs/language/settings/backends/consul.html.md b/website/docs/language/settings/backends/consul.html.md index d2f921454018..dcb21df88a05 100644 --- a/website/docs/language/settings/backends/consul.html.md +++ b/website/docs/language/settings/backends/consul.html.md @@ -8,8 +8,6 @@ description: |- # consul -**Kind: Standard (with locking)** - Stores the state in the [Consul](https://www.consul.io/) KV store at a given path. This backend supports [state locking](/docs/language/state/locking.html). diff --git a/website/docs/language/settings/backends/cos.html.md b/website/docs/language/settings/backends/cos.html.md index cef18670c275..4e8772f91bbf 100644 --- a/website/docs/language/settings/backends/cos.html.md +++ b/website/docs/language/settings/backends/cos.html.md @@ -8,10 +8,9 @@ description: |- # COS -**Kind: Standard (with locking)** - Stores the state as an object in a configurable prefix in a given bucket on [Tencent Cloud Object Storage](https://intl.cloud.tencent.com/product/cos) (COS). -This backend also supports [state locking](/docs/language/state/locking.html). + +This backend supports [state locking](/docs/language/state/locking.html). ~> **Warning!** It is highly recommended that you enable [Object Versioning](https://intl.cloud.tencent.com/document/product/436/19883) on the COS bucket to allow for state recovery in the case of accidental deletions and human error. diff --git a/website/docs/language/settings/backends/etcd.html.md b/website/docs/language/settings/backends/etcd.html.md index 792b7354c577..771b74d72480 100644 --- a/website/docs/language/settings/backends/etcd.html.md +++ b/website/docs/language/settings/backends/etcd.html.md @@ -8,10 +8,10 @@ description: |- # etcd -**Kind: Standard (with no locking)** - Stores the state in [etcd 2.x](https://coreos.com/etcd/docs/latest/v2/README.html) at a given path. +This backend does **not** support [state locking](/docs/language/state/locking.html). + ## Example Configuration ```hcl diff --git a/website/docs/language/settings/backends/etcdv3.html.md b/website/docs/language/settings/backends/etcdv3.html.md index 318a7b405df3..478f79d2ca6c 100644 --- a/website/docs/language/settings/backends/etcdv3.html.md +++ b/website/docs/language/settings/backends/etcdv3.html.md @@ -8,8 +8,6 @@ description: |- # etcdv3 -**Kind: Standard (with locking)** - Stores the state in the [etcd](https://etcd.io/) KV store with a given prefix. This backend supports [state locking](/docs/language/state/locking.html). diff --git a/website/docs/language/settings/backends/gcs.html.md b/website/docs/language/settings/backends/gcs.html.md index 1d869579e281..172c1154a044 100644 --- a/website/docs/language/settings/backends/gcs.html.md +++ b/website/docs/language/settings/backends/gcs.html.md @@ -8,10 +8,10 @@ description: |- # gcs -**Kind: Standard (with locking)** - Stores the state as an object in a configurable prefix in a pre-existing bucket on [Google Cloud Storage](https://cloud.google.com/storage/) (GCS). -This backend also supports [state locking](/docs/language/state/locking.html). The bucket must exist prior to configuring the backend. +The bucket must exist prior to configuring the backend. + +This backend supports [state locking](/docs/language/state/locking.html). ~> **Warning!** It is highly recommended that you enable [Object Versioning](https://cloud.google.com/storage/docs/object-versioning) diff --git a/website/docs/language/settings/backends/http.html.md b/website/docs/language/settings/backends/http.html.md index e87903c4458e..78eedcba922f 100644 --- a/website/docs/language/settings/backends/http.html.md +++ b/website/docs/language/settings/backends/http.html.md @@ -8,15 +8,15 @@ description: |- # http -**Kind: Standard (with optional locking)** - Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client. State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable. -When locking support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The endpoint should -return a 423: Locked or 409: Conflict with the holding lock info when it's already taken, 200: OK for success. Any other status -will be considered an error. The ID of the holding lock info will be added as a query parameter to state updates requests. +This backend optionally supports [state locking](/docs/language/state/locking.html). When locking +support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The +endpoint should return a 423: Locked or 409: Conflict with the holding lock info when it's already +taken, 200: OK for success. Any other status will be considered an error. The ID of the holding lock +info will be added as a query parameter to state updates requests. ## Example Usage diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index 5a8a75359ae1..1188cfcdf857 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -1,14 +1,16 @@ --- layout: "language" page_title: "Backend Overview - Configuration Language" -description: "A backend defines where and how Terraform performs operations, such as where it stores state files. Learn about recommended backends and how backends work." +description: "A backend defines where Terraform stores its state. Learn about how backends work." --- # Backends -Each Terraform configuration can specify a backend, which defines where -and how operations are performed, where [state](/docs/language/state/index.html) -snapshots are stored, etc. +Backends define where Terraform's [state](/docs/language/state/index.html) snapshots are stored. + +A given Terraform configuration can either specify a backend, +[integrate with Terraform Cloud](/docs/language/settings/terraform-cloud.html), +or do neither and default to storing state locally. The rest of this page introduces the concept of backends; the other pages in this section document how to configure and use backends. @@ -20,92 +22,37 @@ this section document how to configure and use backends. documenting its behavior and available settings. See the navigation sidebar for a complete list. -## Recommended Backends - -- If you are still learning how to use Terraform, we recommend using the default - `local` backend, which requires no configuration. -- If you and your team are using Terraform to manage meaningful infrastructure, - we recommend using the `remote` backend with [Terraform Cloud](/docs/cloud/index.html) - or [Terraform Enterprise](/docs/enterprise/index.html). - -## Where Backends are Used - -Backend configuration is only used by [Terraform CLI](/docs/cli/index.html). -Terraform Cloud and Terraform Enterprise always use their own state storage when -performing Terraform runs, so they ignore any backend block in the -configuration. - -But since it's common to -[use Terraform CLI alongside Terraform Cloud](/docs/cloud/run/cli.html) -(and since certain state operations, like [tainting](/docs/cli/commands/taint.html), -can only be performed on the CLI), we recommend that Terraform Cloud users -include a backend block in their configurations and configure the `remote` -backend to use the relevant Terraform Cloud workspace(s). - -## Where Backends Come From - -Terraform includes a built-in selection of backends; this selection has changed -over time, but does not change very often. - -The built-in backends are the only backends. You cannot load additional backends -as plugins. - ## What Backends Do -There are two areas of Terraform's behavior that are determined by the backend: - -- Where state is stored. -- Where operations are performed. - -### State +Backends primarily determine where Terraform stores its [state](/docs/language/state/index.html). +Terraform uses this persisted [state](/docs/language/state/index.html) data to keep track of the +resources it manages. Since it needs the state in order to know which real-world infrastructure +objects correspond to the resources in a configuration, everyone working with a given collection of +infrastructure resources must be able to access the same state data. -Terraform uses persistent [state](/docs/language/state/index.html) data to keep track of -the resources it manages. Since it needs the state in order to know which -real-world infrastructure objects correspond to the resources in a -configuration, everyone working with a given collection of infrastructure -resources must be able to access the same state data. - -The `local` backend stores state as a local file on disk, but every other -backend stores state in a remote service of some kind, which allows multiple -people to access it. Accessing state in a remote service generally requires some -kind of access credentials, since state data contains extremely sensitive -information. +By default, Terraform implicitly uses a backend called +[`local`](/docs/language/settings/backends/local.html) to store state as a local file on disk. +Every other backend stores state in a remote service of some kind, which allows multiple people to +access it. Accessing state in a remote service generally requires some kind of access credentials, +since state data contains extremely sensitive information. Some backends act like plain "remote disks" for state files; others support _locking_ the state while operations are being performed, which helps prevent conflicts and inconsistencies. -### Operations - -"Operations" refers to performing API requests against infrastructure services -in order to create, read, update, or destroy resources. Not every `terraform` -subcommand performs API operations; many of them only operate on state data. +-> **Note:** In Terraform versions prior to 1.1.0, backends were also classifid as being 'standard' +or 'enhanced', where the latter term referred to the ability of the +[remote](/docs/language/settings/sbackends/remote.html) backend to not only store state but perform +Terraform operations. This classification has been removed, clarifying the primary purpose of +backends. See [Configuring Terraform Cloud](/docs/language/settings/configuring-terraform-cloud) to +store state, execute remote operations, and use Terraform Cloud directly from Terraform. -Only two backends actually perform operations: `local` and `remote`. +## Available Backends -The `local` backend performs API operations directly from the machine where the -`terraform` command is run. Whenever you use a backend other than `local` or -`remote`, Terraform uses the `local` backend for operations; it only uses the -configured backend for state storage. +Terraform includes a built-in selection of backends, which are listed in the +navigation sidebar. This selection has changed over time, but does not change +very often. -The `remote` backend can perform API operations remotely, using Terraform Cloud -or Terraform Enterprise. When running remote operations, the local `terraform` -command displays the output of the remote actions as though they were being -performed locally, but only the remote system requires cloud credentials or -network access to the resources being managed. - -Remote operations are optional for the `remote` backend; the settings for the -target Terraform Cloud workspace determine whether operations run remotely or -locally. If local operations are configured, Terraform uses the `remote` backend -for state and the `local` backend for operations, like with the other state -backends. - -### Backend Types - -Terraform's backends are divided into two main types, according to how they -handle state and operations: +The built-in backends are the only backends. You cannot load additional backends +as plugins. -- **Enhanced** backends can both store state and perform operations. There are - only two enhanced backends: `local` and `remote`. -- **Standard** backends only store state, and rely on the `local` backend for - performing operations. diff --git a/website/docs/language/settings/backends/kubernetes.html.md b/website/docs/language/settings/backends/kubernetes.html.md index 71d80e24fe56..20e3ecc1b38d 100644 --- a/website/docs/language/settings/backends/kubernetes.html.md +++ b/website/docs/language/settings/backends/kubernetes.html.md @@ -10,9 +10,9 @@ description: |- -> **Note:** This backend is limited by Kubernetes' maximum Secret size of 1MB. See [Secret restrictions](https://kubernetes.io/docs/concepts/configuration/secret/#restrictions) for details. -**Kind: Standard (with locking)** +Stores the state in a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). -Stores the state in a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/) with locking done using a Lease resource. +This backend supports [state locking](/docs/language/state/locking.html), with locking done using a Lease resource. ## Example Configuration diff --git a/website/docs/language/settings/backends/manta.html.md b/website/docs/language/settings/backends/manta.html.md index ef82e5602ff4..150b3633b81e 100644 --- a/website/docs/language/settings/backends/manta.html.md +++ b/website/docs/language/settings/backends/manta.html.md @@ -8,10 +8,10 @@ description: |- # manta -**Kind: Standard (with locking within Manta)** - Stores the state as an artifact in [Manta](https://www.joyent.com/manta). +This backend supports [state locking](/docs/language/state/locking.html), with locking within Manta. + ## Example Configuration ```hcl diff --git a/website/docs/language/settings/backends/oss.html.md b/website/docs/language/settings/backends/oss.html.md index e2a0adc12b8e..a67ac94fff57 100644 --- a/website/docs/language/settings/backends/oss.html.md +++ b/website/docs/language/settings/backends/oss.html.md @@ -8,14 +8,14 @@ description: |- # OSS -**Kind: Standard (with locking via TableStore)** - Stores the state as a given key in a given bucket on Stores [Alibaba Cloud OSS](https://www.alibabacloud.com/help/product/31815.htm). This backend also supports state locking and consistency checking via [Alibaba Cloud Table Store](https://www.alibabacloud.com/help/doc-detail/27280.htm), which can be enabled by setting the `tablestore_table` field to an existing TableStore table name. +This backend supports [state locking](/docs/language/state/locking.html) via TableStore. + -> **Note:** The OSS backend is available from terraform version 0.12.2. ## Example Configuration diff --git a/website/docs/language/settings/backends/pg.html.md b/website/docs/language/settings/backends/pg.html.md index 934345f34b3b..509f33c8ef30 100644 --- a/website/docs/language/settings/backends/pg.html.md +++ b/website/docs/language/settings/backends/pg.html.md @@ -8,8 +8,6 @@ description: |- # pg -**Kind: Standard (with locking)** - Stores the state in a [Postgres database](https://www.postgresql.org) version 10 or newer. This backend supports [state locking](/docs/language/state/locking.html). diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.html.md index a011993a0c88..3e8d6ded317f 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.html.md @@ -8,17 +8,22 @@ description: |- # remote -**Kind: Enhanced** +-> **Note:** With the release of Terraform v1.1.0, we recommend using the Terraform Cloud's built-in +[`cloud` integration](/docs/language/settings/terraform-cloud.html) instead of this backend. +The `cloud` option includes an improved user experience and more features. --> **Note:** We recommend using Terraform v0.11.13 or newer with this -backend. This backend requires either a Terraform Cloud account on -[app.terraform.io](https://app.terraform.io) or a Terraform Enterprise instance -(version v201809-1 or newer). +-> **Note:** This backend is unique among all other Terraform backends in that it has the ability to +execute operations for Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html), rather +than only store state snapshots. (The documentation used to refer to this as "enhanced" backend +behavior, but it's simpler to describe it as a quirk of the `remote` backend.) + +-> **Note:** The remote backend requires Terraform v0.11.13 or newer, and requires either a +Terraform Cloud account on [app.terraform.io](https://app.terraform.io) or a Terraform Enterprise +instance (version v201809-1 or newer). -The remote backend stores Terraform state and may be used to run operations in Terraform Cloud. When using full remote operations, operations like `terraform plan` or `terraform apply` can be executed in Terraform -Cloud's run environment, with log output streaming to the local terminal. Remote plans and applies use variable values from the associated Terraform Cloud workspace. +Cloud's run environment, with log output streaming to the local terminal. Remote plans and applies use variable values from the associated Terraform Cloud workspace. Terraform Cloud can also be used with local operations, in which case only state is stored in the Terraform Cloud backend. @@ -70,16 +75,16 @@ the Terraform CLI workspace `prod` within the current configuration. Remote Terraform operations such as `plan` and `apply` executed against that Terraform CLI workspace will be executed in the Terraform Cloud workspace `networking-prod`. -Additionally, the [`${terraform.workspace}`](/docs/language/state/workspaces.html#current-workspace-interpolation) -interpolation sequence should be removed from Terraform configurations that run +Additionally, the [`terraform.workspace`](/docs/language/state/workspaces.html#referencing-the-current-workspace-name) +expression shouldn't be used in Terraform configurations that use Terraform 1.0.x or earlier and run remote operations against Terraform Cloud workspaces. The reason for this is that -each Terraform Cloud workspace currently only uses the single `default` Terraform +prior to Terraform 1.1.0, Terraform Cloud workspaces only used the single `default` Terraform CLI workspace internally. In other words, if your Terraform configuration used `${terraform.workspace}` to return `dev` or `prod`, remote runs in Terraform Cloud would always evaluate it as `default` regardless of which workspace you had set with the `terraform workspace select` command. That -would most likely not be what you wanted. (It is ok to use `${terraform.workspace}` -in local operations.) +would most likely not be what you wanted. (It is ok to use `terraform.workspace` +in local operations, and with remote operations in workspaces configured to use Terraform 1.1.0 or later.) The backend configuration requires either `name` or `prefix`. Omitting both or setting both results in a configuration error. @@ -190,7 +195,7 @@ The following configuration options are supported: workspace names are used in Terraform Cloud, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with `name`. - + -> **Note:** You must use the `name` key when configuring a `terraform_remote_state` data source that retrieves state from another Terraform Cloud workspace. The `prefix` key is only intended for use when configuring an instance of the remote backend. diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.html.md index e043701f445b..f5b2d2ee0995 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.html.md @@ -8,8 +8,6 @@ description: |- # S3 -**Kind: Standard (with locking via DynamoDB)** - Stores the state as a given key in a given bucket on [Amazon S3](https://aws.amazon.com/s3/). This backend also supports state locking and consistency checking via diff --git a/website/docs/language/settings/backends/swift.html.md b/website/docs/language/settings/backends/swift.html.md index 8bc3d783a3e3..b53d83087e7b 100644 --- a/website/docs/language/settings/backends/swift.html.md +++ b/website/docs/language/settings/backends/swift.html.md @@ -8,10 +8,10 @@ description: |- # swift -**Kind: Standard (with locking)** - Stores the state as an artifact in [Swift](http://docs.openstack.org/developer/swift/latest/). +This backend supports [state locking](/docs/language/state/locking.html). + ~> Warning! It is highly recommended that you enable [Object Versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) by setting the [`archive_container`](https://www.terraform.io/docs/language/settings/backends/swift.html#archive_container) configuration. This allows for state recovery in the case of accidental deletions and human error. ## Example Configuration diff --git a/website/docs/language/settings/terraform-cloud.html.md b/website/docs/language/settings/terraform-cloud.html.md new file mode 100644 index 000000000000..e0887c2a0de0 --- /dev/null +++ b/website/docs/language/settings/terraform-cloud.html.md @@ -0,0 +1,37 @@ +--- +layout: "language" +page_title: "Terraform Cloud Configuration - Terraform Settings - Configuration Language" +sidebar_current: "docs-config-terraform" +description: "The nested `cloud` block configures Terraform's integration with Terraform Cloud." +--- + +# Terraform Cloud Configuration + +The main module of a Terraform configuration can integrate with Terraform Cloud to enable its +[CLI-driven run workflow](/docs/cloud/run/cli.html). These settings are only needed when +using Terraform CLI to interact with Terraform Cloud, and are ignored when interacting with +Terraform Cloud via version control or the API. + +Terraform Cloud is configured with a nested `cloud` block within the top-level +`terraform` block: + +```hcl +terraform { + cloud { + organization = "example_corp" + + workspaces { + tags = ["app"] + } + } +} +``` + +Using the Cloud integration is mutually exclusive of declaring any [state backend](/docs/language/settings/backends/index.html); that is, a configuration +can only declare one or the other. Similar to backends... + +- A configuration can only provide one cloud block. +- A cloud block cannot refer to named values (like input variables, locals, or data source attributes). + +See [Configuring Terraform Cloud](/docs/cli/cloud/index.html) +in the Terraform CLI docs for more information. diff --git a/website/layouts/language.erb b/website/layouts/language.erb index 91818808ed4e..1fb37c0f31ff 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -850,6 +850,10 @@ Overview +
    • + Terraform Cloud +
      • +
    • Backends
        @@ -862,7 +866,7 @@
      • - Enhanced Backends + Available Backends -
        • - - -
      • - Standard Backends -
        • artifactory
          • From b80e98ab47ddb97e19e4829c943309926f5529c8 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 7 Dec 2021 15:28:44 -0600 Subject: [PATCH 402/644] Misc doc edits referencing state/settings --- website/docs/language/settings/index.html.md | 16 ++++++++++++++-- website/docs/language/state/remote.html.md | 4 ++-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/website/docs/language/settings/index.html.md b/website/docs/language/settings/index.html.md index 5fa8949ac764..fbeec6c4c7f9 100644 --- a/website/docs/language/settings/index.html.md +++ b/website/docs/language/settings/index.html.md @@ -2,7 +2,7 @@ layout: "language" page_title: "Terraform Settings - Configuration Language" sidebar_current: "docs-config-terraform" -description: "The terraform block allows you to configure Terraform behavior, including the Terraform version, backend, and required providers." +description: "The terraform block allows you to configure Terraform behavior, including the Terraform version, backend, integration with Terraform Cloud, and required providers." --- # Terraform Settings @@ -29,9 +29,21 @@ etc, and may not use any of the Terraform language built-in functions. The various options supported within a `terraform` block are described in the following sections. +## Configuring Terraform Cloud + +The nested `cloud` block configures Terraform Cloud for enabling its +[CLI-driven run workflow](/docs/cloud/run/cli.html). + +- For a summary of the `cloud` block's syntax, see +[Terraform Cloud Configuration](/docs/language/settings/terraform-cloud.html). + +- For more complete details about configuring and using Terraform Cloud with Terraform CLI, +see [Configuring Terraform Cloud](/docs/cli/cloud/index.html) in the +Terraform CLI documentation. + ## Configuring a Terraform Backend -The nested `backend` block configures which backend Terraform should use. +The nested `backend` block configures which state backend Terraform should use. The syntax and behavior of the `backend` block is described in [Backend Configuration](/docs/language/settings/backends/configuration.html). diff --git a/website/docs/language/state/remote.html.md b/website/docs/language/state/remote.html.md index 998b479452fd..b9cf39d64cbe 100644 --- a/website/docs/language/state/remote.html.md +++ b/website/docs/language/state/remote.html.md @@ -19,8 +19,8 @@ which can then be shared between all members of a team. Terraform supports storing state in [Terraform Cloud](https://www.hashicorp.com/products/terraform/), [HashiCorp Consul](https://www.consul.io/), Amazon S3, Azure Blob Storage, Google Cloud Storage, Alibaba Cloud OSS, and more. -Remote state is implemented by a [backend](/docs/language/settings/backends/index.html), -which you can configure in your configuration's root module. +Remote state is implemented by a [backend](/docs/language/settings/backends/index.html) or by +Terraform Cloud, both of which you can configure in your configuration's root module. ## Delegation and Teamwork From 099c7269e453ad290033133b90e8ff9ccc2a6b17 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Tue, 7 Dec 2021 15:29:11 -0600 Subject: [PATCH 403/644] Add Terraform Cloud integration docs --- .../cli/cloud/command-line-arguments.html.md | 27 +++++ website/docs/cli/cloud/index.html.md | 32 ++++++ website/docs/cli/cloud/migrating.html.md | 86 +++++++++++++++ website/docs/cli/cloud/settings.html.md | 103 ++++++++++++++++++ website/docs/cli/workspaces/index.html.md | 9 +- website/docs/language/settings/index.html.md | 2 +- .../language/settings/terraform-cloud.html.md | 2 +- .../docs/language/state/workspaces.html.md | 5 +- website/layouts/docs.erb | 23 +++- 9 files changed, 277 insertions(+), 12 deletions(-) create mode 100644 website/docs/cli/cloud/command-line-arguments.html.md create mode 100644 website/docs/cli/cloud/index.html.md create mode 100644 website/docs/cli/cloud/migrating.html.md create mode 100644 website/docs/cli/cloud/settings.html.md diff --git a/website/docs/cli/cloud/command-line-arguments.html.md b/website/docs/cli/cloud/command-line-arguments.html.md new file mode 100644 index 000000000000..ca51ce0e7bd3 --- /dev/null +++ b/website/docs/cli/cloud/command-line-arguments.html.md @@ -0,0 +1,27 @@ +--- +layout: "docs" +page_title: "Command Line Arguments" +description: "Command Line Arguments" +--- + +# Command Line Arguments + +When your configuration includes a `cloud` block, commands that +make local modifications to Terraform state and then push them back up to the remote workspace +accept the following option to modify that behavior: + +* `-ignore-remote-version` - Override checking that the local and remote + Terraform versions agree, making an operation proceed even when there is + a mismatch. + + Normally state-modification operations require using a local version of + Terraform CLI that is compatible with the Terraform version selected + for the remote workspace as part of its settings. This is to avoid the + local operation creating a new state snapshot that the workspace's + remote execution environment would then be unable to decode. + + Overriding this check can result in a Terraform Cloud workspace that is no + longer able to complete remote operations with the currently selected + version of Terraform, so we recommend against using this option unless + absolutely necessary. + diff --git a/website/docs/cli/cloud/index.html.md b/website/docs/cli/cloud/index.html.md new file mode 100644 index 000000000000..e6a0c6acbf0b --- /dev/null +++ b/website/docs/cli/cloud/index.html.md @@ -0,0 +1,32 @@ +--- +layout: "docs" +page_title: "Using Terraform Cloud - Terraform CLI" +--- + +# Using Terraform Cloud with Terraform + +The Terraform Cloud CLI Integration allows you to use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated. + +Using Terraform Cloud through the command line is called the [CLI-driven run workflow](/docs/cloud/run/cli.html). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in Terraform Cloud's run environment by default, with log output streaming to the local terminal. This lets you use Terraform Cloud features within the familiar Terraform CLI workflow, including variables encrypted at rest in a Terraform Cloud workspace, cost estimates, and policy checking. + +Workspaces can also be configured for local execution, in which case only state is stored in +Terraform Cloud. In this mode, Terraform Cloud behaves just like a standard state backend. + +-> **Note:** The Cloud integration for Terraform was added in Terraform 1.1.0; for previous +versions, see the [remote backend documentation](/docs/language/settings/backends/remote.html). See +also: [Migrating from the remote +backend](/docs/cli/cloud/migrating.html) + +-> **Note:** This integration supports Terraform Enterprise as well. Throughout all the +documentation, the platform will be referred to as Terraform Cloud, with any Terraform +Enterprise-specific details explicitly stated. The minimum required version of Terraform Enterprise +is 202201-1. + +## Documentation Summary + +- [Terraform Cloud Settings](/docs/cli/cloud/settings.html) documents the `cloud` block that you must add to your configuration to enable Terraform Cloud support. +- [Initializing and Migrating](/docs/cli/cloud/migrating.html) describes +how to start using Terraform Cloud with a working directory that already has state data. +- [Command Line Arguments](/docs/cli/cloud/command-line-arguments.html) lists the Terraform command flags that are specific to using Terraform with Terraform Cloud. + +Refer to the [CLI-driven Run Workflow](/docs/cloud/run/cli.html) for more details about how to use Terraform Cloud from the command line. diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md new file mode 100644 index 000000000000..ca24b31064d2 --- /dev/null +++ b/website/docs/cli/cloud/migrating.html.md @@ -0,0 +1,86 @@ +--- +layout: "docs" +page_title: "Initializing and Migrating to Terraform Cloud - Terraform CLI" +--- + +# Initializing and Migrating + +After [configuring Terraform Cloud settings](/docs/cli/cloud/settings.html) for a working directory, you must run `terraform init` to finish setting up. When running this command, Terraform may guide you through an interactive process where you may choose whether or not you'd like to migrate state from any existing workspaces. + +There are three potential scenarios: + +1. **Fresh working directory:** If the working directory has no existing Terraform state, no migrations will occur. You can start using Terraform with Terraform Cloud right away, creating workspaces and starting runs. +2. **State backend or local state:** If the working directory already has state data in one or more workspaces (using either local state or a [state backend](/docs/language/settings/backends/index.html)), Terraform will ask if you're like to migrate that state to new Terraform Cloud workspaces. You will need permission to manage workspaces in the destination Terraform Cloud organization. You may also be prompted to rename the workspaces being migrated, to better distinguish them within a Terraform Cloud organization. +3. **`remote` backend:** If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. The local names shown for those workspaces will change to match their remote names. + +The rest of this page briefly describes cases 2 and 3. + +## Migrating from Local State or Other Backends + +If the working directory already has state data available (using either local state or a [state +backend](/docs/language/settings/backends/index.html)), Terraform will ask your approval to migrate +that state to Terraform Cloud. This process is interactive and self-documenting, and resembles +moving between state backends. + +You may also be prompted to rename your workspaces during the migration, to either give a name to +the unnamed `default` workspace (Terraform Cloud requires all workspaces to have a name) or give +your workspace names more contextual information. Unlike typical Terraform workspaces representing +an environment associated with a particular configuration (e.g. production, staging, development), +Terraform Cloud workspaces are named uniquely across all configurations used within an organization. +Because of this, you'll be given an opportunity to rename the working directory's workspaces +according to a pattern relative to their existing names. A typical strategy to start with is +`--` (e.g. `networking-prod-us-east`, +`networking-staging-us-east`). For more information on workspace naming, see [Workspace +Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation. + +## Migrating from the `remote` Backend + +The [`remote` backend](/docs/language/settings/backends/remote.html) was the primary +implementation of Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html) for +Terraform versions 0.11.13 through 1.0.x. We recommend using the native `cloud` +integration for Terraform versions 1.1 or later, as it provides an improved user experience and +various enhancements. + +### Block Replacement + +When switching from the `remote` backend to a `cloud` block, Terraform will continue using the same +set of Terraform Cloud workspaces. Replace your `backend "remote"` block with an equivalent `cloud` +block: + +- If you were using a single workspace via the `name` argument, change the block + label to `cloud`. + + ```diff + terraform { + - backend "remote" { + + cloud { + organization = "my-org" + + workspaces { + name = "my-app-prod" + } + } + } + ``` + +- If you were using multiple workspaces via the `prefix` argument, replace it + with a `cloud` block that uses the `tags` argument. You may specify any number of tags to + distinguish the workspaces for your working directory, but a good starting point may be to use + whatever the prefix was before. + + The existing workspaces don't need to already have these tags — when you + initialize, Terraform will add the specified tags to them. + + ```diff + terraform { + - backend "remote" { + + cloud { + organization = "my-org" + + workspaces { + - prefix = "my-app-" + + tags = ["app:mine"] + } + } + } + ``` diff --git a/website/docs/cli/cloud/settings.html.md b/website/docs/cli/cloud/settings.html.md new file mode 100644 index 000000000000..7ad3b290d004 --- /dev/null +++ b/website/docs/cli/cloud/settings.html.md @@ -0,0 +1,103 @@ +--- +layout: "docs" +page_title: "Terraform Cloud Settings - Terraform CLI" +--- + +# Terraform Cloud Settings + +Terraform CLI can integrate with Terraform Cloud, acting as a client for Terraform Cloud's +[CLI-driven run workflow](https://www.terraform.io/docs/cloud/run/cli.html). + +To use Terraform Cloud for a particular working directory, you must configure the following settings: + +- Provide credentials to access Terraform Cloud, preferably by using the + [`terraform login`](/docs/cli/commands/login.html) command. +- Add a `cloud` block to the directory's Terraform configuration, to specify + which organization and workspace(s) to use. +- Optionally, use a `.terraformignore` file to specify files that shouldn't be + uploaded with the Terraform configuration when running plans and applies. + +After adding or changing a `cloud` block, you must run `terraform init`. + +## The `cloud` Block + +The `cloud` block is a nested block within the top-level `terraform` settings +block. It specifies which Terraform Cloud workspaces to use for the current +working directory. + +```hcl +terraform { + cloud { + organization = "my-org" + hostname = "app.terraform.io" # Optional; defaults to app.terraform.io + + workspaces { + tags = ["networking", "source:cli"] + } + } +} +``` + +The `cloud` block has some special restrictions: + +- A configuration can only provide one `cloud` block. +- A `cloud` block cannot be used with [state backends](/docs/language/settings/backends/index.html). + A configuration can use one or the other, but not both. +- A cloud block cannot refer to named values (like input variables, locals, or + data source attributes). + +The `cloud` block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration +that contains a cloud block - for example, when a workspace is configured to use a VCS provider +directly - it ignores the block and behaves according to its own workspace settings. + +### Arguments + +The `cloud` block supports the following configuration arguments: + +* `organization` - (Required) The name of the organization containing the + workspace(s) the current configuration should use. + +* `workspaces` - (Required) A nested block that specifies which remote Terraform Cloud workspaces to +use for the current configuration. The `workspaces` block must contain **exactly one** of the +following arguments, each denoting a strategy for how workspaces should be mapped: + + * `tags` - (Optional) A set of Terraform Cloud workspace tags. You will be able to use + this working directory with any workspaces that have all of the specified tags, + and can use [the `terraform workspace` commands](/docs/cli/workspaces/index.html) + to switch between them or create new workspaces; new workspaces will automatically have + the specified tags. This option conflicts with `name`. + + * `name` - (Optional) The name of a single Terraform Cloud workspace. You will + only be able to use the workspace specified in the configuration with this working + directory, and cannot manage workspaces from the CLI (e.g. `terraform workspace select` or + `terraform workspace new`). This option conflicts with `tags`. + +* `hostname` - (Optional) The hostname of a Terraform Enterprise installation, if using Terraform + Enterprise. Defaults to Terraform Cloud (app.terraform.io). + +* `token` - (Optional) The token used to authenticate with Terraform Cloud. + We recommend omitting the token from the configuration, and instead using + [`terraform login`](/docs/cli/commands/login.html) or manually configuring + `credentials` in the + [CLI config file](/docs/cli/config/config-file.html#credentials). + +## Excluding Files from Upload with .terraformignore + +When executing a remote `plan` or `apply` in a [CLI-driven run](/docs/cloud/run/cli.html), +a copy of your configuration directory is uploaded to Terraform Cloud. You can define +paths to exclude from upload by adding a `.terraformignore` file at the root of your +configuration directory. If this file is not present, the upload will exclude +the following by default: + +* `.git/` directories +* `.terraform/` directories (exclusive of `.terraform/modules`) + +The rules in `.terraformignore` file resemble the rules allowed in a +[.gitignore file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring): + +* Comments (starting with `#`) or blank lines are ignored. +* End a pattern with a forward slash `/` to specify a directory. +* Negate a pattern by starting it with an exclamation point `!`. + +Note that unlike `.gitignore`, only the `.terraformignore` at the root of the configuration +directory is considered. diff --git a/website/docs/cli/workspaces/index.html.md b/website/docs/cli/workspaces/index.html.md index e8a5dcb5e64b..6143c30879cd 100644 --- a/website/docs/cli/workspaces/index.html.md +++ b/website/docs/cli/workspaces/index.html.md @@ -68,11 +68,10 @@ act more like completely separate working directories; each Terraform Cloud workspace has its own Terraform configuration, set of variable values, state data, run history, and settings. -These two kinds of workspaces are different, but related. When using Terraform -CLI as a frontend for Terraform Cloud, you associate the current working -directory with one or more remote workspaces by configuring -[the `remote` backend](/docs/language/settings/backends/remote.html). If you associate the -directory with multiple workspaces (using a name prefix), you can use the +These two kinds of workspaces are different, but related. When [using Terraform +CLI as a frontend for Terraform Cloud](/docs/cli/cloud/index.html), you can associate the current working +directory with one or more remote workspaces. If you associate the +directory with multiple workspaces (using workspace tags), you can use the `terraform workspace` commands to select which remote workspace to use. For more information about using Terraform CLI with Terraform Cloud, see diff --git a/website/docs/language/settings/index.html.md b/website/docs/language/settings/index.html.md index fbeec6c4c7f9..9c17d2f58ae7 100644 --- a/website/docs/language/settings/index.html.md +++ b/website/docs/language/settings/index.html.md @@ -38,7 +38,7 @@ The nested `cloud` block configures Terraform Cloud for enabling its [Terraform Cloud Configuration](/docs/language/settings/terraform-cloud.html). - For more complete details about configuring and using Terraform Cloud with Terraform CLI, -see [Configuring Terraform Cloud](/docs/cli/cloud/index.html) in the +see [Using Terraform Cloud](/docs/cli/cloud/index.html) in the Terraform CLI documentation. ## Configuring a Terraform Backend diff --git a/website/docs/language/settings/terraform-cloud.html.md b/website/docs/language/settings/terraform-cloud.html.md index e0887c2a0de0..854863ad424b 100644 --- a/website/docs/language/settings/terraform-cloud.html.md +++ b/website/docs/language/settings/terraform-cloud.html.md @@ -33,5 +33,5 @@ can only declare one or the other. Similar to backends... - A configuration can only provide one cloud block. - A cloud block cannot refer to named values (like input variables, locals, or data source attributes). -See [Configuring Terraform Cloud](/docs/cli/cloud/index.html) +See [Using Terraform Cloud](/docs/cli/cloud/index.html) in the Terraform CLI docs for more information. diff --git a/website/docs/language/state/workspaces.html.md b/website/docs/language/state/workspaces.html.md index a675d8edde67..c33cad7d3147 100644 --- a/website/docs/language/state/workspaces.html.md +++ b/website/docs/language/state/workspaces.html.md @@ -80,10 +80,7 @@ Terraform workspace. Within your Terraform configuration, you may include the name of the current workspace using the `${terraform.workspace}` interpolation sequence. This can -be used anywhere interpolations are allowed. However, it should **not** be -used in remote operations against Terraform Cloud workspaces. For an -explanation, see the [remote backend](/docs/language/settings/backends/remote.html#workspaces) -document. +be used anywhere interpolations are allowed. Referencing the current workspace is useful for changing behavior based on the workspace. For example, for non-default workspaces, it may be useful diff --git a/website/layouts/docs.erb b/website/layouts/docs.erb index 602a490e565d..059d25d7f802 100644 --- a/website/layouts/docs.erb +++ b/website/layouts/docs.erb @@ -334,6 +334,27 @@
        • +
      • + Using Terraform Cloud + +
        • +
      • Automating Terraform
          @@ -565,7 +586,7 @@
        • Remote Service Discovery
          • - +
        • Resource Graph
          • From 50904620016fac32a48bfafefee75c18ce1e2368 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 7 Dec 2021 15:49:50 -0800 Subject: [PATCH 404/644] website: Terraform v1.1 upgrade guide Since this is only a minor release there isn't any super-significant upgrade guide content this time, but I've used this page to elaborate on some of the upgrade notes already recorded in the Terraform Changelog, to give additional context if needed to the hopefully-small number of users that these changes will directly effect during upgrading. --- website/layouts/language.erb | 4 + website/upgrade-guides/1-1.html.markdown | 137 +++++++++++++++++++++++ 2 files changed, 141 insertions(+) create mode 100644 website/upgrade-guides/1-1.html.markdown diff --git a/website/layouts/language.erb b/website/layouts/language.erb index 91818808ed4e..80e1d5a1122a 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -974,6 +974,10 @@ Overview +
        • + Upgrading to v1.1 +
          • +
        • Upgrading to v1.0
          • diff --git a/website/upgrade-guides/1-1.html.markdown b/website/upgrade-guides/1-1.html.markdown new file mode 100644 index 000000000000..2232e60538a5 --- /dev/null +++ b/website/upgrade-guides/1-1.html.markdown @@ -0,0 +1,137 @@ +--- +layout: "language" +page_title: "Upgrading to Terraform v1.1" +sidebar_current: "upgrade-guides-1-1" +description: |- + Upgrading to Terraform v1.1 +--- + +# Upgrading to Terraform v1.1 + +Terraform v1.1 is the first minor release after establishing a compatibility +baseline in Terraform v1.0, and so this release should not require any +unusual upgrade steps for most users. + +However, if you are upgrading from a version earlier than v1.0 then please +refer to [the Terraform v1.0 upgrade guide](1-0.html) for how to upgrade through +the v0 releases to reach the v1 release series. Because v1.1 is +backward-compatible with the v1.0 series, you can upgrade directly to the +latest v1.1 release, skipping the v1.0 series entirely, at any point where the +v1.0 upgrade guide calls for upgrading to Terraform v1.0. + +Terraform v1.1 continues to honor +[the Terraform v1.0 Compatibility Promises](/docs/language/v1-compatibility-promises.html), +but there are some behavior changes outside of those promises that may affect a +small number of users, described in the following sections. + +* [Terraform requires macOS 10.13 High Sierra or later](#terraform-requires-macos-1013-high-sierra-or-later) +* [Preparation for removing Azure AD Graph support in the AzureRM Backend](#preparation-for-removing-azure-ad-graph-support-in-the-azurerm-backend) +* [Changes to `terraform graph`](#changes-to-terraform-graph) +* [Changes to `terraform state mv`](#changes-to-terraform-state-mv) +* [Provider checksum verification in `terraform apply`](#provider-checksum-verification-in-terraform-apply) + +## Terraform requires macOS 10.13 High Sierra or later + +As operating system vendors phase out support for older versions of their +software, the Terraform team must also phase out support in order to focus +on supporting newer releases. + +With that in mind, the official releases of Terraform v1.1 now require +macOS 10.13 High Sierra or later. Earlier versions of macOS are no longer +supported, and Terraform CLI behavior on those earlier versions is undefined. + +## Preparation for removing Azure AD Graph support in the AzureRM Backend + +[Microsoft has announced the deprecation of Azure AD Graph](https://docs.microsoft.com/en-us/graph/migrate-azure-ad-graph-faq), +and so Terraform v1.1 marks the first phase of a deprecation process for +that legacy system in [the AzureRM state storage backend](/docs/language/settings/backends/azurerm.html). + +During the Terraform v1.1 release the default behavior is unchanged, but you +can explicitly opt in to Microsoft Graph by setting +`use_microsoft_graph = true` inside your `backend "azurerm` block and then +reinitializing your working directory with `terraform init -reconfigure`. + +In Terraform v1.2 we plan to change this argument to default to `true` when +not set, and so we strongly recommend planning to migrate to Microsoft Graph +in the near future to prepare for the final removal of Azure AD Graph support +in a later Terraform release. However, no immediate change is required before +upgrading to Terraform v1.1. + +## Changes to `terraform graph` + +The `terraform graph` command exists to help with debugging and so it +inherently exposes some of Terraform Core's implementation details. For that +reason it isn't included in the v1.0 Compatibility Promises, but we still +aim to preserve its behavior in spirit even as Terraform Core's internal +design changes. + +In previous releases, `terraform graph` exposed the implementation detail that +Terraform internally knows how to build graph types called "validate" and +"eval", but Terraform Core no longer exposes those graph types externally +and so consequently the graph command will no longer accept the options +`-type=validate` or `-type=eval`. + +You can see a similar result to what those graph types would previously +produce by generating a _plan_ graph, which is the default graph type and +therefore requires no special `-type=...` option. + +## Changes to `terraform state mv` + +Terraform's local state storage backend supports a number of +[legacy command line options](/docs/language/settings/backends/local.html#command-line-arguments) +for backward-compatibility with workflows from much older versions of Terraform, +prior to the introduction of Backends. + +Those options are not supported when using any other backend, but for many +commands they are simply silently ignored rather than returning an error. + +Because `terraform state mv` has some extra use-cases related to migrating +between states, it historically had some slightly different handling of those +legacy options, but was not fully consistent. + +From Terraform v1.1, the behavior of these options has changed as follows: + +* The `-state=...` argument is allowed even when a remote backend is specified + in the configuration. If present, it forces the command to work in local + mode. +* The `-backup=...` and `-backup-out=...` options are allowed only if either + the local backend is the configuration's selected backend _or_ if you + specify `-state=...` to force local state operation. These options will now + return an error if used against a remote backend, whereas previous Terraform + versions ignored them entirely in that case. + +There are no breaking changes to `terraform state mv`'s normal usage pattern, +without any special options overriding the state storage strategy. + +## Provider checksum verification in `terraform apply` + +This section applies only to situations where you might generate a saved +plan file using `terraform plan -out=tfplan` and then separately apply it +using `terraform apply tfplan`. + +You do not need to consider this section unless you are using a custom +Terraform provider which somehow modifies its own provider package contents +during execution. That is hypothetically possible, but not true in practice for +any publicly-available providers we are aware of at the time of writing this +guide. + +Our design intent for this two-step run workflow is that the saved plan +records enough information for Terraform to guarantee that it's running +against an identical set of providers during the apply step as it was during +the plan step, because otherwise the different provider plugins may disagree +about the meaning of the planned actions. + +However, prior versions of Terraform verified consistency only for the main +executable file representing a provider plugin, and didn't consider other +files that might appear alongside in the plugin package. Terraform v1.1 now +uses the same strategy for provider checking during apply as it does when +verifying provider consistency against +[the dependency lock file](/docs/language/dependency-lock.html) +during `terraform init`, which means `terraform apply` will return an error +if it detects that _any_ of the files in a provider's plugin package have +changed compared to when the plan was created. + +In the unlikely event that you _do_ use a self-modifying provider plugin, +please consider other solutions to achieve the goals which motivated that, +which do not involve the provider modifying itself at runtime. If you aren't +sure, please open a GitHub issue to discuss your use-case. From f514f8eb3081c4e004a9d4c5e6ae3f2797916501 Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:43:18 -0800 Subject: [PATCH 405/644] Apply suggestions from code review Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- .../cli/cloud/command-line-arguments.html.md | 17 +++++++------- website/docs/cli/cloud/index.html.md | 12 +++------- website/docs/cli/cloud/migrating.html.md | 7 +++--- website/docs/cli/cloud/settings.html.md | 23 +++++++++---------- .../settings/backends/azurerm.html.md | 2 +- .../settings/backends/configuration.html.md | 7 ++---- .../language/settings/backends/remote.html.md | 10 ++------ website/docs/language/settings/index.html.md | 8 +++---- .../language/settings/terraform-cloud.html.md | 16 ++++--------- 9 files changed, 38 insertions(+), 64 deletions(-) diff --git a/website/docs/cli/cloud/command-line-arguments.html.md b/website/docs/cli/cloud/command-line-arguments.html.md index ca51ce0e7bd3..aceebbbd19a9 100644 --- a/website/docs/cli/cloud/command-line-arguments.html.md +++ b/website/docs/cli/cloud/command-line-arguments.html.md @@ -10,18 +10,17 @@ When your configuration includes a `cloud` block, commands that make local modifications to Terraform state and then push them back up to the remote workspace accept the following option to modify that behavior: -* `-ignore-remote-version` - Override checking that the local and remote +- `-ignore-remote-version` - Override checking that the local and remote Terraform versions agree, making an operation proceed even when there is a mismatch. - Normally state-modification operations require using a local version of + State-modification operations usually require using a local version of the Terraform CLI that is compatible with the Terraform version selected - for the remote workspace as part of its settings. This is to avoid the - local operation creating a new state snapshot that the workspace's - remote execution environment would then be unable to decode. + in the remote workspace settings. This prevents the + local operation from creating a new state snapshot that the workspace's + remote execution environment cannot decode. - Overriding this check can result in a Terraform Cloud workspace that is no - longer able to complete remote operations with the currently selected - version of Terraform, so we recommend against using this option unless - absolutely necessary. + We recommend against using this option unless absolutely necessary. Overriding this check can result + in a Terraform Cloud workspace that is no longer able to complete remote operations with the currently + selected version of Terraform. diff --git a/website/docs/cli/cloud/index.html.md b/website/docs/cli/cloud/index.html.md index e6a0c6acbf0b..cb88583cf7c2 100644 --- a/website/docs/cli/cloud/index.html.md +++ b/website/docs/cli/cloud/index.html.md @@ -12,15 +12,9 @@ Using Terraform Cloud through the command line is called the [CLI-driven run wor Workspaces can also be configured for local execution, in which case only state is stored in Terraform Cloud. In this mode, Terraform Cloud behaves just like a standard state backend. --> **Note:** The Cloud integration for Terraform was added in Terraform 1.1.0; for previous -versions, see the [remote backend documentation](/docs/language/settings/backends/remote.html). See -also: [Migrating from the remote -backend](/docs/cli/cloud/migrating.html) - --> **Note:** This integration supports Terraform Enterprise as well. Throughout all the -documentation, the platform will be referred to as Terraform Cloud, with any Terraform -Enterprise-specific details explicitly stated. The minimum required version of Terraform Enterprise -is 202201-1. +-> **Note:** The CLI integration is available in Terraform 1.1.0 and later, and Terraform Enterprise 202201-1 and later. Previous versions can use the [`remote` backend](/docs/language/settings/backends/remote.html). Refer to [Migrating from the remote +backend](/docs/cli/cloud/migrating.html) for details about switching to the CLI integration. + ## Documentation Summary diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md index ca24b31064d2..70da1b540e94 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.html.md @@ -5,7 +5,7 @@ page_title: "Initializing and Migrating to Terraform Cloud - Terraform CLI" # Initializing and Migrating -After [configuring Terraform Cloud settings](/docs/cli/cloud/settings.html) for a working directory, you must run `terraform init` to finish setting up. When running this command, Terraform may guide you through an interactive process where you may choose whether or not you'd like to migrate state from any existing workspaces. +After [configuring Terraform Cloud settings](/docs/cli/cloud/settings.html) for a working directory, you must run `terraform init` to finish setting up. When running this command, Terraform may guide you through an interactive process where you may choose whether or not to migrate state from any existing workspaces. There are three potential scenarios: @@ -47,7 +47,7 @@ When switching from the `remote` backend to a `cloud` block, Terraform will cont set of Terraform Cloud workspaces. Replace your `backend "remote"` block with an equivalent `cloud` block: -- If you were using a single workspace via the `name` argument, change the block +- If you were using a single workspace with the `name` argument, change the block label to `cloud`. ```diff @@ -68,8 +68,7 @@ block: distinguish the workspaces for your working directory, but a good starting point may be to use whatever the prefix was before. - The existing workspaces don't need to already have these tags — when you - initialize, Terraform will add the specified tags to them. + The tags you configure do not need to be present on the existing workspaces. When you initialize, Terraform will add the specified tags to the workspaces if necessary. ```diff terraform { diff --git a/website/docs/cli/cloud/settings.html.md b/website/docs/cli/cloud/settings.html.md index 7ad3b290d004..ad61322b0706 100644 --- a/website/docs/cli/cloud/settings.html.md +++ b/website/docs/cli/cloud/settings.html.md @@ -43,7 +43,7 @@ The `cloud` block has some special restrictions: - A configuration can only provide one `cloud` block. - A `cloud` block cannot be used with [state backends](/docs/language/settings/backends/index.html). A configuration can use one or the other, but not both. -- A cloud block cannot refer to named values (like input variables, locals, or +- A `cloud` block cannot refer to named values (like input variables, locals, or data source attributes). The `cloud` block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration @@ -54,10 +54,10 @@ directly - it ignores the block and behaves according to its own workspace setti The `cloud` block supports the following configuration arguments: -* `organization` - (Required) The name of the organization containing the +- `organization` - (Required) The name of the organization containing the workspace(s) the current configuration should use. -* `workspaces` - (Required) A nested block that specifies which remote Terraform Cloud workspaces to +- `workspaces` - (Required) A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. The `workspaces` block must contain **exactly one** of the following arguments, each denoting a strategy for how workspaces should be mapped: @@ -67,7 +67,7 @@ following arguments, each denoting a strategy for how workspaces should be mappe to switch between them or create new workspaces; new workspaces will automatically have the specified tags. This option conflicts with `name`. - * `name` - (Optional) The name of a single Terraform Cloud workspace. You will + - `name` - (Optional) The name of a single Terraform Cloud workspace. You will only be able to use the workspace specified in the configuration with this working directory, and cannot manage workspaces from the CLI (e.g. `terraform workspace select` or `terraform workspace new`). This option conflicts with `tags`. @@ -75,7 +75,7 @@ following arguments, each denoting a strategy for how workspaces should be mappe * `hostname` - (Optional) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. Defaults to Terraform Cloud (app.terraform.io). -* `token` - (Optional) The token used to authenticate with Terraform Cloud. +- `token` - (Optional) The token used to authenticate with Terraform Cloud. We recommend omitting the token from the configuration, and instead using [`terraform login`](/docs/cli/commands/login.html) or manually configuring `credentials` in the @@ -89,15 +89,14 @@ paths to exclude from upload by adding a `.terraformignore` file at the root of configuration directory. If this file is not present, the upload will exclude the following by default: -* `.git/` directories -* `.terraform/` directories (exclusive of `.terraform/modules`) +- `.git/` directories +- `.terraform/` directories (exclusive of `.terraform/modules`) The rules in `.terraformignore` file resemble the rules allowed in a [.gitignore file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring): -* Comments (starting with `#`) or blank lines are ignored. -* End a pattern with a forward slash `/` to specify a directory. -* Negate a pattern by starting it with an exclamation point `!`. +- Comments (starting with `#`) or blank lines are ignored. +- End a pattern with a forward slash `/` to specify a directory. +- Negate a pattern by starting it with an exclamation point `!`. -Note that unlike `.gitignore`, only the `.terraformignore` at the root of the configuration -directory is considered. +-> **Note:** Unlike `.gitignore`, only the `.terraformignore` at the root of the configuration directory is considered. diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.html.md index 632f6d2c6cbd..8e0f951a82f5 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.html.md @@ -11,7 +11,7 @@ description: |- Stores the state as a Blob with the given Key within the Blob Container within [the Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction). -This backend supports state locking and consistency checking via native capabilities of Azure Blob Storage. +This backend supports state locking and consistency checking with Azure Blob Storage native capabilities. -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. diff --git a/website/docs/language/settings/backends/configuration.html.md b/website/docs/language/settings/backends/configuration.html.md index dc848d3bc354..e7286f5bf544 100644 --- a/website/docs/language/settings/backends/configuration.html.md +++ b/website/docs/language/settings/backends/configuration.html.md @@ -8,11 +8,8 @@ page_title: "Backend Configuration - Configuration Language" Each Terraform configuration can specify a backend, which defines where [state](/docs/language/state/index.html) snapshots are stored. -Backend configuration is not needed when using Terraform Cloud, because -Terraform Cloud automatically manages state in the workspaces your configuration -is associated with. If your configuration includes -[a `cloud` block](/docs/language/settings/terraform-cloud.html), -it cannot include a `backend` block. +You do not need to configure a backend when using Terraform Cloud because +Terraform Cloud automatically manages state in the workspaces associated with your configuration. If your configuration includes [a `cloud` block](/docs/language/settings/terraform-cloud.html), it cannot include a `backend` block. Most non-trivial Terraform configurations store state remotely so that multiple people can work with the same infrastructure. diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.html.md index 3e8d6ded317f..128e1b7cfd84 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.html.md @@ -12,14 +12,8 @@ description: |- [`cloud` integration](/docs/language/settings/terraform-cloud.html) instead of this backend. The `cloud` option includes an improved user experience and more features. --> **Note:** This backend is unique among all other Terraform backends in that it has the ability to -execute operations for Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html), rather -than only store state snapshots. (The documentation used to refer to this as "enhanced" backend -behavior, but it's simpler to describe it as a quirk of the `remote` backend.) - --> **Note:** The remote backend requires Terraform v0.11.13 or newer, and requires either a -Terraform Cloud account on [app.terraform.io](https://app.terraform.io) or a Terraform Enterprise -instance (version v201809-1 or newer). +The remote backend is unique among all other Terraform backends because it can both store state snapshots and execute operations for Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html). It used to be called an "enhanced" backend. + When using full remote operations, operations like `terraform plan` or `terraform apply` can be executed in Terraform diff --git a/website/docs/language/settings/index.html.md b/website/docs/language/settings/index.html.md index 9c17d2f58ae7..cec07d2938d5 100644 --- a/website/docs/language/settings/index.html.md +++ b/website/docs/language/settings/index.html.md @@ -34,12 +34,10 @@ following sections. The nested `cloud` block configures Terraform Cloud for enabling its [CLI-driven run workflow](/docs/cloud/run/cli.html). -- For a summary of the `cloud` block's syntax, see -[Terraform Cloud Configuration](/docs/language/settings/terraform-cloud.html). +- Refer to [Terraform Cloud Configuration](/docs/language/settings/terraform-cloud.html) for a summary of the `cloud` block's syntax. -- For more complete details about configuring and using Terraform Cloud with Terraform CLI, -see [Using Terraform Cloud](/docs/cli/cloud/index.html) in the -Terraform CLI documentation. +- Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) in the +Terraform CLI documentation for complete details about how to initialize and configure the Terraform Cloud CLI integration. ## Configuring a Terraform Backend diff --git a/website/docs/language/settings/terraform-cloud.html.md b/website/docs/language/settings/terraform-cloud.html.md index 854863ad424b..4f536299d030 100644 --- a/website/docs/language/settings/terraform-cloud.html.md +++ b/website/docs/language/settings/terraform-cloud.html.md @@ -8,11 +8,10 @@ description: "The nested `cloud` block configures Terraform's integration with T # Terraform Cloud Configuration The main module of a Terraform configuration can integrate with Terraform Cloud to enable its -[CLI-driven run workflow](/docs/cloud/run/cli.html). These settings are only needed when -using Terraform CLI to interact with Terraform Cloud, and are ignored when interacting with -Terraform Cloud via version control or the API. +[CLI-driven run workflow](/docs/cloud/run/cli.html). You only need to configure these settings when you want to use Terraform CLI to interact with Terraform Cloud. Terraform Cloud ignores them when interacting with +Terraform through version control or the API. -Terraform Cloud is configured with a nested `cloud` block within the top-level +You can configure the Terraform Cloud CLI integration by adding a nested `cloud` block within the top-level `terraform` block: ```hcl @@ -27,11 +26,6 @@ terraform { } ``` -Using the Cloud integration is mutually exclusive of declaring any [state backend](/docs/language/settings/backends/index.html); that is, a configuration -can only declare one or the other. Similar to backends... +You cannot use the CLI integration and a [state backend](/docs/language/settings/backends/index.html) in the same configuration; the are mutually exclusive. A configuration can only provide one `cloud` block and the `cloud` block cannot refer to named values like input variables, locals, or data source attributes. -- A configuration can only provide one cloud block. -- A cloud block cannot refer to named values (like input variables, locals, or data source attributes). - -See [Using Terraform Cloud](/docs/cli/cloud/index.html) -in the Terraform CLI docs for more information. +Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) in the Terraform CLI docs for more information. From 310368d464580bc7e23917af62919e34666e92d5 Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:44:32 -0800 Subject: [PATCH 406/644] Move version info to one note --- website/docs/cli/cloud/index.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/cloud/index.html.md b/website/docs/cli/cloud/index.html.md index cb88583cf7c2..d79981e29621 100644 --- a/website/docs/cli/cloud/index.html.md +++ b/website/docs/cli/cloud/index.html.md @@ -5,7 +5,7 @@ page_title: "Using Terraform Cloud - Terraform CLI" # Using Terraform Cloud with Terraform -The Terraform Cloud CLI Integration allows you to use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated. +The Terraform CLI's integration with Terraform Cloud lets you to use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated. Using Terraform Cloud through the command line is called the [CLI-driven run workflow](/docs/cloud/run/cli.html). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in Terraform Cloud's run environment by default, with log output streaming to the local terminal. This lets you use Terraform Cloud features within the familiar Terraform CLI workflow, including variables encrypted at rest in a Terraform Cloud workspace, cost estimates, and policy checking. From 5897c9590ceae12ebd7c621ef09e81c34a0b6fa7 Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:45:18 -0800 Subject: [PATCH 407/644] Clarify background on unique names in TFC --- website/docs/cli/cloud/migrating.html.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md index 70da1b540e94..91b50c0bb125 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.html.md @@ -22,13 +22,14 @@ backend](/docs/language/settings/backends/index.html)), Terraform will ask your that state to Terraform Cloud. This process is interactive and self-documenting, and resembles moving between state backends. -You may also be prompted to rename your workspaces during the migration, to either give a name to +Terraform may also prompt you to rename your workspaces during the migration, to either give a name to the unnamed `default` workspace (Terraform Cloud requires all workspaces to have a name) or give -your workspace names more contextual information. Unlike typical Terraform workspaces representing -an environment associated with a particular configuration (e.g. production, staging, development), -Terraform Cloud workspaces are named uniquely across all configurations used within an organization. -Because of this, you'll be given an opportunity to rename the working directory's workspaces -according to a pattern relative to their existing names. A typical strategy to start with is +your workspace names more contextual information. Unlike Terraform CLI-only workspaces, which represent +multiple environments associated with the same configuration (e.g. production, staging, development), +Terraform Cloud workspaces can represent totally independent configurations, and must have unique names within the Terraform Cloud organization. + +Because of this, Terraform will prompt you to rename the working directory's workspaces +according to a pattern relative to their existing names, which can indicate the fact that these specific workspaces share configuration. A typical strategy to start with is `--` (e.g. `networking-prod-us-east`, `networking-staging-us-east`). For more information on workspace naming, see [Workspace Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation. From 57a27cd1dc4406fcf8a750fe532ec6cacb04f02e Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:46:47 -0800 Subject: [PATCH 408/644] Add intro text to migrating section Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cli/cloud/migrating.html.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md index 91b50c0bb125..d044a46cbdfc 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.html.md @@ -36,11 +36,9 @@ Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation ## Migrating from the `remote` Backend -The [`remote` backend](/docs/language/settings/backends/remote.html) was the primary -implementation of Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html) for -Terraform versions 0.11.13 through 1.0.x. We recommend using the native `cloud` -integration for Terraform versions 1.1 or later, as it provides an improved user experience and -various enhancements. +If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. The local names shown for those workspaces will change to match their remote names. + +The [`remote` backend](/docs/language/settings/backends/remote.html) was the primary implementation of Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html) for Terraform versions 0.11.13 through 1.0.x. We recommend using the native `cloud` integration for Terraform versions 1.1 or later, as it provides an improved user experience and various enhancements. ### Block Replacement From 57cc74ddc4727bf21a424603c46bad34162dec0f Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:48:01 -0800 Subject: [PATCH 409/644] Correct bullet and break up sentence Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cli/cloud/settings.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/cloud/settings.html.md b/website/docs/cli/cloud/settings.html.md index ad61322b0706..b3cd5c65c397 100644 --- a/website/docs/cli/cloud/settings.html.md +++ b/website/docs/cli/cloud/settings.html.md @@ -61,10 +61,10 @@ The `cloud` block supports the following configuration arguments: use for the current configuration. The `workspaces` block must contain **exactly one** of the following arguments, each denoting a strategy for how workspaces should be mapped: - * `tags` - (Optional) A set of Terraform Cloud workspace tags. You will be able to use + - `tags` - (Optional) A set of Terraform Cloud workspace tags. You will be able to use this working directory with any workspaces that have all of the specified tags, and can use [the `terraform workspace` commands](/docs/cli/workspaces/index.html) - to switch between them or create new workspaces; new workspaces will automatically have + to switch between them or create new workspaces. New workspaces will automatically have the specified tags. This option conflicts with `name`. - `name` - (Optional) The name of a single Terraform Cloud workspace. You will From 29b71d873fc1f3b4b4a106febf098fc79ed39315 Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:48:23 -0800 Subject: [PATCH 410/644] Correct bullet Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/cli/cloud/settings.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/cloud/settings.html.md b/website/docs/cli/cloud/settings.html.md index b3cd5c65c397..700e3a671a1e 100644 --- a/website/docs/cli/cloud/settings.html.md +++ b/website/docs/cli/cloud/settings.html.md @@ -72,7 +72,7 @@ following arguments, each denoting a strategy for how workspaces should be mappe directory, and cannot manage workspaces from the CLI (e.g. `terraform workspace select` or `terraform workspace new`). This option conflicts with `tags`. -* `hostname` - (Optional) The hostname of a Terraform Enterprise installation, if using Terraform +- `hostname` - (Optional) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. Defaults to Terraform Cloud (app.terraform.io). - `token` - (Optional) The token used to authenticate with Terraform Cloud. From d82211ad7b840dbc3203724fe282ba0c062977c9 Mon Sep 17 00:00:00 2001 From: Judith Malnick Date: Wed, 8 Dec 2021 09:49:12 -0800 Subject: [PATCH 411/644] Keep version note, include introduction and enterprise versioning --- website/docs/language/settings/backends/remote.html.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.html.md index 128e1b7cfd84..9277f1dd52f3 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.html.md @@ -8,9 +8,8 @@ description: |- # remote --> **Note:** With the release of Terraform v1.1.0, we recommend using the Terraform Cloud's built-in -[`cloud` integration](/docs/language/settings/terraform-cloud.html) instead of this backend. -The `cloud` option includes an improved user experience and more features. +-> **Note:** The remote backend was introduced in Terraform v0.11.13 and Terraform Enterprise v201809-1. As of Terraform v1.1.0 and Terraform Enterprise v202201-1, **we recommend using the Terraform Cloud's built-in [`cloud` integration](/docs/language/settings/terraform-cloud.html)** instead of this backend. The `cloud` option includes an improved user experience and more features. + The remote backend is unique among all other Terraform backends because it can both store state snapshots and execute operations for Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html). It used to be called an "enhanced" backend. From c17317ded4f2615cc85e578b2be947677fdf46dc Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:05:24 -0500 Subject: [PATCH 412/644] Update website/docs/cli/cloud/index.html.md Co-authored-by: Judith Malnick --- website/docs/cli/cloud/index.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/cloud/index.html.md b/website/docs/cli/cloud/index.html.md index d79981e29621..e92a08cafb67 100644 --- a/website/docs/cli/cloud/index.html.md +++ b/website/docs/cli/cloud/index.html.md @@ -3,7 +3,7 @@ layout: "docs" page_title: "Using Terraform Cloud - Terraform CLI" --- -# Using Terraform Cloud with Terraform +# Using Terraform Cloud with Terraform CLI The Terraform CLI's integration with Terraform Cloud lets you to use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated. From c713815e332f1cb1c8977729c0d8261cb92615a7 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:09:12 -0500 Subject: [PATCH 413/644] Add learn callout to usiing TFC index page --- website/docs/cli/cloud/index.html.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/cli/cloud/index.html.md b/website/docs/cli/cloud/index.html.md index e92a08cafb67..30b5744fe0b5 100644 --- a/website/docs/cli/cloud/index.html.md +++ b/website/docs/cli/cloud/index.html.md @@ -9,6 +9,8 @@ The Terraform CLI's integration with Terraform Cloud lets you to use Terraform C Using Terraform Cloud through the command line is called the [CLI-driven run workflow](/docs/cloud/run/cli.html). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in Terraform Cloud's run environment by default, with log output streaming to the local terminal. This lets you use Terraform Cloud features within the familiar Terraform CLI workflow, including variables encrypted at rest in a Terraform Cloud workspace, cost estimates, and policy checking. +> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. + Workspaces can also be configured for local execution, in which case only state is stored in Terraform Cloud. In this mode, Terraform Cloud behaves just like a standard state backend. From 502ec81ae20049fa1a8de040305f6352c70cdd92 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:37:22 -0500 Subject: [PATCH 414/644] Update initializing page --- website/docs/cli/cloud/migrating.html.md | 95 ++++++++++++------------ 1 file changed, 48 insertions(+), 47 deletions(-) diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md index d044a46cbdfc..dc4a70ee564b 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.html.md @@ -5,21 +5,21 @@ page_title: "Initializing and Migrating to Terraform Cloud - Terraform CLI" # Initializing and Migrating -After [configuring Terraform Cloud settings](/docs/cli/cloud/settings.html) for a working directory, you must run `terraform init` to finish setting up. When running this command, Terraform may guide you through an interactive process where you may choose whether or not to migrate state from any existing workspaces. +After [configuring Terraform Cloud settings](/docs/cli/cloud/settings.html) for a working directory, you must run `terraform init` to finish setting up. If the working directory has no existing Terraform state, you can start using Terraform with Terraform Cloud right away. Refer to [CLI-driven run workflow](/docs/cloud/run/cli.html) for more details. -There are three potential scenarios: +When you run `terraform init` in the following scenarios, Terraform will ask you to choose whether or not to migrate state from any existing workspaces. -1. **Fresh working directory:** If the working directory has no existing Terraform state, no migrations will occur. You can start using Terraform with Terraform Cloud right away, creating workspaces and starting runs. -2. **State backend or local state:** If the working directory already has state data in one or more workspaces (using either local state or a [state backend](/docs/language/settings/backends/index.html)), Terraform will ask if you're like to migrate that state to new Terraform Cloud workspaces. You will need permission to manage workspaces in the destination Terraform Cloud organization. You may also be prompted to rename the workspaces being migrated, to better distinguish them within a Terraform Cloud organization. -3. **`remote` backend:** If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. The local names shown for those workspaces will change to match their remote names. +1. [**Migrating from local state or state backends:**](#migrating-from-local-state-or-state-backends) If the working directory already has state data in one or more workspaces, Terraform will ask if you would like to migrate that state to new Terraform Cloud workspaces. -The rest of this page briefly describes cases 2 and 3. +2. [**Migrating from the `remote` backend:**](#migrating-from-the-remote-backend) If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. -## Migrating from Local State or Other Backends +## Migrating from Local State or State Backends + +> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. If the working directory already has state data available (using either local state or a [state backend](/docs/language/settings/backends/index.html)), Terraform will ask your approval to migrate -that state to Terraform Cloud. This process is interactive and self-documenting, and resembles +that state to Terraform Cloud. You will need permission to manage workspaces in the destination Terraform Cloud organization. This process is interactive and self-documenting, and resembles moving between state backends. Terraform may also prompt you to rename your workspaces during the migration, to either give a name to @@ -29,10 +29,10 @@ multiple environments associated with the same configuration (e.g. production, s Terraform Cloud workspaces can represent totally independent configurations, and must have unique names within the Terraform Cloud organization. Because of this, Terraform will prompt you to rename the working directory's workspaces -according to a pattern relative to their existing names, which can indicate the fact that these specific workspaces share configuration. A typical strategy to start with is -`--` (e.g. `networking-prod-us-east`, -`networking-staging-us-east`). For more information on workspace naming, see [Workspace -Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation. +according to a pattern relative to their existing names. This can indicate the fact that these specific workspaces share configuration. A typical strategy is +`--` (e.g., `networking-prod-us-east`, +`networking-staging-us-east`). Refer to [Workspace +Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation for more detail. ## Migrating from the `remote` Backend @@ -44,41 +44,42 @@ The [`remote` backend](/docs/language/settings/backends/remote.html) was the pri When switching from the `remote` backend to a `cloud` block, Terraform will continue using the same set of Terraform Cloud workspaces. Replace your `backend "remote"` block with an equivalent `cloud` -block: +block. + +#### Single Workspace -- If you were using a single workspace with the `name` argument, change the block +If you were using a single workspace with the `name` argument, change the block label to `cloud`. - ```diff - terraform { - - backend "remote" { - + cloud { - organization = "my-org" - - workspaces { - name = "my-app-prod" - } - } - } - ``` - -- If you were using multiple workspaces via the `prefix` argument, replace it - with a `cloud` block that uses the `tags` argument. You may specify any number of tags to - distinguish the workspaces for your working directory, but a good starting point may be to use - whatever the prefix was before. - - The tags you configure do not need to be present on the existing workspaces. When you initialize, Terraform will add the specified tags to the workspaces if necessary. - - ```diff - terraform { - - backend "remote" { - + cloud { - organization = "my-org" - - workspaces { - - prefix = "my-app-" - + tags = ["app:mine"] - } - } - } - ``` +```diff +terraform { +- backend "remote" { ++ cloud { + organization = "my-org" + + workspaces { + name = "my-app-prod" + } + } + } +``` + +#### Multiple workspaces + +If you were using multiple workspaces with the `prefix` argument, replace it with a `cloud` block that uses the `tags` argument. You may specify any number of tags to distinguish the workspaces for your working directory, but a good starting point may be to use whatever the prefix was before. + +The tags you configure do not need to be present on the existing workspaces. When you initialize, Terraform will add the specified tags to the workspaces if necessary. + +```diff +terraform { +- backend "remote" { ++ cloud { + organization = "my-org" + + workspaces { +- prefix = "my-app-" ++ tags = ["app:mine"] + } + } + } +``` From 829e9b4842d5a419de2e27da33a5b89d3a11a076 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:45:14 -0500 Subject: [PATCH 415/644] Update settings page --- website/docs/cli/cloud/settings.html.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/cloud/settings.html.md b/website/docs/cli/cloud/settings.html.md index 700e3a671a1e..5ffc2dd8b2d1 100644 --- a/website/docs/cli/cloud/settings.html.md +++ b/website/docs/cli/cloud/settings.html.md @@ -8,7 +8,9 @@ page_title: "Terraform Cloud Settings - Terraform CLI" Terraform CLI can integrate with Terraform Cloud, acting as a client for Terraform Cloud's [CLI-driven run workflow](https://www.terraform.io/docs/cloud/run/cli.html). -To use Terraform Cloud for a particular working directory, you must configure the following settings: +> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. + +You must configure the following settings to use Terraform Cloud for a particular working directory: - Provide credentials to access Terraform Cloud, preferably by using the [`terraform login`](/docs/cli/commands/login.html) command. @@ -38,7 +40,7 @@ terraform { } ``` -The `cloud` block has some special restrictions: +The `cloud` block also has some special restrictions: - A configuration can only provide one `cloud` block. - A `cloud` block cannot be used with [state backends](/docs/language/settings/backends/index.html). From ab23ecb210894ab107d7099b5f81612c9269f0d1 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:47:42 -0500 Subject: [PATCH 416/644] Change "see" to "refer to" --- website/docs/cli/workspaces/index.html.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/cli/workspaces/index.html.md b/website/docs/cli/workspaces/index.html.md index 6143c30879cd..39dd00f5e629 100644 --- a/website/docs/cli/workspaces/index.html.md +++ b/website/docs/cli/workspaces/index.html.md @@ -74,5 +74,4 @@ directory with one or more remote workspaces. If you associate the directory with multiple workspaces (using workspace tags), you can use the `terraform workspace` commands to select which remote workspace to use. -For more information about using Terraform CLI with Terraform Cloud, see -[CLI-driven Runs](/docs/cloud/run/cli.html) in the Terraform Cloud docs. +Refer to [CLI-driven Runs](/docs/cloud/run/cli.html) in the Terraform Cloud documentation for more details about using Terraform CLI with Terraform Cloud. From d0cb88f0915f7f5e5983e5d56f4ad6bbbe4e0494 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:49:58 -0500 Subject: [PATCH 417/644] Updates to TFC page in Language --- website/docs/language/settings/terraform-cloud.html.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/language/settings/terraform-cloud.html.md b/website/docs/language/settings/terraform-cloud.html.md index 4f536299d030..fd1b94b713fe 100644 --- a/website/docs/language/settings/terraform-cloud.html.md +++ b/website/docs/language/settings/terraform-cloud.html.md @@ -11,6 +11,8 @@ The main module of a Terraform configuration can integrate with Terraform Cloud [CLI-driven run workflow](/docs/cloud/run/cli.html). You only need to configure these settings when you want to use Terraform CLI to interact with Terraform Cloud. Terraform Cloud ignores them when interacting with Terraform through version control or the API. +> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. + You can configure the Terraform Cloud CLI integration by adding a nested `cloud` block within the top-level `terraform` block: @@ -26,6 +28,6 @@ terraform { } ``` -You cannot use the CLI integration and a [state backend](/docs/language/settings/backends/index.html) in the same configuration; the are mutually exclusive. A configuration can only provide one `cloud` block and the `cloud` block cannot refer to named values like input variables, locals, or data source attributes. +You cannot use the CLI integration and a [state backend](/docs/language/settings/backends/index.html) in the same configuration; they are mutually exclusive. A configuration can only provide one `cloud` block and the `cloud` block cannot refer to named values like input variables, locals, or data source attributes. Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) in the Terraform CLI docs for more information. From 0bd3491ef8b9e5e3449f506b31540b40123a7776 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 13:55:45 -0500 Subject: [PATCH 418/644] Fix typo and update note --- website/docs/language/settings/backends/index.html.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index 1188cfcdf857..21f573ab8eeb 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -40,11 +40,11 @@ Some backends act like plain "remote disks" for state files; others support _locking_ the state while operations are being performed, which helps prevent conflicts and inconsistencies. --> **Note:** In Terraform versions prior to 1.1.0, backends were also classifid as being 'standard' +-> **Note:** In Terraform versions prior to 1.1.0, backends were also classified as being 'standard' or 'enhanced', where the latter term referred to the ability of the -[remote](/docs/language/settings/sbackends/remote.html) backend to not only store state but perform +[remote](/docs/language/settings/sbackends/remote.html) backend to store state and perform Terraform operations. This classification has been removed, clarifying the primary purpose of -backends. See [Configuring Terraform Cloud](/docs/language/settings/configuring-terraform-cloud) to +backends. Refer to [Configuring Terraform Cloud](/docs/language/settings/configuring-terraform-cloud) for details about how to store state, execute remote operations, and use Terraform Cloud directly from Terraform. ## Available Backends From 91755d380ff13b6657e62f86b279cfe5fdf9ee70 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 14:01:58 -0500 Subject: [PATCH 419/644] udpate to migrating page --- website/docs/cli/cloud/migrating.html.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.html.md index dc4a70ee564b..5547b43b98c6 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.html.md @@ -11,7 +11,7 @@ When you run `terraform init` in the following scenarios, Terraform will ask you 1. [**Migrating from local state or state backends:**](#migrating-from-local-state-or-state-backends) If the working directory already has state data in one or more workspaces, Terraform will ask if you would like to migrate that state to new Terraform Cloud workspaces. -2. [**Migrating from the `remote` backend:**](#migrating-from-the-remote-backend) If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. +2. [**Migrating from the `remote` backend:**](#migrating-from-the-remote-backend) If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. You will need to switch the `remote` backend block to the `cloud` block. ## Migrating from Local State or State Backends @@ -64,7 +64,7 @@ terraform { } ``` -#### Multiple workspaces +#### Multiple Workspaces If you were using multiple workspaces with the `prefix` argument, replace it with a `cloud` block that uses the `tags` argument. You may specify any number of tags to distinguish the workspaces for your working directory, but a good starting point may be to use whatever the prefix was before. From 70740e9493b4e8d0f65e85a14072ea867d580a3c Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 14:13:47 -0500 Subject: [PATCH 420/644] Add tutorial to moving resources page --- website/docs/cli/state/move.html.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/cli/state/move.html.md b/website/docs/cli/state/move.html.md index 4eb654fd348d..c507aa0effa1 100644 --- a/website/docs/cli/state/move.html.md +++ b/website/docs/cli/state/move.html.md @@ -25,6 +25,8 @@ resource. real-world object. Use this to preserve an object when renaming a resource, or when moving a resource into or out of a child module. + > **Hands On:** Try the [Use Configuration to Move Resources](https://learn.hashicorp.com/tutorials/terraform/move-config) on HashiCorp Learn. + - [The `terraform state rm` command](/docs/cli/commands/state/rm.html) tells Terraform to stop managing a resource as part of the current working directory and workspace, _without_ destroying the corresponding real-world object. (You From 2cef923495ceae8273424a54edd4c65a4062feb2 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 8 Dec 2021 13:43:06 -0800 Subject: [PATCH 421/644] website: Correct navbar link to the "Refactoring" page We late-reorganized this into the "Module Development" subsection, but forgot to update the actual link in the navbar, so it was still linking to its old location. --- website/layouts/language.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/layouts/language.erb b/website/layouts/language.erb index a15a5012f37f..b2233530f218 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -251,7 +251,7 @@
        • - Refactoring + Refactoring
        • From f95dcfe90a6e13a8d820c0035b302681a202bbcb Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 8 Dec 2021 14:01:45 -0800 Subject: [PATCH 422/644] website: Fix link from remote backend page to the terraform.workspace docs --- website/docs/language/settings/backends/remote.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.html.md index 9277f1dd52f3..dfe8df5a3712 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.html.md @@ -68,7 +68,7 @@ the Terraform CLI workspace `prod` within the current configuration. Remote Terraform operations such as `plan` and `apply` executed against that Terraform CLI workspace will be executed in the Terraform Cloud workspace `networking-prod`. -Additionally, the [`terraform.workspace`](/docs/language/state/workspaces.html#referencing-the-current-workspace-name) +Additionally, the [`terraform.workspace`](/docs/language/state/workspaces.html#current-workspace-interpolation) expression shouldn't be used in Terraform configurations that use Terraform 1.0.x or earlier and run remote operations against Terraform Cloud workspaces. The reason for this is that prior to Terraform 1.1.0, Terraform Cloud workspaces only used the single `default` Terraform From 533a29edee53ac8e568170e4b86cc6c408b5d0a0 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 8 Dec 2021 14:02:30 -0800 Subject: [PATCH 423/644] website: Shorter heading for the nullable = false variable argument This makes it match some incoming links we have elsewhere, but also it makes the heading a bit more consice because "module" isn't really adding anything here anyway: input variables are _always_ in modules. --- website/docs/language/values/variables.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/values/variables.html.md b/website/docs/language/values/variables.html.md index a983192be0db..858ed298fcf9 100644 --- a/website/docs/language/values/variables.html.md +++ b/website/docs/language/values/variables.html.md @@ -304,7 +304,7 @@ random_pet.animal: Creating... random_pet.animal: Creation complete after 0s [id=jae-known-mongoose] ``` -### Disallowing null Module Input Values +### Disallowing Null Input Values [inpage-nullable]: #disallowing-null-input-values From 2edd9f4e10faf38e65d5fc5ce4e29c3c4e3b59b0 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 17:53:18 -0500 Subject: [PATCH 424/644] Update broken links --- website/docs/language/settings/backends/index.html.md | 4 ++-- website/docs/language/state/workspaces.html.md | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index 21f573ab8eeb..f0e9dca78eae 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -42,9 +42,9 @@ conflicts and inconsistencies. -> **Note:** In Terraform versions prior to 1.1.0, backends were also classified as being 'standard' or 'enhanced', where the latter term referred to the ability of the -[remote](/docs/language/settings/sbackends/remote.html) backend to store state and perform +[remote](/docs/language/settings/backends/remote.html) backend to store state and perform Terraform operations. This classification has been removed, clarifying the primary purpose of -backends. Refer to [Configuring Terraform Cloud](/docs/language/settings/configuring-terraform-cloud) for details about how to +backends. Refer to [Using Terraform Cloud ](/docs/cli/cloud/index.html) for details about how to store state, execute remote operations, and use Terraform Cloud directly from Terraform. ## Available Backends diff --git a/website/docs/language/state/workspaces.html.md b/website/docs/language/state/workspaces.html.md index c33cad7d3147..8dcb7b5f476a 100644 --- a/website/docs/language/state/workspaces.html.md +++ b/website/docs/language/state/workspaces.html.md @@ -46,8 +46,7 @@ organizations that use Terraform. different from but related to the Terraform Cloud [workspace](/docs/cloud/workspaces/index.html) concept. If you use multiple Terraform CLI workspaces in a single Terraform configuration -and are migrating that configuration to Terraform Cloud, see this [migration -document](/docs/cloud/migrate/workspaces.html). +and are migrating that configuration to Terraform Cloud, refer to [Initializing and Migrating](/docs/cli/cloud/migrating.html). ## Using Workspaces From 22d80df0ba07adea6a4f388097f0cc4ee0ced6f1 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 18:01:48 -0500 Subject: [PATCH 425/644] Fix extra space in link --- website/docs/language/settings/backends/index.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index f0e9dca78eae..65dc816edd9a 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -44,7 +44,7 @@ conflicts and inconsistencies. or 'enhanced', where the latter term referred to the ability of the [remote](/docs/language/settings/backends/remote.html) backend to store state and perform Terraform operations. This classification has been removed, clarifying the primary purpose of -backends. Refer to [Using Terraform Cloud ](/docs/cli/cloud/index.html) for details about how to +backends. Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) for details about how to store state, execute remote operations, and use Terraform Cloud directly from Terraform. ## Available Backends From 168c2885e353e06858a1727c84a655b1635ae0c0 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 8 Dec 2021 18:03:26 -0500 Subject: [PATCH 426/644] Fix link text --- website/docs/language/settings/backends/index.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index 65dc816edd9a..3259b542228f 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -42,7 +42,7 @@ conflicts and inconsistencies. -> **Note:** In Terraform versions prior to 1.1.0, backends were also classified as being 'standard' or 'enhanced', where the latter term referred to the ability of the -[remote](/docs/language/settings/backends/remote.html) backend to store state and perform +[remote backend](/docs/language/settings/backends/remote.html) to store state and perform Terraform operations. This classification has been removed, clarifying the primary purpose of backends. Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) for details about how to store state, execute remote operations, and use Terraform Cloud directly from Terraform. From b202eefc7bcafda5598a3de579668cf42fe9001a Mon Sep 17 00:00:00 2001 From: Marcus Way Date: Wed, 8 Dec 2021 19:33:17 -0500 Subject: [PATCH 427/644] Update docs to use `assume_role` block I'm guessing this document is just out of date, but I got an error when configuring `assume_role` as an argument and had to add an `assume_role` block --- website/docs/language/settings/backends/s3.html.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.html.md index f5b2d2ee0995..f8d6b449a9b2 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.html.md @@ -313,7 +313,9 @@ provider "aws" { # No credentials explicitly set here because they come from either the # environment or the global credentials file. - assume_role = "${var.workspace_iam_roles[terraform.workspace]}" + assume_role = { + role_arn = "${var.workspace_iam_roles[terraform.workspace]}" + } } ``` From ced4f5500cf763688d7969616ef0dcf299dede4e Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Thu, 9 Dec 2021 13:16:11 -0700 Subject: [PATCH 428/644] update go-tfe to v0.21.0 --- go.mod | 4 ++-- go.sum | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/go.mod b/go.mod index b41a9a32298b..7505396c94da 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa + github.com/hashicorp/go-tfe v0.21.0 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f @@ -180,7 +180,7 @@ require ( go.uber.org/multierr v1.1.0 // indirect go.uber.org/zap v1.10.0 // indirect golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5 // indirect - golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect + golang.org/x/time v0.0.0-20211116232009-f0f3c7e86c11 // indirect golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/appengine v1.6.7 // indirect google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect diff --git a/go.sum b/go.sum index fba0b54b9b40..e7d439d84236 100644 --- a/go.sum +++ b/go.sum @@ -407,8 +407,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa h1:6LHPSBzcYJwMO+iBSOCTY1ZvMc3EeIuD4okEM7p7G7c= -github.com/hashicorp/go-tfe v0.20.1-0.20211110172530-c43c6b574caa/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.21.0 h1:P1QoeLkigDi4BXGQ//42kyXwfcHUqbh5jJemml6iQJs= +github.com/hashicorp/go-tfe v0.21.0/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= @@ -948,8 +948,8 @@ golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxb golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac h1:7zkz7BUtwNFFqcowJ+RIgu2MaV/MapERkDIy+mwPyjs= -golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20211116232009-f0f3c7e86c11 h1:GZokNIeuVkl3aZHJchRrr13WCsols02MLUcz1U9is6M= +golang.org/x/time v0.0.0-20211116232009-f0f3c7e86c11/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= From 6530055d188d363bf64ff99b56bb00b350de2cfb Mon Sep 17 00:00:00 2001 From: Patrick Decat Date: Thu, 9 Dec 2021 23:54:19 +0100 Subject: [PATCH 429/644] website: Refactoring "Renaming a Module Call" should include a moved block --- website/docs/language/modules/develop/refactoring.html.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/docs/language/modules/develop/refactoring.html.md b/website/docs/language/modules/develop/refactoring.html.md index 22f548ec4046..b094608ad58a 100644 --- a/website/docs/language/modules/develop/refactoring.html.md +++ b/website/docs/language/modules/develop/refactoring.html.md @@ -231,6 +231,11 @@ module "b" { # (module arguments) } + +moved { + from = module.a + to = module.b +} ``` When creating the next plan for each configuration using this module, Terraform From ec6fe93fa8814de02e1e122484c98d6749139d1e Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 8 Dec 2021 15:40:32 -0500 Subject: [PATCH 430/644] instances: Non-existing module instance has no resource instances Previously we were treating it as a programming error to ask for the instances of a resource inside an instance of a module that is declared but whose declaration doesn't include the given instance key. However, that's actually a valid situation which can arise if, for example, the user has changed the repetition/expansion mode for an existing module call and so now all of the resource instances addresses it previously contained are "orphaned". To represent that, we'll instead say that an invalid instance key of a declared module behaves as if it contains no resource instances at all, regardless of the configurations of any resources nested inside. This then gives the result needed to successfully detect all of the former resource instances as "orphaned" and plan to destroy them. However, this then introduces a new case for NodePlannableResourceInstanceOrphan.deleteActionReason to deal with: the resource configuration still exists (because configuration isn't aware of individual module/resource instances) but the module instance does not. This actually allows us to resolve, at least partially, a previous missing piece of explaining to the user why the resource instances are planned for deletion in that case, finally allowing us to be explicit to the user that it's because of the module instance being removed, which internally we call plans.ResourceInstanceDeleteBecauseNoModule. Co-authored-by: Alisdair McDiarmid --- internal/instances/expander.go | 63 ++++++++++- internal/instances/expander_test.go | 65 ++++++++++- internal/terraform/context_plan2_test.go | 102 ++++++++++++++++++ .../terraform/node_resource_plan_orphan.go | 24 ++++- 4 files changed, 246 insertions(+), 8 deletions(-) diff --git a/internal/instances/expander.go b/internal/instances/expander.go index 3e3ac9675342..4a0bd936fd68 100644 --- a/internal/instances/expander.go +++ b/internal/instances/expander.go @@ -120,6 +120,41 @@ func (e *Expander) ExpandModule(addr addrs.Module) []addrs.ModuleInstance { return ret } +// GetDeepestExistingModuleInstance is a funny specialized function for +// determining how many steps we can traverse through the given module instance +// address before encountering an undeclared instance of a declared module. +// +// The result is the longest prefix of the given address which steps only +// through module instances that exist. +// +// All of the modules on the given path must already have had their +// expansion registered using one of the SetModule* methods before calling, +// or this method will panic. +func (e *Expander) GetDeepestExistingModuleInstance(given addrs.ModuleInstance) addrs.ModuleInstance { + exps := e.exps // start with the root module expansions + for i := 0; i < len(given); i++ { + step := given[i] + callName := step.Name + if _, ok := exps.moduleCalls[addrs.ModuleCall{Name: callName}]; !ok { + // This is a bug in the caller, because it should always register + // expansions for an object and all of its ancestors before requesting + // expansion of it. + panic(fmt.Sprintf("no expansion has been registered for %s", given[:i].Child(callName, addrs.NoKey))) + } + + var ok bool + exps, ok = exps.childInstances[step] + if !ok { + // We've found a non-existing instance, so we're done. + return given[:i] + } + } + + // If we complete the loop above without returning early then the entire + // given address refers to a declared module instance. + return given +} + // ExpandModuleResource finds the exhaustive set of resource instances resulting from // the expansion of the given resource and all of its containing modules. // @@ -149,6 +184,14 @@ func (e *Expander) ExpandModuleResource(moduleAddr addrs.Module, resourceAddr ad // All of the modules on the path to the identified resource and the resource // itself must already have had their expansion registered using one of the // SetModule*/SetResource* methods before calling, or this method will panic. +// +// ExpandModuleResource returns all instances of a resource across all +// instances of its containing module, whereas this ExpandResource function +// is more specific and only expands within a single module instance. If +// any of the module instances selected in the module path of the given address +// aren't valid for that module's expansion then ExpandResource returns an +// empty result, reflecting that a non-existing module instance can never +// contain any existing resource instances. func (e *Expander) ExpandResource(resourceAddr addrs.AbsResource) []addrs.AbsResourceInstance { e.mu.RLock() defer e.mu.RUnlock() @@ -380,9 +423,23 @@ func (m *expanderModule) resourceInstances(moduleAddr addrs.ModuleInstance, reso panic(fmt.Sprintf("no expansion has been registered for %s", parentAddr.Child(callName, addrs.NoKey))) } - inst := m.childInstances[step] - moduleInstAddr := append(parentAddr, step) - return inst.resourceInstances(moduleAddr[1:], resourceAddr, moduleInstAddr) + if inst, ok := m.childInstances[step]; ok { + moduleInstAddr := append(parentAddr, step) + return inst.resourceInstances(moduleAddr[1:], resourceAddr, moduleInstAddr) + } else { + // If we have the module _call_ registered (as we checked above) + // but we don't have the given module _instance_ registered, that + // suggests that the module instance key in "step" is not declared + // by the current definition of this module call. That means the + // module instance doesn't exist at all, and therefore it can't + // possibly declare any resource instances either. + // + // For example, if we were asked about module.foo[0].aws_instance.bar + // but module.foo doesn't currently have count set, then there is no + // module.foo[0] at all, and therefore no aws_instance.bar + // instances inside it. + return nil + } } return m.onlyResourceInstances(resourceAddr, parentAddr) } diff --git a/internal/instances/expander_test.go b/internal/instances/expander_test.go index 8e4d0f8f0e0e..2e983288929a 100644 --- a/internal/instances/expander_test.go +++ b/internal/instances/expander_test.go @@ -199,14 +199,47 @@ func TestExpander(t *testing.T) { } }) t.Run("module single resource count2", func(t *testing.T) { - got := ex.ExpandModuleResource( + // Two different ways of asking the same question, which should + // both produce the same result. + // First: nested expansion of all instances of the resource across + // all instances of the module, but it's a single-instance module + // so the first level is a singleton. + got1 := ex.ExpandModuleResource( mustModuleAddr(`single`), count2ResourceAddr, ) + // Second: expansion of only instances belonging to a specific + // instance of the module, but again it's a single-instance module + // so there's only one to ask about. + got2 := ex.ExpandResource( + count2ResourceAddr.Absolute( + addrs.RootModuleInstance.Child("single", addrs.NoKey), + ), + ) want := []addrs.AbsResourceInstance{ mustAbsResourceInstanceAddr(`module.single.test.count2[0]`), mustAbsResourceInstanceAddr(`module.single.test.count2[1]`), } + if diff := cmp.Diff(want, got1); diff != "" { + t.Errorf("wrong ExpandModuleResource result\n%s", diff) + } + if diff := cmp.Diff(want, got2); diff != "" { + t.Errorf("wrong ExpandResource result\n%s", diff) + } + }) + t.Run("module single resource count2 with non-existing module instance", func(t *testing.T) { + got := ex.ExpandResource( + count2ResourceAddr.Absolute( + // Note: This is intentionally an invalid instance key, + // so we're asking about module.single[1].test.count2 + // even though module.single doesn't have count set and + // therefore there is no module.single[1]. + addrs.RootModuleInstance.Child("single", addrs.IntKey(1)), + ), + ) + // If the containing module instance doesn't exist then it can't + // possibly have any resource instances inside it. + want := ([]addrs.AbsResourceInstance)(nil) if diff := cmp.Diff(want, got); diff != "" { t.Errorf("wrong result\n%s", diff) } @@ -261,6 +294,36 @@ func TestExpander(t *testing.T) { t.Errorf("wrong result\n%s", diff) } }) + t.Run("module count2 module count2 GetDeepestExistingModuleInstance", func(t *testing.T) { + t.Run("first step invalid", func(t *testing.T) { + got := ex.GetDeepestExistingModuleInstance(mustModuleInstanceAddr(`module.count2["nope"].module.count2[0]`)) + want := addrs.RootModuleInstance + if !want.Equal(got) { + t.Errorf("wrong result\ngot: %s\nwant: %s", got, want) + } + }) + t.Run("second step invalid", func(t *testing.T) { + got := ex.GetDeepestExistingModuleInstance(mustModuleInstanceAddr(`module.count2[1].module.count2`)) + want := mustModuleInstanceAddr(`module.count2[1]`) + if !want.Equal(got) { + t.Errorf("wrong result\ngot: %s\nwant: %s", got, want) + } + }) + t.Run("neither step valid", func(t *testing.T) { + got := ex.GetDeepestExistingModuleInstance(mustModuleInstanceAddr(`module.count2.module.count2["nope"]`)) + want := addrs.RootModuleInstance + if !want.Equal(got) { + t.Errorf("wrong result\ngot: %s\nwant: %s", got, want) + } + }) + t.Run("both steps valid", func(t *testing.T) { + got := ex.GetDeepestExistingModuleInstance(mustModuleInstanceAddr(`module.count2[1].module.count2[0]`)) + want := mustModuleInstanceAddr(`module.count2[1].module.count2[0]`) + if !want.Equal(got) { + t.Errorf("wrong result\ngot: %s\nwant: %s", got, want) + } + }) + }) t.Run("module count2 resource count2 resource count2", func(t *testing.T) { got := ex.ExpandModuleResource( mustModuleAddr(`count2.count2`), diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 85872ac53324..006e9e932f68 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -2076,3 +2076,105 @@ output "output" { } } } + +func TestContext2Plan_moduleExpandOrphansResourceInstance(t *testing.T) { + // This test deals with the situation where a user has changed the + // repetition/expansion mode for a module call while there are already + // resource instances from the previous declaration in the state. + // + // This is conceptually just the same as removing the resources + // from the module configuration only for that instance, but the + // implementation of it ends up a little different because it's + // an entry in the resource address's _module path_ that we'll find + // missing, rather than the resource's own instance key, and so + // our analyses need to handle that situation by indicating that all + // of the resources under the missing module instance have zero + // instances, regardless of which resource in that module we might + // be asking about, and do so without tripping over any missing + // registrations in the instance expander that might lead to panics + // if we aren't careful. + // + // (For some history here, see https://github.com/hashicorp/terraform/issues/30110 ) + + addrNoKey := mustResourceInstanceAddr("module.child.test_object.a[0]") + addrZeroKey := mustResourceInstanceAddr("module.child[0].test_object.a[0]") + m := testModuleInline(t, map[string]string{ + "main.tf": ` + module "child" { + source = "./child" + count = 1 + } + `, + "child/main.tf": ` + resource "test_object" "a" { + count = 1 + } + `, + }) + + state := states.BuildState(func(s *states.SyncState) { + // Notice that addrNoKey is the address which lacks any instance key + // for module.child, and so that module instance doesn't match the + // call declared above with count = 1, and therefore the resource + // inside is "orphaned" even though the resource block actually + // still exists there. + s.SetResourceInstanceCurrent(addrNoKey, &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + + p := simpleMockProvider() + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + plan, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.NormalMode, + }) + if diags.HasErrors() { + t.Fatalf("unexpected errors\n%s", diags.Err().Error()) + } + + t.Run(addrNoKey.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrNoKey) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrNoKey) + } + + if got, want := instPlan.Addr, addrNoKey; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrNoKey; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.Delete; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceDeleteBecauseNoModule; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) + + t.Run(addrZeroKey.String(), func(t *testing.T) { + instPlan := plan.Changes.ResourceInstance(addrZeroKey) + if instPlan == nil { + t.Fatalf("no plan for %s at all", addrZeroKey) + } + + if got, want := instPlan.Addr, addrZeroKey; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.PrevRunAddr, addrZeroKey; !got.Equal(want) { + t.Errorf("wrong previous run address\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.Action, plans.Create; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + if got, want := instPlan.ActionReason, plans.ResourceInstanceChangeNoReason; got != want { + t.Errorf("wrong action reason\ngot: %s\nwant: %s", got, want) + } + }) +} diff --git a/internal/terraform/node_resource_plan_orphan.go b/internal/terraform/node_resource_plan_orphan.go index 7f9a683f1ad9..94aa18f980e5 100644 --- a/internal/terraform/node_resource_plan_orphan.go +++ b/internal/terraform/node_resource_plan_orphan.go @@ -157,13 +157,29 @@ func (n *NodePlannableResourceInstanceOrphan) managedResourceExecute(ctx EvalCon func (n *NodePlannableResourceInstanceOrphan) deleteActionReason(ctx EvalContext) plans.ResourceInstanceChangeActionReason { cfg := n.Config if cfg == nil { - // NOTE: We'd ideally detect if the containing module is what's missing - // and then use ResourceInstanceDeleteBecauseNoModule for that case, - // but we don't currently have access to the full configuration here, - // so we need to be less specific. return plans.ResourceInstanceDeleteBecauseNoResourceConfig } + // If this is a resource instance inside a module instance that's no + // longer declared then we will have a config (because config isn't + // instance-specific) but the expander will know that our resource + // address's module path refers to an undeclared module instance. + if expander := ctx.InstanceExpander(); expander != nil { // (sometimes nil in MockEvalContext in tests) + validModuleAddr := expander.GetDeepestExistingModuleInstance(n.Addr.Module) + if len(validModuleAddr) != len(n.Addr.Module) { + // If we get here then at least one step in the resource's module + // path is to a module instance that doesn't exist at all, and + // so a missing module instance is the delete reason regardless + // of whether there might _also_ be a change to the resource + // configuration inside the module. (Conceptually the configurations + // inside the non-existing module instance don't exist at all, + // but they end up existing just as an artifact of the + // implementation detail that we detect module instance orphans + // only dynamically.) + return plans.ResourceInstanceDeleteBecauseNoModule + } + } + switch n.Addr.Resource.Key.(type) { case nil: // no instance key at all if cfg.Count != nil || cfg.ForEach != nil { From 096cddb4b794c0592640be736f6dc89cd3e08510 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 10 Dec 2021 16:27:40 -0800 Subject: [PATCH 431/644] command/format: Limitation of plans.ResourceInstanceDeleteBecauseNoModule This is an explicit technical debt note that our plan renderer isn't able to give a fully-specific hint in this particular case of deletion reason. This reason code means that at least one of the module instance keys in the resource's module path doesn't match an instance declared in the configuration, but the plan data structure doesn't retain enough information to know which is the first step in the path which refers to a missing instance, and so we just always return the whole thing. This would be confusing if we return module.foo[0].module.bar not being in the configuration as a result of module.foo not using "count"; it would be better to say "module.foo[0] is not in the configuration" instead. It would be most ideal to handle all of the different situations that ResourceInstanceDeleteBecauseWrongRepetition's rendering does, so that we can go further and explain exactly _why_ that module instance isn't declared anymore. We can do neither of those things today because only the Terraform Core "expander" component knows that information, and we've discarded that by the time we get to rendering a plan. To fix this one day would require preserving in the plan information about which module instances are declared, as a separate sidecar data structure from which resource instances we're taking actions on, and then using that to identify which step in addr.Module here first selects an invalid instance. --- internal/command/format/diff.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/internal/command/format/diff.go b/internal/command/format/diff.go index 3d08109e545b..1c1da14f48a4 100644 --- a/internal/command/format/diff.go +++ b/internal/command/format/diff.go @@ -107,6 +107,11 @@ func ResourceChange( case plans.ResourceInstanceDeleteBecauseNoResourceConfig: buf.WriteString(fmt.Sprintf("\n # (because %s is not in configuration)", addr.Resource.Resource)) case plans.ResourceInstanceDeleteBecauseNoModule: + // FIXME: Ideally we'd truncate addr.Module to reflect the earliest + // step that doesn't exist, so it's clearer which call this refers + // to, but we don't have enough information out here in the UI layer + // to decide that; only the "expander" in Terraform Core knows + // which module instance keys are actually declared. buf.WriteString(fmt.Sprintf("\n # (because %s is not in configuration)", addr.Module)) case plans.ResourceInstanceDeleteBecauseWrongRepetition: // We have some different variations of this one From 98978b3853a505b7fd31cc2ca8bba53f6925f381 Mon Sep 17 00:00:00 2001 From: Chris Arcand Date: Fri, 10 Dec 2021 13:43:17 -0600 Subject: [PATCH 432/644] command/meta_backend: Allow the remote backend to have no workspaces [again] A regression introduced in d72a413ef833d4882fcb15d7436fba4a35d53741 The comment explains, but TLDR: The remote backend actually *depended* on being able to write it's backend state even though an 'error' occurred (no workspaces). --- internal/command/meta_backend.go | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/internal/command/meta_backend.go b/internal/command/meta_backend.go index dafea1a7761c..f95e03d3fd24 100644 --- a/internal/command/meta_backend.go +++ b/internal/command/meta_backend.go @@ -1025,11 +1025,24 @@ func (m *Meta) backend_C_r_s(c *configs.Backend, cHash int, sMgr *clistate.Local Hash: uint64(cHash), } - // Verify that selected workspace exist. Otherwise prompt user to create one + // Verify that selected workspace exists in the backend. if opts.Init && b != nil { - if err := m.selectWorkspace(b); err != nil { + err := m.selectWorkspace(b) + if err != nil { diags = diags.Append(err) - return nil, diags + + // FIXME: A compatibility oddity with the 'remote' backend. + // As an awkward legacy UX, when the remote backend is configured and there + // are no workspaces, the output to the user saying that there are none and + // the user should create one with 'workspace new' takes the form of an + // error message - even though it's happy path, expected behavior. + // + // Therefore, only return nil with errored diags for everything else, and + // allow the remote backend to continue and write its configuration to state + // even though no workspace is selected. + if c.Type != "remote" { + return nil, diags + } } } From b0ff17ef2a1727143fa330062b32e1e466d4abe9 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 13 Dec 2021 15:31:30 -0800 Subject: [PATCH 433/644] getmodules: Inline our own fork of getter.GitGetter This is a pragmatic temporary solution to allow us to more quickly resolve an upstream regression in go-getter locally within Terraform, so that the work to upstream it for other callers can happen asynchronously and with less time pressure. This commit doesn't yet include any changes to address the bug, and instead aims to be functionally equivalent to getter.GitGetter. A subsequent commit will then address the regression, so that the diff of that commit will be easier to apply later to the upstream to get the same effect there. --- go.mod | 2 +- internal/getmodules/getter.go | 2 +- internal/getmodules/git_getter.go | 382 +++++++++++++ internal/getmodules/git_getter_test.go | 724 +++++++++++++++++++++++++ 4 files changed, 1108 insertions(+), 2 deletions(-) create mode 100644 internal/getmodules/git_getter.go create mode 100644 internal/getmodules/git_getter_test.go diff --git a/go.mod b/go.mod index 7505396c94da..d68dfd7cbec7 100644 --- a/go.mod +++ b/go.mod @@ -41,6 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 + github.com/hashicorp/go-safetemp v1.0.0 github.com/hashicorp/go-tfe v0.21.0 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 @@ -144,7 +145,6 @@ require ( github.com/hashicorp/go-immutable-radix v1.0.0 // indirect github.com/hashicorp/go-msgpack v0.5.4 // indirect github.com/hashicorp/go-rootcerts v1.0.2 // indirect - github.com/hashicorp/go-safetemp v1.0.0 // indirect github.com/hashicorp/go-slug v0.7.0 // indirect github.com/hashicorp/golang-lru v0.5.1 // indirect github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d // indirect diff --git a/internal/getmodules/getter.go b/internal/getmodules/getter.go index 95f334762e64..ba4c8d89ce52 100644 --- a/internal/getmodules/getter.go +++ b/internal/getmodules/getter.go @@ -73,7 +73,7 @@ var goGetterDecompressors = map[string]getter.Decompressor{ var goGetterGetters = map[string]getter.Getter{ "file": new(getter.FileGetter), "gcs": new(getter.GCSGetter), - "git": new(getter.GitGetter), + "git": new(gitGetter), "hg": new(getter.HgGetter), "s3": new(getter.S3Getter), "http": getterHTTPGetter, diff --git a/internal/getmodules/git_getter.go b/internal/getmodules/git_getter.go new file mode 100644 index 000000000000..535112e7ecde --- /dev/null +++ b/internal/getmodules/git_getter.go @@ -0,0 +1,382 @@ +package getmodules + +import ( + "bytes" + "context" + "encoding/base64" + "fmt" + "io/ioutil" + "net/url" + "os" + "os/exec" + "path/filepath" + "regexp" + "runtime" + "strconv" + "strings" + "syscall" + + getter "github.com/hashicorp/go-getter" + urlhelper "github.com/hashicorp/go-getter/helper/url" + safetemp "github.com/hashicorp/go-safetemp" + version "github.com/hashicorp/go-version" +) + +// getter is our base getter; it regroups +// fields all getters have in common. +type getterCommon struct { + client *getter.Client +} + +func (g *getterCommon) SetClient(c *getter.Client) { g.client = c } + +// Context tries to returns the Contex from the getter's +// client. otherwise context.Background() is returned. +func (g *getterCommon) Context() context.Context { + if g == nil || g.client == nil { + return context.Background() + } + return g.client.Ctx +} + +// gitGetter is a temporary fork of getter.GitGetter to allow us to tactically +// fix https://github.com/hashicorp/terraform/issues/30119 only within +// Terraform. +// +// This should be only a brief workaround to help us decouple work on the +// Terraform CLI v1.1.1 release so that we can get it done without having to +// coordinate with every other go-getter caller first. However, this fork +// should be healed promptly after v1.1.1 by upstreaming something like this +// fix into upstream go-getter, so that other go-getter callers can also +// benefit from it. +type gitGetter struct { + getterCommon +} + +var defaultBranchRegexp = regexp.MustCompile(`\s->\sorigin/(.*)`) +var lsRemoteSymRefRegexp = regexp.MustCompile(`ref: refs/heads/([^\s]+).*`) + +func (g *gitGetter) ClientMode(_ *url.URL) (getter.ClientMode, error) { + return getter.ClientModeDir, nil +} + +func (g *gitGetter) Get(dst string, u *url.URL) error { + ctx := g.Context() + if _, err := exec.LookPath("git"); err != nil { + return fmt.Errorf("git must be available and on the PATH") + } + + // The port number must be parseable as an integer. If not, the user + // was probably trying to use a scp-style address, in which case the + // ssh:// prefix must be removed to indicate that. + // + // This is not necessary in versions of Go which have patched + // CVE-2019-14809 (e.g. Go 1.12.8+) + if portStr := u.Port(); portStr != "" { + if _, err := strconv.ParseUint(portStr, 10, 16); err != nil { + return fmt.Errorf("invalid port number %q; if using the \"scp-like\" git address scheme where a colon introduces the path instead, remove the ssh:// portion and use just the git:: prefix", portStr) + } + } + + // Extract some query parameters we use + var ref, sshKey string + var depth int + q := u.Query() + if len(q) > 0 { + ref = q.Get("ref") + q.Del("ref") + + sshKey = q.Get("sshkey") + q.Del("sshkey") + + if n, err := strconv.Atoi(q.Get("depth")); err == nil { + depth = n + } + q.Del("depth") + + // Copy the URL + var newU url.URL = *u + u = &newU + u.RawQuery = q.Encode() + } + + var sshKeyFile string + if sshKey != "" { + // Check that the git version is sufficiently new. + if err := checkGitVersion("2.3"); err != nil { + return fmt.Errorf("Error using ssh key: %v", err) + } + + // We have an SSH key - decode it. + raw, err := base64.StdEncoding.DecodeString(sshKey) + if err != nil { + return err + } + + // Create a temp file for the key and ensure it is removed. + fh, err := ioutil.TempFile("", "go-getter") + if err != nil { + return err + } + sshKeyFile = fh.Name() + defer os.Remove(sshKeyFile) + + // Set the permissions prior to writing the key material. + if err := os.Chmod(sshKeyFile, 0600); err != nil { + return err + } + + // Write the raw key into the temp file. + _, err = fh.Write(raw) + fh.Close() + if err != nil { + return err + } + } + + // Clone or update the repository + _, err := os.Stat(dst) + if err != nil && !os.IsNotExist(err) { + return err + } + if err == nil { + err = g.update(ctx, dst, sshKeyFile, ref, depth) + } else { + err = g.clone(ctx, dst, sshKeyFile, u, ref, depth) + } + if err != nil { + return err + } + + // Next: check out the proper tag/branch if it is specified, and checkout + if ref != "" { + if err := g.checkout(dst, ref); err != nil { + return err + } + } + + // Lastly, download any/all submodules. + return g.fetchSubmodules(ctx, dst, sshKeyFile, depth) +} + +// GetFile for Git doesn't support updating at this time. It will download +// the file every time. +func (g *gitGetter) GetFile(dst string, u *url.URL) error { + td, tdcloser, err := safetemp.Dir("", "getter") + if err != nil { + return err + } + defer tdcloser.Close() + + // Get the filename, and strip the filename from the URL so we can + // just get the repository directly. + filename := filepath.Base(u.Path) + u.Path = filepath.Dir(u.Path) + + // Get the full repository + if err := g.Get(td, u); err != nil { + return err + } + + // Copy the single file + u, err = urlhelper.Parse(fmtFileURL(filepath.Join(td, filename))) + if err != nil { + return err + } + + fg := &getter.FileGetter{Copy: true} + return fg.GetFile(dst, u) +} + +func (g *gitGetter) checkout(dst string, ref string) error { + cmd := exec.Command("git", "checkout", ref) + cmd.Dir = dst + return getRunCommand(cmd) +} + +func (g *gitGetter) clone(ctx context.Context, dst, sshKeyFile string, u *url.URL, ref string, depth int) error { + args := []string{"clone"} + + if ref == "" { + ref = findRemoteDefaultBranch(u) + } + if depth > 0 { + args = append(args, "--depth", strconv.Itoa(depth)) + } + + args = append(args, "--branch", ref, u.String(), dst) + cmd := exec.CommandContext(ctx, "git", args...) + setupGitEnv(cmd, sshKeyFile) + return getRunCommand(cmd) +} + +func (g *gitGetter) update(ctx context.Context, dst, sshKeyFile, ref string, depth int) error { + // Determine if we're a branch. If we're NOT a branch, then we just + // switch to master prior to checking out + cmd := exec.CommandContext(ctx, "git", "show-ref", "-q", "--verify", "refs/heads/"+ref) + cmd.Dir = dst + + if getRunCommand(cmd) != nil { + // Not a branch, switch to default branch. This will also catch + // non-existent branches, in which case we want to switch to default + // and then checkout the proper branch later. + ref = findDefaultBranch(dst) + } + + // We have to be on a branch to pull + if err := g.checkout(dst, ref); err != nil { + return err + } + + if depth > 0 { + cmd = exec.Command("git", "pull", "--depth", strconv.Itoa(depth), "--ff-only") + } else { + cmd = exec.Command("git", "pull", "--ff-only") + } + + cmd.Dir = dst + setupGitEnv(cmd, sshKeyFile) + return getRunCommand(cmd) +} + +// fetchSubmodules downloads any configured submodules recursively. +func (g *gitGetter) fetchSubmodules(ctx context.Context, dst, sshKeyFile string, depth int) error { + args := []string{"submodule", "update", "--init", "--recursive"} + if depth > 0 { + args = append(args, "--depth", strconv.Itoa(depth)) + } + cmd := exec.CommandContext(ctx, "git", args...) + cmd.Dir = dst + setupGitEnv(cmd, sshKeyFile) + return getRunCommand(cmd) +} + +// findDefaultBranch checks the repo's origin remote for its default branch +// (generally "master"). "master" is returned if an origin default branch +// can't be determined. +func findDefaultBranch(dst string) string { + var stdoutbuf bytes.Buffer + cmd := exec.Command("git", "branch", "-r", "--points-at", "refs/remotes/origin/HEAD") + cmd.Dir = dst + cmd.Stdout = &stdoutbuf + err := cmd.Run() + matches := defaultBranchRegexp.FindStringSubmatch(stdoutbuf.String()) + if err != nil || matches == nil { + return "master" + } + return matches[len(matches)-1] +} + +// findRemoteDefaultBranch checks the remote repo's HEAD symref to return the remote repo's +// default branch. "master" is returned if no HEAD symref exists. +func findRemoteDefaultBranch(u *url.URL) string { + var stdoutbuf bytes.Buffer + cmd := exec.Command("git", "ls-remote", "--symref", u.String(), "HEAD") + cmd.Stdout = &stdoutbuf + err := cmd.Run() + matches := lsRemoteSymRefRegexp.FindStringSubmatch(stdoutbuf.String()) + if err != nil || matches == nil { + return "master" + } + return matches[len(matches)-1] +} + +// setupGitEnv sets up the environment for the given command. This is used to +// pass configuration data to git and ssh and enables advanced cloning methods. +func setupGitEnv(cmd *exec.Cmd, sshKeyFile string) { + const gitSSHCommand = "GIT_SSH_COMMAND=" + var sshCmd []string + + // If we have an existing GIT_SSH_COMMAND, we need to append our options. + // We will also remove our old entry to make sure the behavior is the same + // with versions of Go < 1.9. + env := os.Environ() + for i, v := range env { + if strings.HasPrefix(v, gitSSHCommand) && len(v) > len(gitSSHCommand) { + sshCmd = []string{v} + + env[i], env[len(env)-1] = env[len(env)-1], env[i] + env = env[:len(env)-1] + break + } + } + + if len(sshCmd) == 0 { + sshCmd = []string{gitSSHCommand + "ssh"} + } + + if sshKeyFile != "" { + // We have an SSH key temp file configured, tell ssh about this. + if runtime.GOOS == "windows" { + sshKeyFile = strings.Replace(sshKeyFile, `\`, `/`, -1) + } + sshCmd = append(sshCmd, "-i", sshKeyFile) + } + + env = append(env, strings.Join(sshCmd, " ")) + cmd.Env = env +} + +// checkGitVersion is used to check the version of git installed on the system +// against a known minimum version. Returns an error if the installed version +// is older than the given minimum. +func checkGitVersion(min string) error { + want, err := version.NewVersion(min) + if err != nil { + return err + } + + out, err := exec.Command("git", "version").Output() + if err != nil { + return err + } + + fields := strings.Fields(string(out)) + if len(fields) < 3 { + return fmt.Errorf("Unexpected 'git version' output: %q", string(out)) + } + v := fields[2] + if runtime.GOOS == "windows" && strings.Contains(v, ".windows.") { + // on windows, git version will return for example: + // git version 2.20.1.windows.1 + // Which does not follow the semantic versionning specs + // https://semver.org. We remove that part in order for + // go-version to not error. + v = v[:strings.Index(v, ".windows.")] + } + + have, err := version.NewVersion(v) + if err != nil { + return err + } + + if have.LessThan(want) { + return fmt.Errorf("Required git version = %s, have %s", want, have) + } + + return nil +} + +// getRunCommand is a helper that will run a command and capture the output +// in the case an error happens. +func getRunCommand(cmd *exec.Cmd) error { + var buf bytes.Buffer + cmd.Stdout = &buf + cmd.Stderr = &buf + err := cmd.Run() + if err == nil { + return nil + } + if exiterr, ok := err.(*exec.ExitError); ok { + // The program has exited with an exit code != 0 + if status, ok := exiterr.Sys().(syscall.WaitStatus); ok { + return fmt.Errorf( + "%s exited with %d: %s", + cmd.Path, + status.ExitStatus(), + buf.String()) + } + } + + return fmt.Errorf("error running %s: %s", cmd.Path, buf.String()) +} diff --git a/internal/getmodules/git_getter_test.go b/internal/getmodules/git_getter_test.go new file mode 100644 index 000000000000..79b3e1592523 --- /dev/null +++ b/internal/getmodules/git_getter_test.go @@ -0,0 +1,724 @@ +package getmodules + +import ( + "bytes" + "encoding/base64" + "io/ioutil" + "net/url" + "os" + "os/exec" + "path/filepath" + "reflect" + "runtime" + "strings" + "testing" + + getter "github.com/hashicorp/go-getter" + urlhelper "github.com/hashicorp/go-getter/helper/url" +) + +var testHasGit bool + +func init() { + if _, err := exec.LookPath("git"); err == nil { + testHasGit = true + } +} + +func TestGitGetter_impl(t *testing.T) { + var _ getter.Getter = new(gitGetter) +} + +func TestGitGetter(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "basic") + repo.commitFile("foo.txt", "hello") + + // With a dir that doesn't exist + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath := filepath.Join(dst, "foo.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_branch(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "branch") + repo.git("checkout", "-b", "test-branch") + repo.commitFile("branch.txt", "branch") + + q := repo.url.Query() + q.Add("ref", "test-branch") + repo.url.RawQuery = q.Encode() + + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath := filepath.Join(dst, "branch.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } + + // Get again should work + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath = filepath.Join(dst, "branch.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_remoteWithoutMaster(t *testing.T) { + if !testHasGit { + t.Log("git not found, skipping") + t.Skip() + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "branch") + repo.git("checkout", "-b", "test-branch") + repo.commitFile("branch.txt", "branch") + + q := repo.url.Query() + repo.url.RawQuery = q.Encode() + + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath := filepath.Join(dst, "branch.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } + + // Get again should work + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath = filepath.Join(dst, "branch.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_shallowClone(t *testing.T) { + if !testHasGit { + t.Log("git not found, skipping") + t.Skip() + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "upstream") + repo.commitFile("upstream.txt", "0") + repo.commitFile("upstream.txt", "1") + + // Specifiy a clone depth of 1 + q := repo.url.Query() + q.Add("depth", "1") + repo.url.RawQuery = q.Encode() + + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Assert rev-list count is '1' + cmd := exec.Command("git", "rev-list", "HEAD", "--count") + cmd.Dir = dst + b, err := cmd.Output() + if err != nil { + t.Fatalf("err: %s", err) + } + + out := strings.TrimSpace(string(b)) + if out != "1" { + t.Fatalf("expected rev-list count to be '1' but got %v", out) + } +} + +func TestGitGetter_shallowCloneWithTag(t *testing.T) { + if !testHasGit { + t.Log("git not found, skipping") + t.Skip() + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "upstream") + repo.commitFile("v1.0.txt", "0") + repo.git("tag", "v1.0") + repo.commitFile("v1.1.txt", "1") + + // Specifiy a clone depth of 1 with a tag + q := repo.url.Query() + q.Add("ref", "v1.0") + q.Add("depth", "1") + repo.url.RawQuery = q.Encode() + + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Assert rev-list count is '1' + cmd := exec.Command("git", "rev-list", "HEAD", "--count") + cmd.Dir = dst + b, err := cmd.Output() + if err != nil { + t.Fatalf("err: %s", err) + } + + out := strings.TrimSpace(string(b)) + if out != "1" { + t.Fatalf("expected rev-list count to be '1' but got %v", out) + } + + // Verify the v1.0 file exists + mainPath := filepath.Join(dst, "v1.0.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the v1.1 file does not exists + mainPath = filepath.Join(dst, "v1.1.txt") + if _, err := os.Stat(mainPath); err == nil { + t.Fatalf("expected v1.1 file to not exist") + } +} + +func TestGitGetter_branchUpdate(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + // First setup the state with a fresh branch + repo := testGitRepo(t, "branch-update") + repo.git("checkout", "-b", "test-branch") + repo.commitFile("branch.txt", "branch") + + // Get the "test-branch" branch + q := repo.url.Query() + q.Add("ref", "test-branch") + repo.url.RawQuery = q.Encode() + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath := filepath.Join(dst, "branch.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } + + // Commit an update to the branch + repo.commitFile("branch-update.txt", "branch-update") + + // Get again should work + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath = filepath.Join(dst, "branch-update.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_tag(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "tag") + repo.commitFile("tag.txt", "tag") + repo.git("tag", "v1.0") + + q := repo.url.Query() + q.Add("ref", "v1.0") + repo.url.RawQuery = q.Encode() + + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath := filepath.Join(dst, "tag.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } + + // Get again should work + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath = filepath.Join(dst, "tag.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_GetFile(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempTestFile(t) + defer os.RemoveAll(filepath.Dir(dst)) + + repo := testGitRepo(t, "file") + repo.commitFile("file.txt", "hello") + + // Download the file + repo.url.Path = filepath.Join(repo.url.Path, "file.txt") + if err := g.GetFile(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + if _, err := os.Stat(dst); err != nil { + t.Fatalf("err: %s", err) + } + assertContents(t, dst, "hello") +} + +func TestGitGetter_gitVersion(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + if runtime.GOOS == "windows" { + t.Skip("skipping on windows since the test requires sh") + } + dir, err := ioutil.TempDir("", "go-getter") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(dir) + + script := filepath.Join(dir, "git") + err = ioutil.WriteFile( + script, + []byte("#!/bin/sh\necho \"git version 2.0 (Some Metadata Here)\n\""), + 0700) + if err != nil { + t.Fatal(err) + } + + defer func(v string) { + os.Setenv("PATH", v) + }(os.Getenv("PATH")) + + os.Setenv("PATH", dir) + + // Asking for a higher version throws an error + if err := checkGitVersion("2.3"); err == nil { + t.Fatal("expect git version error") + } + + // Passes when version is satisfied + if err := checkGitVersion("1.9"); err != nil { + t.Fatal(err) + } +} + +func TestGitGetter_sshKey(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + encodedKey := base64.StdEncoding.EncodeToString([]byte(testGitToken)) + + // avoid getting locked by a github authenticity validation prompt + os.Setenv("GIT_SSH_COMMAND", "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes") + defer os.Setenv("GIT_SSH_COMMAND", "") + + u, err := urlhelper.Parse("ssh://git@github.com/hashicorp/test-private-repo" + + "?sshkey=" + encodedKey) + if err != nil { + t.Fatal(err) + } + + if err := g.Get(dst, u); err != nil { + t.Fatalf("err: %s", err) + } + + readmePath := filepath.Join(dst, "README.md") + if _, err := os.Stat(readmePath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_sshSCPStyle(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + encodedKey := base64.StdEncoding.EncodeToString([]byte(testGitToken)) + + // avoid getting locked by a github authenticity validation prompt + os.Setenv("GIT_SSH_COMMAND", "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes") + defer os.Setenv("GIT_SSH_COMMAND", "") + + // This test exercises the combination of the git detector and the + // git getter, to make sure that together they make scp-style URLs work. + client := &getter.Client{ + Src: "git@github.com:hashicorp/test-private-repo?sshkey=" + encodedKey, + Dst: dst, + Pwd: ".", + + Mode: getter.ClientModeDir, + + Detectors: []getter.Detector{ + new(getter.GitDetector), + }, + Getters: map[string]getter.Getter{ + "git": g, + }, + } + + if err := client.Get(); err != nil { + t.Fatalf("client.Get failed: %s", err) + } + + readmePath := filepath.Join(dst, "README.md") + if _, err := os.Stat(readmePath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_sshExplicitPort(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + encodedKey := base64.StdEncoding.EncodeToString([]byte(testGitToken)) + + // avoid getting locked by a github authenticity validation prompt + os.Setenv("GIT_SSH_COMMAND", "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes") + defer os.Setenv("GIT_SSH_COMMAND", "") + + // This test exercises the combination of the git detector and the + // git getter, to make sure that together they make scp-style URLs work. + client := &getter.Client{ + Src: "git::ssh://git@github.com:22/hashicorp/test-private-repo?sshkey=" + encodedKey, + Dst: dst, + Pwd: ".", + + Mode: getter.ClientModeDir, + + Detectors: []getter.Detector{ + new(getter.GitDetector), + }, + Getters: map[string]getter.Getter{ + "git": g, + }, + } + + if err := client.Get(); err != nil { + t.Fatalf("client.Get failed: %s", err) + } + + readmePath := filepath.Join(dst, "README.md") + if _, err := os.Stat(readmePath); err != nil { + t.Fatalf("err: %s", err) + } +} + +func TestGitGetter_sshSCPStyleInvalidScheme(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + encodedKey := base64.StdEncoding.EncodeToString([]byte(testGitToken)) + + // avoid getting locked by a github authenticity validation prompt + os.Setenv("GIT_SSH_COMMAND", "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes") + defer os.Setenv("GIT_SSH_COMMAND", "") + + // This test exercises the combination of the git detector and the + // git getter, to make sure that together they make scp-style URLs work. + client := &getter.Client{ + Src: "git::ssh://git@github.com:hashicorp/test-private-repo?sshkey=" + encodedKey, + Dst: dst, + Pwd: ".", + + Mode: getter.ClientModeDir, + + Detectors: []getter.Detector{ + new(getter.GitDetector), + }, + Getters: map[string]getter.Getter{ + "git": g, + }, + } + + err := client.Get() + if err == nil { + t.Fatalf("get succeeded; want error") + } + + got := err.Error() + want1, want2 := `invalid source string`, `invalid port number "hashicorp"` + if !(strings.Contains(got, want1) || strings.Contains(got, want2)) { + t.Fatalf("wrong error\ngot: %s\nwant: %q or %q", got, want1, want2) + } +} + +func TestGitGetter_submodule(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + relpath := func(basepath, targpath string) string { + relpath, err := filepath.Rel(basepath, targpath) + if err != nil { + t.Fatal(err) + } + return strings.Replace(relpath, `\`, `/`, -1) + // on windows git still prefers relatives paths + // containing `/` for submodules + } + + // Set up the grandchild + gc := testGitRepo(t, "grandchild") + gc.commitFile("grandchild.txt", "grandchild") + + // Set up the child + c := testGitRepo(t, "child") + c.commitFile("child.txt", "child") + c.git("submodule", "add", "-f", relpath(c.dir, gc.dir)) + c.git("commit", "-m", "Add grandchild submodule") + + // Set up the parent + p := testGitRepo(t, "parent") + p.commitFile("parent.txt", "parent") + p.git("submodule", "add", "-f", relpath(p.dir, c.dir)) + p.git("commit", "-m", "Add child submodule") + + // Clone the root repository + if err := g.Get(dst, p.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Check that the files exist + for _, path := range []string{ + filepath.Join(dst, "parent.txt"), + filepath.Join(dst, "child", "child.txt"), + filepath.Join(dst, "child", "grandchild", "grandchild.txt"), + } { + if _, err := os.Stat(path); err != nil { + t.Fatalf("err: %s", err) + } + } +} + +func TestGitGetter_setupGitEnv_sshKey(t *testing.T) { + if runtime.GOOS == "windows" { + t.Skip("skipping on windows since the test requires sh") + } + + cmd := exec.Command("/bin/sh", "-c", "echo $GIT_SSH_COMMAND") + setupGitEnv(cmd, "/tmp/foo.pem") + out, err := cmd.Output() + if err != nil { + t.Fatal(err) + } + + actual := strings.TrimSpace(string(out)) + if actual != "ssh -i /tmp/foo.pem" { + t.Fatalf("unexpected GIT_SSH_COMMAND: %q", actual) + } +} + +func TestGitGetter_setupGitEnvWithExisting_sshKey(t *testing.T) { + if runtime.GOOS == "windows" { + t.Skipf("skipping on windows since the test requires sh") + return + } + + // start with an existing ssh command configuration + os.Setenv("GIT_SSH_COMMAND", "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes") + defer os.Setenv("GIT_SSH_COMMAND", "") + + cmd := exec.Command("/bin/sh", "-c", "echo $GIT_SSH_COMMAND") + setupGitEnv(cmd, "/tmp/foo.pem") + out, err := cmd.Output() + if err != nil { + t.Fatal(err) + } + + actual := strings.TrimSpace(string(out)) + if actual != "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i /tmp/foo.pem" { + t.Fatalf("unexpected GIT_SSH_COMMAND: %q", actual) + } +} + +// gitRepo is a helper struct which controls a single temp git repo. +type gitRepo struct { + t *testing.T + url *url.URL + dir string +} + +// testGitRepo creates a new test git repository. +func testGitRepo(t *testing.T, name string) *gitRepo { + t.Helper() + dir, err := ioutil.TempDir("", "go-getter") + if err != nil { + t.Fatal(err) + } + dir = filepath.Join(dir, name) + if err := os.Mkdir(dir, 0700); err != nil { + t.Fatal(err) + } + + r := &gitRepo{ + t: t, + dir: dir, + } + + url, err := urlhelper.Parse("file://" + r.dir) + if err != nil { + t.Fatal(err) + } + r.url = url + + t.Logf("initializing git repo in %s", dir) + r.git("init") + r.git("config", "user.name", "go-getter") + r.git("config", "user.email", "go-getter@hashicorp.com") + + return r +} + +// git runs a git command against the repo. +func (r *gitRepo) git(args ...string) { + cmd := exec.Command("git", args...) + cmd.Dir = r.dir + bfr := bytes.NewBuffer(nil) + cmd.Stderr = bfr + if err := cmd.Run(); err != nil { + r.t.Fatal(err, bfr.String()) + } +} + +// commitFile writes and commits a text file to the repo. +func (r *gitRepo) commitFile(file, content string) { + path := filepath.Join(r.dir, file) + if err := ioutil.WriteFile(path, []byte(content), 0600); err != nil { + r.t.Fatal(err) + } + r.git("add", file) + r.git("commit", "-m", "Adding "+file) +} + +// This is a read-only deploy key for an empty test repository. +// Note: This is split over multiple lines to avoid being disabled by key +// scanners automatically. +var testGitToken = `-----BEGIN RSA PRIVATE KEY----- +MIIEpAIBAAKCAQEA9cHsxCl3Jjgu9DHpwvmfFOl1XEdY+ShHDR/cMnzJ5ddk5/oV +Wy6EWatvyHZfRSZMwzv4PtKeUPm6iXjqWp4xdWU9khlPzozyj+U9Fq70TRVUW9E5 +T1XdQVwJE421yffr4VMMwu60wBqjI1epapH2i2inYvw9Zl9X2MXq0+jTvFvDerbT +mDtfStDPljenELAIZtWVETSvbI46gALwbxbM2292ZUIL4D6jRz0aZMmyy/twYv8r +9WGJLwmYzU518Ie7zqKW/mCTdTrV0WRiDj0MeRaPgrGY9amuHE4r9iG/cJkwpKAO +Ccz0Hs6i89u9vZnTqZU9V7weJqRAQcMjXXR6yQIDAQABAoIBAQDBzICKnGxiTlHw +rd+6qqChnAy5jWYDbZjCJ8q8YZ3RS08+g/8NXZxvHftTqM0uOaq1FviHig3gq15H +hHvCpBc6jXDFYoKFzq6FfO/0kFkE5HoWweIgxwRow0xBCDJAJ+ryUEyy+Ay/pQHb +IAjwilRS0V+WdnVw4mTjBAhPvb4jPOo97Yfy3PYUyx2F3newkqXOZy+zx3G/ANoa +ncypfMGyy76sfCWKqw4J1gVkVQLwbB6gQkXUFGYwY9sRrxbG93kQw76Flc/E/s52 +62j4v1IM0fq0t/St+Y/+s6Lkw` + `aqt3ft1nsqWcRaVDdqvMfkzgJGXlw0bGzJG5MEQ +AIBq3dHRAoGBAP8OeG/DKG2Z1VmSfzuz1pas1fbZ+F7venOBrjez3sKlb3Pyl2aH +mt2wjaTUi5v10VrHgYtOEdqyhQeUSYydWXIBKNMag0NLLrfFUKZK+57wrHWFdFjn +VgpsdkLSNTOZpC8gA5OaJ+36IcOPfGqyyP9wuuRoaYnVT1KEzqLa9FEFAoGBAPaq +pglwhil2rxjJE4zq0afQLNpAfi7Xqcrepij+xvJIcIj7nawxXuPxqRFxONE/h3yX +zkybO8wLdbHX9Iw/wc1j50Uf1Z5gHdLf7/hQJoWKpz1RnkWRy6CYON8v1tpVp0tb +OAajR/kZnzebq2mfa7pyy5zDCX++2kp/dcFwHf31AoGAE8oupBVTZLWj7TBFuP8q +LkS40U92Sv9v09iDCQVmylmFvUxcXPM2m+7f/qMTNgWrucxzC7kB/6MMWVszHbrz +vrnCTibnemgx9sZTjKOSxHFOIEw7i85fSa3Cu0qOIDPSnmlwfZpfcMKQrhjLAYhf +uhooFiLX1X78iZ2OXup4PHUCgYEAsmBrm83sp1V1gAYBBlnVbXakyNv0pCk/Vz61 +iFXeRt1NzDGxLxGw3kQnED8BaIh5kQcyn8Fud7sdzJMv/LAqlT4Ww60mzNYTGyjo +H3jOsqm3ESfRvduWFreeAQBWbiOczGjV1i8D4EbAFfWT+tjXjchwKBf+6Yt5zn/o +Bw/uEHUCgYAFs+JPOR25oRyBs7ujrMo/OY1z/eXTVVgZxY+tYGe1FJqDeFyR7ytK ++JBB1MuDwQKGm2wSIXdCzTNoIx2B9zTseiPTwT8G7vqNFhXoIaTBp4P2xIQb45mJ +7GkTsMBHwpSMOXgX9Weq3v5xOJ2WxVtjENmd6qzxcYCO5lP15O17hA== +-----END RSA PRIVATE KEY-----` + +func assertContents(t *testing.T, path string, contents string) { + data, err := ioutil.ReadFile(path) + if err != nil { + t.Fatalf("err: %s", err) + } + + if !reflect.DeepEqual(data, []byte(contents)) { + t.Fatalf("bad. expected:\n\n%s\n\nGot:\n\n%s", contents, string(data)) + } +} + +func tempDir(t *testing.T) string { + dir, err := ioutil.TempDir("", "tf") + if err != nil { + t.Fatalf("err: %s", err) + } + if err := os.RemoveAll(dir); err != nil { + t.Fatalf("err: %s", err) + } + + return dir +} + +func tempTestFile(t *testing.T) string { + dir := tempDir(t) + return filepath.Join(dir, "foo") +} From c4d46e7c6b9ed577cae3f1ab149e610fcc44a666 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 13 Dec 2021 17:14:30 -0800 Subject: [PATCH 434/644] getmodules: Re-allow git:: source with ref=COMMIT_ID Earlier versions of this code allowed "ref" to take any value that would be accepted by "git checkout" as a valid target of a symbolic ref. We inadvertently accepted a breaking change to upstream go-getter that broke that as part of introducing a shallow clone optimization, because shallow clone requires selecting a single branch. To restore the previous capabilities while retaining the "depth" argument, here we accept a compromise where "ref" has the stronger requirement of being a valid named ref in the remote repository if and only if "depth" is set to a value greater than zero. If depth isn't set or is less than one, we will do the old behavior of just cloning all of the refs in the remote repository in full and then switching to refer to the selected branch, tag, or naked commit ID as a separate step. This includes a heuristic to generate an additional error message hint if we get an error from "git clone" and it looks like the user might've been trying to use "depth" and "ref=COMMIT" together. We can't recognize that error accurately because it's only reported as human-oriented git command output, but this heuristic should hopefully minimize situations where we show it inappropriately. For now this is a change in the Terraform repository directly, so that we can expedite the fix to an already-reported regression. After this is released I tend to also submit a similar set of changes to upstream go-getter, at which point we can revert Terraform to using the upstream getter.GitGetter instead of our own local fork. --- internal/getmodules/git_getter.go | 40 +++++++++- internal/getmodules/git_getter_test.go | 103 +++++++++++++++++++++++++ 2 files changed, 140 insertions(+), 3 deletions(-) diff --git a/internal/getmodules/git_getter.go b/internal/getmodules/git_getter.go index 535112e7ecde..1b811b8fbd43 100644 --- a/internal/getmodules/git_getter.go +++ b/internal/getmodules/git_getter.go @@ -80,7 +80,7 @@ func (g *gitGetter) Get(dst string, u *url.URL) error { // Extract some query parameters we use var ref, sshKey string - var depth int + depth := 0 // 0 means "not set" q := u.Query() if len(q) > 0 { ref = q.Get("ref") @@ -194,20 +194,54 @@ func (g *gitGetter) checkout(dst string, ref string) error { return getRunCommand(cmd) } +// gitCommitIDRegex is a pattern intended to match strings that seem +// "likely to be" git commit IDs, rather than named refs. This cannot be +// an exact decision because it's valid to name a branch or tag after a series +// of hexadecimal digits too. +// +// We require at least 7 digits here because that's the smallest size git +// itself will typically generate, and so it'll reduce the risk of false +// positives on short branch names that happen to also be "hex words". +var gitCommitIDRegex = regexp.MustCompile("^[0-9a-fA-F]{7,40}$") + func (g *gitGetter) clone(ctx context.Context, dst, sshKeyFile string, u *url.URL, ref string, depth int) error { args := []string{"clone"} + autoBranch := false if ref == "" { ref = findRemoteDefaultBranch(u) + autoBranch = true } if depth > 0 { args = append(args, "--depth", strconv.Itoa(depth)) + args = append(args, "--branch", ref) } + args = append(args, u.String(), dst) - args = append(args, "--branch", ref, u.String(), dst) cmd := exec.CommandContext(ctx, "git", args...) setupGitEnv(cmd, sshKeyFile) - return getRunCommand(cmd) + err := getRunCommand(cmd) + if err != nil { + if depth > 0 && !autoBranch { + // If we're creating a shallow clone then the given ref must be + // a named ref (branch or tag) rather than a commit directly. + // We can't accurately recognize the resulting error here without + // hard-coding assumptions about git's human-readable output, but + // we can at least try a heuristic. + if gitCommitIDRegex.MatchString(ref) { + return fmt.Errorf("%w (note that setting 'depth' requires 'ref' to be a branch or tag name)", err) + } + } + return err + } + + if depth < 1 && !autoBranch { + // If we didn't add --depth and --branch above then we will now be + // on the remote repository's default branch, rather than the selected + // ref, so we'll need to fix that before we return. + return g.checkout(dst, ref) + } + return nil } func (g *gitGetter) update(ctx context.Context, dst, sshKeyFile, ref string, depth int) error { diff --git a/internal/getmodules/git_getter_test.go b/internal/getmodules/git_getter_test.go index 79b3e1592523..5893c9c8e1b9 100644 --- a/internal/getmodules/git_getter_test.go +++ b/internal/getmodules/git_getter_test.go @@ -90,6 +90,58 @@ func TestGitGetter_branch(t *testing.T) { } } +func TestGitGetter_commitID(t *testing.T) { + if !testHasGit { + t.Skip("git not found, skipping") + } + + g := new(gitGetter) + dst := tempDir(t) + + // We're going to create different content on the main branch vs. + // another branch here, so that below we can recognize if we + // correctly cloned the commit actually requested (from the + // "other branch"), not the one at HEAD. + repo := testGitRepo(t, "commit_id") + repo.git("checkout", "-b", "main-branch") + repo.commitFile("wrong.txt", "Nope") + repo.git("checkout", "-b", "other-branch") + repo.commitFile("hello.txt", "Yep") + commitID, err := repo.latestCommit() + if err != nil { + t.Fatal(err) + } + // Return to the main branch so that HEAD of this repository + // will be that, rather than "test-branch". + repo.git("checkout", "main-branch") + + q := repo.url.Query() + q.Add("ref", commitID) + repo.url.RawQuery = q.Encode() + + t.Logf("Getting %s", repo.url) + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath := filepath.Join(dst, "hello.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } + + // Get again should work + if err := g.Get(dst, repo.url); err != nil { + t.Fatalf("err: %s", err) + } + + // Verify the main file exists + mainPath = filepath.Join(dst, "hello.txt") + if _, err := os.Stat(mainPath); err != nil { + t.Fatalf("err: %s", err) + } +} + func TestGitGetter_remoteWithoutMaster(t *testing.T) { if !testHasGit { t.Log("git not found, skipping") @@ -214,6 +266,44 @@ func TestGitGetter_shallowCloneWithTag(t *testing.T) { } } +func TestGitGetter_shallowCloneWithCommitID(t *testing.T) { + if !testHasGit { + t.Log("git not found, skipping") + t.Skip() + } + + g := new(gitGetter) + dst := tempDir(t) + + repo := testGitRepo(t, "upstream") + repo.commitFile("v1.0.txt", "0") + repo.git("tag", "v1.0") + repo.commitFile("v1.1.txt", "1") + + commitID, err := repo.latestCommit() + if err != nil { + t.Fatal(err) + } + + // Specify a clone depth of 1 with a naked commit ID + // This is intentionally invalid: shallow clone always requires a named ref. + q := repo.url.Query() + q.Add("ref", commitID[:8]) + q.Add("depth", "1") + repo.url.RawQuery = q.Encode() + + t.Logf("Getting %s", repo.url) + err = g.Get(dst, repo.url) + if err == nil { + t.Fatalf("success; want error") + } + // We use a heuristic to generate an extra hint in the error message if + // it looks like the user was trying to combine ref=COMMIT with depth. + if got, want := err.Error(), "(note that setting 'depth' requires 'ref' to be a branch or tag name)"; !strings.Contains(got, want) { + t.Errorf("missing error message hint\ngot: %s\nwant substring: %s", got, want) + } +} + func TestGitGetter_branchUpdate(t *testing.T) { if !testHasGit { t.Skip("git not found, skipping") @@ -664,6 +754,19 @@ func (r *gitRepo) commitFile(file, content string) { r.git("commit", "-m", "Adding "+file) } +// latestCommit returns the full commit id of the latest commit on the current +// branch. +func (r *gitRepo) latestCommit() (string, error) { + cmd := exec.Command("git", "rev-parse", "HEAD") + cmd.Dir = r.dir + rawOut, err := cmd.Output() + if err != nil { + return "", err + } + rawOut = bytes.TrimSpace(rawOut) + return string(rawOut), nil +} + // This is a read-only deploy key for an empty test repository. // Note: This is split over multiple lines to avoid being disabled by key // scanners automatically. From d469e86331a6dc4eee9a6d45e00c12dae80bcb32 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 14 Dec 2021 17:50:53 -0500 Subject: [PATCH 435/644] revert 6b8b0617 Revert the evaluation change from #29862. While returning a dynamic value for all expanded resources during validation is not optimal, trying to work around this using unknown maps and lists is causing other undesirable behaviors during evaluation. --- internal/terraform/context_plan_test.go | 1 - internal/terraform/evaluate.go | 19 +++++-------------- .../testdata/plan-self-ref-multi-all/main.tf | 2 +- 3 files changed, 6 insertions(+), 16 deletions(-) diff --git a/internal/terraform/context_plan_test.go b/internal/terraform/context_plan_test.go index 1159f0b424fc..cfd51da8cc43 100644 --- a/internal/terraform/context_plan_test.go +++ b/internal/terraform/context_plan_test.go @@ -5308,7 +5308,6 @@ func TestContext2Plan_selfRefMultiAll(t *testing.T) { ResourceTypes: map[string]*configschema.Block{ "aws_instance": { Attributes: map[string]*configschema.Attribute{ - "id": {Type: cty.String, Computed: true}, "foo": {Type: cty.List(cty.String), Optional: true}, }, }, diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index 8fd05d548192..a017cf1751a9 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -696,21 +696,12 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc log.Printf("[ERROR] unknown instance %q referenced during %s", addr.Absolute(d.ModulePath), d.Operation) return cty.DynamicVal, diags } - default: - if d.Operation != walkValidate { - log.Printf("[ERROR] missing state for %q while in %s\n", addr.Absolute(d.ModulePath), d.Operation) - } - // Validation is done with only the configuration, so generate - // unknown values of the correct shape for evaluation. - switch { - case config.Count != nil: - return cty.UnknownVal(cty.List(ty)), diags - case config.ForEach != nil: - return cty.UnknownVal(cty.Map(ty)), diags - default: - return cty.UnknownVal(ty), diags - } + default: + // We should only end up here during the validate walk, + // since later walks should have at least partial states populated + // for all resources in the configuration. + return cty.DynamicVal, diags } } diff --git a/internal/terraform/testdata/plan-self-ref-multi-all/main.tf b/internal/terraform/testdata/plan-self-ref-multi-all/main.tf index a4d28f8a092f..d3a9857f7bd3 100644 --- a/internal/terraform/testdata/plan-self-ref-multi-all/main.tf +++ b/internal/terraform/testdata/plan-self-ref-multi-all/main.tf @@ -1,4 +1,4 @@ resource "aws_instance" "web" { - foo = aws_instance.web[*].id + foo = "${aws_instance.web.*.foo}" count = 4 } From 71b9682e8ce40d389b48377ff23c98c887bbcc11 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 14 Dec 2021 18:02:57 -0500 Subject: [PATCH 436/644] ensure there is always a valid return value --- internal/terraform/evaluate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index a017cf1751a9..322ef6fda4d0 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -794,7 +794,7 @@ func (d *evaluationStateData) GetResource(addr addrs.Resource, rng tfdiags.Sourc instances[key] = val } - var ret cty.Value + ret := cty.DynamicVal switch { case config.Count != nil: From 21cbb5b3921c54124ea3923ce52081ebe4382a3f Mon Sep 17 00:00:00 2001 From: Dylan Staley <88163+dstaley@users.noreply.github.com> Date: Tue, 14 Dec 2021 18:41:17 -0800 Subject: [PATCH 437/644] migrate docs to mdx --- website/README.md | 31 +- .../cli/auth/{index.html.md => index.mdx} | 17 +- .../cli/cloud/command-line-arguments.html.md | 26 - .../docs/cli/cloud/command-line-arguments.mdx | 24 + website/docs/cli/cloud/index.html.md | 28 - website/docs/cli/cloud/index.mdx | 26 + .../{migrating.html.md => migrating.mdx} | 15 +- .../cloud/{settings.html.md => settings.mdx} | 37 +- .../cli/code/{index.html.md => index.mdx} | 24 +- .../{0.12upgrade.html.md => 0.12upgrade.mdx} | 19 +- .../{0.13upgrade.html.md => 0.13upgrade.mdx} | 13 +- .../cli/commands/{apply.html.md => apply.mdx} | 40 +- .../commands/{console.html.md => console.mdx} | 23 +- .../commands/{destroy.html.md => destroy.mdx} | 12 +- website/docs/cli/commands/env.html.md | 12 - website/docs/cli/commands/env.mdx | 12 + .../cli/commands/{fmt.html.md => fmt.mdx} | 12 +- ...{force-unlock.html.md => force-unlock.mdx} | 10 +- .../cli/commands/{get.html.md => get.mdx} | 10 +- .../cli/commands/{graph.html.md => graph.mdx} | 19 +- .../commands/{import.html.md => import.mdx} | 38 +- .../cli/commands/{index.html.md => index.mdx} | 14 +- .../cli/commands/{init.html.md => init.mdx} | 48 +- .../cli/commands/{login.html.md => login.mdx} | 16 +- .../commands/{logout.html.md => logout.mdx} | 11 +- .../commands/{output.html.md => output.mdx} | 25 +- .../cli/commands/{plan.html.md => plan.mdx} | 123 ++-- .../{providers.html.md => providers.mdx} | 10 +- .../providers/{lock.html.md => lock.mdx} | 56 +- .../providers/{mirror.html.md => mirror.mdx} | 8 +- .../providers/{schema.html.md => schema.mdx} | 14 +- .../cli/commands/{push.html.md => push.mdx} | 12 +- .../commands/{refresh.html.md => refresh.mdx} | 14 +- .../cli/commands/{show.html.md => show.mdx} | 15 +- .../state/{index.html.md => index.mdx} | 11 +- .../commands/state/{list.html.md => list.mdx} | 15 +- .../cli/commands/state/{mv.html.md => mv.mdx} | 40 +- .../commands/state/{pull.html.md => pull.mdx} | 11 +- website/docs/cli/commands/state/push.html.md | 50 -- website/docs/cli/commands/state/push.mdx | 47 ++ ...-provider.html.md => replace-provider.mdx} | 24 +- .../cli/commands/state/{rm.html.md => rm.mdx} | 31 +- .../commands/state/{show.html.md => show.mdx} | 21 +- .../cli/commands/{taint.html.md => taint.mdx} | 26 +- .../cli/commands/{test.html.md => test.mdx} | 9 +- .../commands/{untaint.html.md => untaint.mdx} | 20 +- .../{validate.html.md => validate.mdx} | 141 +++-- .../commands/{version.html.md => version.mdx} | 14 +- .../workspace/{delete.html.md => delete.mdx} | 11 +- .../workspace/{index.html.md => index.mdx} | 9 +- .../workspace/{list.html.md => list.mdx} | 7 +- .../workspace/{new.html.md => new.mdx} | 11 +- .../workspace/{select.html.md => select.mdx} | 7 +- .../workspace/{show.html.md => show.mdx} | 7 +- .../{config-file.html.md => config-file.mdx} | 84 +-- ...bles.html.md => environment-variables.mdx} | 22 +- .../cli/config/{index.html.md => index.mdx} | 11 +- ...mportability.html.md => importability.mdx} | 6 +- .../cli/import/{index.html.md => index.mdx} | 14 +- .../cli/import/{usage.html.md => usage.mdx} | 13 +- website/docs/cli/{index.html.md => index.mdx} | 10 +- .../cli/init/{index.html.md => index.mdx} | 14 +- .../cli/inspect/{index.html.md => index.mdx} | 19 +- .../docs/cli/install/{apt.html.md => apt.mdx} | 13 +- .../docs/cli/install/{yum.html.md => yum.mdx} | 13 +- .../cli/plugins/{index.html.md => index.mdx} | 25 +- .../plugins/{signing.html.md => signing.mdx} | 15 +- .../docs/cli/run/{index.html.md => index.mdx} | 17 +- .../cli/state/{index.html.md => index.mdx} | 19 +- .../state/{inspect.html.md => inspect.mdx} | 11 +- .../docs/cli/state/{move.html.md => move.mdx} | 17 +- .../state/{recover.html.md => recover.mdx} | 14 +- ...essing.html.md => resource-addressing.mdx} | 38 +- .../cli/state/{taint.html.md => taint.mdx} | 11 +- .../workspaces/{index.html.md => index.mdx} | 35 +- .../configuration-0-11/interpolation.html.md | 570 ----------------- .../docs/configuration/expressions.html.md | 157 ----- website/docs/configuration/expressions.mdx | 121 ++++ website/docs/configuration/index.mdx | 5 + website/docs/configuration/modules.html.md | 54 -- website/docs/configuration/modules.mdx | 39 ++ website/docs/configuration/resources.html.md | 135 ----- website/docs/configuration/resources.mdx | 93 +++ .../{archiving.html.md => archiving.mdx} | 12 +- ...elpers.html.md => credentials-helpers.mdx} | 23 +- .../{debugging.html.md => debugging.mdx} | 11 +- website/docs/internals/graph.html.md | 121 ---- website/docs/internals/graph.mdx | 123 ++++ .../internals/{index.html.md => index.mdx} | 8 +- .../{json-format.html.md => json-format.mdx} | 19 +- website/docs/internals/lifecycle.html.md | 58 -- website/docs/internals/lifecycle.mdx | 59 ++ ...tocol.html.markdown => login-protocol.mdx} | 17 +- ...ble-ui.html.md => machine-readable-ui.mdx} | 35 +- ...l.html.md => module-registry-protocol.mdx} | 36 +- ...rovider-meta.html.md => provider-meta.mdx} | 9 +- ...d => provider-network-mirror-protocol.mdx} | 42 +- ...html.md => provider-registry-protocol.mdx} | 76 ++- ...y.html.md => remote-service-discovery.mdx} | 12 +- ...r-as-blocks.html.md => attr-as-blocks.mdx} | 24 +- .../configuration-0-11/data-sources.mdx} | 27 +- .../environment-variables.mdx} | 22 +- .../configuration-0-11/index.mdx} | 12 +- .../configuration-0-11/interpolation.mdx | 571 ++++++++++++++++++ .../configuration-0-11/load.mdx} | 16 +- .../configuration-0-11/locals.mdx} | 18 +- .../configuration-0-11/modules.mdx} | 36 +- .../configuration-0-11/outputs.mdx} | 17 +- .../configuration-0-11/override.mdx} | 22 +- .../configuration-0-11/providers.mdx} | 43 +- .../configuration-0-11/resources.mdx} | 50 +- .../configuration-0-11/syntax.mdx} | 52 +- .../terraform-enterprise.mdx} | 20 +- .../configuration-0-11/terraform.mdx} | 17 +- .../configuration-0-11/variables.mdx} | 16 +- .../data-sources/{index.html.md => index.mdx} | 36 +- ...{conditionals.html.md => conditionals.mdx} | 9 +- ...amic-blocks.html.md => dynamic-blocks.mdx} | 22 +- .../expressions/{for.html.md => for.mdx} | 11 +- ...ction-calls.html.md => function-calls.mdx} | 25 +- .../expressions/{index.html.md => index.mdx} | 33 +- .../{operators.html.md => operators.mdx} | 11 +- .../{references.html.md => references.mdx} | 108 ++-- .../expressions/{splat.html.md => splat.mdx} | 13 +- .../{strings.html.md => strings.mdx} | 63 +- ...nstraints.html.md => type-constraints.mdx} | 104 ++-- .../expressions/{types.html.md => types.mdx} | 14 +- ...raints.html.md => version-constraints.mdx} | 15 +- .../dependency-lock.mdx} | 89 +-- .../files/{index.html.md => index.mdx} | 12 +- .../files/{override.html.md => override.mdx} | 8 +- .../functions/{abs.html.md => abs.mdx} | 7 +- .../{abspath.html.md => abspath.mdx} | 9 +- .../{alltrue.html.md => alltrue.mdx} | 2 - .../{anytrue.html.md => anytrue.mdx} | 2 - ...{base64decode.html.md => base64decode.mdx} | 17 +- ...{base64encode.html.md => base64encode.mdx} | 17 +- .../{base64gzip.html.md => base64gzip.mdx} | 8 +- ...{base64sha256.html.md => base64sha256.mdx} | 10 +- ...{base64sha512.html.md => base64sha512.mdx} | 10 +- .../{basename.html.md => basename.mdx} | 8 +- .../functions/{bcrypt.html.md => bcrypt.mdx} | 4 +- .../functions/{can.html.md => can.mdx} | 12 +- .../functions/{ceil.html.md => ceil.mdx} | 6 +- .../functions/{chomp.html.md => chomp.mdx} | 9 +- .../{chunklist.html.md => chunklist.mdx} | 4 +- .../{cidrhost.html.md => cidrhost.mdx} | 8 +- .../{cidrnetmask.html.md => cidrnetmask.mdx} | 4 +- .../{cidrsubnet.html.md => cidrsubnet.mdx} | 16 +- .../{cidrsubnets.html.md => cidrsubnets.mdx} | 14 +- .../{coalesce.html.md => coalesce.mdx} | 6 +- ...{coalescelist.html.md => coalescelist.mdx} | 6 +- .../docs/language/functions/compact.html.md | 23 - website/docs/language/functions/compact.mdx | 20 + .../docs/language/functions/concat.html.md | 23 - website/docs/language/functions/concat.mdx | 20 + .../{contains.html.md => contains.mdx} | 7 +- .../{csvdecode.html.md => csvdecode.mdx} | 11 +- .../{defaults.html.md => defaults.mdx} | 11 +- .../{dirname.html.md => dirname.mdx} | 11 +- .../{distinct.html.md => distinct.mdx} | 7 +- .../{element.html.md => element.mdx} | 13 +- .../functions/{file.html.md => file.mdx} | 10 +- .../{filebase64.html.md => filebase64.mdx} | 8 +- ...e64sha256.html.md => filebase64sha256.mdx} | 8 +- ...e64sha512.html.md => filebase64sha512.mdx} | 8 +- .../{fileexists.html.md => fileexists.mdx} | 9 +- .../{filemd5.html.md => filemd5.mdx} | 8 +- .../{fileset.html.md => fileset.mdx} | 13 +- .../{filesha1.html.md => filesha1.mdx} | 8 +- .../{filesha256.html.md => filesha256.mdx} | 8 +- .../{filesha512.html.md => filesha512.mdx} | 8 +- .../{flatten.html.md => flatten.mdx} | 13 +- .../functions/{floor.html.md => floor.mdx} | 6 +- .../functions/{format.html.md => format.mdx} | 8 +- .../language/functions/formatdate.html.md | 108 ---- .../docs/language/functions/formatdate.mdx | 105 ++++ .../{formatlist.html.md => formatlist.mdx} | 8 +- .../functions/{indent.html.md => indent.mdx} | 4 +- .../functions/{index.html.md => index.mdx} | 12 +- ...ex_function.html.md => index_function.mdx} | 9 +- .../functions/{join.html.md => join.mdx} | 6 +- .../{jsondecode.html.md => jsondecode.mdx} | 8 +- .../{jsonencode.html.md => jsonencode.mdx} | 11 +- .../functions/{keys.html.md => keys.mdx} | 9 +- .../functions/{length.html.md => length.mdx} | 7 +- .../functions/{list.html.md => list.mdx} | 13 +- .../functions/{log.html.md => log.mdx} | 7 +- .../functions/{lookup.html.md => lookup.mdx} | 9 +- .../functions/{lower.html.md => lower.mdx} | 13 +- .../functions/{map.html.md => map.mdx} | 13 +- .../{matchkeys.html.md => matchkeys.mdx} | 4 +- .../functions/{max.html.md => max.mdx} | 9 +- .../functions/{md5.html.md => md5.mdx} | 6 +- .../functions/{merge.html.md => merge.mdx} | 6 +- .../functions/{min.html.md => min.mdx} | 9 +- ...{nonsensitive.html.md => nonsensitive.mdx} | 9 +- .../functions/{one.html.md => one.mdx} | 6 +- .../{parseint.html.md => parseint.mdx} | 11 +- .../{pathexpand.html.md => pathexpand.mdx} | 4 +- website/docs/language/functions/pow.html.md | 20 - website/docs/language/functions/pow.mdx | 17 + .../functions/{range.html.md => range.mdx} | 7 +- website/docs/language/functions/regex.html.md | 163 ----- website/docs/language/functions/regex.mdx | 161 +++++ .../{regexall.html.md => regexall.mdx} | 13 +- .../{replace.html.md => replace.mdx} | 8 +- .../{reverse.html.md => reverse.mdx} | 9 +- .../{rsadecrypt.html.md => rsadecrypt.mdx} | 7 +- .../{sensitive.html.md => sensitive.mdx} | 9 +- ...tersection.html.md => setintersection.mdx} | 14 +- .../{setproduct.html.md => setproduct.mdx} | 18 +- .../{setsubtract.html.md => setsubtract.mdx} | 13 +- .../{setunion.html.md => setunion.mdx} | 14 +- .../functions/{sha1.html.md => sha1.mdx} | 6 +- .../functions/{sha256.html.md => sha256.mdx} | 9 +- .../functions/{sha512.html.md => sha512.mdx} | 8 +- .../functions/{signum.html.md => signum.mdx} | 7 +- .../functions/{slice.html.md => slice.mdx} | 9 +- .../functions/{sort.html.md => sort.mdx} | 4 +- .../functions/{split.html.md => split.mdx} | 6 +- .../functions/{strrev.html.md => strrev.mdx} | 9 +- .../functions/{substr.html.md => substr.mdx} | 4 +- .../functions/{sum.html.md => sum.mdx} | 7 +- ...{templatefile.html.md => templatefile.mdx} | 20 +- ...odebase64.html.md => textdecodebase64.mdx} | 19 +- ...odebase64.html.md => textencodebase64.mdx} | 18 +- .../{timeadd.html.md => timeadd.mdx} | 4 +- .../{timestamp.html.md => timestamp.mdx} | 8 +- .../functions/{title.html.md => title.mdx} | 8 +- .../functions/{tobool.html.md => tobool.mdx} | 7 +- .../functions/{tolist.html.md => tolist.mdx} | 7 +- .../functions/{tomap.html.md => tomap.mdx} | 7 +- .../{tonumber.html.md => tonumber.mdx} | 7 +- .../functions/{toset.html.md => toset.mdx} | 7 +- .../{tostring.html.md => tostring.mdx} | 7 +- .../{transpose.html.md => transpose.mdx} | 4 +- .../functions/{trim.html.md => trim.mdx} | 20 +- .../{trimprefix.html.md => trimprefix.mdx} | 10 +- .../{trimspace.html.md => trimspace.mdx} | 6 +- .../language/functions/trimsuffix.html.md | 26 - .../docs/language/functions/trimsuffix.mdx | 24 + .../functions/{try.html.md => try.mdx} | 6 +- .../functions/{type.html.md => type.mdx} | 9 +- .../functions/{upper.html.md => upper.mdx} | 13 +- .../{urlencode.html.md => urlencode.mdx} | 7 +- .../functions/{uuid.html.md => uuid.mdx} | 13 +- .../functions/{uuidv5.html.md => uuidv5.mdx} | 25 +- .../functions/{values.html.md => values.mdx} | 11 +- .../{yamldecode.html.md => yamldecode.mdx} | 10 +- .../{yamlencode.html.md => yamlencode.mdx} | 17 +- .../functions/{zipmap.html.md => zipmap.mdx} | 4 +- .../language/{index.html.md => index.mdx} | 16 +- .../{count.html.md => count.mdx} | 15 +- .../{depends_on.html.md => depends_on.mdx} | 8 +- .../{for_each.html.md => for_each.mdx} | 37 +- .../language/meta-arguments/lifecycle.html.md | 116 ---- .../language/meta-arguments/lifecycle.mdx | 117 ++++ ...providers.html.md => module-providers.mdx} | 15 +- ...provider.html.md => resource-provider.mdx} | 11 +- .../{composition.html.md => composition.mdx} | 8 +- .../develop/{index.html.md => index.mdx} | 28 +- .../{providers.html.md => providers.mdx} | 15 +- .../develop/{publish.html.md => publish.mdx} | 18 +- .../{refactoring.html.md => refactoring.mdx} | 24 +- .../{structure.html.md => structure.mdx} | 9 +- .../modules/{index.html.md => index.mdx} | 25 +- .../modules/{sources.html.md => sources.mdx} | 47 +- .../modules/{syntax.html.md => syntax.mdx} | 37 +- ...eriment.html.md => testing-experiment.mdx} | 3 +- ...onfiguration.html.md => configuration.mdx} | 26 +- .../providers/{index.html.md => index.mdx} | 63 +- ...{requirements.html.md => requirements.mdx} | 40 +- .../{behavior.html.md => behavior.mdx} | 20 +- .../resources/{index.html.md => index.mdx} | 23 +- .../provisioners/{chef.html.md => chef.mdx} | 23 +- .../{connection.html.md => connection.mdx} | 35 +- .../provisioners/{file.html.md => file.mdx} | 14 +- .../{habitat.html.md => habitat.mdx} | 20 +- .../resources/provisioners/index.html.md | 12 - .../language/resources/provisioners/index.mdx | 12 + .../{local-exec.html.md => local-exec.mdx} | 16 +- ...ull_resource.html.md => null_resource.mdx} | 18 +- .../{puppet.html.md => puppet.mdx} | 15 +- .../{remote-exec.html.md => remote-exec.mdx} | 22 +- .../provisioners/salt-masterless.html.md | 92 --- .../provisioners/salt-masterless.mdx | 91 +++ .../{syntax.html.md => syntax.mdx} | 26 +- .../resources/{syntax.html.md => syntax.mdx} | 33 +- .../{artifactory.html.md => artifactory.mdx} | 19 +- .../backends/{azurerm.html.md => azurerm.mdx} | 44 +- ...onfiguration.html.md => configuration.mdx} | 41 +- .../language/settings/backends/consul.html.md | 59 -- .../language/settings/backends/consul.mdx | 56 ++ .../backends/{cos.html.md => cos.mdx} | 29 +- .../backends/{etcd.html.md => etcd.mdx} | 17 +- .../language/settings/backends/etcdv3.html.md | 55 -- .../language/settings/backends/etcdv3.mdx | 52 ++ .../backends/{gcs.html.md => gcs.mdx} | 65 +- .../language/settings/backends/http.html.md | 70 --- .../docs/language/settings/backends/http.mdx | 67 ++ .../backends/{index.html.md => index.mdx} | 24 +- .../{kubernetes.html.md => kubernetes.mdx} | 18 +- .../backends/{local.html.md => local.mdx} | 33 +- .../language/settings/backends/manta.html.md | 52 -- .../docs/language/settings/backends/manta.mdx | 49 ++ .../backends/{oss.html.md => oss.mdx} | 35 +- .../language/settings/backends/pg.html.md | 90 --- .../docs/language/settings/backends/pg.mdx | 87 +++ .../backends/{remote.html.md => remote.mdx} | 71 +-- .../settings/backends/{s3.html.md => s3.mdx} | 17 +- .../backends/{swift.html.md => swift.mdx} | 22 +- .../settings/{index.html.md => index.mdx} | 29 +- .../language/settings/terraform-cloud.html.md | 33 - .../language/settings/terraform-cloud.mdx | 33 + .../state/{backends.html.md => backends.mdx} | 33 +- .../state/{import.html.md => import.mdx} | 11 +- .../state/{index.html.md => index.mdx} | 28 +- .../state/{locking.html.md => locking.mdx} | 15 +- .../state/{purpose.html.md => purpose.mdx} | 13 +- .../language/state/remote-state-data.html.md | 220 ------- .../docs/language/state/remote-state-data.mdx | 219 +++++++ .../state/{remote.html.md => remote.mdx} | 17 +- ...sitive-data.html.md => sensitive-data.mdx} | 13 +- .../{workspaces.html.md => workspaces.mdx} | 49 +- ...onfiguration.html.md => configuration.mdx} | 12 +- .../syntax/{index.html.md => index.mdx} | 15 +- .../syntax/{json.html.md => json.mdx} | 18 +- .../syntax/{style.html.md => style.mdx} | 43 +- .../language/upgrade-guides/0-10.mdx} | 25 +- .../language/upgrade-guides/0-11.mdx} | 15 +- .../language/upgrade-guides/0-12.mdx} | 26 +- .../language/upgrade-guides/0-13.mdx} | 28 +- .../language/upgrade-guides/0-14.mdx} | 28 +- .../language/upgrade-guides/0-15.mdx} | 163 +++-- .../language/upgrade-guides/0-7.mdx} | 17 +- .../language/upgrade-guides/0-8.mdx} | 7 +- .../language/upgrade-guides/0-9.mdx} | 23 +- .../language/upgrade-guides/1-0.mdx} | 27 +- .../language/upgrade-guides/1-1.mdx} | 17 +- .../language/upgrade-guides/index.mdx} | 7 +- ....html.md => v1-compatibility-promises.mdx} | 115 ++-- website/docs/language/values/index.html.md | 19 - website/docs/language/values/index.mdx | 20 + .../values/{locals.html.md => locals.mdx} | 20 +- .../values/{outputs.html.md => outputs.mdx} | 25 +- .../{variables.html.md => variables.mdx} | 67 +- website/guides/{index.html.md => index.mdx} | 6 +- .../terraform-integration-program.html.md | 235 ------- ...erraform-provider-development-program.mdx} | 80 +-- .../core-workflow.mdx} | 25 +- .../intro/{index.html.markdown => index.mdx} | 21 +- ...{use-cases.html.markdown => use-cases.mdx} | 11 +- .../intro/vs/{boto.html.markdown => boto.mdx} | 7 +- ...f-puppet.html.markdown => chef-puppet.mdx} | 9 +- ...ation.html.markdown => cloudformation.mdx} | 10 +- .../vs/{custom.html.markdown => custom.mdx} | 9 +- .../vs/{index.html.markdown => index.mdx} | 7 +- 358 files changed, 5054 insertions(+), 5868 deletions(-) rename website/docs/cli/auth/{index.html.md => index.mdx} (64%) delete mode 100644 website/docs/cli/cloud/command-line-arguments.html.md create mode 100644 website/docs/cli/cloud/command-line-arguments.mdx delete mode 100644 website/docs/cli/cloud/index.html.md create mode 100644 website/docs/cli/cloud/index.mdx rename website/docs/cli/cloud/{migrating.html.md => migrating.mdx} (76%) rename website/docs/cli/cloud/{settings.html.md => settings.mdx} (70%) rename website/docs/cli/code/{index.html.md => index.mdx} (65%) rename website/docs/cli/commands/{0.12upgrade.html.md => 0.12upgrade.mdx} (90%) rename website/docs/cli/commands/{0.13upgrade.html.md => 0.13upgrade.mdx} (92%) rename website/docs/cli/commands/{apply.html.md => apply.mdx} (82%) rename website/docs/cli/commands/{console.html.md => console.mdx} (77%) rename website/docs/cli/commands/{destroy.html.md => destroy.mdx} (78%) delete mode 100644 website/docs/cli/commands/env.html.md create mode 100644 website/docs/cli/commands/env.mdx rename website/docs/cli/commands/{fmt.html.md => fmt.mdx} (89%) rename website/docs/cli/commands/{force-unlock.html.md => force-unlock.mdx} (71%) rename website/docs/cli/commands/{get.html.md => get.mdx} (60%) rename website/docs/cli/commands/{graph.html.md => graph.mdx} (74%) rename website/docs/cli/commands/{import.html.md => import.mdx} (79%) rename website/docs/cli/commands/{index.html.md => index.mdx} (93%) rename website/docs/cli/commands/{init.html.md => init.mdx} (83%) rename website/docs/cli/commands/{login.html.md => login.mdx} (72%) rename website/docs/cli/commands/{logout.html.md => logout.mdx} (79%) rename website/docs/cli/commands/{output.html.md => output.mdx} (81%) rename website/docs/cli/commands/{plan.html.md => plan.mdx} (78%) rename website/docs/cli/commands/{providers.html.md => providers.mdx} (55%) rename website/docs/cli/commands/providers/{lock.html.md => lock.mdx} (76%) rename website/docs/cli/commands/providers/{mirror.html.md => mirror.mdx} (89%) rename website/docs/cli/commands/providers/{schema.html.md => schema.mdx} (93%) rename website/docs/cli/commands/{push.html.md => push.mdx} (61%) rename website/docs/cli/commands/{refresh.html.md => refresh.mdx} (88%) rename website/docs/cli/commands/{show.html.md => show.mdx} (81%) rename website/docs/cli/commands/state/{index.html.md => index.mdx} (82%) rename website/docs/cli/commands/state/{list.html.md => list.mdx} (84%) rename website/docs/cli/commands/state/{mv.html.md => mv.mdx} (81%) rename website/docs/cli/commands/state/{pull.html.md => pull.mdx} (77%) delete mode 100644 website/docs/cli/commands/state/push.html.md create mode 100644 website/docs/cli/commands/state/push.mdx rename website/docs/cli/commands/state/{replace-provider.html.md => replace-provider.mdx} (65%) rename website/docs/cli/commands/state/{rm.html.md => rm.mdx} (80%) rename website/docs/cli/commands/state/{show.html.md => show.mdx} (78%) rename website/docs/cli/commands/{taint.html.md => taint.mdx} (73%) rename website/docs/cli/commands/{test.html.md => test.mdx} (52%) rename website/docs/cli/commands/{untaint.html.md => untaint.mdx} (78%) rename website/docs/cli/commands/{validate.html.md => validate.mdx} (56%) rename website/docs/cli/commands/{version.html.md => version.mdx} (75%) rename website/docs/cli/commands/workspace/{delete.html.md => delete.mdx} (81%) rename website/docs/cli/commands/workspace/{index.html.md => index.mdx} (60%) rename website/docs/cli/commands/workspace/{list.html.md => list.mdx} (64%) rename website/docs/cli/commands/workspace/{new.html.md => new.mdx} (83%) rename website/docs/cli/commands/workspace/{select.html.md => select.mdx} (69%) rename website/docs/cli/commands/workspace/{show.html.md => show.mdx} (57%) rename website/docs/cli/config/{config-file.html.md => config-file.mdx} (86%) rename website/docs/cli/config/{environment-variables.html.md => environment-variables.mdx} (88%) rename website/docs/cli/config/{index.html.md => index.mdx} (68%) rename website/docs/cli/import/{importability.html.md => importability.mdx} (82%) rename website/docs/cli/import/{index.html.md => index.mdx} (81%) rename website/docs/cli/import/{usage.html.md => usage.mdx} (90%) rename website/docs/cli/{index.html.md => index.mdx} (67%) rename website/docs/cli/init/{index.html.md => index.mdx} (85%) rename website/docs/cli/inspect/{index.html.md => index.mdx} (63%) rename website/docs/cli/install/{apt.html.md => apt.mdx} (93%) rename website/docs/cli/install/{yum.html.md => yum.mdx} (91%) rename website/docs/cli/plugins/{index.html.md => index.mdx} (65%) rename website/docs/cli/plugins/{signing.html.md => signing.mdx} (70%) rename website/docs/cli/run/{index.html.md => index.mdx} (82%) rename website/docs/cli/state/{index.html.md => index.mdx} (66%) rename website/docs/cli/state/{inspect.html.md => inspect.mdx} (58%) rename website/docs/cli/state/{move.html.md => move.mdx} (64%) rename website/docs/cli/state/{recover.html.md => recover.mdx} (65%) rename website/docs/cli/state/{resource-addressing.html.md => resource-addressing.mdx} (69%) rename website/docs/cli/state/{taint.html.md => taint.mdx} (68%) rename website/docs/cli/workspaces/{index.html.md => index.mdx} (65%) delete mode 100644 website/docs/configuration-0-11/interpolation.html.md delete mode 100644 website/docs/configuration/expressions.html.md create mode 100644 website/docs/configuration/expressions.mdx create mode 100644 website/docs/configuration/index.mdx delete mode 100644 website/docs/configuration/modules.html.md create mode 100644 website/docs/configuration/modules.mdx delete mode 100644 website/docs/configuration/resources.html.md create mode 100644 website/docs/configuration/resources.mdx rename website/docs/internals/{archiving.html.md => archiving.mdx} (75%) rename website/docs/internals/{credentials-helpers.html.md => credentials-helpers.mdx} (89%) rename website/docs/internals/{debugging.html.md => debugging.mdx} (89%) delete mode 100644 website/docs/internals/graph.html.md create mode 100644 website/docs/internals/graph.mdx rename website/docs/internals/{index.html.md => index.mdx} (68%) rename website/docs/internals/{json-format.html.md => json-format.mdx} (96%) delete mode 100644 website/docs/internals/lifecycle.html.md create mode 100644 website/docs/internals/lifecycle.mdx rename website/docs/internals/{login-protocol.html.markdown => login-protocol.mdx} (92%) rename website/docs/internals/{machine-readable-ui.html.md => machine-readable-ui.mdx} (94%) rename website/docs/internals/{module-registry-protocol.html.md => module-registry-protocol.mdx} (87%) rename website/docs/internals/{provider-meta.html.md => provider-meta.mdx} (96%) rename website/docs/internals/{provider-network-mirror-protocol.html.md => provider-network-mirror-protocol.mdx} (87%) rename website/docs/internals/{provider-registry-protocol.html.md => provider-registry-protocol.mdx} (84%) rename website/docs/internals/{remote-service-discovery.html.md => remote-service-discovery.mdx} (91%) rename website/docs/language/{attr-as-blocks.html.md => attr-as-blocks.mdx} (89%) rename website/docs/{configuration-0-11/data-sources.html.md => language/configuration-0-11/data-sources.mdx} (77%) rename website/docs/{configuration-0-11/environment-variables.html.md => language/configuration-0-11/environment-variables.mdx} (85%) rename website/docs/{configuration-0-11/index.html.md => language/configuration-0-11/index.mdx} (73%) create mode 100644 website/docs/language/configuration-0-11/interpolation.mdx rename website/docs/{configuration-0-11/load.html.md => language/configuration-0-11/load.mdx} (78%) rename website/docs/{configuration-0-11/locals.html.md => language/configuration-0-11/locals.mdx} (85%) rename website/docs/{configuration-0-11/modules.html.md => language/configuration-0-11/modules.mdx} (92%) rename website/docs/{configuration-0-11/outputs.html.md => language/configuration-0-11/outputs.mdx} (85%) rename website/docs/{configuration-0-11/override.html.md => language/configuration-0-11/override.mdx} (64%) rename website/docs/{configuration-0-11/providers.html.md => language/configuration-0-11/providers.mdx} (91%) rename website/docs/{configuration-0-11/resources.html.md => language/configuration-0-11/resources.mdx} (86%) rename website/docs/{configuration-0-11/syntax.html.md => language/configuration-0-11/syntax.mdx} (61%) rename website/docs/{configuration-0-11/terraform-enterprise.html.md => language/configuration-0-11/terraform-enterprise.mdx} (67%) rename website/docs/{configuration-0-11/terraform.html.md => language/configuration-0-11/terraform.mdx} (82%) rename website/docs/{configuration-0-11/variables.html.md => language/configuration-0-11/variables.mdx} (94%) rename website/docs/language/data-sources/{index.html.md => index.mdx} (86%) rename website/docs/language/expressions/{conditionals.html.md => conditionals.mdx} (87%) rename website/docs/language/expressions/{dynamic-blocks.html.md => dynamic-blocks.mdx} (88%) rename website/docs/language/expressions/{for.html.md => for.mdx} (95%) rename website/docs/language/expressions/{function-calls.html.md => function-calls.mdx} (81%) rename website/docs/language/expressions/{index.html.md => index.mdx} (67%) rename website/docs/language/expressions/{operators.html.md => operators.mdx} (92%) rename website/docs/language/expressions/{references.html.md => references.mdx} (80%) rename website/docs/language/expressions/{splat.html.md => splat.mdx} (90%) rename website/docs/language/expressions/{strings.html.md => strings.mdx} (80%) rename website/docs/language/expressions/{type-constraints.html.md => type-constraints.mdx} (75%) rename website/docs/language/expressions/{types.html.md => types.mdx} (92%) rename website/docs/language/expressions/{version-constraints.html.md => version-constraints.mdx} (85%) rename website/docs/language/{dependency-lock.html.md => files/dependency-lock.mdx} (82%) rename website/docs/language/files/{index.html.md => index.mdx} (84%) rename website/docs/language/files/{override.html.md => override.mdx} (95%) rename website/docs/language/functions/{abs.html.md => abs.mdx} (61%) rename website/docs/language/functions/{abspath.html.md => abspath.mdx} (67%) rename website/docs/language/functions/{alltrue.html.md => alltrue.mdx} (89%) rename website/docs/language/functions/{anytrue.html.md => anytrue.mdx} (90%) rename website/docs/language/functions/{base64decode.html.md => base64decode.mdx} (68%) rename website/docs/language/functions/{base64encode.html.md => base64encode.mdx} (70%) rename website/docs/language/functions/{base64gzip.html.md => base64gzip.mdx} (78%) rename website/docs/language/functions/{base64sha256.html.md => base64sha256.mdx} (72%) rename website/docs/language/functions/{base64sha512.html.md => base64sha512.mdx} (73%) rename website/docs/language/functions/{basename.html.md => basename.mdx} (80%) rename website/docs/language/functions/{bcrypt.html.md => bcrypt.mdx} (90%) rename website/docs/language/functions/{can.html.md => can.mdx} (83%) rename website/docs/language/functions/{ceil.html.md => ceil.mdx} (63%) rename website/docs/language/functions/{chomp.html.md => chomp.mdx} (56%) rename website/docs/language/functions/{chunklist.html.md => chunklist.mdx} (80%) rename website/docs/language/functions/{cidrhost.html.md => cidrhost.mdx} (87%) rename website/docs/language/functions/{cidrnetmask.html.md => cidrnetmask.mdx} (88%) rename website/docs/language/functions/{cidrsubnet.html.md => cidrsubnet.mdx} (91%) rename website/docs/language/functions/{cidrsubnets.html.md => cidrsubnets.mdx} (86%) rename website/docs/language/functions/{coalesce.html.md => coalesce.mdx} (85%) rename website/docs/language/functions/{coalescelist.html.md => coalescelist.mdx} (75%) delete mode 100644 website/docs/language/functions/compact.html.md create mode 100644 website/docs/language/functions/compact.mdx delete mode 100644 website/docs/language/functions/concat.html.md create mode 100644 website/docs/language/functions/concat.mdx rename website/docs/language/functions/{contains.html.md => contains.mdx} (54%) rename website/docs/language/functions/{csvdecode.html.md => csvdecode.mdx} (89%) rename website/docs/language/functions/{defaults.html.md => defaults.mdx} (93%) rename website/docs/language/functions/{dirname.html.md => dirname.mdx} (76%) rename website/docs/language/functions/{distinct.html.md => distinct.mdx} (60%) rename website/docs/language/functions/{element.html.md => element.mdx} (64%) rename website/docs/language/functions/{file.html.md => file.mdx} (79%) rename website/docs/language/functions/{filebase64.html.md => filebase64.mdx} (84%) rename website/docs/language/functions/{filebase64sha256.html.md => filebase64sha256.mdx} (53%) rename website/docs/language/functions/{filebase64sha512.html.md => filebase64sha512.mdx} (53%) rename website/docs/language/functions/{fileexists.html.md => fileexists.mdx} (68%) rename website/docs/language/functions/{filemd5.html.md => filemd5.mdx} (55%) rename website/docs/language/functions/{fileset.html.md => fileset.mdx} (82%) rename website/docs/language/functions/{filesha1.html.md => filesha1.mdx} (54%) rename website/docs/language/functions/{filesha256.html.md => filesha256.mdx} (54%) rename website/docs/language/functions/{filesha512.html.md => filesha512.mdx} (54%) rename website/docs/language/functions/{flatten.html.md => flatten.mdx} (87%) rename website/docs/language/functions/{floor.html.md => floor.mdx} (62%) rename website/docs/language/functions/{format.html.md => format.mdx} (95%) delete mode 100644 website/docs/language/functions/formatdate.html.md create mode 100644 website/docs/language/functions/formatdate.mdx rename website/docs/language/functions/{formatlist.html.md => formatlist.mdx} (81%) rename website/docs/language/functions/{indent.html.md => indent.mdx} (84%) rename website/docs/language/functions/{index.html.md => index.mdx} (76%) rename website/docs/language/functions/{index_function.html.md => index_function.mdx} (52%) rename website/docs/language/functions/{join.html.md => join.mdx} (71%) rename website/docs/language/functions/{jsondecode.html.md => jsondecode.mdx} (83%) rename website/docs/language/functions/{jsonencode.html.md => jsonencode.mdx} (78%) rename website/docs/language/functions/{keys.html.md => keys.mdx} (55%) rename website/docs/language/functions/{length.html.md => length.mdx} (81%) rename website/docs/language/functions/{list.html.md => list.mdx} (55%) rename website/docs/language/functions/{log.html.md => log.mdx} (65%) rename website/docs/language/functions/{lookup.html.md => lookup.mdx} (65%) rename website/docs/language/functions/{lower.html.md => lower.mdx} (52%) rename website/docs/language/functions/{map.html.md => map.mdx} (57%) rename website/docs/language/functions/{matchkeys.html.md => matchkeys.mdx} (93%) rename website/docs/language/functions/{max.html.md => max.mdx} (52%) rename website/docs/language/functions/{md5.html.md => md5.mdx} (81%) rename website/docs/language/functions/{merge.html.md => merge.mdx} (86%) rename website/docs/language/functions/{min.html.md => min.mdx} (52%) rename website/docs/language/functions/{nonsensitive.html.md => nonsensitive.mdx} (95%) rename website/docs/language/functions/{one.html.md => one.mdx} (94%) rename website/docs/language/functions/{parseint.html.md => parseint.mdx} (81%) rename website/docs/language/functions/{pathexpand.html.md => pathexpand.mdx} (93%) delete mode 100644 website/docs/language/functions/pow.html.md create mode 100644 website/docs/language/functions/pow.mdx rename website/docs/language/functions/{range.html.md => range.mdx} (93%) delete mode 100644 website/docs/language/functions/regex.html.md create mode 100644 website/docs/language/functions/regex.mdx rename website/docs/language/functions/{regexall.html.md => regexall.mdx} (80%) rename website/docs/language/functions/{replace.html.md => replace.mdx} (75%) rename website/docs/language/functions/{reverse.html.md => reverse.mdx} (53%) rename website/docs/language/functions/{rsadecrypt.html.md => rsadecrypt.mdx} (79%) rename website/docs/language/functions/{sensitive.html.md => sensitive.mdx} (79%) rename website/docs/language/functions/{setintersection.html.md => setintersection.mdx} (57%) rename website/docs/language/functions/{setproduct.html.md => setproduct.mdx} (91%) rename website/docs/language/functions/{setsubtract.html.md => setsubtract.mdx} (58%) rename website/docs/language/functions/{setunion.html.md => setunion.mdx} (55%) rename website/docs/language/functions/{sha1.html.md => sha1.mdx} (82%) rename website/docs/language/functions/{sha256.html.md => sha256.mdx} (73%) rename website/docs/language/functions/{sha512.html.md => sha512.mdx} (74%) rename website/docs/language/functions/{signum.html.md => signum.mdx} (50%) rename website/docs/language/functions/{slice.html.md => slice.mdx} (61%) rename website/docs/language/functions/{sort.html.md => sort.mdx} (78%) rename website/docs/language/functions/{split.html.md => split.mdx} (72%) rename website/docs/language/functions/{strrev.html.md => strrev.mdx} (63%) rename website/docs/language/functions/{substr.html.md => substr.mdx} (84%) rename website/docs/language/functions/{sum.html.md => sum.mdx} (67%) rename website/docs/language/functions/{templatefile.html.md => templatefile.mdx} (85%) rename website/docs/language/functions/{textdecodebase64.html.md => textdecodebase64.mdx} (75%) rename website/docs/language/functions/{textencodebase64.html.md => textencodebase64.mdx} (77%) rename website/docs/language/functions/{timeadd.html.md => timeadd.mdx} (88%) rename website/docs/language/functions/{timestamp.html.md => timestamp.mdx} (79%) rename website/docs/language/functions/{title.html.md => title.mdx} (58%) rename website/docs/language/functions/{tobool.html.md => tobool.mdx} (80%) rename website/docs/language/functions/{tolist.html.md => tolist.mdx} (80%) rename website/docs/language/functions/{tomap.html.md => tomap.mdx} (76%) rename website/docs/language/functions/{tonumber.html.md => tonumber.mdx} (77%) rename website/docs/language/functions/{toset.html.md => toset.mdx} (83%) rename website/docs/language/functions/{tostring.html.md => tostring.mdx} (76%) rename website/docs/language/functions/{transpose.html.md => transpose.mdx} (75%) rename website/docs/language/functions/{trim.html.md => trim.mdx} (53%) rename website/docs/language/functions/{trimprefix.html.md => trimprefix.mdx} (57%) rename website/docs/language/functions/{trimspace.html.md => trimspace.mdx} (69%) delete mode 100644 website/docs/language/functions/trimsuffix.html.md create mode 100644 website/docs/language/functions/trimsuffix.mdx rename website/docs/language/functions/{try.html.md => try.mdx} (95%) rename website/docs/language/functions/{type.html.md => type.mdx} (87%) rename website/docs/language/functions/{upper.html.md => upper.mdx} (52%) rename website/docs/language/functions/{urlencode.html.md => urlencode.mdx} (80%) rename website/docs/language/functions/{uuid.html.md => uuid.mdx} (70%) rename website/docs/language/functions/{uuidv5.html.md => uuidv5.mdx} (66%) rename website/docs/language/functions/{values.html.md => values.mdx} (53%) rename website/docs/language/functions/{yamldecode.html.md => yamldecode.mdx} (89%) rename website/docs/language/functions/{yamlencode.html.md => yamlencode.mdx} (80%) rename website/docs/language/functions/{zipmap.html.md => zipmap.mdx} (85%) rename website/docs/language/{index.html.md => index.mdx} (89%) rename website/docs/language/meta-arguments/{count.html.md => count.mdx} (89%) rename website/docs/language/meta-arguments/{depends_on.html.md => depends_on.mdx} (92%) rename website/docs/language/meta-arguments/{for_each.html.md => for_each.mdx} (83%) delete mode 100644 website/docs/language/meta-arguments/lifecycle.html.md create mode 100644 website/docs/language/meta-arguments/lifecycle.mdx rename website/docs/language/meta-arguments/{module-providers.html.md => module-providers.mdx} (88%) rename website/docs/language/meta-arguments/{resource-provider.html.md => resource-provider.mdx} (79%) rename website/docs/language/modules/develop/{composition.html.md => composition.mdx} (98%) rename website/docs/language/modules/develop/{index.html.md => index.mdx} (77%) rename website/docs/language/modules/develop/{providers.html.md => providers.mdx} (94%) rename website/docs/language/modules/develop/{publish.html.md => publish.mdx} (76%) rename website/docs/language/modules/develop/{refactoring.html.md => refactoring.mdx} (95%) rename website/docs/language/modules/develop/{structure.html.md => structure.mdx} (95%) rename website/docs/language/modules/{index.html.md => index.mdx} (71%) rename website/docs/language/modules/{sources.html.md => sources.mdx} (92%) rename website/docs/language/modules/{syntax.html.md => syntax.mdx} (83%) rename website/docs/language/modules/{testing-experiment.html.md => testing-experiment.mdx} (99%) rename website/docs/language/providers/{configuration.html.md => configuration.mdx} (86%) rename website/docs/language/providers/{index.html.md => index.mdx} (54%) rename website/docs/language/providers/{requirements.html.md => requirements.mdx} (91%) rename website/docs/language/resources/{behavior.html.md => behavior.mdx} (86%) rename website/docs/language/resources/{index.html.md => index.mdx} (55%) rename website/docs/language/resources/provisioners/{chef.html.md => chef.mdx} (93%) rename website/docs/language/resources/provisioners/{connection.html.md => connection.mdx} (80%) rename website/docs/language/resources/provisioners/{file.html.md => file.mdx} (89%) rename website/docs/language/resources/provisioners/{habitat.html.md => habitat.mdx} (94%) delete mode 100644 website/docs/language/resources/provisioners/index.html.md create mode 100644 website/docs/language/resources/provisioners/index.mdx rename website/docs/language/resources/provisioners/{local-exec.html.md => local-exec.mdx} (83%) rename website/docs/language/resources/provisioners/{null_resource.html.md => null_resource.mdx} (68%) rename website/docs/language/resources/provisioners/{puppet.html.md => puppet.mdx} (93%) rename website/docs/language/resources/provisioners/{remote-exec.html.md => remote-exec.mdx} (67%) delete mode 100644 website/docs/language/resources/provisioners/salt-masterless.html.md create mode 100644 website/docs/language/resources/provisioners/salt-masterless.mdx rename website/docs/language/resources/provisioners/{syntax.html.md => syntax.mdx} (93%) rename website/docs/language/resources/{syntax.html.md => syntax.mdx} (83%) rename website/docs/language/settings/backends/{artifactory.html.md => artifactory.mdx} (63%) rename website/docs/language/settings/backends/{azurerm.html.md => azurerm.mdx} (96%) rename website/docs/language/settings/backends/{configuration.html.md => configuration.mdx} (81%) delete mode 100644 website/docs/language/settings/backends/consul.html.md create mode 100644 website/docs/language/settings/backends/consul.mdx rename website/docs/language/settings/backends/{cos.html.md => cos.mdx} (51%) rename website/docs/language/settings/backends/{etcd.html.md => etcd.mdx} (55%) delete mode 100644 website/docs/language/settings/backends/etcdv3.html.md create mode 100644 website/docs/language/settings/backends/etcdv3.mdx rename website/docs/language/settings/backends/{gcs.html.md => gcs.mdx} (53%) delete mode 100644 website/docs/language/settings/backends/http.html.md create mode 100644 website/docs/language/settings/backends/http.mdx rename website/docs/language/settings/backends/{index.html.md => index.mdx} (70%) rename website/docs/language/settings/backends/{kubernetes.html.md => kubernetes.mdx} (86%) rename website/docs/language/settings/backends/{local.html.md => local.mdx} (71%) delete mode 100644 website/docs/language/settings/backends/manta.html.md create mode 100644 website/docs/language/settings/backends/manta.mdx rename website/docs/language/settings/backends/{oss.html.md => oss.mdx} (90%) delete mode 100644 website/docs/language/settings/backends/pg.html.md create mode 100644 website/docs/language/settings/backends/pg.mdx rename website/docs/language/settings/backends/{remote.html.md => remote.mdx} (75%) rename website/docs/language/settings/backends/{s3.html.md => s3.mdx} (96%) rename website/docs/language/settings/backends/{swift.html.md => swift.mdx} (91%) rename website/docs/language/settings/{index.html.md => index.mdx} (78%) delete mode 100644 website/docs/language/settings/terraform-cloud.html.md create mode 100644 website/docs/language/settings/terraform-cloud.mdx rename website/docs/language/state/{backends.html.md => backends.mdx} (69%) rename website/docs/language/state/{import.html.md => import.mdx} (59%) rename website/docs/language/state/{index.html.md => index.mdx} (77%) rename website/docs/language/state/{locking.html.md => locking.mdx} (77%) rename website/docs/language/state/{purpose.html.md => purpose.mdx} (93%) delete mode 100644 website/docs/language/state/remote-state-data.html.md create mode 100644 website/docs/language/state/remote-state-data.mdx rename website/docs/language/state/{remote.html.md => remote.mdx} (84%) rename website/docs/language/state/{sensitive-data.html.md => sensitive-data.mdx} (79%) rename website/docs/language/state/{workspaces.html.md => workspaces.mdx} (85%) rename website/docs/language/syntax/{configuration.html.md => configuration.mdx} (92%) rename website/docs/language/syntax/{index.html.md => index.mdx} (53%) rename website/docs/language/syntax/{json.html.md => json.mdx} (95%) rename website/docs/language/syntax/{style.html.md => style.mdx} (76%) rename website/{upgrade-guides/0-10.html.markdown => docs/language/upgrade-guides/0-10.mdx} (90%) rename website/{upgrade-guides/0-11.html.markdown => docs/language/upgrade-guides/0-11.mdx} (95%) rename website/{upgrade-guides/0-12.html.markdown => docs/language/upgrade-guides/0-12.mdx} (97%) rename website/{upgrade-guides/0-13.html.markdown => docs/language/upgrade-guides/0-13.mdx} (95%) rename website/{upgrade-guides/0-14.html.markdown => docs/language/upgrade-guides/0-14.mdx} (95%) rename website/{upgrade-guides/0-15.html.markdown => docs/language/upgrade-guides/0-15.mdx} (84%) rename website/{upgrade-guides/0-7.html.markdown => docs/language/upgrade-guides/0-7.mdx} (93%) rename website/{upgrade-guides/0-8.html.markdown => docs/language/upgrade-guides/0-8.mdx} (96%) rename website/{upgrade-guides/0-9.html.markdown => docs/language/upgrade-guides/0-9.mdx} (76%) rename website/{upgrade-guides/1-0.html.markdown => docs/language/upgrade-guides/1-0.mdx} (52%) rename website/{upgrade-guides/1-1.html.markdown => docs/language/upgrade-guides/1-1.mdx} (91%) rename website/{upgrade-guides/index.html.markdown => docs/language/upgrade-guides/index.mdx} (66%) rename website/docs/language/{v1-compatibility-promises.html.md => v1-compatibility-promises.mdx} (88%) delete mode 100644 website/docs/language/values/index.html.md create mode 100644 website/docs/language/values/index.mdx rename website/docs/language/values/{locals.html.md => locals.mdx} (74%) rename website/docs/language/values/{outputs.html.md => outputs.mdx} (87%) rename website/docs/language/values/{variables.html.md => variables.mdx} (87%) rename website/guides/{index.html.md => index.mdx} (86%) delete mode 100644 website/guides/terraform-integration-program.html.md rename website/guides/{terraform-provider-development-program.html.md => terraform-provider-development-program.mdx} (56%) rename website/{guides/core-workflow.html.md => intro/core-workflow.mdx} (93%) rename website/intro/{index.html.markdown => index.mdx} (76%) rename website/intro/{use-cases.html.markdown => use-cases.mdx} (96%) rename website/intro/vs/{boto.html.markdown => boto.mdx} (81%) rename website/intro/vs/{chef-puppet.html.markdown => chef-puppet.mdx} (80%) rename website/intro/vs/{cloudformation.html.markdown => cloudformation.mdx} (87%) rename website/intro/vs/{custom.html.markdown => custom.mdx} (88%) rename website/intro/vs/{index.html.markdown => index.mdx} (80%) diff --git a/website/README.md b/website/README.md index 53a5d9be5664..036fa3c354cc 100644 --- a/website/README.md +++ b/website/README.md @@ -8,39 +8,36 @@ The files in this directory are intended to be used in conjunction with different documentation sources together and contains the scripts for testing and building the site as a whole. +## Modifying Sidebar Navigation + +Updates to the sidebar navigation of Terraform docs need to be made in the [`terraform-website`](https://github.com/hashicorp/terraform-website/) repository (preferrably in a PR also updating the submodule commit). You can read more about how to make modifications to the navigation in the [README for `terraform-website`](https://github.com/hashicorp/terraform-website#editing-navigation-sidebars). + ## Previewing Changes -You should preview all of your changes locally before creating a pull request. The build includes content from this repository and the [`terraform-website`](https://github.com/hashicorp/terraform-website/) repository, allowing you to preview the entire Terraform documentation site. If `terraform-website` isn't in your `GOPATH`, the preview command will clone it to your machine. +You should preview all of your changes locally before creating a pull request. The build includes content from this repository and the [`terraform-website`](https://github.com/hashicorp/terraform-website/) repository, allowing you to preview the entire Terraform documentation site. **Set Up Local Environment** 1. [Install Docker](https://docs.docker.com/get-docker/). -2. Create a `~/go` directory manually or by [installing Go](https://golang.org/doc/install). -3. Open terminal and set `GOPATH` as an environment variable: - - Bash: `export $GOPATH=~/go`(bash) - - Zsh: `echo -n 'export GOPATH=~/go' >> ~/.zshrc` -4. Restart your terminal or command line session. +1. Restart your terminal or command line session. **Launch Site Locally** 1. Navigate into your local `terraform` top-level directory and run `make website`. -2. Open `http://localhost:4567` in your web browser. While the preview is running, you can edit pages and Middleman will automatically rebuild them. -3. When you're done with the preview, press `ctrl-C` in your terminal to stop the server. +1. Open `http://localhost:4567` in your web browser. While the preview is running, you can edit pages and Next.js will automatically rebuild them. +1. When you're done with the preview, press `ctrl-C` in your terminal to stop the server. ## Deploying Changes Merge the PR to main. The changes will appear in the next major Terraform release. If you need your changes to be deployed sooner, cherry-pick them to: -- the current release branch (e.g. `v1.0`) and push. They will be deployed in the next minor version release (once every two weeks). -- the `stable-website` branch and push. They will be included in the next site deploy (see below). Note that the release process resets `stable-website` to match the release tag, removing any additional commits. So, we recommend always cherry-picking to the version branch first and then to `stable-website` when needed. + +- the current release branch (e.g. `v1.1`) and push. They will be deployed in the next minor version release (once every two weeks). +- the `stable-website` branch and push. They will be included in the next site deploy (see below). Note that the release process resets `stable-website` to match the release tag, removing any additional commits. So, we recommend always cherry-picking to the version branch first and then to `stable-website` when needed. + +Once your PR to `stable-website` is merged, open a PR bumping the submodule commit in [`terraform-website`](https://github.com/hashicorp/terraform-website). ### Deployment -Currently, HashiCorp uses a CircleCI job to deploy the [terraform.io](terraform.io) site. This job can be run manually by many people within HashiCorp, and also runs automatically whenever a user in the HashiCorp GitHub org merges changes to master in the `terraform-website` repository. -New commits in this repository don't automatically deploy the [terraform.io][] site, but an unrelated site deploy will usually happen within a day. If you can't wait that long, you can do a manual CircleCI build or ask someone in the #proj-terraform-docs channel to do so: -- Log in to circleci.com, and make sure you're viewing the HashiCorp organization. -- Go to the terraform-website project's list of workflows. -- Find the most recent "website-deploy" workflow, and click the "Rerun workflow from start" button (which looks like a refresh button with a numeral "1" inside). +New commits in `hashicorp/terraform` and `hashicorp/terraform-cdk` don't automatically deploy the site. To use the latest upstream content, you'll need to open a PR bumping the submodule commit. If your changes aren't being deployed, it's very likely that you need to open a PR to update the submodule commit. diff --git a/website/docs/cli/auth/index.html.md b/website/docs/cli/auth/index.mdx similarity index 64% rename from website/docs/cli/auth/index.html.md rename to website/docs/cli/auth/index.mdx index cb61fbcdf47f..0b2247365fae 100644 --- a/website/docs/cli/auth/index.html.md +++ b/website/docs/cli/auth/index.mdx @@ -1,21 +1,22 @@ --- -layout: "docs" -page_title: "Authentication - Terraform CLI" -description: "Documentation about the login and logout commands that help automate getting an API token for your Terraform Cloud account." +page_title: Authentication - Terraform CLI +description: >- + Documentation about the login and logout commands that help automate getting + an API token for your Terraform Cloud account. --- # CLI Authentication > **Hands-on:** Try the [Authenticate the CLI with Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-login?in=terraform/cloud&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. -[Terraform Cloud](/docs/cloud/index.html) and -[Terraform Enterprise](/docs/enterprise/index.html) are platforms that perform +[Terraform Cloud](/cloud) and +[Terraform Enterprise](/enterprise) are platforms that perform Terraform runs to provision infrastructure, offering a collaboration-focused environment that makes it easier for teams to use Terraform together. (For expediency, the content below refers to both products as "Terraform Cloud.") Terraform CLI integrates with Terraform Cloud in several ways — it can be a -front-end for [CLI-driven runs](/docs/cloud/run/cli.html) in Terraform Cloud, +front-end for [CLI-driven runs](/cloud-docs/run/cli) in Terraform Cloud, and can also use Terraform Cloud as a state backend and a private module registry. All of these integrations require you to authenticate Terraform CLI with your Terraform Cloud account. @@ -26,5 +27,5 @@ Terraform Cloud user account. For details, see: -- [The `terraform login` command](/docs/cli/commands/login.html) -- [The `terraform logout` command](/docs/cli/commands/logout.html) +- [The `terraform login` command](/cli/commands/login) +- [The `terraform logout` command](/cli/commands/logout) diff --git a/website/docs/cli/cloud/command-line-arguments.html.md b/website/docs/cli/cloud/command-line-arguments.html.md deleted file mode 100644 index aceebbbd19a9..000000000000 --- a/website/docs/cli/cloud/command-line-arguments.html.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: "docs" -page_title: "Command Line Arguments" -description: "Command Line Arguments" ---- - -# Command Line Arguments - -When your configuration includes a `cloud` block, commands that -make local modifications to Terraform state and then push them back up to the remote workspace -accept the following option to modify that behavior: - -- `-ignore-remote-version` - Override checking that the local and remote - Terraform versions agree, making an operation proceed even when there is - a mismatch. - - State-modification operations usually require using a local version of the - Terraform CLI that is compatible with the Terraform version selected - in the remote workspace settings. This prevents the - local operation from creating a new state snapshot that the workspace's - remote execution environment cannot decode. - - We recommend against using this option unless absolutely necessary. Overriding this check can result - in a Terraform Cloud workspace that is no longer able to complete remote operations with the currently - selected version of Terraform. - diff --git a/website/docs/cli/cloud/command-line-arguments.mdx b/website/docs/cli/cloud/command-line-arguments.mdx new file mode 100644 index 000000000000..81897cfe669a --- /dev/null +++ b/website/docs/cli/cloud/command-line-arguments.mdx @@ -0,0 +1,24 @@ +--- +page_title: Command Line Arguments +description: Command Line Arguments +--- + +# Command Line Arguments + +When your configuration includes a `cloud` block, commands that +make local modifications to Terraform state and then push them back up to the remote workspace +accept the following option to modify that behavior: + +- `-ignore-remote-version` - Override checking that the local and remote + Terraform versions agree, making an operation proceed even when there is + a mismatch. + + State-modification operations usually require using a local version of the + Terraform CLI that is compatible with the Terraform version selected + in the remote workspace settings. This prevents the + local operation from creating a new state snapshot that the workspace's + remote execution environment cannot decode. + + We recommend against using this option unless absolutely necessary. Overriding this check can result + in a Terraform Cloud workspace that is no longer able to complete remote operations with the currently + selected version of Terraform. diff --git a/website/docs/cli/cloud/index.html.md b/website/docs/cli/cloud/index.html.md deleted file mode 100644 index 30b5744fe0b5..000000000000 --- a/website/docs/cli/cloud/index.html.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: "docs" -page_title: "Using Terraform Cloud - Terraform CLI" ---- - -# Using Terraform Cloud with Terraform CLI - -The Terraform CLI's integration with Terraform Cloud lets you to use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated. - -Using Terraform Cloud through the command line is called the [CLI-driven run workflow](/docs/cloud/run/cli.html). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in Terraform Cloud's run environment by default, with log output streaming to the local terminal. This lets you use Terraform Cloud features within the familiar Terraform CLI workflow, including variables encrypted at rest in a Terraform Cloud workspace, cost estimates, and policy checking. - -> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. - -Workspaces can also be configured for local execution, in which case only state is stored in -Terraform Cloud. In this mode, Terraform Cloud behaves just like a standard state backend. - --> **Note:** The CLI integration is available in Terraform 1.1.0 and later, and Terraform Enterprise 202201-1 and later. Previous versions can use the [`remote` backend](/docs/language/settings/backends/remote.html). Refer to [Migrating from the remote -backend](/docs/cli/cloud/migrating.html) for details about switching to the CLI integration. - - -## Documentation Summary - -- [Terraform Cloud Settings](/docs/cli/cloud/settings.html) documents the `cloud` block that you must add to your configuration to enable Terraform Cloud support. -- [Initializing and Migrating](/docs/cli/cloud/migrating.html) describes -how to start using Terraform Cloud with a working directory that already has state data. -- [Command Line Arguments](/docs/cli/cloud/command-line-arguments.html) lists the Terraform command flags that are specific to using Terraform with Terraform Cloud. - -Refer to the [CLI-driven Run Workflow](/docs/cloud/run/cli.html) for more details about how to use Terraform Cloud from the command line. diff --git a/website/docs/cli/cloud/index.mdx b/website/docs/cli/cloud/index.mdx new file mode 100644 index 000000000000..d9b74185196f --- /dev/null +++ b/website/docs/cli/cloud/index.mdx @@ -0,0 +1,26 @@ +--- +page_title: Using Terraform Cloud - Terraform CLI +--- + +# Using Terraform Cloud with Terraform CLI + +The Terraform CLI's integration with Terraform Cloud lets you to use Terraform Cloud and Terraform Enterprise on the command line. In the documentation Terraform Cloud instructions also apply to Terraform Enterprise, except where explicitly stated. + +Using Terraform Cloud through the command line is called the [CLI-driven run workflow](/cloud-docs/run/cli). When you use the CLI workflow, operations like `terraform plan` or `terraform apply` are remotely executed in Terraform Cloud's run environment by default, with log output streaming to the local terminal. This lets you use Terraform Cloud features within the familiar Terraform CLI workflow, including variables encrypted at rest in a Terraform Cloud workspace, cost estimates, and policy checking. + +> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. + +Workspaces can also be configured for local execution, in which case only state is stored in +Terraform Cloud. In this mode, Terraform Cloud behaves just like a standard state backend. + +-> **Note:** The CLI integration is available in Terraform 1.1.0 and later, and Terraform Enterprise 202201-1 and later. Previous versions can use the [`remote` backend](/language/settings/backends/remote). Refer to [Migrating from the remote +backend](/cli/cloud/migrating) for details about switching to the CLI integration. + +## Documentation Summary + +- [Terraform Cloud Settings](/cli/cloud/settings) documents the `cloud` block that you must add to your configuration to enable Terraform Cloud support. +- [Initializing and Migrating](/cli/cloud/migrating) describes + how to start using Terraform Cloud with a working directory that already has state data. +- [Command Line Arguments](/cli/cloud/command-line-arguments) lists the Terraform command flags that are specific to using Terraform with Terraform Cloud. + +Refer to the [CLI-driven Run Workflow](/cloud-docs/run/cli) for more details about how to use Terraform Cloud from the command line. diff --git a/website/docs/cli/cloud/migrating.html.md b/website/docs/cli/cloud/migrating.mdx similarity index 76% rename from website/docs/cli/cloud/migrating.html.md rename to website/docs/cli/cloud/migrating.mdx index 5547b43b98c6..7aa5572c3724 100644 --- a/website/docs/cli/cloud/migrating.html.md +++ b/website/docs/cli/cloud/migrating.mdx @@ -1,24 +1,23 @@ --- -layout: "docs" -page_title: "Initializing and Migrating to Terraform Cloud - Terraform CLI" +page_title: Initializing and Migrating to Terraform Cloud - Terraform CLI --- # Initializing and Migrating -After [configuring Terraform Cloud settings](/docs/cli/cloud/settings.html) for a working directory, you must run `terraform init` to finish setting up. If the working directory has no existing Terraform state, you can start using Terraform with Terraform Cloud right away. Refer to [CLI-driven run workflow](/docs/cloud/run/cli.html) for more details. +After [configuring Terraform Cloud settings](/cli/cloud/settings) for a working directory, you must run `terraform init` to finish setting up. If the working directory has no existing Terraform state, you can start using Terraform with Terraform Cloud right away. Refer to [CLI-driven run workflow](/cloud-docs/run/cli) for more details. When you run `terraform init` in the following scenarios, Terraform will ask you to choose whether or not to migrate state from any existing workspaces. 1. [**Migrating from local state or state backends:**](#migrating-from-local-state-or-state-backends) If the working directory already has state data in one or more workspaces, Terraform will ask if you would like to migrate that state to new Terraform Cloud workspaces. -2. [**Migrating from the `remote` backend:**](#migrating-from-the-remote-backend) If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. You will need to switch the `remote` backend block to the `cloud` block. +1. [**Migrating from the `remote` backend:**](#migrating-from-the-remote-backend) If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. You will need to switch the `remote` backend block to the `cloud` block. ## Migrating from Local State or State Backends > **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. If the working directory already has state data available (using either local state or a [state -backend](/docs/language/settings/backends/index.html)), Terraform will ask your approval to migrate +backend](/language/settings/backends)), Terraform will ask your approval to migrate that state to Terraform Cloud. You will need permission to manage workspaces in the destination Terraform Cloud organization. This process is interactive and self-documenting, and resembles moving between state backends. @@ -32,13 +31,13 @@ Because of this, Terraform will prompt you to rename the working directory's wor according to a pattern relative to their existing names. This can indicate the fact that these specific workspaces share configuration. A typical strategy is `--` (e.g., `networking-prod-us-east`, `networking-staging-us-east`). Refer to [Workspace -Naming](/docs/cloud/workspaces/naming.html) in the Terraform Cloud documentation for more detail. +Naming](/cloud-docs/workspaces/naming) in the Terraform Cloud documentation for more detail. ## Migrating from the `remote` Backend If the working directory was already connected to Terraform Cloud with the `remote` backend, Terraform can continue using the same Terraform Cloud workspaces. The local names shown for those workspaces will change to match their remote names. -The [`remote` backend](/docs/language/settings/backends/remote.html) was the primary implementation of Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html) for Terraform versions 0.11.13 through 1.0.x. We recommend using the native `cloud` integration for Terraform versions 1.1 or later, as it provides an improved user experience and various enhancements. +The [`remote` backend](/language/settings/backends/remote) was the primary implementation of Terraform Cloud's [CLI-driven run workflow](/cloud-docs/run/cli) for Terraform versions 0.11.13 through 1.0.x. We recommend using the native `cloud` integration for Terraform versions 1.1 or later, as it provides an improved user experience and various enhancements. ### Block Replacement @@ -49,7 +48,7 @@ block. #### Single Workspace If you were using a single workspace with the `name` argument, change the block - label to `cloud`. +label to `cloud`. ```diff terraform { diff --git a/website/docs/cli/cloud/settings.html.md b/website/docs/cli/cloud/settings.mdx similarity index 70% rename from website/docs/cli/cloud/settings.html.md rename to website/docs/cli/cloud/settings.mdx index 5ffc2dd8b2d1..74835e2b249b 100644 --- a/website/docs/cli/cloud/settings.html.md +++ b/website/docs/cli/cloud/settings.mdx @@ -1,19 +1,18 @@ --- -layout: "docs" -page_title: "Terraform Cloud Settings - Terraform CLI" +page_title: Terraform Cloud Settings - Terraform CLI --- # Terraform Cloud Settings Terraform CLI can integrate with Terraform Cloud, acting as a client for Terraform Cloud's -[CLI-driven run workflow](https://www.terraform.io/docs/cloud/run/cli.html). +[CLI-driven run workflow](/cloud-docs/run/cli). > **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. You must configure the following settings to use Terraform Cloud for a particular working directory: - Provide credentials to access Terraform Cloud, preferably by using the - [`terraform login`](/docs/cli/commands/login.html) command. + [`terraform login`](/cli/commands/login) command. - Add a `cloud` block to the directory's Terraform configuration, to specify which organization and workspace(s) to use. - Optionally, use a `.terraformignore` file to specify files that shouldn't be @@ -43,7 +42,7 @@ terraform { The `cloud` block also has some special restrictions: - A configuration can only provide one `cloud` block. -- A `cloud` block cannot be used with [state backends](/docs/language/settings/backends/index.html). +- A `cloud` block cannot be used with [state backends](/language/settings/backends). A configuration can use one or the other, but not both. - A `cloud` block cannot refer to named values (like input variables, locals, or data source attributes). @@ -60,32 +59,32 @@ The `cloud` block supports the following configuration arguments: workspace(s) the current configuration should use. - `workspaces` - (Required) A nested block that specifies which remote Terraform Cloud workspaces to -use for the current configuration. The `workspaces` block must contain **exactly one** of the -following arguments, each denoting a strategy for how workspaces should be mapped: + use for the current configuration. The `workspaces` block must contain **exactly one** of the + following arguments, each denoting a strategy for how workspaces should be mapped: - - `tags` - (Optional) A set of Terraform Cloud workspace tags. You will be able to use - this working directory with any workspaces that have all of the specified tags, - and can use [the `terraform workspace` commands](/docs/cli/workspaces/index.html) - to switch between them or create new workspaces. New workspaces will automatically have - the specified tags. This option conflicts with `name`. + - `tags` - (Optional) A set of Terraform Cloud workspace tags. You will be able to use + this working directory with any workspaces that have all of the specified tags, + and can use [the `terraform workspace` commands](/cli/workspaces) + to switch between them or create new workspaces. New workspaces will automatically have + the specified tags. This option conflicts with `name`. - - `name` - (Optional) The name of a single Terraform Cloud workspace. You will - only be able to use the workspace specified in the configuration with this working - directory, and cannot manage workspaces from the CLI (e.g. `terraform workspace select` or - `terraform workspace new`). This option conflicts with `tags`. + - `name` - (Optional) The name of a single Terraform Cloud workspace. You will + only be able to use the workspace specified in the configuration with this working + directory, and cannot manage workspaces from the CLI (e.g. `terraform workspace select` or + `terraform workspace new`). This option conflicts with `tags`. - `hostname` - (Optional) The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. Defaults to Terraform Cloud (app.terraform.io). - `token` - (Optional) The token used to authenticate with Terraform Cloud. We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/cli/commands/login.html) or manually configuring + [`terraform login`](/cli/commands/login) or manually configuring `credentials` in the - [CLI config file](/docs/cli/config/config-file.html#credentials). + [CLI config file](/cli/config/config-file#credentials). ## Excluding Files from Upload with .terraformignore -When executing a remote `plan` or `apply` in a [CLI-driven run](/docs/cloud/run/cli.html), +When executing a remote `plan` or `apply` in a [CLI-driven run](/cloud-docs/run/cli), a copy of your configuration directory is uploaded to Terraform Cloud. You can define paths to exclude from upload by adding a `.terraformignore` file at the root of your configuration directory. If this file is not present, the upload will exclude diff --git a/website/docs/cli/code/index.html.md b/website/docs/cli/code/index.mdx similarity index 65% rename from website/docs/cli/code/index.html.md rename to website/docs/cli/code/index.mdx index bf858dd6ba42..ec06e20abe2e 100644 --- a/website/docs/cli/code/index.html.md +++ b/website/docs/cli/code/index.mdx @@ -1,12 +1,13 @@ --- -layout: "docs" -page_title: "Writing and Modifying Code - Terraform CLI" -description: "Learn commands that help validate, format, and upgrade code written in the Terraform Configuration Language." +page_title: Writing and Modifying Code - Terraform CLI +description: >- + Learn commands that help validate, format, and upgrade code written in the + Terraform Configuration Language. --- # Writing and Modifying Terraform Code -The [Terraform language](/docs/language/index.html) is Terraform's primary +The [Terraform language](/language) is Terraform's primary user interface, and all of Terraform's workflows rely on configurations written in the Terraform language. @@ -14,18 +15,17 @@ Terraform CLI includes several commands to make Terraform code more convenient to work with. Integrating these commands into your editing workflow can potentially save you time and effort. -- [The `terraform console` command](/docs/cli/commands/console.html) starts an +- [The `terraform console` command](/cli/commands/console) starts an interactive shell for evaluating Terraform - [expressions](/docs/language/expressions/index.html), which can be a faster way + [expressions](/language/expressions), which can be a faster way to verify that a particular resource argument results in the value you expect. - -- [The `terraform fmt` command](/docs/cli/commands/fmt.html) rewrites Terraform +- [The `terraform fmt` command](/cli/commands/fmt) rewrites Terraform configuration files to a canonical format and style, so you don't have to waste time making minor adjustments for readability and consistency. It works well as a pre-commit hook in your version control system. -- [The `terraform validate` command](/docs/cli/commands/validate.html) validates the +- [The `terraform validate` command](/cli/commands/validate) validates the syntax and arguments of the Terraform configuration files in a directory, including argument and attribute names and types for resources and modules. The `plan` and `apply` commands automatically validate a configuration before @@ -33,12 +33,12 @@ potentially save you time and effort. workflow, but it can be very useful as a pre-commit hook or as part of a continuous integration pipeline. -- [The `0.13upgrade` command](/docs/cli/commands/0.13upgrade.html) and - [the `0.12upgrade` command](/docs/cli/commands/0.12upgrade.html) can automatically +- [The `0.13upgrade` command](/cli/commands/0.13upgrade) and + [the `0.12upgrade` command](/cli/commands/0.12upgrade) can automatically modify the configuration files in a Terraform module to help deal with major syntax changes that occurred in the 0.13 and 0.12 releases of Terraform. Both of these commands are only available in the Terraform version they are associated with, and you are expected to upgrade older code to be compatible with 0.12 before attempting to make it compatible with 0.13. For more detailed information about updating code for new Terraform versions, see the [upgrade - guides](/upgrade-guides/index.html) in the Terraform language docs. + guides](/language/upgrade-guides) in the Terraform language docs. diff --git a/website/docs/cli/commands/0.12upgrade.html.md b/website/docs/cli/commands/0.12upgrade.mdx similarity index 90% rename from website/docs/cli/commands/0.12upgrade.html.md rename to website/docs/cli/commands/0.12upgrade.mdx index 59ff0de44f1b..73068ad71bc0 100644 --- a/website/docs/cli/commands/0.12upgrade.html.md +++ b/website/docs/cli/commands/0.12upgrade.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: 0.12upgrade" -sidebar_current: "docs-commands-012upgrade" -description: |- - The 0.12upgrade subcommand automatically rewrites existing configurations for Terraform 0.12 compatibility. +page_title: 'Command: 0.12upgrade' +description: >- + The 0.12upgrade subcommand automatically rewrites existing configurations for + Terraform 0.12 compatibility. --- # Command: 0.12upgrade @@ -12,7 +11,7 @@ The `terraform 0.12upgrade` command applies several automatic upgrade rules to help prepare a module that was written for Terraform v0.11 to be used with Terraform v0.12. --> **This command is available only in Terraform v0.12 releases.** For more information, see [the Terraform v0.12 upgrade guide](https://www.terraform.io/upgrade-guides/0-12.html). +-> **This command is available only in Terraform v0.12 releases.** For more information, see [the Terraform v0.12 upgrade guide](/language/upgrade-guides/0-12). ## Usage @@ -71,13 +70,13 @@ the change. Once upgraded the configuration will no longer be compatible with Terraform v0.11 and earlier. When upgrading a shared module that is called from multiple configurations, you may need to -[fix existing configurations to a previous version](/docs/language/modules/syntax.html#version) +[fix existing configurations to a previous version](/language/modules/syntax#version) to allow for a gradual upgrade. If the module is published via -[a Terraform registry](/docs/registry/), assign a new _major_ version number +[a Terraform registry](/registry), assign a new _major_ version number to the upgraded module source to represent the fact that this is a breaking change for v0.11 callers. If a module is installed directly from a version control system such as Git, -[use specific revisions](https://www.terraform.io/docs/language/modules/sources.html#selecting-a-revision) +[use specific revisions](/language/modules/sources#selecting-a-revision) to control which version is used by which caller. The command-line options are all optional. The available options are: @@ -107,8 +106,8 @@ On Mac OS X, the `find` included with the system does not support the `-printf` ``` brew install findutils ``` -Once installed, run the above command line using `gfind` instead of `find`. +Once installed, run the above command line using `gfind` instead of `find`. Note that the above includes the `-yes` option to override the interactive prompt, so be sure you have a clean work tree before running it. diff --git a/website/docs/cli/commands/0.13upgrade.html.md b/website/docs/cli/commands/0.13upgrade.mdx similarity index 92% rename from website/docs/cli/commands/0.13upgrade.html.md rename to website/docs/cli/commands/0.13upgrade.mdx index 52ff420671bc..7322129aa943 100644 --- a/website/docs/cli/commands/0.13upgrade.html.md +++ b/website/docs/cli/commands/0.13upgrade.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: 0.13upgrade" -sidebar_current: "docs-commands-013upgrade" -description: |- - The 0.13upgrade subcommand updates existing configurations to use the new provider source features from Terraform 0.13. +page_title: 'Command: 0.13upgrade' +description: >- + The 0.13upgrade subcommand updates existing configurations to use the new + provider source features from Terraform 0.13. --- # Command: 0.13upgrade @@ -12,7 +11,7 @@ The `terraform 0.13upgrade` command updates existing configuration to add an explicit `source` attribute for each provider used in a given module. The provider source settings are stored in a `required_providers` block. --> **This command is available only in Terraform v0.13 releases.** For more information, see [the Terraform v0.13 upgrade guide](https://www.terraform.io/upgrade-guides/0-13.html). +-> **This command is available only in Terraform v0.13 releases.** For more information, see [the Terraform v0.13 upgrade guide](/language/upgrade-guides/0-13). ## Usage @@ -23,7 +22,7 @@ providers are in use for a module, detect the source address for those providers where possible, and record this information in a [`required_providers` block][required-providers]. -[required-providers]: /docs/language/providers/requirements.html +[required-providers]: /language/providers/requirements ~> Note: the command ignores `.tf.json` files and override files in the module. diff --git a/website/docs/cli/commands/apply.html.md b/website/docs/cli/commands/apply.mdx similarity index 82% rename from website/docs/cli/commands/apply.html.md rename to website/docs/cli/commands/apply.mdx index 09172c542a0f..ece491cdc2f0 100644 --- a/website/docs/cli/commands/apply.html.md +++ b/website/docs/cli/commands/apply.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: apply" -sidebar_current: "docs-commands-apply" -description: "The terraform apply command executes the actions proposed in a Terraform plan to create, update, or destroy infrastructure." +page_title: 'Command: apply' +description: >- + The terraform apply command executes the actions proposed in a Terraform plan + to create, update, or destroy infrastructure. --- # Command: apply @@ -33,15 +33,15 @@ you pass it the filename of a previously-saved plan file. ### Automatic Plan Mode In the default case, with no saved plan file, `terraform apply` creates its own -plan of action, in the same way that [`terraform plan`](./plan.html) would. +plan of action, in the same way that [`terraform plan`](/cli/commands/plan) would. Terraform will propose the plan to you and prompt you to approve it before taking the described actions, unless you waive that prompt by using the `-auto-approve` option. When performing its own plan, `terraform apply` supports all of the same -[planning modes](./plan.html#planning-modes) and -[planning options](./plan.html#planning-options) that `terraform plan` would +[planning modes](/cli/commands/plan#planning-modes) and +[planning options](/cli/commands/plan#planning-options) that `terraform plan` would accept, so you can customize how Terraform will create the plan. ### Saved Plan Mode @@ -49,7 +49,7 @@ accept, so you can customize how Terraform will create the plan. If you pass the filename of a previously-saved plan file, `terraform apply` performs exactly the steps specified by that plan file. It does not prompt for approval; if you want to inspect a plan file before applying it, you can use -[`terraform show`](./show.html). +[`terraform show`](/cli/commands/show). When using a saved plan, none of the planning modes or planning options linked above are supported; these options only affect Terraform's decisions about which @@ -61,8 +61,8 @@ decisions. When run without a saved plan file, `terraform apply` supports all of `terraform plan`'s planning modes and planning options. For details, see: -- [Planning Modes](./plan.html#planning-modes) -- [Planning Options](./plan.html#planning-options) +* [Planning Modes](/cli/commands/plan#planning-modes) +* [Planning Options](/cli/commands/plan#planning-options) ### Apply Options @@ -70,7 +70,7 @@ The following options allow you to change various details about how the apply command executes and reports on the apply operation. If you are running `terraform apply` _without_ a previously-saved plan file, these options are _in addition to_ the planning modes and planning options described for -[`terraform plan`](./plan.html). +[`terraform plan`](/cli/commands/plan). * `-auto-approve` - Skips interactive approval of plan before applying. This option is ignored when you pass a previously-saved plan file, because @@ -95,11 +95,11 @@ _in addition to_ the planning modes and planning options described for variable values to continue. To enable this flag, you must also either enable the `-auto-approve` flag or specify a previously-saved plan. - [machine-readable-ui]: /docs/internals/machine-readable-ui.html + [machine-readable-ui]: /internals/machine-readable-ui * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -111,13 +111,13 @@ _in addition to_ the planning modes and planning options described for rendered by a system that cannot interpret terminal formatting. * `-parallelism=n` - Limit the number of concurrent operation as Terraform - [walks the graph](/docs/internals/graph.html#walking-the-graph). Defaults to - 10. + [walks the graph](/internals/graph#walking-the-graph). Defaults to + 10\. For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform apply` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Passing a Different Configuration Directory @@ -127,7 +127,7 @@ that directory as the root module instead of the current working directory. That usage was deprecated in Terraform v0.14 and removed in Terraform v0.15. If your workflow relies on overriding the root module directory, use -[the `-chdir` global option](./#switching-working-directory-with-chdir) +[the `-chdir` global option](/cli/commands/#switching-working-directory-with-chdir) instead, which works across all commands and makes Terraform consistently look in the given directory for all files it would normally read or write in the current working directory. @@ -135,6 +135,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/cli/config/environment-variables#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/console.html.md b/website/docs/cli/commands/console.mdx similarity index 77% rename from website/docs/cli/commands/console.html.md rename to website/docs/cli/commands/console.mdx index 23682b56209d..2f7edcfa5379 100644 --- a/website/docs/cli/commands/console.html.md +++ b/website/docs/cli/commands/console.mdx @@ -1,37 +1,36 @@ --- -layout: "docs" -page_title: "Command: console" -sidebar_current: "docs-commands-console" -description: "The terraform console command provides an interactive console for - evaluating expressions." +page_title: 'Command: console' +description: >- + The terraform console command provides an interactive console for evaluating + expressions. --- # Command: console The `terraform console` command provides an interactive console for -evaluating [expressions](/docs/language/expressions/index.html). +evaluating [expressions](/language/expressions). ## Usage Usage: `terraform console [options]` This command provides an interactive command-line console for evaluating and -experimenting with [expressions](/docs/language/expressions/index.html). +experimenting with [expressions](/language/expressions). This is useful for testing interpolations before using them in configurations, and for interacting with any values currently saved in -[state](/docs/language/state/index.html). +[state](/language/state). If the current state is empty or has not yet been created, the console can be used to experiment with the expression syntax and -[built-in functions](/docs/language/functions/index.html). +[built-in functions](/language/functions). You can close the console with the `exit` command or by pressing Control-C or Control-D. For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform console` accepts the legacy command line option -[`-state`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`](/language/settings/backends/local#command-line-arguments). ## Scripting @@ -52,7 +51,7 @@ tolist([ ## Remote State -If [remote state](/docs/language/state/remote.html) is used by the current backend, +If [remote state](/language/state/remote) is used by the current backend, Terraform will read the state for the current workspace from the backend before evaluating any expressions. diff --git a/website/docs/cli/commands/destroy.html.md b/website/docs/cli/commands/destroy.mdx similarity index 78% rename from website/docs/cli/commands/destroy.html.md rename to website/docs/cli/commands/destroy.mdx index 4e45bbe3d095..beb9782ebfd5 100644 --- a/website/docs/cli/commands/destroy.html.md +++ b/website/docs/cli/commands/destroy.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: destroy" -sidebar_current: "docs-commands-destroy" -description: "The terraform destroy command destroys all objects managed by a Terraform configuration." +page_title: 'Command: destroy' +description: >- + The terraform destroy command destroys all objects managed by a Terraform + configuration. --- # Command: destroy @@ -27,7 +27,7 @@ terraform apply -destroy ``` For that reason, this command accepts most of the options that -[`terraform apply`](./apply.html) accepts, although it does +[`terraform apply`](/cli/commands/apply) accepts, although it does not accept a plan file argument and forces the selection of the "destroy" planning mode. @@ -38,7 +38,7 @@ destroying would be, by running the following command: terraform plan -destroy ``` -This will run [`terraform plan`](./plan.html) in _destroy_ mode, showing +This will run [`terraform plan`](/cli/commands/plan) in _destroy_ mode, showing you the proposed destroy changes without executing them. -> **Note:** The `-destroy` option to `terraform apply` exists only in diff --git a/website/docs/cli/commands/env.html.md b/website/docs/cli/commands/env.html.md deleted file mode 100644 index bbaacc530d0e..000000000000 --- a/website/docs/cli/commands/env.html.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: "docs" -page_title: "Command: env" -sidebar_current: "docs-commands-envcmd" -description: "The terraform env command is a deprecated form of the terraform workspace command." ---- - -# Command: env - -The `terraform env` command is deprecated. -[The `terraform workspace` command](/docs/cli/commands/workspace/index.html) -should be used instead. diff --git a/website/docs/cli/commands/env.mdx b/website/docs/cli/commands/env.mdx new file mode 100644 index 000000000000..611354068a18 --- /dev/null +++ b/website/docs/cli/commands/env.mdx @@ -0,0 +1,12 @@ +--- +page_title: 'Command: env' +description: >- + The terraform env command is a deprecated form of the terraform workspace + command. +--- + +# Command: env + +The `terraform env` command is deprecated. +[The `terraform workspace` command](/cli/commands/workspace) +should be used instead. diff --git a/website/docs/cli/commands/fmt.html.md b/website/docs/cli/commands/fmt.mdx similarity index 89% rename from website/docs/cli/commands/fmt.html.md rename to website/docs/cli/commands/fmt.mdx index b25a476b4efe..c6868d733f9f 100644 --- a/website/docs/cli/commands/fmt.html.md +++ b/website/docs/cli/commands/fmt.mdx @@ -1,15 +1,15 @@ --- -layout: "docs" -page_title: "Command: fmt" -sidebar_current: "docs-commands-fmt" -description: "The terraform fmt command rewrites configuration files to a canonical format and style." +page_title: 'Command: fmt' +description: >- + The terraform fmt command rewrites configuration files to a canonical format + and style. --- # Command: fmt The `terraform fmt` command is used to rewrite Terraform configuration files to a canonical format and style. This command applies a subset of -the [Terraform language style conventions](/docs/language/syntax/style.html), +the [Terraform language style conventions](/language/syntax/style), along with other minor adjustments for readability. Other Terraform commands that generate Terraform configuration will produce @@ -58,5 +58,5 @@ The command-line flags are all optional. The list of available flags are: * `-write=false` - Don't overwrite the input files. (This is implied by `-check` or when the input is STDIN.) * `-diff` - Display diffs of formatting changes * `-check` - Check if the input is formatted. Exit status will be 0 if - all input is properly formatted and non-zero otherwise. + all input is properly formatted and non-zero otherwise. * `-recursive` - Also process files in subdirectories. By default, only the given directory (or current directory) is processed. diff --git a/website/docs/cli/commands/force-unlock.html.md b/website/docs/cli/commands/force-unlock.mdx similarity index 71% rename from website/docs/cli/commands/force-unlock.html.md rename to website/docs/cli/commands/force-unlock.mdx index 0ad7a6285703..735eec48968d 100644 --- a/website/docs/cli/commands/force-unlock.html.md +++ b/website/docs/cli/commands/force-unlock.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: force-unlock" -sidebar_current: "docs-commands-force-unlock" -description: "The terraform force-unlock command unlocks the state for a configuration. It does not modify your infrastructure." +page_title: 'Command: force-unlock' +description: >- + The terraform force-unlock command unlocks the state for a configuration. It + does not modify your infrastructure. --- # Command: force-unlock @@ -27,4 +27,4 @@ process. Options: -* `-force` - Don't ask for input for unlock confirmation. +* `-force` - Don't ask for input for unlock confirmation. diff --git a/website/docs/cli/commands/get.html.md b/website/docs/cli/commands/get.mdx similarity index 60% rename from website/docs/cli/commands/get.html.md rename to website/docs/cli/commands/get.mdx index 47f4e6cfa4f3..bf9b9f970559 100644 --- a/website/docs/cli/commands/get.html.md +++ b/website/docs/cli/commands/get.mdx @@ -1,14 +1,12 @@ --- -layout: "docs" -page_title: "Command: get" -sidebar_current: "docs-commands-get" -description: "The terraform get command downloads and updates modules." +page_title: 'Command: get' +description: The terraform get command downloads and updates modules. --- # Command: get The `terraform get` command is used to download and update -[modules](/docs/language/modules/develop/index.html) mentioned in the root module. +[modules](/language/modules/develop) mentioned in the root module. ## Usage @@ -21,6 +19,6 @@ repository. The `get` command supports the following option: * `-update` - If specified, modules that are already downloaded will be - checked for updates and the updates will be downloaded if present. + checked for updates and the updates will be downloaded if present. * `-no-color` - Disable text coloring in the output. diff --git a/website/docs/cli/commands/graph.html.md b/website/docs/cli/commands/graph.mdx similarity index 74% rename from website/docs/cli/commands/graph.html.md rename to website/docs/cli/commands/graph.mdx index cfc915667c66..969c6e5dbe1a 100644 --- a/website/docs/cli/commands/graph.html.md +++ b/website/docs/cli/commands/graph.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: graph" -sidebar_current: "docs-commands-graph" -description: "The terraform graph command generates a visual representation of a configuration or execution plan that you can use to generate charts." +page_title: 'Command: graph' +description: >- + The terraform graph command generates a visual representation of a + configuration or execution plan that you can use to generate charts. --- # Command: graph @@ -12,7 +12,6 @@ representation of either a configuration or execution plan. The output is in the DOT format, which can be used by [GraphViz](http://www.graphviz.org) to generate charts. - ## Usage Usage: `terraform graph [options]` @@ -33,16 +32,16 @@ argument. Options: * `-plan=tfplan` - Render graph using the specified plan file instead of the - configuration in the current directory. + configuration in the current directory. * `-draw-cycles` - Highlight any cycles in the graph with colored edges. - This helps when diagnosing cycle errors. + This helps when diagnosing cycle errors. * `-type=plan` - Type of graph to output. Can be: `plan`, `plan-destroy`, `apply`, - `validate`, `input`, `refresh`. + `validate`, `input`, `refresh`. * `-module-depth=n` - (deprecated) In prior versions of Terraform, specified the - depth of modules to show in the output. + depth of modules to show in the output. ## Generating Images @@ -55,4 +54,4 @@ $ terraform graph | dot -Tsvg > graph.svg ``` Here is an example graph output: -![Graph Example](docs/graph-example.png) +![Graph Example](/img/docs/graph-example.png) diff --git a/website/docs/cli/commands/import.html.md b/website/docs/cli/commands/import.mdx similarity index 79% rename from website/docs/cli/commands/import.html.md rename to website/docs/cli/commands/import.mdx index 7c26b1758ec1..42e1eaa609d8 100644 --- a/website/docs/cli/commands/import.html.md +++ b/website/docs/cli/commands/import.mdx @@ -1,8 +1,6 @@ --- -layout: "docs" -page_title: "Command: import" -sidebar_current: "docs-commands-import" -description: "The terraform import command brings existing resources into Terraform state." +page_title: 'Command: import' +description: The terraform import command brings existing resources into Terraform state. --- # Command: import @@ -10,7 +8,7 @@ description: "The terraform import command brings existing resources into Terraf > **Hands-on:** Try the [Import Terraform Configuration](https://learn.hashicorp.com/tutorials/terraform/state-import?in=terraform/state&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. The `terraform import` command is used to -[import existing resources](/docs/cli/import/index.html) +[import existing resources](/cli/import) into Terraform. ## Usage @@ -20,7 +18,7 @@ Usage: `terraform import [options] ADDRESS ID` Import will find the existing resource from ID and import it into your Terraform state at the given ADDRESS. -ADDRESS must be a valid [resource address](/docs/cli/state/resource-addressing.html). +ADDRESS must be a valid [resource address](/cli/state/resource-addressing). Because any resource address is valid, the import command can import resources into modules as well as directly into the root of your state. @@ -36,7 +34,7 @@ itself having created all objects. If you import existing objects into Terraform be careful to import each remote object to only one Terraform resource address. If you import the same object multiple times, Terraform may exhibit unwanted behavior. For more information on this assumption, see -[the State section](/docs/language/state/index.html). +[the State section](/language/state). The command-line flags are all optional. The list of available flags are: @@ -48,29 +46,29 @@ The command-line flags are all optional. The list of available flags are: * `-input=true` - Whether to ask for input for provider configuration. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=0s` - Duration to retry a state lock. * `-no-color` - If specified, output won't contain any color. * `-parallelism=n` - Limit the number of concurrent operation as Terraform - [walks the graph](/docs/internals/graph.html#walking-the-graph). Defaults + [walks the graph](/internals/graph#walking-the-graph). Defaults to 10. * `-provider=provider` - **Deprecated** Override the provider configuration to -use when importing the object. By default, Terraform uses the provider specified -in the configuration for the target resource, and that is the best behavior in most cases. + use when importing the object. By default, Terraform uses the provider specified + in the configuration for the target resource, and that is the best behavior in most cases. * `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag can be set multiple times. Variable values are interpreted as - [literal expressions](/docs/language/expressions/types.html) in the + [literal expressions](/language/expressions/types) in the Terraform language, so list and map values can be specified via this flag. This is only useful with the `-config` flag. * `-var-file=foo` - Set variables in the Terraform configuration from - a [variable file](/docs/language/values/variables.html#variable-definitions-tfvars-files). If + a [variable file](/language/values/variables#variable-definitions-tfvars-files). If a `terraform.tfvars` or any `.auto.tfvars` files are present in the current directory, they will be automatically loaded. `terraform.tfvars` is loaded first and the `.auto.tfvars` files after in alphabetical order. Any files @@ -79,15 +77,15 @@ in the configuration for the target resource, and that is the best behavior in m useful with the `-config` flag. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform import` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform import` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Provider Configuration @@ -135,7 +133,7 @@ $ terraform import module.foo.aws_instance.bar i-abcd1234 ## Example: Import into Resource configured with count The example below will import an AWS instance into the first instance of the `aws_instance` resource named `baz` configured with -[`count`](/docs/language/meta-arguments/count.html): +[`count`](/language/meta-arguments/count): ```shell $ terraform import 'aws_instance.baz[0]' i-abcd1234 @@ -144,7 +142,7 @@ $ terraform import 'aws_instance.baz[0]' i-abcd1234 ## Example: Import into Resource configured with for_each The example below will import an AWS instance into the `"example"` instance of the `aws_instance` resource named `baz` configured with -[`for_each`](/docs/language/meta-arguments/for_each.html): +[`for_each`](/language/meta-arguments/for_each): Linux, Mac OS, and UNIX: diff --git a/website/docs/cli/commands/index.html.md b/website/docs/cli/commands/index.mdx similarity index 93% rename from website/docs/cli/commands/index.html.md rename to website/docs/cli/commands/index.mdx index 6fb5919a77ba..f7dd9c74fc61 100644 --- a/website/docs/cli/commands/index.html.md +++ b/website/docs/cli/commands/index.mdx @@ -1,8 +1,6 @@ --- -layout: "docs" -page_title: "Basic CLI Features" -sidebar_current: "docs-commands" -description: "An introduction to the terraform command and its available subcommands." +page_title: Basic CLI Features +description: An introduction to the terraform command and its available subcommands. --- # Basic CLI Features @@ -17,8 +15,8 @@ of this page. We refer to the `terraform` command line tool as "Terraform CLI" elsewhere in the documentation. This terminology is often used to distinguish it from other components you might use in the Terraform product family, such as -[Terraform Cloud](/docs/cloud/) or -the various [Terraform providers](/docs/language/providers/index.html), which +[Terraform Cloud](/cloud-docs) or +the various [Terraform providers](/language/providers), which are developed and released separately from Terraform CLI. To view a list of the commands available in your current Terraform version, @@ -100,7 +98,7 @@ will be read or written in the given directory instead. There are two exceptions where Terraform will use the original working directory even when you specify `-chdir=...`: -* Settings in the [CLI Configuration](/docs/cli/config/config-file.html) are not for a specific +* Settings in the [CLI Configuration](/cli/config/config-file) are not for a specific subcommand and Terraform processes them before acting on the `-chdir` option. @@ -153,7 +151,7 @@ Checkpoint itself can be entirely disabled for all HashiCorp products by setting the environment variable `CHECKPOINT_DISABLE` to any non-empty value. Alternatively, settings in -[the CLI configuration file](/docs/cli/config/config-file.html) can be used to +[the CLI configuration file](/cli/config/config-file) can be used to disable checkpoint features. The following checkpoint-related settings are supported in this file: diff --git a/website/docs/cli/commands/init.html.md b/website/docs/cli/commands/init.mdx similarity index 83% rename from website/docs/cli/commands/init.html.md rename to website/docs/cli/commands/init.mdx index 6a62906a5440..d9e7b8ce6f4f 100644 --- a/website/docs/cli/commands/init.html.md +++ b/website/docs/cli/commands/init.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: init" -sidebar_current: "docs-commands-init" -description: "The terraform init command initializes a working directory containing configuration files and installs plugins for required providers." +page_title: 'Command: init' +description: >- + The terraform init command initializes a working directory containing + configuration files and installs plugins for required providers. --- # Command: init @@ -74,7 +74,7 @@ activating credentials) before running `terraform init`. ## Backend Initialization During init, the root configuration directory is consulted for -[backend configuration](/docs/language/settings/backends/configuration.html) and the chosen backend +[backend configuration](/language/settings/backends/configuration) and the chosen backend is initialized using the given configuration settings. Re-running init with an already-initialized backend will update the working @@ -96,14 +96,14 @@ when the working directory was already previously initialized for a particular backend. The `-backend-config=...` option can be used for -[partial backend configuration](/docs/language/settings/backends/configuration.html#partial-configuration), +[partial backend configuration](/language/settings/backends/configuration#partial-configuration), in situations where the backend settings are dynamic or sensitive and so cannot be statically specified in the configuration file. ## Child Module Installation During init, the configuration is searched for `module` blocks, and the source -code for referenced [modules](/docs/language/modules/develop/index.html) is retrieved from the locations +code for referenced [modules](/language/modules/develop) is retrieved from the locations given in their `source` arguments. Re-running init with modules already installed will install the sources for @@ -128,13 +128,13 @@ third-party provider registry, `terraform init` will automatically find, download, and install the necessary provider plugins. If you cannot or do not wish to install providers from their origin registries, you can customize how Terraform installs providers using -[the provider installation settings in the CLI configuration](/docs/cli/config/config-file.html#provider-installation). +[the provider installation settings in the CLI configuration](/cli/config/config-file#provider-installation). For more information about specifying which providers are required for each -of your modules, see [Provider Requirements](/docs/language/providers/requirements.html). +of your modules, see [Provider Requirements](/language/providers/requirements). After successful installation, Terraform writes information about the selected -providers to [the dependency lock file](/docs/language/dependency-lock.html). +providers to [the dependency lock file](/language/files/dependency-lock). You should commit this file to your version control system to ensure that when you run `terraform init` again in future Terraform will select exactly the same provider versions. Use the `-upgrade` option if you want Terraform @@ -142,31 +142,31 @@ to ignore the dependency lock file and consider installing newer versions. You can modify `terraform init`'s plugin behavior with the following options: -- `-upgrade` Upgrade all previously-selected plugins to the newest version +* `-upgrade` Upgrade all previously-selected plugins to the newest version that complies with the configuration's version constraints. This will cause Terraform to ignore any selections recorded in the dependency lock file, and to take the newest available version matching the configured version constraints. -- `-get-plugins=false` — Skip plugin installation. - - -> Note: Since Terraform 0.13, this option has been superseded by the - [`provider_installation`](/docs/cli/config/config-file.html#provider-installation) and - [`plugin_cache_dir`](/docs/cli/config/config-file.html#plugin_cache_dir) settings. - It should not be used in Terraform versions 0.13+, and this option - was removed in Terraform 0.15. -- `-plugin-dir=PATH` — Force plugin installation to read plugins _only_ from +* `-get-plugins=false` — Skip plugin installation. + + -> Note: Since Terraform 0.13, this option has been superseded by the + [`provider_installation`](/cli/config/config-file#provider-installation) and + [`plugin_cache_dir`](/cli/config/config-file#plugin_cache_dir) settings. + It should not be used in Terraform versions 0.13+, and this option + was removed in Terraform 0.15. +* `-plugin-dir=PATH` — Force plugin installation to read plugins _only_ from the specified directory, as if it had been configured as a `filesystem_mirror` in the CLI configuration. If you intend to routinely use a particular filesystem mirror then we recommend - [configuring Terraform's installation methods globally](/docs/cli/config/config-file.html#provider-installation). + [configuring Terraform's installation methods globally](/cli/config/config-file#provider-installation). You can use `-plugin-dir` as a one-time override for exceptional situations, such as if you are testing a local build of a provider plugin you are currently developing. -- `-lockfile=MODE` Set a dependency lockfile mode. +* `-lockfile=MODE` Set a dependency lockfile mode. The valid values for the lockfile mode are as follows: -- readonly: suppress the lockfile changes, but verify checksums against the +* readonly: suppress the lockfile changes, but verify checksums against the information already recorded. It conflicts with the `-upgrade` flag. If you update the lockfile with third-party dependency management tools, it would be useful to control when it changes explicitly. @@ -192,7 +192,7 @@ that directory as the root module instead of the current working directory. That usage is still supported in Terraform v0.14, but is now deprecated and we plan to remove it in Terraform v0.15. If your workflow relies on overriding the root module directory, use -[the `-chdir` global option](./#switching-working-directory-with-chdir) +[the `-chdir` global option](/cli/commands/#switching-working-directory-with-chdir) instead, which works across all commands and makes Terraform consistently look in the given directory for all files it would normally read or write in the current working directory. @@ -200,6 +200,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/cli/config/environment-variables#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/login.html.md b/website/docs/cli/commands/login.mdx similarity index 72% rename from website/docs/cli/commands/login.html.md rename to website/docs/cli/commands/login.mdx index 8af1ef7a474f..86e1fcfee966 100644 --- a/website/docs/cli/commands/login.html.md +++ b/website/docs/cli/commands/login.mdx @@ -1,9 +1,9 @@ --- -layout: "docs" -page_title: "Command: login" -sidebar_current: "docs-commands-login" -description: |- - The terraform login command can be used to automatically obtain and save an API token for Terraform Cloud, Terraform Enterprise, or any other host that offers Terraform services. +page_title: 'Command: login' +description: >- + The terraform login command can be used to automatically obtain and save an + API token for Terraform Cloud, Terraform Enterprise, or any other host that + offers Terraform services. --- # Command: login @@ -15,7 +15,7 @@ API token for Terraform Cloud, Terraform Enterprise, or any other host that offe where it is possible to launch a web browser on the same host where Terraform is running. If you are running Terraform in an unattended automation scenario, you can -[configure credentials manually in the CLI configuration](https://www.terraform.io/docs/cli/config/config-file.html#credentials). +[configure credentials manually in the CLI configuration](/cli/config/config-file#credentials). ## Usage @@ -34,12 +34,12 @@ not as desired. If you don't wish to store your API token in the default location, you can optionally configure a -[credentials helper program](/docs/cli/config/config-file.html#credentials-helpers) which knows +[credentials helper program](/cli/config/config-file#credentials-helpers) which knows how to store and later retrieve credentials in some other system, such as your organization's existing secrets management system. ## Login Server Support The `terraform login` command works with any server supporting the -[login protocol](/docs/internals/login-protocol.html), including Terraform Cloud +[login protocol](/internals/login-protocol), including Terraform Cloud and Terraform Enterprise. diff --git a/website/docs/cli/commands/logout.html.md b/website/docs/cli/commands/logout.mdx similarity index 79% rename from website/docs/cli/commands/logout.html.md rename to website/docs/cli/commands/logout.mdx index 15656fba9acc..dbec4bc757a0 100644 --- a/website/docs/cli/commands/logout.html.md +++ b/website/docs/cli/commands/logout.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: logout" -sidebar_current: "docs-commands-logout" -description: |- - The terraform logout command is used to remove credentials stored by terraform login. +page_title: 'Command: logout' +description: >- + The terraform logout command is used to remove credentials stored by terraform + login. --- # Command: logout @@ -26,5 +25,5 @@ the remote server, so it will remain valid until manually revoked. By default, Terraform will remove the token stored in plain text in a local CLI configuration file called `credentials.tfrc.json`. If you have configured a -[credentials helper program](/docs/cli/config/config-file.html#credentials-helpers), Terraform +[credentials helper program](/cli/config/config-file#credentials-helpers), Terraform will use the helper's `forget` command to remove it. diff --git a/website/docs/cli/commands/output.html.md b/website/docs/cli/commands/output.mdx similarity index 81% rename from website/docs/cli/commands/output.html.md rename to website/docs/cli/commands/output.mdx index a09725e212eb..2fe970ba7234 100644 --- a/website/docs/cli/commands/output.html.md +++ b/website/docs/cli/commands/output.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: output" -sidebar_current: "docs-commands-output" -description: |- - The `terraform output` command is used to extract the value of an output variable from the state file. +page_title: 'Command: output' +description: >- + The `terraform output` command is used to extract the value of an output + variable from the state file. --- # Command: output @@ -22,20 +21,20 @@ output is printed. The command-line flags are all optional. The list of available flags are: * `-json` - If specified, the outputs are formatted as a JSON object, with - a key per output. If `NAME` is specified, only the output specified will be - returned. This can be piped into tools such as `jq` for further processing. + a key per output. If `NAME` is specified, only the output specified will be + returned. This can be piped into tools such as `jq` for further processing. * `-raw` - If specified, Terraform will convert the specified output value to a - string and print that string directly to the output, without any special - formatting. This can be convenient when working with shell scripts, but - it only supports string, number, and boolean values. Use `-json` instead - for processing complex data types. + string and print that string directly to the output, without any special + formatting. This can be convenient when working with shell scripts, but + it only supports string, number, and boolean values. Use `-json` instead + for processing complex data types. * `-no-color` - If specified, output won't contain any color. * `-state=path` - Path to the state file. Defaults to "terraform.tfstate". - Ignored when [remote state](/docs/language/state/remote.html) is used. + Ignored when [remote state](/language/state/remote) is used. -> **Note:** When using the `-json` or `-raw` command-line flag, any sensitive values in Terraform state will be displayed in plain text. For more information, -see [Sensitive Data in State](/docs/language/state/sensitive-data.html). +see [Sensitive Data in State](/language/state/sensitive-data). ## Examples diff --git a/website/docs/cli/commands/plan.html.md b/website/docs/cli/commands/plan.mdx similarity index 78% rename from website/docs/cli/commands/plan.html.md rename to website/docs/cli/commands/plan.mdx index cdb3bbe277d0..8cb8112e166f 100644 --- a/website/docs/cli/commands/plan.html.md +++ b/website/docs/cli/commands/plan.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: plan" -sidebar_current: "docs-commands-plan" -description: "The terraform plan command creates an execution plan with a preview of the changes that Terraform will make to your infrastructure." +page_title: 'Command: plan' +description: >- + The terraform plan command creates an execution plan with a preview of the + changes that Terraform will make to your infrastructure. --- # Command: plan @@ -31,12 +31,12 @@ to be taken. If you are using Terraform directly in an interactive terminal and you expect to apply the changes Terraform proposes, you can alternatively run -[`terraform apply`](./apply.html) directly. By default, the "apply" command +[`terraform apply`](/cli/commands/apply) directly. By default, the "apply" command automatically generates a new plan and prompts for you to approve it. You can use the optional `-out=FILE` option to save the generated plan to a file on disk, which you can later execute by passing the file to -[`terraform apply`](./apply.html) as an extra argument. This two-step workflow +[`terraform apply`](/cli/commands/apply) as an extra argument. This two-step workflow is primarily intended for when [running Terraform in automation](https://learn.hashicorp.com/tutorials/terraform/automate-terraform?in=terraform/automation&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). @@ -74,9 +74,9 @@ The remaining sections on this page describe the various options: * **[Planning Options](#planning-options)**: Alongside the special planning modes, there are also some options you can set in order to customize the planning process for unusual needs. - * **[Resource Targeting](#resource-targeting)** is one particular - special planning option that has some important caveats associated - with it. + * **[Resource Targeting](#resource-targeting)** is one particular + special planning option that has some important caveats associated + with it. * **[Other Options](#other-options)**: These change the behavior of the planning command itself, rather than customizing the content of the generated plan. @@ -94,7 +94,7 @@ a different intended outcome: for situations like transient development environments, where the managed objects cease to be useful once the development task is complete. - Activate destroy mode using the `-destroy` command line option. + Activate destroy mode using the `-destroy` command line option. * **Refresh-only mode:** creates a plan whose goal is only to update the Terraform state and any root module output values to match changes made to @@ -103,7 +103,7 @@ a different intended outcome: workflow (e.g. while responding to an incident) and you now need to reconcile Terraform's records with those changes. - Activate refresh-only mode using the `-refresh-only` command line option. + Activate refresh-only mode using the `-refresh-only` command line option. In situations where we need to discuss the default planning mode that Terraform uses when none of the alternative modes are selected, we refer to it as @@ -118,7 +118,7 @@ one alternative mode at the same time. -> **Note:** In Terraform v0.15 and earlier, the `-destroy` option is supported only by the `terraform plan` command, and not by the `terraform apply` command. To create and apply a plan in destroy mode in -earlier versions you must run [`terraform destroy`](./destroy.html). +earlier versions you must run [`terraform destroy`](/cli/commands/destroy). -> **Note:** The `-refresh-only` option is available only in Terraform v0.15.4 and later. @@ -140,62 +140,62 @@ the previous section, are also available with the same meanings on * `-refresh=false` - Disables the default behavior of synchronizing the Terraform state with remote objects before checking for configuration changes. - This option can potentially make the planning operation faster by reducing - the number of remote API requests, but it comes at the expense of having - Terraform not take into account any changes that might've happened outside - of Terraform, and thus the resulting plan may not be complete or correct. + This option can potentially make the planning operation faster by reducing + the number of remote API requests, but it comes at the expense of having + Terraform not take into account any changes that might've happened outside + of Terraform, and thus the resulting plan may not be complete or correct. - This option is not available in the "refresh only" planning mode, because - it would effectively disable the entirety of the planning operation in that - case. + This option is not available in the "refresh only" planning mode, because + it would effectively disable the entirety of the planning operation in that + case. * `-replace=ADDRESS` - Instructs Terraform to plan to replace the single resource instance with the given address. If the given instance would normally have caused only an "update" action, or no action at all, then Terraform will choose a "replace" action instead. - You can use this option if you have learned that a particular remote object - has become degraded in some way. If you are using immutable infrastructure - patterns then you may wish to respond to that by replacing the - malfunctioning object with a new object that has the same configuration. + You can use this option if you have learned that a particular remote object + has become degraded in some way. If you are using immutable infrastructure + patterns then you may wish to respond to that by replacing the + malfunctioning object with a new object that has the same configuration. - This option is allowed only in the normal planning mode, so this option - is incompatible with the `-destroy` option. + This option is allowed only in the normal planning mode, so this option + is incompatible with the `-destroy` option. - The `-replace=...` option is available only from Terraform v0.15.2 onwards. - For earlier versions, you can achieve a similar effect (with some caveats) - using [`terraform taint`](./taint.html). + The `-replace=...` option is available only from Terraform v0.15.2 onwards. + For earlier versions, you can achieve a similar effect (with some caveats) + using [`terraform taint`](/cli/commands/taint). * `-target=ADDRESS` - Instructs Terraform to focus its planning efforts only on resource instances which match the given address and on any objects that those instances depend on. - This command is for exceptional use only. See - [Resource Targeting](#resource-targeting) - below for more information. + This command is for exceptional use only. See + [Resource Targeting](#resource-targeting) + below for more information. * `-var 'NAME=VALUE'` - Sets a value for a single - [input variable](/docs/language/values/variables.html) declared in the + [input variable](/language/values/variables) declared in the root module of the configuration. Use this option multiple times to set more than one variable. For more information see [Input Variables on the Command Line](#input-variables-on-the-command-line), below. * `-var-file=FILENAME` - Sets values for potentially many - [input variables](/docs/language/values/variables.html) declared in the + [input variables](/language/values/variables) declared in the root module of the configuration, using definitions from a - ["tfvars" file](/docs/language/values/variables.html#variable-definitions-tfvars-files). + ["tfvars" file](/language/values/variables#variable-definitions-tfvars-files). Use this option multiple times to include values from more than one file. There are several other ways to set values for input variables in the root module, aside from the `-var` and `-var-file` options. For more information, see -[Assigning Values to Root Module Variables](/docs/language/values/variables.html#assigning-values-to-root-module-variables). +[Assigning Values to Root Module Variables](/language/values/variables#assigning-values-to-root-module-variables). ### Input Variables on the Command Line You can use the `-var` command line option to specify values for -[input variables](/docs/language/values/variables.html) declared in your +[input variables](/language/values/variables) declared in your root module. However, to do so will require writing a command line that is parsable both @@ -242,7 +242,7 @@ so we do not recommend using Terraform with PowerShell when you are on Windows. Use Windows Command Prompt instead. The appropriate syntax for writing the variable value is different depending -on the variable's [type constraint](/docs/language/expressions/type-constraints.html). +on the variable's [type constraint](/language/expressions/type-constraints). The primitive types `string`, `number`, and `bool` all expect a direct string value with no special punctuation except that required by your shell, as shown in the above examples. For all other type constraints, including list, @@ -262,8 +262,7 @@ terraform plan -var "name=[\"a\", \"b\", \"c\"]" Similar constraints apply when setting input variables using environment variables. For more information on the various methods for setting root module input variables, see -[Assigning Values to Root Module Variables](/docs/language/values/variables.html#assigning-values-to-root-module-variables). - +[Assigning Values to Root Module Variables](/language/values/variables#assigning-values-to-root-module-variables). ### Resource Targeting @@ -271,7 +270,7 @@ input variables, see You can use the `-target` option to focus Terraform's attention on only a subset of resources. -You can use [resource address syntax](/docs/cli/state/resource-addressing.html) +You can use [resource address syntax](/cli/state/resource-addressing) to specify the constraint. Terraform interprets the resource address as follows: * If the given address identifies one specific resource instance, Terraform @@ -296,14 +295,14 @@ that those selections depend on either directly or indirectly. This targeting capability is provided for exceptional circumstances, such as recovering from mistakes or working around Terraform limitations. It -is *not recommended* to use `-target` for routine operations, since this can +is _not recommended_ to use `-target` for routine operations, since this can lead to undetected configuration drift and confusion about how the true state of resources relates to configuration. Instead of using `-target` as a means to operate on isolated portions of very large configurations, prefer instead to break large configurations into several smaller configurations that can each be independently applied. -[Data sources](/docs/language/data-sources/index.html) can be used to access +[Data sources](/language/data-sources) can be used to access information about resources created in other configurations, allowing a complex system architecture to be broken down into more manageable parts that can be updated independently. @@ -339,11 +338,11 @@ The available options are: This implies `-input=false`, so the configuration must have no unassigned variable values to continue. - [machine-readable-ui]: /docs/internals/machine-readable-ui.html + [machine-readable-ui]: /internals/machine-readable-ui * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -359,28 +358,28 @@ The available options are: the planned changes, and to some other Terraform commands that can work with saved plan files. - Terraform will allow any filename for the plan file, but a typical - convention is to name it `tfplan`. **Do not** name the file with a suffix - that Terraform recognizes as another file format; if you use a `.tf` suffix - then Terraform will try to interpret the file as a configuration source - file, which will then cause syntax errors for subsequent commands. + Terraform will allow any filename for the plan file, but a typical + convention is to name it `tfplan`. **Do not** name the file with a suffix + that Terraform recognizes as another file format; if you use a `.tf` suffix + then Terraform will try to interpret the file as a configuration source + file, which will then cause syntax errors for subsequent commands. - The generated file is not in any standard format intended for consumption - by other software, but the file _does_ contain your full configuration, - all of the values associated with planned changes, and all of the plan - options including the input variables. If your plan includes any sort of - sensitive data, even if obscured in Terraform's terminal output, it will - be saved in cleartext in the plan file. You should therefore treat any - saved plan files as potentially-sensitive artifacts. + The generated file is not in any standard format intended for consumption + by other software, but the file _does_ contain your full configuration, + all of the values associated with planned changes, and all of the plan + options including the input variables. If your plan includes any sort of + sensitive data, even if obscured in Terraform's terminal output, it will + be saved in cleartext in the plan file. You should therefore treat any + saved plan files as potentially-sensitive artifacts. * `-parallelism=n` - Limit the number of concurrent operations as Terraform - [walks the graph](/docs/internals/graph.html#walking-the-graph). Defaults + [walks the graph](/internals/graph#walking-the-graph). Defaults to 10. For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform plan` accepts the legacy command line option -[`-state`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`](/language/settings/backends/local#command-line-arguments). ### Passing a Different Configuration Directory @@ -390,7 +389,7 @@ module instead of the current working directory. That usage was deprecated in Terraform v0.14 and removed in Terraform v0.15. If your workflow relies on overriding the root module directory, use -[the `-chdir` global option](./#switching-working-directory-with-chdir) +[the `-chdir` global option](/cli/commands/#switching-working-directory-with-chdir) instead, which works across all commands and makes Terraform consistently look in the given directory for all files it would normally read or write in the current working directory. @@ -398,6 +397,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/cli/config/environment-variables#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/providers.html.md b/website/docs/cli/commands/providers.mdx similarity index 55% rename from website/docs/cli/commands/providers.html.md rename to website/docs/cli/commands/providers.mdx index a39d0ee0ff7b..9d2b6c722134 100644 --- a/website/docs/cli/commands/providers.html.md +++ b/website/docs/cli/commands/providers.mdx @@ -1,14 +1,14 @@ --- -layout: "docs" -page_title: "Command: providers" -sidebar_current: "docs-commands-providers" -description: "The terraform providers command prints information about the providers required in the current configuration." +page_title: 'Command: providers' +description: >- + The terraform providers command prints information about the providers + required in the current configuration. --- # Command: providers The `terraform providers` command shows information about the -[provider requirements](/docs/language/providers/requirements.html) of the +[provider requirements](/language/providers/requirements) of the configuration in the current working directory, as an aid to understanding where each requirement was detected from. diff --git a/website/docs/cli/commands/providers/lock.html.md b/website/docs/cli/commands/providers/lock.mdx similarity index 76% rename from website/docs/cli/commands/providers/lock.html.md rename to website/docs/cli/commands/providers/lock.mdx index b9a48fae7d2e..9a6de3ff9dfc 100644 --- a/website/docs/cli/commands/providers/lock.html.md +++ b/website/docs/cli/commands/providers/lock.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: providers lock" -sidebar_current: "docs-commands-providers-lock" +page_title: 'Command: providers lock' description: |- The `terraform providers lock` command adds new provider selection information to the dependency lock file without initializing the referenced providers. @@ -11,31 +9,31 @@ description: |- The `terraform providers lock` consults upstream registries (by default) in order to write provider dependency information into -[the dependency lock file](/docs/language/dependency-lock.html). +[the dependency lock file](/language/files/dependency-lock). The common way to update the dependency lock file is as a side-effect of normal provider installation during -[`terraform init`](/docs/cli/commands/init.html), but there are several situations where that +[`terraform init`](/cli/commands/init), but there are several situations where that automatic approach may not be sufficient: * If you are running Terraform in an environment that uses - [alternative provider installation methods](/docs/cli/config/config-file.html#provider-installation), + [alternative provider installation methods](/cli/config/config-file#provider-installation), such as filesystem or network mirrors, normal provider installation will not access the origin registry for a provider and therefore Terraform will not be able to populate all of the possible package checksums for the selected provider versions. - If you use `terraform lock` to write the official release checksums for a - provider into the dependency lock file then future `terraform init` runs - will verify the packages available in your selected mirror against the - official checksums previously recorded, giving additional certainty that - the mirror is serving the provider packages it is claiming to. + If you use `terraform lock` to write the official release checksums for a + provider into the dependency lock file then future `terraform init` runs + will verify the packages available in your selected mirror against the + official checksums previously recorded, giving additional certainty that + the mirror is serving the provider packages it is claiming to. * If your team runs Terraform across a number of different platforms (e.g. on both Windows and Linux) and the upstream registry for a provider is unable to provide signed checksums using the latest hashing scheme, subsequent runs of Terraform on other platforms may - [add additional checksums to the lock file](/docs/language/dependency-lock.html#new-provider-package-checksums). + [add additional checksums to the lock file](/language/files/dependency-lock#new-provider-package-checksums). You can avoid that by pre-populating hashes for all of the platforms you intend to use, using the `terraform providers lock` command. @@ -49,17 +47,17 @@ With no additional command line arguments, `terraform providers lock` will analyze the configuration in the current working directory to find all of the providers it depends on, and it will fetch the necessary data about those providers from their origin registries and then update -[the dependency lock file](/docs/language/dependency-lock.html) to +[the dependency lock file](/language/files/dependency-lock) to include a selected version for each provider and all of the package checksums that are covered by the provider developer's cryptographic signature. ~> **Warning:** The `terraform providers lock` command prints information - about what it has fetched and whether each package was signed using a - cryptographic signature, but it cannot automatically verify that the - providers are trustworthy and that they comply with your local system - policies or relevant regulations. Review the signing key information - in the output to confirm that you trust all of the signers before committing - the updated lock file to your version control system. +about what it has fetched and whether each package was signed using a +cryptographic signature, but it cannot automatically verify that the +providers are trustworthy and that they comply with your local system +policies or relevant regulations. Review the signing key information +in the output to confirm that you trust all of the signers before committing +the updated lock file to your version control system. If you list one or more provider source addresses on the command line then `terraform providers lock` will restrict its work only to those providers, @@ -74,21 +72,21 @@ You can customize the default behavior using the following additional option: * `-net-mirror=URL` - Direct Terraform to look for provider packages in the given network mirror service, instead of in upstream registries. The given URL must implement - [the Terraform provider network mirror protocol](/docs/internals/provider-network-mirror-protocol.html). + [the Terraform provider network mirror protocol](/internals/provider-network-mirror-protocol). * `-platform=OS_ARCH` - Specify a platform you intend to use to work with this Terraform configuration. Terraform will ensure that the providers are all available for the given platform and will save enough package checksums in the lock file to support _at least_ the specified platforms. - - Use this option multiple times to include checksums for multiple target - systems. - Target platform names consist of an operating system and a CPU - architecture. For example, `linux_amd64` selects the Linux operating system - running on an AMD64 or x86_64 CPU. + Use this option multiple times to include checksums for multiple target + systems. - There is more detail on this option in the following section. + Target platform names consist of an operating system and a CPU + architecture. For example, `linux_amd64` selects the Linux operating system + running on an AMD64 or x86_64 CPU. + + There is more detail on this option in the following section. ## Specifying Target Platforms @@ -150,7 +148,7 @@ multiple times and specify a different subset of your providers each time. The `-fs-mirror` and `-net-mirror` options have the same meaning as `filesystem_mirror` and `network_mirror` blocks in -[the provider installation methods configuration](/docs/cli/config/config-file.html#provider-installation), +[the provider installation methods configuration](/cli/config/config-file#provider-installation), but specify only a single method in order to be explicit about where you intend to derive the package checksum information from. @@ -167,4 +165,4 @@ If you wish, you can publish your in-house providers via an in-house provider registry, which will then allow locking and installation of those providers without any special options or additional CLI configuration. For more information, see -[the provider registry protocol](/docs/internals/provider-registry-protocol.html). +[the provider registry protocol](/internals/provider-registry-protocol). diff --git a/website/docs/cli/commands/providers/mirror.html.md b/website/docs/cli/commands/providers/mirror.mdx similarity index 89% rename from website/docs/cli/commands/providers/mirror.html.md rename to website/docs/cli/commands/providers/mirror.mdx index b0827837e446..d6f9c8c8c852 100644 --- a/website/docs/cli/commands/providers/mirror.html.md +++ b/website/docs/cli/commands/providers/mirror.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: providers mirror" -sidebar_current: "docs-commands-providers-mirror" +page_title: 'Command: providers mirror' description: |- The `terraform providers mirror` command downloads the providers required for the current configuration and copies them into a directory in the local @@ -19,7 +17,7 @@ from provider registries as part of initializing the current working directory. Sometimes Terraform is running in an environment where that isn't possible, such as on an isolated network without access to the Terraform Registry. In that case, -[explicit installation method configuration](/docs/cli/config/config-file.html#explicit-installation-method-configuration) +[explicit installation method configuration](/cli/config/config-file#explicit-installation-method-configuration) allows you to configure Terraform, when running on a particular system, to consult only a local filesystem directory where you've created a local mirror of the necessary plugins, and to skip accessing the upstream registry at all. @@ -41,7 +39,7 @@ themselves. Terraform will also generate various `.json` index files which contain suitable responses to implement -[the network mirror protocol](/docs/internals/provider-network-mirror-protocol.html), +[the network mirror protocol](/internals/provider-network-mirror-protocol), if you upload the resulting directory to a static website host. Terraform ignores those index files when using the directory as a filesystem mirror, because the directory entries themselves are authoritative in that case. diff --git a/website/docs/cli/commands/providers/schema.html.md b/website/docs/cli/commands/providers/schema.mdx similarity index 93% rename from website/docs/cli/commands/providers/schema.html.md rename to website/docs/cli/commands/providers/schema.mdx index 2a3dddc1338e..fbdeafc70f69 100644 --- a/website/docs/cli/commands/providers/schema.html.md +++ b/website/docs/cli/commands/providers/schema.mdx @@ -1,9 +1,9 @@ --- -layout: "docs" -page_title: "Command: providers schema" -sidebar_current: "docs-commands-providers-schema" -description: |- - The `terraform providers schema` command prints detailed schemas for the providers used +page_title: 'Command: providers schema' +description: >- + The `terraform providers schema` command prints detailed schemas for the + providers used + in the current configuration. --- @@ -19,7 +19,7 @@ Usage: `terraform providers schema [options]` The list of available flags are: -* `-json` - Displays the schemas in a machine-readable, JSON format. +- `-json` - Displays the schemas in a machine-readable, JSON format. Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. @@ -34,7 +34,7 @@ value `"1.0"`. The semantics of this version are: version. We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +[the Terraform 1.0 Compatibility Promises](/language/v1-compatibility-promises). ## Format Summary diff --git a/website/docs/cli/commands/push.html.md b/website/docs/cli/commands/push.mdx similarity index 61% rename from website/docs/cli/commands/push.html.md rename to website/docs/cli/commands/push.mdx index bc093a85cb9a..7eb66776e917 100644 --- a/website/docs/cli/commands/push.html.md +++ b/website/docs/cli/commands/push.mdx @@ -1,16 +1,14 @@ --- -layout: "docs" -page_title: "Command: push" -sidebar_current: "docs-commands-push" -description: |- - DISCONTINUED. Terraform Cloud and the modern "remote" backend have replaced the old `terraform push` command. +page_title: 'Command: push' +description: >- + DISCONTINUED. Terraform Cloud and the modern "remote" backend have replaced + the old `terraform push` command. --- # Command: push -!> **Important:** The `terraform push` command is no longer functional. Its functionality was replaced and surpassed by [the `remote` backend](/docs/language/settings/backends/remote.html), which works with current versions of Terraform Cloud. The `remote` backend allows you to run remote operations directly from the command line, and displays real-time output from the remote run environment. +!> **Important:** The `terraform push` command is no longer functional. Its functionality was replaced and surpassed by [the `remote` backend](/language/settings/backends/remote), which works with current versions of Terraform Cloud. The `remote` backend allows you to run remote operations directly from the command line, and displays real-time output from the remote run environment. The `terraform push` command was an early implementation of remote Terraform runs. It allowed teams to push a configuration to a remote run environment in a discontinued version of Terraform Enterprise. The legacy Terraform Enterprise version that supported `terraform push` is no longer available, and there are no remaining instances of that version in operation. Without a service to push to, the command is now completely non-functional. - diff --git a/website/docs/cli/commands/refresh.html.md b/website/docs/cli/commands/refresh.mdx similarity index 88% rename from website/docs/cli/commands/refresh.html.md rename to website/docs/cli/commands/refresh.mdx index 55a007f38e20..898457fd8cb9 100644 --- a/website/docs/cli/commands/refresh.html.md +++ b/website/docs/cli/commands/refresh.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: refresh" -sidebar_current: "docs-commands-refresh" +page_title: 'Command: refresh' description: |- The `terraform refresh` command reads the current settings from all managed remote objects and updates the Terraform state to match. @@ -14,19 +12,19 @@ description: |- The `terraform refresh` command reads the current settings from all managed remote objects and updates the Terraform state to match. -~> *Warning:* This command is deprecated, because its default behavior is +~> _Warning:_ This command is deprecated, because its default behavior is unsafe if you have misconfigured credentials for any of your providers. See below for more information and recommended alternatives. This won't modify your real remote objects, but it will modify the -[Terraform state](/docs/language/state/). +[Terraform state](/language/state). You shouldn't typically need to use this command, because Terraform automatically performs the same refreshing actions as a part of creating a plan in both the -[`terraform plan`](./plan.html) +[`terraform plan`](/cli/commands/plan) and -[`terraform apply`](./apply.html) +[`terraform apply`](/cli/commands/apply) commands. This command is here primarily for backward compatibility, but we don't recommend using it because it provides no opportunity to review the effects of the operation before updating the state. @@ -42,7 +40,7 @@ terraform apply -refresh-only -auto-approve ``` Consequently, it supports all of the same options as -[`terraform apply`](./apply.html) except that it does not accept a saved +[`terraform apply`](/cli/commands/apply) except that it does not accept a saved plan file, it doesn't allow selecting a planning mode other than "refresh only", and `-auto-approve` is always enabled. diff --git a/website/docs/cli/commands/show.html.md b/website/docs/cli/commands/show.mdx similarity index 81% rename from website/docs/cli/commands/show.html.md rename to website/docs/cli/commands/show.mdx index 45bc6fa3f7d2..f956db19ba1d 100644 --- a/website/docs/cli/commands/show.html.md +++ b/website/docs/cli/commands/show.mdx @@ -1,9 +1,10 @@ --- -layout: "docs" -page_title: "Command: show" -sidebar_current: "docs-commands-show" -description: |- - The `terraform show` command is used to provide human-readable output from a state or plan file. This can be used to inspect a plan to ensure that the planned operations are expected, or to inspect the current state as Terraform sees it. +page_title: 'Command: show' +description: >- + The `terraform show` command is used to provide human-readable output from a + state or plan file. This can be used to inspect a plan to ensure that the + planned operations are expected, or to inspect the current state as Terraform + sees it. --- # Command: show @@ -18,7 +19,7 @@ flag. -> **Note:** When using the `-json` command-line flag, any sensitive values in Terraform state will be displayed in plain text. For more information, see -[Sensitive Data in State](/docs/language/state/sensitive-data.html). +[Sensitive Data in State](/language/state/sensitive-data). ## JSON Output @@ -34,7 +35,7 @@ was written, the state needs to be upgraded before it can be displayed with `-refresh=false`. If you are viewing a state file, run `terraform refresh` first. -The output format is covered in detail in [JSON Output Format](/docs/internals/json-format.html). +The output format is covered in detail in [JSON Output Format](/internals/json-format). ## Usage diff --git a/website/docs/cli/commands/state/index.html.md b/website/docs/cli/commands/state/index.mdx similarity index 82% rename from website/docs/cli/commands/state/index.html.md rename to website/docs/cli/commands/state/index.mdx index 38e2028d9d31..7b2f10ac8a60 100644 --- a/website/docs/cli/commands/state/index.html.md +++ b/website/docs/cli/commands/state/index.mdx @@ -1,16 +1,13 @@ --- -layout: "docs" -page_title: "Command: state" -sidebar_current: "docs-commands-state-index" -description: |- - The `terraform state` command is used for advanced state management. +page_title: 'Command: state' +description: The `terraform state` command is used for advanced state management. --- # State Command The `terraform state` command is used for advanced state management. As your Terraform usage becomes more advanced, there are some cases where -you may need to modify the [Terraform state](/docs/language/state/index.html). +you may need to modify the [Terraform state](/language/state). Rather than modify the state directly, the `terraform state` commands can be used in many cases instead. @@ -35,7 +32,7 @@ written to disk and the CLI usage is the same as if it were local state. All `terraform state` subcommands that modify the state write backup files. The path of these backup file can be controlled with `-backup`. -Subcommands that are read-only (such as [list](/docs/cli/commands/state/list.html)) +Subcommands that are read-only (such as [list](/cli/commands/state/list)) do not write any backup files since they aren't modifying the state. Note that backups for state modification _can not be disabled_. Due to diff --git a/website/docs/cli/commands/state/list.html.md b/website/docs/cli/commands/state/list.mdx similarity index 84% rename from website/docs/cli/commands/state/list.html.md rename to website/docs/cli/commands/state/list.mdx index a7b78c94b620..b4ed0e66cdcc 100644 --- a/website/docs/cli/commands/state/list.html.md +++ b/website/docs/cli/commands/state/list.mdx @@ -1,15 +1,14 @@ --- -layout: "docs" -page_title: "Command: state list" -sidebar_current: "docs-commands-state-sub-list" -description: |- - The terraform state list command is used to list resources within a Terraform state. +page_title: 'Command: state list' +description: >- + The terraform state list command is used to list resources within a Terraform + state. --- # Command: state list The `terraform state list` command is used to list resources within a -[Terraform state](/docs/language/state/index.html). +[Terraform state](/language/state). ## Usage @@ -25,12 +24,12 @@ within modules are listed last. For complex infrastructures, the state can contain thousands of resources. To filter these, provide one or more patterns to the command. Patterns are -in [resource addressing format](/docs/cli/state/resource-addressing.html). +in [resource addressing format](/cli/state/resource-addressing). The command-line flags are all optional. The list of available flags are: * `-state=path` - Path to the state file. Defaults to "terraform.tfstate". - Ignored when [remote state](/docs/language/state/remote.html) is used. + Ignored when [remote state](/language/state/remote) is used. * `-id=id` - ID of resources to show. Ignored when unset. ## Example: All Resources diff --git a/website/docs/cli/commands/state/mv.html.md b/website/docs/cli/commands/state/mv.mdx similarity index 81% rename from website/docs/cli/commands/state/mv.html.md rename to website/docs/cli/commands/state/mv.mdx index 2cf2f8cd6c8d..72999019ef59 100644 --- a/website/docs/cli/commands/state/mv.html.md +++ b/website/docs/cli/commands/state/mv.mdx @@ -1,14 +1,13 @@ --- -layout: "docs" -page_title: "Command: state mv" -sidebar_current: "docs-commands-state-sub-mv" -description: |- - The `terraform state mv` command changes bindings in Terraform state, associating existing remote objects with new resource instances. +page_title: 'Command: state mv' +description: >- + The `terraform state mv` command changes bindings in Terraform state, + associating existing remote objects with new resource instances. --- # Command: state mv -The main function of [Terraform state](/docs/language/state/index.html) is +The main function of [Terraform state](/language/state) is to track the bindings between resource instance addresses in your configuration and the remote objects they represent. Normally Terraform automatically updates the state in response to actions taken when applying a plan, such as @@ -29,7 +28,7 @@ remote objects currently associated with the source to be tracked instead by the destination. Both the source and destination addresses must use -[resource address syntax](/docs/cli/state/resource-addressing.html), and +[resource address syntax](/cli/state/resource-addressing), and they must both refer to the same kind of object: you can only move a resource instance to another resource instance, a whole module instance to another whole module instance, etc. Furthermore, if you are moving a resource or @@ -45,7 +44,7 @@ object and create a new object at the new address, and so `terraform state mv` allows you to override that interpretation by pre-emptively attaching the existing object to the new address in Terraform. -~> *Warning:* If you are using Terraform in a collaborative environment, you +~> _Warning:_ If you are using Terraform in a collaborative environment, you must ensure that when you are using `terraform state mv` for a code refactoring purpose you communicate carefully with your coworkers to ensure that nobody makes any other changes between your configuration change and your @@ -59,8 +58,8 @@ This command also accepts the following options: address without actually "forgetting" any of them. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -68,23 +67,22 @@ This command also accepts the following options: unit letter, such as "3s" for three seconds. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform state mv` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). -The legacy options [`-backup` and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments) +The legacy options [`-backup` and `-backup-out`](/language/settings/backends/local#command-line-arguments) operate on a local state file only. Configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) -must specify a local state file with the [`-state`](/docs/language/settings/backends/local.html#command-line-arguments) -option in order to use the [`-backup` and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments) +[the `remote` backend](/language/settings/backends/remote) +must specify a local state file with the [`-state`](/language/settings/backends/local#command-line-arguments) +option in order to use the [`-backup` and `-backup-out`](/language/settings/backends/local#command-line-arguments) options. - For configurations using -[the `local` state mv](/docs/language/settings/backends/local.html) only, +[the `local` state mv](/language/settings/backends/local) only, `terraform state mv` also accepts the legacy options -[`-state`, `-state-out`, `-backup`, and `-backup-out`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, `-backup`, and `-backup-out`](/language/settings/backends/local#command-line-arguments). ## Example: Rename a Resource @@ -136,7 +134,7 @@ terraform state mv module.app module.parent.module.app ## Example: Move a Particular Instance of a Resource using `count` -A resource defined with [the `count` meta-argument](/docs/language/meta-arguments/count.html) +A resource defined with [the `count` meta-argument](/language/meta-arguments/count) has multiple instances that are each identified by an integer. You can select a particular instance by including an explicit index in your given address: @@ -161,7 +159,7 @@ The above examples show the typical quoting syntax for Unix-style shells. ## Example: Move a Resource configured with for_each -A resource defined with [the `for_each` meta-argument](/docs/language/meta-arguments/for_each.html) +A resource defined with [the `for_each` meta-argument](/language/meta-arguments/for_each) has multiple instances that are each identified by an string. You can select a particular instance by including an explicit key in your given address. diff --git a/website/docs/cli/commands/state/pull.html.md b/website/docs/cli/commands/state/pull.mdx similarity index 77% rename from website/docs/cli/commands/state/pull.html.md rename to website/docs/cli/commands/state/pull.mdx index ad52c96b6f60..5fc5a7ba3d87 100644 --- a/website/docs/cli/commands/state/pull.html.md +++ b/website/docs/cli/commands/state/pull.mdx @@ -1,15 +1,14 @@ --- -layout: "docs" -page_title: "Command: state pull" -sidebar_current: "docs-commands-state-sub-pull" -description: |- - The `terraform state pull` command is used to manually download and output the state from remote state. +page_title: 'Command: state pull' +description: >- + The `terraform state pull` command is used to manually download and output the + state from remote state. --- # Command: state pull The `terraform state pull` command is used to manually download and output -the state from [remote state](/docs/language/state/remote.html). This command also +the state from [remote state](/language/state/remote). This command also works with local state. ## Usage diff --git a/website/docs/cli/commands/state/push.html.md b/website/docs/cli/commands/state/push.html.md deleted file mode 100644 index 2ba8f21da9f7..000000000000 --- a/website/docs/cli/commands/state/push.html.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: "docs" -page_title: "Command: state push" -sidebar_current: "docs-commands-state-sub-push" -description: |- - The `terraform state push` command pushes items to the Terraform state. ---- - -# Command: state push - -The `terraform state push` command is used to manually upload a local -state file to [remote state](/docs/language/state/remote.html). This command also -works with local state. - -This command should rarely be used. It is meant only as a utility in case -manual intervention is necessary with the remote state. - -## Usage - -Usage: `terraform state push [options] PATH` - -This command will push the state specified by PATH to the currently -configured [backend](/docs/language/settings/backends/index.html). - -If PATH is "-" then the state data to push is read from stdin. This data -is loaded completely into memory and verified prior to being written to -the destination state. - -Terraform will perform a number of safety checks to prevent you from -making changes that appear to be unsafe: - - * **Differing lineage**: If the "lineage" value in the state differs, - Terraform will not allow you to push the state. A differing lineage - suggests that the states are completely different and you may lose - data. - - * **Higher remote serial**: If the "serial" value in the destination state - is higher than the state being pushed, Terraform will prevent the push. - A higher serial suggests that data is in the destination state that isn't - accounted for in the local state being pushed. - -Both of these safety checks can be disabled with the `-force` flag. -**This is not recommended.** If you disable the safety checks and are -pushing state, the destination state will be overwritten. - -For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) -only, `terraform state push` -also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). diff --git a/website/docs/cli/commands/state/push.mdx b/website/docs/cli/commands/state/push.mdx new file mode 100644 index 000000000000..853b53618c00 --- /dev/null +++ b/website/docs/cli/commands/state/push.mdx @@ -0,0 +1,47 @@ +--- +page_title: 'Command: state push' +description: The `terraform state push` command pushes items to the Terraform state. +--- + +# Command: state push + +The `terraform state push` command is used to manually upload a local +state file to [remote state](/language/state/remote). This command also +works with local state. + +This command should rarely be used. It is meant only as a utility in case +manual intervention is necessary with the remote state. + +## Usage + +Usage: `terraform state push [options] PATH` + +This command will push the state specified by PATH to the currently +configured [backend](/language/settings/backends). + +If PATH is "-" then the state data to push is read from stdin. This data +is loaded completely into memory and verified prior to being written to +the destination state. + +Terraform will perform a number of safety checks to prevent you from +making changes that appear to be unsafe: + +- **Differing lineage**: If the "lineage" value in the state differs, + Terraform will not allow you to push the state. A differing lineage + suggests that the states are completely different and you may lose + data. + +- **Higher remote serial**: If the "serial" value in the destination state + is higher than the state being pushed, Terraform will prevent the push. + A higher serial suggests that data is in the destination state that isn't + accounted for in the local state being pushed. + +Both of these safety checks can be disabled with the `-force` flag. +**This is not recommended.** If you disable the safety checks and are +pushing state, the destination state will be overwritten. + +For configurations using +[the `remote` backend](/language/settings/backends/remote) +only, `terraform state push` +also accepts the option +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). diff --git a/website/docs/cli/commands/state/replace-provider.html.md b/website/docs/cli/commands/state/replace-provider.mdx similarity index 65% rename from website/docs/cli/commands/state/replace-provider.html.md rename to website/docs/cli/commands/state/replace-provider.mdx index 21befd99e46c..3c74bd6e722b 100644 --- a/website/docs/cli/commands/state/replace-provider.html.md +++ b/website/docs/cli/commands/state/replace-provider.mdx @@ -1,15 +1,14 @@ --- -layout: "docs" -page_title: "Command: state replace-provider" -sidebar_current: "docs-commands-state-sub-replace-provider" -description: |- - The `terraform state replace-provider` command replaces the provider for resources in the Terraform state. +page_title: 'Command: state replace-provider' +description: >- + The `terraform state replace-provider` command replaces the provider for + resources in the Terraform state. --- # Command: state replace-provider The `terraform state replace-provider` command is used to replace the provider -for resources in a [Terraform state](/docs/language/state/index.html). +for resources in a [Terraform state](/language/state). ## Usage @@ -28,22 +27,21 @@ This command also accepts the following options: * `-auto-approve` - Skip interactive approval. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=0s` - Duration to retry a state lock. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform state replace-provider` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` state rm](/docs/language/settings/backends/local.html) only, +[the `local` state rm](/language/settings/backends/local) only, `terraform state replace-provider` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). - +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Example diff --git a/website/docs/cli/commands/state/rm.html.md b/website/docs/cli/commands/state/rm.mdx similarity index 80% rename from website/docs/cli/commands/state/rm.html.md rename to website/docs/cli/commands/state/rm.mdx index 131c31a815f3..034265767c9b 100644 --- a/website/docs/cli/commands/state/rm.html.md +++ b/website/docs/cli/commands/state/rm.mdx @@ -1,14 +1,13 @@ --- -layout: "docs" -page_title: "Command: state rm" -sidebar_current: "docs-commands-state-sub-rm" -description: |- - The `terraform state rm` command removes bindings from the Terraform state, causing Terraform to "forget about" existing objects. +page_title: 'Command: state rm' +description: >- + The `terraform state rm` command removes bindings from the Terraform state, + causing Terraform to "forget about" existing objects. --- # Command: state rm -The main function of [Terraform state](/docs/language/state/index.html) is +The main function of [Terraform state](/language/state) is to track the bindings between resource instance addresses in your configuration and the remote objects they represent. Normally Terraform automatically updates the state in response to actions taken when applying a plan, such as @@ -24,13 +23,13 @@ to exist in the remote system. Usage: `terraform state rm [options] ADDRESS...` Terraform will search the state for any instances matching the given -[resource address](/docs/cli/state/resource-addressing.html), and remove +[resource address](/cli/state/resource-addressing), and remove the record of each one so that Terraform will no longer be tracking the corresponding remote objects. This means that although the objects will still continue to exist in the remote system, a subsequent -[`terraform plan`](../plan.html) +[`terraform plan`](/cli/commands/plan) will include an action to create a new object for each of the "forgotten" instances. Depending on the constraints imposed by the remote system, creating those objects might fail if their names or other identifiers conflict with @@ -42,8 +41,8 @@ This command also accepts the following options: address without actually "forgetting" any of them. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -51,15 +50,15 @@ This command also accepts the following options: unit letter, such as "3s" for three seconds. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform state rm` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` state rm](/docs/language/settings/backends/local.html) only, +[the `local` state rm](/language/settings/backends/local) only, `terraform state rm` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). ## Example: Remove all Instances of a Resource @@ -94,7 +93,7 @@ $ terraform state rm 'module.foo' ## Example: Remove a Particular Instance of a Resource using `count` -A resource defined with [the `count` meta-argument](/docs/language/meta-arguments/count.html) +A resource defined with [the `count` meta-argument](/language/meta-arguments/count) has multiple instances that are each identified by an integer. You can select a particular instance by including an explicit index in your given address: @@ -109,7 +108,7 @@ The above shows the typical quoting syntax for Unix-style shells. ## Example: Remove a Particular Instance of a Resource using `for_each` -A resource defined with [the `for_each` meta-argument](/docs/language/meta-arguments/for_each.html) +A resource defined with [the `for_each` meta-argument](/language/meta-arguments/for_each) has multiple instances that are each identified by an string. You can select a particular instance by including an explicit key in your given address. diff --git a/website/docs/cli/commands/state/show.html.md b/website/docs/cli/commands/state/show.mdx similarity index 78% rename from website/docs/cli/commands/state/show.html.md rename to website/docs/cli/commands/state/show.mdx index 2c665ba64004..46032ac31fd4 100644 --- a/website/docs/cli/commands/state/show.html.md +++ b/website/docs/cli/commands/state/show.mdx @@ -1,16 +1,15 @@ --- -layout: "docs" -page_title: "Command: state show" -sidebar_current: "docs-commands-state-sub-show" -description: |- - The `terraform state show` command is used to show the attributes of a single resource in the Terraform state. +page_title: 'Command: state show' +description: >- + The `terraform state show` command is used to show the attributes of a single + resource in the Terraform state. --- # Command: state show The `terraform state show` command is used to show the attributes of a single resource in the -[Terraform state](/docs/language/state/index.html). +[Terraform state](/language/state). ## Usage @@ -21,16 +20,16 @@ state file that matches the given address. This command requires an address that points to a single resource in the state. Addresses are -in [resource addressing format](/docs/cli/state/resource-addressing.html). +in [resource addressing format](/cli/state/resource-addressing). The command-line flags are all optional. The list of available flags are: * `-state=path` - Path to the state file. Defaults to "terraform.tfstate". - Ignored when [remote state](/docs/language/state/remote.html) is used. + Ignored when [remote state](/language/state/remote) is used. The output of `terraform state show` is intended for human consumption, not programmatic consumption. To extract state data for use in other software, use -[`terraform show -json`](/docs/cli/commands/show.html#json-output) and decode the result +[`terraform show -json`](/cli/commands/show#json-output) and decode the result using the documented structure. ## Example: Show a Resource @@ -61,7 +60,7 @@ $ terraform state show 'module.foo.packet_device.worker' ## Example: Show a Resource configured with count The example below shows the first instance of a `packet_device` resource named `worker` configured with -[`count`](/docs/language/meta-arguments/count.html): +[`count`](/language/meta-arguments/count): ```shell $ terraform state show 'packet_device.worker[0]' @@ -70,7 +69,7 @@ $ terraform state show 'packet_device.worker[0]' ## Example: Show a Resource configured with for_each The example below shows the `"example"` instance of a `packet_device` resource named `worker` configured with -[`for_each`](/docs/language/meta-arguments/for_each.html): +[`for_each`](/language/meta-arguments/for_each): Linux, Mac OS, and UNIX: diff --git a/website/docs/cli/commands/taint.html.md b/website/docs/cli/commands/taint.mdx similarity index 73% rename from website/docs/cli/commands/taint.html.md rename to website/docs/cli/commands/taint.mdx index aeffa1d7bcdb..f0fcf1b1a39c 100644 --- a/website/docs/cli/commands/taint.html.md +++ b/website/docs/cli/commands/taint.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: taint" -sidebar_current: "docs-commands-taint" +page_title: 'Command: taint' description: |- The `terraform taint` command informs Terraform that a particular object is damaged or degraded. @@ -14,12 +12,12 @@ become degraded or damaged. Terraform represents this by marking the object as "tainted" in the Terraform state, in which case Terraform will propose to replace it in the next plan you create. -~> *Warning:* This command is deprecated, because there are better alternatives +~> _Warning:_ This command is deprecated, because there are better alternatives available in Terraform v0.15.2 and later. See below for more details. If your intent is to force replacement of a particular object even though there are no configuration changes that would require it, we recommend instead -to use the `-replace` option with [`terraform apply`](./apply.html). +to use the `-replace` option with [`terraform apply`](/cli/commands/apply). For example: ``` @@ -44,13 +42,13 @@ Usage: `terraform taint [options] address` The `address` argument is the address of the resource to mark as tainted. The address is in -[the resource address syntax](/docs/cli/state/resource-addressing.html) syntax, +[the resource address syntax](/cli/state/resource-addressing) syntax, as shown in the output from other commands, such as: - * `aws_instance.foo` - * `aws_instance.bar[1]` - * `aws_instance.baz[\"key\"]` (quotes in resource addresses must be escaped on the command line, so that they will not be interpreted by your shell) - * `module.foo.module.bar.aws_instance.qux` +* `aws_instance.foo` +* `aws_instance.bar[1]` +* `aws_instance.baz[\"key\"]` (quotes in resource addresses must be escaped on the command line, so that they will not be interpreted by your shell) +* `module.foo.module.bar.aws_instance.qux` This command accepts the following options: @@ -68,12 +66,12 @@ This command accepts the following options: unit letter, such as "3s" for three seconds. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform taint` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform taint` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). diff --git a/website/docs/cli/commands/test.html.md b/website/docs/cli/commands/test.mdx similarity index 52% rename from website/docs/cli/commands/test.html.md rename to website/docs/cli/commands/test.mdx index 7edd1fb1b6c4..282c2171053f 100644 --- a/website/docs/cli/commands/test.html.md +++ b/website/docs/cli/commands/test.mdx @@ -1,15 +1,12 @@ --- -layout: "docs" -page_title: "Command: test" -sidebar_current: "docs-commands-test" -description: |- - Part of the ongoing design research for module integration testing. +page_title: 'Command: test' +description: Part of the ongoing design research for module integration testing. --- # Command: test The `terraform test` command is currently serving as part of -[the module integration testing experiment](/docs/language/modules/testing-experiment.html). +[the module integration testing experiment](/language/modules/testing-experiment). It's not ready for routine use, but if you'd be interested in trying the prototype functionality then we'd love to hear your feedback. See the diff --git a/website/docs/cli/commands/untaint.html.md b/website/docs/cli/commands/untaint.mdx similarity index 78% rename from website/docs/cli/commands/untaint.html.md rename to website/docs/cli/commands/untaint.mdx index 12793958b81b..85e210a6a3e4 100644 --- a/website/docs/cli/commands/untaint.html.md +++ b/website/docs/cli/commands/untaint.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Command: untaint" -sidebar_current: "docs-commands-untaint" +page_title: 'Command: untaint' description: |- The `terraform untaint` command tells Terraform that an object is functioning correctly, even though its creation failed or it was previously manually @@ -18,7 +16,7 @@ a multi-step "create" action, because Terraform can't be sure that the object was left in a fully-functional state. You can also manually mark an object as "tainted" using the deprecated command -[`terraform taint`](./taint.html), although we no longer recommend that +[`terraform taint`](/cli/commands/taint), although we no longer recommend that workflow. If Terraform currently considers a particular object as tainted but you've @@ -40,7 +38,7 @@ terraform apply -replace="aws_instance.example[0]" Usage: `terraform untaint [options] address` -The `address` argument is a [resource address](/docs/cli/state/resource-addressing.html) +The `address` argument is a [resource address](/cli/state/resource-addressing) identifying a particular resource instance which is currently tainted. This command also accepts the following options: @@ -51,8 +49,8 @@ This command also accepts the following options: the state. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`, instructs Terraform to retry acquiring a lock for a period of time before @@ -64,12 +62,12 @@ This command also accepts the following options: rendered by a system that cannot interpret terminal formatting. For configurations using -[the `remote` backend](/docs/language/settings/backends/remote.html) +[the `remote` backend](/language/settings/backends/remote) only, `terraform untaint` also accepts the option -[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments). +[`-ignore-remote-version`](/language/settings/backends/remote#command-line-arguments). For configurations using -[the `local` backend](/docs/language/settings/backends/local.html) only, +[the `local` backend](/language/settings/backends/local) only, `terraform untaint` also accepts the legacy options -[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments). +[`-state`, `-state-out`, and `-backup`](/language/settings/backends/local#command-line-arguments). diff --git a/website/docs/cli/commands/validate.html.md b/website/docs/cli/commands/validate.mdx similarity index 56% rename from website/docs/cli/commands/validate.html.md rename to website/docs/cli/commands/validate.mdx index e81da01b27a4..fbbb03971699 100644 --- a/website/docs/cli/commands/validate.html.md +++ b/website/docs/cli/commands/validate.mdx @@ -1,9 +1,8 @@ --- -layout: "docs" -page_title: "Command: validate" -sidebar_current: "docs-commands-validate" -description: |- - The `terraform validate` command is used to validate the syntax of the terraform files. +page_title: 'Command: validate' +description: >- + The `terraform validate` command is used to validate the syntax of the + terraform files. --- # Command: validate @@ -39,11 +38,11 @@ Usage: `terraform validate [options]` This command accepts the following options: -- `-json` - Produce output in a machine-readable JSON format, suitable for +* `-json` - Produce output in a machine-readable JSON format, suitable for use in text editor integrations and other automated systems. Always disables color. -- `-no-color` - If specified, output won't contain any color. +* `-no-color` - If specified, output won't contain any color. ## JSON Output Format @@ -60,15 +59,15 @@ JSON, which it should then treat as a generic error case. The output includes a `format_version` key, which as of Terraform 1.1.0 has value `"1.0"`. The semantics of this version are: -- We will increment the minor version, e.g. `"1.1"`, for backward-compatible +* We will increment the minor version, e.g. `"1.1"`, for backward-compatible changes or additions. Ignore any object properties with unrecognized names to remain forward-compatible with future minor versions. -- We will increment the major version, e.g. `"2.0"`, for changes that are not +* We will increment the major version, e.g. `"2.0"`, for changes that are not backward-compatible. Reject any input which reports an unsupported major version. We will introduce new major versions only within the bounds of -[the Terraform 1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html). +[the Terraform 1.0 Compatibility Promises](/language/v1-compatibility-promises). In the normal case, Terraform will print a JSON object to the standard output stream. The top-level JSON object will have the following properties: @@ -95,93 +94,93 @@ The nested objects in `diagnostics` have the following properties: * `severity` (string): A string keyword, currently either `"error"` or `"warning"`, indicating the diagnostic severity. - The presence of errors causes Terraform to consider a configuration to be - invalid, while warnings are just advice or caveats to the user which do not - block working with the configuration. Later versions of Terraform may - introduce new severity keywords, so consumers should be prepared to accept - and ignore severity values they don't understand. + The presence of errors causes Terraform to consider a configuration to be + invalid, while warnings are just advice or caveats to the user which do not + block working with the configuration. Later versions of Terraform may + introduce new severity keywords, so consumers should be prepared to accept + and ignore severity values they don't understand. * `summary` (string): A short description of the nature of the problem that the diagnostic is reporting. - In Terraform's usual human-oriented diagnostic messages, the summary serves - as a sort of "heading" for the diagnostic, printed after the "Error:" or - "Warning:" indicator. + In Terraform's usual human-oriented diagnostic messages, the summary serves + as a sort of "heading" for the diagnostic, printed after the "Error:" or + "Warning:" indicator. - Summaries are typically short, single sentences, but can sometimes be longer - as a result of returning errors from subsystems that are not designed to - return full diagnostics, where the entire error message therefore becomes the - summary. In those cases, the summary might include newline characters which - a renderer should honor when presenting the message visually to a user. + Summaries are typically short, single sentences, but can sometimes be longer + as a result of returning errors from subsystems that are not designed to + return full diagnostics, where the entire error message therefore becomes the + summary. In those cases, the summary might include newline characters which + a renderer should honor when presenting the message visually to a user. * `detail` (string): An optional additional message giving more detail about the problem. - In Terraform's usual human-oriented diagnostic messages, the detail provides - the paragraphs of text that appear after the heading and the source location - reference. - - Detail messages are often multiple paragraphs and possibly interspersed with - non-paragraph lines, so tools which aim to present detail messages to the - user should distinguish between lines without leading spaces, treating them - as paragraphs, and lines with leading spaces, treating them as preformatted - text. Renderers should then soft-wrap the paragraphs to fit the width of the - rendering container, but leave the preformatted lines unwrapped. - - Some Terraform detail messages currently contain an approximation of bullet - lists using ASCII characters to mark the bullets. This is not currently a - contractural formatting convention and so renderers should avoid depending on - it and should instead treat those lines as either paragraphs or preformatted - text per the rules above. A future version of this format may define some - additional rules for processing other text conventions, but will do so within - the bounds of the rules above to achieve backward-compatibility. + In Terraform's usual human-oriented diagnostic messages, the detail provides + the paragraphs of text that appear after the heading and the source location + reference. + + Detail messages are often multiple paragraphs and possibly interspersed with + non-paragraph lines, so tools which aim to present detail messages to the + user should distinguish between lines without leading spaces, treating them + as paragraphs, and lines with leading spaces, treating them as preformatted + text. Renderers should then soft-wrap the paragraphs to fit the width of the + rendering container, but leave the preformatted lines unwrapped. + + Some Terraform detail messages currently contain an approximation of bullet + lists using ASCII characters to mark the bullets. This is not currently a + contractural formatting convention and so renderers should avoid depending on + it and should instead treat those lines as either paragraphs or preformatted + text per the rules above. A future version of this format may define some + additional rules for processing other text conventions, but will do so within + the bounds of the rules above to achieve backward-compatibility. * `range` (object): An optional object referencing a portion of the configuration source code that the diagnostic message relates to. For errors, this will typically indicate the bounds of the specific block header, attribute, or expression which was detected as invalid. - A source range is an object with a property `filename` which gives the - filename as a relative path from the current working directory, and then - two properties `start` and `end` which are both themselves objects - describing source positions, as described below. + A source range is an object with a property `filename` which gives the + filename as a relative path from the current working directory, and then + two properties `start` and `end` which are both themselves objects + describing source positions, as described below. - Not all diagnostic messages are connected with specific portions of the - configuration, so `range` will be omitted or `null` for diagnostic messages - where it isn't relevant. + Not all diagnostic messages are connected with specific portions of the + configuration, so `range` will be omitted or `null` for diagnostic messages + where it isn't relevant. * `snippet` (object): An optional object including an excerpt of the configuration source code that the diagnostic message relates to. - The snippet information includes: + The snippet information includes: - * `context` (string): An optional summary of the root context of the - diagnostic. For example, this might be the resource block containing the - expression which triggered the diagnostic. For some diagnostics this - information is not available, and then this property will be `null`. + * `context` (string): An optional summary of the root context of the + diagnostic. For example, this might be the resource block containing the + expression which triggered the diagnostic. For some diagnostics this + information is not available, and then this property will be `null`. - * `code` (string): A snippet of Terraform configuration including the - source of the diagnostic. This can be multiple lines and may include - additional configuration source code around the expression which - triggered the diagnostic. + * `code` (string): A snippet of Terraform configuration including the + source of the diagnostic. This can be multiple lines and may include + additional configuration source code around the expression which + triggered the diagnostic. - * `start_line` (number): A one-based line count representing the position - in the source file at which the `code` excerpt begins. This is not - necessarily the same value as `range.start.line`, as it is possible for - `code` to include one or more lines of context before the source of the - diagnostic. + * `start_line` (number): A one-based line count representing the position + in the source file at which the `code` excerpt begins. This is not + necessarily the same value as `range.start.line`, as it is possible for + `code` to include one or more lines of context before the source of the + diagnostic. - * `highlight_start_offset` (number): A zero-based character offset into the - `code` string, pointing at the start of the expression which triggered - the diagnostic. + * `highlight_start_offset` (number): A zero-based character offset into the + `code` string, pointing at the start of the expression which triggered + the diagnostic. - * `highlight_end_offset` (number): A zero-based character offset into the - `code` string, pointing at the end of the expression which triggered the - diagnostic. + * `highlight_end_offset` (number): A zero-based character offset into the + `code` string, pointing at the end of the expression which triggered the + diagnostic. - * `values` (array of objects): Contains zero or more expression values - which may be useful in understanding the source of a diagnostic in a - complex expression. These expression value objects are described below. + * `values` (array of objects): Contains zero or more expression values + which may be useful in understanding the source of a diagnostic in a + complex expression. These expression value objects are described below. ### Source Position diff --git a/website/docs/cli/commands/version.html.md b/website/docs/cli/commands/version.mdx similarity index 75% rename from website/docs/cli/commands/version.html.md rename to website/docs/cli/commands/version.mdx index 91798380180f..bcfa5f0b76af 100644 --- a/website/docs/cli/commands/version.html.md +++ b/website/docs/cli/commands/version.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Command: version" -sidebar_current: "docs-commands-version" -description: "The terraform version command displays the Terraform version and the version of all installed plugins." +page_title: 'Command: version' +description: >- + The terraform version command displays the Terraform version and the version + of all installed plugins. --- # Command: version @@ -16,12 +16,12 @@ Usage: `terraform version [options]` With no additional arguments, `version` will display the version of Terraform, the platform it's installed on, installed providers, and the results of upgrade -and security checks [unless disabled](/docs/cli/commands/index.html#upgrade-and-security-bulletin-checks). +and security checks [unless disabled](/cli/commands#upgrade-and-security-bulletin-checks). This command has one optional flag: * `-json` - If specified, the version information is formatted as a JSON object, - and no upgrade or security information is included. + and no upgrade or security information is included. -> **Note:** Platform information was added to the `version` command in Terraform 0.15. @@ -51,4 +51,4 @@ $ terraform version -json }, "terraform_outdated": true } -``` \ No newline at end of file +``` diff --git a/website/docs/cli/commands/workspace/delete.html.md b/website/docs/cli/commands/workspace/delete.mdx similarity index 81% rename from website/docs/cli/commands/workspace/delete.html.md rename to website/docs/cli/commands/workspace/delete.mdx index 3fd077631cf0..cadfa6459e9c 100644 --- a/website/docs/cli/commands/workspace/delete.html.md +++ b/website/docs/cli/commands/workspace/delete.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace delete" -sidebar_current: "docs-commands-workspace-sub-delete" -description: |- - The terraform workspace delete command is used to delete a workspace. +page_title: 'Command: workspace delete' +description: The terraform workspace delete command is used to delete a workspace. --- # Command: workspace delete @@ -31,8 +28,8 @@ The command-line flags are all optional. The only supported flag is: * `-force` - Delete the workspace even if its state is not empty. Defaults to false. * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Duration to retry a state lock. Default 0s. ## Example diff --git a/website/docs/cli/commands/workspace/index.html.md b/website/docs/cli/commands/workspace/index.mdx similarity index 60% rename from website/docs/cli/commands/workspace/index.html.md rename to website/docs/cli/commands/workspace/index.mdx index 6237a4133fc7..2d67b1d7c550 100644 --- a/website/docs/cli/commands/workspace/index.html.md +++ b/website/docs/cli/commands/workspace/index.mdx @@ -1,15 +1,12 @@ --- -layout: "docs" -page_title: "Command: workspace" -sidebar_current: "docs-commands-workspace-index" -description: "The workspace command helps you manage workspaces." - +page_title: 'Command: workspace' +description: The workspace command helps you manage workspaces. --- # Command: workspace The `terraform workspace` command is used to manage -[workspaces](/docs/language/state/workspaces.html). +[workspaces](/language/state/workspaces). This command is a container for further subcommands. These subcommands are listed in the navigation bar. diff --git a/website/docs/cli/commands/workspace/list.html.md b/website/docs/cli/commands/workspace/list.mdx similarity index 64% rename from website/docs/cli/commands/workspace/list.html.md rename to website/docs/cli/commands/workspace/list.mdx index 2114a60c66d7..d7d2e6eee285 100644 --- a/website/docs/cli/commands/workspace/list.html.md +++ b/website/docs/cli/commands/workspace/list.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace list" -sidebar_current: "docs-commands-workspace-sub-list" -description: |- - The terraform workspace list command is used to list all existing workspaces. +page_title: 'Command: workspace list' +description: The terraform workspace list command is used to list all existing workspaces. --- # Command: workspace list diff --git a/website/docs/cli/commands/workspace/new.html.md b/website/docs/cli/commands/workspace/new.mdx similarity index 83% rename from website/docs/cli/commands/workspace/new.html.md rename to website/docs/cli/commands/workspace/new.mdx index ef2e73ecf47d..28b4d1c30d4e 100644 --- a/website/docs/cli/commands/workspace/new.html.md +++ b/website/docs/cli/commands/workspace/new.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace new" -sidebar_current: "docs-commands-workspace-sub-new" -description: |- - The terraform workspace new command is used to create a new workspace. +page_title: 'Command: workspace new' +description: The terraform workspace new command is used to create a new workspace. --- # Command: workspace new @@ -23,8 +20,8 @@ will be copied to initialize the state for this new workspace. The command-line flags are all optional. The supported flags are: * `-lock=false` - Don't hold a state lock during the operation. This is - dangerous if others might concurrently run commands against the same - workspace. + dangerous if others might concurrently run commands against the same + workspace. * `-lock-timeout=DURATION` - Duration to retry a state lock. Default 0s. * `-state=path` - Path to an existing state file to initialize the state of this environment. diff --git a/website/docs/cli/commands/workspace/select.html.md b/website/docs/cli/commands/workspace/select.mdx similarity index 69% rename from website/docs/cli/commands/workspace/select.html.md rename to website/docs/cli/commands/workspace/select.mdx index 08170a61eff6..f22f7aabeb6c 100644 --- a/website/docs/cli/commands/workspace/select.html.md +++ b/website/docs/cli/commands/workspace/select.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace select" -sidebar_current: "docs-commands-workspace-sub-select" -description: |- - The terraform workspace select command is used to choose a workspace. +page_title: 'Command: workspace select' +description: The terraform workspace select command is used to choose a workspace. --- # Command: workspace select diff --git a/website/docs/cli/commands/workspace/show.html.md b/website/docs/cli/commands/workspace/show.mdx similarity index 57% rename from website/docs/cli/commands/workspace/show.html.md rename to website/docs/cli/commands/workspace/show.mdx index 7cd7d5b5d140..c6063f22fddc 100644 --- a/website/docs/cli/commands/workspace/show.html.md +++ b/website/docs/cli/commands/workspace/show.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Command: workspace show" -sidebar_current: "docs-commands-workspace-sub-show" -description: |- - The terraform workspace show command is used to output the current workspace. +page_title: 'Command: workspace show' +description: The terraform workspace show command is used to output the current workspace. --- # Command: workspace show diff --git a/website/docs/cli/config/config-file.html.md b/website/docs/cli/config/config-file.mdx similarity index 86% rename from website/docs/cli/config/config-file.html.md rename to website/docs/cli/config/config-file.mdx index 1aa83c40ef2b..6e97aee35023 100644 --- a/website/docs/cli/config/config-file.html.md +++ b/website/docs/cli/config/config-file.mdx @@ -1,15 +1,15 @@ --- -layout: "docs" -page_title: "CLI Configuration" -sidebar_current: "docs-commands-cli-config" -description: "Learn to use the CLI configuration file to customize your CLI settings, including credentials, plugin caching, provider installation methods, etc." +page_title: CLI Configuration +description: >- + Learn to use the CLI configuration file to customize your CLI settings, + including credentials, plugin caching, provider installation methods, etc. --- # CLI Configuration File (`.terraformrc` or `terraform.rc`) The CLI configuration file configures per-user settings for CLI behaviors, which apply across all Terraform working directories. This is separate from -[your infrastructure configuration](/docs/language/index.html). +[your infrastructure configuration](/language). ## Locations @@ -31,7 +31,7 @@ as just `terraform.rc`. Use `dir` from PowerShell or Command Prompt to confirm the filename. The location of the Terraform CLI configuration file can also be specified -using the `TF_CLI_CONFIG_FILE` [environment variable](/docs/cli/config/environment-variables.html). +using the `TF_CLI_CONFIG_FILE` [environment variable](/cli/config/environment-variables). Any such file should follow the naming pattern `*.tfrc`. ## Configuration File Syntax @@ -50,38 +50,38 @@ disable_checkpoint = true The following settings can be set in the CLI configuration file: -- `credentials` - configures credentials for use with Terraform Cloud or +* `credentials` - configures credentials for use with Terraform Cloud or Terraform Enterprise. See [Credentials](#credentials) below for more information. -- `credentials_helper` - configures an external helper program for the storage +* `credentials_helper` - configures an external helper program for the storage and retrieval of credentials for Terraform Cloud or Terraform Enterprise. See [Credentials Helpers](#credentials-helpers) below for more information. -- `disable_checkpoint` — when set to `true`, disables - [upgrade and security bulletin checks](/docs/cli/commands/index.html#upgrade-and-security-bulletin-checks) +* `disable_checkpoint` — when set to `true`, disables + [upgrade and security bulletin checks](/cli/commands#upgrade-and-security-bulletin-checks) that require reaching out to HashiCorp-provided network services. -- `disable_checkpoint_signature` — when set to `true`, allows the upgrade and +* `disable_checkpoint_signature` — when set to `true`, allows the upgrade and security bulletin checks described above but disables the use of an anonymous id used to de-duplicate warning messages. -- `plugin_cache_dir` — enables +* `plugin_cache_dir` — enables [plugin caching](#provider-plugin-cache) and specifies, as a string, the location of the plugin cache directory. -- `provider_installation` - customizes the installation methods used by +* `provider_installation` - customizes the installation methods used by `terraform init` when installing provider plugins. See [Provider Installation](#provider-installation) below for more information. ## Credentials -[Terraform Cloud](/docs/cloud/index.html) provides a number of remote network +[Terraform Cloud](/cloud) provides a number of remote network services for use with Terraform, and -[Terraform Enterprise](/docs/enterprise/index.html) allows hosting those +[Terraform Enterprise](/enterprise) allows hosting those services inside your own infrastructure. For example, these systems offer both -[remote operations](/docs/cloud/run/cli.html) and a -[private module registry](/docs/cloud/registry/index.html). +[remote operations](/cloud-docs/run/cli) and a +[private module registry](/cloud-docs/registry). When interacting with Terraform-specific network services, Terraform expects to find API tokens in CLI configuration files in `credentials` blocks: @@ -92,7 +92,7 @@ credentials "app.terraform.io" { } ``` -If you are running the Terraform CLI interactively on a computer with a web browser, you can use [the `terraform login` command](/docs/cli/commands/login.html) +If you are running the Terraform CLI interactively on a computer with a web browser, you can use [the `terraform login` command](/cli/commands/login) to get credentials and automatically save them in the CLI configuration. If not, you can manually write `credentials` blocks. @@ -104,9 +104,9 @@ giving the API token to use for that host. ~> **Important:** If you are using Terraform Cloud or Terraform Enterprise, the token provided must be either a -[user token](/docs/cloud/users-teams-organizations/users.html#api-tokens) +[user token](/cloud-docs/users-teams-organizations/users#api-tokens) or a -[team token](/docs/cloud/users-teams-organizations/api-tokens.html#team-api-tokens); +[team token](/cloud-docs/users-teams-organizations/api-tokens#team-api-tokens); organization tokens cannot be used for command-line Terraform actions. -> **Note:** The credentials hostname must match the hostname in your module @@ -144,7 +144,7 @@ for a specific hostname by writing a `credentials` block alongside the Terraform does not include any credentials helpers in the main distribution. To learn how to write and install your own credentials helpers to integrate with existing in-house credentials management systems, see -[the guide to Credentials Helper internals](/docs/internals/credentials-helpers.html). +[the guide to Credentials Helper internals](/internals/credentials-helpers). ## Provider Installation @@ -216,36 +216,36 @@ The following are the two supported installation method types: providers. This method requires the additional argument `path` to indicate which directory to look in. - Terraform expects the given directory to contain a nested directory structure - where the path segments together provide metadata about the available - providers. The following two directory structures are supported: + Terraform expects the given directory to contain a nested directory structure + where the path segments together provide metadata about the available + providers. The following two directory structures are supported: - * Packed layout: `HOSTNAME/NAMESPACE/TYPE/terraform-provider-TYPE_VERSION_TARGET.zip` - is the distribution zip file obtained from the provider's origin registry. - * Unpacked layout: `HOSTNAME/NAMESPACE/TYPE/VERSION/TARGET` is a directory - containing the result of extracting the provider's distribution zip file. + * Packed layout: `HOSTNAME/NAMESPACE/TYPE/terraform-provider-TYPE_VERSION_TARGET.zip` + is the distribution zip file obtained from the provider's origin registry. + * Unpacked layout: `HOSTNAME/NAMESPACE/TYPE/VERSION/TARGET` is a directory + containing the result of extracting the provider's distribution zip file. - In both layouts, the `VERSION` is a string like `2.0.0` and the `TARGET` - specifies a particular target platform using a format like `darwin_amd64`, - `linux_arm`, `windows_amd64`, etc. + In both layouts, the `VERSION` is a string like `2.0.0` and the `TARGET` + specifies a particular target platform using a format like `darwin_amd64`, + `linux_arm`, `windows_amd64`, etc. - If you use the unpacked layout, Terraform will attempt to create a symbolic - link to the mirror directory when installing the provider, rather than - creating a deep copy of the directory. The packed layout prevents this - because Terraform must extract the zip file during installation. + If you use the unpacked layout, Terraform will attempt to create a symbolic + link to the mirror directory when installing the provider, rather than + creating a deep copy of the directory. The packed layout prevents this + because Terraform must extract the zip file during installation. - You can include multiple `filesystem_mirror` blocks in order to specify - several different directories to search. + You can include multiple `filesystem_mirror` blocks in order to specify + several different directories to search. * `network_mirror`: consult a particular HTTPS server for copies of providers, regardless of which registry host they belong to. This method requires the additional argument `url` to indicate the mirror base URL, which should use the `https:` scheme and end with a trailing slash. - Terraform expects the given URL to be a base URL for an implementation of - [the provider network mirror protocol](/docs/internals/provider-network-mirror-protocol.html), - which is designed to be relatively easy to implement using typical static - website hosting mechanisms. + Terraform expects the given URL to be a base URL for an implementation of + [the provider network mirror protocol](/internals/provider-network-mirror-protocol), + which is designed to be relatively easy to implement using typical static + website hosting mechanisms. ~> **Warning:** Don't configure `network_mirror` URLs that you do not trust. Provider mirror servers are subject to TLS certificate checks to verify @@ -402,7 +402,7 @@ provider_installation { With development overrides in effect, the `terraform init` command will still attempt to select a suitable published version of your provider to install and record in -[the dependency lock file](/docs/language/dependency-lock.html) +[the dependency lock file](/language/files/dependency-lock) for future use, but other commands like `terraform apply` will disregard the lock file's entry for `hashicorp/null` and will use the given directory instead. Once your new changes are included in a diff --git a/website/docs/cli/config/environment-variables.html.md b/website/docs/cli/config/environment-variables.mdx similarity index 88% rename from website/docs/cli/config/environment-variables.html.md rename to website/docs/cli/config/environment-variables.mdx index 55997e97ea34..ffe749ec6a59 100644 --- a/website/docs/cli/config/environment-variables.html.md +++ b/website/docs/cli/config/environment-variables.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Environment Variables" -sidebar_current: "docs-commands-environment-variables" -description: "Learn to use environment variables to change Terraform's default behavior. Configure log content and output, set variables, and more." +page_title: Environment Variables +description: >- + Learn to use environment variables to change Terraform's default behavior. + Configure log content and output, set variables, and more. --- # Environment Variables @@ -27,7 +27,7 @@ To disable, either unset it, or set it to `off`. For example: export TF_LOG=off ``` -For more on debugging Terraform, check out the section on [Debugging](/docs/internals/debugging.html). +For more on debugging Terraform, check out the section on [Debugging](/internals/debugging). ## TF_LOG_PATH @@ -37,7 +37,7 @@ This specifies where the log should persist its output to. Note that even when ` export TF_LOG_PATH=./terraform.log ``` -For more on debugging Terraform, check out the section on [Debugging](/docs/internals/debugging.html). +For more on debugging Terraform, check out the section on [Debugging](/internals/debugging). ## TF_INPUT @@ -58,9 +58,10 @@ export TF_VAR_alist='[1,2,3]' export TF_VAR_amap='{ foo = "bar", baz = "qux" }' ``` -For more on how to use `TF_VAR_name` in context, check out the section on [Variable Configuration](/docs/language/values/variables.html). +For more on how to use `TF_VAR_name` in context, check out the section on [Variable Configuration](/language/values/variables). ## TF_CLI_ARGS and TF_CLI_ARGS_name + The value of `TF_CLI_ARGS` will specify additional arguments to the @@ -113,8 +114,7 @@ export TF_WORKSPACE=your_workspace Using this environment variable is recommended only for non-interactive usage, since in a local shell environment it can be easy to forget the variable is set and apply changes to the wrong state. -For more information regarding workspaces, check out the section on [Using Workspaces] -(https://www.terraform.io/docs/language/state/workspaces.html). +For more information regarding workspaces, check out the section on [Using Workspaces](/language/state/workspaces). ## TF_IN_AUTOMATION @@ -145,7 +145,7 @@ export TF_REGISTRY_CLIENT_TIMEOUT=15 ## TF_CLI_CONFIG_FILE -The location of the [Terraform CLI configuration file](/docs/cli/config/config-file.html). +The location of the [Terraform CLI configuration file](/cli/config/config-file). ```shell export TF_CLI_CONFIG_FILE="$HOME/.terraformrc-custom" @@ -159,4 +159,4 @@ If `TF_IGNORE` is set to "trace", Terraform will output debug messages to displa export TF_IGNORE=trace ``` -For more details on `.terraformignore`, please see [Excluding Files from Upload with .terraformignore](/docs/language/settings/backends/remote.html#excluding-files-from-upload-with-terraformignore). +For more details on `.terraformignore`, please see [Excluding Files from Upload with .terraformignore](/language/settings/backends/remote#excluding-files-from-upload-with-terraformignore). diff --git a/website/docs/cli/config/index.html.md b/website/docs/cli/config/index.mdx similarity index 68% rename from website/docs/cli/config/index.html.md rename to website/docs/cli/config/index.mdx index afe00e8f2fb8..188e7ad61475 100644 --- a/website/docs/cli/config/index.html.md +++ b/website/docs/cli/config/index.mdx @@ -1,7 +1,8 @@ --- -layout: "docs" -page_title: "CLI Configuration - Terraform CLI" -description: "Find documentation about the CLI config file and customizing Terraform environment variables." +page_title: CLI Configuration - Terraform CLI +description: >- + Find documentation about the CLI config file and customizing Terraform + environment variables. --- # CLI Configuration @@ -15,9 +16,9 @@ most of the global settings relate to advanced or automated workflows, or unusual environmental conditions like running Terraform on an airgapped instance. -- The [CLI config file](/docs/cli/config/config-file.html) configures provider +- The [CLI config file](/cli/config/config-file) configures provider installation and security features. -- Several [environment variables](/docs/cli/config/environment-variables.html) can +- Several [environment variables](/cli/config/environment-variables) can configure Terraform's inputs and outputs; this includes some alternate ways to provide information that is usually passed on the command line or read from the state of the shell. diff --git a/website/docs/cli/import/importability.html.md b/website/docs/cli/import/importability.mdx similarity index 82% rename from website/docs/cli/import/importability.html.md rename to website/docs/cli/import/importability.mdx index 79d78d90a2e6..88a200a4e1ad 100644 --- a/website/docs/cli/import/importability.html.md +++ b/website/docs/cli/import/importability.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Import: Resource Importability" -sidebar_current: "docs-import-importability" +page_title: 'Import: Resource Importability' description: |- Each resource in Terraform must implement some basic logic to become importable. As a result, not all Terraform resources are currently importable. @@ -21,4 +19,4 @@ you're interested in contributing that functionality, the Terraform team would be grateful. To make a resource importable, please see -[Extending Terraform: Resources — Import](/docs/extend/resources/import.html). +[Extending Terraform: Resources — Import](/plugin/sdkv2/resources/import). diff --git a/website/docs/cli/import/index.html.md b/website/docs/cli/import/index.mdx similarity index 81% rename from website/docs/cli/import/index.html.md rename to website/docs/cli/import/index.mdx index b06c668fc0df..3ff3417498fd 100644 --- a/website/docs/cli/import/index.html.md +++ b/website/docs/cli/import/index.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Import" -sidebar_current: "docs-import" -description: "Terraform can import and manage existing infrastructure. This can help you transition your infrastructure to Terraform." +page_title: Import +description: >- + Terraform can import and manage existing infrastructure. This can help you + transition your infrastructure to Terraform. --- # Import @@ -23,12 +23,12 @@ itself having created all objects. If you import existing objects into Terraform be careful to import each remote object to only one Terraform resource address. If you import the same object multiple times, Terraform may exhibit unwanted behavior. For more information on this assumption, see -[the State section](/docs/language/state/index.html). +[the State section](/language/state). ## Currently State Only The current implementation of Terraform import can only import resources -into the [state](/docs/language/state/index.html). It does not generate configuration. A future +into the [state](/language/state). It does not generate configuration. A future version of Terraform will also generate configuration. Because of this, prior to running `terraform import` it is necessary to write @@ -41,7 +41,7 @@ importing existing resources. ## Remote Backends When using Terraform import on the command line with a [remote -backend](/docs/language/settings/backends/remote.html), such as Terraform Cloud, the import +backend](/language/settings/backends/remote), such as Terraform Cloud, the import command runs locally, unlike commands such as apply, which run inside your Terraform Cloud environment. Because of this, the import command will not have access to information from the remote backend, such as workspace variables. diff --git a/website/docs/cli/import/usage.html.md b/website/docs/cli/import/usage.mdx similarity index 90% rename from website/docs/cli/import/usage.html.md rename to website/docs/cli/import/usage.mdx index 4fdc5452d02e..e5d448990ba8 100644 --- a/website/docs/cli/import/usage.html.md +++ b/website/docs/cli/import/usage.mdx @@ -1,9 +1,6 @@ --- -layout: "docs" -page_title: "Import: Usage" -sidebar_current: "docs-import-usage" -description: |- - The `terraform import` command is used to import existing infrastructure. +page_title: 'Import: Usage' +description: The `terraform import` command is used to import existing infrastructure. --- # Import Usage @@ -23,7 +20,7 @@ itself having created all objects. If you import existing objects into Terraform be careful to import each remote object to only one Terraform resource address. If you import the same object multiple times, Terraform may exhibit unwanted behavior. For more information on this assumption, see -[the State section](/docs/language/state/index.html). +[the State section](/language/state). To import a resource, first write a resource block for it in your configuration, establishing the name by which it will be known to Terraform: @@ -57,7 +54,7 @@ Terraform state. It is also possible to import to resources in child modules, using their paths, and to single instances of a resource with `count` or `for_each` set. See -[_Resource Addressing_](/docs/cli/state/resource-addressing.html) for more +[_Resource Addressing_](/cli/state/resource-addressing) for more details on how to specify a target resource. The syntax of the given ID is dependent on the resource type being imported. @@ -83,4 +80,4 @@ a `resource` block in configuration for each secondary resource. If this is not done, Terraform will plan to destroy the imported objects on the next run. If you want to rename or otherwise move the imported resources, the -[state management commands](/docs/cli/commands/state/index.html) can be used. +[state management commands](/cli/commands/state) can be used. diff --git a/website/docs/cli/index.html.md b/website/docs/cli/index.mdx similarity index 67% rename from website/docs/cli/index.html.md rename to website/docs/cli/index.mdx index f52fb1bc5e9a..e59efd750eea 100644 --- a/website/docs/cli/index.html.md +++ b/website/docs/cli/index.mdx @@ -1,8 +1,8 @@ --- -layout: "docs" -page_title: "Terraform CLI Documentation" -sidebar_current: "docs-home" -description: "Learn how to use Terraform's CLI-based workflows. You can use the CLI alone or in conjunction with Terraform Cloud or Terraform Enterprise." +page_title: Terraform CLI Documentation +description: >- + Learn how to use Terraform's CLI-based workflows. You can use the CLI alone or + in conjunction with Terraform Cloud or Terraform Enterprise. --- # Terraform CLI Documentation @@ -16,4 +16,4 @@ Cloud or Terraform Enterprise. Notably, this documentation does not cover the syntax and usage of the Terraform language. For that, see the -[Terraform Language Documentation](/docs/language/index.html). +[Terraform Language Documentation](/language). diff --git a/website/docs/cli/init/index.html.md b/website/docs/cli/init/index.mdx similarity index 85% rename from website/docs/cli/init/index.html.md rename to website/docs/cli/init/index.mdx index 1fc581e3f235..133527e9712a 100644 --- a/website/docs/cli/init/index.html.md +++ b/website/docs/cli/init/index.mdx @@ -1,14 +1,16 @@ --- -layout: "docs" -page_title: "Initializing Working Directories - Terraform CLI" -description: "Working directories contain configurations, settings, cached plugins and modules, and state data. Learn how to initialize and manage working directories." +page_title: Initializing Working Directories - Terraform CLI +description: >- + Working directories contain configurations, settings, cached plugins and + modules, and state data. Learn how to initialize and manage working + directories. --- # Initializing Working Directories Terraform expects to be invoked from a working directory that contains configuration files written in -[the Terraform language](/docs/language/index.html). Terraform uses +[the Terraform language](/language). Terraform uses configuration content from this directory, and also uses the directory to store settings, cached plugins and modules, and sometimes state data. @@ -23,7 +25,7 @@ A Terraform working directory typically contains: configuration is expected to change over time. - A hidden `.terraform` directory, which Terraform uses to manage cached provider plugins and modules, record which - [workspace](/docs/cli/workspaces/index.html) is currently active, and + [workspace](/cli/workspaces) is currently active, and record the last known backend configuration in case it needs to migrate state on the next run. This directory is automatically managed by Terraform, and is created during initialization. @@ -48,7 +50,7 @@ plugins, and downloading modules. Under some conditions (usually when changing from one backend to another), it might ask the user for guidance or confirmation. -For details, see [the `terraform init` command](/docs/cli/commands/init.html). +For details, see [the `terraform init` command](/cli/commands/init). ## Reinitialization diff --git a/website/docs/cli/inspect/index.html.md b/website/docs/cli/inspect/index.mdx similarity index 63% rename from website/docs/cli/inspect/index.html.md rename to website/docs/cli/inspect/index.mdx index 3fac82ed52b1..2337764dea52 100644 --- a/website/docs/cli/inspect/index.html.md +++ b/website/docs/cli/inspect/index.mdx @@ -1,7 +1,8 @@ --- -layout: "docs" -page_title: "Inspecting Infrastructure - Terraform CLI" -description: "Learn commands to inspect dependency information, outputs, etc. Use them for integration or to understand your infrastructure." +page_title: Inspecting Infrastructure - Terraform CLI +description: >- + Learn commands to inspect dependency information, outputs, etc. Use them for + integration or to understand your infrastructure. --- # Inspecting Infrastructure @@ -16,19 +17,19 @@ Terraform CLI includes some commands for inspecting or transforming this data. You can use these to integrate other tools with Terraform's infrastructure data, or just to gain a deeper or more holistic understanding of your infrastructure. -- [The `terraform graph` command](/docs/cli/commands/graph.html) creates a visual +- [The `terraform graph` command](/cli/commands/graph) creates a visual representation of a configuration or a set of planned changes. -- [The `terraform output` command](/docs/cli/commands/output.html) can get the - values for the top-level [output values](/docs/language/values/outputs.html) of +- [The `terraform output` command](/cli/commands/output) can get the + values for the top-level [output values](/language/values/outputs) of a configuration, which are often helpful when making use of the infrastructure Terraform has provisioned. -- [The `terraform show` command](/docs/cli/commands/show.html) can generate +- [The `terraform show` command](/cli/commands/show) can generate human-readable versions of a state file or plan file, or generate machine-readable versions that can be integrated with other tools. -- [The `terraform state list` command](/docs/cli/commands/state/list.html) can list +- [The `terraform state list` command](/cli/commands/state/list) can list the resources being managed by the current working directory and workspace, providing a complete or filtered list. -- [The `terraform state show` command](/docs/cli/commands/state/show.html) can print +- [The `terraform state show` command](/cli/commands/state/show) can print all of the attributes of a given resource being managed by the current working directory and workspace, including generated read-only attributes like the unique ID assigned by the cloud provider. diff --git a/website/docs/cli/install/apt.html.md b/website/docs/cli/install/apt.mdx similarity index 93% rename from website/docs/cli/install/apt.html.md rename to website/docs/cli/install/apt.mdx index 88cf58fb2d9b..fff3cdf2f40f 100644 --- a/website/docs/cli/install/apt.html.md +++ b/website/docs/cli/install/apt.mdx @@ -1,9 +1,8 @@ --- -layout: "downloads" -page_title: "APT Packages for Debian and Ubuntu" -sidebar_current: "docs-cli-install-apt" -description: |- - The HashiCorp APT repositories contain distribution-specific Terraform packages for both Debian and Ubuntu systems. +page_title: APT Packages for Debian and Ubuntu +description: >- + The HashiCorp APT repositories contain distribution-specific Terraform + packages for both Debian and Ubuntu systems. --- # APT Packages for Debian and Ubuntu @@ -16,7 +15,7 @@ Debian and Ubuntu systems, which allow you to install Terraform using the `apt install` command or any other APT frontend. If you are instead using Red Hat Enterprise Linux, CentOS, or Fedora, you -might prefer to [install Terraform from our Yum repositories](yum.html). +might prefer to [install Terraform from our Yum repositories](/cli/install/yum). -> **Note:** The APT repositories discussed on this page are generic HashiCorp repositories that contain packages for a variety of different HashiCorp @@ -64,7 +63,7 @@ architecture, which is also sometimes known as `x86_64`. There are no official packages available for other architectures, such as `arm64`. If you wish to use Terraform on a non-`amd64` system, -[download a normal release `.zip` file](/downloads.html) instead. +[download a normal release `.zip` file](/downloads) instead. ## Supported Debian and Ubuntu Releases diff --git a/website/docs/cli/install/yum.html.md b/website/docs/cli/install/yum.mdx similarity index 91% rename from website/docs/cli/install/yum.html.md rename to website/docs/cli/install/yum.mdx index 45e88e0eb445..accc2d3f3d9b 100644 --- a/website/docs/cli/install/yum.html.md +++ b/website/docs/cli/install/yum.mdx @@ -1,9 +1,8 @@ --- -layout: "downloads" -page_title: "Yum Packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux" -sidebar_current: "docs-cli-install-yum" -description: |- - The HashiCorp Yum repositories contain distribution-specific Terraform packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux systems. +page_title: 'Yum Packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux' +description: >- + The HashiCorp Yum repositories contain distribution-specific Terraform + packages for Red Hat Enterprise Linux, Fedora, and Amazon Linux systems. --- # Yum/DNF Packages for RHEL, CentOS, and Fedora @@ -16,7 +15,7 @@ RedHat Enterprise Linux, Fedora, and Amazon Linux systems, which allow you to install Terraform using the `yum install` or `dnf install` commands. If you are instead using Debian or Ubuntu, you -might prefer to [install Terraform from our APT repositories](apt.html). +might prefer to [install Terraform from our APT repositories](/cli/install/apt). -> **Note:** The Yum repositories discussed on this page are generic HashiCorp repositories that contain packages for a variety of different HashiCorp @@ -64,7 +63,7 @@ architecture, which is also sometimes known as `amd64`. There are no official packages available for other architectures, such as `aarch64`. If you wish to use Terraform on a non-`x86_64` system, -[download a normal release `.zip` file](/downloads.html) instead. +[download a normal release `.zip` file](/downloads) instead. ## Supported Distribution Releases diff --git a/website/docs/cli/plugins/index.html.md b/website/docs/cli/plugins/index.mdx similarity index 65% rename from website/docs/cli/plugins/index.html.md rename to website/docs/cli/plugins/index.mdx index 95edb225ec1d..22965ea07e5a 100644 --- a/website/docs/cli/plugins/index.html.md +++ b/website/docs/cli/plugins/index.mdx @@ -1,14 +1,15 @@ --- -layout: "docs" -page_title: "Managing Plugins - Terraform CLI" -description: "Commands to install, configure, and show information about providers. Also commands to reduce install effort in air-gapped environments." +page_title: Managing Plugins - Terraform CLI +description: >- + Commands to install, configure, and show information about providers. Also + commands to reduce install effort in air-gapped environments. --- # Managing Plugins Terraform relies on plugins called "providers" in order to manage various types of resources. (For more information about providers, see -[Providers](/docs/language/providers/index.html) in the Terraform +[Providers](/language/providers) in the Terraform language docs.) -> **Note:** Providers are currently the only plugin type most Terraform users @@ -16,8 +17,8 @@ will interact with. Terraform also supports third-party provisioner plugins, but we discourage their use. Terraform downloads and/or installs any providers -[required](/docs/language/providers/requirements.html) by a configuration -when [initializing](/docs/cli/init/index.html) a working directory. By default, +[required](/language/providers/requirements) by a configuration +when [initializing](/cli/init) a working directory. By default, this works without any additional interaction but requires network access to download providers from their source registry. @@ -31,29 +32,29 @@ environments. Terraform's configuration file includes options for caching downloaded plugins, or explicitly specifying a local or HTTPS mirror to install plugins from. For -more information, see [CLI Config File](/docs/cli/config/config-file.html). +more information, see [CLI Config File](/cli/config/config-file). ## Getting Plugin Information -Use the [`terraform providers`](/docs/cli/commands/providers.html) command to get information +Use the [`terraform providers`](/cli/commands/providers) command to get information about the providers required by the current working directory's configuration. -Use the [`terraform version`](/docs/cli/commands/version.html) command (or +Use the [`terraform version`](/cli/commands/version) command (or `terraform -version`) to show the specific provider versions installed for the current working directory. -Use the [`terraform providers schema`](/docs/cli/commands/providers/schema.html) command to +Use the [`terraform providers schema`](/cli/commands/providers/schema) command to get machine-readable information about the resources and configuration options offered by each provider. ## Managing Plugin Installation -Use the [`terraform providers mirror`](/docs/cli/commands/providers/mirror.html) command to +Use the [`terraform providers mirror`](/cli/commands/providers/mirror) command to download local copies of every provider required by the current working directory's configuration. This directory will use the nested directory layout that Terraform expects when installing plugins from a local source, so you can transfer it directly to an airgapped system that runs Terraform. -Use the [`terraform providers lock`](/docs/cli/commands/providers/lock.html) command +Use the [`terraform providers lock`](/cli/commands/providers/lock) command to update the lock file that Terraform uses to ensure predictable runs when using ambiguous provider version constraints. diff --git a/website/docs/cli/plugins/signing.html.md b/website/docs/cli/plugins/signing.mdx similarity index 70% rename from website/docs/cli/plugins/signing.html.md rename to website/docs/cli/plugins/signing.mdx index 9c82157d3f58..cdcd546d68f5 100644 --- a/website/docs/cli/plugins/signing.html.md +++ b/website/docs/cli/plugins/signing.mdx @@ -1,7 +1,8 @@ --- -layout: "docs" -page_title: "Plugin Signing" -description: "Learn about the types of signatures providers can have on the Terraform Registry." +page_title: Plugin Signing +description: >- + Learn about the types of signatures providers can have on the Terraform + Registry. --- @@ -14,11 +15,11 @@ Terraform providers installed from the Registry are cryptographically signed, an * **Signed by HashiCorp** - are built, signed, and supported by HashiCorp. * **Signed by Trusted Partners** - are built, signed, and supported by a third party. HashiCorp has -verified the ownership of the private key and we provide a chain of trust to the CLI to verify this -programatically. + verified the ownership of the private key and we provide a chain of trust to the CLI to verify this + programatically. * **Self-signed** - are built, signed, and supported by a third party. HashiCorp does not provide a -verification or chain of trust for the signature. You may obtain and validate fingerprints manually -if you want to ensure you are using a binary you can trust. + verification or chain of trust for the signature. You may obtain and validate fingerprints manually + if you want to ensure you are using a binary you can trust. Terraform does **NOT** support fetching and using unsigned binaries, but you can manually install unsigned binaries. You should take extreme care when doing so as no programatic authentication is performed. diff --git a/website/docs/cli/run/index.html.md b/website/docs/cli/run/index.mdx similarity index 82% rename from website/docs/cli/run/index.html.md rename to website/docs/cli/run/index.mdx index 0d0770a34ac0..0ce5238200e9 100644 --- a/website/docs/cli/run/index.html.md +++ b/website/docs/cli/run/index.mdx @@ -1,14 +1,13 @@ --- -layout: "docs" -page_title: "Provisioning Infrastructure - Terraform CLI" -description: "Learn about commands for core provisioning tasks: plan, apply, and destroy." +page_title: Provisioning Infrastructure - Terraform CLI +description: 'Learn about commands for core provisioning tasks: plan, apply, and destroy.' --- # Provisioning Infrastructure with Terraform Terraform's primary function is to create, modify, and destroy infrastructure resources to match the desired state described in a -[Terraform configuration](/docs/language/index.html). +[Terraform configuration](/language). When people refer to "running Terraform," they generally mean performing these provisioning actions in order to affect real infrastructure objects. The @@ -17,8 +16,8 @@ actions, but these basic provisioning tasks are the core of Terraform. Terraform's provisioning workflow relies on three commands: `plan`, `apply`, and `destroy`. All of these commands require an -[initialized](/docs/cli/init/index.html) working directory, and all of them act -only upon the currently selected [workspace](/docs/cli/workspaces/index.html). +[initialized](/cli/init) working directory, and all of them act +only upon the currently selected [workspace](/cli/workspaces). ## Planning @@ -39,7 +38,7 @@ resulting actions are as expected. However, `terraform plan` can also save its plan as a runnable artifact, which `terraform apply` can use to carry out those exact changes. -For details, see [the `terraform plan` command](/docs/cli/commands/plan.html). +For details, see [the `terraform plan` command](/cli/commands/plan). ## Applying @@ -55,7 +54,7 @@ running a new plan. You can use this to reliably perform an exact set of pre-approved changes, even if the configuration or the state of the real infrastructure has changed in the minutes since the original plan was created. -For details, see [the `terraform apply` command](/docs/cli/commands/apply.html). +For details, see [the `terraform apply` command](/cli/commands/apply). ## Destroying @@ -69,4 +68,4 @@ and then running an apply, except that it doesn't require editing the configuration. This is more convenient if you intend to provision similar resources at a later date. -For details, see [the `terraform destroy` command](/docs/cli/commands/destroy.html). +For details, see [the `terraform destroy` command](/cli/commands/destroy). diff --git a/website/docs/cli/state/index.html.md b/website/docs/cli/state/index.mdx similarity index 66% rename from website/docs/cli/state/index.html.md rename to website/docs/cli/state/index.mdx index 7f12fea4f501..9db8d9252bd1 100644 --- a/website/docs/cli/state/index.html.md +++ b/website/docs/cli/state/index.mdx @@ -1,14 +1,15 @@ --- -layout: "docs" -page_title: "Manipulating State - Terraform CLI" -description: "State data tracks which real-world object corresponds to each resource. Inspect state, move or import resources, and more." +page_title: Manipulating State - Terraform CLI +description: >- + State data tracks which real-world object corresponds to each resource. + Inspect state, move or import resources, and more. --- # Manipulating Terraform State > **Hands-on:** Try the [Manage Resources in Terraform State](https://learn.hashicorp.com/tutorials/terraform/state-cli?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. -Terraform uses [state data](/docs/language/state/index.html) to remember which +Terraform uses [state data](/language/state) to remember which real-world object corresponds to each resource in the configuration; this allows it to modify an existing object when its resource declaration changes. @@ -20,12 +21,12 @@ infrastructure. Terraform CLI supports several workflows for interacting with state: -- [Inspecting State](/docs/cli/state/inspect.html) -- [Forcing Re-creation (Tainting)](/docs/cli/state/taint.html) -- [Moving Resources](/docs/cli/state/move.html) +- [Inspecting State](/cli/state/inspect) +- [Forcing Re-creation (Tainting)](/cli/state/taint) +- [Moving Resources](/cli/state/move) - Importing Pre-existing Resources (documented in the - [Importing Infrastructure](/docs/cli/import/index.html) section) -- [Disaster Recovery](/docs/cli/state/recover.html) + [Importing Infrastructure](/cli/import) section) +- [Disaster Recovery](/cli/state/recover) ~> **Important:** Modifying state data outside a normal plan or apply can cause Terraform to lose track of managed resources, which might waste money, annoy diff --git a/website/docs/cli/state/inspect.html.md b/website/docs/cli/state/inspect.mdx similarity index 58% rename from website/docs/cli/state/inspect.html.md rename to website/docs/cli/state/inspect.mdx index 382cd37a24f8..54767bb834ef 100644 --- a/website/docs/cli/state/inspect.html.md +++ b/website/docs/cli/state/inspect.mdx @@ -1,7 +1,6 @@ --- -layout: "docs" -page_title: "Inspecting State - Terraform CLI" -description: "Commands that allow you to read and update state." +page_title: Inspecting State - Terraform CLI +description: Commands that allow you to read and update state. --- # Inspecting State @@ -9,14 +8,14 @@ description: "Commands that allow you to read and update state." Terraform includes some commands for reading and updating state without taking any other actions. -- [The `terraform state list` command](/docs/cli/commands/state/list.html) +- [The `terraform state list` command](/cli/commands/state/list) shows the resource addresses for every resource Terraform knows about in a configuration, optionally filtered by partial resource address. -- [The `terraform state show` command](/docs/cli/commands/state/show.html) +- [The `terraform state show` command](/cli/commands/state/show) displays detailed state data about one resource. -- [The `terraform refresh` command](/docs/cli/commands/refresh.html) updates +- [The `terraform refresh` command](/cli/commands/refresh) updates state data to match the real-world condition of the managed resources. This is done automatically during plans and applies, but not when interacting with state directly. diff --git a/website/docs/cli/state/move.html.md b/website/docs/cli/state/move.mdx similarity index 64% rename from website/docs/cli/state/move.html.md rename to website/docs/cli/state/move.mdx index c507aa0effa1..8b0f9cdaeb75 100644 --- a/website/docs/cli/state/move.html.md +++ b/website/docs/cli/state/move.mdx @@ -1,13 +1,14 @@ --- -layout: "docs" -page_title: "Moving Resources - Terraform CLI" -description: "Commands that allow you to manage the way that resources are tracked in state. They are helpful when you move or change resources." +page_title: Moving Resources - Terraform CLI +description: >- + Commands that allow you to manage the way that resources are tracked in state. + They are helpful when you move or change resources. --- # Moving Resources Terraform's state associates each real-world object with a configured resource -at a specific [resource address](/docs/cli/state/resource-addressing.html). This +at a specific [resource address](/cli/state/resource-addressing). This is seamless when changing a resource's attributes, but Terraform will lose track of a resource if you change its name, move it to a different module, or change its provider. @@ -20,19 +21,19 @@ In cases where it's important to preserve an existing infrastructure object, you can explicitly tell Terraform to associate it with a different configured resource. -- [The `terraform state mv` command](/docs/cli/commands/state/mv.html) changes +- [The `terraform state mv` command](/cli/commands/state/mv) changes which resource address in your configuration is associated with a particular real-world object. Use this to preserve an object when renaming a resource, or when moving a resource into or out of a child module. - > **Hands On:** Try the [Use Configuration to Move Resources](https://learn.hashicorp.com/tutorials/terraform/move-config) on HashiCorp Learn. + > **Hands On:** Try the [Use Configuration to Move Resources](https://learn.hashicorp.com/tutorials/terraform/move-config) on HashiCorp Learn. -- [The `terraform state rm` command](/docs/cli/commands/state/rm.html) tells +- [The `terraform state rm` command](/cli/commands/state/rm) tells Terraform to stop managing a resource as part of the current working directory and workspace, _without_ destroying the corresponding real-world object. (You can later use `terraform import` to start managing that resource in a different workspace or a different Terraform configuration.) -- [The `terraform state replace-provider` command](/docs/cli/commands/state/replace-provider.html) +- [The `terraform state replace-provider` command](/cli/commands/state/replace-provider) transfers existing resources to a new provider without requiring them to be re-created. diff --git a/website/docs/cli/state/recover.html.md b/website/docs/cli/state/recover.mdx similarity index 65% rename from website/docs/cli/state/recover.html.md rename to website/docs/cli/state/recover.mdx index 29e289c427c2..f3b124cb2d7f 100644 --- a/website/docs/cli/state/recover.html.md +++ b/website/docs/cli/state/recover.mdx @@ -1,7 +1,8 @@ --- -layout: "docs" -page_title: "Recovering from State Disasters - Terraform CLI" -descriptin: "Commands that allow you to restore state backups and override Terraform state protections." +page_title: Recovering from State Disasters - Terraform CLI +descriptin: >- + Commands that allow you to restore state backups and override Terraform state + protections. --- # Recovering from State Disasters @@ -10,7 +11,7 @@ If something has gone horribly wrong (possibly due to accidents when performing other state manipulation actions), you might need to take drastic actions with your state data. -- [The `terraform force-unlock` command](/docs/cli/commands/force-unlock.html) can +- [The `terraform force-unlock` command](/cli/commands/force-unlock) can override the protections Terraform uses to prevent two processes from modifying state at the same time. You might need this if a Terraform process (like a normal apply) is unexpectedly terminated (like by the complete @@ -18,8 +19,7 @@ your state data. state backend. Do not run this until you are completely certain what happened to the process that caused the lock to get stuck. -- [The `terraform state pull` command](/docs/cli/commands/state/pull.html) and - [the `terraform state push` command](/docs/cli/commands/state/push.html) can +- [The `terraform state pull` command](/cli/commands/state/pull) and + [the `terraform state push` command](/cli/commands/state/push) can directly read and write entire state files from and to the configured backend. You might need this for obtaining or restoring a state backup. - diff --git a/website/docs/cli/state/resource-addressing.html.md b/website/docs/cli/state/resource-addressing.mdx similarity index 69% rename from website/docs/cli/state/resource-addressing.html.md rename to website/docs/cli/state/resource-addressing.mdx index 72b987a8393a..07f3039c067e 100644 --- a/website/docs/cli/state/resource-addressing.html.md +++ b/website/docs/cli/state/resource-addressing.mdx @@ -1,7 +1,5 @@ --- -layout: "docs" -page_title: "Internals: Resource Address" -sidebar_current: "docs-internals-resource-addressing" +page_title: 'Internals: Resource Address' description: |- A resource address is a string that identifies zero or more resource instances in your overall configuration. @@ -32,12 +30,12 @@ A module path addresses a module within the tree of modules. It takes the form: module.module_name[module index] ``` - * `module` - Module keyword indicating a child module (non-root). Multiple `module` - keywords in a path indicate nesting. - * `module_name` - User-defined name of the module. - * `[module index]` - (Optional) [Index](#index-values-for-modules-and-resources) - to select an instance from a module call that has multiple instances, - surrounded by square bracket characters (`[` and `]`). +- `module` - Module keyword indicating a child module (non-root). Multiple `module` + keywords in a path indicate nesting. +- `module_name` - User-defined name of the module. +- `[module index]` - (Optional) [Index](#index-values-for-modules-and-resources) + to select an instance from a module call that has multiple instances, + surrounded by square bracket characters (`[` and `]`). An address without a resource spec, i.e. `module.foo` applies to every resource within the module if a single module, or all instances of a module if a module has multiple instances. @@ -64,11 +62,11 @@ It has the following syntax: resource_type.resource_name[instance index] ``` - * `resource_type` - Type of the resource being addressed. - * `resource_name` - User-defined name of the resource. - * `[instance index]` - (Optional) [Index](#index-values-for-modules-and-resources) - to select an instance from a resource that has multiple instances, - surrounded by square bracket characters (`[` and `]`). +- `resource_type` - Type of the resource being addressed. +- `resource_name` - User-defined name of the resource. +- `[instance index]` - (Optional) [Index](#index-values-for-modules-and-resources) + to select an instance from a resource that has multiple instances, + surrounded by square bracket characters (`[` and `]`). -> In Terraform v0.12 and later, a resource spec without a module path prefix matches only resources in the root module. In earlier versions, a resource spec @@ -79,12 +77,12 @@ in any descendent module. The following specifications apply to index values on modules and resources with multiple instances: - * `[N]` where `N` is a `0`-based numerical index into a resource with multiple - instances specified by the `count` meta-argument. Omitting an index when - addressing a resource where `count > 1` means that the address references - all instances. - * `["INDEX"]` where `INDEX` is a alphanumerical key index into a resource with - multiple instances specified by the `for_each` meta-argument. +- `[N]` where `N` is a `0`-based numerical index into a resource with multiple + instances specified by the `count` meta-argument. Omitting an index when + addressing a resource where `count > 1` means that the address references + all instances. +- `["INDEX"]` where `INDEX` is a alphanumerical key index into a resource with + multiple instances specified by the `for_each` meta-argument. ## Examples diff --git a/website/docs/cli/state/taint.html.md b/website/docs/cli/state/taint.mdx similarity index 68% rename from website/docs/cli/state/taint.html.md rename to website/docs/cli/state/taint.mdx index cea1281449d8..dbe67f9063ff 100644 --- a/website/docs/cli/state/taint.html.md +++ b/website/docs/cli/state/taint.mdx @@ -1,7 +1,6 @@ --- -layout: "docs" -page_title: "Forcing Re-creation of Resources (Tainting) - Terraform CLI" -description: "Commands that allow you to destroy and re-create resources manually." +page_title: Forcing Re-creation of Resources (Tainting) - Terraform CLI +description: Commands that allow you to destroy and re-create resources manually. --- # Forcing Re-creation of Resources (Tainting) @@ -17,10 +16,10 @@ happen during creation; for example, a virtual machine that configures itself with `cloud-init` on startup might no longer meet your needs if the cloud-init configuration changes. -- [The `terraform taint` command](/docs/cli/commands/taint.html) tells Terraform to +- [The `terraform taint` command](/cli/commands/taint) tells Terraform to destroy and re-create a particular resource during the next apply, regardless of whether its resource arguments would normally require that. -- [The `terraform untaint` command](/docs/cli/commands/untaint.html) undoes a +- [The `terraform untaint` command](/cli/commands/untaint) undoes a previous taint, or can preserve a resource that was automatically tainted due - to failed [provisioners](/docs/language/resources/provisioners/syntax.html). + to failed [provisioners](/language/resources/provisioners/syntax). diff --git a/website/docs/cli/workspaces/index.html.md b/website/docs/cli/workspaces/index.mdx similarity index 65% rename from website/docs/cli/workspaces/index.html.md rename to website/docs/cli/workspaces/index.mdx index 39dd00f5e629..7a6b11f9e7c8 100644 --- a/website/docs/cli/workspaces/index.html.md +++ b/website/docs/cli/workspaces/index.mdx @@ -1,28 +1,29 @@ --- -layout: "docs" -page_title: "Managing Workspaces - Terraform CLI" -description: "Commands to list, select, create, and output workspaces. Workspaces help manage different groups of resources with one configuration." +page_title: Managing Workspaces - Terraform CLI +description: >- + Commands to list, select, create, and output workspaces. Workspaces help + manage different groups of resources with one configuration. --- # Managing Workspaces In Terraform CLI, _workspaces_ are separate instances of -[state data](/docs/language/state/index.html) that can be used from the same working +[state data](/language/state) that can be used from the same working directory. You can use workspaces to manage multiple non-overlapping groups of resources with the same configuration. -- Every [initialized working directory](/docs/cli/init/index.html) has at least +- Every [initialized working directory](/cli/init) has at least one workspace. (If you haven't created other workspaces, it is a workspace named `default`.) - For a given working directory, only one workspace can be _selected_ at a time. -- Most Terraform commands (including [provisioning](/docs/cli/run/index.html) - and [state manipulation](/docs/cli/state/index.html) commands) only interact +- Most Terraform commands (including [provisioning](/cli/run) + and [state manipulation](/cli/state) commands) only interact with the currently selected workspace. -- Use [the `terraform workspace select` command](/docs/cli/commands/workspace/select.html) +- Use [the `terraform workspace select` command](/cli/commands/workspace/select) to change the currently selected workspace. -- Use the [`terraform workspace list`](/docs/cli/commands/workspace/list.html), - [`terraform workspace new`](/docs/cli/commands/workspace/new.html), and - [`terraform workspace delete`](/docs/cli/commands/workspace/delete.html) commands +- Use the [`terraform workspace list`](/cli/commands/workspace/list), + [`terraform workspace new`](/cli/commands/workspace/new), and + [`terraform workspace delete`](/cli/commands/workspace/delete) commands to manage the available workspaces in the current working directory. -> **Note:** Terraform Cloud and Terraform CLI both have features called @@ -35,19 +36,19 @@ Since most of the resources you can manage with Terraform don't include a unique name as part of their configuration, it's common to use the same Terraform configuration to provision multiple groups of similar resources. -Terraform relies on [state](/docs/language/state/index.html) to associate resources with +Terraform relies on [state](/language/state) to associate resources with real-world objects, so if you run the same configuration multiple times with completely separate state data, Terraform can manage many non-overlapping groups of resources. In some cases you'll want to change -[variable values](/docs/language/values/variables.html) for these different +[variable values](/language/values/variables) for these different resource collections (like when specifying differences between staging and production deployments), and in other cases you might just want many instances of a particular infrastructure pattern. The simplest way to maintain multiple instances of a configuration with completely separate state data is to use multiple -[working directories](/docs/cli/init/index.html) (with different -[backend](/docs/language/settings/backends/configuration.html) configurations per directory, if you +[working directories](/cli/init) (with different +[backend](/language/settings/backends/configuration) configurations per directory, if you aren't using the default `local` backend). However, this isn't always the most _convenient_ way to handle separate states. @@ -69,9 +70,9 @@ workspace has its own Terraform configuration, set of variable values, state data, run history, and settings. These two kinds of workspaces are different, but related. When [using Terraform -CLI as a frontend for Terraform Cloud](/docs/cli/cloud/index.html), you can associate the current working +CLI as a frontend for Terraform Cloud](/cli/cloud), you can associate the current working directory with one or more remote workspaces. If you associate the directory with multiple workspaces (using workspace tags), you can use the `terraform workspace` commands to select which remote workspace to use. -Refer to [CLI-driven Runs](/docs/cloud/run/cli.html) in the Terraform Cloud documentation for more details about using Terraform CLI with Terraform Cloud. +Refer to [CLI-driven Runs](/cloud-docs/run/cli) in the Terraform Cloud documentation for more details about using Terraform CLI with Terraform Cloud. diff --git a/website/docs/configuration-0-11/interpolation.html.md b/website/docs/configuration-0-11/interpolation.html.md deleted file mode 100644 index 9ec65d8aa41e..000000000000 --- a/website/docs/configuration-0-11/interpolation.html.md +++ /dev/null @@ -1,570 +0,0 @@ ---- -layout: "language" -page_title: "Interpolation Syntax - 0.11 Configuration Language" -sidebar_current: "docs-conf-old-interpolation" -description: |- - Embedded within strings in Terraform, whether you're using the Terraform syntax or JSON syntax, you can interpolate other values into strings. These interpolations are wrapped in `${}`, such as `${var.foo}`. ---- - -# Interpolation Syntax - --> **Note:** This page is about Terraform 0.11 and earlier. For Terraform 0.12 -and later, see -[Configuration Language: Expressions](/docs/language/expressions/index.html) and -[Configuration Language: Functions](/docs/language/functions/index.html). - -Embedded within strings in Terraform, whether you're using the -Terraform syntax or JSON syntax, you can interpolate other values. These -interpolations are wrapped in `${}`, such as `${var.foo}`. - -The interpolation syntax is powerful and allows you to reference -variables, attributes of resources, call functions, etc. - -You can perform [simple math](#math) in interpolations, allowing -you to write expressions such as `${count.index + 1}`. And you can -also use [conditionals](#conditionals) to determine a value based -on some logic. - -You can escape interpolation with double dollar signs: `$${foo}` -will be rendered as a literal `${foo}`. - -## Available Variables - -There are a variety of available variable references you can use. - -#### User string variables - -Use the `var.` prefix followed by the variable name. For example, -`${var.foo}` will interpolate the `foo` variable value. - -#### User map variables - -The syntax is `var.[""]`. For example, `${var.amis["us-east-1"]}` -would get the value of the `us-east-1` key within the `amis` map -variable. - -#### User list variables - -The syntax is `"${var.}"`. For example, `"${var.subnets}"` -would get the value of the `subnets` list, as a list. You can also -return list elements by index: `${var.subnets[idx]}`. - -#### Attributes of your own resource - -The syntax is `self.`. For example `${self.private_ip}` -will interpolate that resource's private IP address. - --> **Note**: The `self.` syntax is only allowed and valid within -provisioners. - -#### Attributes of other resources - -The syntax is `..`. For example, -`${aws_instance.web.id}` will interpolate the ID attribute from the -`aws_instance` resource named `web`. If the resource has a `count` -attribute set, you can access individual attributes with a zero-based -index, such as `${aws_instance.web.0.id}`. You can also use the splat -syntax to get a list of all the attributes: `${aws_instance.web.*.id}`. - -#### Attributes of a data source - -The syntax is `data...`. For example. `${data.aws_ami.ubuntu.id}` will interpolate the `id` attribute from the `aws_ami` [data source](./data-sources.html) named `ubuntu`. If the data source has a `count` -attribute set, you can access individual attributes with a zero-based -index, such as `${data.aws_subnet.example.0.cidr_block}`. You can also use the splat -syntax to get a list of all the attributes: `${data.aws_subnet.example.*.cidr_block}`. - -#### Outputs from a module - -The syntax is `module..`. For example `${module.foo.bar}` will -interpolate the `bar` output from the `foo` -[module](/docs/language/modules/develop/index.html). - -#### Count information - -The syntax is `count.index`. For example, `${count.index}` will -interpolate the current index in a multi-count resource. For more -information on `count`, see the [resource configuration -page](./resources.html). - -#### Path information - -The syntax is `path.`. TYPE can be `cwd`, `module`, or `root`. -`cwd` will interpolate the current working directory. `module` will -interpolate the path to the current module. `root` will interpolate the -path of the root module. In general, you probably want the -`path.module` variable. - -#### Terraform meta information - -The syntax is `terraform.`. This variable type contains metadata about -the currently executing Terraform run. FIELD can currently only be `env` to -reference the currently active workspace. - -## Conditionals - -Interpolations may contain conditionals to branch on the final value. - -```hcl -resource "aws_instance" "web" { - subnet = "${var.env == "production" ? var.prod_subnet : var.dev_subnet}" -} -``` - -The conditional syntax is the well-known ternary operation: - -```text -CONDITION ? TRUEVAL : FALSEVAL -``` - -The condition can be any valid interpolation syntax, such as variable -access, a function call, or even another conditional. The true and false -value can also be any valid interpolation syntax. The returned types by -the true and false side must be the same. - -The supported operators are: - - * Equality: `==` and `!=` - * Numerical comparison: `>`, `<`, `>=`, `<=` - * Boolean logic: `&&`, `||`, unary `!` - -A common use case for conditionals is to enable/disable a resource by -conditionally setting the count: - -```hcl -resource "aws_instance" "vpn" { - count = "${var.something ? 1 : 0}" -} -``` - -In the example above, the "vpn" resource will only be included if -"var.something" evaluates to true. Otherwise, the VPN resource will -not be created at all. - -## Built-in Functions - -Terraform ships with built-in functions. Functions are called with the -syntax `name(arg, arg2, ...)`. For example, to read a file: -`${file("path.txt")}`. - -~> **Note**: Proper escaping is required for JSON field values containing quotes -(`"`) such as `environment` values. If directly setting the JSON, they should be -escaped as `\"` in the JSON, e.g. `"value": "I \"love\" escaped quotes"`. If -using a Terraform variable value, they should be escaped as `\\\"` in the -variable, e.g. `value = "I \\\"love\\\" escaped quotes"` in the variable and -`"value": "${var.myvariable}"` in the JSON. - -### Supported built-in functions - -The supported built-in functions are: - - * `abs(float)` - Returns the absolute value of a given float. - Example: `abs(1)` returns `1`, and `abs(-1)` would also return `1`, - whereas `abs(-3.14)` would return `3.14`. See also the `signum` function. - - * `basename(path)` - Returns the last element of a path. - - * `base64decode(string)` - Given a base64-encoded string, decodes it and - returns the original string. - - * `base64encode(string)` - Returns a base64-encoded representation of the - given string. - - * `base64gzip(string)` - Compresses the given string with gzip and then - encodes the result to base64. This can be used with certain resource - arguments that allow binary data to be passed with base64 encoding, since - Terraform strings are required to be valid UTF-8. - - * `base64sha256(string)` - Returns a base64-encoded representation of raw - SHA-256 sum of the given string. - **This is not equivalent** of `base64encode(sha256(string))` - since `sha256()` returns hexadecimal representation. - - * `base64sha512(string)` - Returns a base64-encoded representation of raw - SHA-512 sum of the given string. - **This is not equivalent** of `base64encode(sha512(string))` - since `sha512()` returns hexadecimal representation. - - * `bcrypt(password, cost)` - Returns the Blowfish encrypted hash of the string - at the given cost. A default `cost` of 10 will be used if not provided. - - * `ceil(float)` - Returns the least integer value greater than or equal - to the argument. - - * `chomp(string)` - Removes trailing newlines from the given string. - - * `chunklist(list, size)` - Returns the `list` items chunked by `size`. - Examples: - * `chunklist(aws_subnet.foo.*.id, 1)`: will outputs `[["id1"], ["id2"], ["id3"]]` - * `chunklist(var.list_of_strings, 2)`: will outputs `[["id1", "id2"], ["id3", "id4"], ["id5"]]` - - * `cidrhost(iprange, hostnum)` - Takes an IP address range in CIDR notation - and creates an IP address with the given host number. If given host - number is negative, the count starts from the end of the range. - For example, `cidrhost("10.0.0.0/8", 2)` returns `10.0.0.2` and - `cidrhost("10.0.0.0/8", -2)` returns `10.255.255.254`. - - * `cidrnetmask(iprange)` - Takes an IP address range in CIDR notation - and returns the address-formatted subnet mask format that some - systems expect for IPv4 interfaces. For example, - `cidrnetmask("10.0.0.0/8")` returns `255.0.0.0`. Not applicable - to IPv6 networks since CIDR notation is the only valid notation for - IPv6. - - * `cidrsubnet(iprange, newbits, netnum)` - Takes an IP address range in - CIDR notation (like `10.0.0.0/8`) and extends its prefix to include an - additional subnet number. For example, - `cidrsubnet("10.0.0.0/8", 8, 2)` returns `10.2.0.0/16`; - `cidrsubnet("2607:f298:6051:516c::/64", 8, 2)` returns - `2607:f298:6051:516c:200::/72`. - - * `coalesce(string1, string2, ...)` - Returns the first non-empty value from - the given arguments. At least two arguments must be provided. - - * `coalescelist(list1, list2, ...)` - Returns the first non-empty list from - the given arguments. At least two arguments must be provided. - - * `compact(list)` - Removes empty string elements from a list. This can be - useful in some cases, for example when passing joined lists as module - variables or when parsing module outputs. - Example: `compact(module.my_asg.load_balancer_names)` - - * `concat(list1, list2, ...)` - Combines two or more lists into a single list. - Example: `concat(aws_instance.db.*.tags.Name, aws_instance.web.*.tags.Name)` - - * `contains(list, element)` - Returns *true* if a list contains the given element - and returns *false* otherwise. Examples: `contains(var.list_of_strings, "an_element")` - - * `dirname(path)` - Returns all but the last element of path, typically the path's directory. - - * `distinct(list)` - Removes duplicate items from a list. Keeps the first - occurrence of each element, and removes subsequent occurrences. This - function is only valid for flat lists. Example: `distinct(var.usernames)` - - * `element(list, index)` - Returns a single element from a list - at the given index. If the index is greater than the number of - elements, this function will wrap using a standard mod algorithm. - This function only works on flat lists. Examples: - * `element(aws_subnet.foo.*.id, count.index)` - * `element(var.list_of_strings, 2)` - - * `file(path)` - Reads the contents of a file into the string. Variables - in this file are _not_ interpolated. The contents of the file are - read as-is. The `path` is interpreted relative to the working directory. - [Path variables](#path-information) can be used to reference paths relative - to other base locations. For example, when using `file()` from inside a - module, you generally want to make the path relative to the module base, - like this: `file("${path.module}/file")`. - - * `floor(float)` - Returns the greatest integer value less than or equal to - the argument. - - * `flatten(list of lists)` - Flattens lists of lists down to a flat list of - primitive values, eliminating any nested lists recursively. Examples: - * `flatten(data.github_user.user.*.gpg_keys)` - - * `format(format, args, ...)` - Formats a string according to the given - format. The syntax for the format is standard `sprintf` syntax. - Good documentation for the syntax can be [found here](https://golang.org/pkg/fmt/). - Example to zero-prefix a count, used commonly for naming servers: - `format("web-%03d", count.index + 1)`. - - * `formatlist(format, args, ...)` - Formats each element of a list - according to the given format, similarly to `format`, and returns a list. - Non-list arguments are repeated for each list element. - For example, to convert a list of DNS addresses to a list of URLs, you might use: - `formatlist("https://%s:%s/", aws_instance.foo.*.public_dns, var.port)`. - If multiple args are lists, and they have the same number of elements, then the formatting is applied to the elements of the lists in parallel. - Example: - `formatlist("instance %v has private ip %v", aws_instance.foo.*.id, aws_instance.foo.*.private_ip)`. - Passing lists with different lengths to formatlist results in an error. - - * `indent(numspaces, string)` - Prepends the specified number of spaces to all but the first - line of the given multi-line string. May be useful when inserting a multi-line string - into an already-indented context. The first line is not indented, to allow for the - indented string to be placed after some sort of already-indented preamble. - Example: `" \"items\": ${ indent(4, "[\n \"item1\"\n]") },"` - - * `index(list, elem)` - Finds the index of a given element in a list. - This function only works on flat lists. - Example: `index(aws_instance.foo.*.tags.Name, "foo-test")` - - * `join(delim, list)` - Joins the list with the delimiter for a resultant string. - This function works only on flat lists. - Examples: - * `join(",", aws_instance.foo.*.id)` - * `join(",", var.ami_list)` - - * `jsonencode(value)` - Returns a JSON-encoded representation of the given - value, which can contain arbitrarily-nested lists and maps. Note that if - the value is a string then its value will be placed in quotes. - - * `keys(map)` - Returns a lexically sorted list of the map keys. - - * `length(list)` - Returns the number of members in a given list or map, or the number of characters in a given string. - * `${length(split(",", "a,b,c"))}` = 3 - * `${length("a,b,c")}` = 5 - * `${length(map("key", "val"))}` = 1 - - * `list(items, ...)` - Returns a list consisting of the arguments to the function. - This function provides a way of representing list literals in interpolation. - * `${list("a", "b", "c")}` returns a list of `"a", "b", "c"`. - * `${list()}` returns an empty list. - - * `log(x, base)` - Returns the logarithm of `x`. - - * `lookup(map, key, [default])` - Performs a dynamic lookup into a map - variable. The `map` parameter should be another variable, such - as `var.amis`. If `key` does not exist in `map`, the interpolation will - fail unless you specify a third argument, `default`, which should be a - string value to return if no `key` is found in `map`. This function - only works on flat maps and will return an error for maps that - include nested lists or maps. - - * `lower(string)` - Returns a copy of the string with all Unicode letters mapped to their lower case. - - * `map(key, value, ...)` - Returns a map consisting of the key/value pairs - specified as arguments. Every odd argument must be a string key, and every - even argument must have the same type as the other values specified. - Duplicate keys are not allowed. Examples: - * `map("hello", "world")` - * `map("us-east", list("a", "b", "c"), "us-west", list("b", "c", "d"))` - - * `matchkeys(values, keys, searchset)` - For two lists `values` and `keys` of - equal length, returns all elements from `values` where the corresponding - element from `keys` exists in the `searchset` list. E.g. - `matchkeys(aws_instance.example.*.id, - aws_instance.example.*.availability_zone, list("us-west-2a"))` will return a - list of the instance IDs of the `aws_instance.example` instances in - `"us-west-2a"`. No match will result in empty list. Items of `keys` are - processed sequentially, so the order of returned `values` is preserved. - - * `max(float1, float2, ...)` - Returns the largest of the floats. - - * `merge(map1, map2, ...)` - Returns the union of 2 or more maps. The maps - are consumed in the order provided, and duplicate keys overwrite previous - entries. - * `${merge(map("a", "b"), map("c", "d"))}` returns `{"a": "b", "c": "d"}` - - * `min(float1, float2, ...)` - Returns the smallest of the floats. - - * `md5(string)` - Returns a (conventional) hexadecimal representation of the - MD5 hash of the given string. - - * `pathexpand(string)` - Returns a filepath string with `~` expanded to the home directory. Note: - This will create a plan diff between two different hosts, unless the filepaths are the same. - - * `pow(x, y)` - Returns the base `x` of exponential `y` as a float. - - Example: - * `${pow(3,2)}` = 9 - * `${pow(4,0)}` = 1 - - * `replace(string, search, replace)` - Does a search and replace on the - given string. All instances of `search` are replaced with the value - of `replace`. If `search` is wrapped in forward slashes, it is treated - as a regular expression. If using a regular expression, `replace` - can reference subcaptures in the regular expression by using `$n` where - `n` is the index or name of the subcapture. If using a regular expression, - the syntax conforms to the [re2 regular expression syntax](https://github.com/google/re2/wiki/Syntax). - - * `rsadecrypt(string, key)` - Decrypts `string` using RSA. The padding scheme - PKCS #1 v1.5 is used. The `string` must be base64-encoded. `key` must be an - RSA private key in PEM format. You may use `file()` to load it from a file. - - * `sha1(string)` - Returns a (conventional) hexadecimal representation of the - SHA-1 hash of the given string. - Example: `"${sha1("${aws_vpc.default.tags.customer}-s3-bucket")}"` - - * `sha256(string)` - Returns a (conventional) hexadecimal representation of the - SHA-256 hash of the given string. - Example: `"${sha256("${aws_vpc.default.tags.customer}-s3-bucket")}"` - - * `sha512(string)` - Returns a (conventional) hexadecimal representation of the - SHA-512 hash of the given string. - Example: `"${sha512("${aws_vpc.default.tags.customer}-s3-bucket")}"` - - * `signum(integer)` - Returns `-1` for negative numbers, `0` for `0` and `1` for positive numbers. - This function is useful when you need to set a value for the first resource and - a different value for the rest of the resources. - Example: `element(split(",", var.r53_failover_policy), signum(count.index))` - where the 0th index points to `PRIMARY` and 1st to `FAILOVER` - - * `slice(list, from, to)` - Returns the portion of `list` between `from` (inclusive) and `to` (exclusive). - Example: `slice(var.list_of_strings, 0, length(var.list_of_strings) - 1)` - - * `sort(list)` - Returns a lexicographically sorted list of the strings contained in - the list passed as an argument. Sort may only be used with lists which contain only - strings. - Examples: `sort(aws_instance.foo.*.id)`, `sort(var.list_of_strings)` - - * `split(delim, string)` - Returns a list by splitting the string based on - the delimiter. This is useful for pushing lists through module - outputs since they currently only support string values. Depending on the - use, the string this is being performed within may need to be wrapped - in brackets to indicate that the output is actually a list, e.g. - `a_resource_param = ["${split(",", var.CSV_STRING)}"]`. - Example: `split(",", module.amod.server_ids)` - - * `substr(string, offset, length)` - Extracts a substring from the input string. A negative offset is interpreted as being equivalent to a positive offset measured backwards from the end of the string. A length of `-1` is interpreted as meaning "until the end of the string". - - * `timestamp()` - Returns a UTC timestamp string in RFC 3339 format. This string will change with every - invocation of the function, so in order to prevent diffs on every plan & apply, it must be used with the - [`ignore_changes`](./resources.html#ignore_changes) lifecycle attribute. - - * `timeadd(time, duration)` - Returns a UTC timestamp string corresponding to adding a given `duration` to `time` in RFC 3339 format. - For example, `timeadd("2017-11-22T00:00:00Z", "10m")` produces a value `"2017-11-22T00:10:00Z"`. - - * `title(string)` - Returns a copy of the string with the first characters of all the words capitalized. - - * `transpose(map)` - Swaps the keys and list values in a map of lists of strings. For example, transpose(map("a", list("1", "2"), "b", list("2", "3")) produces a value equivalent to map("1", list("a"), "2", list("a", "b"), "3", list("b")). - - * `trimspace(string)` - Returns a copy of the string with all leading and trailing white spaces removed. - - * `upper(string)` - Returns a copy of the string with all Unicode letters mapped to their upper case. - - * `urlencode(string)` - Returns an URL-safe copy of the string. - - * `uuid()` - Returns a random UUID string. This string will change with every invocation of the function, so in order to prevent diffs on every plan & apply, it must be used with the [`ignore_changes`](./resources.html#ignore_changes) lifecycle attribute. - - * `values(map)` - Returns a list of the map values, in the order of the keys - returned by the `keys` function. This function only works on flat maps and - will return an error for maps that include nested lists or maps. - - * `zipmap(list, list)` - Creates a map from a list of keys and a list of - values. The keys must all be of type string, and the length of the lists - must be the same. - For example, to output a mapping of AWS IAM user names to the fingerprint - of the key used to encrypt their initial password, you might use: - `zipmap(aws_iam_user.users.*.name, aws_iam_user_login_profile.users.*.key_fingerprint)`. - -The hashing functions `base64sha256`, `base64sha512`, `md5`, `sha1`, `sha256`, -and `sha512` all have variants with a `file` prefix, like `filesha1`, which -interpret their first argument as a path to a file on disk rather than as a -literal string. This allows safely creating hashes of binary files that might -otherwise be corrupted in memory if loaded into Terraform strings (which are -assumed to be UTF-8). `filesha1(filename)` is equivalent to `sha1(file(filename))` -in Terraform 0.11 and earlier, but the latter will fail for binary files in -Terraform 0.12 and later. - -## Templates - -Long strings can be managed using templates. -[Templates](https://registry.terraform.io/providers/hashicorp/template/latest/docs) are -[data-sources](./data-sources.html) defined by a -string with interpolation tokens (usually loaded from a file) and some variables -to use during interpolation. They have a computed `rendered` attribute -containing the result. - -A template data source looks like: - -```hcl -# templates/greeting.tpl -${hello} ${world}! -``` - -```hcl -data "template_file" "example" { - template = "${file("templates/greeting.tpl")}" - vars { - hello = "goodnight" - world = "moon" - } -} - -output "rendered" { - value = "${data.template_file.example.rendered}" -} -``` - -Then the rendered value would be `goodnight moon!`. - --> **Note:** If you specify the template as a literal string instead of loading -a file, the inline template must use double dollar signs (like `$${hello}`) to -prevent Terraform from interpolating values from the configuration into the -string. This is because `template_file` creates its own instance of the -interpolation system, with values provided by its nested `vars` block instead of -by the surrounding scope of the configuration. - -You may use any of the built-in functions in your template. For more -details on template usage, please see the -[template_file documentation](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file). - -### Using Templates with Count - -Here is an example that combines the capabilities of templates with the interpolation -from `count` to give us a parameterized template, unique to each resource instance: - -```hcl -variable "hostnames" { - default = { - "0" = "example1.org" - "1" = "example2.net" - } -} - -data "template_file" "web_init" { - # Render the template once for each instance - count = "${length(var.hostnames)}" - template = "${file("templates/web_init.tpl")}" - vars { - # count.index tells us the index of the instance we are rendering - hostname = "${var.hostnames[count.index]}" - } -} - -resource "aws_instance" "web" { - # Create one instance for each hostname - count = "${length(var.hostnames)}" - - # Pass each instance its corresponding template_file - user_data = "${data.template_file.web_init.*.rendered[count.index]}" -} -``` - -With this, we will build a list of `template_file.web_init` data resources -which we can use in combination with our list of `aws_instance.web` resources. - -## Math - -Simple math can be performed in interpolations: - -```hcl -variable "count" { - default = 2 -} - -resource "aws_instance" "web" { - # ... - - count = "${var.count}" - - # Tag the instance with a counter starting at 1, ie. web-001 - tags { - Name = "${format("web-%03d", count.index + 1)}" - } -} -``` - -The supported operations are: - -- *Add* (`+`), *Subtract* (`-`), *Multiply* (`*`), and *Divide* (`/`) for **float** types -- *Add* (`+`), *Subtract* (`-`), *Multiply* (`*`), *Divide* (`/`), and *Modulo* (`%`) for **integer** types - -Operator precedences is the standard mathematical order of operations: -*Multiply* (`*`), *Divide* (`/`), and *Modulo* (`%`) have precedence over -*Add* (`+`) and *Subtract* (`-`). Parenthesis can be used to force ordering. - -```text -"${2 * 4 + 3 * 3}" # computes to 17 -"${3 * 3 + 2 * 4}" # computes to 17 -"${2 * (4 + 3) * 3}" # computes to 42 -``` - -You can use the [terraform console](/docs/cli/commands/console.html) command to -try the math operations. - --> **Note:** Since Terraform allows hyphens in resource and variable names, -it's best to use spaces between math operators to prevent confusion or unexpected -behavior. For example, `${var.instance-count - 1}` will subtract **1** from the -`instance-count` variable value, while `${var.instance-count-1}` will interpolate -the `instance-count-1` variable value. diff --git a/website/docs/configuration/expressions.html.md b/website/docs/configuration/expressions.html.md deleted file mode 100644 index 801253dcc19e..000000000000 --- a/website/docs/configuration/expressions.html.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -layout: "language" -page_title: "Expressions Landing Page - Configuration Language" -sidebar_current: "docs-config-expressions" ---- - -# Expressions Landing Page - -To improve navigation, we've split the old Expressions page into several smaller -pages. - - - - - - - -## Types and Values, Literal Expressions, Indices and Attributes - -Terraform's types are `string`, `number`, `bool`, `list`, `tuple`, `map`, -`object`, and `null`. - -This information has moved to -[Types and Values](/docs/language/expressions/types.html). - -
        - - - - - - - - - - -## References to Named Values (Resource Attributes, Variables, etc.) - -You can refer to certain values by name, like `var.some_variable` or -`aws_instance.example.ami`. - -This information has moved to -[References to Values](/docs/language/expressions/references.html). - -
        - - - - - - - - -## Arithmetic and Logical Operators - -Operators are expressions that transform other expressions, like adding two -numbers (`+`) or comparing two values to get a bool (`==`, `>=`, etc.). - -This information has moved to -[Operators](/docs/language/expressions/operators.html). - -
        - - - -## Conditional Expressions - -The `condition ? true_val : false_val` expression chooses between two -expressions based on a bool condition. - -This information has moved to -[Conditional Expressions](/docs/language/expressions/conditionals.html). - -
        - - - - - - -## Function Calls - -Terraform's functions can be called like `function_name(arg1, arg2)`. - -This information has moved to -[Function Calls](/docs/language/expressions/function-calls.html). - -
        - - - - - -## `for` Expressions - -Expressions like `[for s in var.list : upper(s)]` can transform a complex type -value into another complex type value. - -This information has moved to -[For Expressions](/docs/language/expressions/for.html). - -
        - - - - - - -## Splat Expressions - -Expressions like `var.list[*].id` can extract simpler collections from complex -collections. - -This information has moved to -[Splat Expressions](/docs/language/expressions/splat.html). - -
        - - - - - - -## `dynamic` Blocks - -The special `dynamic` block type serves the same purpose as a `for` expression, -except it creates multiple repeatable nested blocks instead of a complex value. - -This information has moved to -[Dynamic Blocks](/docs/language/expressions/dynamic-blocks.html). - -
        - - - - - - - - -## String Literals and String Templates - -Strings can be `"double-quoted"` or - -```hcl -<
      • diff --git a/website/docs/configuration/expressions.mdx b/website/docs/configuration/expressions.mdx new file mode 100644 index 000000000000..f9ac614688ed --- /dev/null +++ b/website/docs/configuration/expressions.mdx @@ -0,0 +1,121 @@ +--- +page_title: Expressions Landing Page - Configuration Language +--- + +# Expressions Landing Page + +To improve navigation, we've split the old Expressions page into several smaller +pages. + + + +## Types and Values, Literal Expressions, Indices and Attributes + +Terraform's types are `string`, `number`, `bool`, `list`, `tuple`, `map`, +`object`, and `null`. + +This information has moved to +[Types and Values](/language/expressions/types). + +
      + + + +## References to Named Values (Resource Attributes, Variables, etc.) + +You can refer to certain values by name, like `var.some_variable` or +`aws_instance.example.ami`. + +This information has moved to +[References to Values](/language/expressions/references). + +
      + + + +## Arithmetic and Logical Operators + +Operators are expressions that transform other expressions, like adding two +numbers (`+`) or comparing two values to get a bool (`==`, `>=`, etc.). + +This information has moved to +[Operators](/language/expressions/operators). + +
      + +## Conditional Expressions + +The `condition ? true_val : false_val` expression chooses between two +expressions based on a bool condition. + +This information has moved to +[Conditional Expressions](/language/expressions/conditionals). + +
      + + + +## Function Calls + +Terraform's functions can be called like `function_name(arg1, arg2)`. + +This information has moved to +[Function Calls](/language/expressions/function-calls). + +
      + + + +## `for` Expressions + +Expressions like `[for s in var.list : upper(s)]` can transform a complex type +value into another complex type value. + +This information has moved to +[For Expressions](/language/expressions/for). + +
      + + + +## Splat Expressions + +Expressions like `var.list[*].id` can extract simpler collections from complex +collections. + +This information has moved to +[Splat Expressions](/language/expressions/splat). + +
      + + + +## `dynamic` Blocks + +The special `dynamic` block type serves the same purpose as a `for` expression, +except it creates multiple repeatable nested blocks instead of a complex value. + +This information has moved to +[Dynamic Blocks](/language/expressions/dynamic-blocks). + +
      + + + +## String Literals and String Templates + +Strings can be `"double-quoted"` or + +```hcl +< diff --git a/website/docs/configuration/index.mdx b/website/docs/configuration/index.mdx new file mode 100644 index 000000000000..046abeac20cb --- /dev/null +++ b/website/docs/configuration/index.mdx @@ -0,0 +1,5 @@ +--- +page_title: Terraform Configuration +--- + +# Terraform Configuration diff --git a/website/docs/configuration/modules.html.md b/website/docs/configuration/modules.html.md deleted file mode 100644 index 1dbcf06a14db..000000000000 --- a/website/docs/configuration/modules.html.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: "language" -page_title: "Modules Landing Page - Configuration Language" ---- - -# Modules Landing Page - -To improve navigation, we've split the old Modules page into several smaller -pages. - - - - - - - - -## Syntax and Elements of Module Blocks - -This information has moved to -[Module Blocks](/docs/language/modules/syntax.html). - -
      - - - - - -## Multiple Instances with `count` and `for_each` - -This information has moved to -[`count`](/docs/language/meta-arguments/count.html) and -[`for_each`](/docs/language/meta-arguments/for_each.html). - -
      - - - - - - - - - - -## Handling Provider Configurations in Re-usable Modules - -This information has moved to -[The `providers` Meta-Argument](/docs/language/meta-arguments/module-providers.html) -(for users of re-usable modules) and -[Providers Within Modules](/docs/language/modules/develop/providers.html) -(for module developers). - -
      diff --git a/website/docs/configuration/modules.mdx b/website/docs/configuration/modules.mdx new file mode 100644 index 000000000000..b6a0adeed51f --- /dev/null +++ b/website/docs/configuration/modules.mdx @@ -0,0 +1,39 @@ +--- +page_title: Modules Landing Page - Configuration Language +--- + +# Modules Landing Page + +To improve navigation, we've split the old Modules page into several smaller +pages. + + + +## Syntax and Elements of Module Blocks + +This information has moved to +[Module Blocks](/language/modules/syntax). + +
      + + + +## Multiple Instances with `count` and `for_each` + +This information has moved to +[`count`](/language/meta-arguments/count) and +[`for_each`](/language/meta-arguments/for_each). + +
      + + + +## Handling Provider Configurations in Re-usable Modules + +This information has moved to +[The `providers` Meta-Argument](/language/meta-arguments/module-providers) +(for users of re-usable modules) and +[Providers Within Modules](/language/modules/develop/providers) +(for module developers). + +
      diff --git a/website/docs/configuration/resources.html.md b/website/docs/configuration/resources.html.md deleted file mode 100644 index 87ae1bf5f439..000000000000 --- a/website/docs/configuration/resources.html.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -layout: "language" -page_title: "Resources Landing Page - Configuration Language" ---- - -# Resources Landing Page - -To improve navigation, we've split the old Resources page into several smaller -pages. - - - - - - - - - - -## Syntax and Elements of Resource Blocks - -This information has moved to -[Resource Blocks](/docs/language/resources/syntax.html). - -
      - - - - - - - - -## Details of Resource Behavior - -This information has moved to -[Resource Behavior](/docs/language/resources/behavior.html). - -
      - - - -## Resource Meta-Arguments - -Each resource meta-argument has moved to its own page: - -- [`depends_on`](/docs/language/meta-arguments/depends_on.html) -- [`count`](/docs/language/meta-arguments/count.html) -- [`for_each`](/docs/language/meta-arguments/for_each.html) -- [`provider`](/docs/language/meta-arguments/resource-provider.html) -- [`lifecycle`](/docs/language/meta-arguments/lifecycle.html) -- [Provisioners](/docs/language/resources/provisioners/index.html) - -
      - - - - - -### `depends_on` - -This information has moved to -[`depends_on`](/docs/language/meta-arguments/depends_on.html). - -
      - - - - - - - - - - - -### `count` - -This information has moved to -[`count`](/docs/language/meta-arguments/count.html). - -
      - - - - - - - - - - - -### `for_each` - -This information has moved to -[`for_each`](/docs/language/meta-arguments/for_each.html). - -
      - - - - - -### `provider` - -This information has moved to -[`provider`](/docs/language/meta-arguments/resource-provider.html). - -
      - - - - - - - - -### `lifecycle` - -This information has moved to -[`lifecycle`](/docs/language/meta-arguments/lifecycle.html). - -
      - - - - - -### Provisioners - -This information has moved to -[Provisioners](/docs/language/resources/provisioners/index.html). - -
      diff --git a/website/docs/configuration/resources.mdx b/website/docs/configuration/resources.mdx new file mode 100644 index 000000000000..7f9489afd631 --- /dev/null +++ b/website/docs/configuration/resources.mdx @@ -0,0 +1,93 @@ +--- +page_title: Resources Landing Page - Configuration Language +--- + +# Resources Landing Page + +To improve navigation, we've split the old Resources page into several smaller +pages. + + + +## Syntax and Elements of Resource Blocks + +This information has moved to +[Resource Blocks](/language/resources/syntax). + +
      + + + +## Details of Resource Behavior + +This information has moved to +[Resource Behavior](/language/resources/behavior). + +
      + +## Resource Meta-Arguments + +Each resource meta-argument has moved to its own page: + +- [`depends_on`](/language/meta-arguments/depends_on) +- [`count`](/language/meta-arguments/count) +- [`for_each`](/language/meta-arguments/for_each) +- [`provider`](/language/meta-arguments/resource-provider) +- [`lifecycle`](/language/meta-arguments/lifecycle) +- [Provisioners](/language/resources/provisioners) + +
      + + + +### `depends_on` + +This information has moved to +[`depends_on`](/language/meta-arguments/depends_on). + +
      + + + +### `count` + +This information has moved to +[`count`](/language/meta-arguments/count). + +
      + + + +### `for_each` + +This information has moved to +[`for_each`](/language/meta-arguments/for_each). + +
      + + + +### `provider` + +This information has moved to +[`provider`](/language/meta-arguments/resource-provider). + +
      + + + +### `lifecycle` + +This information has moved to +[`lifecycle`](/language/meta-arguments/lifecycle). + +
      + + + +### Provisioners + +This information has moved to +[Provisioners](/language/resources/provisioners). + +
      diff --git a/website/docs/internals/archiving.html.md b/website/docs/internals/archiving.mdx similarity index 75% rename from website/docs/internals/archiving.html.md rename to website/docs/internals/archiving.mdx index 6c9cad0f179d..5c71326b7d4a 100644 --- a/website/docs/internals/archiving.html.md +++ b/website/docs/internals/archiving.mdx @@ -1,9 +1,9 @@ --- -layout: "docs" -page_title: "Archiving Providers" -sidebar_current: "docs-internals" -description: |- - Terraform is built on a plugin-based architecture, much of which is maintained by our user community. Occasionally, unmaintained providers may archived to reduce confusion for users and developers. +page_title: Archiving Providers +description: >- + Terraform is built on a plugin-based architecture, much of which is maintained + by our user community. Occasionally, unmaintained providers may archived to + reduce confusion for users and developers. --- This function maps -[Terraform language values](/docs/language/expressions/types.html) +[Terraform language values](/language/expressions/types) to YAML tags in the following way: | Terraform type | YAML type | @@ -77,12 +74,12 @@ mean that this is rarely a problem in practice. `yamlencode` always uses YAML's "block style" for mappings and sequences, unless the mapping or sequence is empty. To generate flow-style YAML, use -[`jsonencode`](./jsonencode.html) instead: YAML flow-style is a superset +[`jsonencode`](/language/functions/jsonencode) instead: YAML flow-style is a superset of JSON syntax. ## Related Functions -- [`jsonencode`](./jsonencode.html) is a similar operation using JSON instead +- [`jsonencode`](/language/functions/jsonencode) is a similar operation using JSON instead of YAML. -- [`yamldecode`](./yamldecode.html) performs the opposite operation, _decoding_ +- [`yamldecode`](/language/functions/yamldecode) performs the opposite operation, _decoding_ a YAML string to obtain its represented value. diff --git a/website/docs/language/functions/zipmap.html.md b/website/docs/language/functions/zipmap.mdx similarity index 85% rename from website/docs/language/functions/zipmap.html.md rename to website/docs/language/functions/zipmap.mdx index d37926f74010..c813e3e49175 100644 --- a/website/docs/language/functions/zipmap.html.md +++ b/website/docs/language/functions/zipmap.mdx @@ -1,7 +1,5 @@ --- -layout: "language" -page_title: "zipmap - Functions - Configuration Language" -sidebar_current: "docs-funcs-collection-zipmap" +page_title: zipmap - Functions - Configuration Language description: |- The zipmap function constructs a map from a list of keys and a corresponding list of values. diff --git a/website/docs/language/index.html.md b/website/docs/language/index.mdx similarity index 89% rename from website/docs/language/index.html.md rename to website/docs/language/index.mdx index 6494298909ed..8efe473ee5bf 100644 --- a/website/docs/language/index.html.md +++ b/website/docs/language/index.mdx @@ -1,16 +1,16 @@ --- -layout: "language" -page_title: "Overview - Configuration Language" -description: "You can use the Terraform language to write configuration files that tell Terraform how to manage a collection of infrastructure." - +page_title: Overview - Configuration Language +description: >- + You can use the Terraform language to write configuration files that tell + Terraform how to manage a collection of infrastructure. --- # Terraform Language Documentation This is the documentation for Terraform's configuration language. It is relevant -to users of [Terraform CLI](/docs/cli/index.html), -[Terraform Cloud](/docs/cloud/index.html), and -[Terraform Enterprise](/docs/enterprise/index.html). Terraform's language is +to users of [Terraform CLI](/cli), +[Terraform Cloud](/cloud), and +[Terraform Enterprise](/enterprise). Terraform's language is its primary user interface. Configuration files you write in Terraform language tell Terraform what plugins to install, what infrastructure to create, and what data to fetch. Terraform language also lets you define dependencies @@ -22,7 +22,7 @@ configuration block. ## About the Terraform Language The main purpose of the Terraform language is declaring -[resources](/docs/language/resources/index.html), which represent infrastructure objects. All other +[resources](/language/resources), which represent infrastructure objects. All other language features exist only to make the definition of resources more flexible and convenient. diff --git a/website/docs/language/meta-arguments/count.html.md b/website/docs/language/meta-arguments/count.mdx similarity index 89% rename from website/docs/language/meta-arguments/count.html.md rename to website/docs/language/meta-arguments/count.mdx index ed188d9249a5..7b051c8f1b74 100644 --- a/website/docs/language/meta-arguments/count.html.md +++ b/website/docs/language/meta-arguments/count.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "The count Meta-Argument - Configuration Language" -description: "Count helps you efficiently manage nearly identical infrastructure resources without writing a separate block for each one." +page_title: The count Meta-Argument - Configuration Language +description: >- + Count helps you efficiently manage nearly identical infrastructure resources + without writing a separate block for each one. --- # The `count` Meta-Argument @@ -13,14 +14,14 @@ previous versions can only use it with resources. > **Hands-on:** Try the [Manage Similar Resources With Count](https://learn.hashicorp.com/tutorials/terraform/count?in=terraform/0-13&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. -By default, a [resource block](/docs/language/resources/syntax.html) configures one real +By default, a [resource block](/language/resources/syntax) configures one real infrastructure object. (Similarly, a -[module block](/docs/language/modules/syntax.html) includes a +[module block](/language/modules/syntax) includes a child module's contents into the configuration one time.) However, sometimes you want to manage several similar objects (like a fixed pool of compute instances) without writing a separate block for each one. Terraform has two ways to do this: -`count` and [`for_each`](/docs/language/meta-arguments/for_each.html). +`count` and [`for_each`](/language/meta-arguments/for_each). If a resource or module block includes a `count` argument whose value is a whole number, Terraform will create that many instances. @@ -59,7 +60,7 @@ This object has one attribute: ## Using Expressions in `count` -The `count` meta-argument accepts numeric [expressions](/docs/language/expressions/index.html). +The `count` meta-argument accepts numeric [expressions](/language/expressions). However, unlike most arguments, the `count` value must be known _before_ Terraform performs any remote resource actions. This means `count` can't refer to any resource attributes that aren't known until after a diff --git a/website/docs/language/meta-arguments/depends_on.html.md b/website/docs/language/meta-arguments/depends_on.mdx similarity index 92% rename from website/docs/language/meta-arguments/depends_on.html.md rename to website/docs/language/meta-arguments/depends_on.mdx index 7224007c732a..0792e721afc1 100644 --- a/website/docs/language/meta-arguments/depends_on.html.md +++ b/website/docs/language/meta-arguments/depends_on.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "The depends_on Meta-Argument - Configuration Language" -description: "The depends_on meta-argument allows you to handle hidden resource or module dependencies." +page_title: The depends_on Meta-Argument - Configuration Language +description: >- + The depends_on meta-argument allows you to handle hidden resource or module + dependencies. --- # The `depends_on` Meta-Argument @@ -74,4 +75,3 @@ and thus before it can safely evaluate expressions. The `depends_on` argument should be used only as a last resort. When using it, always include a comment explaining why it is being used, to help future maintainers understand the purpose of the additional dependency. - diff --git a/website/docs/language/meta-arguments/for_each.html.md b/website/docs/language/meta-arguments/for_each.mdx similarity index 83% rename from website/docs/language/meta-arguments/for_each.html.md rename to website/docs/language/meta-arguments/for_each.mdx index 088f424faa86..48dbc67b2a29 100644 --- a/website/docs/language/meta-arguments/for_each.html.md +++ b/website/docs/language/meta-arguments/for_each.mdx @@ -1,19 +1,20 @@ --- -layout: "language" -page_title: "The for_each Meta-Argument - Configuration Language" -description: "The for_each meta-argument allows you to manage similar infrastructure resources without writing a separate block for each one." +page_title: The for_each Meta-Argument - Configuration Language +description: >- + The for_each meta-argument allows you to manage similar infrastructure + resources without writing a separate block for each one. --- # The `for_each` Meta-Argument -By default, a [resource block](/docs/language/resources/syntax.html) configures one real +By default, a [resource block](/language/resources/syntax) configures one real infrastructure object (and similarly, a -[module block](/docs/language/modules/syntax.html) includes a +[module block](/language/modules/syntax) includes a child module's contents into the configuration one time). However, sometimes you want to manage several similar objects (like a fixed pool of compute instances) without writing a separate block for each one. Terraform has two ways to do this: -[`count`](/docs/language/meta-arguments/count.html) and `for_each`. +[`count`](/language/meta-arguments/count) and `for_each`. > **Hands-on:** Try the [Manage Similar Resources With For Each](https://learn.hashicorp.com/tutorials/terraform/for-each?in=terraform/configuration-language) tutorial on HashiCorp Learn. @@ -108,16 +109,16 @@ that cannot be determined before apply, and a `-target` may be needed. including `uuid`, `bcrypt`, or `timestamp`, as their evaluation is deferred during the main evaluation step. -Sensitive values, such as [sensitive input variables](https://www.terraform.io/docs/language/values/variables.html#suppressing-values-in-cli-output), -[sensitive outputs](https://www.terraform.io/docs/language/values/outputs.html#sensitive-suppressing-values-in-cli-output), -or [sensitive resource attributes](https://www.terraform.io/docs/language/expressions/references.html#sensitive-resource-attributes), +Sensitive values, such as [sensitive input variables](/language/values/variables#suppressing-values-in-cli-output), +[sensitive outputs](/language/values/outputs#sensitive-suppressing-values-in-cli-output), +or [sensitive resource attributes](/language/expressions/references#sensitive-resource-attributes), cannot be used as arguments to `for_each`. The value used in `for_each` is used to identify the resource instance and will always be disclosed in UI output, which is why sensitive values are not allowed. Attempts to use sensitive values as `for_each` arguments will result in an error. If you transform a value containing sensitive data into an argument to be used in `for_each`, be aware that -[most functions in Terraform will return a sensitive result if given an argument with any sensitive content](https://www.terraform.io/docs/language/expressions/function-calls.html#using-sensitive-data-as-function-arguments). +[most functions in Terraform will return a sensitive result if given an argument with any sensitive content](/language/expressions/function-calls#using-sensitive-data-as-function-arguments). In many cases, you can achieve similar results to a function used for this purpose by using a `for` expression. For example, if you would like to call `keys(local.map)`, where `local.map` is an object with sensitive values (but non-sensitive keys), you can create a @@ -125,7 +126,7 @@ value to pass to `for_each` with `toset([for k,v in local.map : k])`. ## Using Expressions in `for_each` -The `for_each` meta-argument accepts map or set [expressions](/docs/language/expressions/index.html). +The `for_each` meta-argument accepts map or set [expressions](/language/expressions). However, unlike most arguments, the `for_each` value must be known _before_ Terraform performs any remote resource actions. This means `for_each` can't refer to any resource attributes that aren't known until after a @@ -134,7 +135,7 @@ an object is created). The `for_each` value must be a map or set with one element per desired resource instance. When providing a set, you must use an expression that -explicitly returns a set value, like the [`toset`](/docs/language/functions/toset.html) +explicitly returns a set value, like the [`toset`](/language/functions/toset) function; to prevent unwanted surprises during conversion, the `for_each` argument does not implicitly convert lists or tuples to sets. If you need to declare resource instances based on a nested @@ -142,11 +143,11 @@ data structure or combinations of elements from multiple data structures you can use Terraform expressions and functions to derive a suitable value. For example: -* Transform a multi-level nested structure into a flat list by - [using nested `for` expressions with the `flatten` function](/docs/language/functions/flatten.html#flattening-nested-structures-for-for_each). -* Produce an exhaustive list of combinations of elements from two or more +- Transform a multi-level nested structure into a flat list by + [using nested `for` expressions with the `flatten` function](/language/functions/flatten#flattening-nested-structures-for-for_each). +- Produce an exhaustive list of combinations of elements from two or more collections by - [using the `setproduct` function inside a `for` expression](/docs/language/functions/setproduct.html#finding-combinations-for-for_each). + [using the `setproduct` function inside a `for` expression](/language/functions/setproduct#finding-combinations-for-for_each). ### Chaining `for_each` Between Resources @@ -226,7 +227,7 @@ as a whole. ## Using Sets The Terraform language doesn't have a literal syntax for -[set values](/docs/language/expressions/type-constraints.html#collection-types), but you can use the `toset` +[set values](/language/expressions/type-constraints#collection-types), but you can use the `toset` function to explicitly convert a list of strings to a set: ```hcl @@ -255,7 +256,7 @@ removes any duplicate elements. `toset(["b", "a", "b"])` will produce a set containing only `"a"` and `"b"` in no particular order; the second `"b"` is discarded. -If you are writing a module with an [input variable](/docs/language/values/variables.html) that +If you are writing a module with an [input variable](/language/values/variables) that will be used as a set of strings for `for_each`, you can set its type to `set(string)` to avoid the need for an explicit type conversion: diff --git a/website/docs/language/meta-arguments/lifecycle.html.md b/website/docs/language/meta-arguments/lifecycle.html.md deleted file mode 100644 index 840ab71a5ea1..000000000000 --- a/website/docs/language/meta-arguments/lifecycle.html.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -layout: "language" -page_title: "The lifecycle Meta-Argument - Configuration Language" -description: "The meta-arguments in a lifecycle block allow you to customize resource behavior." ---- - -# The `lifecycle` Meta-Argument - -> **Hands-on:** Try the [Lifecycle Management](https://learn.hashicorp.com/tutorials/terraform/resource-lifecycle?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. - -The general lifecycle for resources is described in the -[Resource Behavior](/docs/language/resources/behavior.html) page. Some details of -that behavior can be customized using the special nested `lifecycle` block -within a resource block body: - -```hcl -resource "azurerm_resource_group" "example" { - # ... - - lifecycle { - create_before_destroy = true - } -} -``` - -## Syntax and Arguments - -`lifecycle` is a nested block that can appear within a resource block. -The `lifecycle` block and its contents are meta-arguments, available -for all `resource` blocks regardless of type. - -The following arguments can be used within a `lifecycle` block: - -* `create_before_destroy` (bool) - By default, when Terraform must change - a resource argument that cannot be updated in-place due to - remote API limitations, Terraform will instead destroy the existing object - and then create a new replacement object with the new configured arguments. - - The `create_before_destroy` meta-argument changes this behavior so that - the new replacement object is created _first,_ and the prior object - is destroyed after the replacement is created. - - This is an opt-in behavior because many remote object types have unique - name requirements or other constraints that must be accommodated for - both a new and an old object to exist concurrently. Some resource types - offer special options to append a random suffix onto each object name to - avoid collisions, for example. Terraform CLI cannot automatically activate - such features, so you must understand the constraints for each resource - type before using `create_before_destroy` with it. - - Destroy provisioners of this resource will not run if `create_before_destroy` - is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. - -* `prevent_destroy` (bool) - This meta-argument, when set to `true`, will - cause Terraform to reject with an error any plan that would destroy the - infrastructure object associated with the resource, as long as the argument - remains present in the configuration. - - This can be used as a measure of safety against the accidental replacement - of objects that may be costly to reproduce, such as database instances. - However, it will make certain configuration changes impossible to apply, - and will prevent the use of the `terraform destroy` command once such - objects are created, and so this option should be used sparingly. - - Since this argument must be present in configuration for the protection to - apply, note that this setting does not prevent the remote object from - being destroyed if the `resource` block were removed from configuration - entirely: in that case, the `prevent_destroy` setting is removed along - with it, and so Terraform will allow the destroy operation to succeed. - -* `ignore_changes` (list of attribute names) - By default, Terraform detects - any difference in the current settings of a real infrastructure object - and plans to update the remote object to match configuration. - - The `ignore_changes` feature is intended to be used when a resource is - created with references to data that may change in the future, but should - not affect said resource after its creation. In some rare cases, settings - of a remote object are modified by processes outside of Terraform, which - Terraform would then attempt to "fix" on the next run. In order to make - Terraform share management responsibilities of a single object with a - separate process, the `ignore_changes` meta-argument specifies resource - attributes that Terraform should ignore when planning updates to the - associated remote object. - - The arguments corresponding to the given attribute names are considered - when planning a _create_ operation, but are ignored when planning an - _update_. The arguments are the relative address of the attributes in the - resource. Map and list elements can be referenced using index notation, - like `tags["Name"]` and `list[0]` respectively. - - ```hcl - resource "aws_instance" "example" { - # ... - - lifecycle { - ignore_changes = [ - # Ignore changes to tags, e.g. because a management agent - # updates these based on some ruleset managed elsewhere. - tags, - ] - } - } - ``` - - Instead of a list, the special keyword `all` may be used to instruct - Terraform to ignore _all_ attributes, which means that Terraform can - create and destroy the remote object but will never propose updates to it. - - Only attributes defined by the resource type can be ignored. - `ignore_changes` cannot be applied to itself or to any other meta-arguments. - -## Literal Values Only - -The `lifecycle` settings all affect how Terraform constructs and traverses -the dependency graph. As a result, only literal values can be used because -the processing happens too early for arbitrary expression evaluation. diff --git a/website/docs/language/meta-arguments/lifecycle.mdx b/website/docs/language/meta-arguments/lifecycle.mdx new file mode 100644 index 000000000000..1554bcb397f8 --- /dev/null +++ b/website/docs/language/meta-arguments/lifecycle.mdx @@ -0,0 +1,117 @@ +--- +page_title: The lifecycle Meta-Argument - Configuration Language +description: >- + The meta-arguments in a lifecycle block allow you to customize resource + behavior. +--- + +# The `lifecycle` Meta-Argument + +> **Hands-on:** Try the [Lifecycle Management](https://learn.hashicorp.com/tutorials/terraform/resource-lifecycle?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. + +The general lifecycle for resources is described in the +[Resource Behavior](/language/resources/behavior) page. Some details of +that behavior can be customized using the special nested `lifecycle` block +within a resource block body: + +```hcl +resource "azurerm_resource_group" "example" { + # ... + + lifecycle { + create_before_destroy = true + } +} +``` + +## Syntax and Arguments + +`lifecycle` is a nested block that can appear within a resource block. +The `lifecycle` block and its contents are meta-arguments, available +for all `resource` blocks regardless of type. + +The following arguments can be used within a `lifecycle` block: + +* `create_before_destroy` (bool) - By default, when Terraform must change + a resource argument that cannot be updated in-place due to + remote API limitations, Terraform will instead destroy the existing object + and then create a new replacement object with the new configured arguments. + + The `create_before_destroy` meta-argument changes this behavior so that + the new replacement object is created _first,_ and the prior object + is destroyed after the replacement is created. + + This is an opt-in behavior because many remote object types have unique + name requirements or other constraints that must be accommodated for + both a new and an old object to exist concurrently. Some resource types + offer special options to append a random suffix onto each object name to + avoid collisions, for example. Terraform CLI cannot automatically activate + such features, so you must understand the constraints for each resource + type before using `create_before_destroy` with it. + + Destroy provisioners of this resource will not run if `create_before_destroy` + is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. + +* `prevent_destroy` (bool) - This meta-argument, when set to `true`, will + cause Terraform to reject with an error any plan that would destroy the + infrastructure object associated with the resource, as long as the argument + remains present in the configuration. + + This can be used as a measure of safety against the accidental replacement + of objects that may be costly to reproduce, such as database instances. + However, it will make certain configuration changes impossible to apply, + and will prevent the use of the `terraform destroy` command once such + objects are created, and so this option should be used sparingly. + + Since this argument must be present in configuration for the protection to + apply, note that this setting does not prevent the remote object from + being destroyed if the `resource` block were removed from configuration + entirely: in that case, the `prevent_destroy` setting is removed along + with it, and so Terraform will allow the destroy operation to succeed. + +* `ignore_changes` (list of attribute names) - By default, Terraform detects + any difference in the current settings of a real infrastructure object + and plans to update the remote object to match configuration. + + The `ignore_changes` feature is intended to be used when a resource is + created with references to data that may change in the future, but should + not affect said resource after its creation. In some rare cases, settings + of a remote object are modified by processes outside of Terraform, which + Terraform would then attempt to "fix" on the next run. In order to make + Terraform share management responsibilities of a single object with a + separate process, the `ignore_changes` meta-argument specifies resource + attributes that Terraform should ignore when planning updates to the + associated remote object. + + The arguments corresponding to the given attribute names are considered + when planning a _create_ operation, but are ignored when planning an + _update_. The arguments are the relative address of the attributes in the + resource. Map and list elements can be referenced using index notation, + like `tags["Name"]` and `list[0]` respectively. + + ```hcl + resource "aws_instance" "example" { + # ... + + lifecycle { + ignore_changes = [ + # Ignore changes to tags, e.g. because a management agent + # updates these based on some ruleset managed elsewhere. + tags, + ] + } + } + ``` + + Instead of a list, the special keyword `all` may be used to instruct + Terraform to ignore _all_ attributes, which means that Terraform can + create and destroy the remote object but will never propose updates to it. + + Only attributes defined by the resource type can be ignored. + `ignore_changes` cannot be applied to itself or to any other meta-arguments. + +## Literal Values Only + +The `lifecycle` settings all affect how Terraform constructs and traverses +the dependency graph. As a result, only literal values can be used because +the processing happens too early for arbitrary expression evaluation. diff --git a/website/docs/language/meta-arguments/module-providers.html.md b/website/docs/language/meta-arguments/module-providers.mdx similarity index 88% rename from website/docs/language/meta-arguments/module-providers.html.md rename to website/docs/language/meta-arguments/module-providers.mdx index 0103fd0302a9..2b7f7d9a9ea5 100644 --- a/website/docs/language/meta-arguments/module-providers.html.md +++ b/website/docs/language/meta-arguments/module-providers.mdx @@ -1,14 +1,15 @@ --- -layout: "language" -page_title: "The Module providers Meta-Argument - Configuration Language" -description: "The providers meta-argument specifies which provider configurations from a parent module are available in a child module." +page_title: The Module providers Meta-Argument - Configuration Language +description: >- + The providers meta-argument specifies which provider configurations from a + parent module are available in a child module. --- # The Module `providers` Meta-Argument -In a [module call](/docs/language/modules/syntax.html) block, the +In a [module call](/language/modules/syntax) block, the optional `providers` meta-argument specifies which -[provider configurations](/docs/language/providers/configuration.html) from the parent +[provider configurations](/language/providers/configuration) from the parent module will be available inside the child module. ```hcl @@ -37,7 +38,7 @@ module "example" { ## Default Behavior: Inherit Default Providers -If the child module does not declare any [configuration aliases](/docs/language/modules/develop/providers.html#provider-aliases-within-modules), +If the child module does not declare any [configuration aliases](/language/modules/develop/providers#provider-aliases-within-modules), the `providers` argument is optional. If you omit it, a child module inherits all of the _default_ provider configurations from its parent module. (Default provider configurations are ones that don't use the `alias` argument.) @@ -122,4 +123,4 @@ names it needs. For more details and guidance about working with providers inside a re-usable child module, see -[Module Development: Providers Within Modules](/docs/language/modules/develop/providers.html). +[Module Development: Providers Within Modules](/language/modules/develop/providers). diff --git a/website/docs/language/meta-arguments/resource-provider.html.md b/website/docs/language/meta-arguments/resource-provider.mdx similarity index 79% rename from website/docs/language/meta-arguments/resource-provider.html.md rename to website/docs/language/meta-arguments/resource-provider.mdx index 21eaad48d47b..683eaa3e0195 100644 --- a/website/docs/language/meta-arguments/resource-provider.html.md +++ b/website/docs/language/meta-arguments/resource-provider.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "The Resource provider Meta-Argument - Configuration Language" -description: "The provider meta-argument specifies the provider configuration Terraform should use for a resource, overriding Terraform's default behavior." +page_title: The Resource provider Meta-Argument - Configuration Language +description: >- + The provider meta-argument specifies the provider configuration Terraform + should use for a resource, overriding Terraform's default behavior. --- # The Resource `provider` Meta-Argument @@ -10,7 +11,7 @@ The `provider` meta-argument specifies which provider configuration to use for a overriding Terraform's default behavior of selecting one based on the resource type name. Its value should be an unquoted `.` reference. -As described in [Provider Configuration](/docs/language/providers/configuration.html), you can optionally +As described in [Provider Configuration](/language/providers/configuration), you can optionally create multiple configurations for a single provider (usually to manage resources in different regions of multi-region services). Each provider can have one default configuration, and any number of alternate configurations that @@ -52,7 +53,7 @@ ensure that the provider is fully configured before any resource actions are taken. The `provider` meta-argument expects -[a `.` reference](/docs/language/providers/configuration.html#referring-to-alternate-provider-configurations), +[a `.` reference](/language/providers/configuration#referring-to-alternate-provider-configurations), which does not need to be quoted. Arbitrary expressions are not permitted for `provider` because it must be resolved while Terraform is constructing the dependency graph, before it is safe to evaluate expressions. diff --git a/website/docs/language/modules/develop/composition.html.md b/website/docs/language/modules/develop/composition.mdx similarity index 98% rename from website/docs/language/modules/develop/composition.html.md rename to website/docs/language/modules/develop/composition.mdx index 96c2da68579e..a083597e58c6 100644 --- a/website/docs/language/modules/develop/composition.html.md +++ b/website/docs/language/modules/develop/composition.mdx @@ -1,7 +1,5 @@ --- -layout: "language" -page_title: "Module Composition" -sidebar_current: "docs-modules-composition" +page_title: Module Composition description: |- Module composition allows infrastructure to be described from modular building blocks. @@ -310,7 +308,7 @@ Most modules contain `resource` blocks and thus describe infrastructure to be created and managed. It may sometimes be useful to write modules that do not describe any new infrastructure at all, but merely retrieve information about existing infrastructure that was created elsewhere using -[data sources](/docs/language/data-sources/index.html). +[data sources](/language/data-sources). As with conventional modules, we suggest using this technique only when the module raises the level of abstraction in some way, in this case by @@ -346,7 +344,7 @@ data sources, or it could read saved information from a Consul cluster using [`consul_keys`](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/keys), or it might read the outputs directly from the state of the configuration that manages the network using -[`terraform_remote_state`](https://www.terraform.io/docs/language/state/remote-state-data.html). +[`terraform_remote_state`](/language/state/remote-state-data). The key benefit of this approach is that the source of this information can change over time without updating every configuration that depends on it. diff --git a/website/docs/language/modules/develop/index.html.md b/website/docs/language/modules/develop/index.mdx similarity index 77% rename from website/docs/language/modules/develop/index.html.md rename to website/docs/language/modules/develop/index.mdx index 98b28ea7c576..760b5ea7a86d 100644 --- a/website/docs/language/modules/develop/index.html.md +++ b/website/docs/language/modules/develop/index.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Creating Modules" -sidebar_current: "docs-modules" -description: "Modules are containers for multiple resources that are used together in a configuration. Learn when to create modules and about module structure." +page_title: Creating Modules +description: >- + Modules are containers for multiple resources that are used together in a + configuration. Learn when to create modules and about module structure. --- # Creating Modules @@ -14,27 +14,27 @@ Modules can be used to create lightweight abstractions, so that you can describe your infrastructure in terms of its architecture, rather than directly in terms of physical objects. -The `.tf` files in your working directory when you run [`terraform plan`](/docs/cli/commands/plan.html) -or [`terraform apply`](/docs/cli/commands/apply.html) together form the _root_ -module. That module may [call other modules](/docs/language/modules/syntax.html#calling-a-child-module) +The `.tf` files in your working directory when you run [`terraform plan`](/cli/commands/plan) +or [`terraform apply`](/cli/commands/apply) together form the _root_ +module. That module may [call other modules](/language/modules/syntax#calling-a-child-module) and connect them together by passing output values from one to input values of another. -To learn how to _use_ modules, see [the Modules configuration section](/docs/language/modules/index.html). +To learn how to _use_ modules, see [the Modules configuration section](/language/modules). This section is about _creating_ re-usable modules that other configurations can include using `module` blocks. ## Module structure Re-usable modules are defined using all of the same -[configuration language](/docs/language/index.html) concepts we use in root modules. +[configuration language](/language) concepts we use in root modules. Most commonly, modules use: -* [Input variables](/docs/language/values/variables.html) to accept values from +* [Input variables](/language/values/variables) to accept values from the calling module. -* [Output values](/docs/language/values/outputs.html) to return results to the +* [Output values](/language/values/outputs) to return results to the calling module, which it can then use to populate arguments elsewhere. -* [Resources](/docs/language/resources/index.html) to define one or more +* [Resources](/language/resources) to define one or more infrastructure objects that the module will manage. To define a module, create a new directory for it and place one or more `.tf` @@ -44,7 +44,7 @@ be re-used by lots of configurations you may wish to place it in its own version control repository. Modules can also call other modules using a `module` block, but we recommend -keeping the module tree relatively flat and using [module composition](./composition.html) +keeping the module tree relatively flat and using [module composition](/language/modules/develop/composition) as an alternative to a deeply-nested tree of modules, because this makes the individual modules easier to re-use in different combinations. @@ -72,7 +72,7 @@ calling module instead. ## Refactoring module resources -You can include [refactoring blocks](refactoring.html) to record how resource +You can include [refactoring blocks](/language/modules/develop/refactoring) to record how resource names and module structure have changed from previous module versions. Terraform uses that information during planning to reinterpret existing objects as if they had been created at the corresponding new addresses, eliminating a diff --git a/website/docs/language/modules/develop/providers.html.md b/website/docs/language/modules/develop/providers.mdx similarity index 94% rename from website/docs/language/modules/develop/providers.html.md rename to website/docs/language/modules/develop/providers.mdx index fd5db189aede..32864a6b6d74 100644 --- a/website/docs/language/modules/develop/providers.html.md +++ b/website/docs/language/modules/develop/providers.mdx @@ -1,6 +1,5 @@ --- -layout: "language" -page_title: "Providers Within Modules - Configuration Language" +page_title: Providers Within Modules - Configuration Language --- # Providers Within Modules @@ -45,10 +44,10 @@ to reintroduce the provider configuration. ## Provider Version Constraints in Modules Although provider _configurations_ are shared between modules, each module must -declare its own [provider requirements](/docs/language/providers/requirements.html), so that +declare its own [provider requirements](/language/providers/requirements), so that Terraform can ensure that there is a single version of the provider that is compatible with all modules in the configuration and to specify the -[source address](/docs/language/providers/requirements.html#source-addresses) that serves as +[source address](/language/providers/requirements#source-addresses) that serves as the global (module-agnostic) identifier for a provider. To declare that a module requires particular versions of a specific provider, @@ -71,7 +70,7 @@ however, specify any of the configuration settings that determine what remote endpoints the provider will access, such as an AWS region; configuration settings come from provider _configurations_, and a particular overall Terraform configuration can potentially have -[several different configurations for the same provider](/docs/language/providers/configuration.html#alias-multiple-provider-configurations). +[several different configurations for the same provider](/language/providers/configuration#alias-multiple-provider-configurations). ## Provider Aliases Within Modules @@ -133,10 +132,10 @@ resource "aws_s3_bucket" "example" { We recommend using this approach when a single configuration for each provider is sufficient for an entire configuration. -~> **Note:** Only provider configurations are inherited by child modules, not provider source or version requirements. Each module must [declare its own provider requirements](/docs/language/providers/requirements.html). This is especially important for non-HashiCorp providers. +~> **Note:** Only provider configurations are inherited by child modules, not provider source or version requirements. Each module must [declare its own provider requirements](/language/providers/requirements). This is especially important for non-HashiCorp providers. In more complex situations there may be -[multiple provider configurations](/docs/language/providers/configuration.html#alias-multiple-provider-configurations), +[multiple provider configurations](/language/providers/configuration#alias-multiple-provider-configurations), or a child module may need to use different provider settings than its parent. For such situations, you must pass providers explicitly. @@ -173,7 +172,7 @@ module "example" { ``` The `providers` argument within a `module` block is similar to -[the `provider` argument](/docs/language/meta-arguments/resource-provider.html) +[the `provider` argument](/language/meta-arguments/resource-provider) within a resource, but is a map rather than a single string because a module may contain resources from many different providers. diff --git a/website/docs/language/modules/develop/publish.html.md b/website/docs/language/modules/develop/publish.mdx similarity index 76% rename from website/docs/language/modules/develop/publish.html.md rename to website/docs/language/modules/develop/publish.mdx index 2f1419dbbaba..6a5e0992d6d5 100644 --- a/website/docs/language/modules/develop/publish.html.md +++ b/website/docs/language/modules/develop/publish.mdx @@ -1,20 +1,17 @@ --- -layout: "language" -page_title: "Publishing Modules" -sidebar_current: "docs-modules-publish" -description: |- - A module is a container for multiple resources that are used together. +page_title: Publishing Modules +description: A module is a container for multiple resources that are used together. --- # Publishing Modules If you've built a module that you intend to be reused, we recommend -[publishing the module](/docs/registry/modules/publish.html) on the +[publishing the module](/registry/modules/publish) on the [Terraform Registry](https://registry.terraform.io). This will version your module, generate documentation, and more. Published modules can be easily consumed by Terraform, and users can -[constrain module versions](/docs/language/modules/syntax.html#version) +[constrain module versions](/language/modules/syntax#version) for safe and predictable updates. The following example shows how a caller might use a module from the Terraform Registry: @@ -25,21 +22,20 @@ module "consul" { ``` If you do not wish to publish your modules in the public registry, you can -instead use a [private registry](/docs/registry/private.html) to get +instead use a [private registry](/registry/private) to get the same benefits. We welcome contributions of Terraform modules from our community members, partners, and customers. Our ecosystem is made richer by each new module created or an existing one updated, as they reflect the wide range of experience and technical requirements of the community that uses them. Our cloud provider partners often seek to develop specific modules for popular or challenging use cases on their platform and utilize them as valuable learning experiences to empathize with their users. Similarly, our community module developers incorporate a variety of opinions and use cases from the broader Terraform community. Both types of modules have their place in the Terraform registry, accessible to practitioners who can decide which modules best fit their requirements. - ## Distribution via other sources Although the registry is the native mechanism for distributing re-usable modules, Terraform can also install modules from -[various other sources](/docs/language/modules/sources.html). The alternative sources +[various other sources](/language/modules/sources). The alternative sources do not support the first-class versioning mechanism, but some sources have their own mechanisms for selecting particular VCS commits, etc. We recommend that modules distributed via other protocols still use the -[standard module structure](/docs/language/modules/develop/structure.html) so that they can +[standard module structure](/language/modules/develop/structure) so that they can be used in a similar way as a registry module or be published on the registry at a later time. diff --git a/website/docs/language/modules/develop/refactoring.html.md b/website/docs/language/modules/develop/refactoring.mdx similarity index 95% rename from website/docs/language/modules/develop/refactoring.html.md rename to website/docs/language/modules/develop/refactoring.mdx index b094608ad58a..210d025ce033 100644 --- a/website/docs/language/modules/develop/refactoring.html.md +++ b/website/docs/language/modules/develop/refactoring.mdx @@ -1,15 +1,12 @@ --- -layout: "language" -page_title: "Refactoring" -sidebar_current: "docs-modules-recactoring" -description: |- - How to make backward-compatible changes to modules already in use. +page_title: Refactoring +description: How to make backward-compatible changes to modules already in use. --- # Refactoring -> **Note:** Explicit refactoring declarations with `moved` blocks is available in Terraform v1.1 and later. For earlier Terraform versions or for refactoring actions too complex to express as `moved` blocks, you can -use the [`terraform state mv` CLI command](/docs/cli/commands/state/mv.html) +use the [`terraform state mv` CLI command](/cli/commands/state/mv) as a separate step. In shared modules and long-lived configurations, you may eventually outgrow @@ -125,7 +122,7 @@ resource "aws_instance" "a" { Applying this configuration would lead to Terraform creating an object bound to the address `aws_instance.a`. -Later, you use [`for_each`](../../meta-arguments/for_each.html) with this +Later, you use [`for_each`](/language/meta-arguments/for_each) with this resource to systematically declare multiple instances. To preserve an object that was previously associated with `aws_instance.a` alone, you must add a `moved` block to specify which instance key the object will take in the new @@ -264,7 +261,7 @@ Applying this configuration would cause Terraform to create objects whose addresses begin with `module.a`. In later module versions, you may need to use -[`count`](../../meta-arguments/count.html) with this resource to systematically +[`count`](/language/meta-arguments/count) with this resource to systematically declare multiple instances. To preserve an object that was previously associated with `aws_instance.a` alone, you can add a `moved` block to specify which instance key that object will take in the new configuration: @@ -328,8 +325,8 @@ To achieve this refactoring without replacing existing objects bound to the old resource addresses, you must: 1. Write module "x", copying over the two resources it should contain. -2. Write module "y", copying over the one resource it should contain. -3. Edit the original module to no longer include any of these resources, and +1. Write module "y", copying over the one resource it should contain. +1. Edit the original module to no longer include any of these resources, and instead to contain only shim configuration to migrate existing users. The new modules "x" and "y" should contain only `resource` blocks: @@ -401,13 +398,13 @@ typical rule that a parent module sees its child module as a "closed box", unaware of exactly which resources are declared inside it. This compromise assumes that all three of these modules are maintained by the same people and distributed together in a single -[module package](../sources.html#modules-in-package-sub-directories). +[module package](/language/modules/sources#modules-in-package-sub-directories). -To reduce [coupling](https://en.wikipedia.org/wiki/Coupling_(computer_programming)) +To reduce [coupling](https://en.wikipedia.org/wiki/Coupling_\(computer_programming\)) between separately-packaged modules, Terraform only allows declarations of moves between modules in the same package. In other words, Terraform would not have allowed moving into `module.x` above if the `source` address of -that call had not been a [local path](../sources.html#local-paths). +that call had not been a [local path](/language/modules/sources#local-paths). Terraform resolves module references in `moved` blocks relative to the module instance they are defined in. For example, if the original module above were @@ -439,7 +436,6 @@ If you do decide to remove `moved` blocks, proceed with caution. It can be safe If you need to rename or move the same object twice, we recommend documenting the full history using _chained_ `moved` blocks, where the new block refers to the existing block: - ```hcl moved { from = aws_instance.a diff --git a/website/docs/language/modules/develop/structure.html.md b/website/docs/language/modules/develop/structure.mdx similarity index 95% rename from website/docs/language/modules/develop/structure.html.md rename to website/docs/language/modules/develop/structure.mdx index 6aed2b2651e7..dbe2db33c3c6 100644 --- a/website/docs/language/modules/develop/structure.html.md +++ b/website/docs/language/modules/develop/structure.mdx @@ -1,6 +1,5 @@ --- -layout: "language" -page_title: "Standard Module Structure" +page_title: Standard Module Structure --- # Standard Module Structure @@ -54,8 +53,8 @@ don't need to do any extra work to follow the standard structure. * **Variables and outputs should have descriptions.** All variables and outputs should have one or two sentence descriptions that explain their purpose. This is used for documentation. See the documentation for - [variable configuration](/docs/language/values/variables.html) and - [output configuration](/docs/language/values/outputs.html) for more details. + [variable configuration](/language/values/variables) and + [output configuration](/language/values/outputs) for more details. * **Nested modules**. Nested modules should exist under the `modules/` subdirectory. Any nested module with a `README.md` is considered usable @@ -75,7 +74,7 @@ don't need to do any extra work to follow the standard structure. again separately. If a repository or package contains multiple nested modules, they should - ideally be [composable](./composition.html) by the caller, rather than + ideally be [composable](/language/modules/develop/composition) by the caller, rather than calling directly to each other and creating a deeply-nested tree of modules. * **Examples**. Examples of using the module should exist under the diff --git a/website/docs/language/modules/index.html.md b/website/docs/language/modules/index.mdx similarity index 71% rename from website/docs/language/modules/index.html.md rename to website/docs/language/modules/index.mdx index a1c1227689a8..bbfad4e8e1a7 100644 --- a/website/docs/language/modules/index.html.md +++ b/website/docs/language/modules/index.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "Modules Overview - Configuration Language" -description: "Modules are containers for multiple resources that are used together in a configuration. Find resources for using, developing, and publishing modules." +page_title: Modules Overview - Configuration Language +description: >- + Modules are containers for multiple resources that are used together in a + configuration. Find resources for using, developing, and publishing modules. --- # Modules @@ -43,27 +44,27 @@ download them automatically if you specify the appropriate source and version in a module call block. Also, members of your organization might produce modules specifically crafted -for your own infrastructure needs. [Terraform Cloud](/docs/cloud/index.html) and -[Terraform Enterprise](/docs/enterprise/index.html) both include a private +for your own infrastructure needs. [Terraform Cloud](/cloud) and +[Terraform Enterprise](/enterprise) both include a private module registry for sharing modules internally within your organization. ## Using Modules -- [Module Blocks](/docs/language/modules/syntax.html) documents the syntax for +- [Module Blocks](/language/modules/syntax) documents the syntax for calling a child module from a parent module, including meta-arguments like `for_each`. -- [Module Sources](/docs/language/modules/sources.html) documents what kinds of paths, +- [Module Sources](/language/modules/sources) documents what kinds of paths, addresses, and URIs can be used in the `source` argument of a module block. - The Meta-Arguments section documents special arguments that can be used with every module, including - [`providers`](/docs/language/meta-arguments/module-providers.html), - [`depends_on`](/docs/language/meta-arguments/depends_on.html), - [`count`](/docs/language/meta-arguments/count.html), - and [`for_each`](/docs/language/meta-arguments/for_each.html). + [`providers`](/language/meta-arguments/module-providers), + [`depends_on`](/language/meta-arguments/depends_on), + [`count`](/language/meta-arguments/count), + and [`for_each`](/language/meta-arguments/for_each). ## Developing Modules For information about developing reusable modules, see -[Module Development](/docs/language/modules/develop/index.html). +[Module Development](/language/modules/develop). diff --git a/website/docs/language/modules/sources.html.md b/website/docs/language/modules/sources.mdx similarity index 92% rename from website/docs/language/modules/sources.html.md rename to website/docs/language/modules/sources.mdx index b9db802faf3e..1af189b9426a 100644 --- a/website/docs/language/modules/sources.html.md +++ b/website/docs/language/modules/sources.mdx @@ -1,13 +1,14 @@ --- -layout: "language" -page_title: "Module Sources" -sidebar_current: "docs-modules-sources" -description: "The source argument tells Terraform where to find child modules's configurations in locations like GitHub, the Terraform Registry, Bitbucket, Git, Mercurial, S3, and GCS." +page_title: Module Sources +description: >- + The source argument tells Terraform where to find child modules's + configurations in locations like GitHub, the Terraform Registry, Bitbucket, + Git, Mercurial, S3, and GCS. --- # Module Sources -The `source` argument in [a `module` block](/docs/language/modules/syntax.html) +The `source` argument in [a `module` block](/language/modules/syntax) tells Terraform where to find the source code for the desired child module. Terraform uses this during the module installation step of `terraform init` @@ -16,28 +17,28 @@ used by other Terraform commands. > **Hands-on:** Try our HashiCorp Learn tutorials to use modules from [the > registry](https://learn.hashicorp.com/tutorials/terraform/module-use) ->or [locally](https://learn.hashicorp.com/tutorials/terraform/module-create). +> or [locally](https://learn.hashicorp.com/tutorials/terraform/module-create). The module installer supports installation from a number of different source types, as listed below. - * [Local paths](#local-paths) +* [Local paths](#local-paths) - * [Terraform Registry](#terraform-registry) +* [Terraform Registry](#terraform-registry) - * [GitHub](#github) +* [GitHub](#github) - * [Bitbucket](#bitbucket) +* [Bitbucket](#bitbucket) - * Generic [Git](#generic-git-repository), [Mercurial](#generic-mercurial-repository) repositories +* Generic [Git](#generic-git-repository), [Mercurial](#generic-mercurial-repository) repositories - * [HTTP URLs](#http-urls) +* [HTTP URLs](#http-urls) - * [S3 buckets](#s3-bucket) +* [S3 buckets](#s3-bucket) - * [GCS buckets](#gcs-bucket) +* [GCS buckets](#gcs-bucket) - * [Modules in Package Sub-directories](#modules-in-package-sub-directories) +* [Modules in Package Sub-directories](#modules-in-package-sub-directories) Each of these is described in the following sections. Module source addresses use a _URL-like_ syntax, but with extensions to support unambiguous selection @@ -99,10 +100,10 @@ to get started with Terraform and find modules created by others in the community. You can also use a -[private registry](/docs/registry/private.html), either +[private registry](/registry/private), either via the built-in feature from Terraform Cloud, or by running a custom service that implements -[the module registry protocol](/docs/registry/api.html). +[the module registry protocol](/registry/api-docs). Modules on the public Terraform Registry can be referenced using a registry source address of the form `//`, with each @@ -138,13 +139,13 @@ the `remote` backend. Registry modules support versioning. You can provide a specific version as shown in the above examples, or use flexible -[version constraints](/docs/language/modules/syntax.html#version). +[version constraints](/language/modules/syntax#version). You can learn more about the registry at the -[Terraform Registry documentation](/docs/registry/modules/use.html#using-modules). +[Terraform Registry documentation](/registry/modules/use#using-modules). To access modules from a private registry, you may need to configure an access -token [in the CLI config](/docs/cli/config/config-file.html#credentials). Use the +token [in the CLI config](/cli/config/config-file#credentials). Use the same hostname as used in the module source string. For a private registry within Terraform Cloud, use the same authentication token as you would use with the Enterprise API or command-line clients. @@ -231,7 +232,7 @@ to select a suitable source of credentials for your environment. If your Terraform configuration will be used within [Terraform Cloud](https://www.hashicorp.com/products/terraform), only SSH key authentication is supported, and -[keys can be configured on a per-workspace basis](/docs/cloud/workspaces/ssh-keys.html). +[keys can be configured on a per-workspace basis](/cloud-docs/workspaces/settings/ssh-keys). ### Selecting a Revision @@ -266,7 +267,6 @@ module "storage" { } ``` - If you use the `ssh://` URL scheme then Terraform will assume that the colon marks the beginning of a port number, rather than the beginning of the path. This matches how Git itself interprets these different forms, aside from @@ -297,7 +297,7 @@ repositories without interactive prompts. If your Terraform configuration will be used within [Terraform Cloud](https://www.hashicorp.com/products/terraform), only SSH key authentication is supported, and -[keys can be configured on a per-workspace basis](/docs/cloud/workspaces/ssh-keys.html). +[keys can be configured on a per-workspace basis](/cloud-docs/workspaces/settings/ssh-keys). ### Selecting a Revision @@ -427,7 +427,6 @@ The module installer uses Google Cloud SDK to authenticate with GCS. To set cred * If you're running Terraform from a GCE instance, default credentials are automatically available. See [Creating and Enabling Service Accounts](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances) for Instances for more details * On your computer, you can make your Google identity available by running `gcloud auth application-default login`. - ## Modules in Package Sub-directories When the source of a module is a version control repository or archive file diff --git a/website/docs/language/modules/syntax.html.md b/website/docs/language/modules/syntax.mdx similarity index 83% rename from website/docs/language/modules/syntax.html.md rename to website/docs/language/modules/syntax.mdx index 83c98fcba8c6..87064e9d350a 100644 --- a/website/docs/language/modules/syntax.html.md +++ b/website/docs/language/modules/syntax.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Modules - Configuration Language" -sidebar_current: "docs-config-modules" -description: "Modules are containers for multiple resources that are used together in configurations. Learn how to call one module from another and access module output." +page_title: Modules - Configuration Language +description: >- + Modules are containers for multiple resources that are used together in + configurations. Learn how to call one module from another and access module + output. --- # Module Blocks @@ -22,13 +23,13 @@ in separate configurations, allowing resource configurations to be packaged and re-used. This page describes how to call one module from another. For more information -about creating re-usable child modules, see [Module Development](/docs/language/modules/develop/index.html). +about creating re-usable child modules, see [Module Development](/language/modules/develop). ## Calling a Child Module To _call_ a module means to include the contents of that module into the configuration with specific values for its -[input variables](/docs/language/values/variables.html). Modules are called +[input variables](/language/values/variables). Modules are called from within other modules using `module` blocks: ```hcl @@ -52,7 +53,7 @@ Module calls use the following kinds of arguments: - The `version` argument is recommended for modules from a registry. -- Most other arguments correspond to [input variables](/docs/language/values/variables.html) +- Most other arguments correspond to [input variables](/language/values/variables) defined by the module. (The `servers` argument in the example above is one of these.) @@ -66,7 +67,7 @@ Terraform. Its value is either the path to a local directory containing the module's configuration files, or a remote module source that Terraform should download and use. This value must be a literal string with no template sequences; arbitrary expressions are not allowed. For more information on -possible values for this argument, see [Module Sources](/docs/language/modules/sources.html). +possible values for this argument, see [Module Sources](/language/modules/sources). The same source address can be specified in multiple `module` blocks to create multiple copies of the resources defined within, possibly with different @@ -94,14 +95,14 @@ module "consul" { } ``` -The `version` argument accepts a [version constraint string](/docs/language/expressions/version-constraints.html). +The `version` argument accepts a [version constraint string](/language/expressions/version-constraints). Terraform will use the newest installed version of the module that meets the constraint; if no acceptable versions are installed, it will download the newest version that meets the constraint. Version constraints are supported only for modules installed from a module registry, such as the public [Terraform Registry](https://registry.terraform.io/) -or [Terraform Cloud's private module registry](/docs/cloud/registry/index.html). +or [Terraform Cloud's private module registry](/cloud-docs/registry). Other module sources can provide their own versioning mechanisms within the source string itself, or might not support versions at all. In particular, modules sourced from local file paths do not support `version`; since @@ -115,22 +116,22 @@ optional meta-arguments that have special meaning across all modules, described in more detail in the following pages: - `count` - Creates multiple instances of a module from a single `module` block. - See [the `count` page](/docs/language/meta-arguments/count.html) + See [the `count` page](/language/meta-arguments/count) for details. - `for_each` - Creates multiple instances of a module from a single `module` block. See - [the `for_each` page](/docs/language/meta-arguments/for_each.html) + [the `for_each` page](/language/meta-arguments/for_each) for details. - `providers` - Passes provider configurations to a child module. See - [the `providers` page](/docs/language/meta-arguments/module-providers.html) + [the `providers` page](/language/meta-arguments/module-providers) for details. If not specified, the child module inherits all of the default (un-aliased) provider configurations from the calling module. - `depends_on` - Creates explicit dependencies between the entire module and the listed targets. See - [the `depends_on` page](/docs/language/meta-arguments/depends_on.html) + [the `depends_on` page](/language/meta-arguments/depends_on) for details. In addition to the above, the `lifecycle` argument is not currently used by @@ -140,7 +141,7 @@ Terraform but is reserved for planned future features. The resources defined in a module are encapsulated, so the calling module cannot access their attributes directly. However, the child module can -declare [output values](/docs/language/values/outputs.html) to selectively +declare [output values](/language/values/outputs) to selectively export certain values to be accessed by the calling module. For example, if the `./app-cluster` module referenced in the example above @@ -156,7 +157,7 @@ resource "aws_elb" "example" { ``` For more information about referring to named values, see -[Expressions](/docs/language/expressions/index.html). +[Expressions](/language/expressions). ## Transferring Resource State Into Modules @@ -166,7 +167,7 @@ result, Terraform plans to destroy all resource instances at the old address and create new instances at the new address. To preserve existing objects, you can use -[refactoring blocks](develop/refactoring.html) to record the old and new +[refactoring blocks](/language/modules/develop/refactoring) to record the old and new addresses for each resource instance. This directs Terraform to treat existing objects at the old addresses as if they had originally been created at the corresponding new addresses. @@ -176,7 +177,7 @@ corresponding new addresses. You may have an object that needs to be replaced with a new object for a reason that isn't automatically visible to Terraform, such as if a particular virtual machine is running on degraded underlying hardware. In this case, you can use -[the `-replace=...` planning option](/docs/cli/commands/plan.html#replace-address) +[the `-replace=...` planning option](/cli/commands/plan#replace-address) to force Terraform to propose replacing that object. If the object belongs to a resource within a nested module, specify the full diff --git a/website/docs/language/modules/testing-experiment.html.md b/website/docs/language/modules/testing-experiment.mdx similarity index 99% rename from website/docs/language/modules/testing-experiment.html.md rename to website/docs/language/modules/testing-experiment.mdx index 6b2bb7fcee9e..f230b85b996f 100644 --- a/website/docs/language/modules/testing-experiment.html.md +++ b/website/docs/language/modules/testing-experiment.mdx @@ -1,6 +1,5 @@ --- -layout: "language" -page_title: "Module Testing Experiment - Configuration Language" +page_title: Module Testing Experiment - Configuration Language --- # Module Testing Experiment diff --git a/website/docs/language/providers/configuration.html.md b/website/docs/language/providers/configuration.mdx similarity index 86% rename from website/docs/language/providers/configuration.html.md rename to website/docs/language/providers/configuration.mdx index 8251bce1900a..4513338fb009 100644 --- a/website/docs/language/providers/configuration.html.md +++ b/website/docs/language/providers/configuration.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provider Configuration - Configuration Language" -sidebar_current: "docs-config-providers" -description: "Learn how to set up providers, including how to use the alias meta-argument to specify multiple configurations for a single provider." +page_title: Provider Configuration - Configuration Language +description: >- + Learn how to set up providers, including how to use the alias meta-argument to + specify multiple configurations for a single provider. --- # Provider Configuration @@ -16,7 +16,7 @@ configure settings for providers. Additionally, all Terraform configurations must declare which providers they require so that Terraform can install and use them. The -[Provider Requirements](/docs/language/providers/requirements.html) +[Provider Requirements](/language/providers/requirements) page documents how to declare providers so Terraform can install them. ## Provider Configuration @@ -24,8 +24,8 @@ page documents how to declare providers so Terraform can install them. Provider configurations belong in the root module of a Terraform configuration. (Child modules receive their provider configurations from the root module; for more information, see -[The Module `providers` Meta-Argument](/docs/language/meta-arguments/module-providers.html) -and [Module Development: Providers Within Modules](/docs/language/modules/develop/providers.html).) +[The Module `providers` Meta-Argument](/language/meta-arguments/module-providers) +and [Module Development: Providers Within Modules](/language/modules/develop/providers).) A provider configuration is created using a `provider` block: @@ -37,7 +37,7 @@ provider "google" { ``` The name given in the block header (`"google"` in this example) is the -[local name](/docs/language/providers/requirements.html#local-names) of the provider to +[local name](/language/providers/requirements#local-names) of the provider to configure. This provider should already be included in a `required_providers` block. @@ -46,7 +46,7 @@ the provider. Most arguments in this section are defined by the provider itself; in this example both `project` and `region` are specific to the `google` provider. -You can use [expressions](/docs/language/expressions/index.html) in the values of these +You can use [expressions](/language/expressions) in the values of these configuration arguments, but can only reference values that are known before the configuration is applied. This means you can safely reference input variables, but not attributes exported by resources (with an exception for resource @@ -68,7 +68,7 @@ and available for all `provider` blocks: - [`alias`, for using the same provider with different configurations for different resources][inpage-alias] - [`version`, which we no longer recommend][inpage-versions] (use - [provider requirements](/docs/language/providers/requirements.html) instead) + [provider requirements](/language/providers/requirements) instead) Unlike many other objects in the Terraform language, a `provider` block may be omitted if its contents would otherwise be empty. Terraform assumes an @@ -175,7 +175,7 @@ module "aws_vpc" { ``` Modules have some special requirements when passing in providers; see -[The Module `providers` Meta-Argument](/docs/language/meta-arguments/module-providers.html) +[The Module `providers` Meta-Argument](/language/meta-arguments/module-providers) for more details. In most cases, only _root modules_ should define provider configurations, with all child modules obtaining their provider configurations from their parents. @@ -188,11 +188,11 @@ from their parents. The `version` meta-argument specifies a version constraint for a provider, and works the same way as the `version` argument in a -[`required_providers` block](/docs/language/providers/requirements.html). The version +[`required_providers` block](/language/providers/requirements). The version constraint in a provider configuration is only used if `required_providers` does not include one for that provider. **The `version` argument in provider configurations is deprecated.** In Terraform 0.13 and later, always declare provider version constraints in -[the `required_providers` block](/docs/language/providers/requirements.html). The `version` +[the `required_providers` block](/language/providers/requirements). The `version` argument will be removed in a future version of Terraform. diff --git a/website/docs/language/providers/index.html.md b/website/docs/language/providers/index.mdx similarity index 54% rename from website/docs/language/providers/index.html.md rename to website/docs/language/providers/index.mdx index fd95e66e54fb..6dab35086403 100644 --- a/website/docs/language/providers/index.html.md +++ b/website/docs/language/providers/index.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "Providers - Configuration Language" -description: "An overview of how to install and use providers, Terraform plugins that interact with services, cloud providers, and other APIs." +page_title: Providers - Configuration Language +description: >- + An overview of how to install and use providers, Terraform plugins that + interact with services, cloud providers, and other APIs. --- # Providers @@ -17,8 +18,8 @@ configuration (like endpoint URLs or cloud regions) before they can be used. ## What Providers Do -Each provider adds a set of [resource types](/docs/language/resources/index.html) -and/or [data sources](/docs/language/data-sources/index.html) that Terraform can +Each provider adds a set of [resource types](/language/resources) +and/or [data sources](/language/data-sources) that Terraform can manage. Every resource type is implemented by a provider; without providers, Terraform @@ -50,20 +51,20 @@ Provider documentation in the Registry is versioned; you can use the version menu in the header to change which version you're viewing. For details about writing, generating, and previewing provider documentation, -see the [provider publishing documentation](/docs/registry/providers/docs.html). +see the [provider publishing documentation](/registry/providers/docs). ## How to Use Providers To use resources from a given provider, you need to include some information about it in your configuration. See the following pages for details: -- [Provider Requirements](/docs/language/providers/requirements.html) +- [Provider Requirements](/language/providers/requirements) documents how to declare providers so Terraform can install them. -- [Provider Configuration](/docs/language/providers/configuration.html) +- [Provider Configuration](/language/providers/configuration) documents how to configure settings for providers. -- [Dependency Lock File](/docs/language/dependency-lock.html) +- [Dependency Lock File](/language/files/dependency-lock) documents an additional HCL file that can be included with a configuration, which tells Terraform to always use a specific set of provider versions. @@ -72,18 +73,18 @@ about it in your configuration. See the following pages for details: - Terraform Cloud and Terraform Enterprise install providers as part of every run. - Terraform CLI finds and installs providers when - [initializing a working directory](/docs/cli/init/index.html). It can + [initializing a working directory](/cli/init). It can automatically download providers from a Terraform registry, or load them from a local mirror or cache. If you are using a persistent working directory, you must reinitialize whenever you change a configuration's providers. - To save time and bandwidth, Terraform CLI supports an optional plugin - cache. You can enable the cache using the `plugin_cache_dir` setting in - [the CLI configuration file](/docs/cli/config/config-file.html). + To save time and bandwidth, Terraform CLI supports an optional plugin + cache. You can enable the cache using the `plugin_cache_dir` setting in + [the CLI configuration file](/cli/config/config-file). To ensure Terraform always installs the same provider versions for a given configuration, you can use Terraform CLI to create a -[dependency lock file](/docs/language/dependency-lock.html) +[dependency lock file](/language/files/dependency-lock) and commit it to version control along with your configuration. If a lock file is present, Terraform Cloud, CLI, and Enterprise will all obey it when installing providers. @@ -100,42 +101,14 @@ are published by platform maintainers, and some are published by users and volunteers. The provider listings use the following badges to indicate who develops and maintains a given provider. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      TierDescriptionNamespace
      Official providers are owned and maintained by HashiCorp hashicorp
      Verified providers are owned and maintained by third-party technology partners. Providers in this tier indicate HashiCorp has verified the authenticity of the Provider’s publisher, and that the partner is a member of the HashiCorp Technology Partner Program.Third-party organization, e.g. mongodb/mongodbatlas
      Community providers are published to the Terraform Registry by individual maintainers, groups of maintainers, or other members of the Terraform community.
      Maintainer’s individual or organization account, e.g. DeviaVir/gsuite
      Archived Providers are Official or Verified Providers that are no longer maintained by HashiCorp or the community. This may occur if an API is deprecated or interest was low.hashicorp or third-party
      - + +

      ## How to Develop Providers Providers are written in Go, using the Terraform Plugin SDK. For more information on developing providers, see: -- The [Plugin Development](/docs/extend/index.html) documentation +- The [Plugin Development](/plugin) documentation - The [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) collection on HashiCorp Learn diff --git a/website/docs/language/providers/requirements.html.md b/website/docs/language/providers/requirements.mdx similarity index 91% rename from website/docs/language/providers/requirements.html.md rename to website/docs/language/providers/requirements.mdx index 6e8b995c4df7..8331bd74e273 100644 --- a/website/docs/language/providers/requirements.html.md +++ b/website/docs/language/providers/requirements.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "Provider Requirements - Configuration Language" -description: "Providers are plugins that allow Terraform to interact with services, cloud providers, and other APIs. Learn how to declare providers in a configuration." +page_title: Provider Requirements - Configuration Language +description: >- + Providers are plugins that allow Terraform to interact with services, cloud + providers, and other APIs. Learn how to declare providers in a configuration. --- # Provider Requirements @@ -15,7 +16,7 @@ so Terraform can install them. Additionally, some providers require configuration (like endpoint URLs or cloud regions) before they can be used. The [Provider -Configuration](/docs/language/providers/configuration.html) page documents how +Configuration](/language/providers/configuration) page documents how to configure settings for providers. -> **Note:** This page is about a feature of Terraform 0.13 and later; it also @@ -43,7 +44,7 @@ terraform { ``` The `required_providers` block must be nested inside the top-level -[`terraform` block](/docs/language/settings/index.html) (which can also contain other settings). +[`terraform` block](/language/settings) (which can also contain other settings). Each argument in the `required_providers` block enables one provider. The key determines the provider's [local name](#local-names) (its unique identifier @@ -66,8 +67,8 @@ Requirements](#v0-12-compatible-provider-requirements) below. Each provider has two identifiers: -- A unique _source address,_ which is only used when requiring a provider. -- A _local name,_ which is used everywhere else in a Terraform module. +* A unique _source address,_ which is only used when requiring a provider. +* A _local name,_ which is used everywhere else in a Terraform module. -> **Note:** Prior to Terraform 0.13, providers only had local names, since Terraform could only automatically download providers distributed by HashiCorp. @@ -80,7 +81,7 @@ Local names must be unique per-module. Outside of the `required_providers` block, Terraform configurations always refer to providers by their local names. For example, the following configuration declares `mycloud` as the local name for `mycorp/mycloud`, then uses that local -name when [configuring the provider](/docs/language/providers/configuration.html): +name when [configuring the provider](/language/providers/configuration): ```hcl terraform { @@ -131,11 +132,11 @@ follows: * **Type:** A short name for the platform or system the provider manages. Must be unique within a particular namespace on a particular registry host. - The type is usually the provider's preferred local name. (There are - exceptions; for example, - [`hashicorp/google-beta`](https://registry.terraform.io/providers/hashicorp/google-beta/latest) - is an alternate release channel for `hashicorp/google`, so its preferred - local name is `google`. If in doubt, check the provider's documentation.) + The type is usually the provider's preferred local name. (There are + exceptions; for example, + [`hashicorp/google-beta`](https://registry.terraform.io/providers/hashicorp/google-beta/latest) + is an alternate release channel for `hashicorp/google`, so its preferred + local name is `google`. If in doubt, check the provider's documentation.) For example, [the official HTTP provider](https://registry.terraform.io/providers/hashicorp/http) @@ -150,7 +151,6 @@ version is used. This display version omits the source host when it is the public registry, so you may see the shortened version `"hashicorp/random"` instead of `"registry.terraform.io/hashicorp/random"`. - -> **Note:** If you omit the `source` argument when requiring a provider, Terraform uses an implied source address of `registry.terraform.io/hashicorp/`. This is a backward compatibility @@ -210,7 +210,7 @@ avoiding typing. Each provider plugin has its own set of available versions, allowing the functionality of the provider to evolve over time. Each provider dependency you -declare should have a [version constraint](/docs/language/expressions/version-constraints.html) given in +declare should have a [version constraint](/language/expressions/version-constraints) given in the `version` argument so Terraform can select a single version per provider that all modules are compatible with. @@ -220,7 +220,7 @@ a version constraint for every provider your module depends on. To ensure Terraform always installs the same provider versions for a given configuration, you can use Terraform CLI to create a -[dependency lock file](/docs/language/dependency-lock.html) +[dependency lock file](/language/files/dependency-lock) and commit it to version control along with your configuration. If a lock file is present, Terraform Cloud, CLI, and Enterprise will all obey it when installing providers. @@ -272,7 +272,7 @@ incompatibilities, and let the root module manage the maximum version. While most Terraform providers are distributed separately as plugins, there is currently one provider that is built in to Terraform itself, which provides -[the `terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +[the `terraform_remote_state` data source](/language/state/remote-state-data). Because this provider is built in to Terraform, you don't need to declare it in the `required_providers` block in order to use its features. However, for @@ -301,11 +301,11 @@ publishing them on the public Terraform Registry. One option for distributing such a provider is to run an in-house _private_ registry, by implementing -[the provider registry protocol](/docs/internals/provider-registry-protocol.html). +[the provider registry protocol](/internals/provider-registry-protocol). Running an additional service just to distribute a single provider internally may be undesirable, so Terraform also supports -[other provider installation methods](/docs/cli/config/config-file.html#provider-installation), +[other provider installation methods](/cli/config/config-file#provider-installation), including placing provider plugins directly in specific directories in the local filesystem, via _filesystem mirrors_. @@ -334,7 +334,7 @@ terraform { To make version 1.0.0 of this provider available for installation from the local filesystem, choose one of the -[implied local mirror directories](/docs/cli/config/config-file.html#implied-local-mirror-directories) +[implied local mirror directories](/cli/config/config-file#implied-local-mirror-directories) and create a directory structure under it like this: ``` diff --git a/website/docs/language/resources/behavior.html.md b/website/docs/language/resources/behavior.mdx similarity index 86% rename from website/docs/language/resources/behavior.html.md rename to website/docs/language/resources/behavior.mdx index 1f8b4c249bf2..4d53a1f6191c 100644 --- a/website/docs/language/resources/behavior.html.md +++ b/website/docs/language/resources/behavior.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "Resource Behavior - Configuration Language" -description: "Learn how Terraform uses resource blocks to create infrastructure objects. Also learn about resource dependencies and how to access resource attributes." +page_title: Resource Behavior - Configuration Language +description: >- + Learn how Terraform uses resource blocks to create infrastructure objects. + Also learn about resource dependencies and how to access resource attributes. --- # Resource Behavior @@ -19,7 +20,7 @@ match the configuration. When Terraform creates a new infrastructure object represented by a `resource` block, the identifier for that real object is saved in Terraform's -[state](/docs/language/state/index.html), allowing it to be updated and destroyed +[state](/language/state), allowing it to be updated and destroyed in response to future changes. For resource blocks that already have an associated infrastructure object in the state, Terraform compares the actual configuration of the object with the arguments given in the @@ -43,7 +44,7 @@ customized on a per-resource basis. ## Accessing Resource Attributes -[Expressions](/docs/language/expressions/index.html) within a Terraform module can access +[Expressions](/language/expressions) within a Terraform module can access information about resources in the same module, and you can use that information to help configure other resources. Use the `..` syntax to reference a resource attribute in an expression. @@ -53,7 +54,7 @@ read-only attributes with information obtained from the remote API; this often includes things that can't be known until the resource is created, like the resource's unique random ID. -Many providers also include [data sources](/docs/language/data-sources/index.html), +Many providers also include [data sources](/language/data-sources), which are a special type of resource used only for looking up information. For a list of the attributes a resource or data source type provides, consult @@ -61,7 +62,7 @@ its documentation; these are generally included in a second list below its list of configurable arguments. For more information about referencing resource attributes in expressions, see -[Expressions: References to Resource Attributes](/docs/language/expressions/references.html#references-to-resource-attributes). +[Expressions: References to Resource Attributes](/language/expressions/references#references-to-resource-attributes). ## Resource Dependencies @@ -74,7 +75,7 @@ resource's configuration just requires information generated by another resource. Most resource dependencies are handled automatically. Terraform analyses any -[expressions](/docs/language/expressions/index.html) within a `resource` block to find references +[expressions](/language/expressions) within a `resource` block to find references to other objects, and treats those references as implicit ordering requirements when creating, updating, or destroying resources. Since most resources with behavioral dependencies on other resources also refer to those resources' data, @@ -85,7 +86,7 @@ example, if Terraform must manage access control policies _and_ take actions that require those policies to be present, there is a hidden dependency between the access policy and a resource whose creation depends on it. In these rare cases, -[the `depends_on` meta-argument](/docs/language/meta-arguments/depends_on.html) +[the `depends_on` meta-argument](/language/meta-arguments/depends_on) can explicitly specify a dependency. ## Local-only Resources @@ -106,4 +107,3 @@ connect together other resources. The behavior of local-only resources is the same as all other resources, but their result data exists only within the Terraform state. "Destroying" such a resource means only to remove it from the state, discarding its data. - diff --git a/website/docs/language/resources/index.html.md b/website/docs/language/resources/index.mdx similarity index 55% rename from website/docs/language/resources/index.html.md rename to website/docs/language/resources/index.mdx index 4de70b7d4144..08921cf7569a 100644 --- a/website/docs/language/resources/index.html.md +++ b/website/docs/language/resources/index.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "Resources Overview - Configuration Language" -description: "Resources describe infrastructure objects in Terraform configurations. Find documentation for resource syntax, behavior, and meta-arguments." +page_title: Resources Overview - Configuration Language +description: >- + Resources describe infrastructure objects in Terraform configurations. Find + documentation for resource syntax, behavior, and meta-arguments. --- # Resources @@ -13,22 +14,22 @@ Each resource block describes one or more infrastructure objects, such as virtual networks, compute instances, or higher-level components such as DNS records. -- [Resource Blocks](/docs/language/resources/syntax.html) documents +- [Resource Blocks](/language/resources/syntax) documents the syntax for declaring resources. -- [Resource Behavior](/docs/language/resources/behavior.html) explains in +- [Resource Behavior](/language/resources/behavior) explains in more detail how Terraform handles resource declarations when applying a configuration. - The Meta-Arguments section documents special arguments that can be used with every resource type, including - [`depends_on`](/docs/language/meta-arguments/depends_on.html), - [`count`](/docs/language/meta-arguments/count.html), - [`for_each`](/docs/language/meta-arguments/for_each.html), - [`provider`](/docs/language/meta-arguments/resource-provider.html), - and [`lifecycle`](/docs/language/meta-arguments/lifecycle.html). + [`depends_on`](/language/meta-arguments/depends_on), + [`count`](/language/meta-arguments/count), + [`for_each`](/language/meta-arguments/for_each), + [`provider`](/language/meta-arguments/resource-provider), + and [`lifecycle`](/language/meta-arguments/lifecycle). -- [Provisioners](/docs/language/resources/provisioners/index.html) +- [Provisioners](/language/resources/provisioners) documents configuring post-creation actions for a resource using the `provisioner` and `connection` blocks. Since provisioners are non-declarative and potentially unpredictable, we strongly recommend that you treat them as a diff --git a/website/docs/language/resources/provisioners/chef.html.md b/website/docs/language/resources/provisioners/chef.mdx similarity index 93% rename from website/docs/language/resources/provisioners/chef.html.md rename to website/docs/language/resources/provisioners/chef.mdx index e420b9a386c7..9ec4887e2cb3 100644 --- a/website/docs/language/resources/provisioners/chef.html.md +++ b/website/docs/language/resources/provisioners/chef.mdx @@ -1,18 +1,17 @@ --- -layout: "language" -page_title: "Provisioner: chef" -sidebar_current: "docs-provisioners-chef" -description: |- - The `chef` provisioner installs, configures and runs the Chef client on a resource. +page_title: 'Provisioner: chef' +description: >- + The `chef` provisioner installs, configures and runs the Chef client on a + resource. --- # Chef Provisioner The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh` and `winrm` type -[connections](/docs/language/resources/provisioners/connection.html). +[connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). ## Requirements @@ -68,7 +67,7 @@ The following arguments are supported: * `attributes_json (string)` - (Optional) A raw JSON string with initial node attributes for the new node. These can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `channel (string)` - (Optional) The Chef Client release channel to install from. If not set, the `stable` channel will be used. @@ -127,7 +126,7 @@ The following arguments are supported: * `prevent_sudo (boolean)` - (Optional) Prevent the use of the `sudo` command while installing, configuring and running the initial Chef Client run. This option is only used with `ssh` type - [connections](/docs/language/resources/provisioners/connection.html). + [connections](/language/resources/provisioners/connection). * `recreate_client (boolean)` - (Optional) If `true`, first delete any existing Chef Node and Client before registering the new Chef Client. @@ -145,7 +144,7 @@ The following arguments are supported: * `secret_key (string)` - (Optional) The contents of the secret key that is used by the Chef Client to decrypt data bags on the Chef Server. The key will be uploaded to the remote machine. This can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `server_url (string)` - (Required) The URL to the Chef server. This includes the path to the organization. See the example. @@ -167,11 +166,11 @@ The following arguments are supported: * `user_key (string)` - (Required) The contents of the user key that will be used to authenticate with the Chef Server. This can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `vault_json (string)` - (Optional) A raw JSON string with Chef Vaults and Items to which the new node should have access. These can also be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). * `version (string)` - (Optional) The Chef Client version to install on the remote machine. If not set, the latest available version will be installed. diff --git a/website/docs/language/resources/provisioners/connection.html.md b/website/docs/language/resources/provisioners/connection.mdx similarity index 80% rename from website/docs/language/resources/provisioners/connection.html.md rename to website/docs/language/resources/provisioners/connection.mdx index 762c37a91063..704012199ae3 100644 --- a/website/docs/language/resources/provisioners/connection.html.md +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provisioner Connection Settings" -sidebar_current: "docs-provisioners-connection" -description: "The connection block allows you to manage provisioner connection defaults for SSH and WinRM." +page_title: Provisioner Connection Settings +description: >- + The connection block allows you to manage provisioner connection defaults for + SSH and WinRM. --- # Provisioner Connection Settings @@ -12,7 +12,7 @@ expect a nested `connection` block with details about how to connect. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). -> **Note:** In Terraform 0.11 and earlier, providers could set default values for some connection settings, so that `connection` blocks could sometimes be @@ -28,9 +28,9 @@ below explicitly set to verify against a specific key or signing CA. Connection blocks don't take a block label, and can be nested within either a `resource` or a `provisioner`. -- A `connection` block nested directly within a `resource` affects all of +* A `connection` block nested directly within a `resource` affects all of that resource's provisioners. -- A `connection` block nested in a `provisioner` block only affects that +* A `connection` block nested in a `provisioner` block only affects that provisioner, and overrides any resource-level connection settings. One use case for providing multiple connections is to have an initial @@ -85,10 +85,10 @@ block would create a dependency cycle. **The following arguments are supported by all connection types:** * `type` - The connection type that should be used. Valid types are `ssh` and `winrm`. - Defaults to `ssh`. + Defaults to `ssh`. * `user` - The user that we should use for the connection. - Defaults to `root` when using type `ssh` and defaults to `Administrator` when using type `winrm`. + Defaults to `root` when using type `ssh` and defaults to `Administrator` when using type `winrm`. * `password` - The password we should use for the connection. In some cases this is specified by the provider. @@ -96,10 +96,10 @@ block would create a dependency cycle. * `host` - (Required) The address of the resource to connect to. * `port` - The port to connect to. - Defaults to `22` when using type `ssh` and defaults to `5985` when using type `winrm`. + Defaults to `22` when using type `ssh` and defaults to `5985` when using type `winrm`. * `timeout` - The timeout to wait for the connection to become available. Should be provided as a string like `30s` or `5m`. - Defaults to 5 minutes. + Defaults to 5 minutes. * `script_path` - The path used to copy scripts meant for remote execution. @@ -107,24 +107,25 @@ block would create a dependency cycle. * `private_key` - The contents of an SSH key to use for the connection. These can be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). This takes + [the `file` function](/language/functions/file). This takes preference over the password if provided. * `certificate` - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `private_key`. These can - be loaded from a file on disk using the [the `file` function](/docs/language/functions/file.html). + be loaded from a file on disk using the [the `file` function](/language/functions/file). * `agent` - Set to `false` to disable using `ssh-agent` to authenticate. On Windows the only supported SSH authentication agent is - [Pageant](http://the.earth.li/~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). + [Pageant](http://the.earth.li/\~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). * `agent_identity` - The preferred identity from the ssh agent for authentication. * `host_key` - The public key from the remote host or the signing CA, used to verify the connection. + * `target_platform` - The target platform to connect to. Valid values are `windows` and `unix`. Defaults to `unix` if not set. - If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` + If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` **Additional arguments only supported by the `winrm` connection type:** @@ -160,9 +161,9 @@ The `ssh` connection also supports the following fields to facilitate connnectio * `bastion_private_key` - The contents of an SSH key file to use for the bastion host. These can be loaded from a file on disk using - [the `file` function](/docs/language/functions/file.html). + [the `file` function](/language/functions/file). Defaults to the value of the `private_key` field. * `bastion_certificate` - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `bastion_private_key`. These can be loaded from - a file on disk using the [the `file` function](/docs/language/functions/file.html). + a file on disk using the [the `file` function](/language/functions/file). diff --git a/website/docs/language/resources/provisioners/file.html.md b/website/docs/language/resources/provisioners/file.mdx similarity index 89% rename from website/docs/language/resources/provisioners/file.html.md rename to website/docs/language/resources/provisioners/file.mdx index 05b494e5b2d0..06b22758b49c 100644 --- a/website/docs/language/resources/provisioners/file.html.md +++ b/website/docs/language/resources/provisioners/file.mdx @@ -1,20 +1,20 @@ --- -layout: "language" -page_title: "Provisioner: file" -sidebar_current: "docs-provisioners-file" -description: |- - The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner supports both `ssh` and `winrm` type connections. +page_title: 'Provisioner: file' +description: >- + The `file` provisioner is used to copy files or directories from the machine + executing Terraform to the newly created resource. The `file` provisioner + supports both `ssh` and `winrm` type connections. --- # File Provisioner The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner -supports both `ssh` and `winrm` type [connections](/docs/language/resources/provisioners/connection.html). +supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). ## Example usage diff --git a/website/docs/language/resources/provisioners/habitat.html.md b/website/docs/language/resources/provisioners/habitat.mdx similarity index 94% rename from website/docs/language/resources/provisioners/habitat.html.md rename to website/docs/language/resources/provisioners/habitat.mdx index 66af5a655f94..c8ab535d14f1 100644 --- a/website/docs/language/resources/provisioners/habitat.html.md +++ b/website/docs/language/resources/provisioners/habitat.mdx @@ -1,22 +1,21 @@ --- -layout: "language" -page_title: "Provisioner: habitat" -sidebar_current: "docs-provisioners-habitat" -description: |- - The `habitat` provisioner installs the Habitat supervisor, and loads configured services. +page_title: 'Provisioner: habitat' +description: >- + The `habitat` provisioner installs the Habitat supervisor, and loads + configured services. --- # Habitat Provisioner The `habitat` provisioner installs the [Habitat](https://habitat.sh) supervisor and loads configured services. This provisioner only supports Linux targets using the `ssh` connection type at this time. -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). ## Requirements The `habitat` provisioner has some prerequisites for specific connection types: -- For `ssh` type connections, we assume a few tools to be available on the remote host: +* For `ssh` type connections, we assume a few tools to be available on the remote host: * `curl` * `tee` * `setsid` - Only if using the `unmanaged` service type. @@ -50,6 +49,7 @@ resource "aws_instance" "redis" { There are 2 configuration levels, `supervisor` and `service`. Configuration placed directly within the `provisioner` block are supervisor configurations, and a provisioner can define zero or more services to run, and each service will have a `service` block within the `provisioner`. A `service` block can also contain zero or more `bind` blocks to create service group bindings. ### Supervisor Arguments + * `accept_license (bool)` - (Required) Set to true to accept [Habitat end user license agreement](https://www.chef.io/end-user-license-agreement/) * `version (string)` - (Optional) The Habitat version to install on the remote machine. If not specified, the latest available version is used. * `auto_update (bool)` - (Optional) If set to `true`, the supervisor will auto-update itself as soon as new releases are available on the specified `channel`. @@ -66,7 +66,7 @@ There are 2 configuration levels, `supervisor` and `service`. Configuration pla * `ring_key (string)` - (Optional) The name of the ring key for encrypting gossip ring communication (Defaults to no encryption) * `ring_key_content (string)` - (Optional) The key content. Only needed if using ring encryption and want the provisioner to take care of uploading and importing it. Easiest to source from a file (eg `ring_key_content = "${file("conf/foo-123456789.sym.key")}"`) (Defaults to none) * `ctl_secret (string)` - (Optional) Specify a secret to use (from `hab sup secret generate`) for control gateway communication between hab client(s) and the supervisor. (Defaults to none) -* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to https://bldr.habitat.sh) +* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to ) * `channel (string)` - (Optional) The release channel in the Builder service to use. (Defaults to `stable`) * `events (string)` - (Optional) Name of the service group running a Habitat EventSrv to forward Supervisor and service event data to. (Defaults to none) * `organization (string)` - (Optional) The organization that the Supervisor and it's subsequent services are part of. (Defaults to `default`) @@ -74,6 +74,7 @@ There are 2 configuration levels, `supervisor` and `service`. Configuration pla * `builder_auth_token (string)` - (Optional) The builder authorization token when using a private origin. (Defaults to none) ### Service Arguments + * `name (string)` - (Required) The Habitat package identifier of the service to run. (ie `core/haproxy` or `core/redis/3.2.4/20171002182640`) * `binds (array)` - (Optional) An array of bind specifications. (ie `binds = ["backend:nginx.default"]`) * `bind` - (Optional) An alternative way of declaring binds. This method can be easier to deal with when populating values from other values or variable inputs without having to do string interpolation. The following example is equivalent to `binds = ["backend:nginx.default"]`: @@ -85,12 +86,13 @@ bind { group = "default" } ``` + * `topology (string)` - (Optional) Topology to start service in. Possible values `standalone` or `leader`. (Defaults to `standalone`) * `strategy (string)` - (Optional) Update strategy to use. Possible values `at-once`, `rolling` or `none`. (Defaults to `none`) * `user_toml (string)` - (Optional) TOML formatted user configuration for the service. Easiest to source from a file (eg `user_toml = "${file("conf/redis.toml")}"`). (Defaults to none) * `channel (string)` - (Optional) The release channel in the Builder service to use. (Defaults to `stable`) * `group (string)` - (Optional) The service group to join. (Defaults to `default`) -* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to https://bldr.habitat.sh) +* `url (string)` - (Optional) The URL of a Builder service to download packages and receive updates from. (Defaults to ) * `application (string)` - (Optional) The application name. (Defaults to none) * `environment (string)` - (Optional) The environment name. (Defaults to none) * `service_key (string)` - (Optional) The key content of a service private key, if using service group encryption. Easiest to source from a file (eg `service_key = "${file("conf/redis.default@org-123456789.box.key")}"`) (Defaults to none) diff --git a/website/docs/language/resources/provisioners/index.html.md b/website/docs/language/resources/provisioners/index.html.md deleted file mode 100644 index 2a22e2dd2eb7..000000000000 --- a/website/docs/language/resources/provisioners/index.html.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -layout: "language" -page_title: "Provisioners Overview - Configuration Language" -description: "Provisioners model specific actions on a local or remote machine to prepare servers or other infrastructure for service." ---- - -# Provisioners - -Provisioners can be used to model specific actions on the local machine or on a -remote machine in order to prepare servers or other infrastructure objects for -service. - diff --git a/website/docs/language/resources/provisioners/index.mdx b/website/docs/language/resources/provisioners/index.mdx new file mode 100644 index 000000000000..badd56b09f3f --- /dev/null +++ b/website/docs/language/resources/provisioners/index.mdx @@ -0,0 +1,12 @@ +--- +page_title: Provisioners Overview - Configuration Language +description: >- + Provisioners model specific actions on a local or remote machine to prepare + servers or other infrastructure for service. +--- + +# Provisioners + +Provisioners can be used to model specific actions on the local machine or on a +remote machine in order to prepare servers or other infrastructure objects for +service. diff --git a/website/docs/language/resources/provisioners/local-exec.html.md b/website/docs/language/resources/provisioners/local-exec.mdx similarity index 83% rename from website/docs/language/resources/provisioners/local-exec.html.md rename to website/docs/language/resources/provisioners/local-exec.mdx index 1feded8c7a6c..02eec0ef7994 100644 --- a/website/docs/language/resources/provisioners/local-exec.html.md +++ b/website/docs/language/resources/provisioners/local-exec.mdx @@ -1,9 +1,9 @@ --- -layout: "language" -page_title: "Provisioner: local-exec" -sidebar_current: "docs-provisioners-local" -description: |- - The `local-exec` provisioner invokes a local executable after a resource is created. This invokes a process on the machine running Terraform, not on the resource. See the `remote-exec` provisioner to run commands on the resource. +page_title: 'Provisioner: local-exec' +description: >- + The `local-exec` provisioner invokes a local executable after a resource is + created. This invokes a process on the machine running Terraform, not on the + resource. See the `remote-exec` provisioner to run commands on the resource. --- # local-exec Provisioner @@ -11,7 +11,7 @@ description: |- The `local-exec` provisioner invokes a local executable after a resource is created. This invokes a process on the machine running Terraform, not on the resource. See the `remote-exec` -[provisioner](/docs/language/resources/provisioners/remote-exec.html) to run commands on the +[provisioner](/language/resources/provisioners/remote-exec) to run commands on the resource. Note that even though the resource will be fully created when the provisioner is @@ -20,7 +20,7 @@ system services such as `sshd` may not be started yet on compute resources. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). ## Example usage @@ -45,7 +45,7 @@ The following arguments are supported: * `working_dir` - (Optional) If provided, specifies the working directory where `command` will be executed. It can be provided as a relative path to the - current working directory or as an absolute path. The directory must exist. + current working directory or as an absolute path. The directory must exist. * `interpreter` - (Optional) If provided, this is a list of interpreter arguments used to execute the command. The first argument is the diff --git a/website/docs/language/resources/provisioners/null_resource.html.md b/website/docs/language/resources/provisioners/null_resource.mdx similarity index 68% rename from website/docs/language/resources/provisioners/null_resource.html.md rename to website/docs/language/resources/provisioners/null_resource.mdx index 4d9f53712c14..3e7b3fd65ae6 100644 --- a/website/docs/language/resources/provisioners/null_resource.html.md +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provisioners Without a Resource" -sidebar_current: "docs-provisioners-null-resource" -description: "A null_resource allows you to configure provisioners that are not directly associated with a single existing resource." +page_title: Provisioners Without a Resource +description: >- + A null_resource allows you to configure provisioners that are not directly + associated with a single existing resource. --- # Provisioners Without a Resource @@ -14,8 +14,8 @@ resource, you can associate them with a `null_resource`. Instances of [`null_resource`][null] are treated like normal resources, but they don't do anything. Like with any other resource, you can configure -[provisioners](/docs/language/resources/provisioners/syntax.html) and [connection -details](/docs/language/resources/provisioners/connection.html) on a `null_resource`. You can also +[provisioners](/language/resources/provisioners/syntax) and [connection +details](/language/resources/provisioners/connection) on a `null_resource`. You can also use its `triggers` argument and any meta-arguments to control exactly where in the dependency graph its provisioners will run. @@ -54,6 +54,6 @@ resource "null_resource" "cluster" { In addition to meta-arguments supported by all resources, `null_resource` supports the following specific arguments: - * `triggers` - A map of values which should cause this set of provisioners to - re-run. Values are meant to be interpolated references to variables or - attributes of other resources. +- `triggers` - A map of values which should cause this set of provisioners to + re-run. Values are meant to be interpolated references to variables or + attributes of other resources. diff --git a/website/docs/language/resources/provisioners/puppet.html.md b/website/docs/language/resources/provisioners/puppet.mdx similarity index 93% rename from website/docs/language/resources/provisioners/puppet.html.md rename to website/docs/language/resources/provisioners/puppet.mdx index 0e5005256435..e0894c271f9b 100644 --- a/website/docs/language/resources/provisioners/puppet.html.md +++ b/website/docs/language/resources/provisioners/puppet.mdx @@ -1,18 +1,17 @@ --- -layout: "language" -page_title: "Provisioner: puppet" -sidebar_current: "docs-provisioners-puppet" -description: |- - The `puppet` provisioner installs, configures and runs the Puppet agent on a resource. +page_title: 'Provisioner: puppet' +description: >- + The `puppet` provisioner installs, configures and runs the Puppet agent on a + resource. --- # Puppet Provisioner The `puppet` provisioner installs, configures and runs the Puppet agent on a remote resource. The `puppet` provisioner supports both `ssh` and `winrm` type -[connections](/docs/language/resources/provisioners/connection.html). +[connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). ## Requirements @@ -76,7 +75,7 @@ The following arguments are supported: a certificate from the Puppet master CA (defaults to the FQDN of the resource). -* `extension_requests (map)` - (Optional) A map of [extension +* `extension_requests (map)` - (Optional) A map of [extension requests](https://puppet.com/docs/puppet/latest/ssl_attributes_extensions.html#concept-932) to be embedded in the certificate signing request before it is sent to the Puppet master CA and then transferred to the final certificate when the CSR diff --git a/website/docs/language/resources/provisioners/remote-exec.html.md b/website/docs/language/resources/provisioners/remote-exec.mdx similarity index 67% rename from website/docs/language/resources/provisioners/remote-exec.html.md rename to website/docs/language/resources/provisioners/remote-exec.mdx index 19e771989de8..4b4d94274a8f 100644 --- a/website/docs/language/resources/provisioners/remote-exec.html.md +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -1,9 +1,11 @@ --- -layout: "language" -page_title: "Provisioner: remote-exec" -sidebar_current: "docs-provisioners-remote" -description: |- - The `remote-exec` provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc. To invoke a local process, see the `local-exec` provisioner instead. The `remote-exec` provisioner supports both `ssh` and `winrm` type connections. +page_title: 'Provisioner: remote-exec' +description: >- + The `remote-exec` provisioner invokes a script on a remote resource after it + is created. This can be used to run a configuration management tool, bootstrap + into a cluster, etc. To invoke a local process, see the `local-exec` + provisioner instead. The `remote-exec` provisioner supports both `ssh` and + `winrm` type connections. --- # remote-exec Provisioner @@ -11,13 +13,13 @@ description: |- The `remote-exec` provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc. To invoke a local process, see the `local-exec` -[provisioner](/docs/language/resources/provisioners/local-exec.html) instead. The `remote-exec` -provisioner requires a [connection](/docs/language/resources/provisioners/connection.html) +[provisioner](/language/resources/provisioners/local-exec) instead. The `remote-exec` +provisioner requires a [connection](/language/resources/provisioners/connection) and supports both `ssh` and `winrm`. -> **Note:** Provisioners should only be used as a last resort. For most common situations there are better alternatives. For more information, see -[the main Provisioners page](./). +[the main Provisioners page](/language/resources/provisioners). ## Example usage @@ -58,14 +60,14 @@ The following arguments are supported: that will be copied to the remote resource and then executed. They are executed in the order they are provided. This cannot be provided with `inline` or `script`. --> **Note:** Since `inline` is implemented by concatenating commands into a script, [`on_failure`](/docs/language/resources/provisioners/syntax.html#failure-behavior) applies only to the final command in the list. In particular, with `on_failure = fail` (the default behaviour) earlier commands will be allowed to fail, and later commands will also execute. If this behaviour is not desired, consider using `"set -o errexit"` as the first command. +-> **Note:** Since `inline` is implemented by concatenating commands into a script, [`on_failure`](/language/resources/provisioners/syntax#failure-behavior) applies only to the final command in the list. In particular, with `on_failure = fail` (the default behaviour) earlier commands will be allowed to fail, and later commands will also execute. If this behaviour is not desired, consider using `"set -o errexit"` as the first command. ## Script Arguments You cannot pass any arguments to scripts using the `script` or `scripts` arguments to this provisioner. If you want to specify arguments, upload the script with the -[file provisioner](/docs/language/resources/provisioners/file.html) +[file provisioner](/language/resources/provisioners/file) and then use `inline` to call it. Example: ```hcl diff --git a/website/docs/language/resources/provisioners/salt-masterless.html.md b/website/docs/language/resources/provisioners/salt-masterless.html.md deleted file mode 100644 index 6cdb4f326006..000000000000 --- a/website/docs/language/resources/provisioners/salt-masterless.html.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: "language" -page_title: "Provisioner: salt-masterless" -sidebar_current: "docs-provisioners-salt-masterless" -description: |- - The salt-masterless Terraform provisioner provisions machines built by Terraform ---- - -# Salt Masterless Provisioner - -Type: `salt-masterless` - -The `salt-masterless` Terraform provisioner provisions machines built by Terraform -using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/docs/language/resources/provisioners/connection.html). - -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](./). - -## Requirements - -The `salt-masterless` provisioner has some prerequisites. `cURL` must be available on the remote host. - -## Example usage - -The example below is fully functional. - -```hcl - -provisioner "salt-masterless" { - "local_state_tree" = "/srv/salt" -} -``` - -## Argument Reference - -The reference of available configuration options is listed below. The only -required argument is the path to your local salt state tree. - -Optional: - -- `bootstrap_args` (string) - Arguments to send to the bootstrap script. Usage - is somewhat documented on - [github](https://github.com/saltstack/salt-bootstrap), but the [script - itself](https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh) - has more detailed usage instructions. By default, no arguments are sent to - the script. - -- `disable_sudo` (boolean) - By default, the bootstrap install command is prefixed with `sudo`. When using a - Docker builder, you will likely want to pass `true` since `sudo` is often not pre-installed. - -- `remote_pillar_roots` (string) - The path to your remote [pillar - roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). - default: `/srv/pillar`. This option cannot be used with `minion_config`. - -- `remote_state_tree` (string) - The path to your remote [state - tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). - default: `/srv/salt`. This option cannot be used with `minion_config`. - -- `local_pillar_roots` (string) - The path to your local [pillar - roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). - This will be uploaded to the `remote_pillar_roots` on the remote. - -- `local_state_tree` (string) - The path to your local [state - tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). - This will be uploaded to the `remote_state_tree` on the remote. - -- `custom_state` (string) - A state to be run instead of `state.highstate`. - Defaults to `state.highstate` if unspecified. - -- `minion_config_file` (string) - The path to your local [minion config - file](http://docs.saltstack.com/ref/configuration/minion.html). This will be - uploaded to the `/etc/salt` on the remote. This option overrides the - `remote_state_tree` or `remote_pillar_roots` options. - -- `skip_bootstrap` (boolean) - By default the salt provisioner runs [salt - bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set - this to true to skip this step. - -- `temp_config_dir` (string) - Where your local state tree will be copied - before moving to the `/srv/salt` directory. Default is `/tmp/salt`. - -- `no_exit_on_failure` (boolean) - Terraform will exit if the `salt-call` command - fails. Set this option to true to ignore Salt failures. - -- `log_level` (string) - Set the logging level for the `salt-call` run. - -- `salt_call_args` (string) - Additional arguments to pass directly to `salt-call`. See - [salt-call](https://docs.saltstack.com/ref/cli/salt-call.html) documentation for more - information. By default no additional arguments (besides the ones Terraform generates) - are passed to `salt-call`. - -- `salt_bin_dir` (string) - Path to the `salt-call` executable. Useful if it is not - on the PATH. diff --git a/website/docs/language/resources/provisioners/salt-masterless.mdx b/website/docs/language/resources/provisioners/salt-masterless.mdx new file mode 100644 index 000000000000..d24532177f99 --- /dev/null +++ b/website/docs/language/resources/provisioners/salt-masterless.mdx @@ -0,0 +1,91 @@ +--- +page_title: 'Provisioner: salt-masterless' +description: >- + The salt-masterless Terraform provisioner provisions machines built by + Terraform +--- + +# Salt Masterless Provisioner + +Type: `salt-masterless` + +The `salt-masterless` Terraform provisioner provisions machines built by Terraform +using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/language/resources/provisioners/connection). + +!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). + +## Requirements + +The `salt-masterless` provisioner has some prerequisites. `cURL` must be available on the remote host. + +## Example usage + +The example below is fully functional. + +```hcl + +provisioner "salt-masterless" { + "local_state_tree" = "/srv/salt" +} +``` + +## Argument Reference + +The reference of available configuration options is listed below. The only +required argument is the path to your local salt state tree. + +Optional: + +- `bootstrap_args` (string) - Arguments to send to the bootstrap script. Usage + is somewhat documented on + [github](https://github.com/saltstack/salt-bootstrap), but the [script + itself](https://github.com/saltstack/salt-bootstrap/blob/develop/bootstrap-salt.sh) + has more detailed usage instructions. By default, no arguments are sent to + the script. + +- `disable_sudo` (boolean) - By default, the bootstrap install command is prefixed with `sudo`. When using a + Docker builder, you will likely want to pass `true` since `sudo` is often not pre-installed. + +- `remote_pillar_roots` (string) - The path to your remote [pillar + roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). + default: `/srv/pillar`. This option cannot be used with `minion_config`. + +- `remote_state_tree` (string) - The path to your remote [state + tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). + default: `/srv/salt`. This option cannot be used with `minion_config`. + +- `local_pillar_roots` (string) - The path to your local [pillar + roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). + This will be uploaded to the `remote_pillar_roots` on the remote. + +- `local_state_tree` (string) - The path to your local [state + tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). + This will be uploaded to the `remote_state_tree` on the remote. + +- `custom_state` (string) - A state to be run instead of `state.highstate`. + Defaults to `state.highstate` if unspecified. + +- `minion_config_file` (string) - The path to your local [minion config + file](http://docs.saltstack.com/ref/configuration/minion.html). This will be + uploaded to the `/etc/salt` on the remote. This option overrides the + `remote_state_tree` or `remote_pillar_roots` options. + +- `skip_bootstrap` (boolean) - By default the salt provisioner runs [salt + bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set + this to true to skip this step. + +- `temp_config_dir` (string) - Where your local state tree will be copied + before moving to the `/srv/salt` directory. Default is `/tmp/salt`. + +- `no_exit_on_failure` (boolean) - Terraform will exit if the `salt-call` command + fails. Set this option to true to ignore Salt failures. + +- `log_level` (string) - Set the logging level for the `salt-call` run. + +- `salt_call_args` (string) - Additional arguments to pass directly to `salt-call`. See + [salt-call](https://docs.saltstack.com/ref/cli/salt-call.html) documentation for more + information. By default no additional arguments (besides the ones Terraform generates) + are passed to `salt-call`. + +- `salt_bin_dir` (string) - Path to the `salt-call` executable. Useful if it is not + on the PATH. diff --git a/website/docs/language/resources/provisioners/syntax.html.md b/website/docs/language/resources/provisioners/syntax.mdx similarity index 93% rename from website/docs/language/resources/provisioners/syntax.html.md rename to website/docs/language/resources/provisioners/syntax.mdx index 0ba9d9d007f3..421e5d2eec2b 100644 --- a/website/docs/language/resources/provisioners/syntax.html.md +++ b/website/docs/language/resources/provisioners/syntax.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Provisioners" -sidebar_current: "docs-provisioners" -description: "Provisioners run scripts on a local or remote machine during resource creation or destruction. Learn how to declare provisioners in a configuration." +page_title: Provisioners +description: >- + Provisioners run scripts on a local or remote machine during resource creation + or destruction. Learn how to declare provisioners in a configuration. --- # Provisioners @@ -161,7 +161,7 @@ resource "aws_instance" "web" { The `local-exec` provisioner requires no other configuration, but most other provisioners must connect to the remote system using SSH or WinRM. -You must include [a `connection` block](./connection.html) so that Terraform +You must include [a `connection` block](/language/resources/provisioners/connection) so that Terraform will know how to communicate with the server. Terraform includes several built-in provisioners; use the navigation sidebar to @@ -193,8 +193,8 @@ block would create a dependency cycle. ## Suppressing Provisioner Logs in CLI Output The configuration for a `provisioner` block may use sensitive values, such as -[`sensitive` variables](/docs/language/values/variables.html#suppressing-values-in-cli-output) or -[`sensitive` output values](/docs/language/values/outputs.html#sensitive-suppressing-values-in-cli-output). +[`sensitive` variables](/language/values/variables#suppressing-values-in-cli-output) or +[`sensitive` output values](/language/values/outputs#sensitive-suppressing-values-in-cli-output). In this case, all log output from the provisioner is automatically suppressed to prevent the sensitive values from being displayed. @@ -236,8 +236,10 @@ fail, Terraform will error and rerun the provisioners again on the next `terraform apply`. Due to this behavior, care should be taken for destroy provisioners to be safe to run multiple times. - Destroy provisioners of this resource will not run if `create_before_destroy` - is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. +``` +Destroy provisioners of this resource will not run if `create_before_destroy` +is set to `true`. We may address this in the future, and this [GitHub issue](https://github.com/hashicorp/terraform/issues/13549) contains more details. +``` Destroy-time provisioners can only run if they remain in the configuration at the time a resource is destroyed. If a resource block with a destroy-time @@ -288,10 +290,10 @@ By default, provisioners that fail will also cause the Terraform apply itself to fail. The `on_failure` setting can be used to change this. The allowed values are: -- `continue` - Ignore the error and continue with creation or destruction. +* `continue` - Ignore the error and continue with creation or destruction. -- `fail` - Raise an error and stop applying (the default behavior). If this is a creation provisioner, - taint the resource. +* `fail` - Raise an error and stop applying (the default behavior). If this is a creation provisioner, + taint the resource. Example: diff --git a/website/docs/language/resources/syntax.html.md b/website/docs/language/resources/syntax.mdx similarity index 83% rename from website/docs/language/resources/syntax.html.md rename to website/docs/language/resources/syntax.mdx index 456e937794aa..259981bfb627 100644 --- a/website/docs/language/resources/syntax.html.md +++ b/website/docs/language/resources/syntax.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Resources - Configuration Language" -sidebar_current: "docs-config-resources" -description: "Resources correspond to infrastructure objects like virtual networks or compute instances. Learn about resource types, syntax, behavior, and arguments." +page_title: Resources - Configuration Language +description: >- + Resources correspond to infrastructure objects like virtual networks or + compute instances. Learn about resource types, syntax, behavior, and + arguments. --- # Resource Blocks @@ -52,7 +53,7 @@ attributes the resource supports. ### Providers -Each resource type is implemented by a [provider](/docs/language/providers/requirements.html), +Each resource type is implemented by a [provider](/language/providers/requirements), which is a plugin for Terraform that offers a collection of resource types. A provider usually provides resources to manage a single cloud or on-premises infrastructure platform. Providers are distributed separately from Terraform @@ -65,16 +66,16 @@ access their remote APIs, and the root module must provide that configuration. For more information, see: -- [Provider Requirements](/docs/language/providers/requirements.html), for declaring which +- [Provider Requirements](/language/providers/requirements), for declaring which providers a module uses. -- [Provider Configuration](/docs/language/providers/configuration.html), for configuring provider settings. +- [Provider Configuration](/language/providers/configuration), for configuring provider settings. Terraform usually automatically determines which provider to use based on a resource type's name. (By convention, resource type names start with their provider's preferred local name.) When using multiple configurations of a provider (or non-preferred local provider names), you must use the `provider` meta-argument to manually choose an alternate provider configuration. See -[the `provider` meta-argument](/docs/language/meta-arguments/resource-provider.html) for more details. +[the `provider` meta-argument](/language/meta-arguments/resource-provider) for more details. ### Resource Arguments @@ -83,7 +84,7 @@ selected resource type. The resource type's documentation lists which arguments are available and how their values should be formatted. The values for resource arguments can make full use of -[expressions](/docs/language/expressions/index.html) and other dynamic Terraform +[expressions](/language/expressions) and other dynamic Terraform language features. There are also some _meta-arguments_ that are defined by Terraform itself @@ -114,7 +115,7 @@ public provider docs. For more information about how Terraform manages resources when applying a configuration, see -[Resource Behavior](/docs/language/resources/behavior.html). +[Resource Behavior](/language/resources/behavior). ## Meta-Arguments @@ -123,12 +124,12 @@ any resource type to change the behavior of resources. The following meta-arguments are documented on separate pages: -- [`depends_on`, for specifying hidden dependencies](/docs/language/meta-arguments/depends_on.html) -- [`count`, for creating multiple resource instances according to a count](/docs/language/meta-arguments/count.html) -- [`for_each`, to create multiple instances according to a map, or set of strings](/docs/language/meta-arguments/for_each.html) -- [`provider`, for selecting a non-default provider configuration](/docs/language/meta-arguments/resource-provider.html) -- [`lifecycle`, for lifecycle customizations](/docs/language/meta-arguments/lifecycle.html) -- [`provisioner` and `connection`, for taking extra actions after resource creation](/docs/language/resources/provisioners/index.html) +- [`depends_on`, for specifying hidden dependencies](/language/meta-arguments/depends_on) +- [`count`, for creating multiple resource instances according to a count](/language/meta-arguments/count) +- [`for_each`, to create multiple instances according to a map, or set of strings](/language/meta-arguments/for_each) +- [`provider`, for selecting a non-default provider configuration](/language/meta-arguments/resource-provider) +- [`lifecycle`, for lifecycle customizations](/language/meta-arguments/lifecycle) +- [`provisioner` and `connection`, for taking extra actions after resource creation](/language/resources/provisioners) ## Operation Timeouts diff --git a/website/docs/language/settings/backends/artifactory.html.md b/website/docs/language/settings/backends/artifactory.mdx similarity index 63% rename from website/docs/language/settings/backends/artifactory.html.md rename to website/docs/language/settings/backends/artifactory.mdx index d3cdf789fbc3..cca3e82b27dd 100644 --- a/website/docs/language/settings/backends/artifactory.html.md +++ b/website/docs/language/settings/backends/artifactory.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: artifactory" -sidebar_current: "docs-backends-types-standard-artifactory" -description: |- - Terraform can store state in artifactory. +page_title: 'Backend Type: artifactory' +description: Terraform can store state in artifactory. --- # artifactory @@ -17,7 +14,7 @@ configurations may be kept at different subpaths within the repository. -> **Note:** The URL must include the path to the Artifactory installation. It will likely end in `/artifactory`. -This backend does **not** support [state locking](/docs/language/state/locking.html). +This backend does **not** support [state locking](/language/state/locking). ## Example Configuration @@ -52,8 +49,8 @@ data "terraform_remote_state" "foo" { The following configuration options / environment variables are supported: - * `username` / `ARTIFACTORY_USERNAME` (Required) - The username - * `password` / `ARTIFACTORY_PASSWORD` (Required) - The password - * `url` / `ARTIFACTORY_URL` (Required) - The URL. Note that this is the base url to artifactory not the full repo and subpath. - * `repo` (Required) - The repository name - * `subpath` (Required) - Path within the repository +- `username` / `ARTIFACTORY_USERNAME` (Required) - The username +- `password` / `ARTIFACTORY_PASSWORD` (Required) - The password +- `url` / `ARTIFACTORY_URL` (Required) - The URL. Note that this is the base url to artifactory not the full repo and subpath. +- `repo` (Required) - The repository name +- `subpath` (Required) - Path within the repository diff --git a/website/docs/language/settings/backends/azurerm.html.md b/website/docs/language/settings/backends/azurerm.mdx similarity index 96% rename from website/docs/language/settings/backends/azurerm.html.md rename to website/docs/language/settings/backends/azurerm.mdx index 8e0f951a82f5..0539f9ddfe4f 100644 --- a/website/docs/language/settings/backends/azurerm.html.md +++ b/website/docs/language/settings/backends/azurerm.mdx @@ -1,10 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: azurerm" -sidebar_current: "docs-backends-types-standard-azurerm" -description: |- - Terraform can store state remotely in Azure Blob Storage. - +page_title: 'Backend Type: azurerm' +description: Terraform can store state remotely in Azure Blob Storage. --- # azurerm @@ -13,7 +9,7 @@ Stores the state as a Blob with the given Key within the Blob Container within [ This backend supports state locking and consistency checking with Azure Blob Storage native capabilities. --> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. +-> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. ## Example Configuration @@ -30,7 +26,7 @@ terraform { } ``` ---- +*** When authenticating using Managed Service Identity (MSI): @@ -48,7 +44,7 @@ terraform { } ``` ---- +*** When authenticating using Azure AD Authentication: @@ -67,7 +63,7 @@ terraform { -> **Note:** When using AzureAD for Authentication to Storage you also need to ensure the `Storage Blob Data Owner` role is assigned. ---- +*** When authenticating using the Access Key associated with the Storage Account: @@ -85,7 +81,7 @@ terraform { } ``` ---- +*** When authenticating using a SAS Token associated with the Storage Account: @@ -103,7 +99,7 @@ terraform { } ``` --> **NOTE:** When using a Service Principal or an Access Key - we recommend using a [Partial Configuration](/docs/language/settings/backends/configuration.html#partial-configuration) for the credentials. +-> **NOTE:** When using a Service Principal or an Access Key - we recommend using a [Partial Configuration](/language/settings/backends/configuration#partial-configuration) for the credentials. ## Data Source Configuration @@ -120,7 +116,7 @@ data "terraform_remote_state" "foo" { } ``` ---- +*** When authenticating using Managed Service Identity (MSI): @@ -139,7 +135,7 @@ data "terraform_remote_state" "foo" { } ``` ---- +*** When authenticating using AzureAD Authentication: @@ -159,7 +155,7 @@ data "terraform_remote_state" "foo" { -> **Note:** When using AzureAD for Authentication to Storage you also need to ensure the `Storage Blob Data Owner` role is assigned. ---- +*** When authenticating using the Access Key associated with the Storage Account: @@ -178,7 +174,7 @@ data "terraform_remote_state" "foo" { } ``` ---- +*** When authenticating using a SAS Token associated with the Storage Account: @@ -215,14 +211,16 @@ The following configuration options are supported: * `snapshot` - (Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use? Defaults to `false`. This value can also be sourced from the `ARM_SNAPSHOT` environment variable. ---- +*** When authenticating using the Managed Service Identity (MSI) - the following fields are also supported: * `resource_group_name` - (Required) The Name of the Resource Group in which the Storage Account exists. * `msi_endpoint` - (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. This can also be sourced from the `ARM_MSI_ENDPOINT` environment variable. -* + +* + * `subscription_id` - (Optional) The Subscription ID in which the Storage Account exists. This can also be sourced from the `ARM_SUBSCRIPTION_ID` environment variable. * `tenant_id` - (Optional) The Tenant ID in which the Subscription exists. This can also be sourced from the `ARM_TENANT_ID` environment variable. @@ -233,19 +231,19 @@ When authenticating using the Managed Service Identity (MSI) - the following fie * `use_msi` - (Optional) Should Managed Service Identity authentication be used? This can also be sourced from the `ARM_USE_MSI` environment variable. ---- +*** When authenticating using a SAS Token associated with the Storage Account - the following fields are also supported: * `sas_token` - (Optional) The SAS Token used to access the Blob Storage Account. This can also be sourced from the `ARM_SAS_TOKEN` environment variable. ---- +*** When authenticating using the Storage Account's Access Key - the following fields are also supported: * `access_key` - (Optional) The Access Key used to access the Blob Storage Account. This can also be sourced from the `ARM_ACCESS_KEY` environment variable. ---- +*** When authenticating using AzureAD Authentication - the following fields are also supported: @@ -257,7 +255,7 @@ When authenticating using AzureAD Authentication - the following fields are also -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. ---- +*** When authenticating using a Service Principal with a Client Certificate - the following fields are also supported: @@ -277,7 +275,7 @@ When authenticating using a Service Principal with a Client Certificate - the fo -> **Note:** By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting `use_microsoft_graph` to `true`. **The default for this will change in Terraform 1.2**, so that MSAL authentication is used by default. ---- +*** When authenticating using a Service Principal with a Client Secret - the following fields are also supported: diff --git a/website/docs/language/settings/backends/configuration.html.md b/website/docs/language/settings/backends/configuration.mdx similarity index 81% rename from website/docs/language/settings/backends/configuration.html.md rename to website/docs/language/settings/backends/configuration.mdx index e7286f5bf544..79f118672b6a 100644 --- a/website/docs/language/settings/backends/configuration.html.md +++ b/website/docs/language/settings/backends/configuration.mdx @@ -1,15 +1,14 @@ --- -layout: "language" -page_title: "Backend Configuration - Configuration Language" +page_title: Backend Configuration - Configuration Language --- # Backend Configuration Each Terraform configuration can specify a backend, which defines where -[state](/docs/language/state/index.html) snapshots are stored. +[state](/language/state) snapshots are stored. You do not need to configure a backend when using Terraform Cloud because -Terraform Cloud automatically manages state in the workspaces associated with your configuration. If your configuration includes [a `cloud` block](/docs/language/settings/terraform-cloud.html), it cannot include a `backend` block. +Terraform Cloud automatically manages state in the workspaces associated with your configuration. If your configuration includes [a `cloud` block](/language/settings/terraform-cloud), it cannot include a `backend` block. Most non-trivial Terraform configurations store state remotely so that multiple people can work with the same infrastructure. @@ -73,25 +72,25 @@ automatically by an automation script running Terraform. When some or all of the arguments are omitted, we call this a _partial configuration_. With a partial configuration, the remaining configuration arguments must be -provided as part of [the initialization process](/docs/cli/init/index.html). +provided as part of [the initialization process](/cli/init). There are several ways to supply the remaining arguments: - * **File**: A configuration file may be specified via the `init` command line. - To specify a file, use the `-backend-config=PATH` option when running - `terraform init`. If the file contains secrets it may be kept in - a secure data store, such as [Vault](https://www.vaultproject.io/), - in which case it must be downloaded to the local disk before running Terraform. +- **File**: A configuration file may be specified via the `init` command line. + To specify a file, use the `-backend-config=PATH` option when running + `terraform init`. If the file contains secrets it may be kept in + a secure data store, such as [Vault](https://www.vaultproject.io/), + in which case it must be downloaded to the local disk before running Terraform. - * **Command-line key/value pairs**: Key/value pairs can be specified via the - `init` command line. Note that many shells retain command-line flags in a - history file, so this isn't recommended for secrets. To specify a single - key/value pair, use the `-backend-config="KEY=VALUE"` option when running - `terraform init`. +- **Command-line key/value pairs**: Key/value pairs can be specified via the + `init` command line. Note that many shells retain command-line flags in a + history file, so this isn't recommended for secrets. To specify a single + key/value pair, use the `-backend-config="KEY=VALUE"` option when running + `terraform init`. - * **Interactively**: Terraform will interactively ask you for the required - values, unless interactive input is disabled. Terraform will not prompt for - optional values. +- **Interactively**: Terraform will interactively ask you for the required + values, unless interactive input is disabled. Terraform will not prompt for + optional values. If backend settings are provided in multiple locations, the top-level settings are merged such that any command-line options override the settings @@ -156,12 +155,12 @@ both the configuration itself as well as the type of backend (for example from "consul" to "s3"). Terraform will automatically detect any changes in your configuration -and request a [reinitialization](/docs/cli/init/index.html). As part of +and request a [reinitialization](/cli/init). As part of the reinitialization process, Terraform will ask if you'd like to migrate your existing state to the new configuration. This allows you to easily switch from one backend to another. -If you're using multiple [workspaces](/docs/language/state/workspaces.html), +If you're using multiple [workspaces](/language/state/workspaces), Terraform can copy all workspaces to the destination. If Terraform detects you have multiple workspaces, it will ask if this is what you want to do. @@ -172,7 +171,7 @@ want to migrate your state. You can respond "no" in this scenario. If you no longer want to use any backend, you can simply remove the configuration from the file. Terraform will detect this like any other -change and prompt you to [reinitialize](/docs/cli/init/index.html). +change and prompt you to [reinitialize](/cli/init). As part of the reinitialization, Terraform will ask if you'd like to migrate your state back down to normal local state. Once this is complete then diff --git a/website/docs/language/settings/backends/consul.html.md b/website/docs/language/settings/backends/consul.html.md deleted file mode 100644 index dcb21df88a05..000000000000 --- a/website/docs/language/settings/backends/consul.html.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: consul" -sidebar_current: "docs-backends-types-standard-consul" -description: |- - Terraform can store state in Consul. ---- - -# consul - -Stores the state in the [Consul](https://www.consul.io/) KV store at a given path. - -This backend supports [state locking](/docs/language/state/locking.html). - -## Example Configuration - -```hcl -terraform { - backend "consul" { - address = "consul.example.com" - scheme = "https" - path = "full/path" - } -} -``` - -Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "consul" - config = { - path = "full/path" - } -} -``` - -## Configuration variables - -The following configuration options / environment variables are supported: - - * `path` - (Required) Path in the Consul KV store - * `access_token` / `CONSUL_HTTP_TOKEN` - (Required) Access token - * `address` / `CONSUL_HTTP_ADDR` - (Optional) DNS name and port of your Consul endpoint specified in the - format `dnsname:port`. Defaults to the local agent HTTP listener. - * `scheme` - (Optional) Specifies what protocol to use when talking to the given - `address`, either `http` or `https`. SSL support can also be triggered - by setting then environment variable `CONSUL_HTTP_SSL` to `true`. - * `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent. - * `http_auth` / `CONSUL_HTTP_AUTH` - (Optional) HTTP Basic Authentication credentials to be used when - communicating with Consul, in the format of either `user` or `user:pass`. - * `gzip` - (Optional) `true` to compress the state data using gzip, or `false` (the default) to leave it uncompressed. - * `lock` - (Optional) `false` to disable locking. This defaults to true, but will require session permissions with Consul and at least kv write permissions on `$path/.lock` to perform locking. - * `ca_file` / `CONSUL_CACERT` - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. - * `cert_file` / `CONSUL_CLIENT_CERT` - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file`. - * `key_file` / `CONSUL_CLIENT_KEY` - (Optional) A path to a PEM-encoded private key, required if `cert_file` is specified. diff --git a/website/docs/language/settings/backends/consul.mdx b/website/docs/language/settings/backends/consul.mdx new file mode 100644 index 000000000000..f003b7851bdd --- /dev/null +++ b/website/docs/language/settings/backends/consul.mdx @@ -0,0 +1,56 @@ +--- +page_title: 'Backend Type: consul' +description: Terraform can store state in Consul. +--- + +# consul + +Stores the state in the [Consul](https://www.consul.io/) KV store at a given path. + +This backend supports [state locking](/language/state/locking). + +## Example Configuration + +```hcl +terraform { + backend "consul" { + address = "consul.example.com" + scheme = "https" + path = "full/path" + } +} +``` + +Note that for the access credentials we recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration). + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "consul" + config = { + path = "full/path" + } +} +``` + +## Configuration variables + +The following configuration options / environment variables are supported: + +- `path` - (Required) Path in the Consul KV store +- `access_token` / `CONSUL_HTTP_TOKEN` - (Required) Access token +- `address` / `CONSUL_HTTP_ADDR` - (Optional) DNS name and port of your Consul endpoint specified in the + format `dnsname:port`. Defaults to the local agent HTTP listener. +- `scheme` - (Optional) Specifies what protocol to use when talking to the given + `address`, either `http` or `https`. SSL support can also be triggered + by setting then environment variable `CONSUL_HTTP_SSL` to `true`. +- `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent. +- `http_auth` / `CONSUL_HTTP_AUTH` - (Optional) HTTP Basic Authentication credentials to be used when + communicating with Consul, in the format of either `user` or `user:pass`. +- `gzip` - (Optional) `true` to compress the state data using gzip, or `false` (the default) to leave it uncompressed. +- `lock` - (Optional) `false` to disable locking. This defaults to true, but will require session permissions with Consul and at least kv write permissions on `$path/.lock` to perform locking. +- `ca_file` / `CONSUL_CACERT` - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. +- `cert_file` / `CONSUL_CLIENT_CERT` - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file`. +- `key_file` / `CONSUL_CLIENT_KEY` - (Optional) A path to a PEM-encoded private key, required if `cert_file` is specified. diff --git a/website/docs/language/settings/backends/cos.html.md b/website/docs/language/settings/backends/cos.mdx similarity index 51% rename from website/docs/language/settings/backends/cos.html.md rename to website/docs/language/settings/backends/cos.mdx index 4e8772f91bbf..548c569cd5ec 100644 --- a/website/docs/language/settings/backends/cos.html.md +++ b/website/docs/language/settings/backends/cos.mdx @@ -1,16 +1,15 @@ --- -layout: "language" -page_title: "Backend Type: cos" -sidebar_current: "docs-backends-types-standard-cos" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: cos' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # COS Stores the state as an object in a configurable prefix in a given bucket on [Tencent Cloud Object Storage](https://intl.cloud.tencent.com/product/cos) (COS). -This backend supports [state locking](/docs/language/state/locking.html). +This backend supports [state locking](/language/state/locking). ~> **Warning!** It is highly recommended that you enable [Object Versioning](https://intl.cloud.tencent.com/document/product/436/19883) on the COS bucket to allow for state recovery in the case of accidental deletions and human error. @@ -32,7 +31,7 @@ Terraform state will be written into the file `terraform/state/terraform.tfstate ## Data Source Configuration -To make use of the COS remote state in another configuration, use the [`terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +To make use of the COS remote state in another configuration, use the [`terraform_remote_state` data source](/language/state/remote-state-data). ```hcl data "terraform_remote_state" "foo" { @@ -50,11 +49,11 @@ data "terraform_remote_state" "foo" { The following configuration options or environment variables are supported: - * `secret_id` - (Optional) Secret id of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_ID`. - * `secret_key` - (Optional) Secret key of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_KEY`. - * `region` - (Optional) The region of the COS bucket. It supports environment variables `TENCENTCLOUD_REGION`. - * `bucket` - (Required) The name of the COS bucket. You shall manually create it first. - * `prefix` - (Optional) The directory for saving the state file in bucket. Default to "env:". - * `key` - (Optional) The path for saving the state file in bucket. Defaults to `terraform.tfstate`. - * `encrypt` - (Optional) Whether to enable server side encryption of the state file. If it is true, COS will use 'AES256' encryption algorithm to encrypt state file. - * `acl` - (Optional) Object ACL to be applied to the state file, allows `private` and `public-read`. Defaults to `private`. +- `secret_id` - (Optional) Secret id of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_ID`. +- `secret_key` - (Optional) Secret key of Tencent Cloud. It supports environment variables `TENCENTCLOUD_SECRET_KEY`. +- `region` - (Optional) The region of the COS bucket. It supports environment variables `TENCENTCLOUD_REGION`. +- `bucket` - (Required) The name of the COS bucket. You shall manually create it first. +- `prefix` - (Optional) The directory for saving the state file in bucket. Default to "env:". +- `key` - (Optional) The path for saving the state file in bucket. Defaults to `terraform.tfstate`. +- `encrypt` - (Optional) Whether to enable server side encryption of the state file. If it is true, COS will use 'AES256' encryption algorithm to encrypt state file. +- `acl` - (Optional) Object ACL to be applied to the state file, allows `private` and `public-read`. Defaults to `private`. diff --git a/website/docs/language/settings/backends/etcd.html.md b/website/docs/language/settings/backends/etcd.mdx similarity index 55% rename from website/docs/language/settings/backends/etcd.html.md rename to website/docs/language/settings/backends/etcd.mdx index 771b74d72480..8495e72f58a7 100644 --- a/website/docs/language/settings/backends/etcd.html.md +++ b/website/docs/language/settings/backends/etcd.mdx @@ -1,16 +1,13 @@ --- -layout: "language" -page_title: "Backend Type: etcd" -sidebar_current: "docs-backends-types-standard-etcdv2" -description: |- - Terraform can store state remotely in etcd 2.x. +page_title: 'Backend Type: etcd' +description: Terraform can store state remotely in etcd 2.x. --- # etcd Stores the state in [etcd 2.x](https://coreos.com/etcd/docs/latest/v2/README.html) at a given path. -This backend does **not** support [state locking](/docs/language/state/locking.html). +This backend does **not** support [state locking](/language/state/locking). ## Example Configuration @@ -39,7 +36,7 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: - * `path` - (Required) The path where to store the state - * `endpoints` - (Required) A space-separated list of the etcd endpoints - * `username` - (Optional) The username - * `password` - (Optional) The password +- `path` - (Required) The path where to store the state +- `endpoints` - (Required) A space-separated list of the etcd endpoints +- `username` - (Optional) The username +- `password` - (Optional) The password diff --git a/website/docs/language/settings/backends/etcdv3.html.md b/website/docs/language/settings/backends/etcdv3.html.md deleted file mode 100644 index 478f79d2ca6c..000000000000 --- a/website/docs/language/settings/backends/etcdv3.html.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: etcdv3" -sidebar_current: "docs-backends-types-standard-etcdv3" -description: |- - Terraform can store state remotely in etcd 3.x. ---- - -# etcdv3 - -Stores the state in the [etcd](https://etcd.io/) KV store with a given prefix. - -This backend supports [state locking](/docs/language/state/locking.html). - -## Example Configuration - -```hcl -terraform { - backend "etcdv3" { - endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] - lock = true - prefix = "terraform-state/" - } -} -``` - -Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "etcdv3" - config = { - endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] - lock = true - prefix = "terraform-state/" - } -} -``` - -## Configuration variables - -The following configuration options / environment variables are supported: - - * `endpoints` - (Required) The list of 'etcd' endpoints which to connect to. - * `username` / `ETCDV3_USERNAME` - (Optional) Username used to connect to the etcd cluster. - * `password` / `ETCDV3_PASSWORD` - (Optional) Password used to connect to the etcd cluster. - * `prefix` - (Optional) An optional prefix to be added to keys when to storing state in etcd. Defaults to `""`. - * `lock` - (Optional) Whether to lock state access. Defaults to `true`. - * `cacert_path` - (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers. - * `cert_path` - (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification. - * `key_path` - (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification. - * `max_request_bytes` - (Optional) The max request size to send to etcd. This can be increased to enable storage of larger state. You must set the corresponding server-side flag [--max-request-bytes](https://etcd.io/docs/current/dev-guide/limit/#request-size-limit) as well and the value should be less than the client setting. Defaults to `2097152` (2.0 MiB). **Please Note:** Increasing etcd's request size limit may negatively impact overall latency. diff --git a/website/docs/language/settings/backends/etcdv3.mdx b/website/docs/language/settings/backends/etcdv3.mdx new file mode 100644 index 000000000000..2196c164c30c --- /dev/null +++ b/website/docs/language/settings/backends/etcdv3.mdx @@ -0,0 +1,52 @@ +--- +page_title: 'Backend Type: etcdv3' +description: Terraform can store state remotely in etcd 3.x. +--- + +# etcdv3 + +Stores the state in the [etcd](https://etcd.io/) KV store with a given prefix. + +This backend supports [state locking](/language/state/locking). + +## Example Configuration + +```hcl +terraform { + backend "etcdv3" { + endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] + lock = true + prefix = "terraform-state/" + } +} +``` + +Note that for the access credentials we recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration). + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "etcdv3" + config = { + endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"] + lock = true + prefix = "terraform-state/" + } +} +``` + +## Configuration variables + +The following configuration options / environment variables are supported: + +- `endpoints` - (Required) The list of 'etcd' endpoints which to connect to. +- `username` / `ETCDV3_USERNAME` - (Optional) Username used to connect to the etcd cluster. +- `password` / `ETCDV3_PASSWORD` - (Optional) Password used to connect to the etcd cluster. +- `prefix` - (Optional) An optional prefix to be added to keys when to storing state in etcd. Defaults to `""`. +- `lock` - (Optional) Whether to lock state access. Defaults to `true`. +- `cacert_path` - (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers. +- `cert_path` - (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification. +- `key_path` - (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification. +- `max_request_bytes` - (Optional) The max request size to send to etcd. This can be increased to enable storage of larger state. You must set the corresponding server-side flag [--max-request-bytes](https://etcd.io/docs/current/dev-guide/limit/#request-size-limit) as well and the value should be less than the client setting. Defaults to `2097152` (2.0 MiB). **Please Note:** Increasing etcd's request size limit may negatively impact overall latency. diff --git a/website/docs/language/settings/backends/gcs.html.md b/website/docs/language/settings/backends/gcs.mdx similarity index 53% rename from website/docs/language/settings/backends/gcs.html.md rename to website/docs/language/settings/backends/gcs.mdx index 172c1154a044..f5f23353a730 100644 --- a/website/docs/language/settings/backends/gcs.html.md +++ b/website/docs/language/settings/backends/gcs.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "Backend Type: gcs" -sidebar_current: "docs-backends-types-standard-gcs" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: gcs' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # gcs @@ -11,7 +10,7 @@ description: |- Stores the state as an object in a configurable prefix in a pre-existing bucket on [Google Cloud Storage](https://cloud.google.com/storage/) (GCS). The bucket must exist prior to configuring the backend. -This backend supports [state locking](/docs/language/state/locking.html). +This backend supports [state locking](/language/state/locking). ~> **Warning!** It is highly recommended that you enable [Object Versioning](https://cloud.google.com/storage/docs/object-versioning) @@ -78,30 +77,30 @@ Terraform can impersonate a Google Service Account as described [here](https://c The following configuration options are supported: - * `bucket` - (Required) The name of the GCS bucket. This name must be - globally unique. For more information, see [Bucket Naming - Guidelines](https://cloud.google.com/storage/docs/bucketnaming.html#requirements). - * `credentials` / `GOOGLE_BACKEND_CREDENTIALS` / `GOOGLE_CREDENTIALS` - - (Optional) Local path to Google Cloud Platform account credentials in JSON - format. If unset, [Google Application Default - Credentials](https://developers.google.com/identity/protocols/application-default-credentials) - are used. The provided credentials must have Storage Object Admin role on the bucket. - **Warning**: if using the Google Cloud Platform provider as well, it will - also pick up the `GOOGLE_CREDENTIALS` environment variable. - * `impersonate_service_account` - (Optional) The service account to impersonate for accessing the State Bucket. - You must have `roles/iam.serviceAccountTokenCreator` role on that account for the impersonation to succeed. - If you are using a delegation chain, you can specify that using the `impersonate_service_account_delegates` field. - Alternatively, this can be specified using the `GOOGLE_IMPERSONATE_SERVICE_ACCOUNT` environment - variable. - * `impersonate_service_account_delegates` - (Optional) The delegation chain for an impersonating a service account as described [here](https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials#sa-credentials-delegated). - * `access_token` - (Optional) A temporary [OAuth 2.0 access token] obtained - from the Google Authorization server, i.e. the `Authorization: Bearer` token - used to authenticate HTTP requests to GCP APIs. This is an alternative to - `credentials`. If both are specified, `access_token` will be used over the - `credentials` field. - * `prefix` - (Optional) GCS prefix inside the bucket. Named states for - workspaces are stored in an object called `/.tfstate`. - * `encryption_key` / `GOOGLE_ENCRYPTION_KEY` - (Optional) A 32 byte base64 - encoded 'customer supplied encryption key' used to encrypt all state. For - more information see [Customer Supplied Encryption - Keys](https://cloud.google.com/storage/docs/encryption#customer-supplied). +- `bucket` - (Required) The name of the GCS bucket. This name must be + globally unique. For more information, see [Bucket Naming + Guidelines](https://cloud.google.com/storage/docs/bucketnaming.html#requirements). +- `credentials` / `GOOGLE_BACKEND_CREDENTIALS` / `GOOGLE_CREDENTIALS` - + (Optional) Local path to Google Cloud Platform account credentials in JSON + format. If unset, [Google Application Default + Credentials](https://developers.google.com/identity/protocols/application-default-credentials) + are used. The provided credentials must have Storage Object Admin role on the bucket. + **Warning**: if using the Google Cloud Platform provider as well, it will + also pick up the `GOOGLE_CREDENTIALS` environment variable. +- `impersonate_service_account` - (Optional) The service account to impersonate for accessing the State Bucket. + You must have `roles/iam.serviceAccountTokenCreator` role on that account for the impersonation to succeed. + If you are using a delegation chain, you can specify that using the `impersonate_service_account_delegates` field. + Alternatively, this can be specified using the `GOOGLE_IMPERSONATE_SERVICE_ACCOUNT` environment + variable. +- `impersonate_service_account_delegates` - (Optional) The delegation chain for an impersonating a service account as described [here](https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials#sa-credentials-delegated). +- `access_token` - (Optional) A temporary \[OAuth 2.0 access token] obtained + from the Google Authorization server, i.e. the `Authorization: Bearer` token + used to authenticate HTTP requests to GCP APIs. This is an alternative to + `credentials`. If both are specified, `access_token` will be used over the + `credentials` field. +- `prefix` - (Optional) GCS prefix inside the bucket. Named states for + workspaces are stored in an object called `/.tfstate`. +- `encryption_key` / `GOOGLE_ENCRYPTION_KEY` - (Optional) A 32 byte base64 + encoded 'customer supplied encryption key' used to encrypt all state. For + more information see [Customer Supplied Encryption + Keys](https://cloud.google.com/storage/docs/encryption#customer-supplied). diff --git a/website/docs/language/settings/backends/http.html.md b/website/docs/language/settings/backends/http.html.md deleted file mode 100644 index 78eedcba922f..000000000000 --- a/website/docs/language/settings/backends/http.html.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: http" -sidebar_current: "docs-backends-types-standard-http" -description: |- - Terraform can store state remotely at any valid HTTP endpoint. ---- - -# http - -Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client. - -State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable. - -This backend optionally supports [state locking](/docs/language/state/locking.html). When locking -support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The -endpoint should return a 423: Locked or 409: Conflict with the holding lock info when it's already -taken, 200: OK for success. Any other status will be considered an error. The ID of the holding lock -info will be added as a query parameter to state updates requests. - -## Example Usage - -```hcl -terraform { - backend "http" { - address = "http://myrest.api.com/foo" - lock_address = "http://myrest.api.com/foo" - unlock_address = "http://myrest.api.com/foo" - } -} -``` - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "http" - config = { - address = "http://my.rest.api.com" - } -} -``` - -## Configuration variables - -The following configuration options / environment variables are supported: - - * `address` / `TF_HTTP_ADDRESS` - (Required) The address of the REST endpoint - * `update_method` / `TF_HTTP_UPDATE_METHOD` - (Optional) HTTP method to use - when updating state. Defaults to `POST`. - * `lock_address` / `TF_HTTP_LOCK_ADDRESS` - (Optional) The address of the lock - REST endpoint. Defaults to disabled. - * `lock_method` / `TF_HTTP_LOCK_METHOD` - (Optional) The HTTP method to use - when locking. Defaults to `LOCK`. - * `unlock_address` / `TF_HTTP_UNLOCK_ADDRESS` - (Optional) The address of the - unlock REST endpoint. Defaults to disabled. - * `unlock_method` / `TF_HTTP_UNLOCK_METHOD` - (Optional) The HTTP method to use - when unlocking. Defaults to `UNLOCK`. - * `username` / `TF_HTTP_USERNAME` - (Optional) The username for HTTP basic - authentication - * `password` / `TF_HTTP_PASSWORD` - (Optional) The password for HTTP basic - authentication - * `skip_cert_verification` - (Optional) Whether to skip TLS verification. - Defaults to `false`. - * `retry_max` / `TF_HTTP_RETRY_MAX` – (Optional) The number of HTTP request - retries. Defaults to `2`. - * `retry_wait_min` / `TF_HTTP_RETRY_WAIT_MIN` – (Optional) The minimum time in - seconds to wait between HTTP request attempts. Defaults to `1`. - * `retry_wait_max` / `TF_HTTP_RETRY_WAIT_MAX` – (Optional) The maximum time in - seconds to wait between HTTP request attempts. Defaults to `30`. diff --git a/website/docs/language/settings/backends/http.mdx b/website/docs/language/settings/backends/http.mdx new file mode 100644 index 000000000000..a87b2152c8a2 --- /dev/null +++ b/website/docs/language/settings/backends/http.mdx @@ -0,0 +1,67 @@ +--- +page_title: 'Backend Type: http' +description: Terraform can store state remotely at any valid HTTP endpoint. +--- + +# http + +Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client. + +State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable. + +This backend optionally supports [state locking](/language/state/locking). When locking +support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The +endpoint should return a 423: Locked or 409: Conflict with the holding lock info when it's already +taken, 200: OK for success. Any other status will be considered an error. The ID of the holding lock +info will be added as a query parameter to state updates requests. + +## Example Usage + +```hcl +terraform { + backend "http" { + address = "http://myrest.api.com/foo" + lock_address = "http://myrest.api.com/foo" + unlock_address = "http://myrest.api.com/foo" + } +} +``` + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "http" + config = { + address = "http://my.rest.api.com" + } +} +``` + +## Configuration variables + +The following configuration options / environment variables are supported: + +- `address` / `TF_HTTP_ADDRESS` - (Required) The address of the REST endpoint +- `update_method` / `TF_HTTP_UPDATE_METHOD` - (Optional) HTTP method to use + when updating state. Defaults to `POST`. +- `lock_address` / `TF_HTTP_LOCK_ADDRESS` - (Optional) The address of the lock + REST endpoint. Defaults to disabled. +- `lock_method` / `TF_HTTP_LOCK_METHOD` - (Optional) The HTTP method to use + when locking. Defaults to `LOCK`. +- `unlock_address` / `TF_HTTP_UNLOCK_ADDRESS` - (Optional) The address of the + unlock REST endpoint. Defaults to disabled. +- `unlock_method` / `TF_HTTP_UNLOCK_METHOD` - (Optional) The HTTP method to use + when unlocking. Defaults to `UNLOCK`. +- `username` / `TF_HTTP_USERNAME` - (Optional) The username for HTTP basic + authentication +- `password` / `TF_HTTP_PASSWORD` - (Optional) The password for HTTP basic + authentication +- `skip_cert_verification` - (Optional) Whether to skip TLS verification. + Defaults to `false`. +- `retry_max` / `TF_HTTP_RETRY_MAX` – (Optional) The number of HTTP request + retries. Defaults to `2`. +- `retry_wait_min` / `TF_HTTP_RETRY_WAIT_MIN` – (Optional) The minimum time in + seconds to wait between HTTP request attempts. Defaults to `1`. +- `retry_wait_max` / `TF_HTTP_RETRY_WAIT_MAX` – (Optional) The maximum time in + seconds to wait between HTTP request attempts. Defaults to `30`. diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.mdx similarity index 70% rename from website/docs/language/settings/backends/index.html.md rename to website/docs/language/settings/backends/index.mdx index 3259b542228f..6af64ab113ef 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.mdx @@ -1,21 +1,22 @@ --- -layout: "language" -page_title: "Backend Overview - Configuration Language" -description: "A backend defines where Terraform stores its state. Learn about how backends work." +page_title: Backend Overview - Configuration Language +description: >- + A backend defines where Terraform stores its state. Learn about how backends + work. --- # Backends -Backends define where Terraform's [state](/docs/language/state/index.html) snapshots are stored. +Backends define where Terraform's [state](/language/state) snapshots are stored. A given Terraform configuration can either specify a backend, -[integrate with Terraform Cloud](/docs/language/settings/terraform-cloud.html), +[integrate with Terraform Cloud](/language/settings/terraform-cloud), or do neither and default to storing state locally. The rest of this page introduces the concept of backends; the other pages in this section document how to configure and use backends. -- [Backend Configuration](/docs/language/settings/backends/configuration.html) documents the form +- [Backend Configuration](/language/settings/backends/configuration) documents the form of a `backend` block, which selects and configures a backend for a Terraform configuration. - This section also includes a page for each of Terraform's built-in backends, @@ -24,14 +25,14 @@ this section document how to configure and use backends. ## What Backends Do -Backends primarily determine where Terraform stores its [state](/docs/language/state/index.html). -Terraform uses this persisted [state](/docs/language/state/index.html) data to keep track of the +Backends primarily determine where Terraform stores its [state](/language/state). +Terraform uses this persisted [state](/language/state) data to keep track of the resources it manages. Since it needs the state in order to know which real-world infrastructure objects correspond to the resources in a configuration, everyone working with a given collection of infrastructure resources must be able to access the same state data. By default, Terraform implicitly uses a backend called -[`local`](/docs/language/settings/backends/local.html) to store state as a local file on disk. +[`local`](/language/settings/backends/local) to store state as a local file on disk. Every other backend stores state in a remote service of some kind, which allows multiple people to access it. Accessing state in a remote service generally requires some kind of access credentials, since state data contains extremely sensitive information. @@ -42,9 +43,9 @@ conflicts and inconsistencies. -> **Note:** In Terraform versions prior to 1.1.0, backends were also classified as being 'standard' or 'enhanced', where the latter term referred to the ability of the -[remote backend](/docs/language/settings/backends/remote.html) to store state and perform +[remote backend](/language/settings/backends/remote) to store state and perform Terraform operations. This classification has been removed, clarifying the primary purpose of -backends. Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) for details about how to +backends. Refer to [Using Terraform Cloud](/cli/cloud) for details about how to store state, execute remote operations, and use Terraform Cloud directly from Terraform. ## Available Backends @@ -55,4 +56,3 @@ very often. The built-in backends are the only backends. You cannot load additional backends as plugins. - diff --git a/website/docs/language/settings/backends/kubernetes.html.md b/website/docs/language/settings/backends/kubernetes.mdx similarity index 86% rename from website/docs/language/settings/backends/kubernetes.html.md rename to website/docs/language/settings/backends/kubernetes.mdx index 20e3ecc1b38d..1f7ee648ef1e 100644 --- a/website/docs/language/settings/backends/kubernetes.html.md +++ b/website/docs/language/settings/backends/kubernetes.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: Kubernetes" -sidebar_current: "docs-backends-types-standard-kubernetes" -description: |- - Terraform can store state remotely in Kubernetes and lock that state. +page_title: 'Backend Type: Kubernetes' +description: Terraform can store state remotely in Kubernetes and lock that state. --- # kubernetes @@ -12,7 +9,7 @@ description: |- Stores the state in a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). -This backend supports [state locking](/docs/language/state/locking.html), with locking done using a Lease resource. +This backend supports [state locking](/language/state/locking), with locking done using a Lease resource. ## Example Configuration @@ -27,14 +24,13 @@ terraform { This assumes the user/service account running terraform has [permissions](https://kubernetes.io/docs/reference/access-authn-authz/authorization/) to read/write secrets in the [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) used to store the secret. -If the `config_path` or `config_paths` attribute is set the backend will attempt to use a [kubeconfig file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) to gain access to the cluster. +If the `config_path` or `config_paths` attribute is set the backend will attempt to use a [kubeconfig file](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) to gain access to the cluster. -If the `in_cluster_config` flag is set the backend will attempt to use a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) to access the cluster. This can be used if Terraform is being run from within a pod running in the Kubernetes cluster. +If the `in_cluster_config` flag is set the backend will attempt to use a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) to access the cluster. This can be used if Terraform is being run from within a pod running in the Kubernetes cluster. For most use cases either `in_cluster_config`, `config_path`, or `config_paths` will need to be set. If all flags are set the configuration at `config_path` will be used. -Note that for the access credentials we recommend using a [partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - +Note that for the access credentials we recommend using a [partial configuration](/language/settings/backends/configuration#partial-configuration). ## Example Referencing @@ -69,7 +65,7 @@ The following configuration options are supported: * `config_context_auth_info` - (Optional) Authentication info context of the kube config (name of the kubeconfig user, `--user` flag in `kubectl`). Can be sourced from `KUBE_CTX_AUTH_INFO`. * `config_context_cluster` - (Optional) Cluster context of the kube config (name of the kubeconfig cluster, `--cluster` flag in `kubectl`). Can be sourced from `KUBE_CTX_CLUSTER`. * `token` - (Optional) Token of your service account. Can be sourced from `KUBE_TOKEN`. -* `exec` - (Optional) Configuration block to use an [exec-based credential plugin] (https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins), e.g. call an external command to receive user credentials. +* `exec` - (Optional) Configuration block to use an [exec-based credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins), e.g. call an external command to receive user credentials. * `api_version` - (Required) API version to use when decoding the ExecCredentials resource, e.g. `client.authentication.k8s.io/v1beta1`. * `command` - (Required) Command to execute. * `args` - (Optional) List of arguments to pass when executing the plugin. diff --git a/website/docs/language/settings/backends/local.html.md b/website/docs/language/settings/backends/local.mdx similarity index 71% rename from website/docs/language/settings/backends/local.html.md rename to website/docs/language/settings/backends/local.mdx index f2829d3a4298..d2f5d18a0ae6 100644 --- a/website/docs/language/settings/backends/local.html.md +++ b/website/docs/language/settings/backends/local.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "Backend Type: local" -sidebar_current: "docs-backends-types-enhanced-local" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: local' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # local @@ -39,9 +38,9 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: - * `path` - (Optional) The path to the `tfstate` file. This defaults to - "terraform.tfstate" relative to the root module by default. - * `workspace_dir` - (Optional) The path to non-default workspaces. +* `path` - (Optional) The path to the `tfstate` file. This defaults to + "terraform.tfstate" relative to the root module by default. +* `workspace_dir` - (Optional) The path to non-default workspaces. ## Command Line Arguments @@ -58,17 +57,17 @@ additional arguments: * `-state-out=FILENAME` - overrides the state filename when _writing_ new state snapshots. - If you use `-state` without also using `-state-out` then Terraform will - use the `-state` filename for both `-state` and `-state-out`, which means - Terraform will overwrite the input file if it creates a new state snapshot. + If you use `-state` without also using `-state-out` then Terraform will + use the `-state` filename for both `-state` and `-state-out`, which means + Terraform will overwrite the input file if it creates a new state snapshot. * `-backup=FILENAME` - overrides the default filename that the local backend would normally choose dynamically to create backup files when it writes new state. - If you use `-state` without also using `-backup` then Terraform will use - the `-state` filename as a filename prefix for generating a backup filename. - You can use `-backup=-` (that is, set the filename to just the ASCII - dash character) to disable the creation of backup files altogether. + If you use `-state` without also using `-backup` then Terraform will use + the `-state` filename as a filename prefix for generating a backup filename. + You can use `-backup=-` (that is, set the filename to just the ASCII + dash character) to disable the creation of backup files altogether. These three options are preserved for backward-compatibility with earlier workflows that predated the introduction of built-in remote state, where @@ -78,7 +77,7 @@ the three arguments would typically all be paths within a temporary directory used just for one operation. Because these old workflows predate the introduction of the possibility of -[multiple workspaces](/docs/language/state/workspaces.html), setting them +[multiple workspaces](/language/state/workspaces), setting them overrides Terraform's usual behavior of selecting a different state filename based on the selected workspace. If you use all three of these options then the selected workspace has no effect on which filenames Terraform will select @@ -90,7 +89,7 @@ backend type selected. We do not recommend using these options in new systems, even if you are running Terraform in automation. Instead, -[select a different backend which supports remote state](./) and configure it +[select a different backend which supports remote state](/language/settings/backends) and configure it within your root module, which ensures that everyone working on your configuration will automatically retrieve and store state in the correct shared location without any special command line options. diff --git a/website/docs/language/settings/backends/manta.html.md b/website/docs/language/settings/backends/manta.html.md deleted file mode 100644 index 150b3633b81e..000000000000 --- a/website/docs/language/settings/backends/manta.html.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: manta" -sidebar_current: "docs-backends-types-standard-manta" -description: |- - Terraform can store state in manta. ---- - -# manta - -Stores the state as an artifact in [Manta](https://www.joyent.com/manta). - -This backend supports [state locking](/docs/language/state/locking.html), with locking within Manta. - -## Example Configuration - -```hcl -terraform { - backend "manta" { - path = "random/path" - object_name = "terraform.tfstate" - } -} -``` - -Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). - -## Data Source Configuration - -```hcl -data "terraform_remote_state" "foo" { - backend = "manta" - config = { - path = "random/path" - object_name = "terraform.tfstate" - } -} -``` - -## Configuration variables - -The following configuration options are supported: - - * `account` - (Required) This is the name of the Manta account. It can also be provided via the `SDC_ACCOUNT` or `TRITON_ACCOUNT` environment variables. - * `user` - (Optional) The username of the Triton account used to authenticate with the Triton API. It can also be provided via the `SDC_USER` or `TRITON_USER` environment variables. - * `url` - (Optional) The Manta API Endpoint. It can also be provided via the `MANTA_URL` environment variable. Defaults to `https://us-east.manta.joyent.com`. - * `key_material` - (Optional) This is the private key of an SSH key associated with the Triton account to be used. If this is not set, the private key corresponding to the fingerprint in key_id must be available via an SSH Agent. Can be set via the `SDC_KEY_MATERIAL` or `TRITON_KEY_MATERIAL` environment variables. - * `key_id` - (Required) This is the fingerprint of the public key matching the key specified in key_path. It can be obtained via the command ssh-keygen -l -E md5 -f /path/to/key. Can be set via the `SDC_KEY_ID` or `TRITON_KEY_ID` environment variables. - * `insecure_skip_tls_verify` - (Optional) This allows skipping TLS verification of the Triton endpoint. It is useful when connecting to a temporary Triton installation such as Cloud-On-A-Laptop which does not generally use a certificate signed by a trusted root CA. Defaults to `false`. - * `path` - (Required) The path relative to your private storage directory (`/$MANTA_USER/stor`) where the state file will be stored. **Please Note:** If this path does not exist, then the backend will create this folder location as part of backend creation. - * `object_name` - (Optional) The name of the state file (defaults to `terraform.tfstate`) diff --git a/website/docs/language/settings/backends/manta.mdx b/website/docs/language/settings/backends/manta.mdx new file mode 100644 index 000000000000..b3d49c7920e1 --- /dev/null +++ b/website/docs/language/settings/backends/manta.mdx @@ -0,0 +1,49 @@ +--- +page_title: 'Backend Type: manta' +description: Terraform can store state in manta. +--- + +# manta + +Stores the state as an artifact in [Manta](https://www.joyent.com/manta). + +This backend supports [state locking](/language/state/locking), with locking within Manta. + +## Example Configuration + +```hcl +terraform { + backend "manta" { + path = "random/path" + object_name = "terraform.tfstate" + } +} +``` + +Note that for the access credentials we recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration). + +## Data Source Configuration + +```hcl +data "terraform_remote_state" "foo" { + backend = "manta" + config = { + path = "random/path" + object_name = "terraform.tfstate" + } +} +``` + +## Configuration variables + +The following configuration options are supported: + +- `account` - (Required) This is the name of the Manta account. It can also be provided via the `SDC_ACCOUNT` or `TRITON_ACCOUNT` environment variables. +- `user` - (Optional) The username of the Triton account used to authenticate with the Triton API. It can also be provided via the `SDC_USER` or `TRITON_USER` environment variables. +- `url` - (Optional) The Manta API Endpoint. It can also be provided via the `MANTA_URL` environment variable. Defaults to `https://us-east.manta.joyent.com`. +- `key_material` - (Optional) This is the private key of an SSH key associated with the Triton account to be used. If this is not set, the private key corresponding to the fingerprint in key_id must be available via an SSH Agent. Can be set via the `SDC_KEY_MATERIAL` or `TRITON_KEY_MATERIAL` environment variables. +- `key_id` - (Required) This is the fingerprint of the public key matching the key specified in key_path. It can be obtained via the command ssh-keygen -l -E md5 -f /path/to/key. Can be set via the `SDC_KEY_ID` or `TRITON_KEY_ID` environment variables. +- `insecure_skip_tls_verify` - (Optional) This allows skipping TLS verification of the Triton endpoint. It is useful when connecting to a temporary Triton installation such as Cloud-On-A-Laptop which does not generally use a certificate signed by a trusted root CA. Defaults to `false`. +- `path` - (Required) The path relative to your private storage directory (`/$MANTA_USER/stor`) where the state file will be stored. **Please Note:** If this path does not exist, then the backend will create this folder location as part of backend creation. +- `object_name` - (Optional) The name of the state file (defaults to `terraform.tfstate`) diff --git a/website/docs/language/settings/backends/oss.html.md b/website/docs/language/settings/backends/oss.mdx similarity index 90% rename from website/docs/language/settings/backends/oss.html.md rename to website/docs/language/settings/backends/oss.mdx index a67ac94fff57..85dd38009110 100644 --- a/website/docs/language/settings/backends/oss.html.md +++ b/website/docs/language/settings/backends/oss.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: oss" -sidebar_current: "docs-backends-types-standard-oss" -description: |- - Terraform can store state remotely in OSS and lock that state with OSS. +page_title: 'Backend Type: oss' +description: Terraform can store state remotely in OSS and lock that state with OSS. --- # OSS @@ -14,7 +11,7 @@ This backend also supports state locking and consistency checking via [Alibaba Cloud Table Store](https://www.alibabacloud.com/help/doc-detail/27280.htm), which can be enabled by setting the `tablestore_table` field to an existing TableStore table name. -This backend supports [state locking](/docs/language/state/locking.html) via TableStore. +This backend supports [state locking](/language/state/locking) via TableStore. -> **Note:** The OSS backend is available from terraform version 0.12.2. @@ -38,12 +35,11 @@ a [OTS Instance](https://registry.terraform.io/providers/aliyun/alicloud/latest/ a [OTS TableStore](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/ots_table) called `statelock`. The Terraform state will be written into the file `path/mystate/version-1.tfstate`. The `TableStore` must have a primary key named `LockID` of type `String`. - ## Data Source Configuration To make use of the OSS remote state in another configuration, use the [`terraform_remote_state` data -source](/docs/language/state/remote-state-data.html). +source](/language/state/remote-state-data). ```hcl terraform { @@ -78,29 +74,48 @@ data "terraform_remote_state" "network" { The following configuration options or environment variables are supported: * `access_key` - (Optional) Alibaba Cloud access key. It supports environment variables `ALICLOUD_ACCESS_KEY` and `ALICLOUD_ACCESS_KEY_ID`. + * `secret_key` - (Optional) Alibaba Cloud secret access key. It supports environment variables `ALICLOUD_SECRET_KEY` and `ALICLOUD_ACCESS_KEY_SECRET`. + * `security_token` - (Optional) STS access token. It supports environment variable `ALICLOUD_SECURITY_TOKEN`. + * `ecs_role_name` - (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. + * `region` - (Optional) The region of the OSS bucket. It supports environment variables `ALICLOUD_REGION` and `ALICLOUD_DEFAULT_REGION`. + * `endpoint` - (Optional) A custom endpoint for the OSS API. It supports environment variables `ALICLOUD_OSS_ENDPOINT` and `OSS_ENDPOINT`. + * `bucket` - (Required) The name of the OSS bucket. + * `prefix` - (Opeional) The path directory of the state file will be stored. Default to "env:". + * `key` - (Optional) The name of the state file. Defaults to `terraform.tfstate`. + * `tablestore_endpoint` / `ALICLOUD_TABLESTORE_ENDPOINT` - (Optional) A custom endpoint for the TableStore API. + * `tablestore_table` - (Optional) A TableStore table for state locking and consistency. The table must have a primary key named `LockID` of type `String`. + * `sts_endpoint` - (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable `ALICLOUD_STS_ENDPOINT`. + * `encrypt` - (Optional) Whether to enable server side encryption of the state file. If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file. + * `acl` - (Optional) [Object ACL](https://www.alibabacloud.com/help/doc-detail/52284.htm) to be applied to the state file. + * `shared_credentials_file` - (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the `ALICLOUD_SHARED_CREDENTIALS_FILE` environment variable. If this is not set and a profile is specified, `~/.aliyun/config.json` will be used. + * `profile` - (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the `ALICLOUD_PROFILE` environment variable. + * `assume_role_role_arn` - (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable `ALICLOUD_ASSUME_ROLE_ARN`. Terraform executes configuration on account with provided credentials. + * `assume_role_policy` - (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. + * `assume_role_session_name` - (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. -* `assume_role_session_expiration` - (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. + +* `assume_role_session_expiration` - (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. * `assume_role` - (**Deprecated as of 1.1.0+**, Available in 0.12.6+) If provided with a role ARN, will attempt to assume this role using the supplied credentials. It will be ignored when `assume_role_role_arn` is specified. @@ -113,6 +128,6 @@ The following configuration options or environment variables are supported: * `session_name` - (Optional) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_NAME`. - * `session_expiration` - (Optional) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. + * `session_expiration` - (Optional) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable `ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION`. -> **Note:** If you want to store state in the custom OSS endpoint, you can specify an environment variable `OSS_ENDPOINT`, like "oss-cn-beijing-internal.aliyuncs.com" diff --git a/website/docs/language/settings/backends/pg.html.md b/website/docs/language/settings/backends/pg.html.md deleted file mode 100644 index 509f33c8ef30..000000000000 --- a/website/docs/language/settings/backends/pg.html.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -layout: "language" -page_title: "Backend Type: pg" -sidebar_current: "docs-backends-types-standard-pg" -description: |- - Terraform can store state remotely in a Postgres database with locking. ---- - -# pg - -Stores the state in a [Postgres database](https://www.postgresql.org) version 10 or newer. - -This backend supports [state locking](/docs/language/state/locking.html). - -## Example Configuration - -```hcl -terraform { - backend "pg" { - conn_str = "postgres://user:pass@db.example.com/terraform_backend" - } -} -``` - -Before initializing the backend with `terraform init`, the database must already exist: - -``` -createdb terraform_backend -``` - -This `createdb` command is found in [Postgres client applications](https://www.postgresql.org/docs/10/reference-client.html) which are installed along with the database server. - -We recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration) -for the `conn_str` variable, because it typically contains access credentials that should not be committed to source control: - -```hcl -terraform { - backend "pg" {} -} -``` - -Then, set the credentials when initializing the configuration: - -``` -terraform init -backend-config="conn_str=postgres://user:pass@db.example.com/terraform_backend" -``` - -To use a Postgres server running on the same machine as Terraform, configure localhost with SSL disabled: - -``` -terraform init -backend-config="conn_str=postgres://localhost/terraform_backend?sslmode=disable" -``` - -## Data Source Configuration - -To make use of the pg remote state in another configuration, use the [`terraform_remote_state` data source](/docs/language/state/remote-state-data.html). - -```hcl -data "terraform_remote_state" "network" { - backend = "pg" - config = { - conn_str = "postgres://localhost/terraform_backend" - } -} -``` - -## Configuration Variables - -The following configuration options or environment variables are supported: - - * `conn_str` - (Required) Postgres connection string; a `postgres://` URL - * `schema_name` - Name of the automatically-managed Postgres schema, default `terraform_remote_state`. - * `skip_schema_creation` - If set to `true`, the Postgres schema must already exist. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator. - * `skip_table_creation` - If set to `true`, the Postgres table must already exist. Terraform won't try to create the table, this is useful when it has already been created by a database administrator. - * `skip_index_creation` - If set to `true`, the Postgres index must already exist. Terraform won't try to create the index, this is useful when it has already been created by a database administrator. - -## Technical Design - -This backend creates one table **states** in the automatically-managed Postgres schema configured by the `schema_name` variable. - -The table is keyed by the [workspace](/docs/language/state/workspaces.html) name. If workspaces are not in use, the name `default` is used. - -Locking is supported using [Postgres advisory locks](https://www.postgresql.org/docs/9.5/explicit-locking.html#ADVISORY-LOCKS). [`force-unlock`](https://www.terraform.io/docs/cli/commands/force-unlock.html) is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the [`pg_locks` system view](https://www.postgresql.org/docs/9.5/view-pg-locks.html). - -The **states** table contains: - - * a serial integer `id`, used as the key for advisory locks - * the workspace `name` key as *text* with a unique index - * the Terraform state `data` as *text* diff --git a/website/docs/language/settings/backends/pg.mdx b/website/docs/language/settings/backends/pg.mdx new file mode 100644 index 000000000000..fae9c856175a --- /dev/null +++ b/website/docs/language/settings/backends/pg.mdx @@ -0,0 +1,87 @@ +--- +page_title: 'Backend Type: pg' +description: Terraform can store state remotely in a Postgres database with locking. +--- + +# pg + +Stores the state in a [Postgres database](https://www.postgresql.org) version 10 or newer. + +This backend supports [state locking](/language/state/locking). + +## Example Configuration + +```hcl +terraform { + backend "pg" { + conn_str = "postgres://user:pass@db.example.com/terraform_backend" + } +} +``` + +Before initializing the backend with `terraform init`, the database must already exist: + +``` +createdb terraform_backend +``` + +This `createdb` command is found in [Postgres client applications](https://www.postgresql.org/docs/10/reference-client.html) which are installed along with the database server. + +We recommend using a +[partial configuration](/language/settings/backends/configuration#partial-configuration) +for the `conn_str` variable, because it typically contains access credentials that should not be committed to source control: + +```hcl +terraform { + backend "pg" {} +} +``` + +Then, set the credentials when initializing the configuration: + +``` +terraform init -backend-config="conn_str=postgres://user:pass@db.example.com/terraform_backend" +``` + +To use a Postgres server running on the same machine as Terraform, configure localhost with SSL disabled: + +``` +terraform init -backend-config="conn_str=postgres://localhost/terraform_backend?sslmode=disable" +``` + +## Data Source Configuration + +To make use of the pg remote state in another configuration, use the [`terraform_remote_state` data source](/language/state/remote-state-data). + +```hcl +data "terraform_remote_state" "network" { + backend = "pg" + config = { + conn_str = "postgres://localhost/terraform_backend" + } +} +``` + +## Configuration Variables + +The following configuration options or environment variables are supported: + +- `conn_str` - (Required) Postgres connection string; a `postgres://` URL +- `schema_name` - Name of the automatically-managed Postgres schema, default `terraform_remote_state`. +- `skip_schema_creation` - If set to `true`, the Postgres schema must already exist. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator. +- `skip_table_creation` - If set to `true`, the Postgres table must already exist. Terraform won't try to create the table, this is useful when it has already been created by a database administrator. +- `skip_index_creation` - If set to `true`, the Postgres index must already exist. Terraform won't try to create the index, this is useful when it has already been created by a database administrator. + +## Technical Design + +This backend creates one table **states** in the automatically-managed Postgres schema configured by the `schema_name` variable. + +The table is keyed by the [workspace](/language/state/workspaces) name. If workspaces are not in use, the name `default` is used. + +Locking is supported using [Postgres advisory locks](https://www.postgresql.org/docs/9.5/explicit-locking.html#ADVISORY-LOCKS). [`force-unlock`](/cli/commands/force-unlock) is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the [`pg_locks` system view](https://www.postgresql.org/docs/9.5/view-pg-locks.html). + +The **states** table contains: + +- a serial integer `id`, used as the key for advisory locks +- the workspace `name` key as _text_ with a unique index +- the Terraform state `data` as _text_ diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.mdx similarity index 75% rename from website/docs/language/settings/backends/remote.html.md rename to website/docs/language/settings/backends/remote.mdx index dfe8df5a3712..e67c90e27b6d 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.mdx @@ -1,19 +1,15 @@ --- -layout: "language" -page_title: "Backend Type: remote" -sidebar_current: "docs-backends-types-enhanced-remote" -description: |- - Terraform can store the state and run operations remotely, making it easier to version and work with in a team. +page_title: 'Backend Type: remote' +description: >- + Terraform can store the state and run operations remotely, making it easier to + version and work with in a team. --- # remote --> **Note:** The remote backend was introduced in Terraform v0.11.13 and Terraform Enterprise v201809-1. As of Terraform v1.1.0 and Terraform Enterprise v202201-1, **we recommend using the Terraform Cloud's built-in [`cloud` integration](/docs/language/settings/terraform-cloud.html)** instead of this backend. The `cloud` option includes an improved user experience and more features. - - -The remote backend is unique among all other Terraform backends because it can both store state snapshots and execute operations for Terraform Cloud's [CLI-driven run workflow](/docs/cloud/run/cli.html). It used to be called an "enhanced" backend. - +-> **Note:** The remote backend was introduced in Terraform v0.11.13 and Terraform Enterprise v201809-1. As of Terraform v1.1.0 and Terraform Enterprise v202201-1, **we recommend using the Terraform Cloud's built-in [`cloud` integration](/language/settings/terraform-cloud)** instead of this backend. The `cloud` option includes an improved user experience and more features. +The remote backend is unique among all other Terraform backends because it can both store state snapshots and execute operations for Terraform Cloud's [CLI-driven run workflow](/cloud-docs/run/cli). It used to be called an "enhanced" backend. When using full remote operations, operations like `terraform plan` or `terraform apply` can be executed in Terraform Cloud's run environment, with log output streaming to the local terminal. Remote plans and applies use variable values from the associated Terraform Cloud workspace. @@ -57,7 +53,7 @@ determines which mode it uses: all of the desired remote workspace names. For example, set `prefix = "networking-"` to use Terraform cloud workspaces with names like `networking-dev` and `networking-prod`. This is helpful when - mapping multiple Terraform CLI [workspaces](/docs/language/state/workspaces.html) + mapping multiple Terraform CLI [workspaces](/language/state/workspaces) used in a single Terraform configuration to multiple Terraform Cloud workspaces. @@ -68,7 +64,7 @@ the Terraform CLI workspace `prod` within the current configuration. Remote Terraform operations such as `plan` and `apply` executed against that Terraform CLI workspace will be executed in the Terraform Cloud workspace `networking-prod`. -Additionally, the [`terraform.workspace`](/docs/language/state/workspaces.html#current-workspace-interpolation) +Additionally, the [`terraform.workspace`](/language/state/workspaces#current-workspace-interpolation) expression shouldn't be used in Terraform configurations that use Terraform 1.0.x or earlier and run remote operations against Terraform Cloud workspaces. The reason for this is that prior to Terraform 1.1.0, Terraform Cloud workspaces only used the single `default` Terraform @@ -92,8 +88,8 @@ running any remote operations against them. ## Example Configurations -> **Note:** We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/cli/commands/login.html) or manually configuring - `credentials` in the [CLI config file](/docs/cli/config/config-file.html#credentials). +[`terraform login`](/cli/commands/login) or manually configuring +`credentials` in the [CLI config file](/cli/config/config-file#credentials). ### Basic Configuration @@ -169,21 +165,21 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: -* `hostname` - (Optional) The remote backend hostname to connect to. Defaults +- `hostname` - (Optional) The remote backend hostname to connect to. Defaults to app.terraform.io. -* `organization` - (Required) The name of the organization containing the +- `organization` - (Required) The name of the organization containing the targeted workspace(s). -* `token` - (Optional) The token used to authenticate with the remote backend. +- `token` - (Optional) The token used to authenticate with the remote backend. We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/cli/commands/login.html) or manually configuring + [`terraform login`](/cli/commands/login) or manually configuring `credentials` in the - [CLI config file](/docs/cli/config/config-file.html#credentials). -* `workspaces` - (Required) A block specifying which remote workspace(s) to use. + [CLI config file](/cli/config/config-file#credentials). +- `workspaces` - (Required) A block specifying which remote workspace(s) to use. The `workspaces` block supports the following keys: - * `name` - (Optional) The full name of one remote workspace. When configured, + - `name` - (Optional) The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with `prefix`. - * `prefix` - (Optional) A prefix used in the names of one or more remote + - `prefix` - (Optional) A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in Terraform Cloud, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. @@ -199,38 +195,37 @@ For configurations that include a `backend "remote"` block, commands that make local modifications to Terraform state and then push them back up to the remote workspace accept the following option to modify that behavior: -* `-ignore-remote-version` - Override checking that the local and remote +- `-ignore-remote-version` - Override checking that the local and remote Terraform versions agree, making an operation proceed even when there is a mismatch. - Normally state-modification operations require using a local version of - Terraform CLI which is compatible with the Terraform version selected - for the remote workspace as part of its settings. This is to avoid the - local operation creating a new state snapshot which the workspace's - remote execution environment would then be unable to decode. + Normally state-modification operations require using a local version of + Terraform CLI which is compatible with the Terraform version selected + for the remote workspace as part of its settings. This is to avoid the + local operation creating a new state snapshot which the workspace's + remote execution environment would then be unable to decode. - Overriding this check can result in a Terraform Cloud workspace that is - no longer able to complete remote operations, so we recommend against - using this option. + Overriding this check can result in a Terraform Cloud workspace that is + no longer able to complete remote operations, so we recommend against + using this option. ## Excluding Files from Upload with .terraformignore -> **Version note:** `.terraformignore` support was added in Terraform 0.12.11. -When executing a remote `plan` or `apply` in a [CLI-driven run](/docs/cloud/run/cli.html), +When executing a remote `plan` or `apply` in a [CLI-driven run](/cloud-docs/run/cli), an archive of your configuration directory is uploaded to Terraform Cloud. You can define paths to ignore from upload via a `.terraformignore` file at the root of your configuration directory. If this file is not present, the archive will exclude the following by default: -* `.git/` directories -* `.terraform/` directories (exclusive of `.terraform/modules`) +- `.git/` directories +- `.terraform/` directories (exclusive of `.terraform/modules`) The `.terraformignore` file can include rules as one would include in a [`.gitignore` file](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) - -* Comments (starting with `#`) or blank lines are ignored -* End a pattern with a forward slash `/` to specify a directory -* Negate a pattern by starting it with an exclamation point `!` +- Comments (starting with `#`) or blank lines are ignored +- End a pattern with a forward slash `/` to specify a directory +- Negate a pattern by starting it with an exclamation point `!` Note that unlike `.gitignore`, only the `.terraformignore` at the root of the configuration directory is considered. diff --git a/website/docs/language/settings/backends/s3.html.md b/website/docs/language/settings/backends/s3.mdx similarity index 96% rename from website/docs/language/settings/backends/s3.html.md rename to website/docs/language/settings/backends/s3.mdx index f8d6b449a9b2..a338a42e1a2f 100644 --- a/website/docs/language/settings/backends/s3.html.md +++ b/website/docs/language/settings/backends/s3.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Backend Type: s3" -sidebar_current: "docs-backends-types-standard-s3" -description: |- - Terraform can store state remotely in S3 and lock that state with DynamoDB. +page_title: 'Backend Type: s3' +description: Terraform can store state remotely in S3 and lock that state with DynamoDB. --- # S3 @@ -35,7 +32,7 @@ This assumes we have a bucket created called `mybucket`. The Terraform state is written to the key `path/to/my/key`. Note that for the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). +[partial configuration](/language/settings/backends/configuration#partial-configuration). ### S3 Bucket Permissions @@ -106,7 +103,7 @@ This is seen in the following AWS IAM Statement: To make use of the S3 remote state in another configuration, use the [`terraform_remote_state` data -source](/docs/language/state/remote-state-data.html). +source](/language/state/remote-state-data). ```hcl data "terraform_remote_state" "network" { @@ -181,7 +178,7 @@ The following configuration is optional: The following configuration is required: * `bucket` - (Required) Name of the S3 Bucket. -* `key` - (Required) Path to the state file inside the S3 Bucket. When using a non-default [workspace](/docs/language/state/workspaces.html), the state path will be `/workspace_key_prefix/workspace_name/key` (see also the `workspace_key_prefix` configuration). +* `key` - (Required) Path to the state file inside the S3 Bucket. When using a non-default [workspace](/language/state/workspaces), the state path will be `/workspace_key_prefix/workspace_name/key` (see also the `workspace_key_prefix` configuration). The following configuration is optional: @@ -213,7 +210,7 @@ The S3 backend can be used in a number of different ways that make different tradeoffs between convenience, security, and isolation in such an organization. This section describes one such approach that aims to find a good compromise between these tradeoffs, allowing use of -[Terraform's workspaces feature](/docs/language/state/workspaces.html) to switch +[Terraform's workspaces feature](/language/state/workspaces) to switch conveniently between multiple isolated deployments of the same configuration. Use this section as a starting-point for your approach, but note that @@ -321,7 +318,7 @@ provider "aws" { If workspace IAM roles are centrally managed and shared across many separate Terraform configurations, the role ARNs could also be obtained via a data -source such as [`terraform_remote_state`](/docs/language/state/remote-state-data.html) +source such as [`terraform_remote_state`](/language/state/remote-state-data) to avoid repeating these values. ### Creating and Selecting Workspaces diff --git a/website/docs/language/settings/backends/swift.html.md b/website/docs/language/settings/backends/swift.mdx similarity index 91% rename from website/docs/language/settings/backends/swift.html.md rename to website/docs/language/settings/backends/swift.mdx index b53d83087e7b..0f34832802ec 100644 --- a/website/docs/language/settings/backends/swift.html.md +++ b/website/docs/language/settings/backends/swift.mdx @@ -1,18 +1,15 @@ --- -layout: "language" -page_title: "Backend Type: swift" -sidebar_current: "docs-backends-types-standard-swift" -description: |- - Terraform can store state remotely in Swift. +page_title: 'Backend Type: swift' +description: Terraform can store state remotely in Swift. --- # swift Stores the state as an artifact in [Swift](http://docs.openstack.org/developer/swift/latest/). -This backend supports [state locking](/docs/language/state/locking.html). +This backend supports [state locking](/language/state/locking). -~> Warning! It is highly recommended that you enable [Object Versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) by setting the [`archive_container`](https://www.terraform.io/docs/language/settings/backends/swift.html#archive_container) configuration. This allows for state recovery in the case of accidental deletions and human error. +~> Warning! It is highly recommended that you enable [Object Versioning](https://docs.openstack.org/developer/swift/latest/overview_object_versioning.html) by setting the [`archive_container`](/language/settings/backends/swift#archive_container) configuration. This allows for state recovery in the case of accidental deletions and human error. ## Example Configuration @@ -24,10 +21,11 @@ terraform { } } ``` + This will create a container called `terraform-state` and an object within that container called `tfstate.tf`. It will enable versioning using the `terraform-state-archive` container to contain the older version. For the access credentials we recommend using a -[partial configuration](/docs/language/settings/backends/configuration.html#partial-configuration). +[partial configuration](/language/settings/backends/configuration#partial-configuration). ## Data Source Configuration @@ -46,7 +44,7 @@ data "terraform_remote_state" "foo" { The following configuration options are supported: * `auth_url` - (Optional) The Identity authentication URL. If omitted, the - `OS_AUTH_URL` environment variable is used. + `OS_AUTH_URL` environment variable is used. * `cloud` - (Optional; required if `auth_url` is not specified) An entry in a `clouds.yaml` file. See the OpenStack `os-client-config` @@ -55,7 +53,7 @@ The following configuration options are supported: environment variable is used. * `region_name` - (Optional) - The region in which to store `terraform.tfstate`. If - omitted, the `OS_REGION_NAME` environment variable is used. + omitted, the `OS_REGION_NAME` environment variable is used. * `container` - (Required) The name of the container to create for storing the Terraform state file. @@ -137,10 +135,10 @@ The following configuration options are supported: certificate. If omitted, the `OS_CACERT` environment variable is used. * `cert` - (Optional) Specify client certificate file for SSL client authentication. - If omitted the `OS_CERT` environment variable is used. + If omitted the `OS_CERT` environment variable is used. * `key` - (Optional) Specify client private key file for SSL client authentication. - If omitted the `OS_KEY` environment variable is used. + If omitted the `OS_KEY` environment variable is used. * `endpoint_type` - (Optional) Specify which type of endpoint to use from the service catalog. It can be set using the OS_ENDPOINT_TYPE environment diff --git a/website/docs/language/settings/index.html.md b/website/docs/language/settings/index.mdx similarity index 78% rename from website/docs/language/settings/index.html.md rename to website/docs/language/settings/index.mdx index cec07d2938d5..213e01f1a2ce 100644 --- a/website/docs/language/settings/index.html.md +++ b/website/docs/language/settings/index.mdx @@ -1,8 +1,9 @@ --- -layout: "language" -page_title: "Terraform Settings - Configuration Language" -sidebar_current: "docs-config-terraform" -description: "The terraform block allows you to configure Terraform behavior, including the Terraform version, backend, integration with Terraform Cloud, and required providers." +page_title: Terraform Settings - Configuration Language +description: >- + The terraform block allows you to configure Terraform behavior, including the + Terraform version, backend, integration with Terraform Cloud, and required + providers. --- # Terraform Settings @@ -32,32 +33,32 @@ following sections. ## Configuring Terraform Cloud The nested `cloud` block configures Terraform Cloud for enabling its -[CLI-driven run workflow](/docs/cloud/run/cli.html). +[CLI-driven run workflow](/cloud-docs/run/cli). -- Refer to [Terraform Cloud Configuration](/docs/language/settings/terraform-cloud.html) for a summary of the `cloud` block's syntax. +- Refer to [Terraform Cloud Configuration](/language/settings/terraform-cloud) for a summary of the `cloud` block's syntax. -- Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) in the -Terraform CLI documentation for complete details about how to initialize and configure the Terraform Cloud CLI integration. +- Refer to [Using Terraform Cloud](/cli/cloud) in the + Terraform CLI documentation for complete details about how to initialize and configure the Terraform Cloud CLI integration. ## Configuring a Terraform Backend The nested `backend` block configures which state backend Terraform should use. The syntax and behavior of the `backend` block is described in [Backend -Configuration](/docs/language/settings/backends/configuration.html). +Configuration](/language/settings/backends/configuration). ## Specifying a Required Terraform Version > **Hands-on:** Try the [Manage Terraform Versions](https://learn.hashicorp.com/tutorials/terraform/versions?in=terraform/configuration-language) or [Manage Terraform Versions in Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-versions?in=terraform/cloud) tutorials on HashiCorp Learn. The `required_version` setting accepts a [version constraint -string,](/docs/language/expressions/version-constraints.html) which specifies which versions of Terraform +string,](/language/expressions/version-constraints) which specifies which versions of Terraform can be used with your configuration. If the running version of Terraform doesn't match the constraints specified, Terraform will produce an error and exit without taking any further actions. -When you use [child modules](/docs/language/modules/index.html), each module can specify its own +When you use [child modules](/language/modules), each module can specify its own version requirements. The requirements of all modules in the tree must be satisfied. @@ -68,7 +69,7 @@ a minimum Terraform version that has behavior expected by the configuration. The `required_version` setting applies only to the version of Terraform CLI. Terraform's resource types are implemented by provider plugins, whose release cycles are independent of Terraform CLI and of each other. -Use [the `required_providers` block](/docs/language/providers/requirements.html) to manage +Use [the `required_providers` block](/language/providers/requirements) to manage the expected versions for each provider you use. ## Specifying Provider Requirements @@ -90,7 +91,7 @@ terraform { } ``` -For more information, see [Provider Requirements](/docs/language/providers/requirements.html). +For more information, see [Provider Requirements](/language/providers/requirements). ## Experimental Language Features @@ -135,4 +136,4 @@ provider a module is using, if the provider defines a schema for it. This allows the provider to receive module-specific information, and is primarily intended for modules distributed by the same vendor as the associated provider. -For more information, see [Provider Metadata](/docs/internals/provider-meta.html). +For more information, see [Provider Metadata](/internals/provider-meta). diff --git a/website/docs/language/settings/terraform-cloud.html.md b/website/docs/language/settings/terraform-cloud.html.md deleted file mode 100644 index fd1b94b713fe..000000000000 --- a/website/docs/language/settings/terraform-cloud.html.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: "language" -page_title: "Terraform Cloud Configuration - Terraform Settings - Configuration Language" -sidebar_current: "docs-config-terraform" -description: "The nested `cloud` block configures Terraform's integration with Terraform Cloud." ---- - -# Terraform Cloud Configuration - -The main module of a Terraform configuration can integrate with Terraform Cloud to enable its -[CLI-driven run workflow](/docs/cloud/run/cli.html). You only need to configure these settings when you want to use Terraform CLI to interact with Terraform Cloud. Terraform Cloud ignores them when interacting with -Terraform through version control or the API. - -> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. - -You can configure the Terraform Cloud CLI integration by adding a nested `cloud` block within the top-level -`terraform` block: - -```hcl -terraform { - cloud { - organization = "example_corp" - - workspaces { - tags = ["app"] - } - } -} -``` - -You cannot use the CLI integration and a [state backend](/docs/language/settings/backends/index.html) in the same configuration; they are mutually exclusive. A configuration can only provide one `cloud` block and the `cloud` block cannot refer to named values like input variables, locals, or data source attributes. - -Refer to [Using Terraform Cloud](/docs/cli/cloud/index.html) in the Terraform CLI docs for more information. diff --git a/website/docs/language/settings/terraform-cloud.mdx b/website/docs/language/settings/terraform-cloud.mdx new file mode 100644 index 000000000000..e764547725f8 --- /dev/null +++ b/website/docs/language/settings/terraform-cloud.mdx @@ -0,0 +1,33 @@ +--- +page_title: Terraform Cloud Configuration - Terraform Settings - Configuration Language +description: >- + The nested `cloud` block configures Terraform's integration with Terraform + Cloud. +--- + +# Terraform Cloud Configuration + +The main module of a Terraform configuration can integrate with Terraform Cloud to enable its +[CLI-driven run workflow](/cloud-docs/run/cli). You only need to configure these settings when you want to use Terraform CLI to interact with Terraform Cloud. Terraform Cloud ignores them when interacting with +Terraform through version control or the API. + +> **Hands On:** Try the [Migrate State to Terraform Cloud](https://learn.hashicorp.com/tutorials/terraform/cloud-migrate) tutorial on HashiCorp Learn. + +You can configure the Terraform Cloud CLI integration by adding a nested `cloud` block within the top-level +`terraform` block: + +```hcl +terraform { + cloud { + organization = "example_corp" + + workspaces { + tags = ["app"] + } + } +} +``` + +You cannot use the CLI integration and a [state backend](/language/settings/backends) in the same configuration; they are mutually exclusive. A configuration can only provide one `cloud` block and the `cloud` block cannot refer to named values like input variables, locals, or data source attributes. + +Refer to [Using Terraform Cloud](/cli/cloud) in the Terraform CLI docs for more information. diff --git a/website/docs/language/state/backends.html.md b/website/docs/language/state/backends.mdx similarity index 69% rename from website/docs/language/state/backends.html.md rename to website/docs/language/state/backends.mdx index da957173d725..03a11958424f 100644 --- a/website/docs/language/state/backends.html.md +++ b/website/docs/language/state/backends.mdx @@ -1,15 +1,14 @@ --- -layout: "language" -page_title: "Backends: State Storage and Locking" -sidebar_current: "docs-backends-state" -description: |- - Backends are configured directly in Terraform files in the `terraform` section. +page_title: 'Backends: State Storage and Locking' +description: >- + Backends are configured directly in Terraform files in the `terraform` + section. --- # State Storage and Locking Backends are responsible for storing state and providing an API for -[state locking](/docs/language/state/locking.html). State locking is optional. +[state locking](/language/state/locking). State locking is optional. Despite the state being stored remotely, all Terraform commands such as `terraform console`, the `terraform state` operations, `terraform taint`, @@ -47,15 +46,15 @@ overwrite the remote state. This can be used to do manual fixups if necessary. When manually pushing state, Terraform will attempt to protect you from some potentially dangerous situations: - * **Differing lineage**: The "lineage" is a unique ID assigned to a state - when it is created. If a lineage is different, then it means the states - were created at different times and its very likely you're modifying a - different state. Terraform will not allow this. +- **Differing lineage**: The "lineage" is a unique ID assigned to a state + when it is created. If a lineage is different, then it means the states + were created at different times and its very likely you're modifying a + different state. Terraform will not allow this. - * **Higher serial**: Every state has a monotonically increasing "serial" - number. If the destination state has a higher serial, Terraform will - not allow you to write it since it means that changes have occurred since - the state you're attempting to write. +- **Higher serial**: Every state has a monotonically increasing "serial" + number. If the destination state has a higher serial, Terraform will + not allow you to write it since it means that changes have occurred since + the state you're attempting to write. Both of these protections can be bypassed with the `-force` flag if you're confident you're making the right decision. Even if using the `-force` flag, @@ -64,12 +63,12 @@ prior to forcing the overwrite. ## State Locking -Backends are responsible for supporting [state locking](/docs/language/state/locking.html) +Backends are responsible for supporting [state locking](/language/state/locking) if possible. Not all backends support locking. The -[documentation for each backend](/docs/language/settings/backends/index.html) +[documentation for each backend](/language/settings/backends) includes details on whether it supports locking or not. For more information on state locking, view the -[page dedicated to state locking](/docs/language/state/locking.html). +[page dedicated to state locking](/language/state/locking). diff --git a/website/docs/language/state/import.html.md b/website/docs/language/state/import.mdx similarity index 59% rename from website/docs/language/state/import.html.md rename to website/docs/language/state/import.mdx index 1334269e92e9..bbbf92d039a0 100644 --- a/website/docs/language/state/import.html.md +++ b/website/docs/language/state/import.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "State: Import Existing Resources" -sidebar_current: "docs-state-import" -description: |- - Terraform stores state which caches the known state of the world the last time Terraform ran. +page_title: 'State: Import Existing Resources' +description: >- + Terraform stores state which caches the known state of the world the last time + Terraform ran. --- # Import Existing Resources @@ -12,4 +11,4 @@ Terraform is able to import existing infrastructure. This allows you take resources you've created by some other means and bring it under Terraform management. To learn more about this, please visit the -[pages dedicated to import](/docs/cli/import/index.html). +[pages dedicated to import](/cli/import). diff --git a/website/docs/language/state/index.html.md b/website/docs/language/state/index.mdx similarity index 77% rename from website/docs/language/state/index.html.md rename to website/docs/language/state/index.mdx index 67072eab237d..fea81b2cbe62 100644 --- a/website/docs/language/state/index.html.md +++ b/website/docs/language/state/index.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "State" -sidebar_current: "docs-state" -description: "An introduction to state, information that Terraform uses to map resources to a configuration, track metadata, and improve performance." +page_title: State +description: >- + An introduction to state, information that Terraform uses to map resources to + a configuration, track metadata, and improve performance. --- # State @@ -17,7 +17,7 @@ but it can also be stored remotely, which works better in a team environment. Terraform uses this local state to create plans and make changes to your infrastructure. Prior to any operation, Terraform does a -[refresh](/docs/cli/commands/refresh.html) to update the state with the +[refresh](/cli/commands/refresh) to update the state with the real infrastructure. The primary purpose of Terraform state is to store bindings between objects in @@ -28,13 +28,13 @@ resource instance, and then potentially update or delete that object in response to future configuration changes. For more information on why Terraform requires state and why Terraform cannot -function without state, please see the page [state purpose](/docs/language/state/purpose.html). +function without state, please see the page [state purpose](/language/state/purpose). ## Inspection and Modification While the format of the state files are just JSON, direct file editing of the state is discouraged. Terraform provides the -[terraform state](/docs/cli/commands/state/index.html) command to perform +[terraform state](/cli/commands/state) command to perform basic modifications of the state using the CLI. The CLI usage and output of the state commands is structured to be @@ -67,13 +67,13 @@ in new versions. Alternatively, there are several integration points which produce JSON output that is specifically intended for consumption by external software: -* [The `terraform output` command](/docs/cli/commands/output.html) -has a `-json` option, for obtaining either the full set of root module output -values or a specific named output value from the latest state snapshot. -* [The `terraform show` command](/docs/cli/commands/show.html) has a `-json` -option for inspecting the latest state snapshot in full, and also for -inspecting saved plan files which include a copy of the prior state at the -time the plan was made. +* [The `terraform output` command](/cli/commands/output) + has a `-json` option, for obtaining either the full set of root module output + values or a specific named output value from the latest state snapshot. +* [The `terraform show` command](/cli/commands/show) has a `-json` + option for inspecting the latest state snapshot in full, and also for + inspecting saved plan files which include a copy of the prior state at the + time the plan was made. A typical way to use these in situations where Terraform is running in automation is to run them immediately after a successful `terraform apply` diff --git a/website/docs/language/state/locking.html.md b/website/docs/language/state/locking.mdx similarity index 77% rename from website/docs/language/state/locking.html.md rename to website/docs/language/state/locking.mdx index 739a4b8c41d0..970c14f2fe4a 100644 --- a/website/docs/language/state/locking.html.md +++ b/website/docs/language/state/locking.mdx @@ -1,14 +1,13 @@ --- -layout: "language" -page_title: "State: Locking" -sidebar_current: "docs-state-locking" -description: |- - Terraform stores state which caches the known state of the world the last time Terraform ran. +page_title: 'State: Locking' +description: >- + Terraform stores state which caches the known state of the world the last time + Terraform ran. --- # State Locking -If supported by your [backend](/docs/language/settings/backends/index.html), Terraform will lock your +If supported by your [backend](/language/settings/backends), Terraform will lock your state for all operations that could write state. This prevents others from acquiring the lock and potentially corrupting your state. @@ -22,12 +21,12 @@ a status message. If Terraform doesn't output a message, state locking is still occurring if your backend supports it. Not all backends support locking. The -[documentation for each backend](/docs/language/settings/backends/index.html) +[documentation for each backend](/language/settings/backends) includes details on whether it supports locking or not. ## Force Unlock -Terraform has a [force-unlock command](/docs/cli/commands/force-unlock.html) +Terraform has a [force-unlock command](/cli/commands/force-unlock) to manually unlock the state if unlocking failed. **Be very careful with this command.** If you unlock the state when someone diff --git a/website/docs/language/state/purpose.html.md b/website/docs/language/state/purpose.mdx similarity index 93% rename from website/docs/language/state/purpose.html.md rename to website/docs/language/state/purpose.mdx index 44bfef6d1963..95e8f09d4fa3 100644 --- a/website/docs/language/state/purpose.html.md +++ b/website/docs/language/state/purpose.mdx @@ -1,9 +1,10 @@ --- -layout: "language" -page_title: "State" -sidebar_current: "docs-state-purpose" -description: |- - Terraform must store state about your managed infrastructure and configuration. This state is used by Terraform to map real world resources to your configuration, keep track of metadata, and to improve performance for large infrastructures. +page_title: State +description: >- + Terraform must store state about your managed infrastructure and + configuration. This state is used by Terraform to map real world resources to + your configuration, keep track of metadata, and to improve performance for + large infrastructures. --- # Purpose of Terraform State @@ -105,7 +106,7 @@ started, but when using Terraform in a team it is important for everyone to be working with the same state so that operations will be applied to the same remote objects. -[Remote state](/docs/language/state/remote.html) is the recommended solution +[Remote state](/language/state/remote) is the recommended solution to this problem. With a fully-featured state backend, Terraform can use remote locking as a measure to avoid two or more different users accidentally running Terraform at the same time, and thus ensure that each Terraform run diff --git a/website/docs/language/state/remote-state-data.html.md b/website/docs/language/state/remote-state-data.html.md deleted file mode 100644 index 10e51460068a..000000000000 --- a/website/docs/language/state/remote-state-data.html.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -layout: "language" -page_title: "The terraform_remote_state Data Source" -sidebar_current: "docs-terraform-datasource-remote-state" -description: |- - Retrieves the root module output values from a Terraform state snapshot stored in a remote backend. ---- - -# The `terraform_remote_state` Data Source - -[backends]: /docs/backends/index.html - -The `terraform_remote_state` data source retrieves the root module output values -from some other Terraform configuration, using the latest state snapshot from -the remote backend. - -This data source is built into Terraform, and is always available; you do not -need to require or configure a provider in order to use it. - --> **Note:** This data source is implemented by a built-in provider, whose -[source address](/docs/language/providers/requirements.html#source-addresses) -is `terraform.io/builtin/terraform`. That provider does not include any other -resources or data sources. - -## Alternative Ways to Share Data Between Configurations - -Sharing data with root module outputs is convenient, but it has drawbacks. -Although `terraform_remote_state` only exposes output values, its user must have -access to the entire state snapshot, which often includes some sensitive -information. - -When possible, we recommend explicitly publishing data for external consumption -to a separate location instead of accessing it via remote state. This lets you -apply different access controls for shared information and state snapshots. - -To share data explicitly between configurations, you can use pairs of managed -resource types and data sources in various providers, including (but not -limited to) the following: - -| System | Publish with... | Read with... | -|--|--|--| -| Alibaba Cloud DNS
      (for IP addresses and hostnames) | [`alicloud_alidns_record` resource type](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/alidns_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Amazon Route53
      (for IP addresses and hostnames) | [`aws_route53_record` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Amazon S3 | [`aws_s3_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) | [`aws_s3_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket_object) | -| Amazon SSM Parameter Store | [`aws_ssm_parameter` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | [`aws_ssm_parameter` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | -| Azure Automation | [`azurerm_automation_variable_string` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/automation_variable_string) | [`azurerm_automation_variable_string` data source](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/automation_variable_string) | -| Azure DNS
      (for IP addresses and hostnames) | [`azurerm_dns_a_record` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_a_record), etc | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Google Cloud DNS
      (for IP addresses and hostnames) | [`google_dns_record_set` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/dns_record_set) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | -| Google Cloud Storage | [`google_storage_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket_object) | [`google_storage_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/storage_bucket_object) and [`http` data source](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | -| HashiCorp Consul | [`consul_key_prefix` resource type](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/key_prefix) | [`consul_key_prefix` data source](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key_prefix) | -| HashiCorp Terraform Cloud | Normal `outputs` terraform block | [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) | -| Kubernetes | [`kubernetes_config_map` resource type](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | [`kubernetes_config_map` data source](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/config_map) | -| OCI Object Storage | [`oci_objectstorage_bucket` resource type](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/objectstorage_object) | [`oci_objectstorage_bucket` data source](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/objectstorage_object) | - --> These are some common options from the Official Terraform providers, but -there are too many configuration storage options for us to list them all -here, including some in partner and community providers. -Any pair of managed resource type and corresponding data source can potentially -be used to share data between Terraform configurations. See individual provider -documentation to find other possibilities. - -A key advantage of using a separate explicit configuration store instead of -`terraform_remote_state` is that the data can potentially also be read by -systems other than Terraform, such as configuration management or scheduler -systems within your compute instances. For that reason, we recommend selecting -a configuration store that your other infrastructure could potentially make -use of. For example: - -* If you wish to share IP addresses and hostnames, you could publish them as -normal DNS `A`, `AAAA`, `CNAME`, and `SRV` records in a private DNS zone and -then configure your other infrastructure to refer to that zone so you can -find infrastructure objects via your system's built-in DNS resolver. -* If you use HashiCorp Consul then publishing data to the Consul key/value -store or Consul service catalog can make that data also accessible via -[Consul Template](https://github.com/hashicorp/consul-template) -or the -[HashiCorp Nomad](https://www.nomadproject.io/docs/job-specification/template) -`template` stanza. -* If you use Kubernetes then you can -[make Config Maps available to your Pods](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/). - -Some of the data stores listed above are specifically designed for storing -small configuration values, while others are generic blob storage systems. For -those generic systems, you can use -[the `jsonencode` function](https://www.terraform.io/docs/language/functions/jsonencode.html) -and -[the `jsondecode` function](https://www.terraform.io/docs/language/functions/jsondecode.html) respectively -to store and retrieve structured data. - -You can encapsulate the implementation details of retrieving your published -configuration data by writing a -[data-only module](/docs/language/modules/develop/composition.html#data-only-modules) -containing the necessary data source configuration and any necessary -post-processing such as JSON decoding. You can then change that module later -if you switch to a different strategy for sharing data between multiple -Terraform configurations. - -## Usage with Terraform Cloud/Enterprise - -When trying to access remote state outputs in Terraform Cloud/Enterprise, it is recommended to use the `tfe_outputs` data source in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) instead of relying the `terraform_remote_state` data source. - -See the [full documentation](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) for the `tfe_outputs` data source for more details. - -## Example Usage (`remote` Backend) - -```hcl -data "terraform_remote_state" "vpc" { - backend = "remote" - - config = { - organization = "hashicorp" - workspaces = { - name = "vpc-prod" - } - } -} - -# Terraform >= 0.12 -resource "aws_instance" "foo" { - # ... - subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id -} - -# Terraform <= 0.11 -resource "aws_instance" "foo" { - # ... - subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" -} -``` - -## Example Usage (`local` Backend) - -```hcl -data "terraform_remote_state" "vpc" { - backend = "local" - - config = { - path = "..." - } -} - -# Terraform >= 0.12 -resource "aws_instance" "foo" { - # ... - subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id -} - -# Terraform <= 0.11 -resource "aws_instance" "foo" { - # ... - subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" -} -``` - -## Argument Reference - -The following arguments are supported: - -* `backend` - (Required) The remote backend to use. -* `workspace` - (Optional) The Terraform workspace to use, if the backend - supports workspaces. -* `config` - (Optional; object) The configuration of the remote backend. - Although this argument is listed as optional, most backends require - some configuration. - - The `config` object can use any arguments that would be valid in the - equivalent `terraform { backend "" { ... } }` block. See - [the documentation of your chosen backend](/docs/language/settings/backends/index.html) - for details. - - -> **Note:** If the backend configuration requires a nested block, specify - it here as a normal attribute with an object value. (For example, - `workspaces = { ... }` instead of `workspaces { ... }`.) -* `defaults` - (Optional; object) Default values for outputs, in case the state - file is empty or lacks a required output. - -## Attributes Reference - -In addition to the above, the following attributes are exported: - -* (v0.12+) `outputs` - An object containing every root-level - [output](/docs/language/values/outputs.html) in the remote state. -* (<= v0.11) `` - Each root-level [output](/docs/language/values/outputs.html) - in the remote state appears as a top level attribute on the data source. - -## Root Outputs Only - -Only the root-level output values from the remote state snapshot are exposed -for use elsewhere in your module. Resource data and output values from nested -modules are not accessible. - -If you wish to make a nested module output value accessible as a root module -output value, you must explicitly configure a passthrough in the root module. -For example: - -For example: - -```hcl -module "app" { - source = "..." -} - -output "app_value" { - # This syntax is for Terraform 0.12 or later. - value = module.app.example -} -``` - -In this example, the output value named `example` from the "app" module is -available as the `app_value` root module output value. If this configuration -didn't include the `output "app_value"` block then the data would not be -accessible via `terraform_remote_state`. - -~> **Warning:** Although `terraform_remote_state` doesn't expose any other -state snapshot information for use in configuration, the state snapshot data -is a single object and so any user or server which has enough access to read -the root module output values will also always have access to the full state -snapshot data by direct network requests. Don't use `terraform_remote_state` -if any of the resources in your configuration work with data that you consider -sensitive. diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx new file mode 100644 index 000000000000..8dbda8ccb04f --- /dev/null +++ b/website/docs/language/state/remote-state-data.mdx @@ -0,0 +1,219 @@ +--- +page_title: The terraform_remote_state Data Source +description: >- + Retrieves the root module output values from a Terraform state snapshot stored + in a remote backend. +--- + +# The `terraform_remote_state` Data Source + +[backends]: /language/settings/backends + +The `terraform_remote_state` data source retrieves the root module output values +from some other Terraform configuration, using the latest state snapshot from +the remote backend. + +This data source is built into Terraform, and is always available; you do not +need to require or configure a provider in order to use it. + +-> **Note:** This data source is implemented by a built-in provider, whose +[source address](/language/providers/requirements#source-addresses) +is `terraform.io/builtin/terraform`. That provider does not include any other +resources or data sources. + +## Alternative Ways to Share Data Between Configurations + +Sharing data with root module outputs is convenient, but it has drawbacks. +Although `terraform_remote_state` only exposes output values, its user must have +access to the entire state snapshot, which often includes some sensitive +information. + +When possible, we recommend explicitly publishing data for external consumption +to a separate location instead of accessing it via remote state. This lets you +apply different access controls for shared information and state snapshots. + +To share data explicitly between configurations, you can use pairs of managed +resource types and data sources in various providers, including (but not +limited to) the following: + +| System | Publish with... | Read with... | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Alibaba Cloud DNS
      (for IP addresses and hostnames) | [`alicloud_alidns_record` resource type](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/alidns_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Amazon Route53
      (for IP addresses and hostnames) | [`aws_route53_record` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Amazon S3 | [`aws_s3_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_object) | [`aws_s3_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket_object) | +| Amazon SSM Parameter Store | [`aws_ssm_parameter` resource type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | [`aws_ssm_parameter` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | +| Azure Automation | [`azurerm_automation_variable_string` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/automation_variable_string) | [`azurerm_automation_variable_string` data source](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/automation_variable_string) | +| Azure DNS
      (for IP addresses and hostnames) | [`azurerm_dns_a_record` resource type](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/dns_a_record), etc | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Google Cloud DNS
      (for IP addresses and hostnames) | [`google_dns_record_set` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/dns_record_set) | Normal DNS lookups, or [the `dns` provider](https://registry.terraform.io/providers/hashicorp/dns/latest/docs) | +| Google Cloud Storage | [`google_storage_bucket_object` resource type](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/storage_bucket_object) | [`google_storage_bucket_object` data source](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/storage_bucket_object) and [`http` data source](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | +| HashiCorp Consul | [`consul_key_prefix` resource type](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/key_prefix) | [`consul_key_prefix` data source](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key_prefix) | +| HashiCorp Terraform Cloud | Normal `outputs` terraform block | [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) | +| Kubernetes | [`kubernetes_config_map` resource type](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | [`kubernetes_config_map` data source](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/config_map) | +| OCI Object Storage | [`oci_objectstorage_bucket` resource type](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/resources/objectstorage_object) | [`oci_objectstorage_bucket` data source](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/data-sources/objectstorage_object) | + +-> These are some common options from the Official Terraform providers, but +there are too many configuration storage options for us to list them all +here, including some in partner and community providers. +Any pair of managed resource type and corresponding data source can potentially +be used to share data between Terraform configurations. See individual provider +documentation to find other possibilities. + +A key advantage of using a separate explicit configuration store instead of +`terraform_remote_state` is that the data can potentially also be read by +systems other than Terraform, such as configuration management or scheduler +systems within your compute instances. For that reason, we recommend selecting +a configuration store that your other infrastructure could potentially make +use of. For example: + +* If you wish to share IP addresses and hostnames, you could publish them as + normal DNS `A`, `AAAA`, `CNAME`, and `SRV` records in a private DNS zone and + then configure your other infrastructure to refer to that zone so you can + find infrastructure objects via your system's built-in DNS resolver. +* If you use HashiCorp Consul then publishing data to the Consul key/value + store or Consul service catalog can make that data also accessible via + [Consul Template](https://github.com/hashicorp/consul-template) + or the + [HashiCorp Nomad](https://www.nomadproject.io/docs/job-specification/template) + `template` stanza. +* If you use Kubernetes then you can + [make Config Maps available to your Pods](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/). + +Some of the data stores listed above are specifically designed for storing +small configuration values, while others are generic blob storage systems. For +those generic systems, you can use +[the `jsonencode` function](/language/functions/jsonencode) +and +[the `jsondecode` function](/language/functions/jsondecode) respectively +to store and retrieve structured data. + +You can encapsulate the implementation details of retrieving your published +configuration data by writing a +[data-only module](/language/modules/develop/composition#data-only-modules) +containing the necessary data source configuration and any necessary +post-processing such as JSON decoding. You can then change that module later +if you switch to a different strategy for sharing data between multiple +Terraform configurations. + +## Usage with Terraform Cloud/Enterprise + +When trying to access remote state outputs in Terraform Cloud/Enterprise, it is recommended to use the `tfe_outputs` data source in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) instead of relying the `terraform_remote_state` data source. + +See the [full documentation](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) for the `tfe_outputs` data source for more details. + +## Example Usage (`remote` Backend) + +```hcl +data "terraform_remote_state" "vpc" { + backend = "remote" + + config = { + organization = "hashicorp" + workspaces = { + name = "vpc-prod" + } + } +} + +# Terraform >= 0.12 +resource "aws_instance" "foo" { + # ... + subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id +} + +# Terraform <= 0.11 +resource "aws_instance" "foo" { + # ... + subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" +} +``` + +## Example Usage (`local` Backend) + +```hcl +data "terraform_remote_state" "vpc" { + backend = "local" + + config = { + path = "..." + } +} + +# Terraform >= 0.12 +resource "aws_instance" "foo" { + # ... + subnet_id = data.terraform_remote_state.vpc.outputs.subnet_id +} + +# Terraform <= 0.11 +resource "aws_instance" "foo" { + # ... + subnet_id = "${data.terraform_remote_state.vpc.subnet_id}" +} +``` + +## Argument Reference + +The following arguments are supported: + +* `backend` - (Required) The remote backend to use. +* `workspace` - (Optional) The Terraform workspace to use, if the backend + supports workspaces. +* `config` - (Optional; object) The configuration of the remote backend. + Although this argument is listed as optional, most backends require + some configuration. + + The `config` object can use any arguments that would be valid in the + equivalent `terraform { backend "" { ... } }` block. See + [the documentation of your chosen backend](/language/settings/backends) + for details. + + -> **Note:** If the backend configuration requires a nested block, specify + it here as a normal attribute with an object value. (For example, + `workspaces = { ... }` instead of `workspaces { ... }`.) +* `defaults` - (Optional; object) Default values for outputs, in case the state + file is empty or lacks a required output. + +## Attributes Reference + +In addition to the above, the following attributes are exported: + +* (v0.12+) `outputs` - An object containing every root-level + [output](/language/values/outputs) in the remote state. +* (<= v0.11) `` - Each root-level [output](/language/values/outputs) + in the remote state appears as a top level attribute on the data source. + +## Root Outputs Only + +Only the root-level output values from the remote state snapshot are exposed +for use elsewhere in your module. Resource data and output values from nested +modules are not accessible. + +If you wish to make a nested module output value accessible as a root module +output value, you must explicitly configure a passthrough in the root module. +For example: + +For example: + +```hcl +module "app" { + source = "..." +} + +output "app_value" { + # This syntax is for Terraform 0.12 or later. + value = module.app.example +} +``` + +In this example, the output value named `example` from the "app" module is +available as the `app_value` root module output value. If this configuration +didn't include the `output "app_value"` block then the data would not be +accessible via `terraform_remote_state`. + +~> **Warning:** Although `terraform_remote_state` doesn't expose any other +state snapshot information for use in configuration, the state snapshot data +is a single object and so any user or server which has enough access to read +the root module output values will also always have access to the full state +snapshot data by direct network requests. Don't use `terraform_remote_state` +if any of the resources in your configuration work with data that you consider +sensitive. diff --git a/website/docs/language/state/remote.html.md b/website/docs/language/state/remote.mdx similarity index 84% rename from website/docs/language/state/remote.html.md rename to website/docs/language/state/remote.mdx index b9cf39d64cbe..77cce472c854 100644 --- a/website/docs/language/state/remote.html.md +++ b/website/docs/language/state/remote.mdx @@ -1,9 +1,8 @@ --- -layout: "language" -page_title: "State: Remote Storage" -sidebar_current: "docs-state-remote" -description: |- - Terraform can store the state remotely, making it easier to version and work with in a team. +page_title: 'State: Remote Storage' +description: >- + Terraform can store the state remotely, making it easier to version and work + with in a team. --- # Remote State @@ -19,13 +18,13 @@ which can then be shared between all members of a team. Terraform supports storing state in [Terraform Cloud](https://www.hashicorp.com/products/terraform/), [HashiCorp Consul](https://www.consul.io/), Amazon S3, Azure Blob Storage, Google Cloud Storage, Alibaba Cloud OSS, and more. -Remote state is implemented by a [backend](/docs/language/settings/backends/index.html) or by +Remote state is implemented by a [backend](/language/settings/backends) or by Terraform Cloud, both of which you can configure in your configuration's root module. ## Delegation and Teamwork Remote state allows you to share -[output values](/docs/language/values/outputs.html) with other configurations. +[output values](/language/values/outputs) with other configurations. This allows your infrastructure to be decomposed into smaller components. Put another way, remote state also allows teams to share infrastructure @@ -39,7 +38,7 @@ you can expose things such as VPC IDs, subnets, NAT instance IDs, etc. through remote state and have other Terraform states consume that. For example usage, see -[the `terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +[the `terraform_remote_state` data source](/language/state/remote-state-data). While remote state can be a convenient, built-in mechanism for sharing data between configurations, you may prefer to use more general stores to @@ -53,7 +52,7 @@ another that consumes those values using ## Locking and Teamwork For fully-featured remote backends, Terraform can also use -[state locking](/docs/language/state/locking.html) to prevent concurrent runs of +[state locking](/language/state/locking) to prevent concurrent runs of Terraform against the same state. [Terraform Cloud by HashiCorp](https://www.hashicorp.com/products/terraform/) diff --git a/website/docs/language/state/sensitive-data.html.md b/website/docs/language/state/sensitive-data.mdx similarity index 79% rename from website/docs/language/state/sensitive-data.html.md rename to website/docs/language/state/sensitive-data.mdx index 49f5c1270675..63f624751e16 100644 --- a/website/docs/language/state/sensitive-data.html.md +++ b/website/docs/language/state/sensitive-data.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "State: Sensitive Data" -sidebar_current: "docs-state-sensitive-data" -description: |- - Sensitive data in Terraform state. +page_title: 'State: Sensitive Data' +description: Sensitive data in Terraform state. --- # Sensitive Data in State @@ -15,7 +12,7 @@ passwords. When using local state, state is stored in plain-text JSON files. -When using [remote state](/docs/language/state/remote.html), state is only ever held in +When using [remote state](/language/state/remote), state is only ever held in memory when used by Terraform. It may be encrypted at rest, but this depends on the specific remote state backend. @@ -30,10 +27,10 @@ and some backends can be configured to encrypt the state data at rest. For example: -- [Terraform Cloud](/docs/cloud/index.html) always encrypts state at rest and +- [Terraform Cloud](/cloud) always encrypts state at rest and protects it with TLS in transit. Terraform Cloud also knows the identity of the user requesting state and maintains a history of state changes. This can - be used to control access and track activity. [Terraform Enterprise](/docs/enterprise/index.html) + be used to control access and track activity. [Terraform Enterprise](/enterprise) also supports detailed audit logging. - The S3 backend supports encryption at rest when the `encrypt` option is enabled. IAM policies and logging can be used to identify any invalid access. diff --git a/website/docs/language/state/workspaces.html.md b/website/docs/language/state/workspaces.mdx similarity index 85% rename from website/docs/language/state/workspaces.html.md rename to website/docs/language/state/workspaces.mdx index 8dcb7b5f476a..a3f38d44783c 100644 --- a/website/docs/language/state/workspaces.html.md +++ b/website/docs/language/state/workspaces.mdx @@ -1,16 +1,15 @@ --- -layout: "language" -page_title: "State: Workspaces" -sidebar_current: "docs-state-workspaces" -description: |- - Workspaces allow the use of multiple states with a single configuration directory. +page_title: 'State: Workspaces' +description: >- + Workspaces allow the use of multiple states with a single configuration + directory. --- # Workspaces -Each Terraform configuration has an associated [backend](/docs/language/settings/backends/index.html) +Each Terraform configuration has an associated [backend](/language/settings/backends) that defines how operations are executed and where persistent data such as -[the Terraform state](https://www.terraform.io/docs/language/state/purpose.html) are +[the Terraform state](/language/state/purpose) are stored. The persistent data stored in the backend belongs to a _workspace_. Initially @@ -25,17 +24,17 @@ credentials. Multiple workspaces are currently supported by the following backends: - * [AzureRM](/docs/language/settings/backends/azurerm.html) - * [Consul](/docs/language/settings/backends/consul.html) - * [COS](/docs/language/settings/backends/cos.html) - * [etcdv3](/docs/language/settings/backends/etcdv3.html) - * [GCS](/docs/language/settings/backends/gcs.html) - * [Kubernetes](/docs/language/settings/backends/kubernetes.html) - * [Local](/docs/language/settings/backends/local.html) - * [Manta](/docs/language/settings/backends/manta.html) - * [Postgres](/docs/language/settings/backends/pg.html) - * [Remote](/docs/language/settings/backends/remote.html) - * [S3](/docs/language/settings/backends/s3.html) +* [AzureRM](/language/settings/backends/azurerm) +* [Consul](/language/settings/backends/consul) +* [COS](/language/settings/backends/cos) +* [etcdv3](/language/settings/backends/etcdv3) +* [GCS](/language/settings/backends/gcs) +* [Kubernetes](/language/settings/backends/kubernetes) +* [Local](/language/settings/backends/local) +* [Manta](/language/settings/backends/manta) +* [Postgres](/language/settings/backends/pg) +* [Remote](/language/settings/backends/remote) +* [S3](/language/settings/backends/s3) In the 0.9 line of Terraform releases, this concept was known as "environment". It was renamed in 0.10 based on feedback about confusion caused by the @@ -44,9 +43,9 @@ organizations that use Terraform. -> **Note**: The Terraform CLI workspace concept described in this document is different from but related to the Terraform Cloud -[workspace](/docs/cloud/workspaces/index.html) concept. +[workspace](/cloud-docs/workspaces) concept. If you use multiple Terraform CLI workspaces in a single Terraform configuration -and are migrating that configuration to Terraform Cloud, refer to [Initializing and Migrating](/docs/cli/cloud/migrating.html). +and are migrating that configuration to Terraform Cloud, refer to [Initializing and Migrating](/cli/cloud/migrating). ## Using Workspaces @@ -143,7 +142,7 @@ In this case, the backend used for each deployment often belongs to that deployment, with different credentials and access controls. Named workspaces are _not_ a suitable isolation mechanism for this scenario. -Instead, use one or more [re-usable modules](/docs/language/modules/develop/index.html) to +Instead, use one or more [re-usable modules](/language/modules/develop) to represent the common elements, and then represent each instance as a separate configuration that instantiates those common elements in the context of a different backend. In that case, the root module of each configuration will @@ -173,7 +172,7 @@ another using paired resources types and data sources. For example: * If a Terraform state for one configuration is stored in a remote backend that is accessible to other configurations then - [`terraform_remote_state`](/docs/language/state/remote-state-data.html) + [`terraform_remote_state`](/language/state/remote-state-data) can be used to directly consume its root module outputs from those other configurations. This creates a tighter coupling between configurations, but avoids the need for the "producer" configuration to explicitly @@ -191,9 +190,9 @@ local-only `terraform.tfstate`; some teams commit these files to version control, although using a remote backend instead is recommended when there are multiple collaborators. -For [remote state](/docs/language/state/remote.html), the workspaces are stored -directly in the configured [backend](/docs/language/settings/backends/index.html). For example, if you -use [Consul](/docs/language/settings/backends/consul.html), the workspaces are stored +For [remote state](/language/state/remote), the workspaces are stored +directly in the configured [backend](/language/settings/backends). For example, if you +use [Consul](/language/settings/backends/consul), the workspaces are stored by appending the workspace name to the state path. To ensure that workspace names are stored correctly and safely in all backends, the name must be valid to use in a URL path segment without escaping. diff --git a/website/docs/language/syntax/configuration.html.md b/website/docs/language/syntax/configuration.mdx similarity index 92% rename from website/docs/language/syntax/configuration.html.md rename to website/docs/language/syntax/configuration.mdx index 5dd06b28ef8e..01467288b046 100644 --- a/website/docs/language/syntax/configuration.html.md +++ b/website/docs/language/syntax/configuration.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Syntax - Configuration Language" -sidebar_current: "docs-config-syntax" -description: "Key constructs of the native Terraform language syntax, including identifiers, arguments, blocks, and comments." +page_title: Syntax - Configuration Language +description: >- + Key constructs of the native Terraform language syntax, including identifiers, + arguments, blocks, and comments. --- # Configuration Syntax @@ -15,7 +15,7 @@ those constructs are built from. This page describes the _native syntax_ of the Terraform language, which is a rich language designed to be relatively easy for humans to read and write. The constructs in the Terraform language can also be expressed in -[JSON syntax](/docs/language/syntax/json.html), which is harder for humans +[JSON syntax](/language/syntax/json), which is harder for humans to read and edit but easier to generate and parse programmatically. This low-level syntax of the Terraform language is defined in terms of a @@ -46,7 +46,7 @@ after the equals sign is the argument's value. The context where the argument appears determines what value types are valid (for example, each resource type has a schema that defines the types of its arguments), but many arguments accept arbitrary -[expressions](/docs/language/expressions/index.html), which allow the value to +[expressions](/language/expressions), which allow the value to either be specified literally or generated from other values programmatically. -> **Note:** Terraform's configuration language is based on a more general diff --git a/website/docs/language/syntax/index.html.md b/website/docs/language/syntax/index.mdx similarity index 53% rename from website/docs/language/syntax/index.html.md rename to website/docs/language/syntax/index.mdx index ccd8a67d950e..742a40fef8e8 100644 --- a/website/docs/language/syntax/index.html.md +++ b/website/docs/language/syntax/index.mdx @@ -1,7 +1,8 @@ --- -layout: "language" -page_title: "Syntax Overview - Configuration Language" -description: "Terraform language syntax for both the native and JSON variants. Also learn formatting conventions that you can enforce with terraform fmt." +page_title: Syntax Overview - Configuration Language +description: >- + Terraform language syntax for both the native and JSON variants. Also learn + formatting conventions that you can enforce with terraform fmt. --- # Syntax @@ -10,13 +11,13 @@ The majority of the Terraform language documentation focuses on the practical uses of the language and the specific constructs it uses. The pages in this section offer a more abstract view of the Terraform language. -- [Configuration Syntax](/docs/language/syntax/configuration.html) describes the native +- [Configuration Syntax](/language/syntax/configuration) describes the native grammar of the Terraform language. -- [JSON Configuration Syntax](/docs/language/syntax/json.html) documents +- [JSON Configuration Syntax](/language/syntax/json) documents how to represent Terraform language constructs in the pure JSON variant of the Terraform language. Terraform's JSON syntax is unfriendly to humans, but can be very useful when generating infrastructure as code with other systems that don't have a readily available HCL library. -- [Style Conventions](/docs/language/syntax/style.html) documents some commonly +- [Style Conventions](/language/syntax/style) documents some commonly accepted formatting guidelines for Terraform code. These conventions can be - enforced automatically with [`terraform fmt`](/docs/cli/commands/fmt.html). + enforced automatically with [`terraform fmt`](/cli/commands/fmt). diff --git a/website/docs/language/syntax/json.html.md b/website/docs/language/syntax/json.mdx similarity index 95% rename from website/docs/language/syntax/json.html.md rename to website/docs/language/syntax/json.mdx index 32a69578eac4..477ce9fd7e80 100644 --- a/website/docs/language/syntax/json.html.md +++ b/website/docs/language/syntax/json.mdx @@ -1,14 +1,14 @@ --- -layout: "language" -page_title: "JSON Configuration Syntax - Configuration Language" -sidebar_current: "docs-config-syntax-json" -description: "Learn about the JSON-compatible language syntax, including file structure, expression mapping, block mapping, and block-type-specific exceptions." +page_title: JSON Configuration Syntax - Configuration Language +description: >- + Learn about the JSON-compatible language syntax, including file structure, + expression mapping, block mapping, and block-type-specific exceptions. --- # JSON Configuration Syntax Most Terraform configurations are written in -[the native Terraform language syntax](/docs/language/syntax/configuration.html), which is designed to be +[the native Terraform language syntax](/language/syntax/configuration), which is designed to be relatively easy for humans to read and update. Terraform also supports an alternative syntax that is JSON-compatible. This @@ -92,7 +92,7 @@ different (see the [block-type-specific exceptions](#block-type-specific-excepti correspond either to argument names or to nested block type names. * Where a property corresponds to an argument that accepts - [arbitrary expressions](/docs/language/expressions/index.html) in the native syntax, the + [arbitrary expressions](/language/expressions) in the native syntax, the property value is mapped to an expression as described under [_Expression Mapping_](#expression-mapping) below. For arguments that do _not_ accept arbitrary expressions, the interpretation of the property @@ -109,7 +109,7 @@ different (see the [block-type-specific exceptions](#block-type-specific-excepti ## Expression Mapping Since JSON grammar is not able to represent all of the Terraform language -[expression syntax](/docs/language/expressions/index.html), JSON values interpreted as expressions +[expression syntax](/language/expressions), JSON values interpreted as expressions are mapped as follows: | JSON | Terraform Language Interpretation | @@ -121,7 +121,7 @@ are mapped as follows: | Array | Each element is mapped per this table, producing a `tuple(...)` value with suitable element types. | | Null | A literal `null`. | -[string template]: /docs/language/expressions/strings.html#string-templates +[string template]: /language/expressions/strings#string-templates When a JSON string is encountered in a location where arbitrary expressions are expected, its value is first parsed as a [string template][] @@ -259,7 +259,7 @@ preserved exactly. ### Comment Properties Although we do not recommend hand-editing of JSON syntax configuration files --- this format is primarily intended for programmatic generation and consumption -- +\-- this format is primarily intended for programmatic generation and consumption -- a limited form of _comments_ are allowed inside JSON objects that represent block bodies using a special property name: diff --git a/website/docs/language/syntax/style.html.md b/website/docs/language/syntax/style.mdx similarity index 76% rename from website/docs/language/syntax/style.html.md rename to website/docs/language/syntax/style.mdx index bbbf090f7596..b29195dcaeec 100644 --- a/website/docs/language/syntax/style.html.md +++ b/website/docs/language/syntax/style.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Style Conventions - Configuration Language" -sidebar_current: "docs-config-style" -description: "Learn recommended formatting conventions for the Terraform language and a command to automatically enforce them." +page_title: Style Conventions - Configuration Language +description: >- + Learn recommended formatting conventions for the Terraform language and a + command to automatically enforce them. --- # Style Conventions @@ -14,17 +14,17 @@ for consistency between files and modules written by different teams. Automatic source code formatting tools may apply these conventions automatically. --> **Note**: You can enforce these conventions automatically by running [`terraform fmt`](/docs/cli/commands/fmt.html). +-> **Note**: You can enforce these conventions automatically by running [`terraform fmt`](/cli/commands/fmt). * Indent two spaces for each nesting level. * When multiple arguments with single-line values appear on consecutive lines at the same nesting level, align their equals signs: - ```hcl - ami = "abc123" - instance_type = "t2.micro" - ``` + ```hcl + ami = "abc123" + instance_type = "t2.micro" + ``` * When both arguments and blocks appear together inside a block body, place all of the arguments together at the top and then place nested @@ -39,22 +39,22 @@ automatically. meta-argument blocks _last_ and separate them from other blocks with one blank line. - ```hcl - resource "aws_instance" "example" { - count = 2 # meta-argument first + ```hcl + resource "aws_instance" "example" { + count = 2 # meta-argument first - ami = "abc123" - instance_type = "t2.micro" + ami = "abc123" + instance_type = "t2.micro" - network_interface { - # ... - } + network_interface { + # ... + } - lifecycle { # meta-argument block last - create_before_destroy = true - } + lifecycle { # meta-argument block last + create_before_destroy = true } - ``` + } + ``` * Top-level blocks should always be separated from one another by one blank line. Nested blocks should also be separated by blank lines, except @@ -68,4 +68,3 @@ automatically. `ephemeral_block_device` on `aws_instance` form a family of block types describing AWS block devices, and can therefore be grouped together and mixed.) - diff --git a/website/upgrade-guides/0-10.html.markdown b/website/docs/language/upgrade-guides/0-10.mdx similarity index 90% rename from website/upgrade-guides/0-10.html.markdown rename to website/docs/language/upgrade-guides/0-10.mdx index c33b6186b396..f12f9979f19e 100644 --- a/website/upgrade-guides/0-10.html.markdown +++ b/website/docs/language/upgrade-guides/0-10.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform 0.10" -sidebar_current: "upgrade-guides-0-10" -description: |- - Upgrading to Terraform v0.10 +page_title: Upgrading to Terraform 0.10 +description: Upgrading to Terraform v0.10 --- # Upgrading to Terraform v0.10 @@ -28,7 +25,7 @@ in the navigation) if you are upgrading directly from an earlier version. As of v0.10, provider plugins are no longer included in the main Terraform distribution. Instead, they are distributed separately and installed automatically by -[the `terraform init` command](/docs/cli/commands/init.html). +[the `terraform init` command](/cli/commands/init). In the long run, this new approach should be beneficial to anyone who wishes to upgrade a specific provider to get new functionality without also @@ -37,7 +34,7 @@ In the short term, it just means a smaller distribution package and thus avoiding the need to download tens of providers that may never be used. Provider plugins are now also versioned separately from Terraform itself. -[Version constraints](/docs/language/providers/configuration.html#provider-versions) +[Version constraints](/language/providers/configuration#provider-versions) can be specified in configuration to ensure that new major releases (which may have breaking changes) are not automatically installed. @@ -48,7 +45,7 @@ step after a Terraform configuration is cloned from version control, and will also install any necessary modules and configure any remote backend. **Action:** For "production" configurations, consider adding -[provider version constraints](/docs/language/providers/configuration.html#provider-versions), +[provider version constraints](/language/providers/configuration#provider-versions), as suggested by the `terraform init` output, to prevent new major versions of plugins from being automatically installed in future. @@ -66,10 +63,10 @@ third-party providers released on the Terraform Registry. In the mean time, third-party providers can be installed by placing them in the user plugins directory: -Operating system | User plugins directory -------------------|----------------------- -Windows | `%APPDATA%\terraform.d\plugins` -All other systems | `~/.terraform.d/plugins` +| Operating system | User plugins directory | +| ----------------- | ------------------------------- | +| Windows | `%APPDATA%\terraform.d\plugins` | +| All other systems | `~/.terraform.d/plugins` | Maintainers of third-party providers may optionally make use of the new versioning mechanism by naming provider binaries @@ -104,9 +101,9 @@ For example, if `module.example` contains a module itself, called `module.example` _and_ `module.example.module.examplechild`. This also applies to other Terraform features that use -[resource addressing](/docs/cli/state/resource-addressing.html) syntax. +[resource addressing](/cli/state/resource-addressing) syntax. This includes some of the subcommands of -[`terraform state`](/docs/cli/commands/state/index.html). +[`terraform state`](/cli/commands/state). **Action:** If running Terraform with `-target` in automation, review usage to ensure that selecting additional resources in child modules will not have diff --git a/website/upgrade-guides/0-11.html.markdown b/website/docs/language/upgrade-guides/0-11.mdx similarity index 95% rename from website/upgrade-guides/0-11.html.markdown rename to website/docs/language/upgrade-guides/0-11.mdx index 60f7708add44..76daf9aa8571 100644 --- a/website/upgrade-guides/0-11.html.markdown +++ b/website/docs/language/upgrade-guides/0-11.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform 0.11" -sidebar_current: "upgrade-guides-0-11" -description: |- - Upgrading to Terraform v0.11 +page_title: Upgrading to Terraform 0.11 +description: Upgrading to Terraform v0.11 --- # Upgrading to Terraform v0.11 @@ -96,7 +93,7 @@ situations: * If a `provider` block is present in a child module, it must either contain a complete configuration for its associated provider or a configuration must be passed from the parent module using - [the new `providers` attribute](/docs/configuration-0-11/modules.html#providers-within-modules). + [the new `providers` attribute](/language/configuration-0-11/modules#providers-within-modules). In the latter case, an empty provider block is a placeholder that declares that the child module requires a configuration to be passed from its parent. @@ -157,7 +154,7 @@ now inherit only as a whole, rather than on a per-argument basis. **Action**: In existing configurations where a descendent module inherits _aliased_ providers from an ancestor module, use -[the new `providers` attribute](/docs/configuration-0-11/modules.html#providers-within-modules) +[the new `providers` attribute](/language/configuration-0-11/modules#providers-within-modules) to explicitly pass those aliased providers. **Action**: Consider refactoring existing configurations so that all provider @@ -260,13 +257,13 @@ resource "aws_vpc" "example" { ``` After the above refactoring, run `terraform apply` to re-synchoronize -Terraform's record (in [the Terraform state](/docs/language/state/index.html)) of the +Terraform's record (in [the Terraform state](/language/state)) of the location of each resource's provider configuration. This should make no changes to actual infrastructure, since no resource configurations were changed. For more details on the explicit `providers` map, and discussion of more complex possibilities such as child modules with additional (aliased) provider -configurations, see [_Providers Within Modules_](/docs/configuration-0-11/modules.html#providers-within-modules). +configurations, see [_Providers Within Modules_](/language/configuration-0-11/modules#providers-within-modules). ## Error Checking for Output Values diff --git a/website/upgrade-guides/0-12.html.markdown b/website/docs/language/upgrade-guides/0-12.mdx similarity index 97% rename from website/upgrade-guides/0-12.html.markdown rename to website/docs/language/upgrade-guides/0-12.mdx index 8c72aa1ee3c0..42b490f5d474 100644 --- a/website/upgrade-guides/0-12.html.markdown +++ b/website/docs/language/upgrade-guides/0-12.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform 0.12" -sidebar_current: "upgrade-guides-0-12" -description: |- - Upgrading to Terraform v0.12 +page_title: Upgrading to Terraform 0.12 +description: Upgrading to Terraform v0.12 --- # Upgrading to Terraform v0.12 @@ -16,14 +13,13 @@ to cover the most common upgrade concerns and issues. For most users, upgrading configuration should be completely automatic. Some simple configurations will require no changes at all, and most other configurations can be prepared by running -[the automatic upgrade tool](/docs/cli/commands/0.12upgrade.html). Please read on +[the automatic upgrade tool](/cli/commands/0.12upgrade). Please read on for more information and recommendations on the upgrade process. -> If you are a developer maintaining a provider plugin, please see -[the documentation on 0.12 compatibility for providers](/docs/extend/terraform-0.12-compatibility.html) +[the documentation on 0.12 compatibility for providers](/plugin/sdkv2/guides/terraform-0.12-compatibility) to learn more about the changes that are required. - ## Upgrade to Terraform 0.11 first We strongly recommend completing an upgrade to the latest Terraform v0.11 @@ -32,7 +28,7 @@ required for the previous major version upgrades separately, rather than making multiple changes at once. In particular, if you are upgrading from a Terraform version prior to v0.9, -you _must_ first [upgrade to Terraform v0.9](/upgrade-guides/0-9.html) and +you _must_ first [upgrade to Terraform v0.9](/language/upgrade-guides/0-9) and switch to initializing with `terraform init`, because v0.12 no longer includes the functionality for automatically migrating from the legacy remote state mechanism. @@ -448,7 +444,7 @@ in retrospect it was an obvious consequence of how the compatibility mechanism was implemented. If you have expressions in your modules that produce a list of strings by using list brackets with a mixture of string and list-of-string sub-expressions, you will need to rewrite this to explicitly use -[the `flatten` function](/docs/language/functions/flatten.html) +[the `flatten` function](/language/functions/flatten) to make the special treatment more obvious to the reader: ```hcl @@ -519,7 +515,7 @@ even though it was then generally inconvenient to work with those values elsewhere in the module due to limitations of the index syntax, `element` function, and `lookup` function. -Terraform now allows various [type constraints](/docs/language/expressions/type-constraints.html) +Terraform now allows various [type constraints](/language/expressions/type-constraints) to be specified, as part of the language's new type system and generalized functions and operators. However, because lists and maps of non-string values were not officially supported in 0.11, existing configurations do not have @@ -557,7 +553,7 @@ child/child.tf:1,1-19: element 0: string required. ``` To fix this, change the `type` argument from `list(string)` or `map(string)` -to a more appropriate [type constraint](/docs/language/expressions/type-constraints.html). +to a more appropriate [type constraint](/language/expressions/type-constraints). If you're not sure what type constraint to use yet, another option is to use the type constraint `any`, which will effectively disable validation and @@ -821,13 +817,13 @@ possible and most policies will continue to work without modification. However, there are some important changes and certain policies will need to modified. More information on the changes can be found in our page on [using Sentinel with -Terraform 0.12](/docs/cloud/sentinel/sentinel-tf-012.html). +Terraform 0.12](/cloud-docs/sentinel/sentinel-tf-012). It's strongly advised that you test your Sentinel policies after upgrading to Terraform 0.12 to ensure they continue to work as expected. [Mock -generation](/docs/cloud/sentinel/mock.html) has also been updated to +generation](/cloud-docs/sentinel/mock) has also been updated to produce mock data for the Sentinel imports as they appear in Terraform 0.12. For more information on testing a policy with 0.11 and 0.12 at the same time, see the section on [testing a policy with 0.11 and 0.12 -simultaneously](/docs/cloud/sentinel/sentinel-tf-012.html#testing-a-policy-with-0-11-and-0-12-simultaneously). +simultaneously](/cloud-docs/sentinel/sentinel-tf-012#testing-a-policy-with-0-11-and-0-12-simultaneously). diff --git a/website/upgrade-guides/0-13.html.markdown b/website/docs/language/upgrade-guides/0-13.mdx similarity index 95% rename from website/upgrade-guides/0-13.html.markdown rename to website/docs/language/upgrade-guides/0-13.mdx index 96fda4b96972..14e6be4fbf17 100644 --- a/website/upgrade-guides/0-13.html.markdown +++ b/website/docs/language/upgrade-guides/0-13.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform v0.13" -sidebar_current: "upgrade-guides-0-13" -description: |- - Upgrading to Terraform v0.13 +page_title: Upgrading to Terraform v0.13 +description: Upgrading to Terraform v0.13 --- # Upgrading to Terraform v0.13 @@ -117,7 +114,7 @@ following command: As mentioned in the error message, Terraform v0.13 includes an automatic upgrade command -[`terraform 0.13upgrade`](/docs/cli/commands/0.13upgrade.html) +[`terraform 0.13upgrade`](/cli/commands/0.13upgrade) that is able to automatically generate source addresses for unlabelled providers by consulting the same lookup table that was previously used for Terraform v0.12 provider installation. This command will automatically modify @@ -129,18 +126,18 @@ because it will generate the recommended explicit source addresses for providers in the "hashicorp" namespace. For more information on declaring provider dependencies, see -[Provider Requirements](/docs/language/providers/requirements.html). +[Provider Requirements](/language/providers/requirements). That page also includes some guidance on how to write provider dependencies for a module that must remain compatible with both Terraform v0.12 and Terraform v0.13; the `terraform 0.13upgrade` result includes a conservative version constraint for Terraform v0.13 or later, which you can weaken to `>= 0.12.26` if you follow the guidelines in -[v0.12-Compatible Provider Requirements](/docs/language/providers/requirements.html#v0-12-compatible-provider-requirements). +[v0.12-Compatible Provider Requirements](/language/providers/requirements#v0-12-compatible-provider-requirements). Each module must declare its own set of provider requirements, so if you have a configuration which calls other modules then you'll need to run this upgrade command for each module separately. -[The `terraform 0.13upgrade documentation`](/docs/cli/commands/0.13upgrade.html) +[The `terraform 0.13upgrade documentation`](/cli/commands/0.13upgrade) includes an example of running the upgrade process across all directories under a particular prefix that contain `.tf` files using some common Unix command line tools, which may be useful if you want to upgrade all modules in a single @@ -149,7 +146,7 @@ repository at once. After you've added explicit provider source addresses to your configuration, run `terraform init` again to re-run the provider installer. --> **Action:** Either run [`terraform 0.13upgrade`](/docs/cli/commands/0.13upgrade.html) for each of your modules, or manually update the provider declarations to use explicit source addresses. +-> **Action:** Either run [`terraform 0.13upgrade`](/cli/commands/0.13upgrade) for each of your modules, or manually update the provider declarations to use explicit source addresses. The upgrade tool described above only updates references in your configuration. The Terraform state also includes references to provider configurations which @@ -164,7 +161,7 @@ from your configuration after upgrading. If you are using Terraform Cloud or Terraform Enterprise with the VCS-driven workflow (as opposed to CLI-driven runs), refer to -[The UI- and VCS-driven Run Workflow](/docs/cloud/run/ui.html) to learn how +[The UI- and VCS-driven Run Workflow](/cloud-docs/run/ui) to learn how to manually start a run after you select a Terraform v0.13 release for your workspace. @@ -232,12 +229,12 @@ Terraform under: Terraform v0.13 introduces some additional options for customizing where Terraform looks for providers in the local filesystem. For more information on -those new options, see [Provider Installation](/docs/cli/config/config-file.html#provider-installation). +those new options, see [Provider Installation](/cli/config/config-file#provider-installation). If you use only providers that are automatically installable from Terraform provider registries but still want to avoid Terraform re-downloading them from registries each time, Terraform v0.13 includes -[the `terraform providers mirror` command](/docs/cli/commands/providers/mirror.html) +[the `terraform providers mirror` command](/cli/commands/providers/mirror) which you can use to automatically populate a local directory based on the requirements of the current configuration file: @@ -408,7 +405,7 @@ The provisioner's `connection` configuration can refer to that value via `self`, whereas referring directly to `aws_instance.example.private_ip` in that context is forbidden. -[Provisioners are a last resort](/docs/language/resources/provisioners/syntax.html#provisioners-are-a-last-resort), +[Provisioners are a last resort](/language/resources/provisioners/syntax#provisioners-are-a-last-resort), so we recommend avoiding both create-time and destroy-time provisioners wherever possible. Other options for destroy-time actions include using `systemd` to run commands within your virtual machines during shutdown or using virtual @@ -441,6 +438,7 @@ accurate plan, and so there is no replacement mechanism in Terraform v0.13 to restore the previous behavior. ## Frequently Asked Questions + ### Why do I see `-/provider` during init? Provider source addresses starting with `registry.terraform.io/-/` are a special @@ -464,7 +462,7 @@ see output like this during your first `init`: ``` Terraform found providers `null` and `random` in the statefile without a -namespace. Terraform *also* found `hashicorp/null` and `hashicorp/random` in the +namespace. Terraform _also_ found `hashicorp/null` and `hashicorp/random` in the configuration files. Providers in configuration are automatically assumed to be default (HashiCorp) providers, while providers found in state are first looked up in the registry. diff --git a/website/upgrade-guides/0-14.html.markdown b/website/docs/language/upgrade-guides/0-14.mdx similarity index 95% rename from website/upgrade-guides/0-14.html.markdown rename to website/docs/language/upgrade-guides/0-14.mdx index ce73b8b12065..684b63f4233e 100644 --- a/website/upgrade-guides/0-14.html.markdown +++ b/website/docs/language/upgrade-guides/0-14.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform v0.14" -sidebar_current: "upgrade-guides-0-14" -description: |- - Upgrading to Terraform v0.14 +page_title: Upgrading to Terraform v0.14 +description: Upgrading to Terraform v0.14 --- # Upgrading to Terraform v0.14 @@ -31,7 +28,7 @@ the previous upgrade guides for any considerations that may be relevant to you. In particular, Terraform v0.14 no longer includes the `terraform 0.13upgrade` command for automatically inserting -[provider requirements](/docs/language/providers/requirements.html) +[provider requirements](/language/providers/requirements) into existing modules, and the automatic mechanisms to upgrade legacy provider references in the Terraform state. You will need to successfully complete a `terraform apply` at least once under Terraform v0.13 before upgrading an @@ -83,7 +80,7 @@ represented in files that can be included in a version control system and code review process. To better meet that goal, Terraform v0.14 introduces a new -[dependency lock file](/docs/language/dependency-lock.html), +[dependency lock file](/language/files/dependency-lock), which Terraform will generate automatically after running `terraform init` in the same directory as your configuration's root module. This file includes the specific version numbers selected for each provider, and also includes @@ -132,7 +129,7 @@ v0.14 which can support a mixture of official, partner, community and in-house providers in a single configuration. If you followed the advice from the Terraform v0.13 upgrade guide about -[assigning your in-house providers their own unique source addresses](0-13.html#in-house-providers), +[assigning your in-house providers their own unique source addresses](/language/upgrade-guides/0-13#in-house-providers), and you're distributing your in-house providers to Terraform through one of the documented mechanisms, Terraform should handle selecting a version and recording its checksums in the same way for all of the providers you use. @@ -159,7 +156,7 @@ network mirrors: across a mixture of platforms then, in addition to making sure that your mirrors include packages for all of the necessary platforms, you may choose to use - [the new `terraform providers lock` command](/docs/cli/commands/providers/lock.html) + [the new `terraform providers lock` command](/cli/commands/providers/lock) to pre-enter the required lock file entries for all of the platforms you intend to use. @@ -265,9 +262,9 @@ Cloud in particular that this approach was previously mis-documented. If you aren't intending to upload the provider plugin to Terraform Cloud as part of your configuration, we recommend instead installing to one of -[the other implied mirror directories](/docs/cli/config/config-file.html#implied-local-mirror-directories), +[the other implied mirror directories](/cli/config/config-file#implied-local-mirror-directories), or you can explicitly configure some -[custom provider installation methods](/docs/cli/config/config-file.html#provider-installation) +[custom provider installation methods](/cli/config/config-file#provider-installation) if your needs are more complicated. ## Concise Terraform Plan Output @@ -322,8 +319,8 @@ instead of the actual value. Terraform v0.14 introduces a more extensive version of that behavior where Terraform will track when you write an expression whose result is derived from a -[sensitive input variable](/docs/language/values/outputs.html#sensitive-suppressing-values-in-cli-output) or -[sensitive output value](/docs/language/values/variables.html#suppressing-values-in-cli-output), +[sensitive input variable](/language/values/outputs#sensitive-suppressing-values-in-cli-output) or +[sensitive output value](/language/values/variables#suppressing-values-in-cli-output), and so after upgrading to Terraform v0.14 you may find that more values are obscured in the Terraform plan output than would have been in Terraform v0.13. @@ -406,13 +403,12 @@ Sensitive values are also still saved in state snapshots stored in your configured backend. Use the access control and audit mechanisms offered by the remote system to control who can access that data. - ## Other Important Workflow Changes ### Terraform Output Formatting -We've modified the formatting of `terraform output` to match the formatting of `terraform show`. +We've modified the formatting of `terraform output` to match the formatting of `terraform show`. We consider the console output of Terraform human readable; specifically designed and optimized for operators and practitioners to review themselves. As a result we occasionally (maybe even regularly) intend to tweak that output to help improve consistency, clarity, actionability and more. -If you rely on `terraform output` in automation, please use `terraform output -json`. +If you rely on `terraform output` in automation, please use `terraform output -json`. diff --git a/website/upgrade-guides/0-15.html.markdown b/website/docs/language/upgrade-guides/0-15.mdx similarity index 84% rename from website/upgrade-guides/0-15.html.markdown rename to website/docs/language/upgrade-guides/0-15.mdx index 8e51bd4f33ac..762693a034c5 100644 --- a/website/upgrade-guides/0-15.html.markdown +++ b/website/docs/language/upgrade-guides/0-15.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform v0.15" -sidebar_current: "upgrade-guides-0-15" -description: |- - Upgrading to Terraform v0.15 +page_title: Upgrading to Terraform v0.15 +description: Upgrading to Terraform v0.15 --- # Upgrading to Terraform v0.15 @@ -151,7 +148,7 @@ OMU3v8F3h8jp+AB/1zGr5UBYfnYp5ncJm/OTCXLFAHxGibEbRnf1m2A3o0hEaWsw If you consider Terraform's treatment of a sensitive value to be too conservative and you'd like to force Terraform to treat a sensitive value as non-sensitive, you can use -[the `nonsensitive` function](/docs/language/functions/nonsensitive.html) to +[the `nonsensitive` function](/language/functions/nonsensitive) to override Terraform's automatic detection: ```hcl @@ -164,13 +161,13 @@ output "private_key" { For more information on the various situations where sensitive values can originate in Terraform, refer to the following sections: -* [Sensitive Input Variables](/docs/language/values/variables.html#suppressing-values-in-cli-output) -* [Sensitive Resource Attributes](/docs/language/expressions/references.html#sensitive-resource-attributes) -* [Sensitive Output Values](/docs/language/values/outputs.html#sensitive) +* [Sensitive Input Variables](/language/values/variables#suppressing-values-in-cli-output) +* [Sensitive Resource Attributes](/language/expressions/references#sensitive-resource-attributes) +* [Sensitive Output Values](/language/values/outputs#sensitive) -> **Note:** The new behavior described in this section was previously available in Terraform v0.14 as the -[language experiment](/docs/language/settings/#experimental-language-features) +[language experiment](/language/settings/#experimental-language-features) `provider_sensitive_attrs`. That experiment has now concluded, so if you were participating in that experiment then you'll now need to remove the experiment opt-in from your module as part of upgrading to Terraform v0.15. @@ -193,72 +190,72 @@ upgrading to Terraform v0.15: deprecated functions in order to resolve the ambiguity with the syntax used to declare list and map type constraints inside `variable` blocks. - If you need to update a module which was using the `list` function, you - can get the same result by replacing `list(...)` with `tolist([...])`. - For example: + If you need to update a module which was using the `list` function, you + can get the same result by replacing `list(...)` with `tolist([...])`. + For example: - ```diff - - list("a", "b", "c") - + tolist(["a", "b", "c"]) - ``` + ```diff + - list("a", "b", "c") + + tolist(["a", "b", "c"]) + ``` - If you need to update a module which was using the `map` function, you - can get the same result by replacing `map(...)` with `tomap({...})`. - For example: + If you need to update a module which was using the `map` function, you + can get the same result by replacing `map(...)` with `tomap({...})`. + For example: - ```diff - - map("a", 1, "b", 2) - + tomap({ a = 1, b = 2 }) - ``` + ```diff + - map("a", 1, "b", 2) + + tomap({ a = 1, b = 2 }) + ``` - The above examples include the type conversion functions `tolist` and - `tomap` to ensure that the result will always be of the same type as - before. However, in most situations those explicit type conversions won't - be necessary because Terraform can infer the necessary type conversions - automatically from context. In those cases, you can just use the - `[ ... ]` or `{ ... }` syntax directly, without a conversion function. + The above examples include the type conversion functions `tolist` and + `tomap` to ensure that the result will always be of the same type as + before. However, in most situations those explicit type conversions won't + be necessary because Terraform can infer the necessary type conversions + automatically from context. In those cases, you can just use the + `[ ... ]` or `{ ... }` syntax directly, without a conversion function. * In `variable` declaration blocks, the `type` argument previously accepted v0.11-style type constraints given as quoted strings. This legacy syntax is removed in Terraform v0.15. - To update an old-style type constraint to the modern syntax, start by - removing the quotes so that the argument is a bare keyword rather than - a string: + To update an old-style type constraint to the modern syntax, start by + removing the quotes so that the argument is a bare keyword rather than + a string: - ```hcl - variable "example" { - type = string - } - ``` + ```hcl + variable "example" { + type = string + } + ``` - Additionally, if the previous type constraint was either `"list"` or - `"map`", add a type argument to specify the element type of the collection. - Terraform v0.11 typically supported only collections of strings, so in - most cases you can set the element type to `string`: + Additionally, if the previous type constraint was either `"list"` or + `"map`", add a type argument to specify the element type of the collection. + Terraform v0.11 typically supported only collections of strings, so in + most cases you can set the element type to `string`: - ```hcl - variable "example" { - type = list(string) - } + ```hcl + variable "example" { + type = list(string) + } - variable "example" { - type = map(string) - } - ``` + variable "example" { + type = map(string) + } + ``` * In `lifecycle` blocks nested inside `resource` blocks, Terraform previously supported a legacy value `["*"]` for the `ignore_changes` argument, which is removed in Terraform v0.15. - Instead, use the `all` keyword to indicate that you wish to ignore changes - to all of the resource arguments: + Instead, use the `all` keyword to indicate that you wish to ignore changes + to all of the resource arguments: - ```hcl - lifecycle { - ignore_changes = all - } - ``` + ```hcl + lifecycle { + ignore_changes = all + } + ``` * Finally, Terraform v0.11 and earlier required all non-constant expressions to be written using string interpolation syntax, even if the result was @@ -296,7 +293,7 @@ Terraform's provider configuration scheme includes the idea of a "default" The `required_providers` block now has a new field for providers to indicate aliased configuration names, replacing the need for an empty "proxy configuration block" as a placeholder. In order to declare -[configuration aliases](/docs/language/modules/develop/providers.html#provider-aliases-within-modules), +[configuration aliases](/language/modules/develop/providers#provider-aliases-within-modules), add the desired names to the `configuration_aliases` argument for the provider requirements. @@ -388,18 +385,18 @@ event that your automation was relying on the limitations of the old mechanism: you can use the `TF_DATA_DIR` environment variable to specify the absolute path where Terraform should store its working directory internal state: - ```bash - TF_DATA_DIR="$PWD/.terraform" - ``` + ```bash + TF_DATA_DIR="$PWD/.terraform" + ``` * If your system uses `.tfvars` or `.tfvars.json` files either implicitly found or explicitly selected in the current working directory, you must either move those variables files into the root module directory or specify your files from elsewhere explicitly using the `-var-file` command line option: - ```bash - terraform plan -var-file="$PWD/example.tfvars" - ``` + ```bash + terraform plan -var-file="$PWD/example.tfvars" + ``` As a special case for backward compatibility, Terraform ensures that the language expression `path.cwd` will return the _original_ working directory, @@ -433,10 +430,10 @@ two possible workarounds available in the v0.15.0 release: * Run Terraform commands using the `-no-color` command line option to disable the terminal formatting sequences. - - This will cause the output to be unformatted plain text, but as a result - will avoid the output being interspersed with uninterpreted terminal - control sequences. + + This will cause the output to be unformatted plain text, but as a result + will avoid the output being interspersed with uninterpreted terminal + control sequences. * Alternatively, you can use Terraform v0.15.0 in various third-party virtual terminal implementations for older Windows versions, including @@ -459,11 +456,11 @@ cleanup of obsolete features and improved consistency: signal (`SIGINT` on Unix systems) will now cause Terraform to exit with a non-successful exit code. Previously it would, in some cases, exit with a success code. - - This signal is typically sent to Terraform when you press - Ctrl+C or similar interrupt keyboard shortcuts in an interactive terminal, - but might also be used by automation in order to gracefully cancel a - long-running Terraform operation. + + This signal is typically sent to Terraform when you press + Ctrl+C or similar interrupt keyboard shortcuts in an interactive terminal, + but might also be used by automation in order to gracefully cancel a + long-running Terraform operation. * The `-lock` and `-lock-timeout` options are no longer available for the `terraform init` command. Locking applies to operations that can potentially @@ -471,9 +468,9 @@ cleanup of obsolete features and improved consistency: don't try to run conflicting operations, but `terraform init` does not interact with any providers in order to possibly effect such changes. - These options didn't do anything in the `terraform init` command before, - and so you can remove them from any automated calls with no change - in behavior. + These options didn't do anything in the `terraform init` command before, + and so you can remove them from any automated calls with no change + in behavior. * The `-verify-plugins` and `-get-plugins` options to `terraform init` are no longer available. These have been non-functional since Terraform v0.13, @@ -482,18 +479,18 @@ cleanup of obsolete features and improved consistency: both require a `terraform init` but can also run without valid provider plugins installed. - If you were using these options in automated calls to `terraform init`, - remove them from the command line for compatibility with Terraform v0.15. - There is no longer an option to initialize without installing the - required provider plugins. + If you were using these options in automated calls to `terraform init`, + remove them from the command line for compatibility with Terraform v0.15. + There is no longer an option to initialize without installing the + required provider plugins. * The `terraform destroy` command no longer accepts the option `-force`. This was a previous name for the option in earlier Terraform versions, but we've since adopted `-auto-approve` for consistency with the `terraform apply` command. - If you are using `-force` in an automated call to `terraform destroy`, - change to using `-auto-approve` instead. + If you are using `-force` in an automated call to `terraform destroy`, + change to using `-auto-approve` instead. ## Azure Backend Removed Arguments @@ -501,7 +498,7 @@ In an earlier release the `azure` backend changed to remove the `arm_` prefix from a number of the configuration arguments: | Old Name | New Name | -|-----------------------|-------------------| +| --------------------- | ----------------- | | `arm_client_id` | `client_id` | | `arm_client_secret` | `client_secret` | | `arm_subscription_id` | `subscription_id` | diff --git a/website/upgrade-guides/0-7.html.markdown b/website/docs/language/upgrade-guides/0-7.mdx similarity index 93% rename from website/upgrade-guides/0-7.html.markdown rename to website/docs/language/upgrade-guides/0-7.mdx index e77dd2f18f9d..249cf7621097 100644 --- a/website/upgrade-guides/0-7.html.markdown +++ b/website/docs/language/upgrade-guides/0-7.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform 0.7" -sidebar_current: "upgrade-guides-0-7" -description: |- - Upgrading to Terraform v0.7 +page_title: Upgrading to Terraform 0.7 +description: Upgrading to Terraform v0.7 --- # Upgrading to Terraform v0.7 @@ -101,12 +98,12 @@ For most users, this change will not affect your day-to-day usage of Terraform. ## Migrating to Data Sources -With the addition of [Data Sources](/docs/language/data-sources/index.html), there are several resources that were acting as Data Sources that are now deprecated. Existing configurations will continue to work, but will print a deprecation warning when a data source is used as a resource. +With the addition of [Data Sources](/language/data-sources), there are several resources that were acting as Data Sources that are now deprecated. Existing configurations will continue to work, but will print a deprecation warning when a data source is used as a resource. - * `atlas_artifact` - * `template_file` - * `template_cloudinit_config` - * `tls_cert_request` +- `atlas_artifact` +- `template_file` +- `template_cloudinit_config` +- `tls_cert_request` Migrating to the equivalent Data Source is as simple as changing the `resource` keyword to `data` in your declaration and prepending `data.` to attribute references elsewhere in your config. diff --git a/website/upgrade-guides/0-8.html.markdown b/website/docs/language/upgrade-guides/0-8.mdx similarity index 96% rename from website/upgrade-guides/0-8.html.markdown rename to website/docs/language/upgrade-guides/0-8.mdx index 23c407ee84f4..ddecaf145834 100644 --- a/website/upgrade-guides/0-8.html.markdown +++ b/website/docs/language/upgrade-guides/0-8.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform 0.8" -sidebar_current: "upgrade-guides-0-8" -description: |- - Upgrading to Terraform v0.8 +page_title: Upgrading to Terraform 0.8 +description: Upgrading to Terraform v0.8 --- # Upgrading to Terraform v0.8 diff --git a/website/upgrade-guides/0-9.html.markdown b/website/docs/language/upgrade-guides/0-9.mdx similarity index 76% rename from website/upgrade-guides/0-9.html.markdown rename to website/docs/language/upgrade-guides/0-9.mdx index 158de20996af..3bb58ff1525d 100644 --- a/website/upgrade-guides/0-9.html.markdown +++ b/website/docs/language/upgrade-guides/0-9.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform 0.9" -sidebar_current: "upgrade-guides-0-9" -description: |- - Upgrading to Terraform v0.9 +page_title: Upgrading to Terraform 0.9 +description: Upgrading to Terraform v0.9 --- # Upgrading to Terraform v0.9 @@ -49,7 +46,7 @@ terraform { **Action:** Nothing immediately, everything will continue working except scripts using `terraform remote config`. -As soon as possible, [upgrade to backends](/docs/language/settings/backends/index.html). +As soon as possible, [upgrade to backends](/language/settings/backends). ## State Locking @@ -63,13 +60,13 @@ use these backends, you can ignore this section. Specific notes for each affected backend: - * **Amazon S3**: DynamoDB is used for locking. The AWS access keys - must have access to Dynamo. You may disable locking by omitting the - `lock_table` key in your backend configuration. +- **Amazon S3**: DynamoDB is used for locking. The AWS access keys + must have access to Dynamo. You may disable locking by omitting the + `lock_table` key in your backend configuration. - * **HashiCorp Consul**: Sessions are used for locking. If an auth token - is used it must have permissions to create and destroy sessions. You - may disable locking by specifying `lock = false` in your backend - configuration. +- **HashiCorp Consul**: Sessions are used for locking. If an auth token + is used it must have permissions to create and destroy sessions. You + may disable locking by specifying `lock = false` in your backend + configuration. **Action:** Update your credentials or configuration if necessary. diff --git a/website/upgrade-guides/1-0.html.markdown b/website/docs/language/upgrade-guides/1-0.mdx similarity index 52% rename from website/upgrade-guides/1-0.html.markdown rename to website/docs/language/upgrade-guides/1-0.mdx index 05425a659b6a..47892dae4591 100644 --- a/website/upgrade-guides/1-0.html.markdown +++ b/website/docs/language/upgrade-guides/1-0.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform v1.0" -sidebar_current: "upgrade-guides-1-0" -description: |- - Upgrading to Terraform v1.0 +page_title: Upgrading to Terraform v1.0 +description: Upgrading to Terraform v1.0 --- # Upgrading to Terraform v1.0 @@ -22,7 +19,7 @@ There are no special steps to take if you are upgrading from the previous major release, Terraform v0.15. You can also upgrade directly from Terraform v0.14 if you wish, although please -still consider the notes from [the Terraform v0.15 upgrade guide](0-15.html). +still consider the notes from [the Terraform v0.15 upgrade guide](/language/upgrade-guides/0-15). If you are affected by the notes in that upgrade guide, you will still need to take the steps described there but you can do so as part of upgrading to v1.0, without any need for an intermediate step of running Terraform v0.15. @@ -39,14 +36,14 @@ The following table summarizes the above recommendations. In each case, we recommend using the latest patch release from each major version in order to complete your upgrade. -| Current Version | Recommendation | -| -- | -- | -| v0.10 or earlier | Refer to the upgrade guides for these historical versions until you have upgraded to the latest v0.11 release, then refer to the following item. | -| v0.11 | Use [the `terraform 0.12checklist` command](0-12.html#pre-upgrade-checklist) to detect any situations that must be addressed before upgrading to v0.12, resolve them, and then upgrade to the latest v0.12 release and follow [the v0.12 Upgrade Guide](/upgrade-guides/0-12.html). | -| v0.12 | Upgrade to the latest Terraform v0.13 release and then follow [the v0.13 upgrade guide](0-13.html) to upgrade your configuration and state for explicit provider requirements. | -| v0.13 | Upgrade to the latest Terraform v0.14 release and attempt a normal Terraform run. If you encounter any new errors, refer to [the v0.14 upgrade guide](0-14.html) for resolution steps. | -| v0.14 | Upgrade directly to the latest Terraform v1.0 release and attempt a normal Terraform run. If you encounter any new errors, refer to [the v0.15 upgrade guide](0-15.html) for resolution steps. | -| v0.15 | Upgrade directly to the latest Terraform v1.0 release and attempt a normal Terraform run. Terraform v1.0 is a continuation of the v0.15 series, and so v1.0.0 and later are directly backward-compatible with Terraform v0.15.5. | +| Current Version | Recommendation | +| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| v0.10 or earlier | Refer to the upgrade guides for these historical versions until you have upgraded to the latest v0.11 release, then refer to the following item. | +| v0.11 | Use [the `terraform 0.12checklist` command](/language/upgrade-guides/0-12#pre-upgrade-checklist) to detect any situations that must be addressed before upgrading to v0.12, resolve them, and then upgrade to the latest v0.12 release and follow [the v0.12 Upgrade Guide](/language/upgrade-guides/0-12). | +| v0.12 | Upgrade to the latest Terraform v0.13 release and then follow [the v0.13 upgrade guide](/language/upgrade-guides/0-13) to upgrade your configuration and state for explicit provider requirements. | +| v0.13 | Upgrade to the latest Terraform v0.14 release and attempt a normal Terraform run. If you encounter any new errors, refer to [the v0.14 upgrade guide](/language/upgrade-guides/0-14) for resolution steps. | +| v0.14 | Upgrade directly to the latest Terraform v1.0 release and attempt a normal Terraform run. If you encounter any new errors, refer to [the v0.15 upgrade guide](/language/upgrade-guides/0-15) for resolution steps. | +| v0.15 | Upgrade directly to the latest Terraform v1.0 release and attempt a normal Terraform run. Terraform v1.0 is a continuation of the v0.15 series, and so v1.0.0 and later are directly backward-compatible with Terraform v0.15.5. | -> If you run into any problems during upgrading, please feel free to start a topic in [the Terraform community forum](https://discuss.hashicorp.com/c/terraform-core), @@ -57,7 +54,7 @@ may be able to reproduce it and offer advice. In a more complex system you might have multiple separate Terraform configurations that collaborate together using -[the `terraform_remote_state` data source](/docs/language/state/remote-state-data.html). +[the `terraform_remote_state` data source](/language/state/remote-state-data). In that case, it's typical for some configurations to be applied with a new version before others do, causing differences in the state snapshot format diff --git a/website/upgrade-guides/1-1.html.markdown b/website/docs/language/upgrade-guides/1-1.mdx similarity index 91% rename from website/upgrade-guides/1-1.html.markdown rename to website/docs/language/upgrade-guides/1-1.mdx index 2232e60538a5..faafcf147573 100644 --- a/website/upgrade-guides/1-1.html.markdown +++ b/website/docs/language/upgrade-guides/1-1.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrading to Terraform v1.1" -sidebar_current: "upgrade-guides-1-1" -description: |- - Upgrading to Terraform v1.1 +page_title: Upgrading to Terraform v1.1 +description: Upgrading to Terraform v1.1 --- # Upgrading to Terraform v1.1 @@ -13,14 +10,14 @@ baseline in Terraform v1.0, and so this release should not require any unusual upgrade steps for most users. However, if you are upgrading from a version earlier than v1.0 then please -refer to [the Terraform v1.0 upgrade guide](1-0.html) for how to upgrade through +refer to [the Terraform v1.0 upgrade guide](/language/upgrade-guides/1-0) for how to upgrade through the v0 releases to reach the v1 release series. Because v1.1 is backward-compatible with the v1.0 series, you can upgrade directly to the latest v1.1 release, skipping the v1.0 series entirely, at any point where the v1.0 upgrade guide calls for upgrading to Terraform v1.0. Terraform v1.1 continues to honor -[the Terraform v1.0 Compatibility Promises](/docs/language/v1-compatibility-promises.html), +[the Terraform v1.0 Compatibility Promises](/language/v1-compatibility-promises), but there are some behavior changes outside of those promises that may affect a small number of users, described in the following sections. @@ -44,7 +41,7 @@ supported, and Terraform CLI behavior on those earlier versions is undefined. [Microsoft has announced the deprecation of Azure AD Graph](https://docs.microsoft.com/en-us/graph/migrate-azure-ad-graph-faq), and so Terraform v1.1 marks the first phase of a deprecation process for -that legacy system in [the AzureRM state storage backend](/docs/language/settings/backends/azurerm.html). +that legacy system in [the AzureRM state storage backend](/language/settings/backends/azurerm). During the Terraform v1.1 release the default behavior is unchanged, but you can explicitly opt in to Microsoft Graph by setting @@ -78,7 +75,7 @@ therefore requires no special `-type=...` option. ## Changes to `terraform state mv` Terraform's local state storage backend supports a number of -[legacy command line options](/docs/language/settings/backends/local.html#command-line-arguments) +[legacy command line options](/language/settings/backends/local#command-line-arguments) for backward-compatibility with workflows from much older versions of Terraform, prior to the introduction of Backends. @@ -126,7 +123,7 @@ executable file representing a provider plugin, and didn't consider other files that might appear alongside in the plugin package. Terraform v1.1 now uses the same strategy for provider checking during apply as it does when verifying provider consistency against -[the dependency lock file](/docs/language/dependency-lock.html) +[the dependency lock file](/language/files/dependency-lock) during `terraform init`, which means `terraform apply` will return an error if it detects that _any_ of the files in a provider's plugin package have changed compared to when the plan was created. diff --git a/website/upgrade-guides/index.html.markdown b/website/docs/language/upgrade-guides/index.mdx similarity index 66% rename from website/upgrade-guides/index.html.markdown rename to website/docs/language/upgrade-guides/index.mdx index 49b28253f2c5..5d3c95166da8 100644 --- a/website/upgrade-guides/index.html.markdown +++ b/website/docs/language/upgrade-guides/index.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Upgrade Guides" -sidebar_current: "upgrade-guides" -description: |- - Upgrade Guides +page_title: Upgrade Guides +description: Upgrade Guides --- # Upgrade Guides diff --git a/website/docs/language/v1-compatibility-promises.html.md b/website/docs/language/v1-compatibility-promises.mdx similarity index 88% rename from website/docs/language/v1-compatibility-promises.html.md rename to website/docs/language/v1-compatibility-promises.mdx index a44a8b3f63ee..e475b8ec605b 100644 --- a/website/docs/language/v1-compatibility-promises.html.md +++ b/website/docs/language/v1-compatibility-promises.mdx @@ -1,7 +1,5 @@ --- -layout: "language" -page_title: "Terraform v1.0 Compatibility Promises" -sidebar_current: "docs-v1-compatibility" +page_title: Terraform v1.0 Compatibility Promises description: |- From Terraform v1.0 onwards the Terraform team promises to preserve backward compatibility for most of the Terraform language and the primary CLI @@ -68,35 +66,35 @@ The following top-level blocks and their defined "meta-arguments" (that is, arguments defined by Terraform Core rather than by external plugins such as providers) will retain their current functionality: -* [`resource`](/docs/language/resources/) and - [`data`](/docs/language/data-sources/) blocks to +* [`resource`](/language/resources) and + [`data`](/language/data-sources) blocks to declare resources, including their nested block types `lifecycle`, `connection`, and `provisioner`, and their meta-argument `provider`. -* [`module`](/docs/language/modules/syntax.html) blocks to call other modules, +* [`module`](/language/modules/syntax) blocks to call other modules, and its meta-argument `providers`. -* The [`count`](/docs/language/meta-arguments/count.html), - [`for_each`](/docs/language/meta-arguments/for_each.html), and - [`depends_on`](/docs/language/meta-arguments/depends_on.html) meta-arguments +* The [`count`](/language/meta-arguments/count), + [`for_each`](/language/meta-arguments/for_each), and + [`depends_on`](/language/meta-arguments/depends_on) meta-arguments in `resource`, `data`, and `module` blocks. -* [`provider`](/docs/language/providers/configuration.html) blocks to configure +* [`provider`](/language/providers/configuration) blocks to configure providers, and the `alias` meta-argument. -* [`variable`](/docs/language/values/variables.html#declaring-an-input-variable), - [`output`](/docs/language/values/outputs.html#declaring-an-output-value), and - [`locals`](/docs/language/values/locals.html#declaring-a-local-value) blocks +* [`variable`](/language/values/variables#declaring-an-input-variable), + [`output`](/language/values/outputs#declaring-an-output-value), and + [`locals`](/language/values/locals#declaring-a-local-value) blocks for declaring the various kinds of named values in a module. -* [`terraform`](/docs/language/settings/) blocks, including the nested - [`required_version`](/docs/language/settings/index.html#specifying-a-required-terraform-version) +* [`terraform`](/language/settings) blocks, including the nested + [`required_version`](/language/settings#specifying-a-required-terraform-version) and - [`required_providers`](/docs/language/providers/requirements.html#requiring-providers) + [`required_providers`](/language/providers/requirements#requiring-providers) arguments, and nested - [`backend`](/docs/language/settings/backends/configuration.html#using-a-backend-block) + [`backend`](/language/settings/backends/configuration#using-a-backend-block) blocks for backend configuration. We also intend to keep compatibility with all -[expression operators](/docs/language/expressions/) and -[built-in functions](/docs/language/functions/), with the exception of +[expression operators](/language/expressions) and +[built-in functions](/language/functions), with the exception of references to -[`terraform.workspace`](/docs/language/expressions/references.html#terraform-workspace), +[`terraform.workspace`](/language/expressions/references#terraform-workspace), whose behavior may change as part of future changes to the workspace model. We intend to retain broad compatibility with Terraform language features, with @@ -104,17 +102,17 @@ a few specific caveats: * We consider a configuration to be valid if Terraform can create and apply a plan for it without reporting any errors. - - A configuration that currently produces errors might generate different - errors or exhibit other non-error behaviors in a future version of - Terraform. A configuration that generates errors during the apply phase - might generate similar errors at an earlier phase in future, because - we generally consider it better to detect errors in as early a phase as - possible. - - Generally-speaking, the compatibility promises described in this document - apply only to valid configurations. Handling of invalid configurations is - always subject to change in future Terraform releases. + + A configuration that currently produces errors might generate different + errors or exhibit other non-error behaviors in a future version of + Terraform. A configuration that generates errors during the apply phase + might generate similar errors at an earlier phase in future, because + we generally consider it better to detect errors in as early a phase as + possible. + + Generally-speaking, the compatibility promises described in this document + apply only to valid configurations. Handling of invalid configurations is + always subject to change in future Terraform releases. * If the actual behavior of a feature differs from what we explicitly documented as the feature's behavior, we will usually treat that as a bug and change the feature to match the documentation, although we will avoid @@ -192,18 +190,18 @@ if you are still using a Terraform v1.x release. ### Provider Installation Methods Terraform normally installs providers from a provider registry implementing -[the Provider Registry Protocol](/docs/internals/provider-registry-protocol.html), +[the Provider Registry Protocol](/internals/provider-registry-protocol), version 1. All Terraform v1.x releases will remain compatible with that protocol, and so correctly-implemented provider registries will stay compatible. Terraform also supports installation of providers from -[local filesystem directories](/docs/cli/config/config-file.html#filesystem_mirror) +[local filesystem directories](/cli/config/config-file#filesystem_mirror) (filesystem mirrors) and from -[network mirrors](/docs/cli/config/config-file.html#network_mirror) -(implementing [the Provider Mirror Protocol](/docs/internals/provider-network-mirror-protocol.html). +[network mirrors](/cli/config/config-file#network_mirror) +(implementing [the Provider Mirror Protocol](/internals/provider-network-mirror-protocol). All Terraform v1.x releases will remain compatible with those installation methods, including -[the Implied Local Mirror Directories](/docs/cli/config/config-file.html#implied-local-mirror-directories). +[the Implied Local Mirror Directories](/cli/config/config-file#implied-local-mirror-directories). Specific provider registries or network mirrors are run independently from Terraform itself and so their own behaviors are not subject to these @@ -239,11 +237,11 @@ and of Terraform itself. ### Module Installation Methods Terraform supports installing child modules from a number of different -[module source types](/docs/language/modules/sources.html). We will continue +[module source types](/language/modules/sources). We will continue to support all of the existing source types throughout the v1.x releases. One of the supported source types is a module registry implementing -[the Module Registry Protocol](/docs/internals/module-registry-protocol.html) +[the Module Registry Protocol](/internals/module-registry-protocol) version 1. All Terraform v1.x releases will remain compatible with correct implementations of that protocol. @@ -286,6 +284,7 @@ For historical reasons, all supported state storage backends are included as part of Terraform CLI but not all are supported directly by the Terraform Team. Only the following backends maintained by the Terraform team are subject to compatibility promises: + * `local` (the default, when you are not using remote state) * `http` @@ -388,7 +387,7 @@ As noted above, compatibility with external software is limited to explicitly-machine-readable output (`-json` and `-raw` modes) and exit codes. Any natural-language output from these commands might change in later releases. -* [`init`](/docs/cli/commands/init.html) +* [`init`](/cli/commands/init) * `-backend=false` * `-backend-config=FILE` * `-backend-config="KEY=VALUE"` @@ -400,10 +399,10 @@ Any natural-language output from these commands might change in later releases. * `-plugin-dir=DIR` * `-reconfigure` * `-upgrade` -* [`validate`](/docs/cli/commands/validate.html) +* [`validate`](/cli/commands/validate) * `-json` * `-no-color` -* [`plan`](/docs/cli/commands/plan.html) +* [`plan`](/cli/commands/plan) * `-compact-warnings` * `-destroy` * `-detailed-exitcode` @@ -420,7 +419,7 @@ Any natural-language output from these commands might change in later releases. * `-target=ADDRESS` * `-var 'NAME=VALUE'` * `-var-file=FILE` -* [`apply`](/docs/cli/commands/apply.html) +* [`apply`](/cli/commands/apply) * `-auto-approve` * `-compact-warnings` * `-lock=false` @@ -435,53 +434,53 @@ Any natural-language output from these commands might change in later releases. * `-target=ADDRESS` * `-var 'NAME=VALUE'` * `-var-file=FILE` -* [`show`](/docs/cli/commands/show.html) +* [`show`](/cli/commands/show) * `-no-color` * `-json` * (both with and without a plan file) -* [`providers`](/docs/cli/commands/providers.html) (with no subcommand) -* [`providers lock`](/docs/cli/commands/providers/lock.html) +* [`providers`](/cli/commands/providers) (with no subcommand) +* [`providers lock`](/cli/commands/providers/lock) * `-fs-mirror=PATH` * `-net-mirror=URL` * `-platform=OS_ARCH` -* [`providers mirror`](/docs/cli/commands/providers/mirror.html) +* [`providers mirror`](/cli/commands/providers/mirror) * `-platform=OS_ARCH` -* [`providers schema`](/docs/cli/commands/providers/schema.html) +* [`providers schema`](/cli/commands/providers/schema) * `-json` -* [`fmt`](/docs/cli/commands/fmt.html) +* [`fmt`](/cli/commands/fmt) * `-list=false` * `-write=false` * `-diff` * `-recursive` * `-check` -* [`version`](/docs/cli/commands/version.html) +* [`version`](/cli/commands/version) * `-json` -* [`output`](/docs/cli/commands/output.html) +* [`output`](/cli/commands/output) * `-no-color` * `-json` * `-raw` -* [`taint`](/docs/cli/commands/taint.html) +* [`taint`](/cli/commands/taint) * `-allow-missing` * `-lock=false` * `-lock-timeout=DURATION` * `-ignore-remote-version` -* [`untaint`](/docs/cli/commands/untaint.html) +* [`untaint`](/cli/commands/untaint) * `-allow-missing` * `-lock=false` * `-lock-timeout=DURATION` * `-ignore-remote-version` -* [`force-unlock`](/docs/cli/commands/force-unlock.html) +* [`force-unlock`](/cli/commands/force-unlock) * `-force` -* [`state list`](/docs/cli/commands/state/list.html) +* [`state list`](/cli/commands/state/list) * `-id=ID` -* [`state pull`](/docs/cli/commands/state/pull.html) -* [`state push`](/docs/cli/commands/state/push.html) +* [`state pull`](/cli/commands/state/pull) +* [`state push`](/cli/commands/state/push) * `-force` * `-lock=false` * `-lock-timeout=DURATION` -* [`state show`](/docs/cli/commands/state/show.html) +* [`state show`](/cli/commands/state/show) * `-ignore-remote-version` -* [`login`](/docs/cli/commands/login.html) +* [`login`](/cli/commands/login) For commands or options not in the above list, we will still avoid breaking changes where possible, but can't promise full compatibility throughout the diff --git a/website/docs/language/values/index.html.md b/website/docs/language/values/index.html.md deleted file mode 100644 index 3074f965c80b..000000000000 --- a/website/docs/language/values/index.html.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: "language" -page_title: "Variables and Outputs" -description: "An overview of input variables, output values, and local values in Terraform language." ---- - -# Variables and Outputs - -The Terraform language includes a few kinds of blocks for requesting or -publishing named values. - -- [Input Variables](/docs/language/values/variables.html) serve as parameters for - a Terraform module, so users can customize behavior without editing the source. - -- [Output Values](/docs/language/values/outputs.html) are like return values for a - Terraform module. - -- [Local Values](/docs/language/values/locals.html) are a convenience feature for - assigning a short name to an expression. diff --git a/website/docs/language/values/index.mdx b/website/docs/language/values/index.mdx new file mode 100644 index 000000000000..d271492c3150 --- /dev/null +++ b/website/docs/language/values/index.mdx @@ -0,0 +1,20 @@ +--- +page_title: Variables and Outputs +description: >- + An overview of input variables, output values, and local values in Terraform + language. +--- + +# Variables and Outputs + +The Terraform language includes a few kinds of blocks for requesting or +publishing named values. + +- [Input Variables](/language/values/variables) serve as parameters for + a Terraform module, so users can customize behavior without editing the source. + +- [Output Values](/language/values/outputs) are like return values for a + Terraform module. + +- [Local Values](/language/values/locals) are a convenience feature for + assigning a short name to an expression. diff --git a/website/docs/language/values/locals.html.md b/website/docs/language/values/locals.mdx similarity index 74% rename from website/docs/language/values/locals.html.md rename to website/docs/language/values/locals.mdx index a487698bfce4..aa529f9fe3f5 100644 --- a/website/docs/language/values/locals.html.md +++ b/website/docs/language/values/locals.mdx @@ -1,25 +1,25 @@ --- -layout: "language" -page_title: "Local Values - Configuration Language" -sidebar_current: "docs-config-locals" -description: "Local values assign a name to an expression that can be used multiple times within a Terraform module." +page_title: Local Values - Configuration Language +description: >- + Local values assign a name to an expression that can be used multiple times + within a Terraform module. --- # Local Values > **Hands-on:** Try the [Simplify Terraform Configuration with -Locals](https://learn.hashicorp.com/tutorials/terraform/locals?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) -tutorial on HashiCorp Learn. +> Locals](https://learn.hashicorp.com/tutorials/terraform/locals?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) +> tutorial on HashiCorp Learn. -A local value assigns a name to an [expression](/docs/language/expressions/index.html), +A local value assigns a name to an [expression](/language/expressions), so you can use it multiple times within a module without repeating it. If you're familiar with traditional programming languages, it can be useful to compare Terraform modules to function definitions: -- [Input variables](./variables.html) are like function arguments. -- [Output values](./outputs.html) are like function return values. +- [Input variables](/language/values/variables) are like function arguments. +- [Output values](/language/values/outputs) are like function return values. - Local values are like a function's temporary local variables. -> **Note:** For brevity, local values are often referred to as just "locals" @@ -59,7 +59,7 @@ locals { ## Using Local Values Once a local value is declared, you can reference it in -[expressions](/docs/language/expressions/index.html) as `local.`. +[expressions](/language/expressions) as `local.`. -> **Note:** Local values are _created_ by a `locals` block (plural), but you _reference_ them as attributes on an object named `local` (singular). Make sure diff --git a/website/docs/language/values/outputs.html.md b/website/docs/language/values/outputs.mdx similarity index 87% rename from website/docs/language/values/outputs.html.md rename to website/docs/language/values/outputs.mdx index 824929fd5b6b..a06c8ffcb4f6 100644 --- a/website/docs/language/values/outputs.html.md +++ b/website/docs/language/values/outputs.mdx @@ -1,9 +1,6 @@ --- -layout: "language" -page_title: "Output Values - Configuration Language" -sidebar_current: "docs-config-outputs" -description: |- - Output values are the return values of a Terraform module. +page_title: Output Values - Configuration Language +description: Output values are the return values of a Terraform module. --- # Output Values @@ -13,8 +10,8 @@ command line, and can expose information for other Terraform configurations to use. Output values are similar to return values in programming languages. > **Hands-on:** Try the [Output Data From -Terraform](https://learn.hashicorp.com/tutorials/terraform/outputs) -tutorial on HashiCorp Learn. +> Terraform](https://learn.hashicorp.com/tutorials/terraform/outputs) +> tutorial on HashiCorp Learn. Output values have several uses: @@ -22,9 +19,9 @@ Output values have several uses: to a parent module. - A root module can use outputs to print certain values in the CLI output after running `terraform apply`. -- When using [remote state](/docs/language/state/remote.html), root module outputs can be +- When using [remote state](/language/state/remote), root module outputs can be accessed by other configurations via a - [`terraform_remote_state` data source](/docs/language/state/remote-state-data.html). + [`terraform_remote_state` data source](/language/state/remote-state-data). Resource instances managed by Terraform each export attributes whose values can be used elsewhere in configuration. Output values are a way to expose some @@ -45,11 +42,11 @@ output "instance_ip_addr" { ``` The label immediately after the `output` keyword is the name, which must be a -valid [identifier](/docs/language/syntax/configuration.html#identifiers). In a root module, this name is +valid [identifier](/language/syntax/configuration#identifiers). In a root module, this name is displayed to the user; in a child module, it can be used to access the output's value. -The `value` argument takes an [expression](/docs/language/expressions/index.html) +The `value` argument takes an [expression](/language/expressions) whose result is to be returned to the user. In this example, the expression refers to the `private_ip` attribute exposed by an `aws_instance` resource defined elsewhere in this module (not shown). Any valid expression is allowed @@ -156,10 +153,10 @@ value in the list of outputs at the end of `terraform apply`. However, the value could still display in the CLI output for other reasons, like if the value is referenced in an expression for a resource argument. -Terraform will still record sensitive values in the [state](/docs/language/state/index.html), +Terraform will still record sensitive values in the [state](/language/state), and so anyone who can access the state data will have access to the sensitive values in cleartext. For more information, see -[_Sensitive Data in State_](/docs/language/state/sensitive-data.html). +[_Sensitive Data in State_](/language/state/sensitive-data). @@ -175,7 +172,7 @@ correctly determine the dependencies between resources defined in different modules. Just as with -[resource dependencies](/docs/language/resources/behavior.html#resource-dependencies), +[resource dependencies](/language/resources/behavior#resource-dependencies), Terraform analyzes the `value` expression for an output value and automatically determines a set of dependencies, but in less-common cases there are dependencies that cannot be recognized implicitly. In these rare cases, the diff --git a/website/docs/language/values/variables.html.md b/website/docs/language/values/variables.mdx similarity index 87% rename from website/docs/language/values/variables.html.md rename to website/docs/language/values/variables.mdx index e1578a7d7645..fc8de6e4e629 100644 --- a/website/docs/language/values/variables.html.md +++ b/website/docs/language/values/variables.mdx @@ -1,8 +1,8 @@ --- -layout: "language" -page_title: "Input Variables - Configuration Language" -sidebar_current: "docs-config-variables" -description: "Input variables allow you to customize modules without altering their source code. Learn how to declare, define, and reference variables in configurations." +page_title: Input Variables - Configuration Language +description: >- + Input variables allow you to customize modules without altering their source + code. Learn how to declare, define, and reference variables in configurations. --- # Input Variables @@ -15,22 +15,22 @@ Terraform configurations, making your module composable and reusable. When you declare variables in the root module of your configuration, you can set their values using CLI options and environment variables. -When you declare them in [child modules](/docs/language/modules/index.html), +When you declare them in [child modules](/language/modules), the calling module should pass values in the `module` block. If you're familiar with traditional programming languages, it can be useful to compare Terraform modules to function definitions: -- Input variables are like function arguments. -- [Output values](./outputs.html) are like function return values. -- [Local values](./locals.html) are like a function's temporary local variables. +* Input variables are like function arguments. +* [Output values](/language/values/outputs) are like function return values. +* [Local values](/language/values/locals) are like a function's temporary local variables. -> **Note:** For brevity, input variables are often referred to as just "variables" or "Terraform variables" when it is clear from context what sort of variable is being discussed. Other kinds of variables in Terraform include _environment variables_ (set by the shell where Terraform runs) and _expression variables_ (used to indirectly represent a value in an -[expression](/docs/language/expressions/index.html)). +[expression](/language/expressions)). ## Declaring an Input Variable @@ -68,23 +68,23 @@ be unique among all variables in the same module. This name is used to assign a value to the variable from outside and to reference the variable's value from within the module. -The name of a variable can be any valid [identifier](/docs/language/syntax/configuration.html#identifiers) +The name of a variable can be any valid [identifier](/language/syntax/configuration#identifiers) _except_ the following: `source`, `version`, `providers`, `count`, `for_each`, `lifecycle`, `depends_on`, `locals`. These names are reserved for meta-arguments in -[module configuration blocks](/docs/language/modules/syntax.html), and cannot be +[module configuration blocks](/language/modules/syntax), and cannot be declared as variable names. ## Arguments Terraform CLI defines the following optional arguments for variable declarations: -- [`default`][inpage-default] - A default value which then makes the variable optional. -- [`type`][inpage-type] - This argument specifies what value types are accepted for the variable. -- [`description`][inpage-description] - This specifies the input variable's documentation. -- [`validation`][inpage-validation] - A block to define validation rules, usually in addition to type constraints. -- [`sensitive`][inpage-sensitive] - Limits Terraform UI output when the variable is used in configuration. -- [`nullable`][inpage-nullable] - Specify if the variable can be `null` within the module. +* [`default`][inpage-default] - A default value which then makes the variable optional. +* [`type`][inpage-type] - This argument specifies what value types are accepted for the variable. +* [`description`][inpage-description] - This specifies the input variable's documentation. +* [`validation`][inpage-validation] - A block to define validation rules, usually in addition to type constraints. +* [`sensitive`][inpage-sensitive] - Limits Terraform UI output when the variable is used in configuration. +* [`nullable`][inpage-nullable] - Specify if the variable can be `null` within the module. ### Default values @@ -101,7 +101,7 @@ configuration. [inpage-type]: #type-constraints The `type` argument in a `variable` block allows you to restrict the -[type of value](/docs/language/expressions/types.html) that will be accepted as +[type of value](/language/expressions/types) that will be accepted as the value for a variable. If no type constraint is set then a value of any type is accepted. @@ -128,7 +128,7 @@ collections: The keyword `any` may be used to indicate that any type is acceptable. For more information on the meaning and behavior of these different types, as well as detailed information about automatic conversion of complex types, see -[Type Constraints](/docs/language/expressions/types.html). +[Type Constraints](/language/expressions/types). If both the `type` and `default` arguments are specified, the given default value must be convertible to the specified type. @@ -182,7 +182,7 @@ The expression can refer only to the variable that the condition applies to, and _must not_ produce errors. If the failure of an expression is the basis of the validation decision, use -[the `can` function](/docs/language/functions/can.html) to detect such errors. For example: +[the `can` function](/language/functions/can) to detect such errors. For example: ```hcl variable "image_id" { @@ -217,10 +217,10 @@ Setting a variable as `sensitive` prevents Terraform from showing its value in the `plan` or `apply` output, when you use that variable elsewhere in your configuration. -Terraform will still record sensitive values in the [state](/docs/language/state/index.html), +Terraform will still record sensitive values in the [state](/language/state), and so anyone who can access the state data will have access to the sensitive values in cleartext. For more information, see -[_Sensitive Data in State_](/docs/language/state/sensitive-data.html). +[_Sensitive Data in State_](/language/state/sensitive-data). Declare a variable as sensitive by setting the `sensitive` argument to `true`: @@ -271,13 +271,13 @@ disclosing the content of one block might imply the content of a sibling block. ``` A provider can also -[declare an attribute as sensitive](/docs/extend/best-practices/sensitive-state.html#using-the-sensitive-flag), +[declare an attribute as sensitive](/plugin/sdkv2/best-practices/sensitive-state#using-the-sensitive-flag), which will cause Terraform to hide it from regular output regardless of how you assign it a value. For more information, see -[Sensitive Resource Attributes](/docs/language/expressions/references.html#sensitive-resource-attributes). +[Sensitive Resource Attributes](/language/expressions/references#sensitive-resource-attributes). If you use a sensitive value from as part of an -[output value](/docs/language/values/outputs.html) then Terraform will require +[output value](/language/values/outputs) then Terraform will require you to also mark the output value itself as sensitive, to confirm that you intended to export it. @@ -334,11 +334,10 @@ For variables of collection or structural types, such as lists or objects, the caller may still use `null` in nested elements or attributes, as long as the collection or structure itself is not null. - ## Using Input Variable Values Within the module that declared a variable, its value can be accessed from -within [expressions](/docs/language/expressions/index.html) as `var.`, +within [expressions](/language/expressions) as `var.`, where `` matches the label given in the declaration block: -> **Note:** Input variables are _created_ by a `variable` block, but you @@ -359,7 +358,7 @@ the module where it was declared. When variables are declared in the root module of your configuration, they can be set in a number of ways: -* [In a Terraform Cloud workspace](/docs/cloud/workspaces/variables.html). +* [In a Terraform Cloud workspace](/cloud-docs/workspaces/variables). * Individually, with the `-var` command line option. * In variable definitions (`.tfvars`) files, either specified on the command line or automatically loaded. @@ -368,7 +367,7 @@ can be set in a number of ways: The following sections describe these options in more detail. This section does not apply to _child_ modules, where values for input variables are instead assigned in the configuration of their parent module, as described in -[_Modules_](/docs/language/modules/index.html). +[_Modules_](/language/modules). ### Variables on the Command Line @@ -384,7 +383,7 @@ terraform apply -var='image_id_map={"us-east-1":"ami-abc123","us-east-2":"ami-de The above examples show appropriate syntax for Unix-style shells, such as on Linux or macOS. For more information on shell quoting, including additional examples for Windows Command Prompt, see -[Input Variables on the Command Line](/docs/cli/commands/plan.html#input-variables-on-the-command-line). +[Input Variables on the Command Line](/cli/commands/plan#input-variables-on-the-command-line). You can use the `-var` option multiple times in a single command to set several different variables. @@ -403,7 +402,7 @@ terraform apply -var-file="testing.tfvars" ``` -> **Note:** This is how Terraform Cloud passes -[workspace variables](/docs/cloud/workspaces/variables.html) to Terraform. +[workspace variables](/cloud-docs/workspaces/variables) to Terraform. A variable definitions file uses the same basic syntax as Terraform language files, but consists only of variable name assignments: @@ -457,7 +456,7 @@ and lower case letters as in the above example. When variable values are provided in a variable definitions file, you can use Terraform's usual syntax for -[literal expressions](/docs/language/expressions/types.html#literal-expressions) +[literal expressions](/language/expressions/types#literal-expressions) to assign complex-typed values, like lists and maps. Some special rules apply to the `-var` command line option and to environment @@ -483,7 +482,7 @@ For readability, and to avoid the need to worry about shell escaping, we recommend always setting complex variable values via variable definitions files. For more information on quoting and escaping for `-var` arguments, see -[Input Variables on the Command Line](/docs/cli/commands/plan.html#input-variables-on-the-command-line). +[Input Variables on the Command Line](/cli/commands/plan#input-variables-on-the-command-line). ### Values for Undeclared Variables @@ -516,7 +515,7 @@ Will cause Terraform to warn you that there is no variable declared `"mosse"`, w you spot this mistake. If you use `.tfvars` files across multiple configurations and expect to continue to see this warning, -you can use the [`-compact-warnings`](https://www.terraform.io/docs/cli/commands/plan.html#compact-warnings) +you can use the [`-compact-warnings`](/cli/commands/plan#compact-warnings) option to simplify your output. If you provide values for undeclared variables on the [command line](#variables-on-the-command-line), diff --git a/website/guides/index.html.md b/website/guides/index.mdx similarity index 86% rename from website/guides/index.html.md rename to website/guides/index.mdx index 987d38531c38..1e4ccedeac39 100644 --- a/website/guides/index.html.md +++ b/website/guides/index.mdx @@ -1,7 +1,5 @@ --- -layout: "intro" -page_title: "Guides" -sidebar_current: "guides-home" +page_title: Guides description: |- Welcome to the Terraform guides! The guides provide examples for common Terraform workflows and actions for both beginner and advanced Terraform @@ -11,7 +9,7 @@ description: |- # Terraform Guides Welcome to the Terraform guides section! If you are just getting started with -Terraform, please start with the [Terraform introduction](/intro/index.html) +Terraform, please start with the [Terraform introduction](/intro) instead and then continue on to the guides. The guides provide examples for common Terraform workflows and actions for both beginner and advanced Terraform users. diff --git a/website/guides/terraform-integration-program.html.md b/website/guides/terraform-integration-program.html.md deleted file mode 100644 index 56dea778e79e..000000000000 --- a/website/guides/terraform-integration-program.html.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -layout: "extend" -page_title: "Terraform Integration Program" -sidebar_current: "guides-terraform-integration-program" -description: The Terraform Integration Program allows prospect partners to create and publish Terraform integrations that have been verified by HashiCorp. ---- - -# Terraform Integration Program - -The Terraform Integration Program facilitates prospect partners in creating and publishing Terraform integrations that have been verified by HashiCorp. - -## Terraform Editions - -Terraform is an infrastructure as code (IaC) tool that allows you to build, change, and version infrastructure safely and efficiently. This includes low-level components such as compute instances, storage, and networking, as well as high-level components such as DNS entries, SaaS features, etc. Terraform can manage both existing service providers and custom in-house solutions. - -HashiCorp offers three editions of Terraform: Open Source, Terraform Cloud, and Terraform Enterprise. - -- [Terraform Open Source](https://www.terraform.io/) provides a consistent CLI workflow to manage hundreds of cloud services. Terraform codifies cloud APIs into declarative configuration files. -- [Terraform Cloud (TFC)](https://www.terraform.io/cloud) is a free to use, self-service SaaS platform that extends the capabilities of the open source Terraform CLI. It adds automation and collaboration features, and performs Terraform functionality remotely, making it ideal for collaborative and production environments. Terraform Cloud is available as a hosted service at https://app.terraform.io. Small teams can sign up for free to connect Terraform to version control, share variables, run Terraform in a stable remote environment, and securely store remote state. Paid tiers allow you to add more than five users, create teams with different levels of permissions, enforce policies before creating infrastructure, and collaborate more effectively. -- [Terraform Enterprise (TFE)](https://www.terraform.io/docs/enterprise/index.html) is our self-hosted distribution of Terraform Cloud with advanced security and compliance features. It offers enterprises a private instance that includes the advanced features available in Terraform Cloud. - -## Types of Terraform Integrations - -The Terraform ecosystem is designed to enable users to apply Terraform across different use cases and environments. The Terraform Integration Program current supports both workflow and integration partners (details below). Some partners can be both, depending on their use cases. - -- **Workflow Partners** build integrations for Terraform Cloud and/or Terraform Enterprise. Ideally, these partners are seeking to enable customers to use their existing platform within a Terraform Run. - -- **Infrastructure Partners** empower customers to leverage Terraform to manage resources exposed by their platform APIs. These are accessible to users of all Terraform editions. - -Our Workflow Partners typically have the following use cases: - -- **Code Scanning:** These partners provide tooling to review infrastructure as code configurations to prevent errors or security issues. -- **Cost Estimation:** These partners drive cost estimation of new deployment based on historical deployments. -- **Monitoring:** These partners provide performance visibility. -- **Zero Trust Security:** These partners help users create configurations to verify connections prior to providing access to an organization’s systems. -- **Audit:** These partners focus on maintaining code formatting, preventing security threats, and performing additional code analysis. -- **ITSM (Information Technology Service Management):** These partners focus on implementation, deployment, and delivery of IT workflows. -- **SSO (Single Sign On):** These partners focus on authentication for end users to securely sign on. -- **CI/CD:** These partners focus on continuous integration and continuous delivery/deployment. -- **VCS:** These partners focus on tracking and managing software code changes. - -Most workflow partners integrate with the Terraform workflow itself. Run tasks allow Terraform Cloud to execute tasks in external systems at specific points in the Terraform Cloud run lifecycle. This offers much more extensibility to Terraform Cloud customers, enabling them to integrate your services into the Terraform Cloud workflow. The beta release of this feature allows users to add and execute these tasks during the new pre-apply stage which exists in between the plan and apply stages. Eventually, we will open the entire workflow to Terraform Cloud users, including the pre-plan and post apply stages. Reference the [Terraform Cloud Integrations documentation](https://www.terraform.io/guides/terraform-integration-program.html#terraform-cloud-integrations) for more details. - -![Integration program diagram](/assets/images/docs/terraform-integration-program-diagram.png) - -Our Infrastructure Partners typically have the following use cases: - -- **Public Cloud:** These are large-scale, global cloud providers that offer a range of services including IaaS, SaaS, and PaaS. -- **Container Orchestration:** These partners help with container provisioning and deployment. -- **IaaS (Infrastructure-as-a-Service):** These are infrastructure and IaaS providers that offer solutions such as storage, networking, and virtualization. -- **Security & Authentication:** These are partners with authentication and security monitoring platforms. -- **Asset Management:** These partners offer asset management of key organization and IT resources, including software licenses, hardware assets, and cloud resources. -- **CI/CD:** These partners focus on continuous integration and continuous delivery/deployment. -- **Logging & Monitoring:** These partners offer the capability to configure and manage services such as loggers, metric tools, and monitoring services. -- **Utility:** These partners offer helper functionality, such as random value generation, file creation, http interactions, and time-based resources. -- **Cloud Automation:** These partners offer specialized cloud infrastructure automation management capabilities such as configuration management. -- **Data Management:** These partners focus on data center storage, backup, and recovery solutions. -- **Networking:** These partners integrate with network-specific hardware and virtualized products such as routing, switching, firewalls, and SD-WAN solutions. -- **VCS (Version Control Systems):** These partners focus on VCS (Version Control System) projects, teams, and repositories from within Terraform. -- **Comms & Messaging:** These partners integrate with communication, email, and messaging platforms. -- **Database:** These partners offer capabilities to provision and configure your database resources. -- **PaaS (Platform-as-a-Service):** These are platform and PaaS providers that offer a range of hardware, software, and application development tools. This category includes smaller-scale providers and those with more specialized offerings. -- **Web Services:** These partners focus on web hosting, web performance, CDN and DNS services. - -Infrastructure partners integrate by building and publishing a plugin called a Terraform [provider](https://www.terraform.io/docs/language/providers/index.html). Providers are executable binaries written in Go that communicate with Terraform Core over an RPC interface. The provider acts as a translation layer for transactions with external APIs, such as a public cloud service (AWS, GCP, Azure), a PaaS service (Heroku), a SaaS service (DNSimple, CloudFlare), or on-prem resources (vSphere). Providers work across Terraform OSS, Terraform Cloud and Terraform Enterprise. Refer to the [Terraform Provider Integrations documentation](https://www.terraform.io/guides/terraform-integration-program.html#terraform-provider-integrations) for more detail. - - - -## Terraform Provider Integrations - -You can follow the five steps. below to develop your provider alongside HashiCorp. This ensures that you can publish new versions with Terraform quickly and efficiently. - -![Provider Development Process](/assets/images/docs/provider-program-steps.png) - -1. **Prepare**: Develop integration using included resources -2. **Publish**: Publish provider to the Registry or plugin documentation -3. **Apply**: Apply to Technology Partnership Program -4. **Verify**: Verify integration with HashiCorp Alliances team -5. **Support**: Vendor provides ongoing maintenance and support - -We encourage you to follow the tasks associated with each step fully to streamline the development process and minimize rework. - -All providers integrate into and operate with Terraform exactly the same way. The table below is intended to help users understand who develops, and maintains a particular provider. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      TierDescriptionNamespace
      Official providers are owned and maintained by HashiCorp hashicorp
      Verified providers are owned and maintained by third-party technology partners. Providers in this tier indicate HashiCorp has verified the authenticity of the Provider’s publisher, and that the partner is a member of the HashiCorp Technology Partner Program.Third-party organization, e.g. cisco/aci
      Community providers are published to the Terraform Registry by individual maintainers, groups of maintainers, or other members of the Terraform community.
      Maintainer’s individual or organization account, e.g. cyrilgdn/postgresql
      Archived Providers are Official or Verified Providers that are no longer maintained by HashiCorp or the community. This may occur if an API is deprecated or interest was low.hashicorp or third-party
      - - -### 1. Prepare -To get started with the Terraform provider development, we recommend reviewing and following the articles listed below. -#### Provider Development Kit - -a) Writing custom providers [guide](https://www.terraform.io/guides/writing-custom-terraform-providers.html) - -b) Creating a Terraform Provider for Just About Anything: [video](https://www.youtube.com/watch?v=noxwUVet5RE) - -c) Sample provider developed by [partner](http://container-solutions.com/write-terraform-provider-part-1/) - -d) Example provider for reference: [AWS](https://github.com/terraform-providers/terraform-provider-aws), [OPC](https://github.com/terraform-providers/terraform-provider-opc) - -e) Contributing to Terraform [guidelines](https://github.com/hashicorp/terraform/blob/master/.github/CONTRIBUTING.md) - -f) HashiCorp developer [forum](https://discuss.hashicorp.com/c/terraform-providers/tf-plugin-sdk/43) - -Please submit questions or suggestions about the Terraform SDK and provider development to the HashiCorp Terraform plugin SDK forum. If you are new to provider development and would like assistance, you can leverage one of the following development agencies that have developed Terraform providers in the past: - -| Partner | Email | Website | -|--------------------|:-----------------------------|:---------------------| -| Crest Data Systems | malhar@crestdatasys.com | www.crestdatasys.com | -| DigitalOnUs | hashicorp@digitalonus.com | www.digitalonus.com | -| Akava | bd@akava.io | www.akava.io | -| OpenCredo | hashicorp@opencredo.com | www.opencredo.com | - -#### Provider License - -All Terraform providers listed as Verified must contain one of the following open source licenses: - -- CDDL 1.0, 2.0 -- CPL 1.0 -- Eclipse Public License (EPL) 1.0 -- MPL 1.0, 1.1, 2.0 -- PSL 2.0 -- Ruby's Licensing -- AFL 2.1, 3.0 -- Apache License 2.0 -- Artistic License 1.0, 2.0 -- Apache Software License (ASL) 1.1 -- Boost Software License -- BSD, BSD 3-clause, "BSD-new" -- CC-BY -- Microsoft Public License (MS-PL) -- MIT -### 2. Publish - -After your provider is complete and ready to release, you can publish it the integration to the [Terraform Registry](https://registry.terraform.io/). This makes it publicly available for all Terraform users. - -Follow the [Terraform Registry publishing documentation](https://www.terraform.io/docs/registry/providers/publishing.html) and review the [provider publishing learn guide](https://learn.hashicorp.com/tutorials/terraform/provider-release-publish?in=terraform/providers). If your company has multiple products with separate providers, we recommend publishing them under the same Github organization to help with discoverability. - -Once completed, your provider will be visible in the Terraform Registry and available to use in Terraform. Please confirm that everything looks correct and that documentation is rendering properly. - -### 3. Apply - -After your provider is published, connect with HashiCorp Alliances to onboard your integration to the HashiCorp technology ecosystem or [apply to become a technology partner](https://www.hashicorp.com/ecosystem/become-a-partner/#technology). - -### 4. Verify - -Work with your HashiCorp Alliances representative to verify the plugin within the Registry and become listed as an HashiCorp technology partner integration on HashiCorp website. - -### 5. Support - -Getting a new provider built and published to the Terraform Registry is just the first step towards enabling your users with a quality Terraform integration. Once a verified provider has been published, on-going effort is required to maintain the provider. - -HashiCorp Terraform has an extremely wide community of users and contributors and we encourage everyone to report issues however small, as well as help resolve them when possible. We expect that all verified provider publishers will continue to maintain the provider and address any issues users report in a timely manner. This includes resolving all critical issues within 48 hours and all other issues within 5 business days. HashiCorp reserves the right to remove verified status from any integration that is no longer being maintained. - -Vendors who choose not to support their provider and prefer to make it a community-supported provider will no longer be listed as Verified. - -## Terraform Cloud Integrations - -Run tasks allow Terraform Cloud to execute tasks in external systems at specific points in the Terraform Cloud run lifecycle. The beta release of this feature allows users to add and execute these tasks during the new pre-apply stage that exists in between the plan and apply stages. Tasks are executed by sending an API payload to the external system. This payload contains a collection of run-related information and a callback URL which the external system can use to send updates back to Terraform Cloud. - -The external system can then use this run information and respond back to Terraform Cloud with a passed or failed status. Terraform Cloud uses this status response to determine if a run should proceed, based on the task's enforcement settings within a workspace. - -Partners who successfully complete the Terraform Cloud Integration Checklist obtain a Terraform Cloud badge. This signifies HashiCorp has verified the integration and the partner is a member of the HashiCorp Technology Partner Program. - -- Note: Currently, pre-apply is the only integration phase available at this time. As of September 2021, run tasks are available only as a beta feature, are subject to change, and not all customers will see this functionality in their Terraform Cloud organization since this is currently enabled by default for our business tier customers of Terraform Cloud. If you have a customer that is interested in run tasks and are not a current Terraform Cloud for Business customer, customers can [sign up here](https://docs.google.com/forms/d/e/1FAIpQLSf3JJIkU05bKWov2wXa9c-QV524WNaHuGIk7xjHnwl5ceGw2A/viewform). - -![TFC Badge](/assets/images/docs/tfc-badge.png) - -The above badge will help drive visibility for the partner as well as provide better differentiation for joint customers. This badge will be available for partners to use at their digital properties (as per guidelines in the technology partner guide that partners receive when they join HashiCorp’s technology partner program). - -The Terraform Cloud Integration program has the following five steps. - -![RunTask Program Process](/assets/images/docs/runtask-program-steps.png) - -1. **Engage**: Sign up for the Technology Partner -Program -2. **Develop & Test**: Understand and build using the API integration for Run Tasks -3. **Review**: Review integration with HashiCorp Alliances team -4. **Release**: Provide documentation for your Integration -5. **Support**: Vendor provides ongoing maintanance and support - -### 1. Engage - -For partners who are new to working with Hashicorp, we recommend [signing up for our Technology Partner Program](https://www.hashicorp.com/go/tech-partner). To understand more about the program, check out our “[Become a Partner](https://www.hashicorp.com/partners/become-a-partner)” page. - -### 2. Develop & Test -Partners should build an integration using [Run Task APIs in Terraform Cloud](https://www.terraform.io/docs/cloud/api/run-tasks.html). To better understand how run Task enhances the workflow, see diagram listed below and check out our [announcement about Terraform run Task](https://www.hashicorp.com/blog/terraform-cloud-run-tasks-beta-now-available). [Snyk](https://docs.snyk.io/features/integrations/ci-cd-integrations/integrating-snyk-with-terraform-cloud), for example, created an integration to detect configuration anomalies in code while reducing risk to the infrastructure. For additional API resources, [click here](https://www.terraform.io/docs/cloud/api/index.html). -**Currently, pre-apply is the only integration phase available.** - -![RunTask Diagram](/assets/images/docs/runtask-diagram.png) - -### 3. Review - -Schedule time with your Partner Alliance manager to review your integration. The review should include enabling the integration on the partner’s platform and Terraform Cloud, explaining the use case for the integration, and a live demonstration of the functionality. If you are unable to engage with your Partner Alliances manager, you can also reach out to [technologypartners@hashicorp.com](technologypartners@hashicorp.com). - -### 4. Release - -We add new partners to the [Terraform Run Task page](https://www.terraform.io/docs/cloud/integrations/run-tasks/index.html#run-tasks-technology-partners) after the integration review and documentation is complete. On this page, you will provide a two-line summary about your integration(s). If you have multiple integrations, we highly recommend creating a summary that highlights all potential integration options. - -You must provide documentation that helps users get started with your integration. You also need to provide documentation for our support team, including points of contact, email address, FAQ and/or best practices. We want to ensure end users are able to reach the right contacts for internal HashiCorp support when working with customers. - -### 5. Support - -At HashiCorp, we view the release step to be the beginning of the journey. Getting the integration built is just the first step in enabling users to leverage it against their infrastructure. On-going effort is required to support and maintain it after you complete the initial development. - -We expect that partners will create a mechanism to track and resolve all critical issues as soon as possible (ideally within 48 hours) and all other issues within 5 business days. This is a requirement given the critical nature of Terraform Cloud to a customer’s operation. If you choose not to support your integration, we cannot consider it Verified and will not list it on the Terraform documentation website. - --> Contact us at technologypartners@hashicorp.com with any questions or feedback. diff --git a/website/guides/terraform-provider-development-program.html.md b/website/guides/terraform-provider-development-program.mdx similarity index 56% rename from website/guides/terraform-provider-development-program.html.md rename to website/guides/terraform-provider-development-program.mdx index 59d5ffc645d1..102446672bba 100644 --- a/website/guides/terraform-provider-development-program.html.md +++ b/website/guides/terraform-provider-development-program.mdx @@ -1,8 +1,9 @@ --- -layout: "extend" -page_title: "Terraform Provider Development Program" -sidebar_current: "guides-terraform-provider-development-program" -description: This guide is intended for vendors who're interested in having their platform supported by Terraform. The guide walks vendors through the steps involved in creating a provider and applying for it to be included with Terraform. +page_title: Terraform Provider Development Program +description: >- + This guide is intended for vendors who're interested in having their platform + supported by Terraform. The guide walks vendors through the steps involved in + creating a provider and applying for it to be included with Terraform. --- # Terraform Provider Development Program @@ -11,10 +12,9 @@ The Terraform Provider Development Program facilitates vendors in creating and p The Verified badge helps users easily identify and discover integrations developed and maintained directly by an integration’s vendor, establishing a level of trust for our users. This program is intended to be largely self-serve, with links to information sources, clearly defined steps, and checkpoints detailed below. -![Verified Provider Card](/assets/images/docs/verified-card.png) - --> **Building your own provider?** If you're building your own provider and aren't interested in having HashiCorp officially verify and regularly monitor your provider, please refer to the [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_medium=WEB_IOhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_offer=ARTICLE_PAGEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_content=DOCS) collection on HashiCorp Learn and the [Extending Terraform](https://www.terraform.io/docs/extend/index.html) section of the documentation. +![Verified Provider Card](/img/docs/verified-card.png) +-> **Building your own provider?** If you're building your own provider and aren't interested in having HashiCorp officially verify and regularly monitor your provider, please refer to the [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_medium=WEB_IOhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_offer=ARTICLE_PAGEhttps://www.terraform.io/docs/extend/writing-custom-providers.htmlutm_content=DOCS) collection on HashiCorp Learn and the [Extending Terraform](/plugin) section of the documentation. ## What is a Terraform Provider? @@ -24,72 +24,41 @@ A Terraform Provider represents an integration that is responsible for understan All providers integrate into and operate with Terraform exactly the same way. The table below is intended to help users understand who develops, and maintains a particular provider. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      TierDescriptionNamespace
      Official providers are owned and maintained by HashiCorp hashicorp
      Verified providers are owned and maintained by third-party technology partners. Providers in this tier indicate HashiCorp has verified the authenticity of the Provider’s publisher, and that the partner is a member of the HashiCorp Technology Partner Program.Third-party organization, e.g. mongodb/mongodbatlas
      Community providers are published to the Terraform Registry by individual maintainers, groups of maintainers, or other members of the Terraform community.
      Maintainer’s individual or organization account, e.g. DeviaVir/gsuite
      Archived Providers are Official or Verified Providers that are no longer maintained by HashiCorp or the community. This may occur if an API is deprecated or interest was low.hashicorp or third-party
      +

      - --> **Note:** This document focuses on the "Verified" Tier in the table above. Community contributors interested in contributing to existing providers or building new providers should refer to the [Publishing a Provider](https://www.terraform.io/docs/registry/providers/publishing.html) section of our documentation. - +-> **Note:** This document focuses on the "Verified" Tier in the table above. Community contributors interested in contributing to existing providers or building new providers should refer to the [Publishing a Provider](/registry/providers/publishing) section of our documentation. ## Provider Development Process The provider development process is divided into five steps below. By following these steps, providers can be developed alongside HashiCorp to ensure new providers are able to be published in Terraform as quickly as possible. -![Provider Development Process](/assets/images/docs/program-steps.png) +![Provider Development Process](/img/docs/program-steps.png) 1. **Apply**: Initial contact between vendor and HashiCorp -2. **Prepare**: Follow documentation while developing the provider -3. **Verify**: Share public GPG key with HashiCorp -4. **Publish**: Release the provider on the Registry -5. **Support**: Ongoing maintenance and support of the provider by the vendor. +1. **Prepare**: Follow documentation while developing the provider +1. **Verify**: Share public GPG key with HashiCorp +1. **Publish**: Release the provider on the Registry +1. **Support**: Ongoing maintenance and support of the provider by the vendor. ### 1. Apply -Please begin by completing our HashiCorp Technology Partner application: https://www.hashicorp.com/ecosystem/become-a-partner/#technology +Please begin by completing our HashiCorp Technology Partner application: Terraform has a large and active ecosystem of partners that may have already started working on the same provider. We'll do our best to connect similar parties to avoid duplicate efforts, and prepare for a successful and impactful launch of the integration. Once you have applied, a member of the HashiCorp Alliances team will be in touch, and will ask for your organization to sign our Technology Partner Agreement. - ### 2. Prepare -Detailed instructions for preparing a provider for publishing are available in our Registry documentation. Please see [Preparing your Provider](https://www.terraform.io/docs/registry/providers/publishing.html#preparing-your-provider). In order to provide a consistent and quality experience for users, please make sure detailed documentation for your provider is included. You can find more information on how to build and structure [provider documentation here](https://www.terraform.io/docs/registry/providers/docs.html). +Detailed instructions for preparing a provider for publishing are available in our Registry documentation. Please see [Preparing your Provider](/registry/providers/publishing#preparing-your-provider). In order to provide a consistent and quality experience for users, please make sure detailed documentation for your provider is included. You can find more information on how to build and structure [provider documentation here](/registry/providers/docs). We’ve found the provider development process to be fairly straightforward and simple when you pay close attention and follow the resources below. If you have not developed a provider before and are looking for some help in developing one, you may choose to leverage one of the following development agencies which have developed Terraform providers in the past and are familiar with the requirements and process: -| Partner | Email | Website | -|--------------------|:-----------------------------|:---------------------| -| Crest Data Systems | malhar@crestdatasys.com | www.crestdatasys.com | -| DigitalOnUs | hashicorp@digitalonus.com | www.digitalonus.com | -| Akava | bd@akava.io | www.akava.io | -| OpenCredo | hashicorp@opencredo.com | www.opencredo.com | +| Partner | Email | Website | +| ------------------ | :-------------------------- | :-------------------------------------------------- | +| Crest Data Systems | | [www.crestdatasys.com](http://www.crestdatasys.com) | +| DigitalOnUs | | [www.digitalonus.com](http://www.digitalonus.com) | +| Akava | | [www.akava.io](http://www.akava.io) | +| OpenCredo | | [www.opencredo.com](http://www.opencredo.com) | -> **Important:** All Terraform providers listed as Verified must contain one of the following open source licenses: @@ -109,14 +78,13 @@ We’ve found the provider development process to be fairly straightforward and - Microsoft Public License (MS-PL) - MIT - ### 3. Verify At this stage, it is expected that the provider is fully developed, all tests and documentation are in place, and your provider is ready for publishing. In this step, HashiCorp will verify the source and authenticity of the namespace being used to publish the provider by signing your GPG key with a trust signature. -> **Important:** This step requires that you have signed and accepted our Technology Partner Agreement. If you have not received this, please see step #1 above. -Please send your public key to terraform-registry@hashicorp.com, indicating you are a partner seeking verification, and a HashiCorp employee will be in touch to help verify, and add your key. +Please send your public key to , indicating you are a partner seeking verification, and a HashiCorp employee will be in touch to help verify, and add your key. To export your public key in ASCII-armor format, use the following command: @@ -126,7 +94,7 @@ $ gpg --armor --export "{Key ID or email address}" ### 4. Publish -Once the verification step is complete please follow the steps on [Publishing a Provider](https://www.terraform.io/docs/registry/providers/publishing.html). This step does not require additional involvement from HashiCorp as publishing is a fully self-service process in the [Terraform Registry](https://registry.terraform.io). +Once the verification step is complete please follow the steps on [Publishing a Provider](/registry/providers/publishing). This step does not require additional involvement from HashiCorp as publishing is a fully self-service process in the [Terraform Registry](https://registry.terraform.io). Once completed, your provider should be visible in the Terraform Registry and usable in Terraform. Please confirm that everything looks good, and that documentation is rendering properly. diff --git a/website/guides/core-workflow.html.md b/website/intro/core-workflow.mdx similarity index 93% rename from website/guides/core-workflow.html.md rename to website/intro/core-workflow.mdx index 2cd010ee58e6..62afc53dc3d4 100644 --- a/website/guides/core-workflow.html.md +++ b/website/intro/core-workflow.mdx @@ -1,9 +1,6 @@ --- -layout: "intro" -page_title: "The Core Terraform Workflow - Guides" -sidebar_current: "guides-core-workflow" -description: |- - An overview of how individuals, teams, and organizations can use Terraform. +page_title: The Core Terraform Workflow - Guides +description: 'An overview of how individuals, teams, and organizations can use Terraform. ' --- # The Core Terraform Workflow @@ -11,8 +8,8 @@ description: |- The core Terraform workflow has three steps: 1. **Write** - Author infrastructure as code. -2. **Plan** - Preview changes before applying. -3. **Apply** - Provision reproducible infrastructure. +1. **Plan** - Preview changes before applying. +1. **Apply** - Provision reproducible infrastructure. This guide walks through how each of these three steps plays out in the context of working as an individual practitioner, how they evolve when a team is @@ -184,7 +181,7 @@ requests should include an attached copy of speculative plan output generated by the change author. Others arrange for their CI system to post speculative plan output to pull requests automatically. -![Screenshot of Pull Request with manually posted Terraform plan output](guides/core-workflow/manually-pasted-plan-output.png) +![Screenshot of Pull Request with manually posted Terraform plan output](/img/docs/manually-pasted-plan-output.png) In addition to reviewing the plan for the proper expression of its author's intent, the team can also make an evaluation whether they want this change to @@ -233,7 +230,7 @@ for a better experience at each step. Terraform Cloud provides a centralized and secure location for storing input variables and state while also bringing back a tight feedback loop for speculative plans for config authors. Terraform configuration interacts with -Terraform Cloud via the ["remote" backend](/docs/language/settings/backends/remote.html). +Terraform Cloud via the ["remote" backend](/language/settings/backends/remote). ``` terraform { @@ -283,14 +280,14 @@ request indicate while the plan is in progress. Once the plan is complete, the status update indicates whether there were any changes in the speculative plan, right from the pull request view. -![Screenshot of Pull Request with resource changes in the status update](guides/core-workflow/pull-request.png) +![Screenshot of Pull Request with resource changes in the status update](/img/docs/pull-request.png) For certain types of changes, this information is all that's needed for a team member to be able to approve the pull request. When a teammate needs to do a full review of the plan, clicking the link to Terraform Cloud brings up a view that allows them to quickly analyze the full plan details. -![Screenshot of Pull Request run in Terraform Cloud](guides/core-workflow/pr-plan.png) +![Screenshot of Pull Request run in Terraform Cloud](/img/docs/pr-plan.png) This page allows the reviewer to quickly determine if the plan is matching the config author's intent and evaluate the risk of the change. @@ -300,17 +297,17 @@ config author's intent and evaluate the risk of the change. After merge, Terraform Cloud presents the concrete plan to the team for review and approval. -![Screenshot of concrete plan](guides/core-workflow/concrete-plan.png) +![Screenshot of concrete plan](/img/docs/concrete-plan.png) The team can discuss any outstanding questions about the plan before the change is made. -![Screenshot of back-and-forth in Terraform Cloud comments](guides/core-workflow/plan-comments.png) +![Screenshot of back-and-forth in Terraform Cloud comments](/img/docs/plan-comments.png) Once the Apply is confirmed, Terraform Cloud displays the progress live to anyone who'd like to watch. -![Screenshot of in-progress Apply](guides/core-workflow/in-progress-apply.png) +![Screenshot of in-progress Apply](/img/docs/in-progress-apply.png) **Note:** This data source is implemented by a built-in provider, whose -[source address](/language/providers/requirements#source-addresses) -is `terraform.io/builtin/terraform`. That provider does not include any other -resources or data sources. +-> **Warning:** To access remote state outputs in Terraform Cloud or Terraform Enterprise, we recommend using the [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs). The `tfe_outputs` method is more secure because it does not require full access to state of a workspace to fetch the outputs. If you are using the [Terraform Cloud CLI integration](/docs/cli/cloud), you **must** use `tfe_outputs` because the integration is incompatible with `terraform_remote_state`. ## Alternative Ways to Share Data Between Configurations @@ -94,12 +90,6 @@ post-processing such as JSON decoding. You can then change that module later if you switch to a different strategy for sharing data between multiple Terraform configurations. -## Usage with Terraform Cloud/Enterprise - -When trying to access remote state outputs in Terraform Cloud/Enterprise, it is recommended to use the `tfe_outputs` data source in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) instead of relying the `terraform_remote_state` data source. - -See the [full documentation](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) for the `tfe_outputs` data source for more details. - ## Example Usage (`remote` Backend) ```hcl From f8fdb6de3f9bf2b2664ca845954094224b63369a Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Wed, 5 Jan 2022 11:28:47 +0000 Subject: [PATCH 478/644] do not use pointer addr strings as map keys in set When creating a Set of BasicEdges, the Hashcode function is used to determine map keys for the underlying set data structure. The string hex representation of the two vertices' pointers is unsafe to use as a map key, since these addresses may change between the time they are added to the set and the time the set is operated on. Instead we modify the Hashcode function to maintain the references to the underlying vertices so they cannot be garbage collected during the lifetime of the Set. --- internal/dag/edge.go | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/internal/dag/edge.go b/internal/dag/edge.go index f0d99ee3a610..8c78924bbde5 100644 --- a/internal/dag/edge.go +++ b/internal/dag/edge.go @@ -1,9 +1,5 @@ package dag -import ( - "fmt" -) - // Edge represents an edge in the graph, with a source and target vertex. type Edge interface { Source() Vertex @@ -25,7 +21,7 @@ type basicEdge struct { } func (e *basicEdge) Hashcode() interface{} { - return fmt.Sprintf("%p-%p", e.S, e.T) + return [...]interface{}{e.S, e.T} } func (e *basicEdge) Source() Vertex { From df36a03be10a460eb84477e7bccb576c0869d196 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 5 Jan 2022 12:29:20 -0500 Subject: [PATCH 479/644] states: Add failing test for ordered dependencies --- internal/states/instance_object_test.go | 37 +++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 internal/states/instance_object_test.go diff --git a/internal/states/instance_object_test.go b/internal/states/instance_object_test.go new file mode 100644 index 000000000000..f8be9743ed83 --- /dev/null +++ b/internal/states/instance_object_test.go @@ -0,0 +1,37 @@ +package states + +import ( + "testing" + + "github.com/google/go-cmp/cmp" + "github.com/hashicorp/terraform/internal/addrs" + "github.com/zclconf/go-cty/cty" +) + +func TestResourceInstanceObject_encode(t *testing.T) { + value := cty.ObjectVal(map[string]cty.Value{ + "foo": cty.True, + }) + deps := []addrs.ConfigResource{ + addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "honk"), + addrs.RootModule.Child("child").Resource(addrs.ManagedResourceMode, "test", "flub"), + addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "boop"), + } + wantDeps := []addrs.ConfigResource{ + addrs.RootModule.Child("child").Resource(addrs.ManagedResourceMode, "test", "flub"), + addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "boop"), + addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "honk"), + } + rio := &ResourceInstanceObject{ + Value: value, + Status: ObjectPlanned, + Dependencies: deps, + } + rios, err := rio.Encode(value.Type(), 0) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } + if diff := cmp.Diff(wantDeps, rios.Dependencies); diff != "" { + t.Errorf("wrong result for deps\n%s", diff) + } +} From 6704f8c795195db717a21b05b80b1007a38496f2 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 22 Dec 2021 16:47:15 -0800 Subject: [PATCH 480/644] Initial work on a new package build process For the moment this is just an experimental additional sidecar package build process, separate from the one we really use for releases, so that we can get some experience building in the GitHub Actions environment before hopefully eventually switching to using the artifacts from this process as the packages we'll release through the official release channels. It will react to any push to one of our release branches or to a release tag by building official-release-like .zip, .deb, and .rpm packages, along with Docker images, based on the content of the corresponding commit. For the moment this doesn't actually produce _shippable_ packages because in particular it doesn't know how to update our version/version.go file to hard-code the correct version number. Once Go 1.18 is release and we've upgraded to it we'll switch to using debug.ReadBuildInfo to determine our version number at runtime and so no longer need to directly update a source file for each release, but that functionality isn't yet available in our current Go 1.17 release. --- .github/workflows/build-Dockerfile | 41 ++++++ .github/workflows/build.yml | 209 +++++++++++++++++++++++++++++ 2 files changed, 250 insertions(+) create mode 100644 .github/workflows/build-Dockerfile create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build-Dockerfile b/.github/workflows/build-Dockerfile new file mode 100644 index 000000000000..6f8f15853a42 --- /dev/null +++ b/.github/workflows/build-Dockerfile @@ -0,0 +1,41 @@ +# This Dockerfile is not intended for general use, but is rather used to +# produce our "light" release packages as part of our official release +# pipeline. +# +# If you want to test this locally you'll need to set the three arguments +# to values realistic for what the hashicorp/actions-docker-build GitHub +# action would set, and ensure that there's a suitable "terraform" executable +# in the dist/linux/${TARGETARCH} directory. + +FROM docker.mirror.hashicorp.services/alpine:latest AS default + +# This is intended to be run from the hashicorp/actions-docker-build GitHub +# action, which sets these appropriately based on context. +ARG PRODUCT_VERSION=UNSPECIFIED +ARG PRODUCT_REVISION=UNSPECIFIED +ARG BIN_NAME=terraform + +# This argument is set by the Docker toolchain itself, to the name +# of the CPU architecture we're building an image for. +# Our caller should've extracted the corresponding "terraform" executable +# into dist/linux/${TARGETARCH} for us to use. +ARG TARGETARCH + +LABEL maintainer="HashiCorp Terraform Team " + +# New standard version label. +LABEL version=$VERSION + +# Historical Terraform-specific label preserved for backward compatibility. +LABEL "com.hashicorp.terraform.version"="${VERSION}" + +RUN apk add --no-cache git openssh + +# The hashicorp/actions-docker-build GitHub Action extracts the appropriate +# release package for our target architecture into the current working +# directory before running "docker build", which we'll then copy into the +# Docker image to make sure that we use an identical binary as all of the +# other official release channels. +COPY ["dist/linux/${TARGETARCH}/terraform", "/bin/terraform"] + +ENTRYPOINT ["/bin/terraform"] diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000000..c2f2092bada2 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,209 @@ +name: Build Terraform CLI Packages + +# If you want to test changes to this file before merging to a main branch, +# push them up to a branch whose name has the prefix "build-workflow-dev/", +# which is a special prefix that triggers this workflow even though it's not +# actually a release branch. + +on: + workflow_dispatch: + push: + branches: + - main + - 'v[0-9]+.[0-9]+' + - build-workflow-dev/* + tags: + - 'v[0-9]+.[0-9]+.[0-9]+*' + +env: + PKG_NAME: "terraform" + +jobs: + get-product-version: + name: "Determine intended Terraform version" + runs-on: ubuntu-latest + outputs: + product-version: ${{ steps.get-product-version.outputs.product-version }} + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 # Need all commits and tags to find a reasonable version number + - name: Decide version number + id: get-product-version + run: | + git describe --first-parent + echo "::set-output name=product-version::$(git describe --first-parent)" + + get-go-version: + name: "Determine Go toolchain version" + runs-on: ubuntu-latest + outputs: + go-version: ${{ steps.get-go-version.outputs.go-version }} + steps: + - uses: actions/checkout@v2 + - name: Determine Go version + id: get-go-version + # We use .go-version as our source of truth for current Go + # version, because "goenv" can react to it automatically. + run: | + echo "Building with Go $(cat .go-version)" + echo "::set-output name=go-version::$(cat .go-version)" + + generate-metadata-file: + name: "Generate release metadata" + needs: get-product-version + runs-on: ubuntu-latest + outputs: + filepath: ${{ steps.generate-metadata-file.outputs.filepath }} + steps: + - uses: actions/checkout@v2 + - name: Generate package metadata + id: generate-metadata-file + uses: hashicorp/actions-generate-metadata@main + with: + version: ${{ needs.get-product-version.outputs.product-version }} + product: ${{ env.PKG_NAME }} + + - uses: actions/upload-artifact@v2 + with: + name: metadata.json + path: ${{ steps.generate-metadata-file.outputs.filepath }} + + build: + needs: ["get-product-version", "get-go-version"] + runs-on: ubuntu-latest + strategy: + matrix: + include: + - {goos: "freebsd", goarch: "386"} + - {goos: "freebsd", goarch: "amd64"} + - {goos: "freebsd", goarch: "arm"} + - {goos: "linux", goarch: "386"} + - {goos: "linux", goarch: "amd64"} + - {goos: "linux", goarch: "arm"} + - {goos: "linux", goarch: "arm64"} + - {goos: "openbsd", goarch: "386"} + - {goos: "openbsd", goarch: "amd64"} + - {goos: "solaris", goarch: "amd64"} + - {goos: "windows", goarch: "386"} + - {goos: "windows", goarch: "amd64"} + fail-fast: false + + name: Build for ${{ matrix.goos }}_${{ matrix.goarch }} + + steps: + - uses: actions/checkout@v2 + + - name: Install Go toolchain + uses: actions/setup-go@v2 + with: + go-version: ${{ needs.get-go-version.outputs.go-version }} + + - name: Build + env: + GOOS: ${{ matrix.goos }} + GOARCH: ${{ matrix.goarch }} + run: | + mkdir dist out + go build -o dist/ . + zip -r -j out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip dist/ + + - uses: actions/upload-artifact@v2 + with: + name: ${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip + path: out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip + + - name: Linux distribution packages + if: ${{ matrix.goos == 'linux' }} + uses: hashicorp/package@v1 + with: + name: "terraform" + description: "Terraform enables you to safely and predictably create, change, and improve infrastructure. It is an open source tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned." + arch: ${{ matrix.goarch }} + version: ${{ needs.get-product-version.outputs.product-version }} + maintainer: "HashiCorp" + homepage: "https://terraform.io/" + license: "MPL-2.0" + binary: "dist/${{ env.PKG_NAME }}" + deb_depends: "git" + rpm_depends: "git" + + - name: Gather Linux distribution package filenames + if: ${{ matrix.goos == 'linux' }} + run: | + echo "RPM_PACKAGE=$(basename out/*.rpm)" >> $GITHUB_ENV + echo "DEB_PACKAGE=$(basename out/*.deb)" >> $GITHUB_ENV + + - uses: actions/upload-artifact@v2 + if: ${{ matrix.goos == 'linux' }} + with: + name: ${{ env.RPM_PACKAGE }} + path: out/${{ env.RPM_PACKAGE }} + + - uses: actions/upload-artifact@v2 + if: ${{ matrix.goos == 'linux' }} + with: + name: ${{ env.DEB_PACKAGE }} + path: out/${{ env.DEB_PACKAGE }} + + build-darwin: + needs: ["get-product-version", "get-go-version"] + runs-on: macos-latest + strategy: + matrix: + include: + - {goos: "darwin", goarch: "amd64"} + - {goos: "darwin", goarch: "arm64"} + fail-fast: false + + name: Build for ${{ matrix.goos }}_${{ matrix.goarch }} + + env: + GOOS: ${{ matrix.goos }} + GOARCH: ${{ matrix.goarch }} + + steps: + - uses: actions/checkout@v2 + + - name: Install Go toolchain + uses: actions/setup-go@v2 + with: + go-version: ${{ needs.get-go-version.outputs.go-version }} + + - name: Build + run: | + mkdir dist out + go build -o dist/ + zip -r -j out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip dist/ + + - uses: actions/upload-artifact@v2 + with: + name: ${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip + path: out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip + + build-docker: + name: Build Docker image for linux_${{ matrix.arch }} + needs: + - get-product-version + - build + runs-on: ubuntu-latest + strategy: + matrix: + arch: ["amd64"] + fail-fast: false + env: + repo: ${{github.event.repository.name}} + version: ${{needs.get-product-version.outputs.product-version}} + + steps: + - uses: actions/checkout@v2 + - name: Build Docker images + uses: hashicorp/actions-docker-build@v1 + with: + version: ${{env.version}} + target: default + arch: ${{matrix.arch}} + dockerfile: .github/workflows/build-Dockerfile + tags: | + docker.io/hashicorp/${{env.repo}}:${{env.version}} + 986891699432.dkr.ecr.us-east-1.amazonaws.com/hashicorp/${{env.repo}}:${{env.version}} From b802db75d73a14a2458113525246555caecb107c Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 23 Dec 2021 09:10:59 -0800 Subject: [PATCH 481/644] build: Build and run e2etest as part of the release build pipeline This uses the decoupled build and run strategy to run the e2etests so that we can arrange to run the tests against the real release packages produced elsewhere in this workflow, rather than ones generated just in time by the test harness. The modifications to make-archive.sh here make it more consistent with its originally-intended purpose of producing a harness for testing "real" release executables. Our earlier compromise of making it include its own terraform executable came from a desire to use that script as part of manual cross-platform testing when we weren't yet set up to support automation of those tests as we're doing here. That does mean, however, that the terraform-e2etest package content must be combined with content from a terraform release package in order to produce a valid contest for running the tests. We use a single job to cross-compile the test harness for all of the supported platforms, because that build is relatively fast and so not worth the overhead of matrix build, but then use a matrix build to actually run the tests so that we can run them in a worker matching the target platform. We currently have access only to amd64 (x64) runners in GitHub Actions and so for the moment this process is limited only to the subset of our supported platforms which use that architecture. --- .github/workflows/build.yml | 207 +++++++++++++++++- internal/command/e2etest/main_test.go | 25 ++- internal/command/e2etest/make-archive.sh | 13 +- internal/command/e2etest/primary_test.go | 4 +- internal/command/e2etest/provider_dev_test.go | 8 + .../command/e2etest/provider_plugin_test.go | 8 + .../command/e2etest/providers_tamper_test.go | 16 +- .../e2etest/provisioner_plugin_test.go | 8 + 8 files changed, 268 insertions(+), 21 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c2f2092bada2..ee7dc5369e8c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -28,11 +28,22 @@ jobs: - uses: actions/checkout@v2 with: fetch-depth: 0 # Need all commits and tags to find a reasonable version number + - name: Git Describe + id: git-describe + run: | + git describe --first-parent + echo "::set-output name=raw-version::$(git describe --first-parent)" - name: Decide version number id: get-product-version + shell: bash + env: + RAW_VERSION: ${{ steps.git-describe.outputs.raw-version }} run: | - git describe --first-parent - echo "::set-output name=product-version::$(git describe --first-parent)" + echo "::set-output name=product-version::${RAW_VERSION#v}" + - name: Report chosen version number + run: | + [ -n "${{steps.get-product-version.outputs.product-version}}" ] + echo "::notice title=Terraform CLI Version::${{ steps.get-product-version.outputs.product-version }}" get-go-version: name: "Determine Go toolchain version" @@ -207,3 +218,195 @@ jobs: tags: | docker.io/hashicorp/${{env.repo}}:${{env.version}} 986891699432.dkr.ecr.us-east-1.amazonaws.com/hashicorp/${{env.repo}}:${{env.version}} + + e2etest-build: + name: Build e2etest for ${{ matrix.goos }}_${{ matrix.goarch }} + needs: ["get-go-version"] + runs-on: ubuntu-latest + strategy: + matrix: + # We build test harnesses only for the v1.0 Compatibility Promises + # supported platforms. Even within that set, we can only run on + # architectures for which we have GitHub Actions runners available, + # which is currently only amd64 (x64). + # TODO: GitHub Actions does support _self-hosted_ arm and arm64 + # runners, so we could potentially run some ourselves to run our + # tests there, but at the time of writing there is no documented + # support for darwin_arm64 (macOS on Apple Silicon). + include: + - {goos: "darwin", goarch: "amd64"} + #- {goos: "darwin", goarch: "arm64"} + - {goos: "windows", goarch: "amd64"} + - {goos: "linux", goarch: "amd64"} + #- {goos: "linux", goarch: "arm"} + #- {goos: "linux", goarch: "arm64"} + fail-fast: false + + env: + build_script: ./internal/command/e2etest/make-archive.sh + + steps: + - uses: actions/checkout@v2 + + - name: Install Go toolchain + uses: actions/setup-go@v2 + with: + go-version: ${{ needs.get-go-version.outputs.go-version }} + + - name: Build test harness package + env: + GOOS: ${{ matrix.goos }} + GOARCH: ${{ matrix.goarch }} + run: | + bash ./internal/command/e2etest/make-archive.sh + + - uses: actions/upload-artifact@v2 + with: + name: terraform-e2etest_${{ matrix.goos }}_${{ matrix.goarch }}.zip + path: internal/command/e2etest/build/terraform-e2etest_${{ matrix.goos }}_${{ matrix.goarch }}.zip + if-no-files-found: error + + e2etest-linux: + name: e2etest for linux_${{ matrix.goarch }} + runs-on: ubuntu-latest + needs: + - get-product-version + - build + - e2etest-build + + strategy: + matrix: + include: + - {goarch: "amd64"} + #- {goarch: "arm64"} + #- {goarch: "arm"} + fail-fast: false + + env: + os: linux + arch: ${{ matrix.goarch }} + version: ${{needs.get-product-version.outputs.product-version}} + + steps: + # NOTE: This intentionally _does not_ check out the source code + # for the commit/tag we're building, because by now we should + # have everything we need in the combination of CLI release package + # and e2etest package for this platform. (This helps ensure that we're + # really testing the release package and not inadvertently testing a + # fresh build from source.) + - name: "Download e2etest package" + uses: actions/download-artifact@v2 + id: e2etestpkg + with: + name: terraform-e2etest_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: "Download Terraform CLI package" + uses: actions/download-artifact@v2 + id: clipkg + with: + name: terraform_${{env.version}}_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: Extract packages + run: | + unzip "./terraform-e2etest_${{ env.os }}_${{ env.arch }}.zip" + unzip "./terraform_${{env.version}}_${{ env.os }}_${{ env.arch }}.zip" + - name: Run E2E Tests + run: | + TF_ACC=1 ./e2etest -test.v + + e2etest-darwin: + name: e2etest for darwin_${{ matrix.goarch }} + runs-on: macos-latest + needs: + - get-product-version + - build-darwin + - e2etest-build + + strategy: + matrix: + include: + - {goarch: "amd64"} + #- {goarch: "arm64"} + fail-fast: false + + env: + os: darwin + arch: ${{ matrix.goarch }} + version: ${{needs.get-product-version.outputs.product-version}} + + steps: + # NOTE: This intentionally _does not_ check out the source code + # for the commit/tag we're building, because by now we should + # have everything we need in the combination of CLI release package + # and e2etest package for this platform. (This helps ensure that we're + # really testing the release package and not inadvertently testing a + # fresh build from source.) + - name: "Download e2etest package" + uses: actions/download-artifact@v2 + id: e2etestpkg + with: + name: terraform-e2etest_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: "Download Terraform CLI package" + uses: actions/download-artifact@v2 + id: clipkg + with: + name: terraform_${{env.version}}_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: Extract packages + run: | + unzip "./terraform-e2etest_${{ env.os }}_${{ env.arch }}.zip" + unzip "./terraform_${{env.version}}_${{ env.os }}_${{ env.arch }}.zip" + - name: Run E2E Tests + run: | + TF_ACC=1 ./e2etest -test.v + + e2etest-windows: + name: e2etest for windows_${{ matrix.goarch }} + runs-on: windows-latest + needs: + - get-product-version + - build + - e2etest-build + + strategy: + matrix: + include: + - {goarch: "amd64"} + fail-fast: false + + env: + os: windows + arch: ${{ matrix.goarch }} + version: ${{needs.get-product-version.outputs.product-version}} + + steps: + # NOTE: This intentionally _does not_ check out the source code + # for the commit/tag we're building, because by now we should + # have everything we need in the combination of CLI release package + # and e2etest package for this platform. (This helps ensure that we're + # really testing the release package and not inadvertently testing a + # fresh build from source.) + - name: "Download e2etest package" + uses: actions/download-artifact@v2 + id: e2etestpkg + with: + name: terraform-e2etest_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: "Download Terraform CLI package" + uses: actions/download-artifact@v2 + id: clipkg + with: + name: terraform_${{env.version}}_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: Extract packages + shell: pwsh + run: | + Expand-Archive -LiteralPath 'terraform-e2etest_${{ env.os }}_${{ env.arch }}.zip' -DestinationPath '.' + Expand-Archive -LiteralPath 'terraform_${{env.version}}_${{ env.os }}_${{ env.arch }}.zip' -DestinationPath '.' + - name: Run E2E Tests + env: + TF_ACC: 1 + shell: cmd + run: | + e2etest.exe -test.v diff --git a/internal/command/e2etest/main_test.go b/internal/command/e2etest/main_test.go index 01e20a9820e0..3c9ba5a5e1b6 100644 --- a/internal/command/e2etest/main_test.go +++ b/internal/command/e2etest/main_test.go @@ -11,6 +11,18 @@ import ( var terraformBin string +// canRunGoBuild is a short-term compromise to account for the fact that we +// have a small number of tests that work by building helper programs using +// "go build" at runtime, but we can't do that in our isolated test mode +// driven by the make-archive.sh script. +// +// FIXME: Rework this a bit so that we build the necessary helper programs +// (test plugins, etc) as part of the initial suite setup, and in the +// make-archive.sh script, so that we can run all of the tests in both +// situations with the tests just using the executable already built for +// them, as we do for terraformBin. +var canRunGoBuild bool + func TestMain(m *testing.M) { teardown := setup() code := m.Run() @@ -21,10 +33,10 @@ func TestMain(m *testing.M) { func setup() func() { if terraformBin != "" { // this is pre-set when we're running in a binary produced from - // the make-archive.sh script, since that builds a ready-to-go - // binary into the archive. However, we do need to turn it into - // an absolute path so that we can find it when we change the - // working directory during tests. + // the make-archive.sh script, since that is for testing an + // executable obtained from a real release package. However, we do + // need to turn it into an absolute path so that we can find it + // when we change the working directory during tests. var err error terraformBin, err = filepath.Abs(terraformBin) if err != nil { @@ -38,6 +50,11 @@ func setup() func() { // Make the executable available for use in tests terraformBin = tmpFilename + // Tests running in the ad-hoc testing mode are allowed to use "go build" + // and similar to produce other test executables. + // (See the comment on this variable's declaration for more information.) + canRunGoBuild = true + return func() { os.Remove(tmpFilename) } diff --git a/internal/command/e2etest/make-archive.sh b/internal/command/e2etest/make-archive.sh index 8fabe2f7a2cd..040633b5dd9a 100755 --- a/internal/command/e2etest/make-archive.sh +++ b/internal/command/e2etest/make-archive.sh @@ -13,9 +13,12 @@ # and then executed as follows: # set TF_ACC=1 # ./e2etest.exe -# Since the test archive includes both the test fixtures and the compiled -# terraform executable along with this test program, the result is -# self-contained and does not require a local Go compiler on the target system. +# +# Because separated e2etest harnesses are intended for testing against "real" +# release executables, the generated archives don't include a copy of +# the Terraform executable. Instead, the caller of the tests must retrieve +# and extract a release package into the working directory before running +# the e2etest executable, so that "e2etest" can find and execute it. set +euo pipefail @@ -33,10 +36,6 @@ mkdir -p "$OUTDIR" # We need the test fixtures available when we run the tests. cp -r testdata "$OUTDIR/testdata" -# Bundle a copy of our binary so the target system doesn't need the go -# compiler installed. -go build -o "$OUTDIR/terraform$GOEXE" github.com/hashicorp/terraform - # Build the test program go test -o "$OUTDIR/e2etest$GOEXE" -c -ldflags "-X github.com/hashicorp/terraform/internal/command/e2etest.terraformBin=./terraform$GOEXE" github.com/hashicorp/terraform/internal/command/e2etest diff --git a/internal/command/e2etest/primary_test.go b/internal/command/e2etest/primary_test.go index 4081d2d4f044..de4ad95b2c8a 100644 --- a/internal/command/e2etest/primary_test.go +++ b/internal/command/e2etest/primary_test.go @@ -204,13 +204,13 @@ func TestPrimaryChdirOption(t *testing.T) { } gotOutput := state.RootModule().OutputValues["cwd"] - wantOutputValue := cty.StringVal(tf.Path()) // path.cwd returns the original path, because path.root is how we get the overridden path + wantOutputValue := cty.StringVal(filepath.ToSlash(tf.Path())) // path.cwd returns the original path, because path.root is how we get the overridden path if gotOutput == nil || !wantOutputValue.RawEquals(gotOutput.Value) { t.Errorf("incorrect value for cwd output\ngot: %#v\nwant Value: %#v", gotOutput, wantOutputValue) } gotOutput = state.RootModule().OutputValues["root"] - wantOutputValue = cty.StringVal(tf.Path("subdir")) // path.root is a relative path, but the text fixture uses abspath on it. + wantOutputValue = cty.StringVal(filepath.ToSlash(tf.Path("subdir"))) // path.root is a relative path, but the text fixture uses abspath on it. if gotOutput == nil || !wantOutputValue.RawEquals(gotOutput.Value) { t.Errorf("incorrect value for root output\ngot: %#v\nwant Value: %#v", gotOutput, wantOutputValue) } diff --git a/internal/command/e2etest/provider_dev_test.go b/internal/command/e2etest/provider_dev_test.go index 8c52c2909b72..1aac10bcd5c6 100644 --- a/internal/command/e2etest/provider_dev_test.go +++ b/internal/command/e2etest/provider_dev_test.go @@ -18,6 +18,14 @@ import ( // we normally do, so they can just overwrite the same local executable // in-place to iterate faster. func TestProviderDevOverrides(t *testing.T) { + if !canRunGoBuild { + // We're running in a separate-build-then-run context, so we can't + // currently execute this test which depends on being able to build + // new executable at runtime. + // + // (See the comment on canRunGoBuild's declaration for more information.) + t.Skip("can't run without building a new provider executable") + } t.Parallel() tf := e2e.NewBinary(terraformBin, "testdata/provider-dev-override") diff --git a/internal/command/e2etest/provider_plugin_test.go b/internal/command/e2etest/provider_plugin_test.go index 585818b1b243..c8ac7fe3f699 100644 --- a/internal/command/e2etest/provider_plugin_test.go +++ b/internal/command/e2etest/provider_plugin_test.go @@ -13,6 +13,14 @@ import ( // TestProviderProtocols verifies that Terraform can execute provider plugins // with both supported protocol versions. func TestProviderProtocols(t *testing.T) { + if !canRunGoBuild { + // We're running in a separate-build-then-run context, so we can't + // currently execute this test which depends on being able to build + // new executable at runtime. + // + // (See the comment on canRunGoBuild's declaration for more information.) + t.Skip("can't run without building a new provider executable") + } t.Parallel() tf := e2e.NewBinary(terraformBin, "testdata/provider-plugin") diff --git a/internal/command/e2etest/providers_tamper_test.go b/internal/command/e2etest/providers_tamper_test.go index 03026354a5b5..0c285c1f2002 100644 --- a/internal/command/e2etest/providers_tamper_test.go +++ b/internal/command/e2etest/providers_tamper_test.go @@ -41,12 +41,16 @@ func TestProviderTampering(t *testing.T) { seedDir := tf.WorkDir() const providerVersion = "3.1.0" // must match the version in the fixture config - pluginDir := ".terraform/providers/registry.terraform.io/hashicorp/null/" + providerVersion + "/" + getproviders.CurrentPlatform.String() - pluginExe := pluginDir + "/terraform-provider-null_v" + providerVersion + "_x5" + pluginDir := filepath.Join(".terraform", "providers", "registry.terraform.io", "hashicorp", "null", providerVersion, getproviders.CurrentPlatform.String()) + pluginExe := filepath.Join(pluginDir, "terraform-provider-null_v"+providerVersion+"_x5") if getproviders.CurrentPlatform.OS == "windows" { pluginExe += ".exe" // ugh } + // filepath.Join here to make sure we get the right path separator + // for whatever OS we're running these tests on. + providerCacheDir := filepath.Join(".terraform", "providers") + t.Run("cache dir totally gone", func(t *testing.T) { tf := e2e.NewBinary(terraformBin, seedDir) defer tf.Close() @@ -61,7 +65,7 @@ func TestProviderTampering(t *testing.T) { if err == nil { t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) } - if want := `registry.terraform.io/hashicorp/null: there is no package for registry.terraform.io/hashicorp/null 3.1.0 cached in .terraform/providers`; !strings.Contains(stderr, want) { + if want := `registry.terraform.io/hashicorp/null: there is no package for registry.terraform.io/hashicorp/null 3.1.0 cached in ` + providerCacheDir; !strings.Contains(stderr, want) { t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) } if want := `terraform init`; !strings.Contains(stderr, want) { @@ -128,7 +132,7 @@ func TestProviderTampering(t *testing.T) { if err == nil { t.Fatalf("unexpected plan success\nstdout:\n%s", stdout) } - if want := `registry.terraform.io/hashicorp/null: the cached package for registry.terraform.io/hashicorp/null 3.1.0 (in .terraform/providers) does not match any of the checksums recorded in the dependency lock file`; !strings.Contains(stderr, want) { + if want := `registry.terraform.io/hashicorp/null: the cached package for registry.terraform.io/hashicorp/null 3.1.0 (in ` + providerCacheDir + `) does not match any of the checksums recorded in the dependency lock file`; !strings.Contains(stderr, want) { t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) } if want := `terraform init`; !strings.Contains(stderr, want) { @@ -237,7 +241,7 @@ func TestProviderTampering(t *testing.T) { if err == nil { t.Fatalf("unexpected apply success\nstdout:\n%s", stdout) } - if want := `registry.terraform.io/hashicorp/null: there is no package for registry.terraform.io/hashicorp/null 3.1.0 cached in .terraform/providers`; !strings.Contains(stderr, want) { + if want := `registry.terraform.io/hashicorp/null: there is no package for registry.terraform.io/hashicorp/null 3.1.0 cached in ` + providerCacheDir; !strings.Contains(stderr, want) { t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) } }) @@ -260,7 +264,7 @@ func TestProviderTampering(t *testing.T) { if err == nil { t.Fatalf("unexpected apply success\nstdout:\n%s", stdout) } - if want := `registry.terraform.io/hashicorp/null: the cached package for registry.terraform.io/hashicorp/null 3.1.0 (in .terraform/providers) does not match any of the checksums recorded in the dependency lock file`; !strings.Contains(stderr, want) { + if want := `registry.terraform.io/hashicorp/null: the cached package for registry.terraform.io/hashicorp/null 3.1.0 (in ` + providerCacheDir + `) does not match any of the checksums recorded in the dependency lock file`; !strings.Contains(stderr, want) { t.Errorf("missing expected error message\nwant substring: %s\ngot:\n%s", want, stderr) } }) diff --git a/internal/command/e2etest/provisioner_plugin_test.go b/internal/command/e2etest/provisioner_plugin_test.go index 4220df574e3c..4ee75f9ceb7a 100644 --- a/internal/command/e2etest/provisioner_plugin_test.go +++ b/internal/command/e2etest/provisioner_plugin_test.go @@ -12,6 +12,14 @@ import ( // TestProvisionerPlugin is a test that terraform can execute a 3rd party // provisioner plugin. func TestProvisionerPlugin(t *testing.T) { + if !canRunGoBuild { + // We're running in a separate-build-then-run context, so we can't + // currently execute this test which depends on being able to build + // new executable at runtime. + // + // (See the comment on canRunGoBuild's declaration for more information.) + t.Skip("can't run without building a new provisioner executable") + } t.Parallel() // This test reaches out to releases.hashicorp.com to download the From 218e55b23cf19cb55183617ee68b86d6cc363c14 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 3 Jan 2022 10:03:00 -0800 Subject: [PATCH 482/644] build: Build docs source package as part of the release pipeline This should eventually grow to be a step that actually verifies the validity of the docs source prior to publishing the artifact that a downstream publishing pipeline can consume, but for the moment it's really just a placeholder since we have no such validation step and no downstream pipeline consuming this artifact. The general idea here is that the artifacts from this workflow should be sufficient for all downstream release steps to occur without any direct access to the Terraform CLI repository, and so this is intended to eventually meet that ideal but as of this commit the website docs publishing step _does_ still depend on direct access to this repository. --- .github/workflows/build.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ee7dc5369e8c..dd28e27daa65 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -410,3 +410,26 @@ jobs: shell: cmd run: | e2etest.exe -test.v + + docs-source-package: + name: "Build documentation bundle" + runs-on: ubuntu-latest + needs: + - get-product-version + + env: + version: ${{needs.get-product-version.outputs.product-version}} + + steps: + - uses: actions/checkout@v2 + # FIXME: We should include some sort of pre-validation step here, to + # confirm that the doc content is mechanically valid so that the + # publishing pipeline will be able to render all content without errors. + - name: "Create documentation source bundle" + run: | + (cd website && zip -9 -r ../terraform-cli-docs-source_${{ env.version }}.zip .) + - uses: actions/upload-artifact@v2 + with: + name: terraform-cli-docs-source_${{ env.version }}.zip + path: terraform-cli-docs-source_${{ env.version }}.zip + if-no-files-found: error From 3bf758eaf5e0b381a902bdda82a4e583d7844cb8 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 3 Jan 2022 10:27:42 -0800 Subject: [PATCH 483/644] build: Consolidate build-darwin job into just "build" We can use an extra matrix dimension to select which execution environment we'll use for each GOOS/GOARCH pair, and thus avoid duplicating the job definition for darwin just to set runs-on: macos-latest for it. This is not really an intended use of a matrix dimension because it's directly related to the existing "goos" one, rather than being an independent third dimension, but it doesn't matter in practice because we're using the "include" option to specify exact combinations, and thus we're not relying on the built-in functionality to generate all possible matrix combinations. --- .github/workflows/build.yml | 89 +++++++++++++++---------------------- 1 file changed, 35 insertions(+), 54 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index dd28e27daa65..825a6a1dad03 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -62,10 +62,11 @@ jobs: generate-metadata-file: name: "Generate release metadata" - needs: get-product-version runs-on: ubuntu-latest + needs: get-product-version outputs: filepath: ${{ steps.generate-metadata-file.outputs.filepath }} + steps: - uses: actions/checkout@v2 - name: Generate package metadata @@ -81,27 +82,31 @@ jobs: path: ${{ steps.generate-metadata-file.outputs.filepath }} build: - needs: ["get-product-version", "get-go-version"] - runs-on: ubuntu-latest + name: Build for ${{ matrix.goos }}_${{ matrix.goarch }} + runs-on: ${{ matrix.runson }} + needs: + - get-product-version + - get-go-version + strategy: matrix: include: - - {goos: "freebsd", goarch: "386"} - - {goos: "freebsd", goarch: "amd64"} - - {goos: "freebsd", goarch: "arm"} - - {goos: "linux", goarch: "386"} - - {goos: "linux", goarch: "amd64"} - - {goos: "linux", goarch: "arm"} - - {goos: "linux", goarch: "arm64"} - - {goos: "openbsd", goarch: "386"} - - {goos: "openbsd", goarch: "amd64"} - - {goos: "solaris", goarch: "amd64"} - - {goos: "windows", goarch: "386"} - - {goos: "windows", goarch: "amd64"} + - {goos: "freebsd", goarch: "386", runson: "ubuntu-latest"} + - {goos: "freebsd", goarch: "amd64", runson: "ubuntu-latest"} + - {goos: "freebsd", goarch: "arm", runson: "ubuntu-latest"} + - {goos: "linux", goarch: "386", runson: "ubuntu-latest"} + - {goos: "linux", goarch: "amd64", runson: "ubuntu-latest"} + - {goos: "linux", goarch: "arm", runson: "ubuntu-latest"} + - {goos: "linux", goarch: "arm64", runson: "ubuntu-latest"} + - {goos: "openbsd", goarch: "386", runson: "ubuntu-latest"} + - {goos: "openbsd", goarch: "amd64", runson: "ubuntu-latest"} + - {goos: "solaris", goarch: "amd64", runson: "ubuntu-latest"} + - {goos: "windows", goarch: "386", runson: "ubuntu-latest"} + - {goos: "windows", goarch: "amd64", runson: "ubuntu-latest"} + - {goos: "darwin", goarch: "amd64", runson: "macos-latest"} + - {goos: "darwin", goarch: "arm64", runson: "macos-latest"} fail-fast: false - name: Build for ${{ matrix.goos }}_${{ matrix.goarch }} - steps: - uses: actions/checkout@v2 @@ -110,13 +115,22 @@ jobs: with: go-version: ${{ needs.get-go-version.outputs.go-version }} + # FIXME: We're not currently setting the hard-coded version string in + # version/version.go at any point here, which means that the packages + # this process builds are not suitable for release. Once we're using + # Go 1.18 we may begin using the version information automatically + # embedded by the Go toolchain, at which point we won't need any + # special steps during build, but failing that we'll need to rework + # the version/version.go package so we can more readily update it + # using linker flags rather than direct code modification. + - name: Build env: GOOS: ${{ matrix.goos }} GOARCH: ${{ matrix.goarch }} run: | mkdir dist out - go build -o dist/ . + go build -ldflags "-w -s" -o dist/ . zip -r -j out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip dist/ - uses: actions/upload-artifact@v2 @@ -145,6 +159,8 @@ jobs: echo "RPM_PACKAGE=$(basename out/*.rpm)" >> $GITHUB_ENV echo "DEB_PACKAGE=$(basename out/*.deb)" >> $GITHUB_ENV + # FIXME: Generate homebrew packages when targeting macOS. + - uses: actions/upload-artifact@v2 if: ${{ matrix.goos == 'linux' }} with: @@ -157,41 +173,6 @@ jobs: name: ${{ env.DEB_PACKAGE }} path: out/${{ env.DEB_PACKAGE }} - build-darwin: - needs: ["get-product-version", "get-go-version"] - runs-on: macos-latest - strategy: - matrix: - include: - - {goos: "darwin", goarch: "amd64"} - - {goos: "darwin", goarch: "arm64"} - fail-fast: false - - name: Build for ${{ matrix.goos }}_${{ matrix.goarch }} - - env: - GOOS: ${{ matrix.goos }} - GOARCH: ${{ matrix.goarch }} - - steps: - - uses: actions/checkout@v2 - - - name: Install Go toolchain - uses: actions/setup-go@v2 - with: - go-version: ${{ needs.get-go-version.outputs.go-version }} - - - name: Build - run: | - mkdir dist out - go build -o dist/ - zip -r -j out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip dist/ - - - uses: actions/upload-artifact@v2 - with: - name: ${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip - path: out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip - build-docker: name: Build Docker image for linux_${{ matrix.arch }} needs: @@ -319,7 +300,7 @@ jobs: runs-on: macos-latest needs: - get-product-version - - build-darwin + - build - e2etest-build strategy: From c1699ea80c93ba971b810496683aec3cf17a72f2 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 3 Jan 2022 10:45:08 -0800 Subject: [PATCH 484/644] build: Constrain permissions for the "build" workflow steps This workflow only generates artifacts and doesn't need to modify anything about the repository. --- .github/workflows/build.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 825a6a1dad03..ff06462ea7a9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -18,6 +18,10 @@ on: env: PKG_NAME: "terraform" +permissions: + contents: read + statuses: write + jobs: get-product-version: name: "Determine intended Terraform version" From 28a6036cf269ab62f0f33d9bb7a167e367aab54a Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 3 Jan 2022 11:20:24 -0800 Subject: [PATCH 485/644] build: Separate Linux distro package builds into separate job In our build workflow we'll treat Linux distribution packaging (currently .deb and .rpm packages) as a separate job, instead of embedding it into the "build" job, so that this step can happen concurrently with the other derived actions like the docker image build, and the e2etest runs. --- .github/workflows/build.yml | 95 ++++++++++++++++++++++++++++--------- 1 file changed, 73 insertions(+), 22 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ff06462ea7a9..c0fd888b35ce 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -5,6 +5,20 @@ name: Build Terraform CLI Packages # which is a special prefix that triggers this workflow even though it's not # actually a release branch. +# NOTE: This workflow is currently used only to verify that all commits to a +# release branch are buildable. It's set up to generate some artifacts that +# might in principle be consumed by a downstream release process, but currently +# they are not used in this way and official Terraform CLI releases are instead +# built using a separate process maintained elsewhere. We intend to adopt this +# new process fully later, once other HashiCorp-internal tooling is ready. +# +# Currently this process produces what should be working packages but packages +# NOT suitable for distribution to end-users as official releases, because it +# doesn't include a step to ensure that "terraform version" (and similar) will +# report the intended version number. Consequently we can safely use these +# results for testing purposes, but not yet for release purposes. See the +# "build" job below for a FIXME comment related to version numbers. + on: workflow_dispatch: push: @@ -28,6 +42,7 @@ jobs: runs-on: ubuntu-latest outputs: product-version: ${{ steps.get-product-version.outputs.product-version }} + steps: - uses: actions/checkout@v2 with: @@ -54,6 +69,7 @@ jobs: runs-on: ubuntu-latest outputs: go-version: ${{ steps.get-go-version.outputs.go-version }} + steps: - uses: actions/checkout@v2 - name: Determine Go version @@ -91,7 +107,6 @@ jobs: needs: - get-product-version - get-go-version - strategy: matrix: include: @@ -142,51 +157,90 @@ jobs: name: ${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip path: out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip - - name: Linux distribution packages - if: ${{ matrix.goos == 'linux' }} + package-linux: + name: "Build Linux distro packages for ${{ matrix.arch }}" + runs-on: ubuntu-latest + needs: + - get-product-version + - build + strategy: + matrix: + include: + - {arch: "386"} + - {arch: "amd64"} + - {arch: "arm"} + - {arch: "arm64"} + fail-fast: false + + env: + os: linux + arch: ${{matrix.arch}} + version: ${{needs.get-product-version.outputs.product-version}} + + steps: + - name: "Download Terraform CLI package" + uses: actions/download-artifact@v2 + id: clipkg + with: + name: terraform_${{ env.version }}_${{ env.os }}_${{ env.arch }}.zip + path: . + - name: Extract packages + run: | + mkdir -p dist + (cd dist && unzip "../terraform_${{ env.version }}_${{ env.os }}_${{ env.arch }}.zip") + mkdir -p out + - name: Build Linux distribution packages uses: hashicorp/package@v1 with: name: "terraform" description: "Terraform enables you to safely and predictably create, change, and improve infrastructure. It is an open source tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned." - arch: ${{ matrix.goarch }} - version: ${{ needs.get-product-version.outputs.product-version }} + arch: ${{ matrix.arch }} + version: ${{ env.version }} maintainer: "HashiCorp" homepage: "https://terraform.io/" license: "MPL-2.0" - binary: "dist/${{ env.PKG_NAME }}" + binary: "dist/terraform" deb_depends: "git" rpm_depends: "git" - - name: Gather Linux distribution package filenames - if: ${{ matrix.goos == 'linux' }} run: | echo "RPM_PACKAGE=$(basename out/*.rpm)" >> $GITHUB_ENV echo "DEB_PACKAGE=$(basename out/*.deb)" >> $GITHUB_ENV - - # FIXME: Generate homebrew packages when targeting macOS. - - - uses: actions/upload-artifact@v2 - if: ${{ matrix.goos == 'linux' }} + - name: "Save .rpm package" + uses: actions/upload-artifact@v2 with: name: ${{ env.RPM_PACKAGE }} path: out/${{ env.RPM_PACKAGE }} - - - uses: actions/upload-artifact@v2 - if: ${{ matrix.goos == 'linux' }} + - name: "Save .deb package" + uses: actions/upload-artifact@v2 with: name: ${{ env.DEB_PACKAGE }} path: out/${{ env.DEB_PACKAGE }} - build-docker: + # TODO: homebrew packages for macOS + #package-homebrew: + # name: Build Homebrew package for darwin_${{ matrix.arch }} + # runs-on: macos-latest + # needs: + # - get-product-version + # - build + # strategy: + # matrix: + # arch: ["amd64", "arm64"] + # fail-fast: false + # ... + + package-docker: name: Build Docker image for linux_${{ matrix.arch }} + runs-on: ubuntu-latest needs: - get-product-version - build - runs-on: ubuntu-latest strategy: matrix: arch: ["amd64"] fail-fast: false + env: repo: ${{github.event.repository.name}} version: ${{needs.get-product-version.outputs.product-version}} @@ -206,8 +260,8 @@ jobs: e2etest-build: name: Build e2etest for ${{ matrix.goos }}_${{ matrix.goarch }} - needs: ["get-go-version"] runs-on: ubuntu-latest + needs: ["get-go-version"] strategy: matrix: # We build test harnesses only for the v1.0 Compatibility Promises @@ -258,7 +312,6 @@ jobs: - get-product-version - build - e2etest-build - strategy: matrix: include: @@ -306,7 +359,6 @@ jobs: - get-product-version - build - e2etest-build - strategy: matrix: include: @@ -353,7 +405,6 @@ jobs: - get-product-version - build - e2etest-build - strategy: matrix: include: From 05d0febf7f23ef0846c336de7bfdf0236cf93576 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Wed, 5 Jan 2022 14:38:53 -0800 Subject: [PATCH 486/644] Relax test to focus on the behavior we care about (encoded == encoded) The specific output order is meaningless, but it should always be the same after two Encode() calls with identical (ignoring in-memory order) dependency sets. --- internal/states/instance_object_test.go | 27 ++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/internal/states/instance_object_test.go b/internal/states/instance_object_test.go index f8be9743ed83..8f961330df0a 100644 --- a/internal/states/instance_object_test.go +++ b/internal/states/instance_object_test.go @@ -12,26 +12,39 @@ func TestResourceInstanceObject_encode(t *testing.T) { value := cty.ObjectVal(map[string]cty.Value{ "foo": cty.True, }) - deps := []addrs.ConfigResource{ + // The in-memory order of resource dependencies is random, since they're an + // unordered set. + depsOne := []addrs.ConfigResource{ addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "honk"), addrs.RootModule.Child("child").Resource(addrs.ManagedResourceMode, "test", "flub"), addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "boop"), } - wantDeps := []addrs.ConfigResource{ + depsTwo := []addrs.ConfigResource{ addrs.RootModule.Child("child").Resource(addrs.ManagedResourceMode, "test", "flub"), addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "boop"), addrs.RootModule.Resource(addrs.ManagedResourceMode, "test", "honk"), } - rio := &ResourceInstanceObject{ + rioOne := &ResourceInstanceObject{ Value: value, Status: ObjectPlanned, - Dependencies: deps, + Dependencies: depsOne, } - rios, err := rio.Encode(value.Type(), 0) + rioTwo := &ResourceInstanceObject{ + Value: value, + Status: ObjectPlanned, + Dependencies: depsTwo, + } + riosOne, err := rioOne.Encode(value.Type(), 0) + if err != nil { + t.Fatalf("unexpected error: %s", err) + } + riosTwo, err := rioTwo.Encode(value.Type(), 0) if err != nil { t.Fatalf("unexpected error: %s", err) } - if diff := cmp.Diff(wantDeps, rios.Dependencies); diff != "" { - t.Errorf("wrong result for deps\n%s", diff) + // However, identical sets of dependencies should always be written to state + // in an identical order, so we don't do meaningless state updates on refresh. + if diff := cmp.Diff(riosOne.Dependencies, riosTwo.Dependencies); diff != "" { + t.Errorf("identical dependencies got encoded in different orders:\n%s", diff) } } From fbf02d63429098c2a8e4c0220df77c7d9485bbf5 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 6 Jan 2022 11:46:08 -0500 Subject: [PATCH 487/644] Language edits --- website/docs/language/state/remote-state-data.mdx | 9 ++++----- website/intro/core-workflow.mdx | 4 ++-- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx index 997d06e2dbf7..a9c6bf93ea12 100644 --- a/website/docs/language/state/remote-state-data.mdx +++ b/website/docs/language/state/remote-state-data.mdx @@ -9,13 +9,12 @@ description: >- [backends]: /language/settings/backends -The `terraform_remote_state` data source retrieves the root module output values -from some other Terraform configuration, using the latest state snapshot from -the remote backend. +The `terraform_remote_state` data source uses the latest state snapshot from the remote backend to retrieve the root module output values +from some other Terraform configuration. -This data source implemented by a built-in provider with the [source address](/language/providers/requirements#source-addresses) `terraform.io/builtin/terraform`. That provider does not include any other resources or data sources. Because of this, the `terraform_remote_state` data source is always available; you do not need to require or configure a provider to use it. +You can use the `terraform_remote_state` data source without requiring or configuring a provider. It is always available because it is implemented through a built-in provider with the [source address](/language/providers/requirements#source-addresses) `terraform.io/builtin/terraform`. That provider does not include any other resources or data sources. --> **Warning:** To access remote state outputs in Terraform Cloud or Terraform Enterprise, we recommend using the [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs). The `tfe_outputs` method is more secure because it does not require full access to state of a workspace to fetch the outputs. If you are using the [Terraform Cloud CLI integration](/docs/cli/cloud), you **must** use `tfe_outputs` because the integration is incompatible with `terraform_remote_state`. +!> **Warning:** We recommend using the [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) to access remote state outputs in Terraform Cloud or Terraform Enterprise. The `tfe_outputs` data source is more secure because it does not require full access to workspace state to fetch outputs. If you are using the [Terraform Cloud CLI integration](/docs/cli/cloud), you **must** use `tfe_outputs` because the integration is incompatible with `terraform_remote_state`. ## Alternative Ways to Share Data Between Configurations diff --git a/website/intro/core-workflow.mdx b/website/intro/core-workflow.mdx index 6e44eb8d567e..e73cb326d2c6 100644 --- a/website/intro/core-workflow.mdx +++ b/website/intro/core-workflow.mdx @@ -229,8 +229,8 @@ for a better experience at each step. Terraform Cloud provides a centralized and secure location for storing input variables and state while also bringing back a tight feedback loop for -speculative plans for config authors. Terraform configuration interacts with -Terraform Cloud via the [CLI integration](/cli/cloud). +speculative plans for config authors. Terraform configuration can interact with +Terraform Cloud through the [CLI integration](/cli/cloud). ``` terraform { From 870116c5091d9d0606f04da1daceea70a0b99923 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 6 Jan 2022 11:48:13 -0500 Subject: [PATCH 488/644] more langauge edits --- website/docs/language/state/remote-state-data.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx index a9c6bf93ea12..4e08a4c6b971 100644 --- a/website/docs/language/state/remote-state-data.mdx +++ b/website/docs/language/state/remote-state-data.mdx @@ -12,7 +12,7 @@ description: >- The `terraform_remote_state` data source uses the latest state snapshot from the remote backend to retrieve the root module output values from some other Terraform configuration. -You can use the `terraform_remote_state` data source without requiring or configuring a provider. It is always available because it is implemented through a built-in provider with the [source address](/language/providers/requirements#source-addresses) `terraform.io/builtin/terraform`. That provider does not include any other resources or data sources. +You can use the `terraform_remote_state` data source without requiring or configuring a provider. It is always available through a built-in provider with the [source address](/language/providers/requirements#source-addresses) `terraform.io/builtin/terraform`. That provider does not include any other resources or data sources. !> **Warning:** We recommend using the [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) to access remote state outputs in Terraform Cloud or Terraform Enterprise. The `tfe_outputs` data source is more secure because it does not require full access to workspace state to fetch outputs. If you are using the [Terraform Cloud CLI integration](/docs/cli/cloud), you **must** use `tfe_outputs` because the integration is incompatible with `terraform_remote_state`. From 087c2f06ee52e41f7d7d8d2c41f673df88b8d4d4 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 5 Jan 2022 12:27:09 -0800 Subject: [PATCH 489/644] website: Documentation of how provisioners upload files We recently made a change to how provisioners upload files in order to address an unintended remote code execution vector when using SSH, which revealed that we had not previously documented well enough the expected contract for how provisioners upload files to remote systems, and so some users were depending on unintended consequences of the the bug now fixed. We are retaining the fix on security-related grounds, but this is a good prompt to be clearer in the docs about what exactly Terraform is doing when asked to upload files over SSH and WinRM, so users can understand what is supported and write their configurations accordingly. This also includes an additional section to the v1.1 upgrade guide, since we apparently neglected to document this intentional breaking change in the first draft of that page. Of course, provisioners as a whole remain a last resort, and so we're documenting this as hopefully a helpful aid to those who have no other option, and not meaning in any way to recommend their use for any new use-cases. --- .../resources/provisioners/connection.mdx | 87 ++++++++++++++++- .../language/resources/provisioners/file.mdx | 96 +++++++++++++------ website/docs/language/upgrade-guides/1-1.mdx | 61 ++++++++++++ 3 files changed, 211 insertions(+), 33 deletions(-) diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 704012199ae3..eb1ccff5f623 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -102,6 +102,9 @@ block would create a dependency cycle. Defaults to 5 minutes. * `script_path` - The path used to copy scripts meant for remote execution. + For more information, see + [How Provisioners Execute Remote Scripts](#how-provisioners-execute-remote-scripts) + below. **Additional arguments only supported by the `ssh` connection type:** @@ -123,9 +126,7 @@ block would create a dependency cycle. * `host_key` - The public key from the remote host or the signing CA, used to verify the connection. -* `target_platform` - The target platform to connect to. Valid values are `windows` and `unix`. Defaults to `unix` if not set. - - If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` +* `target_platform` - The target platform to connect to. Valid values are `"windows"` and `"unix"`. Defaults to `"unix"` if not set. **Additional arguments only supported by the `winrm` connection type:** @@ -137,6 +138,11 @@ block would create a dependency cycle. * `cacert` - The CA certificate to validate against. +Provisioners typically assume that the remote system runs Microsoft Windows +when using the `winrm` connection type. Behaviors which would vary based on +the `target_platform` option if using SSH will instead force the +Windows-specific behavior when using WinRM, unless otherwise specified. + ## Connecting through a Bastion Host with SSH @@ -167,3 +173,78 @@ The `ssh` connection also supports the following fields to facilitate connnectio * `bastion_certificate` - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `bastion_private_key`. These can be loaded from a file on disk using the [the `file` function](/language/functions/file). + +## How Provisioners Execute Remote Scripts + +Provisioners which execute commands on a remote system via a protocol such as +SSH typically achieve that by uploading a script file to the remote system +and then asking the default shell to execute it. Provisioners use this strategy +because it then allows you to use all of the typical scripting techniques +supported by that shell, including preserving environment variable values +and other context between script statements. + +However, this approach does have some consequences which can be relevant in +some unusual situations, even though this is just an implementation detail +for typical use. + +Most importantly, there must be a suitable location in the remote filesystem +where the provisioner can create the script file. By default, Terraform +chooses a path containing a random number using the following patterns +depending on how `target_platform` is set: + +* `"unix"`: `/tmp/terraform_%RAND%.sh` +* `"windows"`: `C:/windows/temp/terraform_%RAND%.cmd` + +In both cases above, the provisioner replaces the sequence `%RAND%` with +some randomly-chosen decimal digits. + +Provisioners cannot react directly to remote environment variables such as +`TMPDIR` or use functions like `mktemp` because they run on the system where +Terraform is running, not on the remote system. Therefore if your remote +system doesn't use the filesystem layout expected by these default paths +then you can override it using the `script_path` option in your `connection` +block: + +```hcl +connection { + # ... + script_path = "H:/terraform-temp/script_%RAND%.sh" +} +``` + +As with the default patterns, provisioners will replace the sequence `%RAND%` +with randomly-selected decimal digits, to reduce the likelihood of collisions +between multiple provisioners running concurrently. + +If your target system is running Windows, we recommend uses forward slashes +instead of backslashes, despite the typical convention on Windows, because +the Terraform language uses backslash as the quoted string escape character. + +### Executing Scripts using SSH/SCP + +When using the SSH protocol, provisioners upload their script files using +the Secure Copy Protocol (SCP), which requires that the remote system have +the `scp` service program installed to act as the server for that protocol. + +Provisioners will pass the chosen script path (after `%RAND%` +expansion) directly to the remote `scp` process, which is responsible for +interpreting it. With the default configuration of `scp` as distributed with +OpenSSH, you can place temporary scripts in the home directory of the remote +user by specifying a relative path: + +```hcl +connection { + type = "ssh" + # ... + script_path = "terraform_provisioner_%RAND%.sh" +} +``` + +-> **Warning:** In Terraform v1.0 and earlier, the built-in provisioners +incorrectly passed the `script_path` value to `scp` through a remote shell and +thus allowed it to be subject to arbitrary shell expansion, and thus created an +unintended opportunity for remote code execution. Terraform v1.1 and later +will now correctly quote and escape the script path to ensure that the +remote `scp` process can always interpret it literally. For modules that will +be used with Terraform v1.0 and earlier, avoid using untrusted external +values as part of the `script_path` argument. diff --git a/website/docs/language/resources/provisioners/file.mdx b/website/docs/language/resources/provisioners/file.mdx index 06b22758b49c..83dfb7a90a75 100644 --- a/website/docs/language/resources/provisioners/file.mdx +++ b/website/docs/language/resources/provisioners/file.mdx @@ -52,41 +52,77 @@ resource "aws_instance" "web" { The following arguments are supported: -* `source` - This is the source file or folder. It can be specified as - relative to the current working directory or as an absolute path. This - attribute cannot be specified with `content`. - -* `content` - This is the content to copy on the destination. If destination is a file, - the content will be written on that file, in case of a directory a file named - `tf-file-content` is created. It's recommended to use a file as the destination. A - [`template_file`](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) might be referenced in here, or - any interpolation syntax. This attribute cannot be specified with `source`. - -* `destination` - (Required) This is the destination path. It must be specified as an - absolute path. +* `source` - The source file or directory. Specify it either relative to the + current working directory or as an absolute path. + This argument cannot be combined with `content`. + +* `content` - The direct content to copy on the destination. + If destination is a file, the content will be written on that file. In case + of a directory, a file named `tf-file-content` is created inside that + directory. We recommend using a file as the destination when using `content`. + This argument cannot be combined with `source`. + +* `destination` - (Required) The destination path to write to on the remote + system. See [Destination Paths](#destination-paths) below for more + information. + +## Destination Paths + +The path you provide in the `destination` argument will be evaluated by the +remote system, rather than by Terraform itself. Therefore the valid values +for that argument can vary depending on the operating system and remote access +software running on the target. + +When connecting over SSH, the `file` provisioner passes the given destination +path verbatim to the `scp` program on the remote host. By default, OpenSSH's +`scp` implementation runs in the remote user's home directory and so you can +specify a relative path to upload into that home directory, or an absolute +path to upload to some other location. The remote `scp` process will run with +the access level of the user specified in the `connection` block, and so +permissions may prevent writing directly to locations outside of the home +directory. + +Because WinRM has no corresponding file transfer protocol, for WinRM +connections the `file` provisioner uses a more complex process: + +1. Generate a temporary filename in the directory given in the remote system's + `TEMP` environment variable, using a pseudorandom UUID for uniqueness. +2. Use sequential generated `echo` commands over WinRM to gradually append + base64-encoded chunks of the source file to the chosen temporary file. +3. Use an uploaded PowerShell script to read the temporary file, base64-decode, + and write the raw result into the destination file. + +In the WinRM case, the destination path is therefore interpreted by PowerShell +and so you must take care not to use any meta-characters that PowerShell might +interpret. In particular, avoid including any untrusted external input in +your `destination` argument when using WinRM, because it can serve as a vector +for arbitrary PowerShell code execution on the remote system. + +Modern Windows systems support running an OpenSSH server, so we strongly +recommend choosing SSH over WinRM whereever possible, and using WinRM only as +a last resort when working with obsolete Windows versions. ## Directory Uploads -The file provisioner is also able to upload a complete directory to the remote machine. -When uploading a directory, there are a few important things you should know. - -First, when using the `ssh` connection type the destination directory must already exist. -If you need to create it, use a remote-exec provisioner just prior to the file provisioner -in order to create the directory. When using the `winrm` connection type the destination -directory will be created for you if it doesn't already exist. +The `file` provisioner can upload a complete directory to the remote machine. +When uploading a directory, there are some additional considerations. -Next, the existence of a trailing slash on the source path will determine whether the -directory name will be embedded within the destination, or whether the destination will -be created. An example explains this best: +When using the `ssh` connection type the destination directory must already +exist. If you need to create it, use a remote-exec provisioner just prior to +the file provisioner in order to create the directory -If the source is `/foo` (no trailing slash), and the destination is `/tmp`, then the contents -of `/foo` on the local machine will be uploaded to `/tmp/foo` on the remote machine. The -`foo` directory on the remote machine will be created by Terraform. +When using the `winrm` connection type the destination directory will be +created for you if it doesn't already exist. -If the source, however, is `/foo/` (a trailing slash is present), and the destination is -`/tmp`, then the contents of `/foo` will be uploaded directly into `/tmp`. +The existence of a trailing slash on the source path will determine whether the +directory name will be embedded within the destination, or whether the +destination will be created. For example: -This behavior was adopted from the standard behavior of -[rsync](https://linux.die.net/man/1/rsync). +* If the source is `/foo` (no trailing slash), and the destination is `/tmp`, + then the contents of `/foo` on the local machine will be uploaded to + `/tmp/foo` on the remote machine. The `foo` directory on the remote machine + will be created by Terraform. --> **Note:** Under the covers, rsync may or may not be used. +* If the source, however, is `/foo/` (a trailing slash is present), and the + destination is `/tmp`, then the contents of `/foo` will be uploaded directly + into `/tmp`. diff --git a/website/docs/language/upgrade-guides/1-1.mdx b/website/docs/language/upgrade-guides/1-1.mdx index faafcf147573..aa16a4838276 100644 --- a/website/docs/language/upgrade-guides/1-1.mdx +++ b/website/docs/language/upgrade-guides/1-1.mdx @@ -23,6 +23,7 @@ small number of users, described in the following sections. * [Terraform requires macOS 10.13 High Sierra or later](#terraform-requires-macos-1013-high-sierra-or-later) * [Preparation for removing Azure AD Graph support in the AzureRM Backend](#preparation-for-removing-azure-ad-graph-support-in-the-azurerm-backend) +* [Interpretation of remote file paths in the `remote-exec` and `file` provisioners](#interpretation-of-remote-file-paths-in-the-remote-exec-and-file-provisioners) * [Changes to `terraform graph`](#changes-to-terraform-graph) * [Changes to `terraform state mv`](#changes-to-terraform-state-mv) * [Provider checksum verification in `terraform apply`](#provider-checksum-verification-in-terraform-apply) @@ -54,6 +55,66 @@ in the near future to prepare for the final removal of Azure AD Graph support in a later Terraform release. However, no immediate change is required before upgrading to Terraform v1.1. +## Interpretation of remote file paths in the `remote-exec` and `file` provisioners + +When using Terraform's built-in `remote-exec` and `file` provisioners, there +are two situations where Terraform internally uses +[Secure Copy Protocol](https://en.wikipedia.org/wiki/Secure_copy_protocol) +(SCP) to upload files to the remote system at a configuration-specified +location: + +* For [the `file` provisioner](/language/resources/provisioners/file), + the primary functionality is to upload a file using SCP, and the + `destination` argument specifies the remote path where the file is to be + written. +* For [the `remote-exec` provisioner](/language/resources/provisioners/remote-exec), + internally the provisioner works by uploading the given scripts to files + on the remote system and then executing them. By default the provisioner + selects a temporary filename automatically, but a module author can + potentially override that location using the `script_path` argument in the + associated [`connection` block](https://www.terraform.io/language/resources/provisioners/connection). + +If you are not using either of the specific arguments mentioned above, no +configuration changes will be required to upgrade to Terraform v1.1. + +These provisioners both passing the specified remote paths to the `scp` service +program on the remote system. In Terraform v1.0 and earlier, the provisioners +were passing the paths to `scp` in a way that was inadvertently subject to +_shell expansion_. That inadvertently allowed for convenient shorthands +such as `~/example` and `$HOME/example` to write into the target user's +home directory, but also offered an undesirable opportunity for accidental +remote code execution, such as `$(arbitrary-program)`. + +In Terraform v1.1 both of the above remote path arguments are passed _verbatim_ +to the remote `scp` service, without any prior shell expansion. For that reason, +shell-defined expansion tokens such as `~` and environment variable references +will no longer be evaluated. + +By default, the OpenSSH server and the program `scp` together already interpret +relative paths as relative to the target user's home directory, and so +module authors can specify relative paths without any special metacharacters +in order to request uploading into that default location: + +```hcl + provisioner "file" { + source = "local.txt" + destination = "remote.txt" + } +``` + +If you maintain a module that was depending on expansion of `~/`, `$HOME/`, +`${HOME}`/ or similar, remove that prefix so that your module instead specifies +just a relative path. + +This is an intentional compatibility regression which we accepted after due +consideration of +[the pragmatic exceptions to our compatibility promises](/language/v1-compatibility-promises#pragmatic-exceptions). +Specifically, this behavior offered an unintended and non-obvious avenue for +arbitrary code execution on the remote system if either of the above arguments +were populated from outside input, and an alternative approach is available +which doesn't have that drawback, and this is therefore justified on security +grounds. + ## Changes to `terraform graph` The `terraform graph` command exists to help with debugging and so it From 4ec1feaa3d41a516b87fbf80191203081a8de62e Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 5 Jan 2022 15:10:05 -0800 Subject: [PATCH 490/644] build: CGO_ENABLED when building for macOS Normally when we cross-compile we do so without CGo, because we don't have suitable C headers available for systems other than the host. However, building for macOS on macOS is special because there are sufficient headers available on darwin_amd64 to build for both darwin_amd64 _and_ darwin_arm64. Also, we _must_ use CGo on macOS because the system resolver is only available via darwin's libc, and so building without CGo produces executables that don't resolve hostnames correctly. This is a conditional in bash to avoid having to duplicate the entire step. Perhaps later we'll find a more general version of this which can avoid the special case, but this is sufficient for the moment. --- .github/workflows/build.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c0fd888b35ce..0aefa68c24ef 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -147,8 +147,17 @@ jobs: env: GOOS: ${{ matrix.goos }} GOARCH: ${{ matrix.goarch }} + ACTIONSOS: ${{ matrix.runson }} run: | mkdir dist out + if [ "$ACTIONSOS" == "macos-latest" ] && [ "$GOOS" == "darwin" ]; then + # When building for macOS _on_ macOS we must force CGo to get + # correct hostname resolution behavior. (This must be conditional + # because other cross-compiles won't have suitable headers + # available to use CGo; darwin_amd64 has suitable headers to + # cross-build for darwin_arm64.) + export CGO_ENABLED=1 + fi go build -ldflags "-w -s" -o dist/ . zip -r -j out/${{ env.PKG_NAME }}_${{ needs.get-product-version.outputs.product-version }}_${{ matrix.goos }}_${{ matrix.goarch }}.zip dist/ From 3ac334f267335d969ca3991d719c4489f7f62657 Mon Sep 17 00:00:00 2001 From: Mukesh Kumar Date: Fri, 7 Jan 2022 05:52:12 +0530 Subject: [PATCH 491/644] Update website/docs/language/values/locals.mdx Thank you. Your suggestion to use "instead of" makes the sentence even more easy to understand. Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/language/values/locals.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/values/locals.mdx b/website/docs/language/values/locals.mdx index 6706ad91da12..dbcd9f6150e9 100644 --- a/website/docs/language/values/locals.mdx +++ b/website/docs/language/values/locals.mdx @@ -12,7 +12,7 @@ description: >- > tutorial on HashiCorp Learn. A local value assigns a name to an [expression](/language/expressions), -so you can use the name multiple times within a module without repeating +so you can use the name multiple times within a module instead of repeating the expression. If you're familiar with traditional programming languages, it can be useful to From 5171c89e1eaa184e827d1c29486ab026e7c8c73c Mon Sep 17 00:00:00 2001 From: SuperKooks Date: Sat, 8 Jan 2022 14:41:20 +1100 Subject: [PATCH 492/644] Fix autocomplete for workspace subcommands --- internal/command/autocomplete.go | 6 +----- internal/command/workspace_delete.go | 1 - internal/command/workspace_new.go | 1 - internal/command/workspace_select.go | 1 - 4 files changed, 1 insertion(+), 8 deletions(-) diff --git a/internal/command/autocomplete.go b/internal/command/autocomplete.go index 4b19c1c95e38..87e765fe833e 100644 --- a/internal/command/autocomplete.go +++ b/internal/command/autocomplete.go @@ -19,11 +19,7 @@ var completePredictModuleSource = complete.PredictAnything type completePredictSequence []complete.Predictor func (s completePredictSequence) Predict(a complete.Args) []string { - // Only one level of command is stripped off the prefix of a.Completed - // here, so nested subcommands like "workspace new" will need to provide - // dummy entries (e.g. complete.PredictNothing) as placeholders for - // all but the first subcommand. For example, "workspace new" needs - // one placeholder for the argument "new". + // Nested subcommands do not require any placeholder entry for their subcommand name. idx := len(a.Completed) if idx >= len(s) { return nil diff --git a/internal/command/workspace_delete.go b/internal/command/workspace_delete.go index 654aac581dd6..013db3966c93 100644 --- a/internal/command/workspace_delete.go +++ b/internal/command/workspace_delete.go @@ -190,7 +190,6 @@ func (c *WorkspaceDeleteCommand) Run(args []string) int { func (c *WorkspaceDeleteCommand) AutocompleteArgs() complete.Predictor { return completePredictSequence{ - complete.PredictNothing, // the "select" subcommand itself (already matched) c.completePredictWorkspaceName(), complete.PredictDirs(""), } diff --git a/internal/command/workspace_new.go b/internal/command/workspace_new.go index 41e657bef5da..cd28e6986744 100644 --- a/internal/command/workspace_new.go +++ b/internal/command/workspace_new.go @@ -167,7 +167,6 @@ func (c *WorkspaceNewCommand) Run(args []string) int { func (c *WorkspaceNewCommand) AutocompleteArgs() complete.Predictor { return completePredictSequence{ - complete.PredictNothing, // the "new" subcommand itself (already matched) complete.PredictAnything, complete.PredictDirs(""), } diff --git a/internal/command/workspace_select.go b/internal/command/workspace_select.go index 1f98ec55e0a2..e257b59d7b95 100644 --- a/internal/command/workspace_select.go +++ b/internal/command/workspace_select.go @@ -117,7 +117,6 @@ func (c *WorkspaceSelectCommand) Run(args []string) int { func (c *WorkspaceSelectCommand) AutocompleteArgs() complete.Predictor { return completePredictSequence{ - complete.PredictNothing, // the "select" subcommand itself (already matched) c.completePredictWorkspaceName(), complete.PredictDirs(""), } From 171e7ef6d9fa48e37d5fa252cd7823b7bc1d9db5 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 10 Jan 2022 09:49:28 -0800 Subject: [PATCH 493/644] core: Invalid for_each argument messaging improvements Our original messaging here was largely just lifted from the equivalent message for unknown values in "count", and it didn't really include any specific advice on how to update a configuration to make for_each valid, instead focusing only on the workaround of using the -target planning option. It's tough to pack in a fully-actionable suggestion here since unknown values in for_each keys tends to be a gnarly architectural problem rather than a local quirk -- when data flows between modules it can sometimes be unclear whether it'll end up being used in a context which allows unknown values. I did my best to summarize the advice we've been giving in community forum though, in the hope that more people will be able to address this for themselves without asking for help, until we're one day able to smooth this out better with a mechanism such as "partial apply". --- internal/terraform/eval_for_each.go | 17 +++++++++++++---- internal/terraform/eval_for_each_test.go | 12 ++++++------ 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/internal/terraform/eval_for_each.go b/internal/terraform/eval_for_each.go index fccf58f915b0..ba7a8c9bca6c 100644 --- a/internal/terraform/eval_for_each.go +++ b/internal/terraform/eval_for_each.go @@ -78,6 +78,9 @@ func evaluateForEachExpressionValue(expr hcl.Expression, ctx EvalContext, allowU } ty := forEachVal.Type() + const errInvalidUnknownDetailMap = "The \"for_each\" map includes keys derived from resource attributes that cannot be determined until apply, and so Terraform cannot determine the full set of keys that will identify the instances of this resource.\n\nWhen working with unknown values in for_each, it's better to define the map keys statically in your configuration and place apply-time results only in the map values.\n\nAlternatively, you could use the -target planning option to first apply only the resources that the for_each value depends on, and then apply a second time to fully converge." + const errInvalidUnknownDetailSet = "The \"for_each\" set includes values derived from resource attributes that cannot be determined until apply, and so Terraform cannot determine the full set of keys that will identify the instances of this resource.\n\nWhen working with unknown values in for_each, it's better to use a map value where the keys are defined statically in your configuration and where only the values contain apply-time results.\n\nAlternatively, you could use the -target planning option to first apply only the resources that the for_each value depends on, and then apply a second time to fully converge." + switch { case forEachVal.IsNull(): diags = diags.Append(&hcl.Diagnostic{ @@ -91,10 +94,18 @@ func evaluateForEachExpressionValue(expr hcl.Expression, ctx EvalContext, allowU return nullMap, diags case !forEachVal.IsKnown(): if !allowUnknown { + var detailMsg string + switch { + case ty.IsSetType(): + detailMsg = errInvalidUnknownDetailSet + default: + detailMsg = errInvalidUnknownDetailMap + } + diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: "Invalid for_each argument", - Detail: errInvalidForEachUnknownDetail, + Detail: detailMsg, Subject: expr.Range().Ptr(), Expression: expr, EvalContext: hclCtx, @@ -129,7 +140,7 @@ func evaluateForEachExpressionValue(expr hcl.Expression, ctx EvalContext, allowU diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: "Invalid for_each argument", - Detail: errInvalidForEachUnknownDetail, + Detail: errInvalidUnknownDetailSet, Subject: expr.Range().Ptr(), Expression: expr, EvalContext: hclCtx, @@ -172,8 +183,6 @@ func evaluateForEachExpressionValue(expr hcl.Expression, ctx EvalContext, allowU return forEachVal, nil } -const errInvalidForEachUnknownDetail = `The "for_each" value depends on resource attributes that cannot be determined until apply, so Terraform cannot predict how many instances will be created. To work around this, use the -target argument to first apply only the resources that the for_each depends on.` - // markSafeLengthInt allows calling LengthInt on marked values safely func markSafeLengthInt(val cty.Value) int { v, _ := val.UnmarkDeep() diff --git a/internal/terraform/eval_for_each_test.go b/internal/terraform/eval_for_each_test.go index 28a025ab0d47..be4b551cf039 100644 --- a/internal/terraform/eval_for_each_test.go +++ b/internal/terraform/eval_for_each_test.go @@ -114,12 +114,12 @@ func TestEvaluateForEachExpression_errors(t *testing.T) { "unknown string set": { hcltest.MockExprLiteral(cty.UnknownVal(cty.Set(cty.String))), "Invalid for_each argument", - "depends on resource attributes that cannot be determined until apply", + "set includes values derived from resource attributes that cannot be determined until apply", }, "unknown map": { hcltest.MockExprLiteral(cty.UnknownVal(cty.Map(cty.Bool))), "Invalid for_each argument", - "depends on resource attributes that cannot be determined until apply", + "map includes keys derived from resource attributes that cannot be determined until apply", }, "marked map": { hcltest.MockExprLiteral(cty.MapVal(map[string]cty.Value{ @@ -142,12 +142,12 @@ func TestEvaluateForEachExpression_errors(t *testing.T) { "set containing unknown value": { hcltest.MockExprLiteral(cty.SetVal([]cty.Value{cty.UnknownVal(cty.String)})), "Invalid for_each argument", - "depends on resource attributes that cannot be determined until apply", + "set includes values derived from resource attributes that cannot be determined until apply", }, "set containing dynamic unknown value": { hcltest.MockExprLiteral(cty.SetVal([]cty.Value{cty.UnknownVal(cty.DynamicPseudoType)})), "Invalid for_each argument", - "depends on resource attributes that cannot be determined until apply", + "set includes values derived from resource attributes that cannot be determined until apply", }, "set containing marked values": { hcltest.MockExprLiteral(cty.SetVal([]cty.Value{cty.StringVal("beep").Mark(marks.Sensitive), cty.StringVal("boop")})), @@ -169,10 +169,10 @@ func TestEvaluateForEachExpression_errors(t *testing.T) { t.Errorf("wrong diagnostic severity %#v; want %#v", got, want) } if got, want := diags[0].Description().Summary, test.Summary; got != want { - t.Errorf("wrong diagnostic summary %#v; want %#v", got, want) + t.Errorf("wrong diagnostic summary\ngot: %s\nwant: %s", got, want) } if got, want := diags[0].Description().Detail, test.DetailSubstring; !strings.Contains(got, want) { - t.Errorf("wrong diagnostic detail %#v; want %#v", got, want) + t.Errorf("wrong diagnostic detail\ngot: %s\nwant substring: %s", got, want) } if fromExpr := diags[0].FromExpr(); fromExpr != nil { if fromExpr.Expression == nil { From a579ae15b083d782245d6ae359911421808c80ea Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 10 Jan 2022 12:24:53 -0800 Subject: [PATCH 494/644] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f61750fda27a..59307b6111de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,8 @@ ## 1.2.0 (Unreleased) +ENHANCEMENTS: + +* The "Invalid for_each argument" error message for unknown maps/sets now includes an additional paragraph to try to help the user notice they can move apply-time values into the map _values_ instead of the map _keys_, and thus avoid the problem without resorting to `-target`. [GH-30327] ## Previous Releases From 483c38aca1b323dac9fda9b682f57b9639e107ae Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 2 Dec 2021 17:41:06 -0800 Subject: [PATCH 495/644] core: Remove TestContext2Validate_PlanGraphBuilder This test seems to be a holdover from the many-moons-ago switch from one graph for all operations to separate graphs for plan and apply. It is effectively just a copy of a subset of the content of the Context.Validate function and is a maintainability hazard because it tends to lag behind updates to that function unless changes there happen to make it fail. This test doesn't cover anything that the other validate context tests don't exercise as an implementation detail of calling Context.Validate, so I've just removed it with no replacement. --- internal/terraform/context_validate_test.go | 26 --------------------- 1 file changed, 26 deletions(-) diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index 1ed5ad4253f2..a02d85cdd9f2 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -1187,32 +1187,6 @@ resource "aws_instance" "foo" { } } -// Manually validate using the new PlanGraphBuilder -func TestContext2Validate_PlanGraphBuilder(t *testing.T) { - fixture := contextFixtureApplyVars(t) - opts := fixture.ContextOpts() - c := testContext2(t, opts) - - graph, diags := ValidateGraphBuilder(&PlanGraphBuilder{ - Config: fixture.Config, - State: states.NewState(), - Plugins: c.plugins, - }).Build(addrs.RootModuleInstance) - if diags.HasErrors() { - t.Fatalf("errors from PlanGraphBuilder: %s", diags.Err()) - } - defer c.acquireRun("validate-test")() - walker, diags := c.walk(graph, walkValidate, &graphWalkOpts{ - Config: fixture.Config, - }) - if diags.HasErrors() { - t.Fatal(diags.Err()) - } - if len(walker.NonFatalDiagnostics) > 0 { - t.Fatal(walker.NonFatalDiagnostics.Err()) - } -} - func TestContext2Validate_invalidOutput(t *testing.T) { m := testModuleInline(t, map[string]string{ "main.tf": ` From 37b1413ab3ab23af368f84766eb3b155e1f0d8bf Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 10 Nov 2021 17:29:45 -0800 Subject: [PATCH 496/644] core: Handle root and child module input variables consistently Previously we had a significant discrepancy between these two situations: we wrote the raw root module variables directly into the EvalContext and then applied type conversions only at expression evaluation time, while for child modules we converted and validated the values while visiting the variable graph node and wrote only the _final_ value into the EvalContext. This confusion seems to have been the root cause for #29899, where validation rules for root module variables were being applied at the wrong point in the process, prior to type conversion. To fix that bug and also make similar mistakes less likely in the future, I've made the root module variable handling more like the child module variable handling in the following ways: - The "raw value" (exactly as given by the user) lives only in the graph node representing the variable, which mirrors how the _expression_ for a child module variable lives in its graph node. This means that the flow for the two is the same except that there's no expression evaluation step for root module variables, because they arrive as constant values from the caller. - The set of variable values in the EvalContext is always only "final" values, after type conversion is complete. That in turn means we no longer need to do "just in time" conversion in evaluationStateData.GetInputVariable, and can just return the value exactly as stored, which is consistent with how we handle all other references between objects. This diff is noisier than I'd like because of how much it takes to wire a new argument (the raw variable values) through to the plan graph builder, but those changes are pretty mechanical and the interesting logic lives inside the plan graph builder itself, in NodeRootVariable, and the shared helper functions in eval_variable.go. While here I also took the opportunity to fix a historical API wart in EvalContext, where SetModuleCallArguments was built to take a set of variable values all at once but our current caller always calls with only one at a time. That is now just SetModuleCallArgument singular, to match with the new SetRootModuleArgument to deal with root module variables. --- internal/terraform/context_apply.go | 69 +-- internal/terraform/context_eval.go | 12 +- internal/terraform/context_import.go | 16 +- internal/terraform/context_plan.go | 74 +-- internal/terraform/context_validate.go | 24 +- internal/terraform/context_walk.go | 24 +- internal/terraform/eval_context.go | 22 +- internal/terraform/eval_context_builtin.go | 29 +- internal/terraform/eval_context_mock.go | 38 +- internal/terraform/eval_variable.go | 107 ++++- internal/terraform/eval_variable_test.go | 426 ++++++++++++++++++ internal/terraform/evaluate.go | 40 +- internal/terraform/graph_builder_apply.go | 7 +- .../terraform/graph_builder_destroy_plan.go | 5 + internal/terraform/graph_builder_eval.go | 7 +- internal/terraform/graph_builder_import.go | 7 +- internal/terraform/graph_builder_plan.go | 7 +- internal/terraform/node_module_variable.go | 129 ++---- internal/terraform/node_root_variable.go | 59 ++- internal/terraform/node_root_variable_test.go | 166 ++++++- internal/terraform/transform_variable.go | 5 +- 21 files changed, 1014 insertions(+), 259 deletions(-) create mode 100644 internal/terraform/eval_variable_test.go diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go index e5d2702bc5dc..42520b03dd83 100644 --- a/internal/terraform/context_apply.go +++ b/internal/terraform/context_apply.go @@ -30,30 +30,11 @@ func (c *Context) Apply(plan *plans.Plan, config *configs.Config) (*states.State return nil, diags } - variables := InputValues{} - for name, dyVal := range plan.VariableValues { - val, err := dyVal.Decode(cty.DynamicPseudoType) - if err != nil { - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid variable value in plan", - fmt.Sprintf("Invalid value for variable %q recorded in plan file: %s.", name, err), - )) - continue - } - - variables[name] = &InputValue{ - Value: val, - SourceType: ValueFromPlan, - } - } - workingState := plan.PriorState.DeepCopy() walker, walkDiags := c.walk(graph, operation, &graphWalkOpts{ - Config: config, - InputState: workingState, - Changes: plan.Changes, - RootVariableValues: variables, + Config: config, + InputState: workingState, + Changes: plan.Changes, }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) @@ -83,15 +64,43 @@ Note that the -target option is not suitable for routine use, and is provided on } func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { - graph, diags := (&ApplyGraphBuilder{ - Config: config, - Changes: plan.Changes, - State: plan.PriorState, - Plugins: c.plugins, - Targets: plan.TargetAddrs, - ForceReplace: plan.ForceReplaceAddrs, - Validate: validate, + var diags tfdiags.Diagnostics + + variables := InputValues{} + for name, dyVal := range plan.VariableValues { + val, err := dyVal.Decode(cty.DynamicPseudoType) + if err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid variable value in plan", + fmt.Sprintf("Invalid value for variable %q recorded in plan file: %s.", name, err), + )) + continue + } + + variables[name] = &InputValue{ + Value: val, + SourceType: ValueFromPlan, + } + } + if diags.HasErrors() { + return nil, walkApply, diags + } + + graph, moreDiags := (&ApplyGraphBuilder{ + Config: config, + Changes: plan.Changes, + State: plan.PriorState, + RootVariableValues: variables, + Plugins: c.plugins, + Targets: plan.TargetAddrs, + ForceReplace: plan.ForceReplaceAddrs, + Validate: validate, }).Build(addrs.RootModuleInstance) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return nil, walkApply, diags + } operation := walkApply if plan.UIMode == plans.DestroyMode { diff --git a/internal/terraform/context_eval.go b/internal/terraform/context_eval.go index efc24767c205..c6af77635fc3 100644 --- a/internal/terraform/context_eval.go +++ b/internal/terraform/context_eval.go @@ -60,9 +60,10 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a log.Printf("[DEBUG] Building and walking 'eval' graph") graph, moreDiags := (&EvalGraphBuilder{ - Config: config, - State: state, - Plugins: c.plugins, + Config: config, + State: state, + RootVariableValues: variables, + Plugins: c.plugins, }).Build(addrs.RootModuleInstance) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { @@ -70,9 +71,8 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a } walkOpts := &graphWalkOpts{ - InputState: state, - Config: config, - RootVariableValues: variables, + InputState: state, + Config: config, } walker, moreDiags = c.walk(graph, walkEval, walkOpts) diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index af17cbd62dc8..b5417405fbb0 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -53,11 +53,14 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt log.Printf("[DEBUG] Building and walking import graph") + variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) + // Initialize our graph builder builder := &ImportGraphBuilder{ - ImportTargets: opts.Targets, - Config: config, - Plugins: c.plugins, + ImportTargets: opts.Targets, + Config: config, + RootVariableValues: variables, + Plugins: c.plugins, } // Build the graph @@ -67,13 +70,10 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt return state, diags } - variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) - // Walk it walker, walkDiags := c.walk(graph, walkImport, &graphWalkOpts{ - Config: config, - InputState: state, - RootVariableValues: variables, + Config: config, + InputState: state, }) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 3f860ef1bd1f..0b3c97f14559 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -125,11 +125,11 @@ The -target option is not for routine use, and is provided only for exceptional var planDiags tfdiags.Diagnostics switch opts.Mode { case plans.NormalMode: - plan, planDiags = c.plan(config, prevRunState, variables, opts) + plan, planDiags = c.plan(config, prevRunState, opts) case plans.DestroyMode: - plan, planDiags = c.destroyPlan(config, prevRunState, variables, opts) + plan, planDiags = c.destroyPlan(config, prevRunState, opts) case plans.RefreshOnlyMode: - plan, planDiags = c.refreshOnlyPlan(config, prevRunState, variables, opts) + plan, planDiags = c.refreshOnlyPlan(config, prevRunState, opts) default: panic(fmt.Sprintf("unsupported plan mode %s", opts.Mode)) } @@ -172,14 +172,14 @@ var DefaultPlanOpts = &PlanOpts{ Mode: plans.NormalMode, } -func (c *Context) plan(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { +func (c *Context) plan(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics if opts.Mode != plans.NormalMode { panic(fmt.Sprintf("called Context.plan with %s", opts.Mode)) } - plan, walkDiags := c.planWalk(config, prevRunState, rootVariables, opts) + plan, walkDiags := c.planWalk(config, prevRunState, opts) diags = diags.Append(walkDiags) if diags.HasErrors() { return nil, diags @@ -194,14 +194,14 @@ func (c *Context) plan(config *configs.Config, prevRunState *states.State, rootV return plan, diags } -func (c *Context) refreshOnlyPlan(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { +func (c *Context) refreshOnlyPlan(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics if opts.Mode != plans.RefreshOnlyMode { panic(fmt.Sprintf("called Context.refreshOnlyPlan with %s", opts.Mode)) } - plan, walkDiags := c.planWalk(config, prevRunState, rootVariables, opts) + plan, walkDiags := c.planWalk(config, prevRunState, opts) diags = diags.Append(walkDiags) if diags.HasErrors() { return nil, diags @@ -235,7 +235,7 @@ func (c *Context) refreshOnlyPlan(config *configs.Config, prevRunState *states.S return plan, diags } -func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { +func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics pendingPlan := &plans.Plan{} @@ -260,7 +260,7 @@ func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State log.Printf("[TRACE] Context.destroyPlan: calling Context.plan to get the effect of refreshing the prior state") normalOpts := *opts normalOpts.Mode = plans.NormalMode - refreshPlan, refreshDiags := c.plan(config, prevRunState, rootVariables, &normalOpts) + refreshPlan, refreshDiags := c.plan(config, prevRunState, &normalOpts) if refreshDiags.HasErrors() { // NOTE: Normally we'd append diagnostics regardless of whether // there are errors, just in case there are warnings we'd want to @@ -291,7 +291,7 @@ func (c *Context) destroyPlan(config *configs.Config, prevRunState *states.State priorState = pendingPlan.PriorState } - destroyPlan, walkDiags := c.planWalk(config, priorState, rootVariables, opts) + destroyPlan, walkDiags := c.planWalk(config, priorState, opts) diags = diags.Append(walkDiags) if walkDiags.HasErrors() { return nil, diags @@ -392,7 +392,7 @@ func (c *Context) postPlanValidateMoves(config *configs.Config, stmts []refactor return refactoring.ValidateMoves(stmts, config, allInsts) } -func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, rootVariables InputValues, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { +func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics log.Printf("[DEBUG] Building and walking plan graph for %s", opts.Mode) @@ -419,11 +419,10 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, r // we can now walk. changes := plans.NewChanges() walker, walkDiags := c.walk(graph, walkOp, &graphWalkOpts{ - Config: config, - InputState: prevRunState, - Changes: changes, - MoveResults: moveResults, - RootVariableValues: rootVariables, + Config: config, + InputState: prevRunState, + Changes: changes, + MoveResults: moveResults, }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) @@ -469,34 +468,37 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, switch mode := opts.Mode; mode { case plans.NormalMode: graph, diags := (&PlanGraphBuilder{ - Config: config, - State: prevRunState, - Plugins: c.plugins, - Targets: opts.Targets, - ForceReplace: opts.ForceReplace, - Validate: validate, - skipRefresh: opts.SkipRefresh, + Config: config, + State: prevRunState, + RootVariableValues: opts.SetVariables, + Plugins: c.plugins, + Targets: opts.Targets, + ForceReplace: opts.ForceReplace, + Validate: validate, + skipRefresh: opts.SkipRefresh, }).Build(addrs.RootModuleInstance) return graph, walkPlan, diags case plans.RefreshOnlyMode: graph, diags := (&PlanGraphBuilder{ - Config: config, - State: prevRunState, - Plugins: c.plugins, - Targets: opts.Targets, - Validate: validate, - skipRefresh: opts.SkipRefresh, - skipPlanChanges: true, // this activates "refresh only" mode. + Config: config, + State: prevRunState, + RootVariableValues: opts.SetVariables, + Plugins: c.plugins, + Targets: opts.Targets, + Validate: validate, + skipRefresh: opts.SkipRefresh, + skipPlanChanges: true, // this activates "refresh only" mode. }).Build(addrs.RootModuleInstance) return graph, walkPlan, diags case plans.DestroyMode: graph, diags := (&DestroyPlanGraphBuilder{ - Config: config, - State: prevRunState, - Plugins: c.plugins, - Targets: opts.Targets, - Validate: validate, - skipRefresh: opts.SkipRefresh, + Config: config, + State: prevRunState, + RootVariableValues: opts.SetVariables, + Plugins: c.plugins, + Targets: opts.Targets, + Validate: validate, + skipRefresh: opts.SkipRefresh, }).Build(addrs.RootModuleInstance) return graph, walkPlanDestroy, diags default: diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go index fb54be420221..4fb02f767164 100644 --- a/internal/terraform/context_validate.go +++ b/internal/terraform/context_validate.go @@ -37,17 +37,6 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { log.Printf("[DEBUG] Building and walking validate graph") - graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ - Config: config, - Plugins: c.plugins, - Validate: true, - State: states.NewState(), - }).Build(addrs.RootModuleInstance) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - return diags - } - // Validate is to check if the given module is valid regardless of // input values, current state, etc. Therefore we populate all of the // input values with unknown values of the expected type, allowing us @@ -66,9 +55,20 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { } } - walker, walkDiags := c.walk(graph, walkValidate, &graphWalkOpts{ + graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ Config: config, + Plugins: c.plugins, + Validate: true, + State: states.NewState(), RootVariableValues: varValues, + }).Build(addrs.RootModuleInstance) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return diags + } + + walker, walkDiags := c.walk(graph, walkValidate, &graphWalkOpts{ + Config: config, }) diags = diags.Append(walker.NonFatalDiagnostics) diags = diags.Append(walkDiags) diff --git a/internal/terraform/context_walk.go b/internal/terraform/context_walk.go index 166341513cce..e8b506314ede 100644 --- a/internal/terraform/context_walk.go +++ b/internal/terraform/context_walk.go @@ -23,8 +23,7 @@ type graphWalkOpts struct { Changes *plans.Changes Config *configs.Config - RootVariableValues InputValues - MoveResults refactoring.MoveResults + MoveResults refactoring.MoveResults } func (c *Context) walk(graph *Graph, operation walkOperation, opts *graphWalkOpts) (*ContextGraphWalker, tfdiags.Diagnostics) { @@ -98,16 +97,15 @@ func (c *Context) graphWalker(operation walkOperation, opts *graphWalkOpts) *Con } return &ContextGraphWalker{ - Context: c, - State: state, - Config: opts.Config, - RefreshState: refreshState, - PrevRunState: prevRunState, - Changes: changes.SyncWrapper(), - InstanceExpander: instances.NewExpander(), - MoveResults: opts.MoveResults, - Operation: operation, - StopContext: c.runContext, - RootVariableValues: opts.RootVariableValues, + Context: c, + State: state, + Config: opts.Config, + RefreshState: refreshState, + PrevRunState: prevRunState, + Changes: changes.SyncWrapper(), + InstanceExpander: instances.NewExpander(), + MoveResults: opts.MoveResults, + Operation: operation, + StopContext: c.runContext, } } diff --git a/internal/terraform/eval_context.go b/internal/terraform/eval_context.go index 4b5a3a5c2cac..8a5958ceb0d4 100644 --- a/internal/terraform/eval_context.go +++ b/internal/terraform/eval_context.go @@ -121,12 +121,24 @@ type EvalContext interface { // addresses in this context. EvaluationScope(self addrs.Referenceable, keyData InstanceKeyEvalData) *lang.Scope - // SetModuleCallArguments defines values for the variables of a particular - // child module call. + // SetRootModuleArgument defines the value for one variable of the root + // module. The caller must ensure that given value is a suitable + // "final value" for the variable, which means that it's already converted + // and validated to match any configured constraints and validation rules. // - // Calling this function multiple times has merging behavior, keeping any - // previously-set keys that are not present in the new map. - SetModuleCallArguments(addrs.ModuleCallInstance, map[string]cty.Value) + // Calling this function multiple times with the same variable address + // will silently overwrite the value provided by a previous call. + SetRootModuleArgument(addrs.InputVariable, cty.Value) + + // SetModuleCallArgument defines the value for one input variable of a + // particular child module call. The caller must ensure that the given + // value is a suitable "final value" for the variable, which means that + // it's already converted and validated to match any configured + // constraints and validation rules. + // + // Calling this function multiple times with the same variable address + // will silently overwrite the value provided by a previous call. + SetModuleCallArgument(addrs.ModuleCallInstance, addrs.InputVariable, cty.Value) // GetVariableValue returns the value provided for the input variable with // the given address, or cty.DynamicVal if the variable hasn't been assigned diff --git a/internal/terraform/eval_context_builtin.go b/internal/terraform/eval_context_builtin.go index ecbac446e7cc..35170bcd6ab3 100644 --- a/internal/terraform/eval_context_builtin.go +++ b/internal/terraform/eval_context_builtin.go @@ -313,7 +313,21 @@ func (ctx *BuiltinEvalContext) Path() addrs.ModuleInstance { return ctx.PathValue } -func (ctx *BuiltinEvalContext) SetModuleCallArguments(n addrs.ModuleCallInstance, vals map[string]cty.Value) { +func (ctx *BuiltinEvalContext) SetRootModuleArgument(addr addrs.InputVariable, v cty.Value) { + ctx.VariableValuesLock.Lock() + defer ctx.VariableValuesLock.Unlock() + + log.Printf("[TRACE] BuiltinEvalContext: Storing final value for variable %s", addr.Absolute(addrs.RootModuleInstance)) + key := addrs.RootModuleInstance.String() + args := ctx.VariableValues[key] + if args == nil { + args = make(map[string]cty.Value) + ctx.VariableValues[key] = args + } + args[addr.Name] = v +} + +func (ctx *BuiltinEvalContext) SetModuleCallArgument(callAddr addrs.ModuleCallInstance, varAddr addrs.InputVariable, v cty.Value) { ctx.VariableValuesLock.Lock() defer ctx.VariableValuesLock.Unlock() @@ -321,18 +335,15 @@ func (ctx *BuiltinEvalContext) SetModuleCallArguments(n addrs.ModuleCallInstance panic("context path not set") } - childPath := n.ModuleInstance(ctx.PathValue) + childPath := callAddr.ModuleInstance(ctx.PathValue) + log.Printf("[TRACE] BuiltinEvalContext: Storing final value for variable %s", varAddr.Absolute(childPath)) key := childPath.String() - args := ctx.VariableValues[key] if args == nil { - ctx.VariableValues[key] = vals - return - } - - for k, v := range vals { - args[k] = v + args = make(map[string]cty.Value) + ctx.VariableValues[key] = args } + args[varAddr.Name] = v } func (ctx *BuiltinEvalContext) GetVariableValue(addr addrs.AbsInputVariableInstance) cty.Value { diff --git a/internal/terraform/eval_context_mock.go b/internal/terraform/eval_context_mock.go index edcdaac6b62c..8dd6ec3343d4 100644 --- a/internal/terraform/eval_context_mock.go +++ b/internal/terraform/eval_context_mock.go @@ -111,13 +111,21 @@ type MockEvalContext struct { PathCalled bool PathPath addrs.ModuleInstance - SetModuleCallArgumentsCalled bool - SetModuleCallArgumentsModule addrs.ModuleCallInstance - SetModuleCallArgumentsValues map[string]cty.Value + SetRootModuleArgumentCalled bool + SetRootModuleArgumentAddr addrs.InputVariable + SetRootModuleArgumentValue cty.Value + SetRootModuleArgumentFunc func(addr addrs.InputVariable, v cty.Value) + + SetModuleCallArgumentCalled bool + SetModuleCallArgumentModuleCall addrs.ModuleCallInstance + SetModuleCallArgumentVariable addrs.InputVariable + SetModuleCallArgumentValue cty.Value + SetModuleCallArgumentFunc func(callAddr addrs.ModuleCallInstance, varAddr addrs.InputVariable, v cty.Value) GetVariableValueCalled bool GetVariableValueAddr addrs.AbsInputVariableInstance GetVariableValueValue cty.Value + GetVariableValueFunc func(addr addrs.AbsInputVariableInstance) cty.Value // supersedes GetVariableValueValue ChangesCalled bool ChangesChanges *plans.ChangesSync @@ -321,15 +329,31 @@ func (c *MockEvalContext) Path() addrs.ModuleInstance { return c.PathPath } -func (c *MockEvalContext) SetModuleCallArguments(n addrs.ModuleCallInstance, values map[string]cty.Value) { - c.SetModuleCallArgumentsCalled = true - c.SetModuleCallArgumentsModule = n - c.SetModuleCallArgumentsValues = values +func (c *MockEvalContext) SetRootModuleArgument(addr addrs.InputVariable, v cty.Value) { + c.SetRootModuleArgumentCalled = true + c.SetRootModuleArgumentAddr = addr + c.SetRootModuleArgumentValue = v + if c.SetRootModuleArgumentFunc != nil { + c.SetRootModuleArgumentFunc(addr, v) + } +} + +func (c *MockEvalContext) SetModuleCallArgument(callAddr addrs.ModuleCallInstance, varAddr addrs.InputVariable, v cty.Value) { + c.SetModuleCallArgumentCalled = true + c.SetModuleCallArgumentModuleCall = callAddr + c.SetModuleCallArgumentVariable = varAddr + c.SetModuleCallArgumentValue = v + if c.SetModuleCallArgumentFunc != nil { + c.SetModuleCallArgumentFunc(callAddr, varAddr, v) + } } func (c *MockEvalContext) GetVariableValue(addr addrs.AbsInputVariableInstance) cty.Value { c.GetVariableValueCalled = true c.GetVariableValueAddr = addr + if c.GetVariableValueFunc != nil { + return c.GetVariableValueFunc(addr) + } return c.GetVariableValueValue } diff --git a/internal/terraform/eval_variable.go b/internal/terraform/eval_variable.go index bdfadd2e9c70..1c16069ad4c1 100644 --- a/internal/terraform/eval_variable.go +++ b/internal/terraform/eval_variable.go @@ -12,6 +12,102 @@ import ( "github.com/zclconf/go-cty/cty/convert" ) +func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given cty.Value, valRange tfdiags.SourceRange, cfg *configs.Variable) (cty.Value, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + convertTy := cfg.ConstraintType + log.Printf("[TRACE] prepareFinalInputVariableValue: preparing %s", addr) + + var defaultVal cty.Value + if cfg.Default != cty.NilVal { + log.Printf("[TRACE] prepareFinalInputVariableValue: %s has a default value", addr) + var err error + defaultVal, err = convert.Convert(cfg.Default, convertTy) + if err != nil { + // Validation of the declaration should typically catch this, + // but we'll check it here too to be robust. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid default value for module argument", + Detail: fmt.Sprintf( + "The default value for variable %q is incompatible with its type constraint: %s.", + cfg.Name, err, + ), + Subject: &cfg.DeclRange, + }) + // We'll return a placeholder unknown value to avoid producing + // redundant downstream errors. + return cty.UnknownVal(cfg.Type), diags + } + } + + if given == cty.NilVal { // The variable wasn't set at all (even to null) + log.Printf("[TRACE] prepareFinalInputVariableValue: %s has no defined value", addr) + if cfg.Required() { + // NOTE: The CLI layer typically checks for itself whether all of + // the required _root_ module variables are not set, which would + // mask this error. We can get here for child module variables, + // though. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Required variable not set`, + Detail: fmt.Sprintf(`The variable %q is required, but is not set.`, addr.Variable.Name), + Subject: valRange.ToHCL().Ptr(), + }) + // We'll return a placeholder unknown value to avoid producing + // redundant downstream errors. + return cty.UnknownVal(cfg.Type), diags + } + + given = defaultVal // must be set, because we checked above that the variable isn't required + } + + val, err := convert.Convert(given, convertTy) + if err != nil { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid value for module argument", + Detail: fmt.Sprintf( + "The given value is not suitable for child module variable %q defined at %s: %s.", + cfg.Name, cfg.DeclRange.String(), err, + ), + Subject: valRange.ToHCL().Ptr(), + }) + // We'll return a placeholder unknown value to avoid producing + // redundant downstream errors. + return cty.UnknownVal(cfg.Type), diags + } + + // By the time we get here, we know: + // - val matches the variable's type constraint + // - val is definitely not cty.NilVal, but might be a null value if the given was already null. + // + // That means we just need to handle the case where the value is null, + // which might mean we need to use the default value, or produce an error. + // + // For historical reasons we do this only for a "non-nullable" variable. + // Nullable variables just appear as null if they were set to null, + // regardless of any default value. + if val.IsNull() && !cfg.Nullable { + log.Printf("[TRACE] prepareFinalInputVariableValue: %s is defined as null", addr) + if defaultVal != cty.NilVal { + val = defaultVal + } else { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Required variable not set`, + Detail: fmt.Sprintf(`The variable %q is required, but the given value is null.`, addr.Variable.Name), + Subject: valRange.ToHCL().Ptr(), + }) + // Stub out our return value so that the semantic checker doesn't + // produce redundant downstream errors. + val = cty.UnknownVal(cfg.Type) + } + } + + return val, diags +} + // evalVariableValidations ensures that all of the configured custom validations // for a variable are passing. // @@ -20,9 +116,10 @@ import ( // EvalModuleCallArgument for variables in descendent modules. func evalVariableValidations(addr addrs.AbsInputVariableInstance, config *configs.Variable, expr hcl.Expression, ctx EvalContext) (diags tfdiags.Diagnostics) { if config == nil || len(config.Validations) == 0 { - log.Printf("[TRACE] evalVariableValidations: not active for %s, so skipping", addr) + log.Printf("[TRACE] evalVariableValidations: no validation rules declared for %s, so skipping", addr) return nil } + log.Printf("[TRACE] evalVariableValidations: validating %s", addr) // Variable nodes evaluate in the parent module to where they were declared // because the value expression (n.Expr, if set) comes from the calling @@ -34,6 +131,14 @@ func evalVariableValidations(addr addrs.AbsInputVariableInstance, config *config // evaluation context containing just the required value, and thus avoid // the problem that ctx's evaluation functions refer to the wrong module. val := ctx.GetVariableValue(addr) + if val == cty.NilVal { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "No final value for variable", + Detail: fmt.Sprintf("Terraform doesn't have a final value for %s during validation. This is a bug in Terraform; please report it!", addr), + }) + return diags + } hclCtx := &hcl.EvalContext{ Variables: map[string]cty.Value{ "var": cty.ObjectVal(map[string]cty.Value{ diff --git a/internal/terraform/eval_variable_test.go b/internal/terraform/eval_variable_test.go new file mode 100644 index 000000000000..fa4048fed41f --- /dev/null +++ b/internal/terraform/eval_variable_test.go @@ -0,0 +1,426 @@ +package terraform + +import ( + "fmt" + "testing" + + "github.com/zclconf/go-cty/cty" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +func TestPrepareFinalInputVariableValue(t *testing.T) { + // This is just a concise way to define a bunch of *configs.Variable + // objects to use in our tests below. We're only going to decode this + // config, not fully evaluate it. + cfgSrc := ` + variable "nullable_required" { + } + variable "nullable_optional_default_string" { + default = "hello" + } + variable "nullable_optional_default_null" { + default = null + } + variable "constrained_string_nullable_required" { + type = string + } + variable "constrained_string_nullable_optional_default_string" { + type = string + default = "hello" + } + variable "constrained_string_nullable_optional_default_bool" { + type = string + default = true + } + variable "constrained_string_nullable_optional_default_null" { + type = string + default = null + } + variable "required" { + nullable = false + } + variable "optional_default_string" { + nullable = false + default = "hello" + } + variable "constrained_string_required" { + nullable = false + type = string + } + variable "constrained_string_optional_default_string" { + nullable = false + type = string + default = "hello" + } + variable "constrained_string_optional_default_bool" { + nullable = false + type = string + default = true + } + ` + cfg := testModuleInline(t, map[string]string{ + "main.tf": cfgSrc, + }) + variableConfigs := cfg.Module.Variables + + tests := []struct { + varName string + given cty.Value + want cty.Value + wantErr string + }{ + // nullable_required + { + "nullable_required", + cty.NilVal, + cty.UnknownVal(cty.DynamicPseudoType), + `Required variable not set: The variable "nullable_required" is required, but is not set.`, + }, + { + "nullable_required", + cty.NullVal(cty.DynamicPseudoType), + cty.NullVal(cty.DynamicPseudoType), + ``, // "required" for a nullable variable means only that it must be set, even if it's set to null + }, + { + "nullable_required", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "nullable_required", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // nullable_optional_default_string + { + "nullable_optional_default_string", + cty.NilVal, + cty.StringVal("hello"), // the declared default value + ``, + }, + { + "nullable_optional_default_string", + cty.NullVal(cty.DynamicPseudoType), + cty.NullVal(cty.DynamicPseudoType), // nullable variables can be really set to null, masking the default + ``, + }, + { + "nullable_optional_default_string", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "nullable_optional_default_string", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // nullable_optional_default_null + { + "nullable_optional_default_null", + cty.NilVal, + cty.NullVal(cty.DynamicPseudoType), // the declared default value + ``, + }, + { + "nullable_optional_default_null", + cty.NullVal(cty.String), + cty.NullVal(cty.String), // nullable variables can be really set to null, masking the default + ``, + }, + { + "nullable_optional_default_null", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "nullable_optional_default_null", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_nullable_required + { + "constrained_string_nullable_required", + cty.NilVal, + cty.UnknownVal(cty.String), + `Required variable not set: The variable "constrained_string_nullable_required" is required, but is not set.`, + }, + { + "constrained_string_nullable_required", + cty.NullVal(cty.DynamicPseudoType), + cty.NullVal(cty.String), // the null value still gets converted to match the type constraint + ``, // "required" for a nullable variable means only that it must be set, even if it's set to null + }, + { + "constrained_string_nullable_required", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_nullable_required", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_nullable_optional_default_string + { + "constrained_string_nullable_optional_default_string", + cty.NilVal, + cty.StringVal("hello"), // the declared default value + ``, + }, + { + "constrained_string_nullable_optional_default_string", + cty.NullVal(cty.DynamicPseudoType), + cty.NullVal(cty.String), // nullable variables can be really set to null, masking the default + ``, + }, + { + "constrained_string_nullable_optional_default_string", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_nullable_optional_default_string", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_nullable_optional_default_bool + { + "constrained_string_nullable_optional_default_bool", + cty.NilVal, + cty.StringVal("true"), // the declared default value, automatically converted to match type constraint + ``, + }, + { + "constrained_string_nullable_optional_default_bool", + cty.NullVal(cty.DynamicPseudoType), + cty.NullVal(cty.String), // nullable variables can be really set to null, masking the default + ``, + }, + { + "constrained_string_nullable_optional_default_bool", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_nullable_optional_default_bool", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_nullable_optional_default_null + { + "constrained_string_nullable_optional_default_null", + cty.NilVal, + cty.NullVal(cty.String), + ``, + }, + { + "constrained_string_nullable_optional_default_null", + cty.NullVal(cty.DynamicPseudoType), + cty.NullVal(cty.String), + ``, + }, + { + "constrained_string_nullable_optional_default_null", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_nullable_optional_default_null", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // required + { + "required", + cty.NilVal, + cty.UnknownVal(cty.DynamicPseudoType), + `Required variable not set: The variable "required" is required, but is not set.`, + }, + { + "required", + cty.NullVal(cty.DynamicPseudoType), + cty.UnknownVal(cty.DynamicPseudoType), + `Required variable not set: The variable "required" is required, but the given value is null.`, + }, + { + "required", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "required", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // optional_default_string + { + "optional_default_string", + cty.NilVal, + cty.StringVal("hello"), // the declared default value + ``, + }, + { + "optional_default_string", + cty.NullVal(cty.DynamicPseudoType), + cty.StringVal("hello"), // the declared default value + ``, + }, + { + "optional_default_string", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "optional_default_string", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_required + { + "constrained_string_required", + cty.NilVal, + cty.UnknownVal(cty.String), + `Required variable not set: The variable "constrained_string_required" is required, but is not set.`, + }, + { + "constrained_string_required", + cty.NullVal(cty.DynamicPseudoType), + cty.UnknownVal(cty.String), + `Required variable not set: The variable "constrained_string_required" is required, but the given value is null.`, + }, + { + "constrained_string_required", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_required", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_optional_default_string + { + "constrained_string_optional_default_string", + cty.NilVal, + cty.StringVal("hello"), // the declared default value + ``, + }, + { + "constrained_string_optional_default_string", + cty.NullVal(cty.DynamicPseudoType), + cty.StringVal("hello"), // the declared default value + ``, + }, + { + "constrained_string_optional_default_string", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_optional_default_string", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + + // constrained_string_optional_default_bool + { + "constrained_string_optional_default_bool", + cty.NilVal, + cty.StringVal("true"), // the declared default value, automatically converted to match type constraint + ``, + }, + { + "constrained_string_optional_default_bool", + cty.NullVal(cty.DynamicPseudoType), + cty.StringVal("true"), // the declared default value, automatically converted to match type constraint + ``, + }, + { + "constrained_string_optional_default_bool", + cty.StringVal("ahoy"), + cty.StringVal("ahoy"), + ``, + }, + { + "constrained_string_optional_default_bool", + cty.UnknownVal(cty.String), + cty.UnknownVal(cty.String), + ``, + }, + } + + for _, test := range tests { + t.Run(fmt.Sprintf("%s %#v", test.varName, test.given), func(t *testing.T) { + varAddr := addrs.InputVariable{Name: test.varName}.Absolute(addrs.RootModuleInstance) + varCfg := variableConfigs[test.varName] + if varCfg == nil { + t.Fatalf("invalid variable name %q", test.varName) + } + + t.Logf( + "test case\nvariable: %s\nconstraint: %#v\ndefault: %#v\nnullable: %#v\ngiven value: %#v", + varAddr, + varCfg.Type, + varCfg.Default, + varCfg.Nullable, + test.given, + ) + + got, diags := prepareFinalInputVariableValue( + varAddr, test.given, tfdiags.SourceRangeFromHCL(varCfg.DeclRange), varCfg, + ) + + if test.wantErr != "" { + if !diags.HasErrors() { + t.Errorf("unexpected success\nwant error: %s", test.wantErr) + } else if got, want := diags.Err().Error(), test.wantErr; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } + } else { + if diags.HasErrors() { + t.Errorf("unexpected error\ngot: %s", diags.Err().Error()) + } + } + + // NOTE: should still have returned some reasonable value even if there was an error + if !test.want.RawEquals(got) { + t.Fatalf("wrong result\ngot: %#v\nwant: %#v", got, test.want) + } + }) + } +} diff --git a/internal/terraform/evaluate.go b/internal/terraform/evaluate.go index 322ef6fda4d0..243335df2642 100644 --- a/internal/terraform/evaluate.go +++ b/internal/terraform/evaluate.go @@ -10,7 +10,6 @@ import ( "github.com/agext/levenshtein" "github.com/hashicorp/hcl/v2" "github.com/zclconf/go-cty/cty" - "github.com/zclconf/go-cty/cty/convert" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" @@ -248,7 +247,7 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd // This is important because otherwise the validation walk will tend to be // overly strict, requiring expressions throughout the configuration to // be complicated to accommodate all possible inputs, whereas returning - // known here allows for simpler patterns like using input values as + // unknown here allows for simpler patterns like using input values as // guards to broadly enable/disable resources, avoid processing things // that are disabled, etc. Terraform's static validation leans towards // being liberal in what it accepts because the subsequent plan walk has @@ -267,28 +266,27 @@ func (d *evaluationStateData) GetInputVariable(addr addrs.InputVariable, rng tfd return cty.UnknownVal(config.Type), diags } - val, isSet := vals[addr.Name] - switch { - case !isSet: - // The config loader will ensure there is a default if the value is not - // set at all. - val = config.Default - - case val.IsNull() && !config.Nullable && config.Default != cty.NilVal: - // If nullable=false a null value will use the configured default. - val = config.Default - } + // d.Evaluator.VariableValues should always contain valid "final values" + // for variables, which is to say that they have already had type + // conversions, validations, and default value handling applied to them. + // Those are the responsibility of the graph notes representing the + // variable declarations. Therefore here we just trust that we already + // have a correct value. - var err error - val, err = convert.Convert(val, config.ConstraintType) - if err != nil { - // We should never get here because this problem should've been caught - // during earlier validation, but we'll do something reasonable anyway. + val, isSet := vals[addr.Name] + if !isSet { + // We should not be able to get here without having a valid value + // for every variable, so this always indicates a bug in either + // the graph builder (not including all the needed nodes) or in + // the graph nodes representing variables. diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, - Summary: `Incorrect variable type`, - Detail: fmt.Sprintf(`The resolved value of variable %q is not appropriate: %s.`, addr.Name, err), - Subject: &config.DeclRange, + Summary: `Reference to unresolved input variable`, + Detail: fmt.Sprintf( + `The final value for %s is missing in Terraform's evaluation context. This is a bug in Terraform; please report it!`, + addr.Absolute(d.ModulePath), + ), + Subject: rng.ToHCL().Ptr(), }) val = cty.UnknownVal(config.Type) } diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go index 75f9d3d4ad25..86d825560276 100644 --- a/internal/terraform/graph_builder_apply.go +++ b/internal/terraform/graph_builder_apply.go @@ -26,6 +26,11 @@ type ApplyGraphBuilder struct { // State is the current state State *states.State + // RootVariableValues are the root module input variables captured as + // part of the plan object, which we must reproduce in the apply step + // to get a consistent result. + RootVariableValues InputValues + // Plugins is a library of the plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins @@ -88,7 +93,7 @@ func (b *ApplyGraphBuilder) Steps() []GraphTransformer { }, // Add dynamic values - &RootVariableTransformer{Config: b.Config}, + &RootVariableTransformer{Config: b.Config, RawValues: b.RootVariableValues}, &ModuleVariableTransformer{Config: b.Config}, &LocalTransformer{Config: b.Config}, &OutputTransformer{Config: b.Config, Changes: b.Changes}, diff --git a/internal/terraform/graph_builder_destroy_plan.go b/internal/terraform/graph_builder_destroy_plan.go index 0bac6305e08f..def1aa3739aa 100644 --- a/internal/terraform/graph_builder_destroy_plan.go +++ b/internal/terraform/graph_builder_destroy_plan.go @@ -23,6 +23,11 @@ type DestroyPlanGraphBuilder struct { // State is the current state State *states.State + // RootVariableValues are the raw input values for root input variables + // given by the caller, which we'll resolve into final values as part + // of the plan walk. + RootVariableValues InputValues + // Plugins is a library of plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins diff --git a/internal/terraform/graph_builder_eval.go b/internal/terraform/graph_builder_eval.go index ee9d6b8e83de..78031e21f9f3 100644 --- a/internal/terraform/graph_builder_eval.go +++ b/internal/terraform/graph_builder_eval.go @@ -30,6 +30,11 @@ type EvalGraphBuilder struct { // State is the current state State *states.State + // RootVariableValues are the raw input values for root input variables + // given by the caller, which we'll resolve into final values as part + // of the plan walk. + RootVariableValues InputValues + // Plugins is a library of plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins @@ -60,7 +65,7 @@ func (b *EvalGraphBuilder) Steps() []GraphTransformer { }, // Add dynamic values - &RootVariableTransformer{Config: b.Config}, + &RootVariableTransformer{Config: b.Config, RawValues: b.RootVariableValues}, &ModuleVariableTransformer{Config: b.Config}, &LocalTransformer{Config: b.Config}, &OutputTransformer{Config: b.Config}, diff --git a/internal/terraform/graph_builder_import.go b/internal/terraform/graph_builder_import.go index 9910354cf5f9..d8d609ebaa85 100644 --- a/internal/terraform/graph_builder_import.go +++ b/internal/terraform/graph_builder_import.go @@ -17,6 +17,11 @@ type ImportGraphBuilder struct { // Module is a configuration to build the graph from. See ImportOpts.Config. Config *configs.Config + // RootVariableValues are the raw input values for root input variables + // given by the caller, which we'll resolve into final values as part + // of the plan walk. + RootVariableValues InputValues + // Plugins is a library of plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins @@ -53,7 +58,7 @@ func (b *ImportGraphBuilder) Steps() []GraphTransformer { &ConfigTransformer{Config: config}, // Add dynamic values - &RootVariableTransformer{Config: b.Config}, + &RootVariableTransformer{Config: b.Config, RawValues: b.RootVariableValues}, &ModuleVariableTransformer{Config: b.Config}, &LocalTransformer{Config: b.Config}, &OutputTransformer{Config: b.Config}, diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index 709b917b6733..1b8ce58338a9 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -28,6 +28,11 @@ type PlanGraphBuilder struct { // State is the current state State *states.State + // RootVariableValues are the raw input values for root input variables + // given by the caller, which we'll resolve into final values as part + // of the plan walk. + RootVariableValues InputValues + // Plugins is a library of plug-in components (providers and // provisioners) available for use. Plugins *contextPlugins @@ -95,7 +100,7 @@ func (b *PlanGraphBuilder) Steps() []GraphTransformer { }, // Add dynamic values - &RootVariableTransformer{Config: b.Config}, + &RootVariableTransformer{Config: b.Config, RawValues: b.RootVariableValues}, &ModuleVariableTransformer{Config: b.Config}, &LocalTransformer{Config: b.Config}, &OutputTransformer{Config: b.Config}, diff --git a/internal/terraform/node_module_variable.go b/internal/terraform/node_module_variable.go index 9f15587eca1b..321cd874845f 100644 --- a/internal/terraform/node_module_variable.go +++ b/internal/terraform/node_module_variable.go @@ -12,7 +12,6 @@ import ( "github.com/hashicorp/terraform/internal/lang" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" - "github.com/zclconf/go-cty/cty/convert" ) // nodeExpandModuleVariable is the placeholder for an variable that has not yet had @@ -143,35 +142,27 @@ func (n *nodeModuleVariable) ModulePath() addrs.Module { // GraphNodeExecutable func (n *nodeModuleVariable) Execute(ctx EvalContext, op walkOperation) (diags tfdiags.Diagnostics) { - // If we have no value, do nothing - if n.Expr == nil { - return nil - } + log.Printf("[TRACE] nodeModuleVariable: evaluating %s", n.Addr) - // Otherwise, interpolate the value of this variable and set it - // within the variables mapping. - var vals map[string]cty.Value + var val cty.Value var err error switch op { case walkValidate: - vals, err = n.evalModuleCallArgument(ctx, true) + val, err = n.evalModuleCallArgument(ctx, true) diags = diags.Append(err) - if diags.HasErrors() { - return diags - } default: - vals, err = n.evalModuleCallArgument(ctx, false) + val, err = n.evalModuleCallArgument(ctx, false) diags = diags.Append(err) - if diags.HasErrors() { - return diags - } + } + if diags.HasErrors() { + return diags } // Set values for arguments of a child module call, for later retrieval // during expression evaluation. _, call := n.Addr.Module.CallInstance() - ctx.SetModuleCallArguments(call, vals) + ctx.SetModuleCallArgument(call, n.Addr.Variable, val) return evalVariableValidations(n.Addr, n.Config, n.Expr, ctx) } @@ -199,77 +190,45 @@ func (n *nodeModuleVariable) DotNode(name string, opts *dag.DotOpts) *dag.DotNod // validateOnly indicates that this evaluation is only for config // validation, and we will not have any expansion module instance // repetition data. -func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnly bool) (map[string]cty.Value, error) { - name := n.Addr.Variable.Name - expr := n.Expr - - if expr == nil { - // Should never happen, but we'll bail out early here rather than - // crash in case it does. We set no value at all in this case, - // making a subsequent call to EvalContext.SetModuleCallArguments - // a no-op. - log.Printf("[ERROR] attempt to evaluate %s with nil expression", n.Addr.String()) - return nil, nil - } - - var moduleInstanceRepetitionData instances.RepetitionData - - switch { - case validateOnly: - // the instance expander does not track unknown expansion values, so we - // have to assume all RepetitionData is unknown. - moduleInstanceRepetitionData = instances.RepetitionData{ - CountIndex: cty.UnknownVal(cty.Number), - EachKey: cty.UnknownVal(cty.String), - EachValue: cty.DynamicVal, +func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnly bool) (cty.Value, error) { + var diags tfdiags.Diagnostics + var givenVal cty.Value + var errSourceRange tfdiags.SourceRange + if expr := n.Expr; expr != nil { + var moduleInstanceRepetitionData instances.RepetitionData + + switch { + case validateOnly: + // the instance expander does not track unknown expansion values, so we + // have to assume all RepetitionData is unknown. + moduleInstanceRepetitionData = instances.RepetitionData{ + CountIndex: cty.UnknownVal(cty.Number), + EachKey: cty.UnknownVal(cty.String), + EachValue: cty.DynamicVal, + } + + default: + // Get the repetition data for this module instance, + // so we can create the appropriate scope for evaluating our expression + moduleInstanceRepetitionData = ctx.InstanceExpander().GetModuleInstanceRepetitionData(n.ModuleInstance) } - default: - // Get the repetition data for this module instance, - // so we can create the appropriate scope for evaluating our expression - moduleInstanceRepetitionData = ctx.InstanceExpander().GetModuleInstanceRepetitionData(n.ModuleInstance) - } - - scope := ctx.EvaluationScope(nil, moduleInstanceRepetitionData) - val, diags := scope.EvalExpr(expr, cty.DynamicPseudoType) - - // We intentionally passed DynamicPseudoType to EvalExpr above because - // now we can do our own local type conversion and produce an error message - // with better context if it fails. - var convErr error - val, convErr = convert.Convert(val, n.Config.ConstraintType) - if convErr != nil { - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Invalid value for module argument", - Detail: fmt.Sprintf( - "The given value is not suitable for child module variable %q defined at %s: %s.", - name, n.Config.DeclRange.String(), convErr, - ), - Subject: expr.Range().Ptr(), - }) - // We'll return a placeholder unknown value to avoid producing - // redundant downstream errors. - val = cty.UnknownVal(n.Config.Type) - } - - // If there is no default, we have to ensure that a null value is allowed - // for this variable. - if n.Config.Default == cty.NilVal && !n.Config.Nullable && val.IsNull() { - // The value cannot be null, and there is no configured default. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: `Invalid variable value`, - Detail: fmt.Sprintf(`The variable %q is required, but the given value is null.`, n.Addr), - Subject: &n.Config.DeclRange, - }) - // Stub out our return value so that the semantic checker doesn't - // produce redundant downstream errors. - val = cty.UnknownVal(n.Config.Type) + scope := ctx.EvaluationScope(nil, moduleInstanceRepetitionData) + val, moreDiags := scope.EvalExpr(expr, cty.DynamicPseudoType) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + return cty.DynamicVal, diags.ErrWithWarnings() + } + givenVal = val + errSourceRange = tfdiags.SourceRangeFromHCL(expr.Range()) + } else { + // We'll use cty.NilVal to represent the variable not being set at all. + givenVal = cty.NilVal + errSourceRange = tfdiags.SourceRangeFromHCL(n.Config.DeclRange) // we use the declaration range as a fallback for an undefined variable } - vals := make(map[string]cty.Value) - vals[name] = val + finalVal, moreDiags := prepareFinalInputVariableValue(n.Addr, givenVal, errSourceRange, n.Config) + diags = diags.Append(moreDiags) - return vals, diags.ErrWithWarnings() + return finalVal, diags.ErrWithWarnings() } diff --git a/internal/terraform/node_root_variable.go b/internal/terraform/node_root_variable.go index 56ee5149a571..d023be3500ba 100644 --- a/internal/terraform/node_root_variable.go +++ b/internal/terraform/node_root_variable.go @@ -1,16 +1,26 @@ package terraform import ( + "log" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/dag" "github.com/hashicorp/terraform/internal/tfdiags" + "github.com/zclconf/go-cty/cty" ) // NodeRootVariable represents a root variable input. type NodeRootVariable struct { Addr addrs.InputVariable Config *configs.Variable + + // RawValue is the value for the variable set from outside Terraform + // Core, such as on the command line, or from an environment variable, + // or similar. This is the raw value that was provided, not yet + // converted or validated, and can be nil for a variable that isn't + // set at all. + RawValue *InputValue } var ( @@ -38,21 +48,56 @@ func (n *NodeRootVariable) ReferenceableAddrs() []addrs.Referenceable { // GraphNodeExecutable func (n *NodeRootVariable) Execute(ctx EvalContext, op walkOperation) tfdiags.Diagnostics { - // We don't actually need to _evaluate_ a root module variable, because - // its value is always constant and already stashed away in our EvalContext. - // However, we might need to run some user-defined validation rules against - // the value. + // Root module variables are special in that they are provided directly + // by the caller (usually, the CLI layer) and so we don't really need to + // evaluate them in the usual sense, but we do need to process the raw + // values given by the caller to match what the module is expecting, and + // make sure the values are valid. + var diags tfdiags.Diagnostics + + addr := addrs.RootModuleInstance.InputVariable(n.Addr.Name) + log.Printf("[TRACE] NodeRootVariable: evaluating %s", addr) + + if n.Config == nil { + // Because we build NodeRootVariable from configuration in the normal + // case it's strange to get here, but we tolerate it to allow for + // tests that might not populate the inputs fully. + return nil + } - if n.Config == nil || len(n.Config.Validations) == 0 { - return nil // nothing to do + var givenVal cty.Value + if n.RawValue != nil { + givenVal = n.RawValue.Value + } else { + // We'll use cty.NilVal to represent the variable not being set at + // all, which for historical reasons is unfortunately different than + // explicitly setting it to null in some cases. + givenVal = cty.NilVal } - return evalVariableValidations( + finalVal, moreDiags := prepareFinalInputVariableValue( + addr, + givenVal, + tfdiags.SourceRangeFromHCL(n.Config.DeclRange), + n.Config, + ) + diags = diags.Append(moreDiags) + if moreDiags.HasErrors() { + // No point in proceeding to validations then, because they'll + // probably fail trying to work with a value of the wrong type. + return diags + } + + ctx.SetRootModuleArgument(addr.Variable, finalVal) + + moreDiags = evalVariableValidations( addrs.RootModuleInstance.InputVariable(n.Addr.Name), n.Config, nil, // not set for root module variables ctx, ) + diags = diags.Append(moreDiags) + return diags } // dag.GraphNodeDotter impl. diff --git a/internal/terraform/node_root_variable_test.go b/internal/terraform/node_root_variable_test.go index bd3d9c2d65c4..aecb7428a203 100644 --- a/internal/terraform/node_root_variable_test.go +++ b/internal/terraform/node_root_variable_test.go @@ -3,26 +3,164 @@ package terraform import ( "testing" + "github.com/hashicorp/hcl/v2" + "github.com/zclconf/go-cty/cty" + "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" - "github.com/zclconf/go-cty/cty" + "github.com/hashicorp/terraform/internal/lang" ) func TestNodeRootVariableExecute(t *testing.T) { - ctx := new(MockEvalContext) - - n := &NodeRootVariable{ - Addr: addrs.InputVariable{Name: "foo"}, - Config: &configs.Variable{ - Name: "foo", - Type: cty.String, - ConstraintType: cty.String, - }, - } + t.Run("type conversion", func(t *testing.T) { + ctx := new(MockEvalContext) + + n := &NodeRootVariable{ + Addr: addrs.InputVariable{Name: "foo"}, + Config: &configs.Variable{ + Name: "foo", + Type: cty.String, + ConstraintType: cty.String, + }, + RawValue: &InputValue{ + Value: cty.True, + SourceType: ValueFromUnknown, + }, + } + + diags := n.Execute(ctx, walkApply) + if diags.HasErrors() { + t.Fatalf("unexpected error: %s", diags.Err()) + } + + if !ctx.SetRootModuleArgumentCalled { + t.Fatalf("ctx.SetRootModuleArgument wasn't called") + } + if got, want := ctx.SetRootModuleArgumentAddr.String(), "var.foo"; got != want { + t.Errorf("wrong address for ctx.SetRootModuleArgument\ngot: %s\nwant: %s", got, want) + } + if got, want := ctx.SetRootModuleArgumentValue, cty.StringVal("true"); !want.RawEquals(got) { + // NOTE: The given value was cty.Bool but the type constraint was + // cty.String, so it was NodeRootVariable's responsibility to convert + // as part of preparing the "final value". + t.Errorf("wrong value for ctx.SetRootModuleArgument\ngot: %#v\nwant: %#v", got, want) + } + }) + t.Run("validation", func(t *testing.T) { + ctx := new(MockEvalContext) + + // The variable validation function gets called with Terraform's + // built-in functions available, so we need a minimal scope just for + // it to get the functions from. + ctx.EvaluationScopeScope = &lang.Scope{} + + // We need to reimplement a _little_ bit of EvalContextBuiltin logic + // here to get a similar effect with EvalContextMock just to get the + // value to flow through here in a realistic way that'll make this test + // useful. + var finalVal cty.Value + ctx.SetRootModuleArgumentFunc = func(addr addrs.InputVariable, v cty.Value) { + if addr.Name == "foo" { + t.Logf("set %s to %#v", addr.String(), v) + finalVal = v + } + } + ctx.GetVariableValueFunc = func(addr addrs.AbsInputVariableInstance) cty.Value { + if addr.String() != "var.foo" { + return cty.NilVal + } + t.Logf("reading final val for %s (%#v)", addr.String(), finalVal) + return finalVal + } + + n := &NodeRootVariable{ + Addr: addrs.InputVariable{Name: "foo"}, + Config: &configs.Variable{ + Name: "foo", + Type: cty.Number, + ConstraintType: cty.Number, + Validations: []*configs.VariableValidation{ + { + Condition: fakeHCLExpressionFunc(func(ctx *hcl.EvalContext) (cty.Value, hcl.Diagnostics) { + // This returns true only if the given variable value + // is exactly cty.Number, which allows us to verify + // that we were given the value _after_ type + // conversion. + // This had previously not been handled correctly, + // as reported in: + // https://github.com/hashicorp/terraform/issues/29899 + vars := ctx.Variables["var"] + if vars == cty.NilVal || !vars.Type().IsObjectType() || !vars.Type().HasAttribute("foo") { + t.Logf("var.foo isn't available") + return cty.False, nil + } + val := vars.GetAttr("foo") + if val == cty.NilVal || val.Type() != cty.Number { + t.Logf("var.foo is %#v; want a number", val) + return cty.False, nil + } + return cty.True, nil + }), + ErrorMessage: "Must be a number.", + }, + }, + }, + RawValue: &InputValue{ + // Note: This is a string, but the variable's type constraint + // is number so it should be converted before use. + Value: cty.StringVal("5"), + SourceType: ValueFromUnknown, + }, + } - diags := n.Execute(ctx, walkApply) - if diags.HasErrors() { - t.Fatalf("unexpected error: %s", diags.Err()) + diags := n.Execute(ctx, walkApply) + if diags.HasErrors() { + t.Fatalf("unexpected error: %s", diags.Err()) + } + + if !ctx.SetRootModuleArgumentCalled { + t.Fatalf("ctx.SetRootModuleArgument wasn't called") + } + if got, want := ctx.SetRootModuleArgumentAddr.String(), "var.foo"; got != want { + t.Errorf("wrong address for ctx.SetRootModuleArgument\ngot: %s\nwant: %s", got, want) + } + if got, want := ctx.SetRootModuleArgumentValue, cty.NumberIntVal(5); !want.RawEquals(got) { + // NOTE: The given value was cty.Bool but the type constraint was + // cty.String, so it was NodeRootVariable's responsibility to convert + // as part of preparing the "final value". + t.Errorf("wrong value for ctx.SetRootModuleArgument\ngot: %#v\nwant: %#v", got, want) + } + }) +} + +// fakeHCLExpressionFunc is a fake implementation of hcl.Expression that just +// directly produces a value with direct Go code. +// +// An expression of this type has no references and so it cannot access any +// variables from the EvalContext unless something else arranges for them +// to be guaranteed available. For example, custom variable validations just +// unconditionally have access to the variable they are validating regardless +// of references. +type fakeHCLExpressionFunc func(*hcl.EvalContext) (cty.Value, hcl.Diagnostics) + +var _ hcl.Expression = fakeHCLExpressionFunc(nil) + +func (f fakeHCLExpressionFunc) Value(ctx *hcl.EvalContext) (cty.Value, hcl.Diagnostics) { + return f(ctx) +} + +func (f fakeHCLExpressionFunc) Variables() []hcl.Traversal { + return nil +} + +func (f fakeHCLExpressionFunc) Range() hcl.Range { + return hcl.Range{ + Filename: "fake", + Start: hcl.InitialPos, + End: hcl.InitialPos, } +} +func (f fakeHCLExpressionFunc) StartRange() hcl.Range { + return f.Range() } diff --git a/internal/terraform/transform_variable.go b/internal/terraform/transform_variable.go index 86bd6a981aff..4262ea3d6db0 100644 --- a/internal/terraform/transform_variable.go +++ b/internal/terraform/transform_variable.go @@ -13,6 +13,8 @@ import ( // reach them. type RootVariableTransformer struct { Config *configs.Config + + RawValues InputValues } func (t *RootVariableTransformer) Transform(g *Graph) error { @@ -31,7 +33,8 @@ func (t *RootVariableTransformer) Transform(g *Graph) error { Addr: addrs.InputVariable{ Name: v.Name, }, - Config: v, + Config: v, + RawValue: t.RawValues[v.Name], } g.Add(node) } From 36c4d4c241b3402d7fbf677e4e7850f6ab80e66f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 20 Dec 2021 16:38:52 -0800 Subject: [PATCH 497/644] core and backend: remove redundant handling of default variable values Previously we had three different layers all thinking they were responsible for substituting a default value for an unset root module variable: - the local backend, via logic in backend.ParseVariableValues - the context.Plan function (and other similar functions) trying to preprocess the input variables using terraform.mergeDefaultInputVariableValues . - the newer prepareFinalInputVariableValue, which aims to centralize all of the variable preparation logic so it can be common to both root and child module variables. The second of these was also trying to handle type constraint checking, which is also the responsibility of the central function and not something we need to handle so early. Only the last of these consistently handles both root and child module variables, and so is the one we ought to keep. The others are now redundant and are causing prepareFinalInputVariableValue to get a slightly corrupted view of the caller's chosen variable values. To rectify that, here we remove the two redundant layers altogether and have unset root variables pass through as cty.NilVal all the way to the central prepareFinalInputVariableValue function, which will then handle them in a suitable way which properly respects the "nullable" setting. This commit includes some test changes in the terraform package to make those tests no longer rely on the mergeDefaultInputVariableValues logic we've removed, and to instead explicitly set cty.NilVal for all unset variables to comply with our intended contract for PlanOpts.SetVariables, and similar. (This is so that we can more easily catch bugs in callers where they _don't_ correctly handle input variables; it allows us to distinguish between the caller explicitly marking a variable as unset vs. not describing it at all, where the latter is a bug in the caller.) --- internal/backend/unparsed_value.go | 17 +- internal/backend/unparsed_value_test.go | 2 +- internal/command/jsonplan/plan.go | 43 +++++- internal/terraform/context_apply.go | 15 ++ internal/terraform/context_apply2_test.go | 6 +- internal/terraform/context_apply_test.go | 59 ++++--- internal/terraform/context_eval.go | 2 +- internal/terraform/context_eval_test.go | 4 +- internal/terraform/context_import.go | 2 +- internal/terraform/context_plan.go | 69 ++++++++- internal/terraform/context_plan2_test.go | 2 +- internal/terraform/context_plan_test.go | 15 +- internal/terraform/eval_variable.go | 10 +- internal/terraform/variables.go | 135 ++++++---------- internal/terraform/variables_test.go | 180 +++------------------- 15 files changed, 255 insertions(+), 306 deletions(-) diff --git a/internal/backend/unparsed_value.go b/internal/backend/unparsed_value.go index 91c9825826e2..e7eadea9a1f8 100644 --- a/internal/backend/unparsed_value.go +++ b/internal/backend/unparsed_value.go @@ -164,13 +164,18 @@ func ParseVariableValues(vv map[string]UnparsedVariableValue, decls map[string]* // By this point we should've gathered all of the required root module // variables from one of the many possible sources. We'll now populate - // any we haven't gathered as their defaults and fail if any of the - // missing ones are required. + // any we haven't gathered as unset placeholders which Terraform Core + // can then react to. for name, vc := range decls { if isDefinedAny(name, ret, undeclared) { continue } + // This check is redundant with a check made in Terraform Core when + // processing undeclared variables, but allows us to generate a more + // specific error message which mentions -var and -var-file command + // line options, whereas the one in Terraform Core is more general + // due to supporting both root and child module variables. if vc.Required() { diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, @@ -189,8 +194,14 @@ func ParseVariableValues(vv map[string]UnparsedVariableValue, decls map[string]* SourceRange: tfdiags.SourceRangeFromHCL(vc.DeclRange), } } else { + // We're still required to put an entry for this variable + // in the mapping to be explicit to Terraform Core that we + // visited it, but its value will be cty.NilVal to represent + // that it wasn't set at all at this layer, and so Terraform Core + // should substitute a default if available, or generate an error + // if not. ret[name] = &terraform.InputValue{ - Value: vc.Default, + Value: cty.NilVal, SourceType: terraform.ValueFromConfig, SourceRange: tfdiags.SourceRangeFromHCL(vc.DeclRange), } diff --git a/internal/backend/unparsed_value_test.go b/internal/backend/unparsed_value_test.go index 981c84a43e7a..8807d243d782 100644 --- a/internal/backend/unparsed_value_test.go +++ b/internal/backend/unparsed_value_test.go @@ -204,7 +204,7 @@ func TestUnparsedValue(t *testing.T) { }, }, "missing2": { - Value: cty.StringVal("default for missing2"), + Value: cty.NilVal, // Terraform Core handles substituting the default SourceType: terraform.ValueFromConfig, SourceRange: tfdiags.SourceRange{ Filename: "fake.tf", diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index 64d77c05a54e..06ed97961012 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -118,7 +118,7 @@ func Marshal( output := newPlan() output.TerraformVersion = version.String() - err := output.marshalPlanVariables(p.VariableValues, schemas) + err := output.marshalPlanVariables(p.VariableValues, config.Module.Variables) if err != nil { return nil, fmt.Errorf("error in marshalPlanVariables: %s", err) } @@ -183,11 +183,7 @@ func Marshal( return ret, err } -func (p *plan) marshalPlanVariables(vars map[string]plans.DynamicValue, schemas *terraform.Schemas) error { - if len(vars) == 0 { - return nil - } - +func (p *plan) marshalPlanVariables(vars map[string]plans.DynamicValue, decls map[string]*configs.Variable) error { p.Variables = make(variables, len(vars)) for k, v := range vars { @@ -203,6 +199,41 @@ func (p *plan) marshalPlanVariables(vars map[string]plans.DynamicValue, schemas Value: valJSON, } } + + // In Terraform v1.1 and earlier we had some confusion about which subsystem + // of Terraform was the one responsible for substituting in default values + // for unset module variables, with root module variables being handled in + // three different places while child module variables were only handled + // during the Terraform Core graph walk. + // + // For Terraform v1.2 and later we rationalized that by having the Terraform + // Core graph walk always be responsible for selecting defaults regardless + // of root vs. child module, but unfortunately our earlier accidental + // misbehavior bled out into the public interface by making the defaults + // show up in the "vars" map to this function. Those are now correctly + // omitted (so that the plan file only records the variables _actually_ + // set by the caller) but consumers of the JSON plan format may be depending + // on our old behavior and so we'll fake it here just in time so that + // outside consumers won't see a behavior change. + for name, decl := range decls { + if _, ok := p.Variables[name]; ok { + continue + } + if val := decl.Default; val != cty.NilVal { + valJSON, err := ctyjson.Marshal(val, val.Type()) + if err != nil { + return err + } + p.Variables[name] = &variable{ + Value: valJSON, + } + } + } + + if len(p.Variables) == 0 { + p.Variables = nil // omit this property if there are no variables to describe + } + return nil } diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go index 42520b03dd83..d3cd9dc2d575 100644 --- a/internal/terraform/context_apply.go +++ b/internal/terraform/context_apply.go @@ -87,6 +87,21 @@ func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, validate return nil, walkApply, diags } + // The plan.VariableValues field only records variables that were actually + // set by the caller in the PlanOpts, so we may need to provide + // placeholders for any other variables that the user didn't set, in + // which case Terraform will once again use the default value from the + // configuration when we visit these variables during the graph walk. + for name := range config.Module.Variables { + if _, ok := variables[name]; ok { + continue + } + variables[name] = &InputValue{ + Value: cty.NilVal, + SourceType: ValueFromPlan, + } + } + graph, moreDiags := (&ApplyGraphBuilder{ Config: config, Changes: plan.Changes, diff --git a/internal/terraform/context_apply2_test.go b/internal/terraform/context_apply2_test.go index 6b87d409d5d2..512f3dab3c9c 100644 --- a/internal/terraform/context_apply2_test.go +++ b/internal/terraform/context_apply2_test.go @@ -426,7 +426,7 @@ resource "test_resource" "b" { }, }) - plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) _, diags = ctx.Apply(plan, m) @@ -530,14 +530,14 @@ resource "test_object" "y" { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) assertNoErrors(t, diags) // FINAL PLAN: - plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + plan, diags = ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) // make sure the same marks are compared in the next plan as well diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 28c5c788b502..46dcbd58b8b9 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -517,7 +517,7 @@ func TestContext2Apply_mapVarBetweenModules(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) @@ -2262,7 +2262,7 @@ func TestContext2Apply_countVariable(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) @@ -2288,7 +2288,7 @@ func TestContext2Apply_countVariableRef(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) @@ -2327,7 +2327,7 @@ func TestContext2Apply_provisionerInterpCount(t *testing.T) { Provisioners: provisioners, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) // We'll marshal and unmarshal the plan here, to ensure that we have @@ -3682,7 +3682,7 @@ func TestContext2Apply_multiVarOrder(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) @@ -3713,7 +3713,7 @@ func TestContext2Apply_multiVarOrderInterp(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) @@ -4704,9 +4704,7 @@ func TestContext2Apply_provisionerDestroy(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, state, &PlanOpts{ - Mode: plans.DestroyMode, - }) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.DestroyMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags = ctx.Apply(plan, m) @@ -4753,9 +4751,7 @@ func TestContext2Apply_provisionerDestroyFail(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, state, &PlanOpts{ - Mode: plans.DestroyMode, - }) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.DestroyMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags = ctx.Apply(plan, m) @@ -5908,7 +5904,7 @@ func TestContext2Apply_destroyWithModuleVariableAndCountNested(t *testing.T) { }) // First plan and apply a create operation - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags = ctx.Apply(plan, m) @@ -5929,9 +5925,7 @@ func TestContext2Apply_destroyWithModuleVariableAndCountNested(t *testing.T) { }) // First plan and apply a create operation - plan, diags := ctx.Plan(m, state, &PlanOpts{ - Mode: plans.DestroyMode, - }) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.DestroyMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("destroy plan err: %s", diags.Err()) } @@ -7561,6 +7555,12 @@ func TestContext2Apply_vars(t *testing.T) { Value: cty.StringVal("us-east-1"), SourceType: ValueFromCaller, }, + "bar": &InputValue{ + // This one is not explicitly set but that's okay because it + // has a declared default, which Terraform Core will use instead. + Value: cty.NilVal, + SourceType: ValueFromCaller, + }, "test_list": &InputValue{ Value: cty.ListVal([]cty.Value{ cty.StringVal("Hello"), @@ -7876,7 +7876,7 @@ func TestContext2Apply_issue7824(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -7932,7 +7932,7 @@ func TestContext2Apply_issue5254(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -7951,7 +7951,7 @@ func TestContext2Apply_issue5254(t *testing.T) { }, }) - plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + plan, diags = ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("err: %s", diags.Err()) } @@ -8845,7 +8845,7 @@ func TestContext2Apply_plannedInterpolatedCount(t *testing.T) { Providers: Providers, }) - plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("plan failed: %s", diags.Err()) } @@ -8904,9 +8904,7 @@ func TestContext2Apply_plannedDestroyInterpolatedCount(t *testing.T) { Providers: providers, }) - plan, diags := ctx.Plan(m, state, &PlanOpts{ - Mode: plans.DestroyMode, - }) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.DestroyMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("plan failed: %s", diags.Err()) } @@ -9674,7 +9672,7 @@ func TestContext2Apply_plannedConnectionRefs(t *testing.T) { Hooks: []Hook{hook}, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) diags.HasErrors() if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) @@ -11687,7 +11685,7 @@ resource "test_resource" "foo" { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags := ctx.Apply(plan, m) @@ -11702,7 +11700,7 @@ resource "test_resource" "foo" { }, }) - plan, diags = ctx.Plan(m, state, DefaultPlanOpts) + plan, diags = ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) state, diags = ctx.Apply(plan, m) @@ -11720,6 +11718,7 @@ resource "test_resource" "foo" { plan, diags = ctx.Plan(m, state, &PlanOpts{ Mode: plans.NormalMode, SetVariables: InputValues{ + "sensitive_id": &InputValue{Value: cty.NilVal}, "sensitive_var": &InputValue{ Value: cty.StringVal("bar"), }, @@ -11759,7 +11758,7 @@ resource "test_resource" "foo" { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("plan errors: %s", diags.Err()) } @@ -11904,7 +11903,7 @@ resource "test_resource" "foo" { ) }) - plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) addr := mustResourceInstanceAddr("test_resource.foo") @@ -11954,7 +11953,7 @@ resource "test_resource" "foo" { // but this seems rather suspicious and we should ideally figure out what // this test was originally intending to do and make it do that. oldPlan := plan - _, diags = ctx2.Plan(m2, state, DefaultPlanOpts) + _, diags = ctx2.Plan(m2, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) stateWithoutSensitive, diags := ctx.Apply(oldPlan, m) assertNoErrors(t, diags) @@ -12206,7 +12205,7 @@ func TestContext2Apply_dataSensitive(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("diags: %s", diags.Err()) } else { diff --git a/internal/terraform/context_eval.go b/internal/terraform/context_eval.go index c6af77635fc3..f9d0f649338b 100644 --- a/internal/terraform/context_eval.go +++ b/internal/terraform/context_eval.go @@ -45,7 +45,7 @@ func (c *Context) Eval(config *configs.Config, state *states.State, moduleAddr a state = state.DeepCopy() var walker *ContextGraphWalker - variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) + variables := opts.SetVariables // By the time we get here, we should have values defined for all of // the root module variables, even if some of them are "unknown". It's the diff --git a/internal/terraform/context_eval_test.go b/internal/terraform/context_eval_test.go index dff6879833e7..0bd752935ecb 100644 --- a/internal/terraform/context_eval_test.go +++ b/internal/terraform/context_eval_test.go @@ -54,7 +54,9 @@ func TestContextEval(t *testing.T) { }, }) - scope, diags := ctx.Eval(m, states.NewState(), addrs.RootModuleInstance, &EvalOpts{}) + scope, diags := ctx.Eval(m, states.NewState(), addrs.RootModuleInstance, &EvalOpts{ + SetVariables: testInputValuesUnset(m.Module.Variables), + }) if diags.HasErrors() { t.Fatalf("Eval errors: %s", diags.Err()) } diff --git a/internal/terraform/context_import.go b/internal/terraform/context_import.go index b5417405fbb0..d809d6bb9dca 100644 --- a/internal/terraform/context_import.go +++ b/internal/terraform/context_import.go @@ -53,7 +53,7 @@ func (c *Context) Import(config *configs.Config, prevRunState *states.State, opt log.Printf("[DEBUG] Building and walking import graph") - variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) + variables := opts.SetVariables // Initialize our graph builder builder := &ImportGraphBuilder{ diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index 0b3c97f14559..f114b2a5f7dc 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -21,10 +21,42 @@ import ( // PlanOpts are the various options that affect the details of how Terraform // will build a plan. type PlanOpts struct { - Mode plans.Mode - SkipRefresh bool + // Mode defines what variety of plan the caller wishes to create. + // Refer to the documentation of the plans.Mode type and its values + // for more information. + Mode plans.Mode + + // SkipRefresh specifies to trust that the current values for managed + // resource instances in the prior state are accurate and to therefore + // disable the usual step of fetching updated values for each resource + // instance using its corresponding provider. + SkipRefresh bool + + // SetVariables are the raw values for root module variables as provided + // by the user who is requesting the run, prior to any normalization or + // substitution of defaults. See the documentation for the InputValue + // type for more information on how to correctly populate this. SetVariables InputValues - Targets []addrs.Targetable + + // If Targets has a non-zero length then it activates targeted planning + // mode, where Terraform will take actions only for resource instances + // mentioned in this set and any other objects those resource instances + // depend on. + // + // Targeted planning mode is intended for exceptional use only, + // and so populating this field will cause Terraform to generate extra + // warnings as part of the planning result. + Targets []addrs.Targetable + + // ForceReplace is a set of resource instance addresses whose corresponding + // objects should be forced planned for replacement if the provider's + // plan would otherwise have been to either update the object in-place or + // to take no action on it at all. + // + // A typical use of this argument is to ask Terraform to replace an object + // which the user has determined is somehow degraded (via information from + // outside of Terraform), thereby hopefully replacing it with a + // fully-functional new object. ForceReplace []addrs.AbsResourceInstance } @@ -99,8 +131,6 @@ func (c *Context) Plan(config *configs.Config, prevRunState *states.State, opts return nil, diags } - variables := mergeDefaultInputVariableValues(opts.SetVariables, config.Module.Variables) - // By the time we get here, we should have values defined for all of // the root module variables, even if some of them are "unknown". It's the // caller's responsibility to have already handled the decoding of these @@ -108,7 +138,7 @@ func (c *Context) Plan(config *configs.Config, prevRunState *states.State, opts // user-friendly error messages if they are not all present, and so // the error message from checkInputVariables should never be seen and // includes language asking the user to report a bug. - varDiags := checkInputVariables(config.Module.Variables, variables) + varDiags := checkInputVariables(config.Module.Variables, opts.SetVariables) diags = diags.Append(varDiags) if len(opts.Targets) > 0 { @@ -139,8 +169,12 @@ The -target option is not for routine use, and is provided only for exceptional } // convert the variables into the format expected for the plan - varVals := make(map[string]plans.DynamicValue, len(variables)) - for k, iv := range variables { + varVals := make(map[string]plans.DynamicValue, len(opts.SetVariables)) + for k, iv := range opts.SetVariables { + if iv.Value == cty.NilVal { + continue // We only record values that the caller actually set + } + // We use cty.DynamicPseudoType here so that we'll save both the // value _and_ its dynamic type in the plan, so we can recover // exactly the same value later. @@ -172,6 +206,25 @@ var DefaultPlanOpts = &PlanOpts{ Mode: plans.NormalMode, } +// SimplePlanOpts is a constructor to help with creating "simple" values of +// PlanOpts which only specify a mode and input variables. +// +// This helper function is primarily intended for use in straightforward +// tests that don't need any of the more "esoteric" planning options. For +// handling real user requests to run Terraform, it'd probably be better +// to construct a *PlanOpts value directly and provide a way for the user +// to set values for all of its fields. +// +// The "mode" and "setVariables" arguments become the values of the "Mode" +// and "SetVariables" fields in the result. Refer to the PlanOpts type +// documentation to learn about the meanings of those fields. +func SimplePlanOpts(mode plans.Mode, setVariables InputValues) *PlanOpts { + return &PlanOpts{ + Mode: mode, + SetVariables: setVariables, + } +} + func (c *Context) plan(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*plans.Plan, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 006e9e932f68..d1771b1f397f 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -205,7 +205,7 @@ data "test_data_source" "foo" { }, }) - plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) assertNoErrors(t, diags) for _, res := range plan.Changes.Resources { diff --git a/internal/terraform/context_plan_test.go b/internal/terraform/context_plan_test.go index cfd51da8cc43..9cf7e875ebe1 100644 --- a/internal/terraform/context_plan_test.go +++ b/internal/terraform/context_plan_test.go @@ -405,7 +405,7 @@ func TestContext2Plan_moduleExpand(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -1175,7 +1175,7 @@ func TestContext2Plan_moduleProviderVar(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2242,7 +2242,7 @@ func TestContext2Plan_countModuleStatic(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -2295,7 +2295,7 @@ func TestContext2Plan_countModuleStaticGrandchild(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -3938,7 +3938,7 @@ func TestContext2Plan_taintDestroyInterpolatedCountRace(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, state.DeepCopy(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, state.DeepCopy(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5481,7 +5481,7 @@ func TestContext2Plan_variableSensitivity(t *testing.T) { }, }) - plan, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + plan, diags := ctx.Plan(m, states.NewState(), SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatalf("unexpected errors: %s", diags.Err()) } @@ -5544,6 +5544,7 @@ func TestContext2Plan_variableSensitivityModule(t *testing.T) { plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ Mode: plans.NormalMode, SetVariables: InputValues{ + "sensitive_var": {Value: cty.NilVal}, "another_var": &InputValue{ Value: cty.StringVal("boop"), SourceType: ValueFromCaller, @@ -6657,7 +6658,7 @@ resource "test_resource" "foo" { }, ) }) - plan, diags := ctx.Plan(m, state, DefaultPlanOpts) + plan, diags := ctx.Plan(m, state, SimplePlanOpts(plans.NormalMode, testInputValuesUnset(m.Module.Variables))) if diags.HasErrors() { t.Fatal(diags.Err()) } diff --git a/internal/terraform/eval_variable.go b/internal/terraform/eval_variable.go index 1c16069ad4c1..bbafbe11c250 100644 --- a/internal/terraform/eval_variable.go +++ b/internal/terraform/eval_variable.go @@ -45,9 +45,11 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c log.Printf("[TRACE] prepareFinalInputVariableValue: %s has no defined value", addr) if cfg.Required() { // NOTE: The CLI layer typically checks for itself whether all of - // the required _root_ module variables are not set, which would - // mask this error. We can get here for child module variables, - // though. + // the required _root_ module variables are set, which would + // mask this error with a more specific one that refers to the + // CLI features for setting such variables. We can get here for + // child module variables, though. + log.Printf("[ERROR] prepareFinalInputVariableValue: %s is required but is not set", addr) diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: `Required variable not set`, @@ -64,6 +66,7 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c val, err := convert.Convert(given, convertTy) if err != nil { + log.Printf("[ERROR] prepareFinalInputVariableValue: %s has unsuitable type\n got: %s\n want: %s", addr, given.Type(), convertTy) diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: "Invalid value for module argument", @@ -93,6 +96,7 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c if defaultVal != cty.NilVal { val = defaultVal } else { + log.Printf("[ERROR] prepareFinalInputVariableValue: %s is non-nullable but set to null, and is required", addr) diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: `Required variable not set`, diff --git a/internal/terraform/variables.go b/internal/terraform/variables.go index 7a6ace0eee5c..f5f03d156bf6 100644 --- a/internal/terraform/variables.go +++ b/internal/terraform/variables.go @@ -3,18 +3,50 @@ package terraform import ( "fmt" - "github.com/hashicorp/hcl/v2" "github.com/zclconf/go-cty/cty" - "github.com/zclconf/go-cty/cty/convert" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/tfdiags" ) -// InputValue represents a value for a variable in the root module, provided -// as part of the definition of an operation. +// InputValue represents a raw value vor a root module input variable as +// provided by the external caller into a function like terraform.Context.Plan. +// +// InputValue should represent as directly as possible what the user set the +// variable to, without any attempt to convert the value to the variable's +// type constraint or substitute the configured default values for variables +// that wasn't set. Those adjustments will be handled by Terraform Core itself +// as part of performing the requested operation. +// +// A Terraform Core caller must provide an InputValue object for each of the +// variables declared in the root module, even if the end user didn't provide +// an explicit value for some of them. See the Value field documentation for +// how to handle that situation. type InputValue struct { - Value cty.Value + // Value is the raw value as provided by the user as part of the plan + // options, or a corresponding similar data structure for non-plan + // operations. + // + // If a particular variable declared in the root module is _not_ set by + // the user then the caller must still provide an InputValue for it but + // must set Value to cty.NilVal to represent the absense of a value. + // This requirement is to help detect situations where the caller isn't + // correctly detecting and handling all of the declared variables. + // + // For historical reasons it's important that callers distinguish the + // situation of the value not being set at all (cty.NilVal) from the + // situation of it being explicitly set to null (a cty.NullVal result): + // for "nullable" input variables that distinction unfortunately decides + // whether the final value will be the variable's default or will be + // explicitly null. + Value cty.Value + + // SourceType is a high-level category for where the value of Value + // came from, which Terraform Core uses to tailor some of its error + // messages to be more helpful to the user. + // + // Some SourceType values should be accompanied by a populated SourceRange + // value. See that field's documentation below for more information. SourceType ValueSourceType // SourceRange provides source location information for values whose @@ -129,23 +161,6 @@ func (vv InputValues) JustValues() map[string]cty.Value { return ret } -// DefaultVariableValues returns an InputValues map representing the default -// values specified for variables in the given configuration map. -func DefaultVariableValues(configs map[string]*configs.Variable) InputValues { - ret := make(InputValues) - for k, c := range configs { - if c.Default == cty.NilVal { - continue - } - ret[k] = &InputValue{ - Value: c.Default, - SourceType: ValueFromConfig, - SourceRange: tfdiags.SourceRangeFromHCL(c.DeclRange), - } - } - return ret -} - // SameValues returns true if the given InputValues has the same values as // the receiever, disregarding the source types and source ranges. // @@ -227,21 +242,15 @@ func (vv InputValues) Identical(other InputValues) bool { return true } -func mergeDefaultInputVariableValues(setVals InputValues, rootVarsConfig map[string]*configs.Variable) InputValues { - var variables InputValues - - // Default variables from the configuration seed our map. - variables = DefaultVariableValues(rootVarsConfig) - - // Variables provided by the caller (from CLI, environment, etc) can - // override the defaults. - variables = variables.Override(setVals) - - return variables -} - -// checkInputVariables ensures that variable values supplied at the UI conform -// to their corresponding declarations in configuration. +// checkInputVariables ensures that the caller provided an InputValue +// definition for each root module variable declared in the configuration. +// The caller must provide an InputVariables with keys exactly matching +// the declared variables, though some of them may be marked explicitly +// unset by their values being cty.NilVal. +// +// This doesn't perform any type checking, default value substitution, or +// validation checks. Those are all handled during a graph walk when we +// visit the graph nodes representing each root variable. // // The set of values is considered valid only if the returned diagnostics // does not contain errors. A valid set of values may still produce warnings, @@ -249,11 +258,12 @@ func mergeDefaultInputVariableValues(setVals InputValues, rootVarsConfig map[str func checkInputVariables(vcs map[string]*configs.Variable, vs InputValues) tfdiags.Diagnostics { var diags tfdiags.Diagnostics - for name, vc := range vcs { - val, isSet := vs[name] + for name := range vcs { + _, isSet := vs[name] if !isSet { - // Always an error, since the caller should already have included - // default values from the configuration in the values map. + // Always an error, since the caller should have produced an + // item with Value: cty.NilVal to be explicit that it offered + // an opportunity to set this variable. diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Unassigned variable", @@ -261,49 +271,6 @@ func checkInputVariables(vcs map[string]*configs.Variable, vs InputValues) tfdia )) continue } - - // A given value is valid if it can convert to the desired type. - _, err := convert.Convert(val.Value, vc.ConstraintType) - if err != nil { - switch val.SourceType { - case ValueFromConfig, ValueFromAutoFile, ValueFromNamedFile: - // We have source location information for these. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Invalid value for input variable", - Detail: fmt.Sprintf("The given value is not valid for variable %q: %s.", name, err), - Subject: val.SourceRange.ToHCL().Ptr(), - }) - case ValueFromEnvVar: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid value for input variable", - fmt.Sprintf("The environment variable TF_VAR_%s does not contain a valid value for variable %q: %s.", name, name, err), - )) - case ValueFromCLIArg: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid value for input variable", - fmt.Sprintf("The argument -var=\"%s=...\" does not contain a valid value for variable %q: %s.", name, name, err), - )) - case ValueFromInput: - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid value for input variable", - fmt.Sprintf("The value entered for variable %q is not valid: %s.", name, err), - )) - default: - // The above gets us good coverage for the situations users - // are likely to encounter with their own inputs. The other - // cases are generally implementation bugs, so we'll just - // use a generic error for these. - diags = diags.Append(tfdiags.Sourceless( - tfdiags.Error, - "Invalid value for input variable", - fmt.Sprintf("The value provided for variable %q is not valid: %s.", name, err), - )) - } - } } // Check for any variables that are assigned without being configured. diff --git a/internal/terraform/variables_test.go b/internal/terraform/variables_test.go index 41decbae2a38..6e53a95750a2 100644 --- a/internal/terraform/variables_test.go +++ b/internal/terraform/variables_test.go @@ -3,166 +3,10 @@ package terraform import ( "testing" - "github.com/davecgh/go-spew/spew" - "github.com/hashicorp/terraform/internal/tfdiags" - - "github.com/go-test/deep" + "github.com/hashicorp/terraform/internal/configs" "github.com/zclconf/go-cty/cty" ) -func TestVariables(t *testing.T) { - tests := map[string]struct { - Module string - Override map[string]cty.Value - Want InputValues - }{ - "config only": { - "vars-basic", - nil, - InputValues{ - "a": &InputValue{ - Value: cty.StringVal("foo"), - SourceType: ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "testdata/vars-basic/main.tf", - Start: tfdiags.SourcePos{Line: 1, Column: 1, Byte: 0}, - End: tfdiags.SourcePos{Line: 1, Column: 13, Byte: 12}, - }, - }, - "b": &InputValue{ - Value: cty.ListValEmpty(cty.String), - SourceType: ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "testdata/vars-basic/main.tf", - Start: tfdiags.SourcePos{Line: 6, Column: 1, Byte: 55}, - End: tfdiags.SourcePos{Line: 6, Column: 13, Byte: 67}, - }, - }, - "c": &InputValue{ - Value: cty.MapValEmpty(cty.String), - SourceType: ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "testdata/vars-basic/main.tf", - Start: tfdiags.SourcePos{Line: 11, Column: 1, Byte: 113}, - End: tfdiags.SourcePos{Line: 11, Column: 13, Byte: 125}, - }, - }, - }, - }, - - "override": { - "vars-basic", - map[string]cty.Value{ - "a": cty.StringVal("bar"), - "b": cty.ListVal([]cty.Value{ - cty.StringVal("foo"), - cty.StringVal("bar"), - }), - "c": cty.MapVal(map[string]cty.Value{ - "foo": cty.StringVal("bar"), - }), - }, - InputValues{ - "a": &InputValue{ - Value: cty.StringVal("bar"), - SourceType: ValueFromCaller, - }, - "b": &InputValue{ - Value: cty.ListVal([]cty.Value{ - cty.StringVal("foo"), - cty.StringVal("bar"), - }), - SourceType: ValueFromCaller, - }, - "c": &InputValue{ - Value: cty.MapVal(map[string]cty.Value{ - "foo": cty.StringVal("bar"), - }), - SourceType: ValueFromCaller, - }, - }, - }, - - "bools: config only": { - "vars-basic-bool", - nil, - InputValues{ - "a": &InputValue{ - Value: cty.True, - SourceType: ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "testdata/vars-basic-bool/main.tf", - Start: tfdiags.SourcePos{Line: 4, Column: 1, Byte: 177}, - End: tfdiags.SourcePos{Line: 4, Column: 13, Byte: 189}, - }, - }, - "b": &InputValue{ - Value: cty.False, - SourceType: ValueFromConfig, - SourceRange: tfdiags.SourceRange{ - Filename: "testdata/vars-basic-bool/main.tf", - Start: tfdiags.SourcePos{Line: 8, Column: 1, Byte: 214}, - End: tfdiags.SourcePos{Line: 8, Column: 13, Byte: 226}, - }, - }, - }, - }, - - "bools: override with string": { - "vars-basic-bool", - map[string]cty.Value{ - "a": cty.StringVal("foo"), - "b": cty.StringVal("bar"), - }, - InputValues{ - "a": &InputValue{ - Value: cty.StringVal("foo"), - SourceType: ValueFromCaller, - }, - "b": &InputValue{ - Value: cty.StringVal("bar"), - SourceType: ValueFromCaller, - }, - }, - }, - - "bools: override with bool": { - "vars-basic-bool", - map[string]cty.Value{ - "a": cty.False, - "b": cty.True, - }, - InputValues{ - "a": &InputValue{ - Value: cty.False, - SourceType: ValueFromCaller, - }, - "b": &InputValue{ - Value: cty.True, - SourceType: ValueFromCaller, - }, - }, - }, - } - - for name, test := range tests { - // Wrapped in a func so we can get defers to work - t.Run(name, func(t *testing.T) { - m := testModule(t, test.Module) - fromConfig := DefaultVariableValues(m.Module.Variables) - overrides := InputValuesFromCaller(test.Override) - got := fromConfig.Override(overrides) - - if !got.Identical(test.Want) { - t.Errorf("wrong result\ngot: %swant: %s", spew.Sdump(got), spew.Sdump(test.Want)) - } - for _, problem := range deep.Equal(got, test.Want) { - t.Errorf(problem) - } - }) - } -} - func TestCheckInputVariables(t *testing.T) { c := testModule(t, "input-variables") @@ -280,3 +124,25 @@ func TestCheckInputVariables(t *testing.T) { } }) } + +// testInputValuesUnset is a helper for constructing InputValues values for +// situations where all of the root module variables are optional and a +// test case intends to just use those default values and not override them +// at all. +// +// In other words, this constructs an InputValues with one entry per given +// input variable declaration where all of them are declared as unset. +func testInputValuesUnset(decls map[string]*configs.Variable) InputValues { + if len(decls) == 0 { + return nil + } + + ret := make(InputValues, len(decls)) + for name := range decls { + ret[name] = &InputValue{ + Value: cty.NilVal, + SourceType: ValueFromUnknown, + } + } + return ret +} From 9ebc3e1cd2798586505096ee3b7860393fb8af95 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Tue, 21 Dec 2021 18:04:24 -0800 Subject: [PATCH 498/644] core: More accurate error message for invalid variable values In earlier Terraform versions we had an extra validation step prior to the graph walk which tried to partially validate root module input variable values (just checking their type constraints) and then return error messages which specified as accurately as possible where the value had originally come from. We're now handling that sort of validation exclusively during the graph walk so that we can share the main logic between both root module and child module variable values, but previously that shared code wasn't able to generate such specific information about where the values had originated, because it was adapted from code originally written to only deal with child module variables. Here then we restore a similar level of detail as before, when we're processing root module variables. For child module variables, we use synthetic InputValue objects which state that the value was declared in the configuration, thus causing us to produce a similar sort of error message as we would've before which includes a source range covering the argument expression in the calling module block. --- internal/terraform/eval_variable.go | 84 +++++++++--- internal/terraform/eval_variable_test.go | 143 ++++++++++++++++++++- internal/terraform/node_module_variable.go | 11 +- internal/terraform/node_root_variable.go | 17 ++- internal/terraform/variables.go | 30 ++++- 5 files changed, 254 insertions(+), 31 deletions(-) diff --git a/internal/terraform/eval_variable.go b/internal/terraform/eval_variable.go index bbafbe11c250..fd57a136f290 100644 --- a/internal/terraform/eval_variable.go +++ b/internal/terraform/eval_variable.go @@ -12,7 +12,7 @@ import ( "github.com/zclconf/go-cty/cty/convert" ) -func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given cty.Value, valRange tfdiags.SourceRange, cfg *configs.Variable) (cty.Value, tfdiags.Diagnostics) { +func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, raw *InputValue, cfg *configs.Variable) (cty.Value, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics convertTy := cfg.ConstraintType @@ -41,6 +41,29 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c } } + var sourceRange tfdiags.SourceRange + var nonFileSource string + if raw.HasSourceRange() { + sourceRange = raw.SourceRange + } else { + // If the value came from a place that isn't a file and thus doesn't + // have its own source range, we'll use the declaration range as + // our source range and generate some slightly different error + // messages. + sourceRange = tfdiags.SourceRangeFromHCL(cfg.DeclRange) + switch raw.SourceType { + case ValueFromCLIArg: + nonFileSource = fmt.Sprintf("set using -var=\"%s=...\"", addr.Variable.Name) + case ValueFromEnvVar: + nonFileSource = fmt.Sprintf("set using the TF_VAR_%s environment variable", addr.Variable.Name) + case ValueFromInput: + nonFileSource = "set using an interactive prompt" + default: + nonFileSource = "set from outside of the configuration" + } + } + + given := raw.Value if given == cty.NilVal { // The variable wasn't set at all (even to null) log.Printf("[TRACE] prepareFinalInputVariableValue: %s has no defined value", addr) if cfg.Required() { @@ -54,7 +77,7 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c Severity: hcl.DiagError, Summary: `Required variable not set`, Detail: fmt.Sprintf(`The variable %q is required, but is not set.`, addr.Variable.Name), - Subject: valRange.ToHCL().Ptr(), + Subject: cfg.DeclRange.Ptr(), }) // We'll return a placeholder unknown value to avoid producing // redundant downstream errors. @@ -67,15 +90,27 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c val, err := convert.Convert(given, convertTy) if err != nil { log.Printf("[ERROR] prepareFinalInputVariableValue: %s has unsuitable type\n got: %s\n want: %s", addr, given.Type(), convertTy) - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Invalid value for module argument", - Detail: fmt.Sprintf( - "The given value is not suitable for child module variable %q defined at %s: %s.", - cfg.Name, cfg.DeclRange.String(), err, - ), - Subject: valRange.ToHCL().Ptr(), - }) + if nonFileSource != "" { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid value for input variable", + Detail: fmt.Sprintf( + "Unsuitable value for %s %s: %s.", + addr, nonFileSource, err, + ), + Subject: cfg.DeclRange.Ptr(), + }) + } else { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid value for input variable", + Detail: fmt.Sprintf( + "The given value is not suitable for %s declared at %s: %s.", + addr, cfg.DeclRange.String(), err, + ), + Subject: sourceRange.ToHCL().Ptr(), + }) + } // We'll return a placeholder unknown value to avoid producing // redundant downstream errors. return cty.UnknownVal(cfg.Type), diags @@ -97,12 +132,27 @@ func prepareFinalInputVariableValue(addr addrs.AbsInputVariableInstance, given c val = defaultVal } else { log.Printf("[ERROR] prepareFinalInputVariableValue: %s is non-nullable but set to null, and is required", addr) - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: `Required variable not set`, - Detail: fmt.Sprintf(`The variable %q is required, but the given value is null.`, addr.Variable.Name), - Subject: valRange.ToHCL().Ptr(), - }) + if nonFileSource != "" { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Required variable not set`, + Detail: fmt.Sprintf( + "Unsuitable value for %s %s: required variable may not be set to null.", + addr, nonFileSource, + ), + Subject: cfg.DeclRange.Ptr(), + }) + } else { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: `Required variable not set`, + Detail: fmt.Sprintf( + "The given value is not suitable for %s defined at %s: required variable may not be set to null.", + addr, cfg.DeclRange.String(), + ), + Subject: sourceRange.ToHCL().Ptr(), + }) + } // Stub out our return value so that the semantic checker doesn't // produce redundant downstream errors. val = cty.UnknownVal(cfg.Type) diff --git a/internal/terraform/eval_variable_test.go b/internal/terraform/eval_variable_test.go index fa4048fed41f..0ebea982f57b 100644 --- a/internal/terraform/eval_variable_test.go +++ b/internal/terraform/eval_variable_test.go @@ -4,6 +4,7 @@ import ( "fmt" "testing" + "github.com/hashicorp/hcl/v2" "github.com/zclconf/go-cty/cty" "github.com/hashicorp/terraform/internal/addrs" @@ -65,6 +66,13 @@ func TestPrepareFinalInputVariableValue(t *testing.T) { }) variableConfigs := cfg.Module.Variables + // Because we loaded our pseudo-module from a temporary file, the + // declaration source ranges will have unpredictable filenames. We'll + // fix that here just to make things easier below. + for _, vc := range variableConfigs { + vc.DeclRange.Filename = "main.tf" + } + tests := []struct { varName string given cty.Value @@ -264,7 +272,7 @@ func TestPrepareFinalInputVariableValue(t *testing.T) { "required", cty.NullVal(cty.DynamicPseudoType), cty.UnknownVal(cty.DynamicPseudoType), - `Required variable not set: The variable "required" is required, but the given value is null.`, + `Required variable not set: Unsuitable value for var.required set from outside of the configuration: required variable may not be set to null.`, }, { "required", @@ -316,7 +324,7 @@ func TestPrepareFinalInputVariableValue(t *testing.T) { "constrained_string_required", cty.NullVal(cty.DynamicPseudoType), cty.UnknownVal(cty.String), - `Required variable not set: The variable "constrained_string_required" is required, but the given value is null.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set from outside of the configuration: required variable may not be set to null.`, }, { "constrained_string_required", @@ -401,8 +409,13 @@ func TestPrepareFinalInputVariableValue(t *testing.T) { test.given, ) + rawVal := &InputValue{ + Value: test.given, + SourceType: ValueFromCaller, + } + got, diags := prepareFinalInputVariableValue( - varAddr, test.given, tfdiags.SourceRangeFromHCL(varCfg.DeclRange), varCfg, + varAddr, rawVal, varCfg, ) if test.wantErr != "" { @@ -423,4 +436,128 @@ func TestPrepareFinalInputVariableValue(t *testing.T) { } }) } + + t.Run("SourceType error message variants", func(t *testing.T) { + tests := []struct { + SourceType ValueSourceType + SourceRange tfdiags.SourceRange + WantTypeErr string + WantNullErr string + }{ + { + ValueFromUnknown, + tfdiags.SourceRange{}, + `Invalid value for input variable: Unsuitable value for var.constrained_string_required set from outside of the configuration: string required.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set from outside of the configuration: required variable may not be set to null.`, + }, + { + ValueFromConfig, + tfdiags.SourceRange{ + Filename: "example.tf", + Start: tfdiags.SourcePos(hcl.InitialPos), + End: tfdiags.SourcePos(hcl.InitialPos), + }, + `Invalid value for input variable: The given value is not suitable for var.constrained_string_required declared at main.tf:32,3-41: string required.`, + `Required variable not set: The given value is not suitable for var.constrained_string_required defined at main.tf:32,3-41: required variable may not be set to null.`, + }, + { + ValueFromAutoFile, + tfdiags.SourceRange{ + Filename: "example.auto.tfvars", + Start: tfdiags.SourcePos(hcl.InitialPos), + End: tfdiags.SourcePos(hcl.InitialPos), + }, + `Invalid value for input variable: The given value is not suitable for var.constrained_string_required declared at main.tf:32,3-41: string required.`, + `Required variable not set: The given value is not suitable for var.constrained_string_required defined at main.tf:32,3-41: required variable may not be set to null.`, + }, + { + ValueFromNamedFile, + tfdiags.SourceRange{ + Filename: "example.tfvars", + Start: tfdiags.SourcePos(hcl.InitialPos), + End: tfdiags.SourcePos(hcl.InitialPos), + }, + `Invalid value for input variable: The given value is not suitable for var.constrained_string_required declared at main.tf:32,3-41: string required.`, + `Required variable not set: The given value is not suitable for var.constrained_string_required defined at main.tf:32,3-41: required variable may not be set to null.`, + }, + { + ValueFromCLIArg, + tfdiags.SourceRange{}, + `Invalid value for input variable: Unsuitable value for var.constrained_string_required set using -var="constrained_string_required=...": string required.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set using -var="constrained_string_required=...": required variable may not be set to null.`, + }, + { + ValueFromEnvVar, + tfdiags.SourceRange{}, + `Invalid value for input variable: Unsuitable value for var.constrained_string_required set using the TF_VAR_constrained_string_required environment variable: string required.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set using the TF_VAR_constrained_string_required environment variable: required variable may not be set to null.`, + }, + { + ValueFromInput, + tfdiags.SourceRange{}, + `Invalid value for input variable: Unsuitable value for var.constrained_string_required set using an interactive prompt: string required.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set using an interactive prompt: required variable may not be set to null.`, + }, + { + // NOTE: This isn't actually a realistic case for this particular + // function, because if we have a value coming from a plan then + // we must be in the apply step, and we shouldn't be able to + // get past the plan step if we have invalid variable values, + // and during planning we'll always have other source types. + ValueFromPlan, + tfdiags.SourceRange{}, + `Invalid value for input variable: Unsuitable value for var.constrained_string_required set from outside of the configuration: string required.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set from outside of the configuration: required variable may not be set to null.`, + }, + { + ValueFromCaller, + tfdiags.SourceRange{}, + `Invalid value for input variable: Unsuitable value for var.constrained_string_required set from outside of the configuration: string required.`, + `Required variable not set: Unsuitable value for var.constrained_string_required set from outside of the configuration: required variable may not be set to null.`, + }, + } + + for _, test := range tests { + t.Run(fmt.Sprintf("%s %s", test.SourceType, test.SourceRange.StartString()), func(t *testing.T) { + varAddr := addrs.InputVariable{Name: "constrained_string_required"}.Absolute(addrs.RootModuleInstance) + varCfg := variableConfigs[varAddr.Variable.Name] + t.Run("type error", func(t *testing.T) { + rawVal := &InputValue{ + Value: cty.EmptyObjectVal, + SourceType: test.SourceType, + SourceRange: test.SourceRange, + } + + _, diags := prepareFinalInputVariableValue( + varAddr, rawVal, varCfg, + ) + if !diags.HasErrors() { + t.Fatalf("unexpected success; want error") + } + + if got, want := diags.Err().Error(), test.WantTypeErr; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } + }) + t.Run("null error", func(t *testing.T) { + rawVal := &InputValue{ + Value: cty.NullVal(cty.DynamicPseudoType), + SourceType: test.SourceType, + SourceRange: test.SourceRange, + } + + _, diags := prepareFinalInputVariableValue( + varAddr, rawVal, varCfg, + ) + if !diags.HasErrors() { + t.Fatalf("unexpected success; want error") + } + + if got, want := diags.Err().Error(), test.WantNullErr; got != want { + t.Errorf("wrong error\ngot: %s\nwant: %s", got, want) + } + }) + }) + } + }) } diff --git a/internal/terraform/node_module_variable.go b/internal/terraform/node_module_variable.go index 321cd874845f..ae3450be528e 100644 --- a/internal/terraform/node_module_variable.go +++ b/internal/terraform/node_module_variable.go @@ -227,7 +227,16 @@ func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnl errSourceRange = tfdiags.SourceRangeFromHCL(n.Config.DeclRange) // we use the declaration range as a fallback for an undefined variable } - finalVal, moreDiags := prepareFinalInputVariableValue(n.Addr, givenVal, errSourceRange, n.Config) + // We construct a synthetic InputValue here to pretend as if this were + // a root module variable set from outside, just as a convenience so we + // can reuse the InputValue type for this. + rawVal := &InputValue{ + Value: givenVal, + SourceType: ValueFromConfig, + SourceRange: errSourceRange, + } + + finalVal, moreDiags := prepareFinalInputVariableValue(n.Addr, rawVal, n.Config) diags = diags.Append(moreDiags) return finalVal, diags.ErrWithWarnings() diff --git a/internal/terraform/node_root_variable.go b/internal/terraform/node_root_variable.go index d023be3500ba..33f439d7cd9a 100644 --- a/internal/terraform/node_root_variable.go +++ b/internal/terraform/node_root_variable.go @@ -65,20 +65,23 @@ func (n *NodeRootVariable) Execute(ctx EvalContext, op walkOperation) tfdiags.Di return nil } - var givenVal cty.Value - if n.RawValue != nil { - givenVal = n.RawValue.Value - } else { + givenVal := n.RawValue + if givenVal == nil { // We'll use cty.NilVal to represent the variable not being set at // all, which for historical reasons is unfortunately different than - // explicitly setting it to null in some cases. - givenVal = cty.NilVal + // explicitly setting it to null in some cases. In normal code we + // should never get here because all variables should have raw + // values, but we can get here in some historical tests that call + // in directly and don't necessarily obey the rules. + givenVal = &InputValue{ + Value: cty.NilVal, + SourceType: ValueFromUnknown, + } } finalVal, moreDiags := prepareFinalInputVariableValue( addr, givenVal, - tfdiags.SourceRangeFromHCL(n.Config.DeclRange), n.Config, ) diags = diags.Append(moreDiags) diff --git a/internal/terraform/variables.go b/internal/terraform/variables.go index f5f03d156bf6..a60f187003dd 100644 --- a/internal/terraform/variables.go +++ b/internal/terraform/variables.go @@ -9,7 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/tfdiags" ) -// InputValue represents a raw value vor a root module input variable as +// InputValue represents a raw value for a root module input variable as // provided by the external caller into a function like terraform.Context.Plan. // // InputValue should represent as directly as possible what the user set the @@ -22,6 +22,11 @@ import ( // variables declared in the root module, even if the end user didn't provide // an explicit value for some of them. See the Value field documentation for // how to handle that situation. +// +// Terraform Core also internally uses InputValue to represent the raw value +// provided for a variable in a child module call, following the same +// conventions. However, that's an implementation detail not visible to +// outside callers. type InputValue struct { // Value is the raw value as provided by the user as part of the plan // options, or a corresponding similar data structure for non-plan @@ -50,8 +55,9 @@ type InputValue struct { SourceType ValueSourceType // SourceRange provides source location information for values whose - // SourceType is either ValueFromConfig or ValueFromFile. It is not - // populated for other source types, and so should not be used. + // SourceType is either ValueFromConfig, ValueFromNamedFile, or + // ValueForNormalFile. It is not populated for other source types, and so + // should not be used. SourceRange tfdiags.SourceRange } @@ -106,6 +112,24 @@ func (v *InputValue) GoString() string { } } +// HasSourceRange returns true if the reciever has a source type for which +// we expect the SourceRange field to be populated with a valid range. +func (v *InputValue) HasSourceRange() bool { + return v.SourceType.HasSourceRange() +} + +// HasSourceRange returns true if the reciever is one of the source types +// that is used along with a valid SourceRange field when appearing inside an +// InputValue object. +func (v ValueSourceType) HasSourceRange() bool { + switch v { + case ValueFromConfig, ValueFromAutoFile, ValueFromNamedFile: + return true + default: + return false + } +} + func (v ValueSourceType) GoString() string { return fmt.Sprintf("terraform.%s", v) } From dabd7567af2940b424b6521ed3564a0fbef1f7e9 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 10 Jan 2022 12:29:10 -0800 Subject: [PATCH 499/644] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 59307b6111de..86538555d80e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ ENHANCEMENTS: * The "Invalid for_each argument" error message for unknown maps/sets now includes an additional paragraph to try to help the user notice they can move apply-time values into the map _values_ instead of the map _keys_, and thus avoid the problem without resorting to `-target`. [GH-30327] +BUG FIXES: + +* Terraform now handles type constraints, nullability, and custom variable validation properly for root module variables. Previously there was an order of operations problem where the nullability and custom variable validation were checked too early, prior to dealing with the type constraints, and thus that logic could potentially "see" an incorrectly-typed value in spite of the type constraint, leading to incorrect errors. [GH-29959] + ## Previous Releases For information on prior major and minor releases, see their changelogs: From 684ed7505d7aaa85d3eb4460d0ae7aec17b99aa8 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Mon, 10 Jan 2022 16:14:30 -0500 Subject: [PATCH 500/644] remove synthetic default expression for variables Now that variable evaluation checks for a nil expression the graph transformer does not need to generate a synthetic expression for variable defaults. This means that all default handling is now located in one place, and we are not surprised by a configuration expression showing up which doesn't actually exist in the configuration. Rename nodeModuleVariable.evalModuleCallArgument to evalModuleVariable. This method is no longer handling only the module call argument, it is also dealing with the variable declaration defaults and validation statements. Add an additional tests for validation with a non-nullable variable. --- internal/terraform/context_validate_test.go | 33 +++++++++++++++++++ internal/terraform/node_module_variable.go | 8 ++--- .../terraform/transform_module_variable.go | 8 ----- 3 files changed, 37 insertions(+), 12 deletions(-) diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index a02d85cdd9f2..1f0491f1a906 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -2062,3 +2062,36 @@ output "out" { t.Fatal(diags.ErrWithWarnings()) } } + +func TestContext2Validate_nonNullableVariableDefaultValidation(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` + module "first" { + source = "./mod" + input = null + } + `, + + "mod/main.tf": ` + variable "input" { + type = string + default = "default" + nullable = false + + // Validation expressions should receive the default with nullable=false and + // a null input. + validation { + condition = var.input != null + error_message = "Input cannot be null!" + } + } + `, + }) + + ctx := testContext2(t, &ContextOpts{}) + + diags := ctx.Validate(m) + if diags.HasErrors() { + t.Fatal(diags.ErrWithWarnings()) + } +} diff --git a/internal/terraform/node_module_variable.go b/internal/terraform/node_module_variable.go index ae3450be528e..c5e2294eaadb 100644 --- a/internal/terraform/node_module_variable.go +++ b/internal/terraform/node_module_variable.go @@ -149,10 +149,10 @@ func (n *nodeModuleVariable) Execute(ctx EvalContext, op walkOperation) (diags t switch op { case walkValidate: - val, err = n.evalModuleCallArgument(ctx, true) + val, err = n.evalModuleVariable(ctx, true) diags = diags.Append(err) default: - val, err = n.evalModuleCallArgument(ctx, false) + val, err = n.evalModuleVariable(ctx, false) diags = diags.Append(err) } if diags.HasErrors() { @@ -178,7 +178,7 @@ func (n *nodeModuleVariable) DotNode(name string, opts *dag.DotOpts) *dag.DotNod } } -// evalModuleCallArgument produces the value for a particular variable as will +// evalModuleVariable produces the value for a particular variable as will // be used by a child module instance. // // The result is written into a map, with its key set to the local name of the @@ -190,7 +190,7 @@ func (n *nodeModuleVariable) DotNode(name string, opts *dag.DotOpts) *dag.DotNod // validateOnly indicates that this evaluation is only for config // validation, and we will not have any expansion module instance // repetition data. -func (n *nodeModuleVariable) evalModuleCallArgument(ctx EvalContext, validateOnly bool) (cty.Value, error) { +func (n *nodeModuleVariable) evalModuleVariable(ctx EvalContext, validateOnly bool) (cty.Value, error) { var diags tfdiags.Diagnostics var givenVal cty.Value var errSourceRange tfdiags.SourceRange diff --git a/internal/terraform/transform_module_variable.go b/internal/terraform/transform_module_variable.go index b739bfd6e453..a9fa02c4e10d 100644 --- a/internal/terraform/transform_module_variable.go +++ b/internal/terraform/transform_module_variable.go @@ -3,7 +3,6 @@ package terraform import ( "fmt" - "github.com/hashicorp/hcl/v2/hclsyntax" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" @@ -94,13 +93,6 @@ func (t *ModuleVariableTransformer) transformSingle(g *Graph, parent, c *configs var expr hcl.Expression if attr := content.Attributes[v.Name]; attr != nil { expr = attr.Expr - } else { - // No expression provided for this variable, so we'll make a - // synthetic one using the variable's default value. - expr = &hclsyntax.LiteralValueExpr{ - Val: v.Default, - SrcRange: v.DeclRange, // This is not exact, but close enough - } } // Add a plannable node, as the variable may expand From 1b7e7b967dca992d04a093b3ae1c6b03f6cc267f Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 10 Jan 2022 17:49:49 -0500 Subject: [PATCH 501/644] Fix broken links to external docs --- .../resources/provisioners/salt-masterless.mdx | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/website/docs/language/resources/provisioners/salt-masterless.mdx b/website/docs/language/resources/provisioners/salt-masterless.mdx index d24532177f99..70fd17dbe74e 100644 --- a/website/docs/language/resources/provisioners/salt-masterless.mdx +++ b/website/docs/language/resources/provisioners/salt-masterless.mdx @@ -47,28 +47,26 @@ Optional: Docker builder, you will likely want to pass `true` since `sudo` is often not pre-installed. - `remote_pillar_roots` (string) - The path to your remote [pillar - roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). + roots](https://docs.saltproject.io/en/latest/ref/configuration/master.html#pillar-configuration). default: `/srv/pillar`. This option cannot be used with `minion_config`. - `remote_state_tree` (string) - The path to your remote [state - tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). + tree](https://docs.saltproject.io/en/latest/ref/states/highstate.html#the-salt-state-tree). default: `/srv/salt`. This option cannot be used with `minion_config`. - `local_pillar_roots` (string) - The path to your local [pillar - roots](http://docs.saltstack.com/ref/configuration/master.html#pillar-configuration). + roots](https://docs.saltproject.io/en/latest/ref/configuration/master.html#pillar-configuration). This will be uploaded to the `remote_pillar_roots` on the remote. - `local_state_tree` (string) - The path to your local [state - tree](http://docs.saltstack.com/ref/states/highstate.html#the-salt-state-tree). + tree](https://docs.saltproject.io/en/latest/ref/states/highstate.html#the-salt-state-tree). This will be uploaded to the `remote_state_tree` on the remote. - `custom_state` (string) - A state to be run instead of `state.highstate`. Defaults to `state.highstate` if unspecified. - `minion_config_file` (string) - The path to your local [minion config - file](http://docs.saltstack.com/ref/configuration/minion.html). This will be - uploaded to the `/etc/salt` on the remote. This option overrides the - `remote_state_tree` or `remote_pillar_roots` options. + file](https://docs.saltproject.io/en/latest/ref/configuration/minion.html). This will be uploaded to the `/etc/salt` on the remote. This option overrides the `remote_state_tree` or `remote_pillar_roots` options. - `skip_bootstrap` (boolean) - By default the salt provisioner runs [salt bootstrap](https://github.com/saltstack/salt-bootstrap) to install salt. Set @@ -83,7 +81,7 @@ Optional: - `log_level` (string) - Set the logging level for the `salt-call` run. - `salt_call_args` (string) - Additional arguments to pass directly to `salt-call`. See - [salt-call](https://docs.saltstack.com/ref/cli/salt-call.html) documentation for more + [salt-call](https://docs.saltproject.io/en/latest/ref/cli/salt-call.html) documentation for more information. By default no additional arguments (besides the ones Terraform generates) are passed to `salt-call`. From beb9432155b7f78122c0b57e66b6ee275ca5e4b8 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 10 Jan 2022 16:44:18 -0800 Subject: [PATCH 502/644] website: CLI state manipulation section de-emphasize old features Previously the "terraform state ..." subcommands were the only way to perform various manipulations of the state, but in recent Terraform versions we have replaced these with better options. Since these pages seem to already have pretty good search engine optimization for the use-cases they are describing, we'll prioritize mentioning the new approaches and only mention the now-deprecated or de-emphasized features as a secondary approach. Specifically: - Describe the -replace=... planning option in preference to "terraform taint", and present taint as primarily a mechanism for Terraform to use itself, as opposed to something end-users should typically use directly. - Introduce the config-based refactoring features before describing "terraform state mv". The older features here are still applicable in some situations and are required for those still using older versions of Terraform, so we will retain the information about them for now while aiming to be clearer in each case about which is our preferred, modern approach. --- website/docs/cli/state/index.mdx | 2 +- website/docs/cli/state/move.mdx | 13 +++++- website/docs/cli/state/taint.mdx | 72 ++++++++++++++++++++++++-------- 3 files changed, 67 insertions(+), 20 deletions(-) diff --git a/website/docs/cli/state/index.mdx b/website/docs/cli/state/index.mdx index 9db8d9252bd1..b3c11b7de3ce 100644 --- a/website/docs/cli/state/index.mdx +++ b/website/docs/cli/state/index.mdx @@ -22,7 +22,7 @@ infrastructure. Terraform CLI supports several workflows for interacting with state: - [Inspecting State](/cli/state/inspect) -- [Forcing Re-creation (Tainting)](/cli/state/taint) +- [Forcing Re-creation](/cli/state/taint) - [Moving Resources](/cli/state/move) - Importing Pre-existing Resources (documented in the [Importing Infrastructure](/cli/import) section) diff --git a/website/docs/cli/state/move.mdx b/website/docs/cli/state/move.mdx index 8b0f9cdaeb75..c69280a902d5 100644 --- a/website/docs/cli/state/move.mdx +++ b/website/docs/cli/state/move.mdx @@ -21,13 +21,22 @@ In cases where it's important to preserve an existing infrastructure object, you can explicitly tell Terraform to associate it with a different configured resource. +For most cases we recommend using +[the Terraform language's refactoring features](/language/modules/develop/refactoring) +to document in your module exactly how the resource names have changed over +time. Terraform will react to this information automatically during planning, +and thus users of your module will not need to take any unusual extra steps. + +> **Hands On:** Try the [Use Configuration to Move Resources](https://learn.hashicorp.com/tutorials/terraform/move-config) on HashiCorp Learn. + +There are some other situations which require explicit state modifications, +though. For those, consider the following Terraform commands: + - [The `terraform state mv` command](/cli/commands/state/mv) changes which resource address in your configuration is associated with a particular real-world object. Use this to preserve an object when renaming a resource, or when moving a resource into or out of a child module. - > **Hands On:** Try the [Use Configuration to Move Resources](https://learn.hashicorp.com/tutorials/terraform/move-config) on HashiCorp Learn. - - [The `terraform state rm` command](/cli/commands/state/rm) tells Terraform to stop managing a resource as part of the current working directory and workspace, _without_ destroying the corresponding real-world object. (You diff --git a/website/docs/cli/state/taint.mdx b/website/docs/cli/state/taint.mdx index dbe67f9063ff..c4c46ca2f051 100644 --- a/website/docs/cli/state/taint.mdx +++ b/website/docs/cli/state/taint.mdx @@ -1,25 +1,63 @@ --- -page_title: Forcing Re-creation of Resources (Tainting) - Terraform CLI +page_title: Forcing Re-creation of Resources - Terraform CLI description: Commands that allow you to destroy and re-create resources manually. --- -# Forcing Re-creation of Resources (Tainting) +# Forcing Re-creation of Resources -When a resource declaration is modified, Terraform usually attempts to update -the existing resource in place (although some changes can require destruction -and re-creation, usually due to upstream API limitations). +During planning, by default Terraform retrieves the latest state of each +existing object and compares it with the current configuration, planning +actions only against objects whose current state does not match the +configuration. -In some cases, you might want a resource to be destroyed and re-created even -when Terraform doesn't think it's necessary. This is usually for objects that -aren't fully described by their resource arguments due to side-effects that -happen during creation; for example, a virtual machine that configures itself -with `cloud-init` on startup might no longer meet your needs if the cloud-init -configuration changes. +However, in some cases a remote object may become damaged or degraded in a +way that Terraform cannot automatically detect. For example, if software +running inside a virtual machine crashes but the virtual machine itself is +still running then Terraform will typically have no way to detect and respond +to the problem, because Terraform only directly manages the machine as a whole. -- [The `terraform taint` command](/cli/commands/taint) tells Terraform to - destroy and re-create a particular resource during the next apply, regardless - of whether its resource arguments would normally require that. +If you know that an object is damaged, or if you want to force Terraform to +replace it for any other reason, you can override Terraform's default behavior +using [the `-replace=...` planning option](/cli/commands/plan#replace-address) +when you run either `terraform plan` or `terraform apply`: -- [The `terraform untaint` command](/cli/commands/untaint) undoes a - previous taint, or can preserve a resource that was automatically tainted due - to failed [provisioners](/language/resources/provisioners/syntax). +```shellsession +$ terraform apply -replace=aws_instance.example +# ... + + # aws_instance.example will be replaced, as requested +-/+ resource "aws_instance" "example" { + # ... + } +``` + +## The "tainted" status + +Sometimes Terraform is able to infer automatically that an object is in an +incomplete or degraded state. For example, if creation of a complex object +fails in such a way that parts of it already exist in the remote system, or +if object creation succeeded but a provisioner step subsequently failed, +Terraform must remember that the object exists but may not be fully-functional. + +Terraform represents this situation by marking an object in the state as +"tainted". When an object is marked with this status, the next plan will force +replacing that object in a similar way to if you had specified that object's +address using `-replace=...` as described above. + +``` + # aws_instance.example is tainted, so must be replaced +-/+ resource "aws_instance" "example" { + # ... + } +``` + +If Terraform has marked an object as tainted but you consider it to be working +correctly and do not want to replace it, you can override Terraform's +determination using [the `terraform untaint` command](/cli/commands/untaint), +after which Terraform will consider the object to be ready for use by any +downstream resource declarations. + +You can also _force_ Terraform to mark a particular object as tainted using +[the `terraform taint` command](/cli/commands/taint), but that approach is +deprecated in favor of the `-replace=...` option, which avoids the need to +create an interim state snapshot with a tainted object. From bdc5f152d7ac2ddbdd7fbbb00422c51d2d833ef0 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 10 Jan 2022 15:36:59 -0800 Subject: [PATCH 503/644] refactoring: Implied move statements can be cross-package Terraform uses "implied" move statements to represent the situation where it automatically handles a switch from count to no-count on a resource. Because that situation requires targeting only a specific resource instance inside a specific module instance, implied move statements are always presented as if they had been declared in the root module and then traversed through the exact module instance path to reach the target resource. However, that means they can potentially cross a module package boundary, if the changed resource belongs to an external module. Normally we prohibit that to avoid the root module depending on implementation details of the called module, but Terraform generates these implied statements based only on information in the called module and so there's no need to apply that same restriction to implied move statements, which will always have source and destination addresses belonging to the same module instance. This change therefore fixes a misbehavior where Terraform would reject an attempt to switch from no-count to count in a called module, where previously the author of the calling configuration had no recourse to fix it because the change has actually happened upstream. --- internal/refactoring/move_validate.go | 49 ++++++++++++--------- internal/refactoring/move_validate_test.go | 51 ++++++++++++++++++++++ 2 files changed, 79 insertions(+), 21 deletions(-) diff --git a/internal/refactoring/move_validate.go b/internal/refactoring/move_validate.go index eedf0041409a..13f2e50f9590 100644 --- a/internal/refactoring/move_validate.go +++ b/internal/refactoring/move_validate.go @@ -55,27 +55,34 @@ func ValidateMoves(stmts []MoveStatement, rootCfg *configs.Config, declaredInsts _, toCallSteps := stmt.To.ModuleCallTraversals() modCfg := rootCfg.Descendent(stmtMod) - if pkgAddr := callsThroughModulePackage(modCfg, fromCallSteps); pkgAddr != nil { - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Cross-package move statement", - Detail: fmt.Sprintf( - "This statement declares a move from an object declared in external module package %q. Move statements can be only within a single module package.", - pkgAddr, - ), - Subject: stmt.DeclRange.ToHCL().Ptr(), - }) - } - if pkgAddr := callsThroughModulePackage(modCfg, toCallSteps); pkgAddr != nil { - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Cross-package move statement", - Detail: fmt.Sprintf( - "This statement declares a move to an object declared in external module package %q. Move statements can be only within a single module package.", - pkgAddr, - ), - Subject: stmt.DeclRange.ToHCL().Ptr(), - }) + if !stmt.Implied { + // Implied statements can cross module boundaries because we + // generate them only for changing instance keys on a single + // resource. They happen to be generated _as if_ they were written + // in the root module, but the source and destination are always + // in the same module anyway. + if pkgAddr := callsThroughModulePackage(modCfg, fromCallSteps); pkgAddr != nil { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Cross-package move statement", + Detail: fmt.Sprintf( + "This statement declares a move from an object declared in external module package %q. Move statements can be only within a single module package.", + pkgAddr, + ), + Subject: stmt.DeclRange.ToHCL().Ptr(), + }) + } + if pkgAddr := callsThroughModulePackage(modCfg, toCallSteps); pkgAddr != nil { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Cross-package move statement", + Detail: fmt.Sprintf( + "This statement declares a move to an object declared in external module package %q. Move statements can be only within a single module package.", + pkgAddr, + ), + Subject: stmt.DeclRange.ToHCL().Ptr(), + }) + } } for _, modInst := range declaredInsts.InstancesForModule(stmtMod) { diff --git a/internal/refactoring/move_validate_test.go b/internal/refactoring/move_validate_test.go index 60122511fe51..aa4ec4f3b800 100644 --- a/internal/refactoring/move_validate_test.go +++ b/internal/refactoring/move_validate_test.go @@ -366,6 +366,50 @@ Each resource can have moved from only one source resource.`, }, WantError: `Cross-package move statement: This statement declares a move to an object declared in external module package "fake-external:///". Move statements can be only within a single module package.`, }, + "implied move from resource in another module package": { + Statements: []MoveStatement{ + makeTestImpliedMoveStmt(t, + ``, + `module.fake_external.test.thing`, + `test.thing`, + ), + }, + // Implied move statements are not subject to the cross-package restriction + WantError: ``, + }, + "implied move to resource in another module package": { + Statements: []MoveStatement{ + makeTestImpliedMoveStmt(t, + ``, + `test.thing`, + `module.fake_external.test.thing`, + ), + }, + // Implied move statements are not subject to the cross-package restriction + WantError: ``, + }, + "implied move from module call in another module package": { + Statements: []MoveStatement{ + makeTestImpliedMoveStmt(t, + ``, + `module.fake_external.module.a`, + `module.b`, + ), + }, + // Implied move statements are not subject to the cross-package restriction + WantError: ``, + }, + "implied move to module call in another module package": { + Statements: []MoveStatement{ + makeTestImpliedMoveStmt(t, + ``, + `module.a`, + `module.fake_external.module.b`, + ), + }, + // Implied move statements are not subject to the cross-package restriction + WantError: ``, + }, "move to a call that refers to another module package": { Statements: []MoveStatement{ makeTestMoveStmt(t, @@ -650,6 +694,13 @@ func makeTestMoveStmt(t *testing.T, moduleStr, fromStr, toStr string) MoveStatem } } +func makeTestImpliedMoveStmt(t *testing.T, moduleStr, fromStr, toStr string) MoveStatement { + t.Helper() + ret := makeTestMoveStmt(t, moduleStr, fromStr, toStr) + ret.Implied = true + return ret +} + var fakeExternalModuleSource = addrs.ModuleSourceRemote{ PackageAddr: addrs.ModulePackage("fake-external:///"), } From e95f29bf9d43bab3198964e5af56e6124506e56f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 10 Jan 2022 16:06:19 -0800 Subject: [PATCH 504/644] lang/funcs: fileexists slightly better "not a file" error message Previously we were just returning a string representation of the file mode, which spends more characters on the irrelevant permission bits that it does on the directory entry type, and is presented in a Unix-centric format that likely won't be familiar to the user of a Windows system. Instead, we'll recognize a few specific directory entry types that seem worth mentioning by name, and then use a generic message for the rest. The original motivation here was actually to deal with the fact that our tests for this function were previously not portable due to the error message leaking system-specific permission detail that are not relevant to the test. Rather than just directly addressing that portability problem, I took the opportunity to improve the error messages at the same time. However, because of that initial focus there are only actually tests here for the directory case. A test that tries to test any of these other file modes would not be portable and in some cases would require superuser access, so we'll just leave those cases untested for the moment since they weren't tested before anyway, and so we've not _lost_ any test coverage here. --- internal/lang/funcs/filesystem.go | 26 ++++++++++++++++++++++++-- internal/lang/funcs/filesystem_test.go | 4 ++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/internal/lang/funcs/filesystem.go b/internal/lang/funcs/filesystem.go index 01e090a5b3f2..e5de7907c433 100644 --- a/internal/lang/funcs/filesystem.go +++ b/internal/lang/funcs/filesystem.go @@ -226,8 +226,30 @@ func MakeFileExistsFunc(baseDir string) function.Function { return cty.True.WithMarks(pathMarks), nil } - return cty.False, fmt.Errorf("%s is not a regular file, but %q", - redactIfSensitive(path, pathMarks), fi.Mode().String()) + // The Go stat API only provides convenient access to whether it's + // a directory or not, so we need to do some bit fiddling to + // recognize other irregular file types. + filename := redactIfSensitive(path, pathMarks) + fileType := fi.Mode().Type() + switch { + case (fileType & os.ModeDir) != 0: + err = function.NewArgErrorf(1, "%s is a directory, not a file", filename) + case (fileType & os.ModeDevice) != 0: + err = function.NewArgErrorf(1, "%s is a device node, not a regular file", filename) + case (fileType & os.ModeNamedPipe) != 0: + err = function.NewArgErrorf(1, "%s is a named pipe, not a regular file", filename) + case (fileType & os.ModeSocket) != 0: + err = function.NewArgErrorf(1, "%s is a unix domain socket, not a regular file", filename) + default: + // If it's not a type we recognize then we'll just return a + // generic error message. This should be very rare. + err = function.NewArgErrorf(1, "%s is not a regular file", filename) + + // Note: os.ModeSymlink should be impossible because we used + // os.Stat above, not os.Lstat. + } + + return cty.False, err }, }) } diff --git a/internal/lang/funcs/filesystem_test.go b/internal/lang/funcs/filesystem_test.go index 4e673984bbbe..037137ae64f4 100644 --- a/internal/lang/funcs/filesystem_test.go +++ b/internal/lang/funcs/filesystem_test.go @@ -228,12 +228,12 @@ func TestFileExists(t *testing.T) { { cty.StringVal(""), cty.BoolVal(false), - `"." is not a regular file, but "drwxr-xr-x"`, + `"." is a directory, not a file`, }, { cty.StringVal("testdata").Mark(marks.Sensitive), cty.BoolVal(false), - `(sensitive value) is not a regular file, but "drwxr-xr-x"`, + `(sensitive value) is a directory, not a file`, }, { cty.StringVal("testdata/missing"), From 8d1bced8126eb7425168bac0df288d98b0483d91 Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Fri, 7 Jan 2022 14:05:56 -0600 Subject: [PATCH 505/644] cli: Refactor show command to remove dependence on local run and only load the backend when we need it See https://github.com/hashicorp/terraform/pull/30205#issuecomment-997113175 for more context --- internal/command/show.go | 160 ++++++++++++++++++--------------------- 1 file changed, 72 insertions(+), 88 deletions(-) diff --git a/internal/command/show.go b/internal/command/show.go index 728ea98728c2..c3c88ebf6133 100644 --- a/internal/command/show.go +++ b/internal/command/show.go @@ -11,10 +11,12 @@ import ( "github.com/hashicorp/terraform/internal/command/jsonplan" "github.com/hashicorp/terraform/internal/command/jsonstate" "github.com/hashicorp/terraform/internal/command/views" + "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/planfile" "github.com/hashicorp/terraform/internal/states/statefile" "github.com/hashicorp/terraform/internal/states/statemgr" + "github.com/hashicorp/terraform/internal/terraform" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -53,79 +55,17 @@ func (c *ShowCommand) Run(args []string) int { var diags tfdiags.Diagnostics - // Load the backend - b, backendDiags := c.Backend(nil) - diags = diags.Append(backendDiags) - if backendDiags.HasErrors() { - c.showDiagnostics(diags) - return 1 - } - - // We require a local backend - local, ok := b.(backend.Local) - if !ok { - c.showDiagnostics(diags) // in case of any warnings in here - c.Ui.Error(ErrUnsupportedLocalOp) - return 1 - } - - // This is a read-only command - c.ignoreRemoteVersionConflict(b) - - // the show command expects the config dir to always be the cwd - cwd, err := os.Getwd() - if err != nil { - c.Ui.Error(fmt.Sprintf("Error getting cwd: %s", err)) - return 1 - } - - // Determine if a planfile was passed to the command - var planFile *planfile.Reader - if len(args) > 0 { - // We will handle error checking later on - this is just required to - // load the local context if the given path is successfully read as - // a planfile. - planFile, _ = c.PlanFile(args[0]) - } - - // Build the operation - opReq := c.Operation(b) - opReq.ConfigDir = cwd - opReq.PlanFile = planFile - opReq.ConfigLoader, err = c.initConfigLoader() - opReq.AllowUnsetVariables = true - opReq.DisablePlanFileStateLineageChecks = true - if err != nil { - diags = diags.Append(err) - c.showDiagnostics(diags) - return 1 - } - - // Get the context - lr, _, ctxDiags := local.LocalRun(opReq) - diags = diags.Append(ctxDiags) - if ctxDiags.HasErrors() { - c.showDiagnostics(diags) - return 1 - } - - // Get the schemas from the context - schemas, moreDiags := lr.Core.Schemas(lr.Config, lr.InputState) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - c.showDiagnostics(diags) - return 1 - } - var planErr, stateErr error var plan *plans.Plan var stateFile *statefile.File + var config *configs.Config + var schemas *terraform.Schemas // if a path was provided, try to read it as a path to a planfile // if that fails, try to read the cli argument as a path to a statefile if len(args) > 0 { path := args[0] - plan, stateFile, planErr = getPlanFromPath(path) + plan, stateFile, config, planErr = getPlanFromPath(path) if planErr != nil { stateFile, stateErr = getStateFromPath(path) if stateErr != nil { @@ -140,21 +80,51 @@ func (c *ShowCommand) Run(args []string) int { } } } else { - env, err := c.Workspace() + // Load the backend + b, backendDiags := c.Backend(nil) + diags = diags.Append(backendDiags) + if backendDiags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } + c.ignoreRemoteVersionConflict(b) + + workspace, err := c.Workspace() if err != nil { c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err)) return 1 } - stateFile, stateErr = getStateFromEnv(b, env) + stateFile, stateErr = getStateFromBackend(b, workspace) if stateErr != nil { c.Ui.Error(stateErr.Error()) return 1 } } + if config != nil || stateFile != nil { + opts, err := c.contextOpts() + if err != nil { + diags = diags.Append(err) + c.showDiagnostics(diags) + return 1 + } + tfCtx, ctxDiags := terraform.NewContext(opts) + diags = diags.Append(ctxDiags) + if ctxDiags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } + var schemaDiags tfdiags.Diagnostics + schemas, schemaDiags = tfCtx.Schemas(config, stateFile.State) + diags = diags.Append(schemaDiags) + if schemaDiags.HasErrors() { + c.showDiagnostics(diags) + return 1 + } + } + if plan != nil { if jsonOutput { - config := lr.Config jsonPlan, err := jsonplan.Marshal(config, plan, stateFile, schemas) if err != nil { @@ -215,52 +185,66 @@ func (c *ShowCommand) Synopsis() string { return "Show the current state or a saved plan" } -// getPlanFromPath returns a plan and statefile if the user-supplied path points -// to a planfile. If both plan and error are nil, the path is likely a -// directory. An error could suggest that the given path points to a statefile. -func getPlanFromPath(path string) (*plans.Plan, *statefile.File, error) { - pr, err := planfile.Open(path) +// getPlanFromPath returns a plan, statefile, and config if the user-supplied +// path points to a planfile. If both plan and error are nil, the path is likely +// a directory. An error could suggest that the given path points to a statefile. +func getPlanFromPath(path string) (*plans.Plan, *statefile.File, *configs.Config, error) { + planReader, err := planfile.Open(path) if err != nil { - return nil, nil, err + return nil, nil, nil, err } - plan, err := pr.ReadPlan() + + // Get plan + plan, err := planReader.ReadPlan() if err != nil { - return nil, nil, err + return nil, nil, nil, err } - stateFile, err := pr.ReadStateFile() - return plan, stateFile, err + // Get statefile + stateFile, err := planReader.ReadStateFile() + if err != nil { + return nil, nil, nil, err + } + + // Get config + config, diags := planReader.ReadConfig() + if diags.HasErrors() { + return nil, nil, nil, diags.Err() + } + + return plan, stateFile, config, err } // getStateFromPath returns a statefile if the user-supplied path points to a statefile. func getStateFromPath(path string) (*statefile.File, error) { - f, err := os.Open(path) + file, err := os.Open(path) if err != nil { return nil, fmt.Errorf("Error loading statefile: %s", err) } - defer f.Close() + defer file.Close() var stateFile *statefile.File - stateFile, err = statefile.Read(f) + stateFile, err = statefile.Read(file) if err != nil { return nil, fmt.Errorf("Error reading %s as a statefile: %s", path, err) } return stateFile, nil } -// getStateFromEnv returns the State for the current workspace, if available. -func getStateFromEnv(b backend.Backend, env string) (*statefile.File, error) { - // Get the state - stateStore, err := b.StateMgr(env) +// getStateFromBackend returns the State for the current workspace, if available. +func getStateFromBackend(b backend.Backend, workspace string) (*statefile.File, error) { + // Get the state store for the given workspace + stateStore, err := b.StateMgr(workspace) if err != nil { return nil, fmt.Errorf("Failed to load state manager: %s", err) } + // Refresh the state store with the latest state snapshot from persistent storage if err := stateStore.RefreshState(); err != nil { return nil, fmt.Errorf("Failed to load state: %s", err) } - sf := statemgr.Export(stateStore) - - return sf, nil + // Get the latest state snapshot and return it + stateFile := statemgr.Export(stateStore) + return stateFile, nil } From fea8f6cfa220e3db34b30d8c21345aa0fa6f01e4 Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Mon, 10 Jan 2022 17:16:12 -0600 Subject: [PATCH 506/644] cli: Migrate show command to use command arguments and views --- internal/command/arguments/show.go | 59 +++ internal/command/arguments/show_test.go | 99 ++++ internal/command/show.go | 230 ++++----- internal/command/show_test.go | 458 ++++++++++++------ .../show-json-state/empty/terraform.tfstate | 0 .../show-json-state/no-state/output.json | 3 + internal/command/views/show.go | 82 +++- internal/command/views/show_test.go | 184 +++++++ internal/command/views/testdata/show/main.tf | 3 + 9 files changed, 854 insertions(+), 264 deletions(-) create mode 100644 internal/command/arguments/show.go create mode 100644 internal/command/arguments/show_test.go create mode 100644 internal/command/testdata/show-json-state/empty/terraform.tfstate create mode 100644 internal/command/testdata/show-json-state/no-state/output.json create mode 100644 internal/command/views/show_test.go create mode 100644 internal/command/views/testdata/show/main.tf diff --git a/internal/command/arguments/show.go b/internal/command/arguments/show.go new file mode 100644 index 000000000000..4d95fc1daa7b --- /dev/null +++ b/internal/command/arguments/show.go @@ -0,0 +1,59 @@ +package arguments + +import ( + "github.com/hashicorp/terraform/internal/tfdiags" +) + +// Show represents the command-line arguments for the show command. +type Show struct { + // Path is the path to the state file or plan file to be displayed. If + // unspecified, show will display the latest state snapshot. + Path string + + // ViewType specifies which output format to use: human, JSON, or "raw". + ViewType ViewType +} + +// ParseShow processes CLI arguments, returning a Show value and errors. +// If errors are encountered, a Show value is still returned representing +// the best effort interpretation of the arguments. +func ParseShow(args []string) (*Show, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + show := &Show{ + Path: "", + } + + var jsonOutput bool + cmdFlags := defaultFlagSet("show") + cmdFlags.BoolVar(&jsonOutput, "json", false, "json") + + if err := cmdFlags.Parse(args); err != nil { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Failed to parse command-line flags", + err.Error(), + )) + } + + args = cmdFlags.Args() + if len(args) > 1 { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Too many command line arguments", + "Expected at most one positional argument.", + )) + } + + if len(args) > 0 { + show.Path = args[0] + } + + switch { + case jsonOutput: + show.ViewType = ViewJSON + default: + show.ViewType = ViewHuman + } + + return show, diags +} diff --git a/internal/command/arguments/show_test.go b/internal/command/arguments/show_test.go new file mode 100644 index 000000000000..5088e1a94e5b --- /dev/null +++ b/internal/command/arguments/show_test.go @@ -0,0 +1,99 @@ +package arguments + +import ( + "reflect" + "testing" + + "github.com/davecgh/go-spew/spew" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +func TestParseShow_valid(t *testing.T) { + testCases := map[string]struct { + args []string + want *Show + }{ + "defaults": { + nil, + &Show{ + Path: "", + ViewType: ViewHuman, + }, + }, + "json": { + []string{"-json"}, + &Show{ + Path: "", + ViewType: ViewJSON, + }, + }, + "path": { + []string{"-json", "foo"}, + &Show{ + Path: "foo", + ViewType: ViewJSON, + }, + }, + } + + for name, tc := range testCases { + t.Run(name, func(t *testing.T) { + got, diags := ParseShow(tc.args) + if len(diags) > 0 { + t.Fatalf("unexpected diags: %v", diags) + } + if *got != *tc.want { + t.Fatalf("unexpected result\n got: %#v\nwant: %#v", got, tc.want) + } + }) + } +} + +func TestParseShow_invalid(t *testing.T) { + testCases := map[string]struct { + args []string + want *Show + wantDiags tfdiags.Diagnostics + }{ + "unknown flag": { + []string{"-boop"}, + &Show{ + Path: "", + ViewType: ViewHuman, + }, + tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Error, + "Failed to parse command-line flags", + "flag provided but not defined: -boop", + ), + }, + }, + "too many arguments": { + []string{"-json", "bar", "baz"}, + &Show{ + Path: "bar", + ViewType: ViewJSON, + }, + tfdiags.Diagnostics{ + tfdiags.Sourceless( + tfdiags.Error, + "Too many command line arguments", + "Expected at most one positional argument.", + ), + }, + }, + } + + for name, tc := range testCases { + t.Run(name, func(t *testing.T) { + got, gotDiags := ParseShow(tc.args) + if *got != *tc.want { + t.Fatalf("unexpected result\n got: %#v\nwant: %#v", got, tc.want) + } + if !reflect.DeepEqual(gotDiags, tc.wantDiags) { + t.Errorf("wrong result\ngot: %s\nwant: %s", spew.Sdump(gotDiags), spew.Sdump(tc.wantDiags)) + } + }) + } +} diff --git a/internal/command/show.go b/internal/command/show.go index c3c88ebf6133..0b16ee735285 100644 --- a/internal/command/show.go +++ b/internal/command/show.go @@ -7,9 +7,6 @@ import ( "github.com/hashicorp/terraform/internal/backend" "github.com/hashicorp/terraform/internal/command/arguments" - "github.com/hashicorp/terraform/internal/command/format" - "github.com/hashicorp/terraform/internal/command/jsonplan" - "github.com/hashicorp/terraform/internal/command/jsonstate" "github.com/hashicorp/terraform/internal/command/views" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/plans" @@ -26,167 +23,170 @@ type ShowCommand struct { Meta } -func (c *ShowCommand) Run(args []string) int { - args = c.Meta.process(args) - cmdFlags := c.Meta.defaultFlagSet("show") - var jsonOutput bool - cmdFlags.BoolVar(&jsonOutput, "json", false, "produce JSON output") - cmdFlags.Usage = func() { c.Ui.Error(c.Help()) } - if err := cmdFlags.Parse(args); err != nil { - c.Ui.Error(fmt.Sprintf("Error parsing command-line flags: %s\n", err.Error())) - return 1 - } +func (c *ShowCommand) Run(rawArgs []string) int { + // Parse and apply global view arguments + common, rawArgs := arguments.ParseView(rawArgs) + c.View.Configure(common) - args = cmdFlags.Args() - if len(args) > 2 { - c.Ui.Error( - "The show command expects at most two arguments.\n The path to a " + - "Terraform state or plan file, and optionally -json for json output.\n") - cmdFlags.Usage() + // Parse and validate flags + args, diags := arguments.ParseShow(rawArgs) + if diags.HasErrors() { + c.View.Diagnostics(diags) + c.View.HelpPrompt("show") return 1 } + // Set up view + view := views.NewShow(args.ViewType, c.View) + // Check for user-supplied plugin path var err error if c.pluginPath, err = c.loadPluginPath(); err != nil { - c.Ui.Error(fmt.Sprintf("Error loading plugin path: %s", err)) + diags = diags.Append(fmt.Errorf("error loading plugin path: %s", err)) + view.Diagnostics(diags) return 1 } - var diags tfdiags.Diagnostics + // Get the data we need to display + plan, stateFile, config, schemas, showDiags := c.show(args.Path) + diags = diags.Append(showDiags) + if showDiags.HasErrors() { + view.Diagnostics(diags) + return 1 + } - var planErr, stateErr error + // Display the data + return view.Display(config, plan, stateFile, schemas) +} + +func (c *ShowCommand) Help() string { + helpText := ` +Usage: terraform [global options] show [options] [path] + + Reads and outputs a Terraform state or plan file in a human-readable + form. If no path is specified, the current state will be shown. + +Options: + + -no-color If specified, output won't contain any color. + -json If specified, output the Terraform plan or state in + a machine-readable form. + +` + return strings.TrimSpace(helpText) +} + +func (c *ShowCommand) Synopsis() string { + return "Show the current state or a saved plan" +} + +func (c *ShowCommand) show(path string) (*plans.Plan, *statefile.File, *configs.Config, *terraform.Schemas, tfdiags.Diagnostics) { + var diags, showDiags tfdiags.Diagnostics var plan *plans.Plan var stateFile *statefile.File var config *configs.Config var schemas *terraform.Schemas - // if a path was provided, try to read it as a path to a planfile - // if that fails, try to read the cli argument as a path to a statefile - if len(args) > 0 { - path := args[0] - plan, stateFile, config, planErr = getPlanFromPath(path) - if planErr != nil { - stateFile, stateErr = getStateFromPath(path) - if stateErr != nil { - c.Ui.Error(fmt.Sprintf( - "Terraform couldn't read the given file as a state or plan file.\n"+ - "The errors while attempting to read the file as each format are\n"+ - "shown below.\n\n"+ - "State read error: %s\n\nPlan read error: %s", - stateErr, - planErr)) - return 1 - } + // No plan file or state file argument provided, + // so get the latest state snapshot + if path == "" { + stateFile, showDiags = c.showFromLatestStateSnapshot() + diags = diags.Append(showDiags) + if showDiags.HasErrors() { + return plan, stateFile, config, schemas, diags } - } else { - // Load the backend - b, backendDiags := c.Backend(nil) - diags = diags.Append(backendDiags) - if backendDiags.HasErrors() { - c.showDiagnostics(diags) - return 1 - } - c.ignoreRemoteVersionConflict(b) + } - workspace, err := c.Workspace() - if err != nil { - c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err)) - return 1 - } - stateFile, stateErr = getStateFromBackend(b, workspace) - if stateErr != nil { - c.Ui.Error(stateErr.Error()) - return 1 + // Plan file or state file argument provided, + // so try to load the argument as a plan file first. + // If that fails, try to load it as a statefile. + if path != "" { + plan, stateFile, config, showDiags = c.showFromPath(path) + diags = diags.Append(showDiags) + if showDiags.HasErrors() { + return plan, stateFile, config, schemas, diags } } + // Get schemas, if possible if config != nil || stateFile != nil { opts, err := c.contextOpts() if err != nil { diags = diags.Append(err) - c.showDiagnostics(diags) - return 1 + return plan, stateFile, config, schemas, diags } tfCtx, ctxDiags := terraform.NewContext(opts) diags = diags.Append(ctxDiags) if ctxDiags.HasErrors() { - c.showDiagnostics(diags) - return 1 + return plan, stateFile, config, schemas, diags } var schemaDiags tfdiags.Diagnostics schemas, schemaDiags = tfCtx.Schemas(config, stateFile.State) diags = diags.Append(schemaDiags) if schemaDiags.HasErrors() { - c.showDiagnostics(diags) - return 1 + return plan, stateFile, config, schemas, diags } } - if plan != nil { - if jsonOutput { - jsonPlan, err := jsonplan.Marshal(config, plan, stateFile, schemas) + return plan, stateFile, config, schemas, diags +} +func (c *ShowCommand) showFromLatestStateSnapshot() (*statefile.File, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics - if err != nil { - c.Ui.Error(fmt.Sprintf("Failed to marshal plan to json: %s", err)) - return 1 - } - c.Ui.Output(string(jsonPlan)) - return 0 - } + // Load the backend + b, backendDiags := c.Backend(nil) + diags = diags.Append(backendDiags) + if backendDiags.HasErrors() { + return nil, diags + } + c.ignoreRemoteVersionConflict(b) - view := views.NewShow(arguments.ViewHuman, c.View) - view.Plan(plan, schemas) - return 0 + // Load the workspace + workspace, err := c.Workspace() + if err != nil { + diags = diags.Append(fmt.Errorf("error selecting workspace: %s", err)) + return nil, diags } - if jsonOutput { - // At this point, it is possible that there is neither state nor a plan. - // That's ok, we'll just return an empty object. - jsonState, err := jsonstate.Marshal(stateFile, schemas) - if err != nil { - c.Ui.Error(fmt.Sprintf("Failed to marshal state to json: %s", err)) - return 1 - } - c.Ui.Output(string(jsonState)) - } else { - if stateFile == nil { - c.Ui.Output("No state.") - return 0 - } - c.Ui.Output(format.State(&format.StateOpts{ - State: stateFile.State, - Color: c.Colorize(), - Schemas: schemas, - })) + // Get the latest state snapshot from the backend for the current workspace + stateFile, stateErr := getStateFromBackend(b, workspace) + if stateErr != nil { + diags = diags.Append(stateErr.Error()) + return nil, diags } - return 0 + return stateFile, diags } -func (c *ShowCommand) Help() string { - helpText := ` -Usage: terraform [global options] show [options] [path] - - Reads and outputs a Terraform state or plan file in a human-readable - form. If no path is specified, the current state will be shown. - -Options: - - -no-color If specified, output won't contain any color. - -json If specified, output the Terraform plan or state in - a machine-readable form. - -` - return strings.TrimSpace(helpText) -} +func (c *ShowCommand) showFromPath(path string) (*plans.Plan, *statefile.File, *configs.Config, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + var planErr, stateErr error + var plan *plans.Plan + var stateFile *statefile.File + var config *configs.Config -func (c *ShowCommand) Synopsis() string { - return "Show the current state or a saved plan" + // Try to get the plan file and associated data from + // the path argument. If that fails, try to get the + // statefile from the path argument. + plan, stateFile, config, planErr = getPlanFromPath(path) + if planErr != nil { + stateFile, stateErr = getStateFromPath(path) + if stateErr != nil { + diags = diags.Append( + tfdiags.Sourceless( + tfdiags.Error, + "Failed to read the given file as a state or plan file", + fmt.Sprintf("State read error: %s\n\nPlan read error: %s", stateErr, planErr), + ), + ) + return nil, nil, nil, diags + } + } + return plan, stateFile, config, diags } // getPlanFromPath returns a plan, statefile, and config if the user-supplied -// path points to a planfile. If both plan and error are nil, the path is likely +// path points to a plan file. If both plan and error are nil, the path is likely // a directory. An error could suggest that the given path points to a statefile. func getPlanFromPath(path string) (*plans.Plan, *statefile.File, *configs.Config, error) { planReader, err := planfile.Open(path) diff --git a/internal/command/show_test.go b/internal/command/show_test.go index 25504d2c21cf..5f220e906ee0 100644 --- a/internal/command/show_test.go +++ b/internal/command/show_test.go @@ -2,7 +2,6 @@ package command import ( "encoding/json" - "fmt" "io/ioutil" "os" "path/filepath" @@ -22,13 +21,11 @@ import ( "github.com/zclconf/go-cty/cty" ) -func TestShow(t *testing.T) { - ui := new(cli.MockUi) - view, _ := testView(t) +func TestShow_badArgs(t *testing.T) { + view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } @@ -36,40 +33,99 @@ func TestShow(t *testing.T) { args := []string{ "bad", "bad", + "-no-color", + } + + code := c.Run(args) + output := done(t) + + if code != 1 { + t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout()) } - if code := c.Run(args); code != 1 { - t.Fatalf("bad: \n%s", ui.OutputWriter.String()) +} + +func TestShow_noArgsNoState(t *testing.T) { + view, done := testView(t) + c := &ShowCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + View: view, + }, + } + + code := c.Run([]string{}) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) + } + + got := output.Stdout() + want := `No state.` + if !strings.Contains(got, want) { + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) } } -func TestShow_noArgs(t *testing.T) { +func TestShow_noArgsWithState(t *testing.T) { // Get a temp cwd tmp, cwd := testCwd(t) defer testFixCwd(t, tmp, cwd) // Create the default state testStateFileDefault(t, testState()) - ui := new(cli.MockUi) - view, _ := testView(t) + view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } - if code := c.Run([]string{}); code != 0 { - t.Fatalf("bad: \n%s", ui.OutputWriter.String()) + code := c.Run([]string{}) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } - if !strings.Contains(ui.OutputWriter.String(), "# test_instance.foo:") { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + got := output.Stdout() + want := `# test_instance.foo:` + if !strings.Contains(got, want) { + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) + } +} + +func TestShow_argsWithState(t *testing.T) { + // Create the default state + statePath := testStateFile(t, testState()) + stateDir := filepath.Dir(statePath) + defer os.RemoveAll(stateDir) + defer testChdir(t, stateDir)() + + view, done := testView(t) + c := &ShowCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + View: view, + }, + } + + path := filepath.Base(statePath) + args := []string{ + path, + "-no-color", + } + code := c.Run(args) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } } // https://github.com/hashicorp/terraform/issues/21462 -func TestShow_aliasedProvider(t *testing.T) { +func TestShow_argsWithStateAliasedProvider(t *testing.T) { // Create the default state with aliased resource testState := states.BuildState(func(s *states.SyncState) { s.SetResourceInstanceCurrent( @@ -95,103 +151,198 @@ func TestShow_aliasedProvider(t *testing.T) { defer os.RemoveAll(stateDir) defer testChdir(t, stateDir)() - ui := new(cli.MockUi) - view, _ := testView(t) + view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } - // the statefile created by testStateFile is named state.tfstate - args := []string{"state.tfstate"} - if code := c.Run(args); code != 0 { - t.Fatalf("bad exit code: \n%s", ui.OutputWriter.String()) + path := filepath.Base(statePath) + args := []string{ + path, + "-no-color", + } + code := c.Run(args) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } - if strings.Contains(ui.OutputWriter.String(), "# missing schema for provider \"test.alias\"") { - t.Fatalf("bad output: \n%s", ui.OutputWriter.String()) + got := output.Stdout() + want := `# missing schema for provider \"test.alias\"` + if strings.Contains(got, want) { + t.Fatalf("unexpected output\ngot: %s", got) } } -func TestShow_noArgsNoState(t *testing.T) { - // Create the default state - statePath := testStateFile(t, testState()) - stateDir := filepath.Dir(statePath) - defer os.RemoveAll(stateDir) - defer testChdir(t, stateDir)() +func TestShow_argsPlanFileDoesNotExist(t *testing.T) { + view, done := testView(t) + c := &ShowCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + View: view, + }, + } - ui := new(cli.MockUi) - view, _ := testView(t) + args := []string{ + "doesNotExist.tfplan", + "-no-color", + } + code := c.Run(args) + output := done(t) + + if code != 1 { + t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout()) + } + + got := output.Stderr() + want := `Plan read error: open doesNotExist.tfplan:` + if !strings.Contains(got, want) { + t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want) + } +} + +func TestShow_argsStatefileDoesNotExist(t *testing.T) { + view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } - // the statefile created by testStateFile is named state.tfstate - args := []string{"state.tfstate"} - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.OutputWriter.String()) + args := []string{ + "doesNotExist.tfstate", + "-no-color", + } + code := c.Run(args) + output := done(t) + + if code != 1 { + t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout()) + } + + got := output.Stderr() + want := `State read error: Error loading statefile:` + if !strings.Contains(got, want) { + t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want) + } +} + +func TestShow_json_argsPlanFileDoesNotExist(t *testing.T) { + view, done := testView(t) + c := &ShowCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + View: view, + }, + } + + args := []string{ + "-json", + "doesNotExist.tfplan", + "-no-color", + } + code := c.Run(args) + output := done(t) + + if code != 1 { + t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout()) + } + + got := output.Stderr() + want := `Plan read error: open doesNotExist.tfplan:` + if !strings.Contains(got, want) { + t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want) + } +} + +func TestShow_json_argsStatefileDoesNotExist(t *testing.T) { + view, done := testView(t) + c := &ShowCommand{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(testProvider()), + View: view, + }, + } + + args := []string{ + "-json", + "doesNotExist.tfstate", + "-no-color", + } + code := c.Run(args) + output := done(t) + + if code != 1 { + t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout()) + } + + got := output.Stderr() + want := `State read error: Error loading statefile:` + if !strings.Contains(got, want) { + t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want) } } func TestShow_planNoop(t *testing.T) { planPath := testPlanFileNoop(t) - ui := cli.NewMockUi() view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } args := []string{ planPath, + "-no-color", } - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + code := c.Run(args) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } + got := output.Stdout() want := `No changes. Your infrastructure matches the configuration.` - got := done(t).Stdout() if !strings.Contains(got, want) { - t.Errorf("missing expected output\nwant: %s\ngot:\n%s", want, got) + t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want) } } func TestShow_planWithChanges(t *testing.T) { planPathWithChanges := showFixturePlanFile(t, plans.DeleteThenCreate) - ui := cli.NewMockUi() view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(showFixtureProvider()), - Ui: ui, View: view, }, } args := []string{ planPathWithChanges, + "-no-color", } + code := c.Run(args) + output := done(t) - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } + got := output.Stdout() want := `test_instance.foo must be replaced` - got := done(t).Stdout() if !strings.Contains(got, want) { - t.Errorf("missing expected output\nwant: %s\ngot:\n%s", want, got) + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) } } @@ -239,30 +390,34 @@ func TestShow_planWithForceReplaceChange(t *testing.T) { plan, ) - ui := cli.NewMockUi() view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(showFixtureProvider()), - Ui: ui, View: view, }, } args := []string{ planFilePath, + "-no-color", } + code := c.Run(args) + output := done(t) - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } - got := done(t).Stdout() - if want := `test_instance.foo will be replaced, as requested`; !strings.Contains(got, want) { - t.Errorf("wrong output\ngot:\n%s\n\nwant substring: %s", got, want) + got := output.Stdout() + want := `test_instance.foo will be replaced, as requested` + if !strings.Contains(got, want) { + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) } - if want := `Plan: 1 to add, 0 to change, 1 to destroy.`; !strings.Contains(got, want) { - t.Errorf("wrong output\ngot:\n%s\n\nwant substring: %s", got, want) + + want = `Plan: 1 to add, 0 to change, 1 to destroy.` + if !strings.Contains(got, want) { + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) } } @@ -270,12 +425,10 @@ func TestShow_planWithForceReplaceChange(t *testing.T) { func TestShow_plan_json(t *testing.T) { planPath := showFixturePlanFile(t, plans.Create) - ui := new(cli.MockUi) - view, _ := testView(t) + view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(showFixtureProvider()), - Ui: ui, View: view, }, } @@ -283,9 +436,13 @@ func TestShow_plan_json(t *testing.T) { args := []string{ "-json", planPath, + "-no-color", } - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + code := c.Run(args) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } } @@ -294,21 +451,23 @@ func TestShow_state(t *testing.T) { statePath := testStateFile(t, originalState) defer os.RemoveAll(filepath.Dir(statePath)) - ui := new(cli.MockUi) - view, _ := testView(t) + view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } args := []string{ statePath, + "-no-color", } - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + code := c.Run(args) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } } @@ -339,18 +498,15 @@ func TestShow_json_output(t *testing.T) { defer close() p := showFixtureProvider() - ui := new(cli.MockUi) - view, _ := testView(t) - m := Meta{ - testingOverrides: metaOverridesForProvider(p), - Ui: ui, - View: view, - ProviderSource: providerSource, - } // init + ui := new(cli.MockUi) ic := &InitCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + ProviderSource: providerSource, + }, } if code := ic.Run([]string{}); code != 0 { if expectError { @@ -360,22 +516,35 @@ func TestShow_json_output(t *testing.T) { t.Fatalf("init failed\n%s", ui.ErrorWriter) } + // plan + planView, planDone := testView(t) pc := &PlanCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + View: planView, + ProviderSource: providerSource, + }, } args := []string{ "-out=terraform.plan", } - if code := pc.Run(args); code != 0 { - t.Fatalf("wrong exit status %d; want 0\nstderr: %s", code, ui.ErrorWriter.String()) + code := pc.Run(args) + planOutput := planDone(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, planOutput.Stderr()) } - // flush the plan output from the mock ui - ui.OutputWriter.Reset() + // show + showView, showDone := testView(t) sc := &ShowCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + View: showView, + ProviderSource: providerSource, + }, } args = []string{ @@ -383,25 +552,27 @@ func TestShow_json_output(t *testing.T) { "terraform.plan", } defer os.Remove("terraform.plan") + code = sc.Run(args) + showOutput := showDone(t) - if code := sc.Run(args); code != 0 { - t.Fatalf("wrong exit status %d; want 0\nstderr: %s", code, ui.ErrorWriter.String()) + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr()) } - // compare ui output to wanted output + // compare view output to wanted output var got, want plan - gotString := ui.OutputWriter.String() + gotString := showOutput.Stdout() json.Unmarshal([]byte(gotString), &got) wantFile, err := os.Open("output.json") if err != nil { - t.Fatalf("err: %s", err) + t.Fatalf("unexpected err: %s", err) } defer wantFile.Close() byteValue, err := ioutil.ReadAll(wantFile) if err != nil { - t.Fatalf("err: %s", err) + t.Fatalf("unexpected err: %s", err) } json.Unmarshal([]byte(byteValue), &want) @@ -423,43 +594,48 @@ func TestShow_json_output_sensitive(t *testing.T) { defer close() p := showFixtureSensitiveProvider() - ui := new(cli.MockUi) - view, _ := testView(t) - m := Meta{ - testingOverrides: metaOverridesForProvider(p), - Ui: ui, - View: view, - ProviderSource: providerSource, - } // init + ui := new(cli.MockUi) ic := &InitCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + ProviderSource: providerSource, + }, } if code := ic.Run([]string{}); code != 0 { t.Fatalf("init failed\n%s", ui.ErrorWriter) } - // flush init output - ui.OutputWriter.Reset() - + // plan + planView, planDone := testView(t) pc := &PlanCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + View: planView, + ProviderSource: providerSource, + }, } args := []string{ "-out=terraform.plan", } + code := pc.Run(args) + planOutput := planDone(t) - if code := pc.Run(args); code != 0 { - fmt.Println(ui.OutputWriter.String()) - t.Fatalf("wrong exit status %d; want 0\nstderr: %s", code, ui.ErrorWriter.String()) + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, planOutput.Stderr()) } - // flush the plan output from the mock ui - ui.OutputWriter.Reset() + // show + showView, showDone := testView(t) sc := &ShowCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + View: showView, + ProviderSource: providerSource, + }, } args = []string{ @@ -467,25 +643,27 @@ func TestShow_json_output_sensitive(t *testing.T) { "terraform.plan", } defer os.Remove("terraform.plan") + code = sc.Run(args) + showOutput := showDone(t) - if code := sc.Run(args); code != 0 { - t.Fatalf("wrong exit status %d; want 0\nstderr: %s", code, ui.ErrorWriter.String()) + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr()) } // compare ui output to wanted output var got, want plan - gotString := ui.OutputWriter.String() + gotString := showOutput.Stdout() json.Unmarshal([]byte(gotString), &got) wantFile, err := os.Open("output.json") if err != nil { - t.Fatalf("err: %s", err) + t.Fatalf("unexpected err: %s", err) } defer wantFile.Close() byteValue, err := ioutil.ReadAll(wantFile) if err != nil { - t.Fatalf("err: %s", err) + t.Fatalf("unexpected err: %s", err) } json.Unmarshal([]byte(byteValue), &want) @@ -520,31 +698,35 @@ func TestShow_json_output_state(t *testing.T) { defer close() p := showFixtureProvider() - ui := new(cli.MockUi) - view, _ := testView(t) - m := Meta{ - testingOverrides: metaOverridesForProvider(p), - Ui: ui, - View: view, - ProviderSource: providerSource, - } // init + ui := new(cli.MockUi) ic := &InitCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + ProviderSource: providerSource, + }, } if code := ic.Run([]string{}); code != 0 { t.Fatalf("init failed\n%s", ui.ErrorWriter) } - // flush the plan output from the mock ui - ui.OutputWriter.Reset() + // show + showView, showDone := testView(t) sc := &ShowCommand{ - Meta: m, + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + View: showView, + ProviderSource: providerSource, + }, } - if code := sc.Run([]string{"-json"}); code != 0 { - t.Fatalf("wrong exit status %d; want 0\nstderr: %s", code, ui.ErrorWriter.String()) + code := sc.Run([]string{"-json"}) + showOutput := showDone(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr()) } // compare ui output to wanted output @@ -556,17 +738,17 @@ func TestShow_json_output_state(t *testing.T) { } var got, want state - gotString := ui.OutputWriter.String() + gotString := showOutput.Stdout() json.Unmarshal([]byte(gotString), &got) wantFile, err := os.Open("output.json") if err != nil { - t.Fatalf("err: %s", err) + t.Fatalf("unexpected error: %s", err) } defer wantFile.Close() byteValue, err := ioutil.ReadAll(wantFile) if err != nil { - t.Fatalf("err: %s", err) + t.Fatalf("unexpected err: %s", err) } json.Unmarshal([]byte(byteValue), &want) @@ -599,27 +781,29 @@ func TestShow_planWithNonDefaultStateLineage(t *testing.T) { } planPath := testPlanFileMatchState(t, snap, state, plan, stateMeta) - ui := cli.NewMockUi() view, done := testView(t) c := &ShowCommand{ Meta: Meta{ testingOverrides: metaOverridesForProvider(testProvider()), - Ui: ui, View: view, }, } args := []string{ planPath, + "-no-color", } - if code := c.Run(args); code != 0 { - t.Fatalf("bad: \n%s", ui.ErrorWriter.String()) + code := c.Run(args) + output := done(t) + + if code != 0 { + t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr()) } + got := output.Stdout() want := `No changes. Your infrastructure matches the configuration.` - got := done(t).Stdout() if !strings.Contains(got, want) { - t.Errorf("missing expected output\nwant: %s\ngot:\n%s", want, got) + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) } } diff --git a/internal/command/testdata/show-json-state/empty/terraform.tfstate b/internal/command/testdata/show-json-state/empty/terraform.tfstate new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/internal/command/testdata/show-json-state/no-state/output.json b/internal/command/testdata/show-json-state/no-state/output.json new file mode 100644 index 000000000000..381450cade5c --- /dev/null +++ b/internal/command/testdata/show-json-state/no-state/output.json @@ -0,0 +1,3 @@ +{ + "format_version": "1.0" +} diff --git a/internal/command/views/show.go b/internal/command/views/show.go index bfc45a4cefc8..1ab16c2d5125 100644 --- a/internal/command/views/show.go +++ b/internal/command/views/show.go @@ -2,37 +2,95 @@ package views import ( "fmt" - "github.com/hashicorp/terraform/internal/command/arguments" + "github.com/hashicorp/terraform/internal/command/format" + "github.com/hashicorp/terraform/internal/command/jsonplan" + "github.com/hashicorp/terraform/internal/command/jsonstate" + "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/states/statefile" "github.com/hashicorp/terraform/internal/terraform" + "github.com/hashicorp/terraform/internal/tfdiags" ) -// FIXME: this is a temporary partial definition of the view for the show -// command, in place to allow access to the plan renderer which is now in the -// views package. type Show interface { - Plan(plan *plans.Plan, schemas *terraform.Schemas) + // Display renders the plan, if it is available. If plan is nil, it renders the statefile. + Display(config *configs.Config, plan *plans.Plan, stateFile *statefile.File, schemas *terraform.Schemas) int + + // Diagnostics renders early diagnostics, resulting from argument parsing. + Diagnostics(diags tfdiags.Diagnostics) } -// FIXME: the show view should support both human and JSON types. This code is -// currently only used to render the plan in human-readable UI, so does not yet -// support JSON. func NewShow(vt arguments.ViewType, view *View) Show { switch vt { + case arguments.ViewJSON: + return &ShowJSON{view: view} case arguments.ViewHuman: - return &ShowHuman{View: *view} + return &ShowHuman{view: view} default: panic(fmt.Sprintf("unknown view type %v", vt)) } } type ShowHuman struct { - View + view *View } var _ Show = (*ShowHuman)(nil) -func (v *ShowHuman) Plan(plan *plans.Plan, schemas *terraform.Schemas) { - renderPlan(plan, schemas, &v.View) +func (v *ShowHuman) Display(config *configs.Config, plan *plans.Plan, stateFile *statefile.File, schemas *terraform.Schemas) int { + if plan != nil { + renderPlan(plan, schemas, v.view) + } else { + if stateFile == nil { + v.view.streams.Println("No state.") + return 0 + } + + v.view.streams.Println(format.State(&format.StateOpts{ + State: stateFile.State, + Color: v.view.colorize, + Schemas: schemas, + })) + } + return 0 +} + +func (v *ShowHuman) Diagnostics(diags tfdiags.Diagnostics) { + v.view.Diagnostics(diags) +} + +type ShowJSON struct { + view *View +} + +var _ Show = (*ShowJSON)(nil) + +func (v *ShowJSON) Display(config *configs.Config, plan *plans.Plan, stateFile *statefile.File, schemas *terraform.Schemas) int { + if plan != nil { + jsonPlan, err := jsonplan.Marshal(config, plan, stateFile, schemas) + + if err != nil { + v.view.streams.Eprintf("Failed to marshal plan to json: %s", err) + return 1 + } + v.view.streams.Println(string(jsonPlan)) + } else { + // It is possible that there is neither state nor a plan. + // That's ok, we'll just return an empty object. + jsonState, err := jsonstate.Marshal(stateFile, schemas) + if err != nil { + v.view.streams.Eprintf("Failed to marshal state to json: %s", err) + return 1 + } + v.view.streams.Println(string(jsonState)) + } + return 0 +} + +// Diagnostics should only be called if show cannot be executed. +// In this case, we choose to render human-readable diagnostic output, +// primarily for backwards compatibility. +func (v *ShowJSON) Diagnostics(diags tfdiags.Diagnostics) { + v.view.Diagnostics(diags) } diff --git a/internal/command/views/show_test.go b/internal/command/views/show_test.go new file mode 100644 index 000000000000..fe69130d9808 --- /dev/null +++ b/internal/command/views/show_test.go @@ -0,0 +1,184 @@ +package views + +import ( + "encoding/json" + "strings" + "testing" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/command/arguments" + "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/initwd" + "github.com/hashicorp/terraform/internal/plans" + "github.com/hashicorp/terraform/internal/states" + "github.com/hashicorp/terraform/internal/states/statefile" + "github.com/hashicorp/terraform/internal/terminal" + "github.com/hashicorp/terraform/internal/terraform" + + "github.com/zclconf/go-cty/cty" +) + +func TestShowHuman(t *testing.T) { + testCases := map[string]struct { + plan *plans.Plan + stateFile *statefile.File + schemas *terraform.Schemas + wantExact bool + wantString string + }{ + "plan file": { + testPlan(t), + nil, + testSchemas(), + false, + "# test_resource.foo will be created", + }, + "statefile": { + nil, + &statefile.File{ + Serial: 0, + Lineage: "fake-for-testing", + State: testState(), + }, + testSchemas(), + false, + "# test_resource.foo:", + }, + "empty statefile": { + nil, + &statefile.File{ + Serial: 0, + Lineage: "fake-for-testing", + State: states.NewState(), + }, + testSchemas(), + true, + "\n", + }, + "nothing": { + nil, + nil, + nil, + true, + "No state.\n", + }, + } + for name, testCase := range testCases { + t.Run(name, func(t *testing.T) { + streams, done := terminal.StreamsForTesting(t) + view := NewView(streams) + view.Configure(&arguments.View{NoColor: true}) + v := NewShow(arguments.ViewHuman, view) + + code := v.Display(nil, testCase.plan, testCase.stateFile, testCase.schemas) + if code != 0 { + t.Errorf("expected 0 return code, got %d", code) + } + + output := done(t) + got := output.Stdout() + want := testCase.wantString + if (testCase.wantExact && got != want) || (!testCase.wantExact && !strings.Contains(got, want)) { + t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want) + } + }) + } +} + +func TestShowJSON(t *testing.T) { + testCases := map[string]struct { + plan *plans.Plan + stateFile *statefile.File + }{ + "plan file": { + testPlan(t), + nil, + }, + "statefile": { + nil, + &statefile.File{ + Serial: 0, + Lineage: "fake-for-testing", + State: testState(), + }, + }, + "empty statefile": { + nil, + &statefile.File{ + Serial: 0, + Lineage: "fake-for-testing", + State: states.NewState(), + }, + }, + "nothing": { + nil, + nil, + }, + } + + config, _, configCleanup := initwd.MustLoadConfigForTests(t, "./testdata/show") + defer configCleanup() + + for name, testCase := range testCases { + t.Run(name, func(t *testing.T) { + streams, done := terminal.StreamsForTesting(t) + view := NewView(streams) + view.Configure(&arguments.View{NoColor: true}) + v := NewShow(arguments.ViewJSON, view) + + schemas := &terraform.Schemas{ + Providers: map[addrs.Provider]*terraform.ProviderSchema{ + addrs.NewDefaultProvider("test"): { + ResourceTypes: map[string]*configschema.Block{ + "test_resource": { + Attributes: map[string]*configschema.Attribute{ + "id": {Type: cty.String, Optional: true, Computed: true}, + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }, + }, + } + + code := v.Display(config, testCase.plan, testCase.stateFile, schemas) + + if code != 0 { + t.Errorf("expected 0 return code, got %d", code) + } + + // Make sure the result looks like JSON; we comprehensively test + // the structure of this output in the command package tests. + var result map[string]interface{} + got := done(t).All() + t.Logf("output: %s", got) + if err := json.Unmarshal([]byte(got), &result); err != nil { + t.Fatal(err) + } + }) + } +} + +// testState returns a test State structure. +func testState() *states.State { + return states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent( + addrs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_resource", + Name: "foo", + }.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance), + &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"id":"bar","foo":"value"}`), + Status: states.ObjectReady, + }, + addrs.AbsProviderConfig{ + Provider: addrs.NewDefaultProvider("test"), + Module: addrs.RootModule, + }, + ) + // DeepCopy is used here to ensure our synthetic state matches exactly + // with a state that will have been copied during the command + // operation, and all fields have been copied correctly. + }).DeepCopy() +} diff --git a/internal/command/views/testdata/show/main.tf b/internal/command/views/testdata/show/main.tf new file mode 100644 index 000000000000..e1cca23dd696 --- /dev/null +++ b/internal/command/views/testdata/show/main.tf @@ -0,0 +1,3 @@ +resource "test_resource" "foo" { + foo = "value" +} From 64e1241ae34013d4db1582ea2caca5c37609418f Mon Sep 17 00:00:00 2001 From: Krista LaFentres Date: Tue, 11 Jan 2022 16:53:36 -0600 Subject: [PATCH 507/644] backend/local: Remove unused DisablePlanFileStateLineageChecks flag Now that show command has been refactored to remove its dependence on a local backend and local run, this flag is no longer needed to fix #30195. --- internal/backend/backend.go | 7 ------- internal/backend/local/backend_local.go | 2 +- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/internal/backend/backend.go b/internal/backend/backend.go index 0e1daef402e3..4124b2abdb8c 100644 --- a/internal/backend/backend.go +++ b/internal/backend/backend.go @@ -275,13 +275,6 @@ type Operation struct { // the variables set in the plan are used instead, and they must be valid. AllowUnsetVariables bool - // When loading a plan file for a read-only operation, we may want to - // disable the state lineage checks which are only relevant for operations - // which can modify state. An example where this is important is showing - // a plan which was prepared against a non-default state file, because the - // lineage checks are always against the default state. - DisablePlanFileStateLineageChecks bool - // View implements the logic for all UI interactions. View views.Operation diff --git a/internal/backend/local/backend_local.go b/internal/backend/local/backend_local.go index a4a4fb67e152..6082bfdf6c61 100644 --- a/internal/backend/local/backend_local.go +++ b/internal/backend/local/backend_local.go @@ -284,7 +284,7 @@ func (b *Local) localRunForPlanFile(op *backend.Operation, pf *planfile.Reader, )) return nil, snap, diags } - if !op.DisablePlanFileStateLineageChecks && currentStateMeta != nil { + if currentStateMeta != nil { // If the caller sets this, we require that the stored prior state // has the same metadata, which is an extra safety check that nothing // has changed since the plan was created. (All of the "real-world" From 08fb9078ea5c05d1e18a6169161c21e56ce3cc24 Mon Sep 17 00:00:00 2001 From: yuriy Date: Mon, 17 Jan 2022 09:09:02 +0100 Subject: [PATCH 508/644] Update aws-sdk-go dependency to support new region (Jakarta) --- go.mod | 4 ++-- go.sum | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/go.mod b/go.mod index 194b60ca7bc1..2cbdb0fc0ece 100644 --- a/go.mod +++ b/go.mod @@ -15,7 +15,7 @@ require ( github.com/apparentlymart/go-userdirs v0.0.0-20200915174352-b0c018a67c13 github.com/apparentlymart/go-versions v1.0.1 github.com/armon/circbuf v0.0.0-20190214190532-5111143e8da2 - github.com/aws/aws-sdk-go v1.40.25 + github.com/aws/aws-sdk-go v1.42.35 github.com/bgentry/speakeasy v0.1.0 github.com/bmatcuk/doublestar v1.1.5 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e @@ -84,7 +84,7 @@ require ( go.etcd.io/etcd v0.5.0-alpha.5.0.20210428180535-15715dcf1ace golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa golang.org/x/mod v0.4.2 - golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d + golang.org/x/net v0.0.0-20211216030914-fe4d6282115f golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d diff --git a/go.sum b/go.sum index 8ef3722b7565..60c55b14988e 100644 --- a/go.sum +++ b/go.sum @@ -153,6 +153,8 @@ github.com/aws/aws-sdk-go v1.25.3/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN github.com/aws/aws-sdk-go v1.31.9/go.mod h1:5zCpMtNQVjRREroY7sYe8lOMRSxkhG6MZveU8YkpAk0= github.com/aws/aws-sdk-go v1.40.25 h1:Depnx7O86HWgOCLD5nMto6F9Ju85Q1QuFDnbpZYQWno= github.com/aws/aws-sdk-go v1.40.25/go.mod h1:585smgzpB/KqRA+K3y/NL/oYRqQvpNJYvLm+LY1U59Q= +github.com/aws/aws-sdk-go v1.42.35 h1:N4N9buNs4YlosI9N0+WYrq8cIZwdgv34yRbxzZlTvFs= +github.com/aws/aws-sdk-go v1.42.35/go.mod h1:OGr6lGMAKGlG9CVrYnWYDKIyb829c6EVBRjxqjmPepc= github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f h1:ZNv7On9kyUzm7fvRZumSyy/IUiSC7AzL0I1jKKtwooA= github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f/go.mod h1:AuiFmCCPBSrqvVMvuqFuk0qogytodnVFVSN5CeJB8Gc= github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= @@ -842,6 +844,8 @@ golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qx golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20211216030914-fe4d6282115f h1:hEYJvxw1lSnWIl8X9ofsYMklzaDs90JI2az5YMd4fPM= +golang.org/x/net v0.0.0-20211216030914-fe4d6282115f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= From d4ebed4c09a9f744bef40f5340509ad5b851438e Mon Sep 17 00:00:00 2001 From: yuriy Date: Mon, 17 Jan 2022 23:08:39 +0100 Subject: [PATCH 509/644] Updates from 'go mod tidy' --- go.sum | 4 ---- 1 file changed, 4 deletions(-) diff --git a/go.sum b/go.sum index 60c55b14988e..447f84bbb664 100644 --- a/go.sum +++ b/go.sum @@ -151,8 +151,6 @@ github.com/asaskevich/govalidator v0.0.0-20190424111038-f61b66f89f4a/go.mod h1:l github.com/aws/aws-sdk-go v1.15.78/go.mod h1:E3/ieXAlvM0XWO57iftYVDLLvQ824smPP3ATZkfNZeM= github.com/aws/aws-sdk-go v1.25.3/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo= github.com/aws/aws-sdk-go v1.31.9/go.mod h1:5zCpMtNQVjRREroY7sYe8lOMRSxkhG6MZveU8YkpAk0= -github.com/aws/aws-sdk-go v1.40.25 h1:Depnx7O86HWgOCLD5nMto6F9Ju85Q1QuFDnbpZYQWno= -github.com/aws/aws-sdk-go v1.40.25/go.mod h1:585smgzpB/KqRA+K3y/NL/oYRqQvpNJYvLm+LY1U59Q= github.com/aws/aws-sdk-go v1.42.35 h1:N4N9buNs4YlosI9N0+WYrq8cIZwdgv34yRbxzZlTvFs= github.com/aws/aws-sdk-go v1.42.35/go.mod h1:OGr6lGMAKGlG9CVrYnWYDKIyb829c6EVBRjxqjmPepc= github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f h1:ZNv7On9kyUzm7fvRZumSyy/IUiSC7AzL0I1jKKtwooA= @@ -841,8 +839,6 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210326060303-6b1517762897/go.mod h1:uSPa2vr4CLtc/ILN5odXGNXS6mhrKVzTaCXzk9m6W3k= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/net v0.0.0-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20211216030914-fe4d6282115f h1:hEYJvxw1lSnWIl8X9ofsYMklzaDs90JI2az5YMd4fPM= golang.org/x/net v0.0.0-20211216030914-fe4d6282115f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= From fc4ceedc6d2b5d2a93511e5dadd442c984044745 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:08:33 -0500 Subject: [PATCH 510/644] Remove overview page and update notes on provisioner pages --- .../language/resources/provisioners/chef.mdx | 3 ++- .../resources/provisioners/connection.mdx | 27 ++++++++++--------- .../language/resources/provisioners/file.mdx | 4 +-- .../resources/provisioners/habitat.mdx | 3 ++- .../language/resources/provisioners/index.mdx | 12 --------- .../resources/provisioners/local-exec.mdx | 4 +-- .../resources/provisioners/null_resource.mdx | 4 +++ .../resources/provisioners/puppet.mdx | 3 ++- .../resources/provisioners/remote-exec.mdx | 6 ++--- .../provisioners/salt-masterless.mdx | 3 ++- 10 files changed, 34 insertions(+), 35 deletions(-) delete mode 100644 website/docs/language/resources/provisioners/index.mdx diff --git a/website/docs/language/resources/provisioners/chef.mdx b/website/docs/language/resources/provisioners/chef.mdx index 9ec4887e2cb3..99419c11e966 100644 --- a/website/docs/language/resources/provisioners/chef.mdx +++ b/website/docs/language/resources/provisioners/chef.mdx @@ -11,7 +11,8 @@ The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index eb1ccff5f623..22a4c16a0cb8 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -11,19 +11,10 @@ Most provisioners require access to the remote resource via SSH or WinRM, and expect a nested `connection` block with details about how to connect. -> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. For more information, see -[the main Provisioners page](/language/resources/provisioners). +common situations there are better alternatives. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. --> **Note:** In Terraform 0.11 and earlier, providers could set default values -for some connection settings, so that `connection` blocks could sometimes be -omitted. This feature was removed in 0.12 in order to make Terraform's behavior -more predictable. - --> **Note:** Since the SSH connection type is most often used with -newly-created remote resources, validation of SSH host keys is disabled by -default. In scenarios where this is not acceptable, a separate mechanism for -key distribution could be established and the `host_key` directive documented -below explicitly set to verify against a specific key or signing CA. +## Connection Block Connection blocks don't take a block label, and can be nested within either a `resource` or a `provisioner`. @@ -37,6 +28,18 @@ One use case for providing multiple connections is to have an initial provisioner connect as the `root` user to set up user accounts, and have subsequent provisioners connect as a user with more limited permissions. +Since the SSH connection type is most often used with +newly-created remote resources, validation of SSH host keys is disabled by +default. In scenarios where this is not acceptable, a separate mechanism for +key distribution could be established and the `host_key` directive documented +below explicitly set to verify against a specific key or signing CA. + +-> **Note:** In Terraform 0.11 and earlier, providers could set default values +for some connection settings, so that `connection` blocks could sometimes be +omitted. This feature was removed in 0.12 in order to make Terraform's behavior +more predictable. + + ## Example usage ```hcl diff --git a/website/docs/language/resources/provisioners/file.mdx b/website/docs/language/resources/provisioners/file.mdx index 83dfb7a90a75..255814cd71fc 100644 --- a/website/docs/language/resources/provisioners/file.mdx +++ b/website/docs/language/resources/provisioners/file.mdx @@ -13,8 +13,8 @@ executing Terraform to the newly created resource. The `file` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. For more information, see -[the main Provisioners page](/language/resources/provisioners). +common situations there are better alternatives. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/habitat.mdx b/website/docs/language/resources/provisioners/habitat.mdx index c8ab535d14f1..cdd8f8bf90ef 100644 --- a/website/docs/language/resources/provisioners/habitat.mdx +++ b/website/docs/language/resources/provisioners/habitat.mdx @@ -9,7 +9,8 @@ description: >- The `habitat` provisioner installs the [Habitat](https://habitat.sh) supervisor and loads configured services. This provisioner only supports Linux targets using the `ssh` connection type at this time. -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/index.mdx b/website/docs/language/resources/provisioners/index.mdx deleted file mode 100644 index badd56b09f3f..000000000000 --- a/website/docs/language/resources/provisioners/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -page_title: Provisioners Overview - Configuration Language -description: >- - Provisioners model specific actions on a local or remote machine to prepare - servers or other infrastructure for service. ---- - -# Provisioners - -Provisioners can be used to model specific actions on the local machine or on a -remote machine in order to prepare servers or other infrastructure objects for -service. diff --git a/website/docs/language/resources/provisioners/local-exec.mdx b/website/docs/language/resources/provisioners/local-exec.mdx index 02eec0ef7994..8298cfbe7497 100644 --- a/website/docs/language/resources/provisioners/local-exec.mdx +++ b/website/docs/language/resources/provisioners/local-exec.mdx @@ -19,8 +19,8 @@ run, there is no guarantee that it will be in an operable state - for example system services such as `sshd` may not be started yet on compute resources. -> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. For more information, see -[the main Provisioners page](/language/resources/provisioners). +common situations there are better alternatives. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/null_resource.mdx b/website/docs/language/resources/provisioners/null_resource.mdx index 3e7b3fd65ae6..0ba1294a9b0a 100644 --- a/website/docs/language/resources/provisioners/null_resource.mdx +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -19,6 +19,10 @@ details](/language/resources/provisioners/connection) on a `null_resource`. You use its `triggers` argument and any meta-arguments to control exactly where in the dependency graph its provisioners will run. +-> **Note:** Provisioners should only be used as a last resort. For most +common situations there are better alternatives. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. + ## Example usage ```hcl diff --git a/website/docs/language/resources/provisioners/puppet.mdx b/website/docs/language/resources/provisioners/puppet.mdx index e0894c271f9b..5563a369e701 100644 --- a/website/docs/language/resources/provisioners/puppet.mdx +++ b/website/docs/language/resources/provisioners/puppet.mdx @@ -11,7 +11,8 @@ The `puppet` provisioner installs, configures and runs the Puppet agent on a remote resource. The `puppet` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/remote-exec.mdx b/website/docs/language/resources/provisioners/remote-exec.mdx index 4b4d94274a8f..89ce5c10931c 100644 --- a/website/docs/language/resources/provisioners/remote-exec.mdx +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -18,8 +18,8 @@ provisioner requires a [connection](/language/resources/provisioners/connection) and supports both `ssh` and `winrm`. -> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. For more information, see -[the main Provisioners page](/language/resources/provisioners). +common situations there are better alternatives. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage @@ -27,7 +27,7 @@ common situations there are better alternatives. For more information, see resource "aws_instance" "web" { # ... - # Establishes connection to be used by all + # Establishes connection to be used by all # generic remote provisioners (i.e. file/remote-exec) connection { type = "ssh" diff --git a/website/docs/language/resources/provisioners/salt-masterless.mdx b/website/docs/language/resources/provisioners/salt-masterless.mdx index 70fd17dbe74e..45aade11f9d9 100644 --- a/website/docs/language/resources/provisioners/salt-masterless.mdx +++ b/website/docs/language/resources/provisioners/salt-masterless.mdx @@ -12,7 +12,8 @@ Type: `salt-masterless` The `salt-masterless` Terraform provisioner provisions machines built by Terraform using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/language/resources/provisioners/connection). -!> **Note:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. For more information, see [the main Provisioners page](/language/resources/provisioners). +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +[Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements From bfefb7405eefdbc8f74e82669148eb1379c0ec73 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:09:43 -0500 Subject: [PATCH 511/644] Update layout file to remove deleted page --- website/layouts/language.erb | 4 ---- 1 file changed, 4 deletions(-) diff --git a/website/layouts/language.erb b/website/layouts/language.erb index b2233530f218..ee9d01774650 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -85,10 +85,6 @@
    • Provisioners
        -
      • - Overview -
        • -
      • Declaring Provisioners
        • From 5d24146f1748c198f230ec3411d8c1be2ea70248 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:12:49 -0500 Subject: [PATCH 512/644] Oops edited the wrong layout file --- website/layouts/language.erb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/layouts/language.erb b/website/layouts/language.erb index ee9d01774650..b2233530f218 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -85,6 +85,10 @@
      • Provisioners
          +
        • + Overview +
          • +
        • Declaring Provisioners
          • From 5cb8be0d500f16ac5c4c7c02a0e7a9425b734853 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:13:27 -0500 Subject: [PATCH 513/644] Update nav to remove overview page that no longer exists --- website/data/language-nav-data.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/website/data/language-nav-data.json b/website/data/language-nav-data.json index 24100696c5f9..3efdda76640f 100644 --- a/website/data/language-nav-data.json +++ b/website/data/language-nav-data.json @@ -74,10 +74,6 @@ { "title": "Provisioners", "routes": [ - { - "title": "Overview", - "path": "resources/provisioners" - }, { "title": "Declaring Provisioners", "path": "resources/provisioners/syntax" From 63106da0b9bc9de334a967516b0a896bbaed0aa8 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 11:53:39 -0500 Subject: [PATCH 514/644] Language updates --- .../language/resources/provisioners/chef.mdx | 2 +- .../resources/provisioners/connection.mdx | 135 +++++------------- .../language/resources/provisioners/file.mdx | 3 +- .../resources/provisioners/habitat.mdx | 2 +- .../resources/provisioners/null_resource.mdx | 3 +- .../resources/provisioners/puppet.mdx | 2 +- .../resources/provisioners/remote-exec.mdx | 3 +- .../provisioners/salt-masterless.mdx | 2 +- 8 files changed, 46 insertions(+), 106 deletions(-) diff --git a/website/docs/language/resources/provisioners/chef.mdx b/website/docs/language/resources/provisioners/chef.mdx index 99419c11e966..5683b0f6902b 100644 --- a/website/docs/language/resources/provisioners/chef.mdx +++ b/website/docs/language/resources/provisioners/chef.mdx @@ -11,7 +11,7 @@ The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 22a4c16a0cb8..b958880f29c0 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -7,15 +7,16 @@ description: >- # Provisioner Connection Settings -Most provisioners require access to the remote resource via SSH or WinRM, and +Most provisioners require access to the remote resource via SSH or WinRM and expect a nested `connection` block with details about how to connect. --> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. Refer to +-> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Connection Block +You can create one or more `connection` blocks that describe how to access the remote resource. One use case for providing multiple connections is to have an initial provisioner connect as the `root` user to set up user accounts, and then have subsequent provisioners connect as a user with more limited permissions. + Connection blocks don't take a block label, and can be nested within either a `resource` or a `provisioner`. @@ -24,15 +25,9 @@ Connection blocks don't take a block label, and can be nested within either a * A `connection` block nested in a `provisioner` block only affects that provisioner, and overrides any resource-level connection settings. -One use case for providing multiple connections is to have an initial -provisioner connect as the `root` user to set up user accounts, and have -subsequent provisioners connect as a user with more limited permissions. - Since the SSH connection type is most often used with newly-created remote resources, validation of SSH host keys is disabled by -default. In scenarios where this is not acceptable, a separate mechanism for -key distribution could be established and the `host_key` directive documented -below explicitly set to verify against a specific key or signing CA. +default. If this is not acceptable, you can establish a separate mechanism for key distribution and explicitly set the `host_key` argument (details below) to verify against a specific key or signing CA. -> **Note:** In Terraform 0.11 and earlier, providers could set default values for some connection settings, so that `connection` blocks could sometimes be @@ -40,7 +35,7 @@ omitted. This feature was removed in 0.12 in order to make Terraform's behavior more predictable. -## Example usage +### Example usage ```hcl # Copies the file as the root user using SSH @@ -79,67 +74,29 @@ The `self` object represents the connection's parent resource, and has all of that resource's attributes. For example, use `self.public_ip` to reference an `aws_instance`'s `public_ip` attribute. --> **Technical note:** Resource references are restricted here because -references create dependencies. Referring to a resource by name within its own -block would create a dependency cycle. +Resource references are restricted because references create dependencies. Referring to a resource by name within its own block would create a dependency cycle. ## Argument Reference -**The following arguments are supported by all connection types:** - -* `type` - The connection type that should be used. Valid types are `ssh` and `winrm`. - Defaults to `ssh`. - -* `user` - The user that we should use for the connection. - Defaults to `root` when using type `ssh` and defaults to `Administrator` when using type `winrm`. - -* `password` - The password we should use for the connection. In some cases this is - specified by the provider. - -* `host` - (Required) The address of the resource to connect to. - -* `port` - The port to connect to. - Defaults to `22` when using type `ssh` and defaults to `5985` when using type `winrm`. - -* `timeout` - The timeout to wait for the connection to become available. Should be provided as a string like `30s` or `5m`. - Defaults to 5 minutes. - -* `script_path` - The path used to copy scripts meant for remote execution. - For more information, see - [How Provisioners Execute Remote Scripts](#how-provisioners-execute-remote-scripts) - below. - -**Additional arguments only supported by the `ssh` connection type:** - -* `private_key` - The contents of an SSH key to use for the connection. These can - be loaded from a file on disk using - [the `file` function](/language/functions/file). This takes - preference over the password if provided. - -* `certificate` - The contents of a signed CA Certificate. The certificate argument must be - used in conjunction with a `private_key`. These can - be loaded from a file on disk using the [the `file` function](/language/functions/file). - -* `agent` - Set to `false` to disable using `ssh-agent` to authenticate. On Windows the - only supported SSH authentication agent is - [Pageant](http://the.earth.li/\~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). - -* `agent_identity` - The preferred identity from the ssh agent for authentication. - -* `host_key` - The public key from the remote host or the signing CA, used to - verify the connection. - -* `target_platform` - The target platform to connect to. Valid values are `"windows"` and `"unix"`. Defaults to `"unix"` if not set. - -**Additional arguments only supported by the `winrm` connection type:** - -* `https` - Set to `true` to connect using HTTPS instead of HTTP. - -* `insecure` - Set to `true` to not validate the HTTPS certificate chain. - -* `use_ntlm` - Set to `true` to use NTLM authentication, rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. Further reading for remote connection authentication can be found [here](https://docs.microsoft.com/en-us/windows/win32/winrm/authentication-for-remote-connections?redirectedfrom=MSDN). - -* `cacert` - The CA certificate to validate against. +| Argument Name | Supported By | Description | Default | +|---------------|--------------|-------------|---------| +| `type` | Both | The connection type that should be used. Valid types are `"ssh"` and `"winrm"`. | `"ssh"` | +| `user` | Both | The user to use for the connection. | `root` for type `"ssh"`
          `Administrator` for type `"winrm"` | +| `password` | Both | The password we should use for the connection. | | +| `host` | Both | **Required** - The address of the resource to connect to. | | +| `port` | Both| The port to connect to. | `22` for type `"ssh"`
          `5985` for type `"winrm"` | +| `timeout` | Both | The timeout to wait for the connection to become available. Should be provided as a string like `"30s"` or `"5m"`. | `"5m"` | +| `script_path` | Both | The path used to copy scripts meant for remote execution. For more information, see [How Provisioners Execute Remote Scripts](#how-provisioners-execute-remote-scripts) below. | (see below)) | +| `private_key` | SSH | The contents of an SSH key to use for the connection. These can be loaded from a file on disk using [the `file` function](/language/functions/file). This takes preference over `password` if provided. | | +| `certificate` | SSH | The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `private_key`. These can be loaded from a file on disk using the [the `file` function](/language/functions/file). | | +| `agent` | SSH | Set to `false` to disable using `ssh-agent` to authenticate. On Windows the only supported SSH authentication agent is [Pageant](http://the.earth.li/\~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). | | +| `agent_identity`| SSH | The preferred identity from the ssh agent for authentication. | | +| `host_key` | SSH | The public key from the remote host or the signing CA, used to verify the connection. | | +| `target_platform`| SSH | The target platform to connect to. Valid values are `"windows"` and `"unix"`. If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` | `"unix"` | +| `https`| WinRM | Set to `true` to connect using HTTPS instead of HTTP. | | +| `insecure`| WinRM | Set to `true` to not validate skip validating the HTTPS certificate chain. | | +| `use_ntlm` | WinRM | Set to `true` to use NTLM authentication, rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. For more information, see [Authentication for Remote Connections](https://docs.microsoft.com/en-us/windows/win32/winrm/authentication-for-remote-connections) in the Windows App Development documentation. | | +| `cacert` | WinRM | The CA certificate to validate against. | | Provisioners typically assume that the remote system runs Microsoft Windows when using the `winrm` connection type. Behaviors which would vary based on @@ -150,32 +107,18 @@ Windows-specific behavior when using WinRM, unless otherwise specified. ## Connecting through a Bastion Host with SSH -The `ssh` connection also supports the following fields to facilitate connnections via a -[bastion host](https://en.wikipedia.org/wiki/Bastion_host). - -* `bastion_host` - Setting this enables the bastion Host connection. This host - will be connected to first, and then the `host` connection will be made from there. - -* `bastion_host_key` - The public key from the remote host or the signing CA, - used to verify the host connection. - -* `bastion_port` - The port to use connect to the bastion host. Defaults to the - value of the `port` field. - -* `bastion_user` - The user for the connection to the bastion host. Defaults to - the value of the `user` field. - -* `bastion_password` - The password we should use for the bastion host. - Defaults to the value of the `password` field. - -* `bastion_private_key` - The contents of an SSH key file to use for the bastion - host. These can be loaded from a file on disk using - [the `file` function](/language/functions/file). - Defaults to the value of the `private_key` field. +The `ssh` connection also supports the following arguments to connect +indirectly via a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). -* `bastion_certificate` - The contents of a signed CA Certificate. The certificate argument - must be used in conjunction with a `bastion_private_key`. These can be loaded from - a file on disk using the [the `file` function](/language/functions/file). +| Argument Name | Description | Default | +|---------------|-------------|---------| +| `bastion_host` | Setting this enables the bastion Host connection. The provisioner will connect to `bastion_host` first, and then connect from there to `host`. | | +| `bastion_host_key` | The public key from the remote host or the signing CA, used to verify the host connection. | | +| `bastion_port` | The port to use connect to the bastion host. | The value of the `port` field.| +| `bastion_user`| The user for the connection to the bastion host. | The value of the `user` field. | +| `bastion_password` | The password to use for the bastion host. | The value of the `password` field. | +| `bastion_private_key` | The contents of an SSH key file to use for the bastion host. These can be loaded from a file on disk using [the `file` function](language/functions/file). | The value of the `private_key` field. | +| `bastion_certificate` | The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `bastion_private_key`. These can be loaded from a file on disk using the [the `file` function](/language/functions/file). | ## How Provisioners Execute Remote Scripts @@ -188,7 +131,7 @@ and other context between script statements. However, this approach does have some consequences which can be relevant in some unusual situations, even though this is just an implementation detail -for typical use. +in typical use. Most importantly, there must be a suitable location in the remote filesystem where the provisioner can create the script file. By default, Terraform @@ -219,7 +162,7 @@ As with the default patterns, provisioners will replace the sequence `%RAND%` with randomly-selected decimal digits, to reduce the likelihood of collisions between multiple provisioners running concurrently. -If your target system is running Windows, we recommend uses forward slashes +If your target system is running Windows, we recommend using forward slashes instead of backslashes, despite the typical convention on Windows, because the Terraform language uses backslash as the quoted string escape character. diff --git a/website/docs/language/resources/provisioners/file.mdx b/website/docs/language/resources/provisioners/file.mdx index 255814cd71fc..a73291013ef4 100644 --- a/website/docs/language/resources/provisioners/file.mdx +++ b/website/docs/language/resources/provisioners/file.mdx @@ -12,8 +12,7 @@ The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). --> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. Refer to +-> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/habitat.mdx b/website/docs/language/resources/provisioners/habitat.mdx index cdd8f8bf90ef..abbee1db8289 100644 --- a/website/docs/language/resources/provisioners/habitat.mdx +++ b/website/docs/language/resources/provisioners/habitat.mdx @@ -9,7 +9,7 @@ description: >- The `habitat` provisioner installs the [Habitat](https://habitat.sh) supervisor and loads configured services. This provisioner only supports Linux targets using the `ssh` connection type at this time. -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/null_resource.mdx b/website/docs/language/resources/provisioners/null_resource.mdx index 0ba1294a9b0a..827f435f46da 100644 --- a/website/docs/language/resources/provisioners/null_resource.mdx +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -19,8 +19,7 @@ details](/language/resources/provisioners/connection) on a `null_resource`. You use its `triggers` argument and any meta-arguments to control exactly where in the dependency graph its provisioners will run. --> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. Refer to +-> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/puppet.mdx b/website/docs/language/resources/provisioners/puppet.mdx index 5563a369e701..72d08251636d 100644 --- a/website/docs/language/resources/provisioners/puppet.mdx +++ b/website/docs/language/resources/provisioners/puppet.mdx @@ -11,7 +11,7 @@ The `puppet` provisioner installs, configures and runs the Puppet agent on a remote resource. The `puppet` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/remote-exec.mdx b/website/docs/language/resources/provisioners/remote-exec.mdx index 89ce5c10931c..646b780689b7 100644 --- a/website/docs/language/resources/provisioners/remote-exec.mdx +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -17,8 +17,7 @@ into a cluster, etc. To invoke a local process, see the `local-exec` provisioner requires a [connection](/language/resources/provisioners/connection) and supports both `ssh` and `winrm`. --> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. Refer to +-> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/salt-masterless.mdx b/website/docs/language/resources/provisioners/salt-masterless.mdx index 45aade11f9d9..e3fcf67be854 100644 --- a/website/docs/language/resources/provisioners/salt-masterless.mdx +++ b/website/docs/language/resources/provisioners/salt-masterless.mdx @@ -12,7 +12,7 @@ Type: `salt-masterless` The `salt-masterless` Terraform provisioner provisions machines built by Terraform using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/language/resources/provisioners/connection). -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. For most common situations there are better alternatives to using provisioners. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements From 20e9f30c3d364502ba388a6c10a990917c16db30 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 12:02:04 -0500 Subject: [PATCH 515/644] formatting nits --- .../docs/language/resources/provisioners/connection.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index b958880f29c0..107ff619623a 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -90,11 +90,11 @@ Resource references are restricted because references create dependencies. Refer | `private_key` | SSH | The contents of an SSH key to use for the connection. These can be loaded from a file on disk using [the `file` function](/language/functions/file). This takes preference over `password` if provided. | | | `certificate` | SSH | The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `private_key`. These can be loaded from a file on disk using the [the `file` function](/language/functions/file). | | | `agent` | SSH | Set to `false` to disable using `ssh-agent` to authenticate. On Windows the only supported SSH authentication agent is [Pageant](http://the.earth.li/\~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). | | -| `agent_identity`| SSH | The preferred identity from the ssh agent for authentication. | | +| `agent_identity` | SSH | The preferred identity from the ssh agent for authentication. | | | `host_key` | SSH | The public key from the remote host or the signing CA, used to verify the connection. | | -| `target_platform`| SSH | The target platform to connect to. Valid values are `"windows"` and `"unix"`. If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` | `"unix"` | -| `https`| WinRM | Set to `true` to connect using HTTPS instead of HTTP. | | -| `insecure`| WinRM | Set to `true` to not validate skip validating the HTTPS certificate chain. | | +| `target_platform` | SSH | The target platform to connect to. Valid values are `"windows"` and `"unix"`. If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` | `"unix"` | +| `https` | WinRM | Set to `true` to connect using HTTPS instead of HTTP. | | +| `insecure` | WinRM | Set to `true` to not validate skip validating the HTTPS certificate chain. | | | `use_ntlm` | WinRM | Set to `true` to use NTLM authentication, rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. For more information, see [Authentication for Remote Connections](https://docs.microsoft.com/en-us/windows/win32/winrm/authentication-for-remote-connections) in the Windows App Development documentation. | | | `cacert` | WinRM | The CA certificate to validate against. | | From ec17cbaeee44730c23f88c92138b0f1bbf5608da Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 5 Jan 2022 12:10:01 -0500 Subject: [PATCH 516/644] update additional references to overview page --- website/docs/language/resources/index.mdx | 2 +- website/docs/language/resources/syntax.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/language/resources/index.mdx b/website/docs/language/resources/index.mdx index 08921cf7569a..79df607b1f51 100644 --- a/website/docs/language/resources/index.mdx +++ b/website/docs/language/resources/index.mdx @@ -29,7 +29,7 @@ as DNS records. [`provider`](/language/meta-arguments/resource-provider), and [`lifecycle`](/language/meta-arguments/lifecycle). -- [Provisioners](/language/resources/provisioners) +- [Provisioners](/language/resources/provisioners/syntax) documents configuring post-creation actions for a resource using the `provisioner` and `connection` blocks. Since provisioners are non-declarative and potentially unpredictable, we strongly recommend that you treat them as a diff --git a/website/docs/language/resources/syntax.mdx b/website/docs/language/resources/syntax.mdx index 259981bfb627..485609ca8fb5 100644 --- a/website/docs/language/resources/syntax.mdx +++ b/website/docs/language/resources/syntax.mdx @@ -129,7 +129,7 @@ The following meta-arguments are documented on separate pages: - [`for_each`, to create multiple instances according to a map, or set of strings](/language/meta-arguments/for_each) - [`provider`, for selecting a non-default provider configuration](/language/meta-arguments/resource-provider) - [`lifecycle`, for lifecycle customizations](/language/meta-arguments/lifecycle) -- [`provisioner` and `connection`, for taking extra actions after resource creation](/language/resources/provisioners) +- [`provisioner`, for taking extra actions after resource creation](/language/resources/provisioners/syntax) ## Operation Timeouts From 13907690a25c735e53167d97e8687409987ca49f Mon Sep 17 00:00:00 2001 From: GiannakopoulosJ Date: Wed, 19 Jan 2022 16:02:24 +0200 Subject: [PATCH 517/644] Typo in zipmap documentation zipmap does not produce a map with comma in terraform cli tested with Terraform v1.1.3 --- website/docs/language/functions/zipmap.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/language/functions/zipmap.mdx b/website/docs/language/functions/zipmap.mdx index c813e3e49175..277543e3abfa 100644 --- a/website/docs/language/functions/zipmap.mdx +++ b/website/docs/language/functions/zipmap.mdx @@ -27,7 +27,7 @@ is used in the resulting map. ``` > zipmap(["a", "b"], [1, 2]) { - "a" = 1, - "b" = 2, + "a" = 1 + "b" = 2 } ``` From a477d10bd10390dd5de3a231b760ccab3ded229b Mon Sep 17 00:00:00 2001 From: Brian Flad Date: Thu, 20 Jan 2022 09:57:42 -0500 Subject: [PATCH 518/644] Introduce Terraform Plugin Protocol 6.2 with legacy_type_system fields from Protocol 5 (#30375) Reference: https://github.com/hashicorp/terraform/issues/30373 This change forward ports the `legacy_type_system` boolean fields in the `ApplyResourceChange.Response` and `PlanResourceChange.Response` messages that existed in protocol version 5, so that existing terraform-plugin-sdk/v2 providers can be muxed with protocol version 6 providers (e.g. terraform-plugin-framework) while also taking advantage of the newer protocol features. This functionality should not be used by any providers or SDKs except those built with terraform-plugin-sdk. Updated via: ```shell cp docs/plugin-protocol/tfplugin6.1.proto docs/plugin-protocol/tfplugin6.2.proto # Copy legacy_type_system fields from tfplugin5.2.proto into ApplyResourceChange.Response and PlanResourceChange rm internal/tfplugin6/tfplugin6.proto ln -s ../../docs/plugin-protocol/tfplugin6.2.proto internal/tfplugin6/tfplugin6.proto go run tools/protobuf-compile/protobuf-compile.go `pwd` # Updates to internal/plugin6/grpc_provider.go ``` --- docs/plugin-protocol/tfplugin6.2.proto | 350 ++++++++++++++++++++++++ internal/plugin6/grpc_provider.go | 4 + internal/tfplugin6/tfplugin6.pb.go | 352 ++++++++++++++----------- internal/tfplugin6/tfplugin6.proto | 2 +- 4 files changed, 553 insertions(+), 155 deletions(-) create mode 100644 docs/plugin-protocol/tfplugin6.2.proto diff --git a/docs/plugin-protocol/tfplugin6.2.proto b/docs/plugin-protocol/tfplugin6.2.proto new file mode 100644 index 000000000000..da5e58eafe6d --- /dev/null +++ b/docs/plugin-protocol/tfplugin6.2.proto @@ -0,0 +1,350 @@ +// Terraform Plugin RPC protocol version 6.2 +// +// This file defines version 6.2 of the RPC protocol. To implement a plugin +// against this protocol, copy this definition into your own codebase and +// use protoc to generate stubs for your target language. +// +// This file will not be updated. Any minor versions of protocol 6 to follow +// should copy this file and modify the copy while maintaing backwards +// compatibility. Breaking changes, if any are required, will come +// in a subsequent major version with its own separate proto definition. +// +// Note that only the proto files included in a release tag of Terraform are +// official protocol releases. Proto files taken from other commits may include +// incomplete changes or features that did not make it into a final release. +// In all reasonable cases, plugin developers should take the proto file from +// the tag of the most recent release of Terraform, and not from the main +// branch or any other development branch. +// +syntax = "proto3"; +option go_package = "github.com/hashicorp/terraform/internal/tfplugin6"; + +package tfplugin6; + +// DynamicValue is an opaque encoding of terraform data, with the field name +// indicating the encoding scheme used. +message DynamicValue { + bytes msgpack = 1; + bytes json = 2; +} + +message Diagnostic { + enum Severity { + INVALID = 0; + ERROR = 1; + WARNING = 2; + } + Severity severity = 1; + string summary = 2; + string detail = 3; + AttributePath attribute = 4; +} + +message AttributePath { + message Step { + oneof selector { + // Set "attribute_name" to represent looking up an attribute + // in the current object value. + string attribute_name = 1; + // Set "element_key_*" to represent looking up an element in + // an indexable collection type. + string element_key_string = 2; + int64 element_key_int = 3; + } + } + repeated Step steps = 1; +} + +message StopProvider { + message Request { + } + message Response { + string Error = 1; + } +} + +// RawState holds the stored state for a resource to be upgraded by the +// provider. It can be in one of two formats, the current json encoded format +// in bytes, or the legacy flatmap format as a map of strings. +message RawState { + bytes json = 1; + map flatmap = 2; +} + +enum StringKind { + PLAIN = 0; + MARKDOWN = 1; +} + +// Schema is the configuration schema for a Resource or Provider. +message Schema { + message Block { + int64 version = 1; + repeated Attribute attributes = 2; + repeated NestedBlock block_types = 3; + string description = 4; + StringKind description_kind = 5; + bool deprecated = 6; + } + + message Attribute { + string name = 1; + bytes type = 2; + Object nested_type = 10; + string description = 3; + bool required = 4; + bool optional = 5; + bool computed = 6; + bool sensitive = 7; + StringKind description_kind = 8; + bool deprecated = 9; + } + + message NestedBlock { + enum NestingMode { + INVALID = 0; + SINGLE = 1; + LIST = 2; + SET = 3; + MAP = 4; + GROUP = 5; + } + + string type_name = 1; + Block block = 2; + NestingMode nesting = 3; + int64 min_items = 4; + int64 max_items = 5; + } + + message Object { + enum NestingMode { + INVALID = 0; + SINGLE = 1; + LIST = 2; + SET = 3; + MAP = 4; + } + + repeated Attribute attributes = 1; + NestingMode nesting = 3; + + // MinItems and MaxItems were never used in the protocol, and have no + // effect on validation. + int64 min_items = 4 [deprecated = true]; + int64 max_items = 5 [deprecated = true]; + } + + // The version of the schema. + // Schemas are versioned, so that providers can upgrade a saved resource + // state when the schema is changed. + int64 version = 1; + + // Block is the top level configuration block for this schema. + Block block = 2; +} + +service Provider { + //////// Information about what a provider supports/expects + rpc GetProviderSchema(GetProviderSchema.Request) returns (GetProviderSchema.Response); + rpc ValidateProviderConfig(ValidateProviderConfig.Request) returns (ValidateProviderConfig.Response); + rpc ValidateResourceConfig(ValidateResourceConfig.Request) returns (ValidateResourceConfig.Response); + rpc ValidateDataResourceConfig(ValidateDataResourceConfig.Request) returns (ValidateDataResourceConfig.Response); + rpc UpgradeResourceState(UpgradeResourceState.Request) returns (UpgradeResourceState.Response); + + //////// One-time initialization, called before other functions below + rpc ConfigureProvider(ConfigureProvider.Request) returns (ConfigureProvider.Response); + + //////// Managed Resource Lifecycle + rpc ReadResource(ReadResource.Request) returns (ReadResource.Response); + rpc PlanResourceChange(PlanResourceChange.Request) returns (PlanResourceChange.Response); + rpc ApplyResourceChange(ApplyResourceChange.Request) returns (ApplyResourceChange.Response); + rpc ImportResourceState(ImportResourceState.Request) returns (ImportResourceState.Response); + + rpc ReadDataSource(ReadDataSource.Request) returns (ReadDataSource.Response); + + //////// Graceful Shutdown + rpc StopProvider(StopProvider.Request) returns (StopProvider.Response); +} + +message GetProviderSchema { + message Request { + } + message Response { + Schema provider = 1; + map resource_schemas = 2; + map data_source_schemas = 3; + repeated Diagnostic diagnostics = 4; + Schema provider_meta = 5; + } +} + +message ValidateProviderConfig { + message Request { + DynamicValue config = 1; + } + message Response { + repeated Diagnostic diagnostics = 2; + } +} + +message UpgradeResourceState { + message Request { + string type_name = 1; + + // version is the schema_version number recorded in the state file + int64 version = 2; + + // raw_state is the raw states as stored for the resource. Core does + // not have access to the schema of prior_version, so it's the + // provider's responsibility to interpret this value using the + // appropriate older schema. The raw_state will be the json encoded + // state, or a legacy flat-mapped format. + RawState raw_state = 3; + } + message Response { + // new_state is a msgpack-encoded data structure that, when interpreted with + // the _current_ schema for this resource type, is functionally equivalent to + // that which was given in prior_state_raw. + DynamicValue upgraded_state = 1; + + // diagnostics describes any errors encountered during migration that could not + // be safely resolved, and warnings about any possibly-risky assumptions made + // in the upgrade process. + repeated Diagnostic diagnostics = 2; + } +} + +message ValidateResourceConfig { + message Request { + string type_name = 1; + DynamicValue config = 2; + } + message Response { + repeated Diagnostic diagnostics = 1; + } +} + +message ValidateDataResourceConfig { + message Request { + string type_name = 1; + DynamicValue config = 2; + } + message Response { + repeated Diagnostic diagnostics = 1; + } +} + +message ConfigureProvider { + message Request { + string terraform_version = 1; + DynamicValue config = 2; + } + message Response { + repeated Diagnostic diagnostics = 1; + } +} + +message ReadResource { + message Request { + string type_name = 1; + DynamicValue current_state = 2; + bytes private = 3; + DynamicValue provider_meta = 4; + } + message Response { + DynamicValue new_state = 1; + repeated Diagnostic diagnostics = 2; + bytes private = 3; + } +} + +message PlanResourceChange { + message Request { + string type_name = 1; + DynamicValue prior_state = 2; + DynamicValue proposed_new_state = 3; + DynamicValue config = 4; + bytes prior_private = 5; + DynamicValue provider_meta = 6; + } + + message Response { + DynamicValue planned_state = 1; + repeated AttributePath requires_replace = 2; + bytes planned_private = 3; + repeated Diagnostic diagnostics = 4; + + // This may be set only by the helper/schema "SDK" in the main Terraform + // repository, to request that Terraform Core >=0.12 permit additional + // inconsistencies that can result from the legacy SDK type system + // and its imprecise mapping to the >=0.12 type system. + // The change in behavior implied by this flag makes sense only for the + // specific details of the legacy SDK type system, and are not a general + // mechanism to avoid proper type handling in providers. + // + // ==== DO NOT USE THIS ==== + // ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== + // ==== DO NOT USE THIS ==== + bool legacy_type_system = 5; + } +} + +message ApplyResourceChange { + message Request { + string type_name = 1; + DynamicValue prior_state = 2; + DynamicValue planned_state = 3; + DynamicValue config = 4; + bytes planned_private = 5; + DynamicValue provider_meta = 6; + } + message Response { + DynamicValue new_state = 1; + bytes private = 2; + repeated Diagnostic diagnostics = 3; + + // This may be set only by the helper/schema "SDK" in the main Terraform + // repository, to request that Terraform Core >=0.12 permit additional + // inconsistencies that can result from the legacy SDK type system + // and its imprecise mapping to the >=0.12 type system. + // The change in behavior implied by this flag makes sense only for the + // specific details of the legacy SDK type system, and are not a general + // mechanism to avoid proper type handling in providers. + // + // ==== DO NOT USE THIS ==== + // ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== + // ==== DO NOT USE THIS ==== + bool legacy_type_system = 4; + } +} + +message ImportResourceState { + message Request { + string type_name = 1; + string id = 2; + } + + message ImportedResource { + string type_name = 1; + DynamicValue state = 2; + bytes private = 3; + } + + message Response { + repeated ImportedResource imported_resources = 1; + repeated Diagnostic diagnostics = 2; + } +} + +message ReadDataSource { + message Request { + string type_name = 1; + DynamicValue config = 2; + DynamicValue provider_meta = 3; + } + message Response { + DynamicValue state = 1; + repeated Diagnostic diagnostics = 2; + } +} diff --git a/internal/plugin6/grpc_provider.go b/internal/plugin6/grpc_provider.go index 3897a17fe2e1..8e0fde0d0d07 100644 --- a/internal/plugin6/grpc_provider.go +++ b/internal/plugin6/grpc_provider.go @@ -436,6 +436,8 @@ func (p *GRPCProvider) PlanResourceChange(r providers.PlanResourceChangeRequest) resp.PlannedPrivate = protoResp.PlannedPrivate + resp.LegacyTypeSystem = protoResp.LegacyTypeSystem + return resp } @@ -494,6 +496,8 @@ func (p *GRPCProvider) ApplyResourceChange(r providers.ApplyResourceChangeReques } resp.NewState = state + resp.LegacyTypeSystem = protoResp.LegacyTypeSystem + return resp } diff --git a/internal/tfplugin6/tfplugin6.pb.go b/internal/tfplugin6/tfplugin6.pb.go index aa0447b09b9e..6e87b98b2668 100644 --- a/internal/tfplugin6/tfplugin6.pb.go +++ b/internal/tfplugin6/tfplugin6.pb.go @@ -1,6 +1,6 @@ -// Terraform Plugin RPC protocol version 6.1 +// Terraform Plugin RPC protocol version 6.2 // -// This file defines version 6.1 of the RPC protocol. To implement a plugin +// This file defines version 6.2 of the RPC protocol. To implement a plugin // against this protocol, copy this definition into your own codebase and // use protoc to generate stubs for your target language. // @@ -2423,6 +2423,18 @@ type PlanResourceChange_Response struct { RequiresReplace []*AttributePath `protobuf:"bytes,2,rep,name=requires_replace,json=requiresReplace,proto3" json:"requires_replace,omitempty"` PlannedPrivate []byte `protobuf:"bytes,3,opt,name=planned_private,json=plannedPrivate,proto3" json:"planned_private,omitempty"` Diagnostics []*Diagnostic `protobuf:"bytes,4,rep,name=diagnostics,proto3" json:"diagnostics,omitempty"` + // This may be set only by the helper/schema "SDK" in the main Terraform + // repository, to request that Terraform Core >=0.12 permit additional + // inconsistencies that can result from the legacy SDK type system + // and its imprecise mapping to the >=0.12 type system. + // The change in behavior implied by this flag makes sense only for the + // specific details of the legacy SDK type system, and are not a general + // mechanism to avoid proper type handling in providers. + // + // ==== DO NOT USE THIS ==== + // ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== + // ==== DO NOT USE THIS ==== + LegacyTypeSystem bool `protobuf:"varint,5,opt,name=legacy_type_system,json=legacyTypeSystem,proto3" json:"legacy_type_system,omitempty"` } func (x *PlanResourceChange_Response) Reset() { @@ -2485,6 +2497,13 @@ func (x *PlanResourceChange_Response) GetDiagnostics() []*Diagnostic { return nil } +func (x *PlanResourceChange_Response) GetLegacyTypeSystem() bool { + if x != nil { + return x.LegacyTypeSystem + } + return false +} + type ApplyResourceChange_Request struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -2580,6 +2599,18 @@ type ApplyResourceChange_Response struct { NewState *DynamicValue `protobuf:"bytes,1,opt,name=new_state,json=newState,proto3" json:"new_state,omitempty"` Private []byte `protobuf:"bytes,2,opt,name=private,proto3" json:"private,omitempty"` Diagnostics []*Diagnostic `protobuf:"bytes,3,rep,name=diagnostics,proto3" json:"diagnostics,omitempty"` + // This may be set only by the helper/schema "SDK" in the main Terraform + // repository, to request that Terraform Core >=0.12 permit additional + // inconsistencies that can result from the legacy SDK type system + // and its imprecise mapping to the >=0.12 type system. + // The change in behavior implied by this flag makes sense only for the + // specific details of the legacy SDK type system, and are not a general + // mechanism to avoid proper type handling in providers. + // + // ==== DO NOT USE THIS ==== + // ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== + // ==== DO NOT USE THIS ==== + LegacyTypeSystem bool `protobuf:"varint,4,opt,name=legacy_type_system,json=legacyTypeSystem,proto3" json:"legacy_type_system,omitempty"` } func (x *ApplyResourceChange_Response) Reset() { @@ -2635,6 +2666,13 @@ func (x *ApplyResourceChange_Response) GetDiagnostics() []*Diagnostic { return nil } +func (x *ApplyResourceChange_Response) GetLegacyTypeSystem() bool { + if x != nil { + return x.LegacyTypeSystem + } + return false +} + type ImportResourceState_Request struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -3180,7 +3218,7 @@ var file_tfplugin6_proto_rawDesc = []byte{ 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x22, - 0xc4, 0x04, 0x0a, 0x12, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0xf2, 0x04, 0x0a, 0x12, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xbb, 0x02, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, @@ -3201,7 +3239,7 @@ var file_tfplugin6_proto_rawDesc = []byte{ 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, - 0x4d, 0x65, 0x74, 0x61, 0x1a, 0xef, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, + 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x9d, 0x02, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, @@ -3216,161 +3254,167 @@ var file_tfplugin6_proto_rawDesc = []byte{ 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x04, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, - 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xe4, 0x03, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xb6, - 0x02, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, - 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, - 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x38, 0x0a, 0x0b, 0x70, 0x72, 0x69, 0x6f, 0x72, - 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, - 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0a, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x53, 0x74, 0x61, 0x74, - 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, - 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, - 0x65, 0x52, 0x0c, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, - 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32, - 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, - 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, - 0x12, 0x27, 0x0a, 0x0f, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x70, 0x72, 0x69, 0x76, - 0x61, 0x74, 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x6e, - 0x65, 0x64, 0x50, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, - 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, - 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, - 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, - 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x93, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, - 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x34, 0x0a, 0x09, 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, - 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, - 0x52, 0x08, 0x6e, 0x65, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, - 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, - 0x76, 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, - 0x69, 0x63, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, - 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0xed, 0x02, - 0x0a, 0x13, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x53, 0x74, 0x61, 0x74, 0x65, 0x1a, 0x36, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, - 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, - 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x0e, 0x0a, - 0x02, 0x69, 0x64, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x69, 0x64, 0x1a, 0x78, 0x0a, - 0x10, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, - 0x65, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, - 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2d, - 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, + 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x12, 0x2c, 0x0a, 0x12, 0x6c, 0x65, 0x67, 0x61, 0x63, 0x79, + 0x5f, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x73, 0x79, 0x73, 0x74, 0x65, 0x6d, 0x18, 0x05, 0x20, 0x01, + 0x28, 0x08, 0x52, 0x10, 0x6c, 0x65, 0x67, 0x61, 0x63, 0x79, 0x54, 0x79, 0x70, 0x65, 0x53, 0x79, + 0x73, 0x74, 0x65, 0x6d, 0x22, 0x92, 0x04, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, + 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x1a, 0xb6, 0x02, 0x0a, + 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, + 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, + 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x38, 0x0a, 0x0b, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x5f, 0x73, + 0x74, 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, + 0x6c, 0x75, 0x65, 0x52, 0x0a, 0x70, 0x72, 0x69, 0x6f, 0x72, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, + 0x3c, 0x0a, 0x0d, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, + 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, + 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, + 0x0c, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x2f, 0x0a, + 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, 0x04, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, - 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, - 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, - 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x1a, 0xa3, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, - 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x5e, 0x0a, 0x12, 0x69, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, - 0x5f, 0x72, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, - 0x32, 0x2f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, - 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, - 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, - 0x65, 0x52, 0x11, 0x69, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, - 0x72, 0x63, 0x65, 0x73, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, - 0x69, 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, - 0x52, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0x9c, 0x02, - 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x1a, 0x95, 0x01, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, + 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x27, + 0x0a, 0x0f, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, 0x5f, 0x70, 0x72, 0x69, 0x76, 0x61, 0x74, + 0x65, 0x18, 0x05, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x0e, 0x70, 0x6c, 0x61, 0x6e, 0x6e, 0x65, 0x64, + 0x50, 0x72, 0x69, 0x76, 0x61, 0x74, 0x65, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, + 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, + 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, + 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0xc1, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, + 0x73, 0x65, 0x12, 0x34, 0x0a, 0x09, 0x6e, 0x65, 0x77, 0x5f, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, + 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x08, + 0x6e, 0x65, 0x77, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, 0x76, + 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, 0x61, + 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, + 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, + 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x12, 0x2c, 0x0a, 0x12, 0x6c, + 0x65, 0x67, 0x61, 0x63, 0x79, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x73, 0x79, 0x73, 0x74, 0x65, + 0x6d, 0x18, 0x04, 0x20, 0x01, 0x28, 0x08, 0x52, 0x10, 0x6c, 0x65, 0x67, 0x61, 0x63, 0x79, 0x54, + 0x79, 0x70, 0x65, 0x53, 0x79, 0x73, 0x74, 0x65, 0x6d, 0x22, 0xed, 0x02, 0x0a, 0x13, 0x49, 0x6d, + 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, + 0x65, 0x1a, 0x36, 0x0a, 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, - 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, - 0x66, 0x69, 0x67, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x0e, 0x0a, 0x02, 0x69, 0x64, 0x18, + 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x69, 0x64, 0x1a, 0x78, 0x0a, 0x10, 0x49, 0x6d, 0x70, + 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x1b, 0x0a, + 0x09, 0x74, 0x79, 0x70, 0x65, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, + 0x52, 0x08, 0x74, 0x79, 0x70, 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2d, 0x0a, 0x05, 0x73, 0x74, + 0x61, 0x74, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, - 0x75, 0x65, 0x52, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, - 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x03, 0x20, 0x01, 0x28, - 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, - 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, - 0x69, 0x64, 0x65, 0x72, 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x72, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, - 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x2d, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, - 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, - 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, - 0x61, 0x74, 0x65, 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, - 0x63, 0x73, 0x18, 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, - 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x2a, 0x25, 0x0a, 0x0a, - 0x53, 0x74, 0x72, 0x69, 0x6e, 0x67, 0x4b, 0x69, 0x6e, 0x64, 0x12, 0x09, 0x0a, 0x05, 0x50, 0x4c, - 0x41, 0x49, 0x4e, 0x10, 0x00, 0x12, 0x0c, 0x0a, 0x08, 0x4d, 0x41, 0x52, 0x4b, 0x44, 0x4f, 0x57, - 0x4e, 0x10, 0x01, 0x32, 0xcc, 0x09, 0x0a, 0x08, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, - 0x12, 0x60, 0x0a, 0x11, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, - 0x63, 0x68, 0x65, 0x6d, 0x61, 0x12, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, - 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, - 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, - 0x73, 0x65, 0x12, 0x6f, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, - 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, 0x74, - 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, - 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, - 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, - 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, - 0x6e, 0x73, 0x65, 0x12, 0x6f, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, - 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, + 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x70, 0x72, 0x69, + 0x76, 0x61, 0x74, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0c, 0x52, 0x07, 0x70, 0x72, 0x69, 0x76, + 0x61, 0x74, 0x65, 0x1a, 0xa3, 0x01, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x12, 0x5e, 0x0a, 0x12, 0x69, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x5f, 0x72, 0x65, 0x73, + 0x6f, 0x75, 0x72, 0x63, 0x65, 0x73, 0x18, 0x01, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x2f, 0x2e, 0x74, + 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, + 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x49, 0x6d, 0x70, + 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x52, 0x11, 0x69, + 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x73, + 0x12, 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, + 0x02, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, + 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x22, 0x9c, 0x02, 0x0a, 0x0e, 0x52, 0x65, + 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x1a, 0x95, 0x01, 0x0a, + 0x07, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x79, 0x70, 0x65, + 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x79, 0x70, + 0x65, 0x4e, 0x61, 0x6d, 0x65, 0x12, 0x2f, 0x0a, 0x06, 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x18, + 0x02, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x06, + 0x63, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x3c, 0x0a, 0x0d, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, + 0x65, 0x72, 0x5f, 0x6d, 0x65, 0x74, 0x61, 0x18, 0x03, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x17, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, 0x6d, 0x69, + 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x0c, 0x70, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, + 0x4d, 0x65, 0x74, 0x61, 0x1a, 0x72, 0x0a, 0x08, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x12, 0x2d, 0x0a, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x0b, 0x32, + 0x17, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x44, 0x79, 0x6e, 0x61, + 0x6d, 0x69, 0x63, 0x56, 0x61, 0x6c, 0x75, 0x65, 0x52, 0x05, 0x73, 0x74, 0x61, 0x74, 0x65, 0x12, + 0x37, 0x0a, 0x0b, 0x64, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x18, 0x02, + 0x20, 0x03, 0x28, 0x0b, 0x32, 0x15, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x44, 0x69, 0x61, 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x52, 0x0b, 0x64, 0x69, 0x61, + 0x67, 0x6e, 0x6f, 0x73, 0x74, 0x69, 0x63, 0x73, 0x2a, 0x25, 0x0a, 0x0a, 0x53, 0x74, 0x72, 0x69, + 0x6e, 0x67, 0x4b, 0x69, 0x6e, 0x64, 0x12, 0x09, 0x0a, 0x05, 0x50, 0x4c, 0x41, 0x49, 0x4e, 0x10, + 0x00, 0x12, 0x0c, 0x0a, 0x08, 0x4d, 0x41, 0x52, 0x4b, 0x44, 0x4f, 0x57, 0x4e, 0x10, 0x01, 0x32, + 0xcc, 0x09, 0x0a, 0x08, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x60, 0x0a, 0x11, + 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, + 0x61, 0x12, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, + 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x2e, 0x47, 0x65, 0x74, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x53, + 0x63, 0x68, 0x65, 0x6d, 0x61, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x6f, + 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, + 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, + 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, + 0x76, 0x69, 0x64, 0x65, 0x72, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, + 0x65, 0x73, 0x74, 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, + 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, + 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, + 0x6f, 0x0a, 0x16, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x29, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, + 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, + 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x12, 0x7b, 0x0a, 0x1a, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, + 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x2d, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, + 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, + 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, - 0x74, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, - 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x2a, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, - 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, - 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x7b, 0x0a, 0x1a, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, - 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, - 0x69, 0x67, 0x12, 0x2d, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, - 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, - 0x72, 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, - 0x74, 0x1a, 0x2e, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x56, 0x61, - 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, - 0x63, 0x65, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, - 0x65, 0x12, 0x69, 0x0a, 0x14, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, - 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, - 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, - 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, - 0x73, 0x74, 0x1a, 0x28, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, - 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, - 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x60, 0x0a, 0x11, + 0x74, 0x65, 0x44, 0x61, 0x74, 0x61, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x6f, + 0x6e, 0x66, 0x69, 0x67, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x69, 0x0a, + 0x14, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, + 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, + 0x36, 0x2e, 0x55, 0x70, 0x67, 0x72, 0x61, 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, + 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x28, + 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x55, 0x70, 0x67, 0x72, 0x61, + 0x64, 0x65, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, + 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x60, 0x0a, 0x11, 0x43, 0x6f, 0x6e, 0x66, + 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x24, 0x2e, + 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, + 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x71, 0x75, + 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, - 0x72, 0x12, 0x24, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, - 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, - 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x75, 0x72, 0x65, 0x50, 0x72, 0x6f, - 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x51, - 0x0a, 0x0c, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x1f, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x52, - 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, - 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, - 0x65, 0x12, 0x63, 0x0a, 0x12, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, - 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, - 0x69, 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, - 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x52, - 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, - 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, - 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, - 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, - 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, - 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, - 0x0a, 0x13, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x53, 0x74, 0x61, 0x74, 0x65, 0x12, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, - 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, - 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, - 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, - 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, - 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x57, 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, - 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x21, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, - 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, - 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x22, 0x2e, 0x74, 0x66, - 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, - 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, - 0x51, 0x0a, 0x0c, 0x53, 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, - 0x1f, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, 0x70, - 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, - 0x1a, 0x20, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, - 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, - 0x73, 0x65, 0x42, 0x33, 0x5a, 0x31, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, - 0x2f, 0x68, 0x61, 0x73, 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, - 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x74, 0x66, - 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x51, 0x0a, 0x0c, 0x52, 0x65, + 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x12, 0x1f, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x20, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x52, 0x65, 0x73, 0x6f, + 0x75, 0x72, 0x63, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x63, 0x0a, + 0x12, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, + 0x6e, 0x67, 0x65, 0x12, 0x25, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, + 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, + 0x67, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x26, 0x2e, 0x74, 0x66, 0x70, + 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x50, 0x6c, 0x61, 0x6e, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, + 0x73, 0x65, 0x12, 0x66, 0x0a, 0x13, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x12, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x41, 0x70, 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, + 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, + 0x74, 0x1a, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x41, 0x70, + 0x70, 0x6c, 0x79, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x43, 0x68, 0x61, 0x6e, 0x67, + 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x66, 0x0a, 0x13, 0x49, 0x6d, + 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, + 0x65, 0x12, 0x26, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, + 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, + 0x65, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x27, 0x2e, 0x74, 0x66, 0x70, 0x6c, + 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x49, 0x6d, 0x70, 0x6f, 0x72, 0x74, 0x52, 0x65, 0x73, 0x6f, + 0x75, 0x72, 0x63, 0x65, 0x53, 0x74, 0x61, 0x74, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, + 0x73, 0x65, 0x12, 0x57, 0x0a, 0x0e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, + 0x75, 0x72, 0x63, 0x65, 0x12, 0x21, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, + 0x2e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, 0x63, 0x65, 0x2e, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x22, 0x2e, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x2e, 0x52, 0x65, 0x61, 0x64, 0x44, 0x61, 0x74, 0x61, 0x53, 0x6f, 0x75, 0x72, + 0x63, 0x65, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x51, 0x0a, 0x0c, 0x53, + 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, 0x76, 0x69, 0x64, 0x65, 0x72, 0x12, 0x1f, 0x2e, 0x74, 0x66, + 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, 0x76, + 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x20, 0x2e, 0x74, + 0x66, 0x70, 0x6c, 0x75, 0x67, 0x69, 0x6e, 0x36, 0x2e, 0x53, 0x74, 0x6f, 0x70, 0x50, 0x72, 0x6f, + 0x76, 0x69, 0x64, 0x65, 0x72, 0x2e, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x42, 0x33, + 0x5a, 0x31, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x68, 0x61, 0x73, + 0x68, 0x69, 0x63, 0x6f, 0x72, 0x70, 0x2f, 0x74, 0x65, 0x72, 0x72, 0x61, 0x66, 0x6f, 0x72, 0x6d, + 0x2f, 0x69, 0x6e, 0x74, 0x65, 0x72, 0x6e, 0x61, 0x6c, 0x2f, 0x74, 0x66, 0x70, 0x6c, 0x75, 0x67, + 0x69, 0x6e, 0x36, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( diff --git a/internal/tfplugin6/tfplugin6.proto b/internal/tfplugin6/tfplugin6.proto index 70bb64b942f0..6841b7f8f178 120000 --- a/internal/tfplugin6/tfplugin6.proto +++ b/internal/tfplugin6/tfplugin6.proto @@ -1 +1 @@ -../../docs/plugin-protocol/tfplugin6.1.proto \ No newline at end of file +../../docs/plugin-protocol/tfplugin6.2.proto \ No newline at end of file From 29a4591cf2042b4718cfb29f97c2d0d735ae6117 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 20 Jan 2022 10:57:38 -0500 Subject: [PATCH 519/644] Fix warning notes --- website/docs/language/resources/provisioners/chef.mdx | 2 +- website/docs/language/resources/provisioners/connection.mdx | 2 +- website/docs/language/resources/provisioners/file.mdx | 2 +- website/docs/language/resources/provisioners/habitat.mdx | 2 +- website/docs/language/resources/provisioners/local-exec.mdx | 3 +-- website/docs/language/resources/provisioners/null_resource.mdx | 2 +- website/docs/language/resources/provisioners/puppet.mdx | 2 +- website/docs/language/resources/provisioners/remote-exec.mdx | 2 +- .../docs/language/resources/provisioners/salt-masterless.mdx | 2 +- 9 files changed, 9 insertions(+), 10 deletions(-) diff --git a/website/docs/language/resources/provisioners/chef.mdx b/website/docs/language/resources/provisioners/chef.mdx index 5683b0f6902b..cf1a2b2a5a8a 100644 --- a/website/docs/language/resources/provisioners/chef.mdx +++ b/website/docs/language/resources/provisioners/chef.mdx @@ -11,7 +11,7 @@ The `chef` provisioner installs, configures and runs the Chef Client on a remote resource. The `chef` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 107ff619623a..512ea29007ac 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -10,7 +10,7 @@ description: >- Most provisioners require access to the remote resource via SSH or WinRM and expect a nested `connection` block with details about how to connect. --> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to +~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Connection Block diff --git a/website/docs/language/resources/provisioners/file.mdx b/website/docs/language/resources/provisioners/file.mdx index a73291013ef4..7b541363cb13 100644 --- a/website/docs/language/resources/provisioners/file.mdx +++ b/website/docs/language/resources/provisioners/file.mdx @@ -12,7 +12,7 @@ The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). --> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to +~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/habitat.mdx b/website/docs/language/resources/provisioners/habitat.mdx index abbee1db8289..9d5b747744cf 100644 --- a/website/docs/language/resources/provisioners/habitat.mdx +++ b/website/docs/language/resources/provisioners/habitat.mdx @@ -9,7 +9,7 @@ description: >- The `habitat` provisioner installs the [Habitat](https://habitat.sh) supervisor and loads configured services. This provisioner only supports Linux targets using the `ssh` connection type at this time. -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/local-exec.mdx b/website/docs/language/resources/provisioners/local-exec.mdx index 8298cfbe7497..dee5d2081da2 100644 --- a/website/docs/language/resources/provisioners/local-exec.mdx +++ b/website/docs/language/resources/provisioners/local-exec.mdx @@ -18,8 +18,7 @@ Note that even though the resource will be fully created when the provisioner is run, there is no guarantee that it will be in an operable state - for example system services such as `sshd` may not be started yet on compute resources. --> **Note:** Provisioners should only be used as a last resort. For most -common situations there are better alternatives. Refer to +~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/null_resource.mdx b/website/docs/language/resources/provisioners/null_resource.mdx index 827f435f46da..cf4218086690 100644 --- a/website/docs/language/resources/provisioners/null_resource.mdx +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -19,7 +19,7 @@ details](/language/resources/provisioners/connection) on a `null_resource`. You use its `triggers` argument and any meta-arguments to control exactly where in the dependency graph its provisioners will run. --> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to +~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/puppet.mdx b/website/docs/language/resources/provisioners/puppet.mdx index 72d08251636d..3199caf28d6d 100644 --- a/website/docs/language/resources/provisioners/puppet.mdx +++ b/website/docs/language/resources/provisioners/puppet.mdx @@ -11,7 +11,7 @@ The `puppet` provisioner installs, configures and runs the Puppet agent on a remote resource. The `puppet` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements diff --git a/website/docs/language/resources/provisioners/remote-exec.mdx b/website/docs/language/resources/provisioners/remote-exec.mdx index 646b780689b7..dc96b1760f83 100644 --- a/website/docs/language/resources/provisioners/remote-exec.mdx +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -17,7 +17,7 @@ into a cluster, etc. To invoke a local process, see the `local-exec` provisioner requires a [connection](/language/resources/provisioners/connection) and supports both `ssh` and `winrm`. --> **Note:** Provisioners should only be used as a last resort. There are better alternatives for most common situations. Refer to +~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/salt-masterless.mdx b/website/docs/language/resources/provisioners/salt-masterless.mdx index e3fcf67be854..fbe54fed09c2 100644 --- a/website/docs/language/resources/provisioners/salt-masterless.mdx +++ b/website/docs/language/resources/provisioners/salt-masterless.mdx @@ -12,7 +12,7 @@ Type: `salt-masterless` The `salt-masterless` Terraform provisioner provisions machines built by Terraform using [Salt](http://saltstack.com/) states, without connecting to a Salt master. The `salt-masterless` provisioner supports `ssh` [connections](/language/resources/provisioners/connection). -!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most common situations. Refer to +!> **Warning:** This provisioner was removed in the 0.15.0 version of Terraform after being deprecated as of Terraform 0.13.4. Provisioners should also be a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Requirements From 1d53273b7a7b945a3dc681d0f4632255fd937236 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 20 Jan 2022 11:28:52 -0500 Subject: [PATCH 520/644] Language nits --- .../resources/provisioners/connection.mdx | 44 +++++++++---------- 1 file changed, 20 insertions(+), 24 deletions(-) diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 512ea29007ac..5b3d275ee5d3 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -15,15 +15,15 @@ expect a nested `connection` block with details about how to connect. ## Connection Block -You can create one or more `connection` blocks that describe how to access the remote resource. One use case for providing multiple connections is to have an initial provisioner connect as the `root` user to set up user accounts, and then have subsequent provisioners connect as a user with more limited permissions. +You can create one or more `connection` blocks that describe how to access the remote resource. One use case for providing multiple connections is to have an initial provisioner connect as the `root` user to set up user accounts and then have subsequent provisioners connect as a user with more limited permissions. -Connection blocks don't take a block label, and can be nested within either a +Connection blocks don't take a block label and can be nested within either a `resource` or a `provisioner`. * A `connection` block nested directly within a `resource` affects all of that resource's provisioners. * A `connection` block nested in a `provisioner` block only affects that - provisioner, and overrides any resource-level connection settings. + provisioner and overrides any resource-level connection settings. Since the SSH connection type is most often used with newly-created remote resources, validation of SSH host keys is disabled by @@ -65,28 +65,28 @@ provisioner "file" { } ``` -## The `self` Object +### The `self` Object -Expressions in `connection` blocks cannot refer to their parent resource by -name. Instead, they can use the special `self` object. +Expressions in `connection` blocks cannot refer to their parent resource by name. References create dependencies, and referring to a resource by name within its own block would create a dependency cycle. Instead, expressions can use the `self` object, which represents the connection's parent resource and has all of that resource's attributes. For example, use `self.public_ip` to reference an `aws_instance`'s `public_ip` attribute. -The `self` object represents the connection's parent resource, and has all of -that resource's attributes. For example, use `self.public_ip` to reference an -`aws_instance`'s `public_ip` attribute. -Resource references are restricted because references create dependencies. Referring to a resource by name within its own block would create a dependency cycle. +### Argument Reference -## Argument Reference +The `connection` block supports the following argments. Some arguments are only supported by either the SSH or the WinRM connection type. -| Argument Name | Supported By | Description | Default | +Behaviors which would vary based on +the `target_platform` option if using SSH will instead force the +Windows-specific behavior when using WinRM, unless otherwise specified. + +| Argument | Connection Type | Description | Default | |---------------|--------------|-------------|---------| -| `type` | Both | The connection type that should be used. Valid types are `"ssh"` and `"winrm"`. | `"ssh"` | +| `type` | Both | The connection type. Valid values are `"ssh"` and `"winrm"`. Provisioners typically assume that the remote system runs Microsoft Windows when using the `"winrm"` connection type. | `"ssh"` | | `user` | Both | The user to use for the connection. | `root` for type `"ssh"`
          `Administrator` for type `"winrm"` | -| `password` | Both | The password we should use for the connection. | | +| `password` | Both | The password to use for the connection. | | | `host` | Both | **Required** - The address of the resource to connect to. | | | `port` | Both| The port to connect to. | `22` for type `"ssh"`
          `5985` for type `"winrm"` | -| `timeout` | Both | The timeout to wait for the connection to become available. Should be provided as a string like `"30s"` or `"5m"`. | `"5m"` | -| `script_path` | Both | The path used to copy scripts meant for remote execution. For more information, see [How Provisioners Execute Remote Scripts](#how-provisioners-execute-remote-scripts) below. | (see below)) | +| `timeout` | Both | The timeout to wait for the connection to become available. Should be provided as a string (e.g., `"30s"` or `"5m"`.) | `"5m"` | +| `script_path` | Both | The path used to copy scripts meant for remote execution. Refer to [How Provisioners Execute Remote Scripts](#how-provisioners-execute-remote-scripts) below for more details. | (details below) | | `private_key` | SSH | The contents of an SSH key to use for the connection. These can be loaded from a file on disk using [the `file` function](/language/functions/file). This takes preference over `password` if provided. | | | `certificate` | SSH | The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `private_key`. These can be loaded from a file on disk using the [the `file` function](/language/functions/file). | | | `agent` | SSH | Set to `false` to disable using `ssh-agent` to authenticate. On Windows the only supported SSH authentication agent is [Pageant](http://the.earth.li/\~sgtatham/putty/0.66/htmldoc/Chapter9.html#pageant). | | @@ -94,23 +94,19 @@ Resource references are restricted because references create dependencies. Refer | `host_key` | SSH | The public key from the remote host or the signing CA, used to verify the connection. | | | `target_platform` | SSH | The target platform to connect to. Valid values are `"windows"` and `"unix"`. If the platform is set to `windows`, the default `script_path` is `c:\windows\temp\terraform_%RAND%.cmd`, assuming [the SSH default shell](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_server_configuration#configuring-the-default-shell-for-openssh-in-windows) is `cmd.exe`. If the SSH default shell is PowerShell, set `script_path` to `"c:/windows/temp/terraform_%RAND%.ps1"` | `"unix"` | | `https` | WinRM | Set to `true` to connect using HTTPS instead of HTTP. | | -| `insecure` | WinRM | Set to `true` to not validate skip validating the HTTPS certificate chain. | | -| `use_ntlm` | WinRM | Set to `true` to use NTLM authentication, rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. For more information, see [Authentication for Remote Connections](https://docs.microsoft.com/en-us/windows/win32/winrm/authentication-for-remote-connections) in the Windows App Development documentation. | | +| `insecure` | WinRM | Set to `true` to skip validating the HTTPS certificate chain. | | +| `use_ntlm` | WinRM | Set to `true` to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. Refer to [Authentication for Remote Connections](https://docs.microsoft.com/en-us/windows/win32/winrm/authentication-for-remote-connections) in the Windows App Development documentation for more details. | | | `cacert` | WinRM | The CA certificate to validate against. | | -Provisioners typically assume that the remote system runs Microsoft Windows -when using the `winrm` connection type. Behaviors which would vary based on -the `target_platform` option if using SSH will instead force the -Windows-specific behavior when using WinRM, unless otherwise specified. ## Connecting through a Bastion Host with SSH The `ssh` connection also supports the following arguments to connect -indirectly via a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). +indirectly with a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). -| Argument Name | Description | Default | +| Argument | Description | Default | |---------------|-------------|---------| | `bastion_host` | Setting this enables the bastion Host connection. The provisioner will connect to `bastion_host` first, and then connect from there to `host`. | | | `bastion_host_key` | The public key from the remote host or the signing CA, used to verify the host connection. | | From 2f465e60473f95515d4ee3003bdaee22cdd144d1 Mon Sep 17 00:00:00 2001 From: Michele Degges Date: Thu, 20 Jan 2022 12:37:33 -0800 Subject: [PATCH 521/644] Update packaging action name --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0aefa68c24ef..be0985c26a86 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -199,7 +199,7 @@ jobs: (cd dist && unzip "../terraform_${{ env.version }}_${{ env.os }}_${{ env.arch }}.zip") mkdir -p out - name: Build Linux distribution packages - uses: hashicorp/package@v1 + uses: hashicorp/actions-packaging-linux@v1 with: name: "terraform" description: "Terraform enables you to safely and predictably create, change, and improve infrastructure. It is an open source tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned." From 9f4c4ff093828b5ba54e9bd8a58c5dd07ad6a95c Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 21 Jan 2022 10:48:27 -0500 Subject: [PATCH 522/644] Update note to be more direct :) --- website/docs/language/resources/provisioners/connection.mdx | 2 +- website/docs/language/resources/provisioners/file.mdx | 2 +- website/docs/language/resources/provisioners/local-exec.mdx | 2 +- website/docs/language/resources/provisioners/null_resource.mdx | 2 +- website/docs/language/resources/provisioners/remote-exec.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 5b3d275ee5d3..736d4eab3385 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -10,7 +10,7 @@ description: >- Most provisioners require access to the remote resource via SSH or WinRM and expect a nested `connection` block with details about how to connect. -~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to +~> **Important:** Use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Connection Block diff --git a/website/docs/language/resources/provisioners/file.mdx b/website/docs/language/resources/provisioners/file.mdx index 7b541363cb13..8d8b2ac04440 100644 --- a/website/docs/language/resources/provisioners/file.mdx +++ b/website/docs/language/resources/provisioners/file.mdx @@ -12,7 +12,7 @@ The `file` provisioner is used to copy files or directories from the machine executing Terraform to the newly created resource. The `file` provisioner supports both `ssh` and `winrm` type [connections](/language/resources/provisioners/connection). -~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to +~> **Important:** Use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/local-exec.mdx b/website/docs/language/resources/provisioners/local-exec.mdx index dee5d2081da2..eda7f9ad01e3 100644 --- a/website/docs/language/resources/provisioners/local-exec.mdx +++ b/website/docs/language/resources/provisioners/local-exec.mdx @@ -18,7 +18,7 @@ Note that even though the resource will be fully created when the provisioner is run, there is no guarantee that it will be in an operable state - for example system services such as `sshd` may not be started yet on compute resources. -~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to +~> **Important:** Use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/null_resource.mdx b/website/docs/language/resources/provisioners/null_resource.mdx index cf4218086690..fc270e364cad 100644 --- a/website/docs/language/resources/provisioners/null_resource.mdx +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -19,7 +19,7 @@ details](/language/resources/provisioners/connection) on a `null_resource`. You use its `triggers` argument and any meta-arguments to control exactly where in the dependency graph its provisioners will run. -~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to +~> **Important:** Use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage diff --git a/website/docs/language/resources/provisioners/remote-exec.mdx b/website/docs/language/resources/provisioners/remote-exec.mdx index dc96b1760f83..769ba72deb14 100644 --- a/website/docs/language/resources/provisioners/remote-exec.mdx +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -17,7 +17,7 @@ into a cluster, etc. To invoke a local process, see the `local-exec` provisioner requires a [connection](/language/resources/provisioners/connection) and supports both `ssh` and `winrm`. -~> **Important:** You should only use provisioners as a last resort. There are better alternatives for most situations. Refer to +~> **Important:** Use provisioners as a last resort. There are better alternatives for most situations. Refer to [Declaring Provisioners](/language/resources/provisioners/syntax) for more details. ## Example usage From 20e740ef8830d211396a8d5e1b7bf284a441d665 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 21 Jan 2022 11:01:37 -0500 Subject: [PATCH 523/644] Final formatting and langauge nits --- .../docs/language/resources/provisioners/connection.mdx | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 736d4eab3385..987ac7892f1f 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -74,13 +74,10 @@ Expressions in `connection` blocks cannot refer to their parent resource by name The `connection` block supports the following argments. Some arguments are only supported by either the SSH or the WinRM connection type. -Behaviors which would vary based on -the `target_platform` option if using SSH will instead force the -Windows-specific behavior when using WinRM, unless otherwise specified. | Argument | Connection Type | Description | Default | |---------------|--------------|-------------|---------| -| `type` | Both | The connection type. Valid values are `"ssh"` and `"winrm"`. Provisioners typically assume that the remote system runs Microsoft Windows when using the `"winrm"` connection type. | `"ssh"` | +| `type` | Both | The connection type. Valid values are `"ssh"` and `"winrm"`. Provisioners typically assume that the remote system runs Microsoft Windows when using WinRM. Behaviors based on the SSH `target_platform` will force Windows-specific behavior for WinRM, unless otherwise specified.| `"ssh"` | | `user` | Both | The user to use for the connection. | `root` for type `"ssh"`
          `Administrator` for type `"winrm"` | | `password` | Both | The password to use for the connection. | | | `host` | Both | **Required** - The address of the resource to connect to. | | @@ -182,7 +179,7 @@ connection { } ``` --> **Warning:** In Terraform v1.0 and earlier, the built-in provisioners +!> **Warning:** In Terraform v1.0 and earlier, the built-in provisioners incorrectly passed the `script_path` value to `scp` through a remote shell and thus allowed it to be subject to arbitrary shell expansion, and thus created an unintended opportunity for remote code execution. Terraform v1.1 and later From a37d47e9558351b1ce30e9cc9d0b3bfe524af2b3 Mon Sep 17 00:00:00 2001 From: Aurel Pintea Date: Mon, 24 Jan 2022 10:52:37 +0000 Subject: [PATCH 524/644] Improve the help.go docs: typo and a more explicit comment. --- help.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/help.go b/help.go index 16bc320951ca..9e38f8510c9e 100644 --- a/help.go +++ b/help.go @@ -10,7 +10,7 @@ import ( "github.com/mitchellh/cli" ) -// helpFunc is a cli.HelpFunc that can is used to output the help for Terraform. +// helpFunc is a cli.HelpFunc that can be used to output the help CLI instructions for Terraform. func helpFunc(commands map[string]cli.CommandFactory) string { // Determine the maximum key length, and classify based on type var otherCommands []string From a00306474d07c1a0d610c82bc5fa17454926bd88 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:09:13 -0500 Subject: [PATCH 525/644] Add new content for intro page --- website/intro/index.mdx | 69 ++++++++++++++++++++++++++++------------- 1 file changed, 48 insertions(+), 21 deletions(-) diff --git a/website/intro/index.mdx b/website/intro/index.mdx index 8e21d2d797f6..9d624dd89912 100644 --- a/website/intro/index.mdx +++ b/website/intro/index.mdx @@ -1,38 +1,65 @@ --- -page_title: Introduction -description: >- - Learn what Terraform is, what problems it can solve, and how it compares to - existing software. +layout: "intro" +page_title: "What is Terraform" +sidebar_current: "what" +description: |- + Terraform is an infrastructure as code tool that lets you build, change, and version cloud and on-prem resources safely and efficiently. --- +# What is Terraform? -# Introduction to Terraform +HashiCorp Terraform is an infrastructure as code tool that lets you define both cloud and on-prem resources in human-readable configuration files that you can version, reuse, and share. You can then use a consistent workflow to provision and manage all of your infrastructure throughout its lifecycle. Terraform can manage low-level components like compute, storage, and networking resources, as well as high-level components like DNS entries and SaaS features. -Terraform is an infrastructure as code (IaC) tool that allows you to build, change, and version infrastructure safely and efficiently. This includes low-level components such as compute instances, storage, and networking, as well as high-level components such as DNS entries, SaaS features, etc. Terraform can manage both existing service providers and custom in-house solutions. +> **Hands On:** Try the Get Started tutorials on HashiCorp Learn to start managing infrastructure on popular cloud providers: [Amazon Web Services](https://learn.hashicorp.com/collections/terraform/aws-get-started), [Azure](https://learn.hashicorp.com/collections/terraform/azure-get-started), [Google Cloud Platform](https://learn.hashicorp.com/collections/terraform/gcp-get-started), [Oracle Cloud Infrastructure](https://learn.hashicorp.com/collections/terraform/oci-get-started), and [Docker](https://learn.hashicorp.com/collections/terraform/docker-get-started). -Below, HashiCorp co-founder and CTO Armon Dadgar describes how Terraform can help solve common infrastructure challenges. +## How does Terraform work? +Terraform creates and manages resources on cloud platforms and other services through their application programming interfaces (APIs). Providers enable Terraform to work with virtually any platform or service with an accessible API. - -Terraform can apply complex changesets to your infrastructure with minimal human interaction. When you update configuration files, Terraform determines what changed and creates incremental execution plans that respect dependencies. -## Next Steps +### Manage any infrastructure -- Learn about common [Terraform use cases](/intro/use-cases). -- Learn [how Terraform compares to and complements other tools](/intro/vs). -- Try the [Terraform: Get Started](https://learn.hashicorp.com/collections/terraform/aws-get-started) tutorials on HashiCorp Learn. +Find providers for many of the platforms and services you already use in the [Terraform Registry](https://registry.terraform.io/). You can also [write your own](/plugin). Terraform takes an [immutable approach to infrastructure](https://www.hashicorp.com/resources/what-is-mutable-vs-immutable-infrastructure), reducing the complexity of upgrading or modifying your services and infrastructure. + +### Track your infrastructure + +Terraform generates a plan and prompts for your approval before modifying your infrastructure. It also keeps track of your real infrastructure in a [state file](/language/state), which acts as a source of truth for your environment. Terraform uses the state file to determine the changes to make to your infrastructure so that it will match your configuration. + +### Automate changes + +Terraform configuration files are declarative, meaning that they describe the end state of your infrastructure. You do not need to write step-by-step instructions to create resources because Terraform handles the underlying logic. Terraform builds a resource graph to determine resource dependencies and creates or modifies non-dependent resources in parallel. This allows Terraform to build resources efficiently. + +### Standardize configurations + +Terraform supports reusable configuration components called [modules](/docs/language/modules) that define configurable collections of infrastructure, saving time and enforcing best practices. You can use publicly available modules from the Terraform Registry, or write your own. + +### Collaborate + +Since your configuration is codified, you can commit it to a version control system (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. + +-> Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). + +## Community + +We welcome questions, suggestions, and contributions from the community. + +- Ask questions in [HashiCorp Discuss](https://discuss.hashicorp.com/c/terraform-core/27). +- Read our [contributing guide](https://github.com/hashicorp/terraform/blob/main/.github/CONTRIBUTING.md). +- [Submit an issue](https://github.com/hashicorp/terraform/issues/new/choose) for bugs and feature requests. From 5e618901396be01e5d50ac80452e5eb5c787aaa7 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:19:19 -0500 Subject: [PATCH 526/644] Add editions page and update sidebar --- website/data/intro-nav-data.json | 5 +- website/intro/terraform-editions.mdx | 77 ++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 2 deletions(-) create mode 100644 website/intro/terraform-editions.mdx diff --git a/website/data/intro-nav-data.json b/website/data/intro-nav-data.json index 5df078cbd2e4..120e29a1aa3d 100644 --- a/website/data/intro-nav-data.json +++ b/website/data/intro-nav-data.json @@ -3,12 +3,13 @@ { "title": "What is Terraform?", "path": "" }, { "title": "Use Cases", "path": "use-cases" }, { - "title": "Getting Started", + "title": "Get Started", "href": "https://learn.hashicorp.com/collections/terraform/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS" }, + { "title": "Terraform Editions", "path": "terraform-editions" }, { "title": "The Core Terraform Workflow", "path": "core-workflow" }, { - "title": "Terraform vs. Other", + "title": "Terraform vs. Alternatives", "routes": [ { "title": "Overview", "path": "vs" }, { "title": "Chef, Puppet, etc.", "path": "vs/chef-puppet" }, diff --git a/website/intro/terraform-editions.mdx b/website/intro/terraform-editions.mdx new file mode 100644 index 000000000000..35b985c92774 --- /dev/null +++ b/website/intro/terraform-editions.mdx @@ -0,0 +1,77 @@ +--- +layout: "intro" +page_title: "Terraform Editions" +sidebar_current: "what" +description: |- + Terraform Open Source, Terraform Cloud, and Terraform Enterprise solve increasingly complex infrastructure and collaboration challenges. +--- + +# Terraform Editions + +As your organization adopts infrastructure as code (IaC), you will encounter increasingly complex technical and collaboration challenges. We offer three Terraform editions designed to help you solve them. + +## Terraform Open Source + +Terraform open source is a free, downloadable tool that you interact with on the command line. It lets you provision infrastructure on any cloud provider and manages configuration, plugins, infrastructure, and state. + +### Why Terraform Open Source? + +Terraform open source lets you: + +- Adopt infrastructure as code and use a common configuration language to provision thousands of different types of resources and services. +Check configuration files into a version control system (VCS) to safely manage contributions. Pull the most up-to-date version to perform Terraform operations. +- Use and publish public infrastructure templates called modules to implement industry and organization best practices, group your infrastructure into logically-related components, and deploy infrastructure more quickly. + +[What is Terraform?](/intro) explains how Terraform works and solves infrastructure challenges. + +### Resources + +- Get Started collections on HashiCorp Learn for popular providers: [Amazon Web Services](https://learn.hashicorp.com/collections/terraform/aws-get-started), [Azure](https://learn.hashicorp.com/collections/terraform/azure-get-started), [Google Cloud Platform](https://learn.hashicorp.com/collections/terraform/gcp-get-started), [Oracle Cloud Infrastructure](https://learn.hashicorp.com/collections/terraform/oci-get-started), and [Docker](https://learn.hashicorp.com/collections/terraform/docker-get-started) +- [Terraform Configuration Language Documentation](/docs/language/index.html) +- [Terraform CLI Documentation](/docs/cli/index.html) + +## Terraform Cloud + +Terraform Cloud is a SaaS application that runs Terraform in a stable, remote environment and securely stores state and secrets. It includes a rich user interface that helps you better understand your Terraform operations and resources, allows you to define role-based access controls, and offers a private registry for sharing modules and providers. Terraform Cloud also integrates with the Terraform CLI and connects to common version control systems (VCS)like GitHub, GitLab, and Bitbucket. When you connect a Terraform Cloud workspace to a VCS repository, new commits and changes can automatically trigger Terraform plans. TFC also offers an API, which allows you to integrate Terraform Cloud into existing workflows. + +Many Terraform Cloud features are free for small teams; we offer paid plans for larger organizations with additional collaboration and governance features. + +### Why Terraform Cloud? + +Terraform Cloud lets you: + +- Run Terraform from the local CLI or in a remote environment, trigger operations through your version control system, or use an API to integrate TFC into your existing workflows. +- Ensure that only approved teams can access, edit, and provision infrastructure with Terraform Cloud workspaces, single sign-on, and role-based access controls. +- Securely store and version Terraform state remotely, with encryption at rest. - Versioned state files allow you to access state file history. +- Publish configuration modules in the Terraform Cloud private registry that define approved infrastructure patterns. For example, a module may allow users to choose the cloud provider on which to deploy their Java application. This allows consumers to implement your organization’s best practices without becoming IaC or cloud experts. +- Enforce best practices and security posture with the Sentinel embedded policy as code framework. For example, policies may restrict regions for production deployments. + +### Resources + +- [Create a Terraform Cloud Account](https://app.terraform.io/signup/account) +- [Terraform Cloud Documentation](/docs/cloud/index.html) +- [Sentinel Documentation](/cloud-docs/sentinel) +- [Collaborate Using Terraform Cloud](https://learn.hashicorp.com/collections/terraform/cloud) collection on HashiCorp Learn + +## Terraform Enterprise + +Terraform Enterprise allows you to set up a self-hosted distribution of Terraform Cloud. It offers customizable resource limits and is ideal for organizations with strict security and compliance requirements. + +### Why Terraform Enterprise? + +Terraform Enterprise lets you: + +- Set up a private instance of Terraform Cloud with dedicated support from HashiCorp. +- Accommodate advanced security and compliance requirements. Terraform Enterprise supports several types of installations, including air gapped and active/active architecture, and allows private networking and job scaling for better performance. + +### Resources +- [Terraform Pricing](https://www.hashicorp.com/products/terraform/pricing) +- [Terraform Enterprise Documentation](/docs/enterprise/index.html) +- [Recommended Enterprise Patterns](https://learn.hashicorp.com/collections/terraform/recommended-patterns) collection on HashiCorp Learn + + + + + + + From f1b36873e1ab403fe789f951a52991029b570a9d Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:25:20 -0500 Subject: [PATCH 527/644] Update Use Cases page copy --- website/intro/use-cases.mdx | 127 +++++++++++++++++------------------- 1 file changed, 59 insertions(+), 68 deletions(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index 7453670fd194..4b67c046c812 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -1,100 +1,91 @@ --- -page_title: Use Cases -description: >- - Learn common use cases for Terraform including managing Heroku apps, - self-service clusters, and multi-cloud deployments. +layout: "intro" +page_title: "Use Cases" +sidebar_current: "use-cases" +description: |- + Learn how Terraform enables multi-cloud deployments, application management, policy compliance, and self-service infrastructure. --- # Use Cases -This page lists a subset of use cases for [Terraform](/intro). +[Terraform](/intro/index.html) is HashiCorp’s infrastructure as code tool. It lets you define infrastructure resources in human-readable configuration files that you can version, reuse, and share. Terraform uses the configuration to safely and efficiently provision and manage your infrastructure throughout its lifecycle. -## Multi-Cloud Deployment +This page describes popular Terraform use cases and provides related resources that you can use to create Terraform configurations and workflows. -It's often attractive to spread infrastructure across multiple clouds to -increase fault-tolerance. By using only a single region or cloud provider, -fault tolerance is limited by the availability of that provider. Multi-cloud -deployment allows for more graceful recovery of the loss of a region or entire -provider. +## Multi-Cloud Deployment +Provisioning infrastructure across multiple clouds increases fault-tolerance, allowing for more graceful recovery from cloud provider outages. However, multi-cloud deployments add complexity because each provider has its own interfaces, tools, and workflows. Terraform lets you use the same workflow to manage multiple providers and handle cross-cloud dependencies. This simplifies management and orchestration for large-scale, multi-cloud infrastructures. -Realizing multi-cloud deployments can be very challenging as many existing -tools for infrastructure management are cloud-specific. Terraform is -cloud-agnostic and allows a single configuration to be used to manage multiple -providers, and to even handle cross-cloud dependencies. This simplifies -management and orchestration, helping operators build large-scale multi-cloud -infrastructures. +### Resources -> **Hands-on:** Try the [Deploy Federated Multi-Cloud Kubernetes Clusters](https://learn.hashicorp.com/tutorials/terraform/multicloud-kubernetes) tutorial on HashiCorp Learn. +- Try the [Deploy Federated Multi-Cloud Kubernetes Clusters](https://learn.hashicorp.com/tutorials/terraform/multicloud-kubernetes) tutorial on HashiCorp Learn to provision Kubernetes clusters in both Azure and AWS environments, configure Consul federation with mesh gateways across the two clusters, and deploy microservices across the two clusters to verify federation. +- Browse the [Terraform Registry](https://registry.terraform.io/browse/providers) to find thousands of publicly available providers. -## Heroku App Setup -Heroku is a popular PaaS for hosting web apps. Developers create an app, and then attach add-ons, such as a database, or email provider. One of the best features is the ability to elastically scale the number of dynos or workers. However, most non-trivial applications quickly need many add-ons and external services. +## Application Infrastructure Deployment, Scaling, and Monitoring Tools -You can use Terraform to codify the setup required for a Heroku application, ensuring that all the required add-ons are available, but it can go even further: configuring DNSimple to set a CNAME, or setting up Cloudflare as a CDN for the app. Best of all, Terraform can do all of this in under 30 seconds without using a web interface. +You can use Terraform to efficiently deploy, release, scale, and monitor infrastructure for multi-tier applications. N-tier application architecture lets you scale application components independently and provides a separation of concerns. An application could consist of a pool of web servers that use a database tier, with additional tiers for API servers, caching servers, and routing meshes. Terraform allows you to manage the resources in each tier together, and automatically handles dependencies between tiers. For example, Terraform will deploy a database tier before provisioning the web servers that depend on it. -## Multi-Tier Applications +### Resources -A very common pattern is the N-tier architecture. The most common 2-tier architecture is -a pool of web servers that use a database tier. Additional tiers get added for API servers, -caching servers, routing meshes, etc. This pattern is used because the tiers can be scaled -independently and provide a separation of concerns. +- Try the [Automate Monitoring with the Terraform Datadog Provider](https://learn.hashicorp.com/tutorials/terraform/datadog-provider?in=terraform/applications) tutorial on HashiCorp Learn to deploy a demo Nginx application to a Kubernetes cluster with Helm and install the Datadog agent across the cluster. The Datadog agent reports the cluster health back to your Datadog dashboard, and you will create a monitor for this cluster in Terraform. +- Try the [Use Application Load Balancers for Blue-Green and Canary Deployments](https://learn.hashicorp.com/tutorials/terraform/blue-green-canary-tests-deployments) tutorial on HashiCorp Learn. You will provision the blue and green environments, add feature toggles to your Terraform configuration to define a list of potential deployment strategies, conduct a canary test, and incrementally promote your green environment. -Terraform is an ideal tool for building and managing these infrastructures. You can group resources in each tier together, and Terraform will automatically handle the dependencies between each tier. For example, Terraform will ensure the database tier is available before provisioning the web servers and that the load balancers are connected to the web nodes. You can then use Terraform to easily scale each tier by modifying the `count` configuration value. Because resource creation and provisioning is codified and automated, elastically scaling -with load becomes trivial. ## Self-Service Clusters -At a certain organizational size, it becomes very challenging for a centralized -operations team to manage a large and growing infrastructure. Instead it becomes -more attractive to make "self-serve" infrastructure, allowing product teams to -manage their own infrastructure using tooling provided by the central operations team. +At a large organization, your centralized operations team may get many repetitive infrastructure requests. You can use Terraform to build a "self-serve" infrastructure model that lets product teams manage their own infrastructure independently. You can create and use Terraform modules that codify the standards for deploying and managing services in your organization, allowing teams to efficiently deploy services in compliance with your organization’s practices. Terraform Cloud can also integrate with ticketing systems like ServiceNow to automatically generate new infrastructure requests. -You can use Terraform configuration to codify the knowledge of how to build and scale a service. You can then share these configurations throughout your organization, enabling customer teams to use Terraform to manage their services. +### Resources -## Software Demos +- Try the [Use Modules from the Registry](https://learn.hashicorp.com/tutorials/terraform/module-use?in=terraform/modules) tutorial on HashiCorp Learn to get started using public modules in your Terraform configuration. +Try the [Build and Use a Local Module](https://learn.hashicorp.com/tutorials/terraform/module-create?in=terraform/modules) tutorial on HashiCorp Learn to create a module to manage AWS S3 buckets. +- Follow these [ServiceNow Service Catalog Integration Setup Instructions](/cloud-docs/integrations/service-now) to connect ServiceNow to Terraform Cloud. + + +## Policy Compliance and Management -Modern software is increasingly networked and distributed. Although tools like -[Vagrant](https://www.vagrantup.com/) exist to build virtualized environments -for demos, it is still very challenging to demo software on real infrastructure -which more closely matches production environments. +Terraform can help you enforce policies on the types of resources teams can provision and use. Ticket-based review processes are a bottleneck that can slow down development. Instead, you can use Sentinel, a policy-as-code framework, to automatically enforce compliance and governance policies before Terraform makes infrastructure changes. Sentinel is available with the [Terraform Cloud team and governance](https://www.hashicorp.com/products/terraform/pricing) plan. -Software writers can provide a Terraform configuration to create, provision and -bootstrap a demo on cloud providers like AWS. This allows end users to easily demo the software on their own infrastructure, and even enables tweaking parameters like cluster size to more rigorously test tools at any scale. +### Resources -## Disposable Environments +- Try the [Control Costs with Policies](https://learn.hashicorp.com/tutorials/terraform/cost-estimation) tutorial on HashiCorp Learn to estimate the cost of infrastructure changes and define policy to check to limit it. -It is common practice to have both a production and staging or QA environment. -These environments are smaller clones of their production counterpart, but are -used to test new applications before releasing in production. As the production -environment grows larger and more complex, it becomes increasingly onerous to -maintain an up-to-date staging environment. +- The [Sentinel documentation](/docs/cloud/sentinel/index.html) provides more in-depth information and a list of example policies that you can adapt for your use cases. + + +## PaaS Application Setup +Platform as a Service (PaaS) vendors like Heroku allow you to create web applications and attach add-ons, such as databases or email providers. Heroku can elastically scale the number of dynos or workers, but most non-trivial applications need many add-ons and external services. You can use Terraform to codify the setup required for a Heroku application, configure a DNSimple to set a CNAME, and set up Cloudflare as a Content Delivery Network (CDN) for the app. Terraform can quickly and consistently do all of this without a web interface. + +### Resources + +Try the [Deploy, Manage, and Scale a an Application on Heroku](https://learn.hashicorp.com/tutorials/terraform/heroku-provider?in=terraform/applications) tutorial on HashiCorp Learn to use Terraform to manage an application’s lifecycle. -Using Terraform, the production environment can be codified and then shared with -staging, QA or dev. These configurations can be used to rapidly spin up new -environments to test in, and then be easily disposed of. Terraform can help tame -the difficulty of maintaining parallel environments, and makes it practical -to elastically create and destroy them. ## Software Defined Networking -Software Defined Networking (SDN) is becoming increasingly prevalent in the -datacenter, as it provides more control to operators and developers and -allows the network to better support the applications running on top. Most SDN -implementations have a control layer and infrastructure layer. +Terraform can interact with Software Defined Networks (SDNs) to automatically configure the network according to the needs of the applications running in it. This lets you move from a ticket-based workflow to an automated one, reducing deployment times. + +For example, when a service registers with [HashiCorp Consul](https://www.consul.io/), [Consul-Terraform-Sync](https://www.consul.io/docs/nia) can automatically generate Terraform configuration to expose appropriate ports and adjust network settings for any SDN that has an associated Terraform provider. Network Infrastructure Automation (NIA) allows you to safely approve the changes that your applications require, without having to manually translate tickets from developers into the changes you think their applications need. -You can use Terraform to codify the configuration for software defined networks. -Terraform can then use this configuration to automatically set up and modify settings by interfacing with the control layer. This allows the configuration to be -versioned and changes to be automated. For example, you can [use Terraform to configure AWS VPC](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc). +### Resources -## Resource Schedulers +Try the [Consul-Terraform-Sync Run Modes and Status Inspection ](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-run-and-inspect?in=consul/network-infrastructure-automation) tutorial on HashiCorp Learn to learn the different run modes available with Consul-Terraform-Sync, how to monitor the task status, and how to locate or store the Terraform state files in the Consul backend. -In large-scale infrastructures, static assignment of applications to machines -becomes increasingly challenging. To solve that problem, there are a number -of schedulers like Borg, Mesos, YARN, and Kubernetes. These can be used to -dynamically schedule Docker containers, Hadoop, Spark, and many other software -tools. -Terraform is not limited to physical providers like AWS. Resource schedulers -can be treated as a provider, enabling Terraform to request resources from them. -This allows Terraform to be used in layers: to setup the physical infrastructure -running the schedulers as well as provisioning onto the scheduled grid. +## Kubernetes + +Kubernetes is an open-source workload scheduler for containerized applications. Terraform enables you to both deploy the Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes custom resource definition (CRD) and Terraform Cloud. + +### Resources + +- Try the [Manage Kubernetes Resources via Terraform](https://learn.hashicorp.com/tutorials/terraform/kubernetes-provider?in=terraform/kubernetes) tutorial on HashiCorp Learn. You will use Terraform to schedule and expose a NGINX deployment on a Kubernetes cluster. +- Try the [Deploy Infrastructure with the Terraform Cloud Operator for Kubernetes](https://learn.hashicorp.com/tutorials/terraform/kubernetes-operator) tutorial on HashiCorp Learn. You will configure and deploy the Operator to a Kubernetes cluster and use it to create a Terraform Cloud workspace and provision a message queue for an example application. + + +## Parallel Environments + +You may have staging or QA environments that you use to test new applications before releasing them in production. As the production environment grows larger and more complex, it can be increasingly difficult to maintain an up-to-date environment for each stage in the development process. Terraform lets you rapidly spin up and decommission infrastructure for development, test, QA, and production. Using Terraform to create disposable environments as needed is more cost-efficient than maintaining each one indefinitely. + + +## Software Demos +You can use Terraform to create, provision, and bootstrap a demo on various cloud providers. This lets end users easily try the software on their own infrastructure and even enables them to adjust parameters like cluster size to more rigorously test tools at any scale. From 95adde5dc9236078313d0dc53702881320b3af5b Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:29:54 -0500 Subject: [PATCH 528/644] Update vs. index page to say "Alternatives" and include a list on the page for SEO --- website/intro/vs/index.mdx | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/website/intro/vs/index.mdx b/website/intro/vs/index.mdx index bc0d6dc9c1d8..6d5bec374fa4 100644 --- a/website/intro/vs/index.mdx +++ b/website/intro/vs/index.mdx @@ -1,9 +1,9 @@ --- -page_title: Terraform vs. Other Software -description: An overview of how Terraform compares to other software and tools. +page_title: Terraform vs. Alternatives +description: An overview of how Terraform compares to alternative software and tools. --- -# Terraform vs. Other Software +# Terraform vs. Alternatives Terraform provides a flexible abstraction of resources and providers. This model allows for representing everything from physical hardware, virtual machines, and @@ -14,5 +14,9 @@ to a number of these tools, but it should be noted that Terraform is not mutuall exclusive with other systems. It can be used to manage a single application, or the entire datacenter. -Use the navigation on the left to read comparisons of Terraform versus other -specific systems. +Learn how Terraform compares to: + +- [Chef, Puppet, etc.](/intro/vs/chef-puppet) +- [CloudFormation, Heat, etc.](/intro/vs/cloudformation) +- [Boto, Fog, etc.](/intro/vs/boto) +- [Custom Solutions](/intro/vs/custom) From 3676b3b157b0b9217fc9f32fedfcb808748b356d Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 24 Jan 2022 16:57:16 -0500 Subject: [PATCH 529/644] build: Remove broken website link check job --- .circleci/config.yml | 95 -------------------------------------------- 1 file changed, 95 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index e462189b31b7..626dcd69a244 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -175,97 +175,6 @@ jobs: name: test docker build for 'full' image command: docker build -t test-docker-full . - # Based on a similar job in terraform-website repo. - website-link-check: - docker: - - image: *MIDDLEMAN_IMAGE - steps: - - checkout: - path: terraform - - - run: - name: Determine changed website files, if any - working_directory: terraform - command: | - # Figure out what the current branch forked from. Compare against - # main and the set of "vX.Y" branches, and choose whichever branch - # we're the *fewest* commits ahead of. - # The point here isn't to perfectly predict where this will be - # merged; all we really care about is determining which commits are - # *unique to this PR,* so we don't accidentally complain about - # problems you had nothing to do with. - PARENT_BRANCH=$( - for br in $(git branch -rl --format='%(refname:short)' | grep -E '^origin/(main|v\d+\.\d+)$'); do - new_commits=$(git rev-list --first-parent ^${br} HEAD | wc -l); - echo "${br} ${new_commits}"; - done \ - | sort -n -k2 \ - | head -n1 \ - | awk '{print $1}'; - ) - echo "Checking current branch against: ${PARENT_BRANCH}" - MERGE_BASE=$(git merge-base HEAD ${PARENT_BRANCH}) - git diff --name-only -z --diff-filter=AMRCT ${MERGE_BASE}..HEAD -- ./website/ > /tmp/changed-website-files.txt - # --name-only: Return a list of affected files but don't show the changes. - # -z: Make that a null-separated list (instead of newline-separated), and - # DON'T mangle non-ASCII characters. - # --diff-filter=AMRCT: Only list files that were added, modified, renamed, - # copied, or had their type changed (file, symlink, etc.). In - # particular, we don't want to check deleted files. - # ${MERGE_BASE}..HEAD: Only consider files that have - # changed since this branch diverged from its parent branch. - # -- ./website/: Only consider files in the website directory. - echo "Changed website files:" - cat /tmp/changed-website-files.txt | tr '\0' '\n' - # Need to use "tr" for display because it's a null-separated list. - - - run: - name: Exit early if there's nothing to check - command: | - if [ ! -s /tmp/changed-website-files.txt ]; then - circleci-agent step halt - fi - - - run: - name: Check out terraform-website repo - command: git clone git@github.com:hashicorp/terraform-website.git - - - run: - name: Use local checkout for terraform submodule, instead of cloning again - working_directory: terraform-website - command: | - # Set submodule's URL to our existing checkout. - # (Using `pwd` because git's behavior with strictly relative paths is unreliable.) - git config --file=.gitmodules submodule.ext/terraform.url $(pwd)/../terraform/.git - # Make it so `make sync` will grab our current branch instead of stable-website. - git config --file=.gitmodules submodule.ext/terraform.branch HEAD - - - run: - name: Init/update terraform-website submodules - working_directory: terraform-website - command: make sync - - - run: - name: Set up terraform-website dependencies - working_directory: terraform-website/content - # If this does anything interesting, then the container needs an update. - command: bundle check || bundle install --path vendor/bundle --retry=3 - - - run: - name: Run middleman in background - working_directory: terraform-website/content - background: true - command: bundle exec middleman server - - - run: - name: Wait for server to start - command: until curl -sS http://localhost:4567/ > /dev/null; do sleep 1; done - - - run: - name: Check links in changed pages - working_directory: terraform-website/content - command: cat /tmp/changed-website-files.txt | bundle exec ./scripts/check-pr-links.rb - workflows: version: 2 test: @@ -289,7 +198,3 @@ workflows: - build-amd64 - build-arm - build-arm64 - - website-test: - jobs: - - website-link-check From 322622a0f40dd0c06f45f9b40f8a36515a7502f4 Mon Sep 17 00:00:00 2001 From: Tyron Date: Tue, 25 Jan 2022 20:54:20 -0500 Subject: [PATCH 530/644] fix reference to module References to child modules should use the resource name, not their path --- website/docs/language/values/outputs.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/values/outputs.mdx b/website/docs/language/values/outputs.mdx index a06c8ffcb4f6..777400e19da2 100644 --- a/website/docs/language/values/outputs.mdx +++ b/website/docs/language/values/outputs.mdx @@ -115,7 +115,7 @@ module "foo" { } resource "test_instance" "x" { - some_attribute = module.mod.a # resource attribute references a sensitive output + some_attribute = module.foo.a # resource attribute references a sensitive output } output "out" { From eaf748f24dfe6ae248d03e75f1b9bab72e3c3527 Mon Sep 17 00:00:00 2001 From: Katy Moe Date: Wed, 26 Jan 2022 09:15:01 +0000 Subject: [PATCH 531/644] remove dependabot --- .github/dependabot.yml | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index e5c936ead2f6..000000000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,6 +0,0 @@ -version: 2 -updates: -- package-ecosystem: gomod - directory: "/" - schedule: - interval: daily \ No newline at end of file From 11a450d3414b03e0c220fb7ada308bbb7b668c03 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 11:18:18 -0500 Subject: [PATCH 532/644] Final editing pass --- website/intro/index.mdx | 4 ++-- website/intro/terraform-editions.mdx | 18 +++++++++--------- website/intro/use-cases.mdx | 8 ++++---- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/website/intro/index.mdx b/website/intro/index.mdx index 9d624dd89912..96eca5fa8442 100644 --- a/website/intro/index.mdx +++ b/website/intro/index.mdx @@ -24,7 +24,7 @@ The core Terraform workflow consists of three stages: - **Plan:** Terraform creates an execution plan describing the infrastructure it will create, update, or destroy based on the existing infrastructure and your configuration. - **Apply:** On approval, Terraform performs the proposed operations in the correct order, respecting any resource dependencies. For example, if you update the properties of a VPC and change the number of virtual machines in that VPC, Terraform will recreate the VPC before scaling the virtual machines. -![The Terraform workflow: Write, Plan, Apply](/images/intro-terraform-workflow.png) +![The Terraform workflow has three steps: Write, Plan, and Apply](/images/intro-terraform-workflow.png) ## Why Terraform? @@ -54,7 +54,7 @@ Terraform supports reusable configuration components called [modules](/docs/lang Since your configuration is codified, you can commit it to a version control system (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. --> Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). +-> **Note:** Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). ## Community diff --git a/website/intro/terraform-editions.mdx b/website/intro/terraform-editions.mdx index 35b985c92774..b0d75d6780b3 100644 --- a/website/intro/terraform-editions.mdx +++ b/website/intro/terraform-editions.mdx @@ -19,20 +19,20 @@ Terraform open source is a free, downloadable tool that you interact with on the Terraform open source lets you: - Adopt infrastructure as code and use a common configuration language to provision thousands of different types of resources and services. -Check configuration files into a version control system (VCS) to safely manage contributions. Pull the most up-to-date version to perform Terraform operations. +- Check configuration files into a version control system (VCS) to safely manage contributions. Pull the most up-to-date version to perform Terraform operations. - Use and publish public infrastructure templates called modules to implement industry and organization best practices, group your infrastructure into logically-related components, and deploy infrastructure more quickly. -[What is Terraform?](/intro) explains how Terraform works and solves infrastructure challenges. ### Resources - Get Started collections on HashiCorp Learn for popular providers: [Amazon Web Services](https://learn.hashicorp.com/collections/terraform/aws-get-started), [Azure](https://learn.hashicorp.com/collections/terraform/azure-get-started), [Google Cloud Platform](https://learn.hashicorp.com/collections/terraform/gcp-get-started), [Oracle Cloud Infrastructure](https://learn.hashicorp.com/collections/terraform/oci-get-started), and [Docker](https://learn.hashicorp.com/collections/terraform/docker-get-started) -- [Terraform Configuration Language Documentation](/docs/language/index.html) -- [Terraform CLI Documentation](/docs/cli/index.html) +- [What is Terraform?](/intro) +- [Configuration Language Documentation](/docs/language/index.html) +- [CLI Documentation](/docs/cli/index.html) ## Terraform Cloud -Terraform Cloud is a SaaS application that runs Terraform in a stable, remote environment and securely stores state and secrets. It includes a rich user interface that helps you better understand your Terraform operations and resources, allows you to define role-based access controls, and offers a private registry for sharing modules and providers. Terraform Cloud also integrates with the Terraform CLI and connects to common version control systems (VCS)like GitHub, GitLab, and Bitbucket. When you connect a Terraform Cloud workspace to a VCS repository, new commits and changes can automatically trigger Terraform plans. TFC also offers an API, which allows you to integrate Terraform Cloud into existing workflows. +Terraform Cloud is a SaaS application that runs Terraform in a stable, remote environment and securely stores state and secrets. It includes a rich user interface that helps you better understand your Terraform operations and resources, allows you to define role-based access controls, and offers a private registry for sharing modules and providers. Terraform Cloud also integrates with the Terraform CLI and connects to common version control systems (VCS) like GitHub, GitLab, and Bitbucket. When you connect a Terraform Cloud workspace to a VCS repository, new commits and changes can automatically trigger Terraform plans. Terraform Cloud also offers an API, allowing you to integrate it into existing workflows. Many Terraform Cloud features are free for small teams; we offer paid plans for larger organizations with additional collaboration and governance features. @@ -40,11 +40,11 @@ Many Terraform Cloud features are free for small teams; we offer paid plans for Terraform Cloud lets you: -- Run Terraform from the local CLI or in a remote environment, trigger operations through your version control system, or use an API to integrate TFC into your existing workflows. +- Run Terraform from the local CLI or in a remote environment, trigger operations through your version control system, or use an API to integrate Terraform Cloud into your existing workflows. - Ensure that only approved teams can access, edit, and provision infrastructure with Terraform Cloud workspaces, single sign-on, and role-based access controls. -- Securely store and version Terraform state remotely, with encryption at rest. - Versioned state files allow you to access state file history. -- Publish configuration modules in the Terraform Cloud private registry that define approved infrastructure patterns. For example, a module may allow users to choose the cloud provider on which to deploy their Java application. This allows consumers to implement your organization’s best practices without becoming IaC or cloud experts. -- Enforce best practices and security posture with the Sentinel embedded policy as code framework. For example, policies may restrict regions for production deployments. +- Securely store and version Terraform state remotely, with encryption at rest. Versioned state files allow you to access state file history. +- Publish configuration modules in the Terraform Cloud private registry that define approved infrastructure patterns. For example, a module may allow users to choose the cloud provider on which to deploy their Java application. This allows consumers to implement your organization’s best practices without becoming infrastructure or cloud experts. +- Enforce best practices and security rules with the Sentinel embedded policy as code framework. For example, policies may restrict regions for production deployments. ### Resources diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index 4b67c046c812..be19bd82a9d6 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -8,7 +8,7 @@ description: |- # Use Cases -[Terraform](/intro/index.html) is HashiCorp’s infrastructure as code tool. It lets you define infrastructure resources in human-readable configuration files that you can version, reuse, and share. Terraform uses the configuration to safely and efficiently provision and manage your infrastructure throughout its lifecycle. +[HashiCorp Terraform](/intro/index.html) is an infrastructure as code tool that lets you define infrastructure resources in human-readable configuration files that you can version, reuse, and share. You can then use a consistent workflow to safely and efficiently provision and manage your infrastructure throughout its lifecycle. This page describes popular Terraform use cases and provides related resources that you can use to create Terraform configurations and workflows. @@ -48,7 +48,7 @@ Terraform can help you enforce policies on the types of resources teams can prov ### Resources -- Try the [Control Costs with Policies](https://learn.hashicorp.com/tutorials/terraform/cost-estimation) tutorial on HashiCorp Learn to estimate the cost of infrastructure changes and define policy to check to limit it. +- Try the [Control Costs with Policies](https://learn.hashicorp.com/tutorials/terraform/cost-estimation) tutorial on HashiCorp Learn to estimate the cost of infrastructure changes and define policy to limit it. - The [Sentinel documentation](/docs/cloud/sentinel/index.html) provides more in-depth information and a list of example policies that you can adapt for your use cases. @@ -58,7 +58,7 @@ Platform as a Service (PaaS) vendors like Heroku allow you to create web applic ### Resources -Try the [Deploy, Manage, and Scale a an Application on Heroku](https://learn.hashicorp.com/tutorials/terraform/heroku-provider?in=terraform/applications) tutorial on HashiCorp Learn to use Terraform to manage an application’s lifecycle. +Try the [Deploy, Manage, and Scale an Application on Heroku](https://learn.hashicorp.com/tutorials/terraform/heroku-provider?in=terraform/applications) tutorial on HashiCorp Learn manage an application’s lifecycle with Terraform. ## Software Defined Networking @@ -74,7 +74,7 @@ Try the [Consul-Terraform-Sync Run Modes and Status Inspection ](https://learn.h ## Kubernetes -Kubernetes is an open-source workload scheduler for containerized applications. Terraform enables you to both deploy the Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes custom resource definition (CRD) and Terraform Cloud. +Kubernetes is an open-source workload scheduler for containerized applications. Terraform lets you both deploy the Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes custom resource definition (CRD) and Terraform Cloud. ### Resources From e9d79f52848d4b93369936c7b45e335859a5cf5c Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 11:41:57 -0500 Subject: [PATCH 533/644] Update website/docs/cli/import/index.mdx Co-authored-by: Nick Fagerlund --- website/docs/cli/import/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/import/index.mdx b/website/docs/cli/import/index.mdx index 0781741b1363..d9503e0b4665 100644 --- a/website/docs/cli/import/index.mdx +++ b/website/docs/cli/import/index.mdx @@ -40,4 +40,4 @@ importing existing resources. ## Terraform Cloud -When you use Terraform on the command line with Terraform Cloud, many commands (e.g., `apply`) run inside your Terraform Cloud environment. However, the `import` command runs locally, so it will not have access to information from Terraform Cloud. To fix this, you may need to set local variables equivalent to any remote workspace variables in Terraform Cloud. +When you use Terraform on the command line with Terraform Cloud, many commands (e.g., `apply`) run inside your Terraform Cloud environment. However, the `import` command runs locally, so it will not have access to information from Terraform Cloud. To successfully perform an import, you may need to set local variables equivalent to any remote workspace variables in Terraform Cloud. From 1b1b5225a2a954d2ff2741b2db49a80fa3c8e01f Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 11:42:22 -0500 Subject: [PATCH 534/644] Update website/docs/language/state/remote-state-data.mdx Co-authored-by: Nick Fagerlund --- website/docs/language/state/remote-state-data.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx index 4e08a4c6b971..6d5b83554ff5 100644 --- a/website/docs/language/state/remote-state-data.mdx +++ b/website/docs/language/state/remote-state-data.mdx @@ -9,7 +9,7 @@ description: >- [backends]: /language/settings/backends -The `terraform_remote_state` data source uses the latest state snapshot from the remote backend to retrieve the root module output values +The `terraform_remote_state` data source uses the latest state snapshot from a specified state backend to retrieve the root module output values from some other Terraform configuration. You can use the `terraform_remote_state` data source without requiring or configuring a provider. It is always available through a built-in provider with the [source address](/language/providers/requirements#source-addresses) `terraform.io/builtin/terraform`. That provider does not include any other resources or data sources. From 53aa84576f6ce8294adba8e78658417f920ece45 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 11:43:16 -0500 Subject: [PATCH 535/644] Update website/docs/language/state/remote-state-data.mdx Co-authored-by: Nick Fagerlund --- website/docs/language/state/remote-state-data.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx index 6d5b83554ff5..48ead8ea43e6 100644 --- a/website/docs/language/state/remote-state-data.mdx +++ b/website/docs/language/state/remote-state-data.mdx @@ -14,7 +14,7 @@ from some other Terraform configuration. You can use the `terraform_remote_state` data source without requiring or configuring a provider. It is always available through a built-in provider with the [source address](/language/providers/requirements#source-addresses) `terraform.io/builtin/terraform`. That provider does not include any other resources or data sources. -!> **Warning:** We recommend using the [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) to access remote state outputs in Terraform Cloud or Terraform Enterprise. The `tfe_outputs` data source is more secure because it does not require full access to workspace state to fetch outputs. If you are using the [Terraform Cloud CLI integration](/docs/cli/cloud), you **must** use `tfe_outputs` because the integration is incompatible with `terraform_remote_state`. +~> **Important:** We recommend using the [`tfe_outputs` data source](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs/data-sources/outputs) in the [Terraform Cloud/Enterprise Provider](https://registry.terraform.io/providers/hashicorp/tfe/latest/docs) to access remote state outputs in Terraform Cloud or Terraform Enterprise. The `tfe_outputs` data source is more secure because it does not require full access to workspace state to fetch outputs. ## Alternative Ways to Share Data Between Configurations From e21d5d36f46fd548d7f1456cd8d86cf4f6aa596a Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 26 Jan 2022 15:16:09 -0500 Subject: [PATCH 536/644] core: Fix plan write/state write ordering bug --- .../terraform/node_resource_plan_instance.go | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/internal/terraform/node_resource_plan_instance.go b/internal/terraform/node_resource_plan_instance.go index 87d54d720204..2006355668bd 100644 --- a/internal/terraform/node_resource_plan_instance.go +++ b/internal/terraform/node_resource_plan_instance.go @@ -206,6 +206,22 @@ func (n *NodePlannableResourceInstance) managedResourceExecute(ctx EvalContext) return diags } + // FIXME: it is currently important that we write resource changes to + // the plan (n.writeChange) before we write the corresponding state + // (n.writeResourceInstanceState). + // + // This is because the planned resource state will normally have the + // status of states.ObjectPlanned, which causes later logic to refer to + // the contents of the plan to retrieve the resource data. Because + // there is no shared lock between these two data structures, reversing + // the order of these writes will cause a brief window of inconsistency + // which can lead to a failed safety check. + // + // Future work should adjust these APIs such that it is impossible to + // update these two data structures incorrectly through any objects + // reachable via the terraform.EvalContext API. + diags = diags.Append(n.writeChange(ctx, change, "")) + diags = diags.Append(n.writeResourceInstanceState(ctx, instancePlanState, workingState)) if diags.HasErrors() { return diags @@ -224,8 +240,6 @@ func (n *NodePlannableResourceInstance) managedResourceExecute(ctx EvalContext) return diags } } - - diags = diags.Append(n.writeChange(ctx, change, "")) } else { // Even if we don't plan changes, we do still need to at least update // the working state to reflect the refresh result. If not, then e.g. From 636499830bfd993a8342d2b3d6dd6eef7710b61c Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Tue, 25 Jan 2022 12:27:49 -0500 Subject: [PATCH 537/644] Add merged pull request reminder --- .github/workflows/merged-pr.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/merged-pr.yml diff --git a/.github/workflows/merged-pr.yml b/.github/workflows/merged-pr.yml new file mode 100644 index 000000000000..df1249a81169 --- /dev/null +++ b/.github/workflows/merged-pr.yml @@ -0,0 +1,24 @@ +name: Merged Pull Request +permissions: + pull-requests: write + +# only trigger on pull request closed events +on: + pull_request_target: + types: [ closed ] + +jobs: + merge_job: + # this job will only run if the PR has been merged + if: github.event.pull_request.merged == true + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v5 + with: + script: | + github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: "Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch." + }) From 044ed1c65aef06805e7a26998846f56b860e0435 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:10:27 -0500 Subject: [PATCH 538/644] Update website/intro/terraform-editions.mdx Co-authored-by: Judith Malnick --- website/intro/terraform-editions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/terraform-editions.mdx b/website/intro/terraform-editions.mdx index b0d75d6780b3..69e2873feaa7 100644 --- a/website/intro/terraform-editions.mdx +++ b/website/intro/terraform-editions.mdx @@ -67,7 +67,7 @@ Terraform Enterprise lets you: ### Resources - [Terraform Pricing](https://www.hashicorp.com/products/terraform/pricing) - [Terraform Enterprise Documentation](/docs/enterprise/index.html) -- [Recommended Enterprise Patterns](https://learn.hashicorp.com/collections/terraform/recommended-patterns) collection on HashiCorp Learn +- [Recommended Enterprise Patterns](https://learn.hashicorp.com/collections/terraform/recommended-patterns) guides From 749507dd6aa025e6da5923baec1378e0cbdcdd46 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:10:34 -0500 Subject: [PATCH 539/644] Update website/intro/terraform-editions.mdx Co-authored-by: Judith Malnick --- website/intro/terraform-editions.mdx | 7 ------- 1 file changed, 7 deletions(-) diff --git a/website/intro/terraform-editions.mdx b/website/intro/terraform-editions.mdx index 69e2873feaa7..900b5bddaf8c 100644 --- a/website/intro/terraform-editions.mdx +++ b/website/intro/terraform-editions.mdx @@ -68,10 +68,3 @@ Terraform Enterprise lets you: - [Terraform Pricing](https://www.hashicorp.com/products/terraform/pricing) - [Terraform Enterprise Documentation](/docs/enterprise/index.html) - [Recommended Enterprise Patterns](https://learn.hashicorp.com/collections/terraform/recommended-patterns) guides - - - - - - - From f76762816304b88cd720b79196f708c66e92d609 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:10:54 -0500 Subject: [PATCH 540/644] Update website/intro/terraform-editions.mdx Co-authored-by: Judith Malnick --- website/intro/terraform-editions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/terraform-editions.mdx b/website/intro/terraform-editions.mdx index 900b5bddaf8c..c7da74250871 100644 --- a/website/intro/terraform-editions.mdx +++ b/website/intro/terraform-editions.mdx @@ -51,7 +51,7 @@ Terraform Cloud lets you: - [Create a Terraform Cloud Account](https://app.terraform.io/signup/account) - [Terraform Cloud Documentation](/docs/cloud/index.html) - [Sentinel Documentation](/cloud-docs/sentinel) -- [Collaborate Using Terraform Cloud](https://learn.hashicorp.com/collections/terraform/cloud) collection on HashiCorp Learn +- [Get Started - Terraform Cloud](https://learn.hashicorp.com/collections/terraform/cloud-get-started) tutorials show you how to manage infrastructure using Terraform Cloud's VCS integration ## Terraform Enterprise From 240243167968428454235e7ba52874d33c5a2305 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:10 -0500 Subject: [PATCH 541/644] Update website/intro/terraform-editions.mdx Co-authored-by: Judith Malnick --- website/intro/terraform-editions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/terraform-editions.mdx b/website/intro/terraform-editions.mdx index c7da74250871..d33d661fd4ac 100644 --- a/website/intro/terraform-editions.mdx +++ b/website/intro/terraform-editions.mdx @@ -19,7 +19,7 @@ Terraform open source is a free, downloadable tool that you interact with on the Terraform open source lets you: - Adopt infrastructure as code and use a common configuration language to provision thousands of different types of resources and services. -- Check configuration files into a version control system (VCS) to safely manage contributions. Pull the most up-to-date version to perform Terraform operations. +- Codify your infrastructure so that you can check configuration files into a version control system (VCS) to safely manage contributions. Manually pull the most up-to-date version to perform Terraform operations. - Use and publish public infrastructure templates called modules to implement industry and organization best practices, group your infrastructure into logically-related components, and deploy infrastructure more quickly. From 10b1f8599109e449952191033be60a485a0500f1 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:16 -0500 Subject: [PATCH 542/644] Update website/intro/use-cases.mdx Co-authored-by: Judith Malnick --- website/intro/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index be19bd82a9d6..93d90df5c09e 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -74,7 +74,7 @@ Try the [Consul-Terraform-Sync Run Modes and Status Inspection ](https://learn.h ## Kubernetes -Kubernetes is an open-source workload scheduler for containerized applications. Terraform lets you both deploy the Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes custom resource definition (CRD) and Terraform Cloud. +Kubernetes is an open-source workload scheduler for containerized applications. Terraform lets you both deploy a Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes custom resource definition (CRD) and Terraform Cloud. ### Resources From 283e3c8ddb0e298e52017a0ac045fb79cc5f24a1 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:24 -0500 Subject: [PATCH 543/644] Update website/intro/use-cases.mdx Co-authored-by: Judith Malnick --- website/intro/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index 93d90df5c09e..fd01e80ccacf 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -37,7 +37,7 @@ At a large organization, your centralized operations team may get many repetitiv ### Resources -- Try the [Use Modules from the Registry](https://learn.hashicorp.com/tutorials/terraform/module-use?in=terraform/modules) tutorial on HashiCorp Learn to get started using public modules in your Terraform configuration. +- Try the [Use Modules from the Registry](https://learn.hashicorp.com/tutorials/terraform/module-use?in=terraform/modules) tutorial to get started using public modules in your Terraform configuration. Try the [Build and Use a Local Module](https://learn.hashicorp.com/tutorials/terraform/module-create?in=terraform/modules) tutorial on HashiCorp Learn to create a module to manage AWS S3 buckets. - Follow these [ServiceNow Service Catalog Integration Setup Instructions](/cloud-docs/integrations/service-now) to connect ServiceNow to Terraform Cloud. From 05391559438a2aeed96b0c3524ff53757192acda Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:31 -0500 Subject: [PATCH 544/644] Update website/intro/use-cases.mdx Co-authored-by: Judith Malnick --- website/intro/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index fd01e80ccacf..6b81d640dcb6 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -28,7 +28,7 @@ You can use Terraform to efficiently deploy, release, scale, and monitor infrast ### Resources - Try the [Automate Monitoring with the Terraform Datadog Provider](https://learn.hashicorp.com/tutorials/terraform/datadog-provider?in=terraform/applications) tutorial on HashiCorp Learn to deploy a demo Nginx application to a Kubernetes cluster with Helm and install the Datadog agent across the cluster. The Datadog agent reports the cluster health back to your Datadog dashboard, and you will create a monitor for this cluster in Terraform. -- Try the [Use Application Load Balancers for Blue-Green and Canary Deployments](https://learn.hashicorp.com/tutorials/terraform/blue-green-canary-tests-deployments) tutorial on HashiCorp Learn. You will provision the blue and green environments, add feature toggles to your Terraform configuration to define a list of potential deployment strategies, conduct a canary test, and incrementally promote your green environment. +- Try our [Use Application Load Balancers for Blue-Green and Canary Deployments](https://learn.hashicorp.com/tutorials/terraform/blue-green-canary-tests-deployments) tutorial. You will provision the blue and green environments, add feature toggles to your Terraform configuration to define a list of potential deployment strategies, conduct a canary test, and incrementally promote your green environment. ## Self-Service Clusters From 2209b00167e48c227887d5823f1ed98db06f1a91 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:42 -0500 Subject: [PATCH 545/644] Update website/intro/use-cases.mdx Co-authored-by: Judith Malnick --- website/intro/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index 6b81d640dcb6..7d9c8479fa60 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -44,7 +44,7 @@ Try the [Build and Use a Local Module](https://learn.hashicorp.com/tutorials/ter ## Policy Compliance and Management -Terraform can help you enforce policies on the types of resources teams can provision and use. Ticket-based review processes are a bottleneck that can slow down development. Instead, you can use Sentinel, a policy-as-code framework, to automatically enforce compliance and governance policies before Terraform makes infrastructure changes. Sentinel is available with the [Terraform Cloud team and governance](https://www.hashicorp.com/products/terraform/pricing) plan. +Terraform can help you enforce policies on the types of resources teams can provision and use. Ticket-based review processes are a bottleneck that can slow down development. Instead, you can use Sentinel, a policy-as-code framework, to automatically enforce compliance and governance policies before Terraform makes infrastructure changes. Sentinel is available with the [Terraform Cloud team and governance](https://www.hashicorp.com/products/terraform/pricing) tier. ### Resources From 2201ebc0751d9547463688a99a2ffafde570d4a0 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:47 -0500 Subject: [PATCH 546/644] Update website/intro/use-cases.mdx Co-authored-by: Judith Malnick --- website/intro/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index 7d9c8479fa60..aa723a7649bf 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -27,7 +27,7 @@ You can use Terraform to efficiently deploy, release, scale, and monitor infrast ### Resources -- Try the [Automate Monitoring with the Terraform Datadog Provider](https://learn.hashicorp.com/tutorials/terraform/datadog-provider?in=terraform/applications) tutorial on HashiCorp Learn to deploy a demo Nginx application to a Kubernetes cluster with Helm and install the Datadog agent across the cluster. The Datadog agent reports the cluster health back to your Datadog dashboard, and you will create a monitor for this cluster in Terraform. +- Try our [Automate Monitoring with the Terraform Datadog Provider](https://learn.hashicorp.com/tutorials/terraform/datadog-provider?in=terraform/applications) tutorial to deploy a demo Nginx application to a Kubernetes cluster with Helm and install the Datadog agent across the cluster. The Datadog agent reports the cluster health back to your Datadog dashboard. - Try our [Use Application Load Balancers for Blue-Green and Canary Deployments](https://learn.hashicorp.com/tutorials/terraform/blue-green-canary-tests-deployments) tutorial. You will provision the blue and green environments, add feature toggles to your Terraform configuration to define a list of potential deployment strategies, conduct a canary test, and incrementally promote your green environment. From 4a8b4b311d9630e23fe8ddc72082c29f3f27b57e Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:11:52 -0500 Subject: [PATCH 547/644] Update website/intro/use-cases.mdx Co-authored-by: Judith Malnick --- website/intro/use-cases.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index aa723a7649bf..a44858dd94a7 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -17,7 +17,7 @@ Provisioning infrastructure across multiple clouds increases fault-tolerance, al ### Resources -- Try the [Deploy Federated Multi-Cloud Kubernetes Clusters](https://learn.hashicorp.com/tutorials/terraform/multicloud-kubernetes) tutorial on HashiCorp Learn to provision Kubernetes clusters in both Azure and AWS environments, configure Consul federation with mesh gateways across the two clusters, and deploy microservices across the two clusters to verify federation. +- Try our [Deploy Federated Multi-Cloud Kubernetes Clusters](https://learn.hashicorp.com/tutorials/terraform/multicloud-kubernetes) tutorial to provision Kubernetes clusters in both Azure and AWS environments, configure Consul federation with mesh gateways across the two clusters, and deploy microservices across the two clusters to verify federation. - Browse the [Terraform Registry](https://registry.terraform.io/browse/providers) to find thousands of publicly available providers. From 8ab9edf8caef81773ede888385e1ef0125f8e113 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:12:04 -0500 Subject: [PATCH 548/644] Update website/intro/index.mdx Co-authored-by: Judith Malnick --- website/intro/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/index.mdx b/website/intro/index.mdx index 96eca5fa8442..232e6c570dc0 100644 --- a/website/intro/index.mdx +++ b/website/intro/index.mdx @@ -54,7 +54,7 @@ Terraform supports reusable configuration components called [modules](/docs/lang Since your configuration is codified, you can commit it to a version control system (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. --> **Note:** Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). +-> **Tip:** Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). ## Community From d5b0f44e37488662959509af95e0b4b597eb56a9 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:12:12 -0500 Subject: [PATCH 549/644] Update website/intro/index.mdx Co-authored-by: Judith Malnick --- website/intro/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/intro/index.mdx b/website/intro/index.mdx index 232e6c570dc0..6da7efe6ec70 100644 --- a/website/intro/index.mdx +++ b/website/intro/index.mdx @@ -52,7 +52,7 @@ Terraform supports reusable configuration components called [modules](/docs/lang ### Collaborate -Since your configuration is codified, you can commit it to a version control system (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. +Since your configuration is codified, you can commit it to a version control system (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides secure access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. -> **Tip:** Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). From 4ced2181ca0db0e25943330c24e8d6f90ba855e8 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:30:05 -0500 Subject: [PATCH 550/644] Update SDN tutorials to recommended ones --- website/intro/use-cases.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index a44858dd94a7..04e80bf6dd95 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -69,7 +69,8 @@ For example, when a service registers with [HashiCorp Consul](https://www.consul ### Resources -Try the [Consul-Terraform-Sync Run Modes and Status Inspection ](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-run-and-inspect?in=consul/network-infrastructure-automation) tutorial on HashiCorp Learn to learn the different run modes available with Consul-Terraform-Sync, how to monitor the task status, and how to locate or store the Terraform state files in the Consul backend. +- Try the [Network Infrastructure Automation with Consul-Terraform-Sync Intro](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-intro?in=consul/network-infrastructure-automation) tutorial on Hashicorp Learn to install Consul-Terraform-Sync on a node. You will then configure it to communicate with a Consul datacenter, react to service changes, and execute an example task. +- Try the [Consul-Terraform-Sync and Terraform Enterprise/Cloud Integration](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-terraform-enterprise?in=consul/network-infrastructure-automation) tutorial on HashiCorp Learn to configure Consul-Terraform-Sync to interact with Terraform Enterprise and Terraform Cloud. ## Kubernetes From 4188c4c518651b408eb14d4bf8a07922b49b2f80 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 18:21:09 -0500 Subject: [PATCH 551/644] fix image references on intro page --- website/intro/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/intro/index.mdx b/website/intro/index.mdx index 6da7efe6ec70..95554ff36c67 100644 --- a/website/intro/index.mdx +++ b/website/intro/index.mdx @@ -14,7 +14,7 @@ HashiCorp Terraform is an infrastructure as code tool that lets you define both ## How does Terraform work? Terraform creates and manages resources on cloud platforms and other services through their application programming interfaces (APIs). Providers enable Terraform to work with virtually any platform or service with an accessible API. -![Terraform creates and manages cloud platforms and services through their APIs](/images/intro-terraform-apis.png) +![Terraform creates and manages cloud platforms and services through their APIs](/img/docs/intro-terraform-apis.png) HashiCorp and the Terraform community have already written **more than 1700 providers** to manage thousands of different types of resources and services, and this number continues to grow. You can find all publicly available providers on the [Terraform Registry](https://registry.terraform.io/), including Amazon Web Services (AWS), Azure, Google Cloud Platform (GCP), Kubernetes, Helm, GitHub, Splunk, DataDog, and many more. @@ -24,7 +24,7 @@ The core Terraform workflow consists of three stages: - **Plan:** Terraform creates an execution plan describing the infrastructure it will create, update, or destroy based on the existing infrastructure and your configuration. - **Apply:** On approval, Terraform performs the proposed operations in the correct order, respecting any resource dependencies. For example, if you update the properties of a VPC and change the number of virtual machines in that VPC, Terraform will recreate the VPC before scaling the virtual machines. -![The Terraform workflow has three steps: Write, Plan, and Apply](/images/intro-terraform-workflow.png) +![The Terraform workflow has three steps: Write, Plan, and Apply](/img/docs/intro-terraform-workflow.png) ## Why Terraform? From 6a02fbaef386aad36b8819b59a3dc04904a1ba89 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 26 Jan 2022 20:06:49 -0500 Subject: [PATCH 552/644] Fixing some final typos and nits that robin found! --- website/intro/index.mdx | 10 +++++----- website/intro/use-cases.mdx | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/website/intro/index.mdx b/website/intro/index.mdx index 95554ff36c67..df01b7a992e2 100644 --- a/website/intro/index.mdx +++ b/website/intro/index.mdx @@ -20,7 +20,7 @@ HashiCorp and the Terraform community have already written **more than 1700 prov The core Terraform workflow consists of three stages: -- **Write:** You define resources, which may be across multiple cloud providers and services. For example, you might create a configuration to deploy an application on virtual machines in a virtual private cloud (VPC) network with security groups and a load balancer. +- **Write:** You define resources, which may be across multiple cloud providers and services. For example, you might create a configuration to deploy an application on virtual machines in a Virtual Private Cloud (VPC) network with security groups and a load balancer. - **Plan:** Terraform creates an execution plan describing the infrastructure it will create, update, or destroy based on the existing infrastructure and your configuration. - **Apply:** On approval, Terraform performs the proposed operations in the correct order, respecting any resource dependencies. For example, if you update the properties of a VPC and change the number of virtual machines in that VPC, Terraform will recreate the VPC before scaling the virtual machines. @@ -40,19 +40,19 @@ Find providers for many of the platforms and services you already use in the [Te ### Track your infrastructure -Terraform generates a plan and prompts for your approval before modifying your infrastructure. It also keeps track of your real infrastructure in a [state file](/language/state), which acts as a source of truth for your environment. Terraform uses the state file to determine the changes to make to your infrastructure so that it will match your configuration. +Terraform generates a plan and prompts you for your approval before modifying your infrastructure. It also keeps track of your real infrastructure in a [state file](/language/state), which acts as a source of truth for your environment. Terraform uses the state file to determine the changes to make to your infrastructure so that it will match your configuration. ### Automate changes -Terraform configuration files are declarative, meaning that they describe the end state of your infrastructure. You do not need to write step-by-step instructions to create resources because Terraform handles the underlying logic. Terraform builds a resource graph to determine resource dependencies and creates or modifies non-dependent resources in parallel. This allows Terraform to build resources efficiently. +Terraform configuration files are declarative, meaning that they describe the end state of your infrastructure. You do not need to write step-by-step instructions to create resources because Terraform handles the underlying logic. Terraform builds a resource graph to determine resource dependencies and creates or modifies non-dependent resources in parallel. This allows Terraform to provision resources efficiently. ### Standardize configurations -Terraform supports reusable configuration components called [modules](/docs/language/modules) that define configurable collections of infrastructure, saving time and enforcing best practices. You can use publicly available modules from the Terraform Registry, or write your own. +Terraform supports reusable configuration components called [modules](/docs/language/modules) that define configurable collections of infrastructure, saving time and encouraging best practices. You can use publicly available modules from the Terraform Registry, or write your own. ### Collaborate -Since your configuration is codified, you can commit it to a version control system (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides secure access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. +Since your configuration is written in a file, you can commit it to a Version Control System (VCS) and use [Terraform Cloud](/intro/terraform-editions#terraform-cloud) to efficiently manage Terraform workflows across teams. Terraform Cloud runs Terraform in a consistent, reliable environment and provides secure access to shared state and secret data, role-based access controls, a private registry for sharing both modules and providers, and more. -> **Tip:** Learn more about [Terraform use cases](/intro/use-cases) and [how Terraform compares to alternatives](/intro/vs). diff --git a/website/intro/use-cases.mdx b/website/intro/use-cases.mdx index 04e80bf6dd95..41600af6c741 100644 --- a/website/intro/use-cases.mdx +++ b/website/intro/use-cases.mdx @@ -65,17 +65,17 @@ Try the [Deploy, Manage, and Scale an Application on Heroku](https://learn.hashi Terraform can interact with Software Defined Networks (SDNs) to automatically configure the network according to the needs of the applications running in it. This lets you move from a ticket-based workflow to an automated one, reducing deployment times. -For example, when a service registers with [HashiCorp Consul](https://www.consul.io/), [Consul-Terraform-Sync](https://www.consul.io/docs/nia) can automatically generate Terraform configuration to expose appropriate ports and adjust network settings for any SDN that has an associated Terraform provider. Network Infrastructure Automation (NIA) allows you to safely approve the changes that your applications require, without having to manually translate tickets from developers into the changes you think their applications need. +For example, when a service registers with [HashiCorp Consul](https://www.consul.io/), [Consul-Terraform-Sync](https://www.consul.io/docs/nia) can automatically generate Terraform configuration to expose appropriate ports and adjust network settings for any SDN that has an associated Terraform provider. Network Infrastructure Automation (NIA) allows you to safely approve the changes that your applications require without having to manually translate tickets from developers into the changes you think their applications need. ### Resources -- Try the [Network Infrastructure Automation with Consul-Terraform-Sync Intro](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-intro?in=consul/network-infrastructure-automation) tutorial on Hashicorp Learn to install Consul-Terraform-Sync on a node. You will then configure it to communicate with a Consul datacenter, react to service changes, and execute an example task. +- Try the [Network Infrastructure Automation with Consul-Terraform-Sync Intro](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-intro?in=consul/network-infrastructure-automation) tutorial on HashiCorp Learn to install Consul-Terraform-Sync on a node. You will then configure it to communicate with a Consul datacenter, react to service changes, and execute an example task. - Try the [Consul-Terraform-Sync and Terraform Enterprise/Cloud Integration](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-terraform-enterprise?in=consul/network-infrastructure-automation) tutorial on HashiCorp Learn to configure Consul-Terraform-Sync to interact with Terraform Enterprise and Terraform Cloud. ## Kubernetes -Kubernetes is an open-source workload scheduler for containerized applications. Terraform lets you both deploy a Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes custom resource definition (CRD) and Terraform Cloud. +Kubernetes is an open-source workload scheduler for containerized applications. Terraform lets you both deploy a Kubernetes cluster and manage its resources (e.g., pods, deployments, services, etc.). You can also use the [Kubernetes Operator for Terraform](https://github.com/hashicorp/terraform-k8s) to manage cloud and on-prem infrastructure through a Kubernetes Custom Resource Definition (CRD) and Terraform Cloud. ### Resources @@ -85,7 +85,7 @@ Kubernetes is an open-source workload scheduler for containerized applications. ## Parallel Environments -You may have staging or QA environments that you use to test new applications before releasing them in production. As the production environment grows larger and more complex, it can be increasingly difficult to maintain an up-to-date environment for each stage in the development process. Terraform lets you rapidly spin up and decommission infrastructure for development, test, QA, and production. Using Terraform to create disposable environments as needed is more cost-efficient than maintaining each one indefinitely. +You may have staging or QA environments that you use to test new applications before releasing them in production. As the production environment grows larger and more complex, it can be increasingly difficult to maintain an up-to-date environment for each stage of the development process. Terraform lets you rapidly spin up and decommission infrastructure for development, test, QA, and production. Using Terraform to create disposable environments as needed is more cost-efficient than maintaining each one indefinitely. ## Software Demos From 238396567d32e95a2e6159b6f8c33e72e9433bfa Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 27 Jan 2022 16:00:08 -0500 Subject: [PATCH 553/644] Making replace flag clearer and making plan options clearer --- website/docs/cli/commands/apply.mdx | 10 +++++----- website/docs/cli/commands/plan.mdx | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index ece491cdc2f0..03517682117a 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -39,7 +39,7 @@ Terraform will propose the plan to you and prompt you to approve it before taking the described actions, unless you waive that prompt by using the `-auto-approve` option. -When performing its own plan, `terraform apply` supports all of the same +-> **Tip:** When performing its own plan, `terraform apply` supports all of the same [planning modes](/cli/commands/plan#planning-modes) and [planning options](/cli/commands/plan#planning-options) that `terraform plan` would accept, so you can customize how Terraform will create the plan. @@ -67,10 +67,7 @@ plan`'s planning modes and planning options. For details, see: ### Apply Options The following options allow you to change various details about how the -apply command executes and reports on the apply operation. If you are running -`terraform apply` _without_ a previously-saved plan file, these options are -_in addition to_ the planning modes and planning options described for -[`terraform plan`](/cli/commands/plan). +apply command executes and reports on the apply operation. * `-auto-approve` - Skips interactive approval of plan before applying. This option is ignored when you pass a previously-saved plan file, because @@ -114,6 +111,9 @@ _in addition to_ the planning modes and planning options described for [walks the graph](/internals/graph#walking-the-graph). Defaults to 10\. +- Planning modes and options available for +[`terraform plan`](/cli/commands/plan#planning-options) - Only available when you run `terraform apply` without a previously-saved plan file. + For configurations using [the `local` backend](/language/settings/backends/local) only, `terraform apply` also accepts the legacy options diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index 8cb8112e166f..57d2ed5f5489 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -137,7 +137,7 @@ options in this section, along with the planning mode selection options in the previous section, are also available with the same meanings on `terraform apply`. -* `-refresh=false` - Disables the default behavior of synchronizing the +- `-refresh=false` - Disables the default behavior of synchronizing the Terraform state with remote objects before checking for configuration changes. This option can potentially make the planning operation faster by reducing @@ -149,7 +149,7 @@ the previous section, are also available with the same meanings on it would effectively disable the entirety of the planning operation in that case. -* `-replace=ADDRESS` - Instructs Terraform to plan to replace the single +- `-replace=ADDRESS` - Instructs Terraform to plan to replace the single resource instance with the given address. If the given instance would normally have caused only an "update" action, or no action at all, then Terraform will choose a "replace" action instead. @@ -157,7 +157,7 @@ the previous section, are also available with the same meanings on You can use this option if you have learned that a particular remote object has become degraded in some way. If you are using immutable infrastructure patterns then you may wish to respond to that by replacing the - malfunctioning object with a new object that has the same configuration. + malfunctioning object with a new object that has the same configuration. You can also replace multiple objects at once by adding multiple flags to the command. This option is allowed only in the normal planning mode, so this option is incompatible with the `-destroy` option. @@ -166,7 +166,7 @@ the previous section, are also available with the same meanings on For earlier versions, you can achieve a similar effect (with some caveats) using [`terraform taint`](/cli/commands/taint). -* `-target=ADDRESS` - Instructs Terraform to focus its planning efforts only +- `-target=ADDRESS` - Instructs Terraform to focus its planning efforts only on resource instances which match the given address and on any objects that those instances depend on. @@ -174,14 +174,14 @@ the previous section, are also available with the same meanings on [Resource Targeting](#resource-targeting) below for more information. -* `-var 'NAME=VALUE'` - Sets a value for a single +- `-var 'NAME=VALUE'` - Sets a value for a single [input variable](/language/values/variables) declared in the root module of the configuration. Use this option multiple times to set more than one variable. For more information see [Input Variables on the Command Line](#input-variables-on-the-command-line), below. -* `-var-file=FILENAME` - Sets values for potentially many +- `-var-file=FILENAME` - Sets values for potentially many [input variables](/language/values/variables) declared in the root module of the configuration, using definitions from a ["tfvars" file](/language/values/variables#variable-definitions-tfvars-files). From 1a66861aaff4de88b3db0008715a37d4cd0036d6 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 27 Jan 2022 16:53:25 -0500 Subject: [PATCH 554/644] A couple other tweaks --- website/docs/cli/commands/apply.mdx | 2 +- website/docs/cli/commands/taint.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index 03517682117a..d6a4c2994ddd 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -112,7 +112,7 @@ apply command executes and reports on the apply operation. 10\. - Planning modes and options available for -[`terraform plan`](/cli/commands/plan#planning-options) - Only available when you run `terraform apply` without a previously-saved plan file. +[`terraform plan`](/cli/commands/plan#planning-options) - Only available when you run `terraform apply` without a saved plan file. For configurations using [the `local` backend](/language/settings/backends/local) only, diff --git a/website/docs/cli/commands/taint.mdx b/website/docs/cli/commands/taint.mdx index b37a34b3eb1c..40ac0526db6a 100644 --- a/website/docs/cli/commands/taint.mdx +++ b/website/docs/cli/commands/taint.mdx @@ -16,7 +16,7 @@ propose to replace it in the next plan you create. ## Recommended Alternative -For Terraform v0.15.2 and later, we recommend using the [`-replace` option](/cli/commands/plan#replace-address) with `terraform apply` to force Terraform to replace an object even though there are no configuration changes that would require it. +For Terraform v0.15.2 and later, we recommend using the [`-replace` option](/cli/commands/plan#replace-address) with `terraform apply` to force Terraform to replace an object even though there are no configuration changes that would require it. ``` $ terraform apply -replace="aws_instance.example[0]" From aa3a046af3747256bdd3bd464234008775d5c431 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 27 Jan 2022 16:56:50 -0500 Subject: [PATCH 555/644] final nits --- website/docs/cli/commands/plan.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index 57d2ed5f5489..7a879a3232c5 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -154,10 +154,9 @@ the previous section, are also available with the same meanings on normally have caused only an "update" action, or no action at all, then Terraform will choose a "replace" action instead. - You can use this option if you have learned that a particular remote object - has become degraded in some way. If you are using immutable infrastructure - patterns then you may wish to respond to that by replacing the - malfunctioning object with a new object that has the same configuration. You can also replace multiple objects at once by adding multiple flags to the command. + You can use this option if you have learned that one or more remote objects + has become degraded in some way. Add multiple `-replace` flags to the command to replace several objects at once. If you are using immutable infrastructure + patterns, you may wish to replace the malfunctioning objects with new objects that have the same configuration. This option is allowed only in the normal planning mode, so this option is incompatible with the `-destroy` option. From dca94a9eaf4012250c9fe8ddbb15cea9ef84f8a7 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 27 Jan 2022 16:58:17 -0500 Subject: [PATCH 556/644] fix verb tense --- website/docs/cli/commands/plan.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index 7a879a3232c5..d36611f9aab2 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -155,8 +155,7 @@ the previous section, are also available with the same meanings on Terraform will choose a "replace" action instead. You can use this option if you have learned that one or more remote objects - has become degraded in some way. Add multiple `-replace` flags to the command to replace several objects at once. If you are using immutable infrastructure - patterns, you may wish to replace the malfunctioning objects with new objects that have the same configuration. + have become degraded in some way. Add multiple `-replace` flags to replace several objects at once. If you are using immutable infrastructure patterns, you may wish to replace the malfunctioning objects with new objects that have the same configuration. This option is allowed only in the normal planning mode, so this option is incompatible with the `-destroy` option. From f56c7c1c85fabdb9ddda02729516b5c785dadbc7 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 27 Jan 2022 17:05:45 -0500 Subject: [PATCH 557/644] Make language in callouts more user friendly --- website/docs/cli/commands/apply.mdx | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index d6a4c2994ddd..3b7d148db702 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -39,10 +39,8 @@ Terraform will propose the plan to you and prompt you to approve it before taking the described actions, unless you waive that prompt by using the `-auto-approve` option. --> **Tip:** When performing its own plan, `terraform apply` supports all of the same -[planning modes](/cli/commands/plan#planning-modes) and -[planning options](/cli/commands/plan#planning-options) that `terraform plan` would -accept, so you can customize how Terraform will create the plan. +-> **Tip:** When you run `terraform apply` without a saved plan file, you can use all of the [planning modes](/cli/commands/plan#planning-modes) and +[planning options](/cli/commands/plan#planning-options) available for `terraform plan`. This lets you customize how Terraform will create the plan. ### Saved Plan Mode @@ -111,8 +109,9 @@ apply command executes and reports on the apply operation. [walks the graph](/internals/graph#walking-the-graph). Defaults to 10\. -- Planning modes and options available for -[`terraform plan`](/cli/commands/plan#planning-options) - Only available when you run `terraform apply` without a saved plan file. +- All [planning modes](/cli/commands/plan#planning-modes) and +[planning options](/cli/commands/plan#planning-options) for +`terraform plan` - Customize how Terraform will create the plan. Only available when you run `terraform apply` without a saved plan file. For configurations using [the `local` backend](/language/settings/backends/local) only, From 4f41a0a1fe343f726cb989dd2a0f027367fde730 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 20 Nov 2020 14:05:13 -0800 Subject: [PATCH 558/644] configs: Generalize "VariableValidation" as "CheckRule" This construct of a block containing a condition and an error message will be useful for other sorts of blocks defining expectations or contracts, so we'll give it a more generic name in anticipation of it being used in other situations. --- internal/configs/checks.go | 152 ++++++++++++++++++ internal/configs/named_values.go | 140 +--------------- internal/terraform/node_root_variable_test.go | 2 +- 3 files changed, 161 insertions(+), 133 deletions(-) create mode 100644 internal/configs/checks.go diff --git a/internal/configs/checks.go b/internal/configs/checks.go new file mode 100644 index 000000000000..31af8ae2fb09 --- /dev/null +++ b/internal/configs/checks.go @@ -0,0 +1,152 @@ +package configs + +import ( + "fmt" + "unicode" + + "github.com/hashicorp/hcl/v2" + "github.com/hashicorp/hcl/v2/gohcl" +) + +// CheckRule represents a configuration-defined validation rule, precondition, +// or postcondition. Blocks of this sort can appear in a few different places +// in configuration, including "validation" blocks for variables, +// and "precondition" and "postcondition" blocks for resources. +type CheckRule struct { + // Condition is an expression that must evaluate to true if the condition + // holds or false if it does not. If the expression produces an error then + // that's considered to be a bug in the module defining the check. + // + // The available variables in a condition expression vary depending on what + // a check is attached to. For example, validation rules attached to + // input variables can only refer to the variable that is being validated. + Condition hcl.Expression + + // ErrorMessage is one or more full sentences, which would need to be in + // English for consistency with the rest of the error message output but + // can in practice be in any language as long as it ends with a period. + // The message should describe what is required for the condition to return + // true in a way that would make sense to a caller of the module. + ErrorMessage string + + DeclRange hcl.Range +} + +// decodeCheckRuleBlock decodes the contents of the given block as a check rule. +// +// Unlike most of our "decode..." functions, this one can be applied to blocks +// of various types as long as their body structures are "check-shaped". The +// function takes the containing block only because some error messages will +// refer to its location, and the returned object's DeclRange will be the +// block's header. +func decodeCheckRuleBlock(block *hcl.Block, override bool) (*CheckRule, hcl.Diagnostics) { + var diags hcl.Diagnostics + cr := &CheckRule{ + DeclRange: block.DefRange, + } + + if override { + // For now we'll just forbid overriding check blocks, to simplify + // the initial design. If we can find a clear use-case for overriding + // checks in override files and there's a way to define it that + // isn't confusing then we could relax this. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: fmt.Sprintf("Can't override %s blocks", block.Type), + Detail: fmt.Sprintf("Override files cannot override %q blocks.", block.Type), + Subject: cr.DeclRange.Ptr(), + }) + return cr, diags + } + + content, moreDiags := block.Body.Content(checkRuleBlockSchema) + diags = append(diags, moreDiags...) + + if attr, exists := content.Attributes["condition"]; exists { + cr.Condition = attr.Expr + } + + if attr, exists := content.Attributes["error_message"]; exists { + moreDiags := gohcl.DecodeExpression(attr.Expr, nil, &cr.ErrorMessage) + diags = append(diags, moreDiags...) + if !moreDiags.HasErrors() { + const errSummary = "Invalid validation error message" + switch { + case cr.ErrorMessage == "": + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errSummary, + Detail: "An empty string is not a valid nor useful error message.", + Subject: attr.Expr.Range().Ptr(), + }) + case !looksLikeSentences(cr.ErrorMessage): + // Because we're going to include this string verbatim as part + // of a bigger error message written in our usual style in + // English, we'll require the given error message to conform + // to that. We might relax this in future if e.g. we start + // presenting these error messages in a different way, or if + // Terraform starts supporting producing error messages in + // other human languages, etc. + // For pragmatism we also allow sentences ending with + // exclamation points, but we don't mention it explicitly here + // because that's not really consistent with the Terraform UI + // writing style. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errSummary, + Detail: "The validation error message must be at least one full sentence starting with an uppercase letter and ending with a period or question mark.\n\nYour given message will be included as part of a larger Terraform error message, written as English prose. For broadly-shared modules we suggest using a similar writing style so that the overall result will be consistent.", + Subject: attr.Expr.Range().Ptr(), + }) + } + } + } + + return cr, diags +} + +// looksLikeSentence is a simple heuristic that encourages writing error +// messages that will be presentable when included as part of a larger +// Terraform error diagnostic whose other text is written in the Terraform +// UI writing style. +// +// This is intentionally not a very strong validation since we're assuming +// that module authors want to write good messages and might just need a nudge +// about Terraform's specific style, rather than that they are going to try +// to work around these rules to write a lower-quality message. +func looksLikeSentences(s string) bool { + if len(s) < 1 { + return false + } + runes := []rune(s) // HCL guarantees that all strings are valid UTF-8 + first := runes[0] + last := runes[len(runes)-1] + + // If the first rune is a letter then it must be an uppercase letter. + // (This will only see the first rune in a multi-rune combining sequence, + // but the first rune is generally the letter if any are, and if not then + // we'll just ignore it because we're primarily expecting English messages + // right now anyway, for consistency with all of Terraform's other output.) + if unicode.IsLetter(first) && !unicode.IsUpper(first) { + return false + } + + // The string must be at least one full sentence, which implies having + // sentence-ending punctuation. + // (This assumes that if a sentence ends with quotes then the period + // will be outside the quotes, which is consistent with Terraform's UI + // writing style.) + return last == '.' || last == '?' || last == '!' +} + +var checkRuleBlockSchema = &hcl.BodySchema{ + Attributes: []hcl.AttributeSchema{ + { + Name: "condition", + Required: true, + }, + { + Name: "error_message", + Required: true, + }, + }, +} diff --git a/internal/configs/named_values.go b/internal/configs/named_values.go index 9dcd10b40b74..0213398851d8 100644 --- a/internal/configs/named_values.go +++ b/internal/configs/named_values.go @@ -2,7 +2,6 @@ package configs import ( "fmt" - "unicode" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/gohcl" @@ -30,7 +29,7 @@ type Variable struct { ConstraintType cty.Type ParsingMode VariableParsingMode - Validations []*VariableValidation + Validations []*CheckRule Sensitive bool DescriptionSet bool @@ -308,53 +307,12 @@ func (m VariableParsingMode) Parse(name, value string) (cty.Value, hcl.Diagnosti } } -// VariableValidation represents a configuration-defined validation rule -// for a particular input variable, given as a "validation" block inside -// a "variable" block. -type VariableValidation struct { - // Condition is an expression that refers to the variable being tested - // and contains no other references. The expression must return true - // to indicate that the value is valid or false to indicate that it is - // invalid. If the expression produces an error, that's considered a bug - // in the module defining the validation rule, not an error in the caller. - Condition hcl.Expression - - // ErrorMessage is one or more full sentences, which would need to be in - // English for consistency with the rest of the error message output but - // can in practice be in any language as long as it ends with a period. - // The message should describe what is required for the condition to return - // true in a way that would make sense to a caller of the module. - ErrorMessage string - - DeclRange hcl.Range -} - -func decodeVariableValidationBlock(varName string, block *hcl.Block, override bool) (*VariableValidation, hcl.Diagnostics) { - var diags hcl.Diagnostics - vv := &VariableValidation{ - DeclRange: block.DefRange, - } - - if override { - // For now we'll just forbid overriding validation blocks, to simplify - // the initial design. If we can find a clear use-case for overriding - // validations in override files and there's a way to define it that - // isn't confusing then we could relax this. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Can't override variable validation rules", - Detail: "Variable \"validation\" blocks cannot be used in override files.", - Subject: vv.DeclRange.Ptr(), - }) - return vv, diags - } - - content, moreDiags := block.Body.Content(variableValidationBlockSchema) - diags = append(diags, moreDiags...) - - if attr, exists := content.Attributes["condition"]; exists { - vv.Condition = attr.Expr - +// decodeVariableValidationBlock is a wrapper around decodeCheckRuleBlock +// that imposes the additional rule that the condition expression can refer +// only to an input variable of the given name. +func decodeVariableValidationBlock(varName string, block *hcl.Block, override bool) (*CheckRule, hcl.Diagnostics) { + vv, diags := decodeCheckRuleBlock(block, override) + if vv.Condition != nil { // The validation condition can only refer to the variable itself, // to ensure that the variable declaration can't create additional // edges in the dependency graph. @@ -382,83 +340,14 @@ func decodeVariableValidationBlock(varName string, block *hcl.Block, override bo Severity: hcl.DiagError, Summary: "Invalid variable validation condition", Detail: fmt.Sprintf("The condition for variable %q must refer to var.%s in order to test incoming values.", varName, varName), - Subject: attr.Expr.Range().Ptr(), + Subject: vv.Condition.Range().Ptr(), }) } } - if attr, exists := content.Attributes["error_message"]; exists { - moreDiags := gohcl.DecodeExpression(attr.Expr, nil, &vv.ErrorMessage) - diags = append(diags, moreDiags...) - if !moreDiags.HasErrors() { - const errSummary = "Invalid validation error message" - switch { - case vv.ErrorMessage == "": - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: errSummary, - Detail: "An empty string is not a valid nor useful error message.", - Subject: attr.Expr.Range().Ptr(), - }) - case !looksLikeSentences(vv.ErrorMessage): - // Because we're going to include this string verbatim as part - // of a bigger error message written in our usual style in - // English, we'll require the given error message to conform - // to that. We might relax this in future if e.g. we start - // presenting these error messages in a different way, or if - // Terraform starts supporting producing error messages in - // other human languages, etc. - // For pragmatism we also allow sentences ending with - // exclamation points, but we don't mention it explicitly here - // because that's not really consistent with the Terraform UI - // writing style. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: errSummary, - Detail: "The validation error message must be at least one full sentence starting with an uppercase letter and ending with a period or question mark.\n\nYour given message will be included as part of a larger Terraform error message, written as English prose. For broadly-shared modules we suggest using a similar writing style so that the overall result will be consistent.", - Subject: attr.Expr.Range().Ptr(), - }) - } - } - } - return vv, diags } -// looksLikeSentence is a simple heuristic that encourages writing error -// messages that will be presentable when included as part of a larger -// Terraform error diagnostic whose other text is written in the Terraform -// UI writing style. -// -// This is intentionally not a very strong validation since we're assuming -// that module authors want to write good messages and might just need a nudge -// about Terraform's specific style, rather than that they are going to try -// to work around these rules to write a lower-quality message. -func looksLikeSentences(s string) bool { - if len(s) < 1 { - return false - } - runes := []rune(s) // HCL guarantees that all strings are valid UTF-8 - first := runes[0] - last := runes[len(runes)-1] - - // If the first rune is a letter then it must be an uppercase letter. - // (This will only see the first rune in a multi-rune combining sequence, - // but the first rune is generally the letter if any are, and if not then - // we'll just ignore it because we're primarily expecting English messages - // right now anyway, for consistency with all of Terraform's other output.) - if unicode.IsLetter(first) && !unicode.IsUpper(first) { - return false - } - - // The string must be at least one full sentence, which implies having - // sentence-ending punctuation. - // (This assumes that if a sentence ends with quotes then the period - // will be outside the quotes, which is consistent with Terraform's UI - // writing style.) - return last == '.' || last == '?' || last == '!' -} - // Output represents an "output" block in a module or file. type Output struct { Name string @@ -592,19 +481,6 @@ var variableBlockSchema = &hcl.BodySchema{ }, } -var variableValidationBlockSchema = &hcl.BodySchema{ - Attributes: []hcl.AttributeSchema{ - { - Name: "condition", - Required: true, - }, - { - Name: "error_message", - Required: true, - }, - }, -} - var outputBlockSchema = &hcl.BodySchema{ Attributes: []hcl.AttributeSchema{ { diff --git a/internal/terraform/node_root_variable_test.go b/internal/terraform/node_root_variable_test.go index aecb7428a203..ccf3b3e41a9f 100644 --- a/internal/terraform/node_root_variable_test.go +++ b/internal/terraform/node_root_variable_test.go @@ -79,7 +79,7 @@ func TestNodeRootVariableExecute(t *testing.T) { Name: "foo", Type: cty.Number, ConstraintType: cty.Number, - Validations: []*configs.VariableValidation{ + Validations: []*configs.CheckRule{ { Condition: fakeHCLExpressionFunc(func(ctx *hcl.EvalContext) (cty.Value, hcl.Diagnostics) { // This returns true only if the given variable value From 82c518209d5456d97330fea9e2d6a97ba76ffb35 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 20 Nov 2020 14:29:03 -0800 Subject: [PATCH 559/644] experiments: New "preconditions_postconditions" experiment --- internal/experiments/experiment.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/internal/experiments/experiment.go b/internal/experiments/experiment.go index 747e9adc9338..fcdcad8047c4 100644 --- a/internal/experiments/experiment.go +++ b/internal/experiments/experiment.go @@ -17,6 +17,7 @@ const ( ModuleVariableOptionalAttrs = Experiment("module_variable_optional_attrs") SuppressProviderSensitiveAttrs = Experiment("provider_sensitive_attrs") ConfigDrivenMove = Experiment("config_driven_move") + PreconditionsPostconditions = Experiment("preconditions_postconditions") ) func init() { @@ -26,6 +27,7 @@ func init() { registerConcludedExperiment(SuppressProviderSensitiveAttrs, "Provider-defined sensitive attributes are now redacted by default, without enabling an experiment.") registerConcludedExperiment(ConfigDrivenMove, "Declarations of moved resource instances using \"moved\" blocks can now be used by default, without enabling an experiment.") registerCurrentExperiment(ModuleVariableOptionalAttrs) + registerCurrentExperiment(PreconditionsPostconditions) } // GetCurrent takes an experiment name and returns the experiment value From 90764004363ccd80ed1ef775bf85253caab2d0b9 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 20 Nov 2020 14:56:21 -0800 Subject: [PATCH 560/644] configs: Decode preconditions and postconditions This allows precondition and postcondition checks to be declared for resources and output values as long as the preconditions_postconditions experiment is enabled. Terraform Core doesn't currently know anything about these features, so as of this commit declaring them does nothing at all. --- internal/configs/checks.go | 11 +++ internal/configs/experiments.go | 49 ++++++++++ internal/configs/named_values.go | 26 +++++ internal/configs/parser_config.go | 4 +- internal/configs/parser_config_test.go | 2 +- internal/configs/resource.go | 94 ++++++++++++++++--- .../precondition-postcondition-constant.tf | 34 +++++++ .../invalid-files/data-reserved-lifecycle.tf | 3 - .../invalid-files/data-resource-lifecycle.tf | 4 +- ...preconditions-postconditions-experiment.tf | 34 +++++++ ...preconditions-postconditions-experiment.tf | 38 ++++++++ 11 files changed, 279 insertions(+), 20 deletions(-) create mode 100644 internal/configs/testdata/error-files/precondition-postcondition-constant.tf delete mode 100644 internal/configs/testdata/invalid-files/data-reserved-lifecycle.tf create mode 100644 internal/configs/testdata/invalid-modules/preconditions-postconditions-experiment/preconditions-postconditions-experiment.tf create mode 100644 internal/configs/testdata/warning-files/preconditions-postconditions-experiment.tf diff --git a/internal/configs/checks.go b/internal/configs/checks.go index 31af8ae2fb09..8339640ccb39 100644 --- a/internal/configs/checks.go +++ b/internal/configs/checks.go @@ -64,6 +64,17 @@ func decodeCheckRuleBlock(block *hcl.Block, override bool) (*CheckRule, hcl.Diag if attr, exists := content.Attributes["condition"]; exists { cr.Condition = attr.Expr + + if len(cr.Condition.Variables()) == 0 { + // A condition expression that doesn't refer to any variable is + // pointless, because its result would always be a constant. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: fmt.Sprintf("Invalid %s expression", block.Type), + Detail: "The condition expression must refer to at least one object from elsewhere in the configuration, or else its result would not be checking anything.", + Subject: cr.Condition.Range().Ptr(), + }) + } } if attr, exists := content.Attributes["error_message"]; exists { diff --git a/internal/configs/experiments.go b/internal/configs/experiments.go index 2ebf2d7006f0..9175fd01fcc4 100644 --- a/internal/configs/experiments.go +++ b/internal/configs/experiments.go @@ -209,6 +209,55 @@ func checkModuleExperiments(m *Module) hcl.Diagnostics { } } + if !m.ActiveExperiments.Has(experiments.PreconditionsPostconditions) { + for _, r := range m.ManagedResources { + for _, c := range r.Preconditions { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Preconditions are experimental", + Detail: "The resource preconditions feature is currently an opt-in experiment, subject to change in future releases based on feedback.\n\nActivate the feature for this module by adding preconditions_postconditions to the list of active experiments.", + Subject: c.DeclRange.Ptr(), + }) + } + for _, c := range r.Postconditions { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Postconditions are experimental", + Detail: "The resource preconditions feature is currently an opt-in experiment, subject to change in future releases based on feedback.\n\nActivate the feature for this module by adding preconditions_postconditions to the list of active experiments.", + Subject: c.DeclRange.Ptr(), + }) + } + } + for _, r := range m.DataResources { + for _, c := range r.Preconditions { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Preconditions are experimental", + Detail: "The resource preconditions feature is currently an opt-in experiment, subject to change in future releases based on feedback.\n\nActivate the feature for this module by adding preconditions_postconditions to the list of active experiments.", + Subject: c.DeclRange.Ptr(), + }) + } + for _, c := range r.Postconditions { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Postconditions are experimental", + Detail: "The resource preconditions feature is currently an opt-in experiment, subject to change in future releases based on feedback.\n\nActivate the feature for this module by adding preconditions_postconditions to the list of active experiments.", + Subject: c.DeclRange.Ptr(), + }) + } + } + for _, o := range m.Outputs { + for _, c := range o.Preconditions { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Preconditions are experimental", + Detail: "The output value preconditions feature is currently an opt-in experiment, subject to change in future releases based on feedback.\n\nActivate the feature for this module by adding preconditions_postconditions to the list of active experiments.", + Subject: c.DeclRange.Ptr(), + }) + } + } + } + return diags } diff --git a/internal/configs/named_values.go b/internal/configs/named_values.go index 0213398851d8..970656511a41 100644 --- a/internal/configs/named_values.go +++ b/internal/configs/named_values.go @@ -356,6 +356,8 @@ type Output struct { DependsOn []hcl.Traversal Sensitive bool + Preconditions []*CheckRule + DescriptionSet bool SensitiveSet bool @@ -409,6 +411,26 @@ func decodeOutputBlock(block *hcl.Block, override bool) (*Output, hcl.Diagnostic o.DependsOn = append(o.DependsOn, deps...) } + for _, block := range content.Blocks { + switch block.Type { + case "precondition": + cr, moreDiags := decodeCheckRuleBlock(block, override) + diags = append(diags, moreDiags...) + o.Preconditions = append(o.Preconditions, cr) + case "postcondition": + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Postconditions are not allowed", + Detail: "Output values can only have preconditions, not postconditions.", + Subject: block.TypeRange.Ptr(), + }) + default: + // The cases above should be exhaustive for all block types + // defined in the block type schema, so this shouldn't happen. + panic(fmt.Sprintf("unexpected lifecycle sub-block type %q", block.Type)) + } + } + return o, diags } @@ -497,4 +519,8 @@ var outputBlockSchema = &hcl.BodySchema{ Name: "sensitive", }, }, + Blocks: []hcl.BlockHeaderSchema{ + {Type: "precondition"}, + {Type: "postcondition"}, + }, } diff --git a/internal/configs/parser_config.go b/internal/configs/parser_config.go index caebb89118af..0281339c6ef0 100644 --- a/internal/configs/parser_config.go +++ b/internal/configs/parser_config.go @@ -142,14 +142,14 @@ func (p *Parser) loadConfigFile(path string, override bool) (*File, hcl.Diagnost } case "resource": - cfg, cfgDiags := decodeResourceBlock(block) + cfg, cfgDiags := decodeResourceBlock(block, override) diags = append(diags, cfgDiags...) if cfg != nil { file.ManagedResources = append(file.ManagedResources, cfg) } case "data": - cfg, cfgDiags := decodeDataBlock(block) + cfg, cfgDiags := decodeDataBlock(block, override) diags = append(diags, cfgDiags...) if cfg != nil { file.DataResources = append(file.DataResources, cfg) diff --git a/internal/configs/parser_config_test.go b/internal/configs/parser_config_test.go index 7832914c9b0c..e1244ade1229 100644 --- a/internal/configs/parser_config_test.go +++ b/internal/configs/parser_config_test.go @@ -97,7 +97,7 @@ func TestParserLoadConfigFileFailureMessages(t *testing.T) { { "invalid-files/data-resource-lifecycle.tf", hcl.DiagError, - "Unsupported lifecycle block", + "Invalid data resource lifecycle argument", }, { "invalid-files/variable-type-unknown.tf", diff --git a/internal/configs/resource.go b/internal/configs/resource.go index ec38cf5ca910..0928f701e78f 100644 --- a/internal/configs/resource.go +++ b/internal/configs/resource.go @@ -22,6 +22,9 @@ type Resource struct { ProviderConfigRef *ProviderConfigRef Provider addrs.Provider + Preconditions []*CheckRule + Postconditions []*CheckRule + DependsOn []hcl.Traversal // Managed is populated only for Mode = addrs.ManagedResourceMode, @@ -81,7 +84,7 @@ func (r *Resource) ProviderConfigAddr() addrs.LocalProviderConfig { } } -func decodeResourceBlock(block *hcl.Block) (*Resource, hcl.Diagnostics) { +func decodeResourceBlock(block *hcl.Block, override bool) (*Resource, hcl.Diagnostics) { var diags hcl.Diagnostics r := &Resource{ Mode: addrs.ManagedResourceMode, @@ -237,6 +240,24 @@ func decodeResourceBlock(block *hcl.Block) (*Resource, hcl.Diagnostics) { } + for _, block := range lcContent.Blocks { + switch block.Type { + case "precondition", "postcondition": + cr, moreDiags := decodeCheckRuleBlock(block, override) + diags = append(diags, moreDiags...) + switch block.Type { + case "precondition": + r.Preconditions = append(r.Preconditions, cr) + case "postcondition": + r.Postconditions = append(r.Postconditions, cr) + } + default: + // The cases above should be exhaustive for all block types + // defined in the lifecycle schema, so this shouldn't happen. + panic(fmt.Sprintf("unexpected lifecycle sub-block type %q", block.Type)) + } + } + case "connection": if seenConnection != nil { diags = append(diags, &hcl.Diagnostic{ @@ -307,7 +328,7 @@ func decodeResourceBlock(block *hcl.Block) (*Resource, hcl.Diagnostics) { return r, diags } -func decodeDataBlock(block *hcl.Block) (*Resource, hcl.Diagnostics) { +func decodeDataBlock(block *hcl.Block, override bool) (*Resource, hcl.Diagnostics) { var diags hcl.Diagnostics r := &Resource{ Mode: addrs.DataResourceMode, @@ -368,6 +389,7 @@ func decodeDataBlock(block *hcl.Block) (*Resource, hcl.Diagnostics) { } var seenEscapeBlock *hcl.Block + var seenLifecycle *hcl.Block for _, block := range content.Blocks { switch block.Type { @@ -391,21 +413,59 @@ func decodeDataBlock(block *hcl.Block) (*Resource, hcl.Diagnostics) { // will see a blend of both. r.Config = hcl.MergeBodies([]hcl.Body{r.Config, block.Body}) - // The rest of these are just here to reserve block type names for future use. case "lifecycle": - diags = append(diags, &hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: "Unsupported lifecycle block", - Detail: "Data resources do not have lifecycle settings, so a lifecycle block is not allowed.", - Subject: &block.DefRange, - }) + if seenLifecycle != nil { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Duplicate lifecycle block", + Detail: fmt.Sprintf("This resource already has a lifecycle block at %s.", seenLifecycle.DefRange), + Subject: block.DefRange.Ptr(), + }) + continue + } + seenLifecycle = block + + lcContent, lcDiags := block.Body.Content(resourceLifecycleBlockSchema) + diags = append(diags, lcDiags...) + + // All of the attributes defined for resource lifecycle are for + // managed resources only, so we can emit a common error message + // for any given attributes that HCL accepted. + for name, attr := range lcContent.Attributes { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid data resource lifecycle argument", + Detail: fmt.Sprintf("The lifecycle argument %q is defined only for managed resources (\"resource\" blocks), and is not valid for data resources.", name), + Subject: attr.NameRange.Ptr(), + }) + } + + for _, block := range lcContent.Blocks { + switch block.Type { + case "precondition", "postcondition": + cr, moreDiags := decodeCheckRuleBlock(block, override) + diags = append(diags, moreDiags...) + switch block.Type { + case "precondition": + r.Preconditions = append(r.Preconditions, cr) + case "postcondition": + r.Postconditions = append(r.Postconditions, cr) + } + default: + // The cases above should be exhaustive for all block types + // defined in the lifecycle schema, so this shouldn't happen. + panic(fmt.Sprintf("unexpected lifecycle sub-block type %q", block.Type)) + } + } default: + // Any other block types are ones we're reserving for future use, + // but don't have any defined meaning today. diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagError, Summary: "Reserved block type name in data block", Detail: fmt.Sprintf("The block type name %q is reserved for use by Terraform in a future version.", block.Type), - Subject: &block.TypeRange, + Subject: block.TypeRange.Ptr(), }) } } @@ -551,13 +611,17 @@ var resourceBlockSchema = &hcl.BodySchema{ var dataBlockSchema = &hcl.BodySchema{ Attributes: commonResourceAttributes, Blocks: []hcl.BlockHeaderSchema{ - {Type: "lifecycle"}, // reserved for future use - {Type: "locals"}, // reserved for future use - {Type: "_"}, // meta-argument escaping block + {Type: "lifecycle"}, + {Type: "locals"}, // reserved for future use + {Type: "_"}, // meta-argument escaping block }, } var resourceLifecycleBlockSchema = &hcl.BodySchema{ + // We tell HCL that these elements are all valid for both "resource" + // and "data" lifecycle blocks, but the rules are actually more restrictive + // than that. We deal with that after decoding so that we can return + // more specific error messages than HCL would typically return itself. Attributes: []hcl.AttributeSchema{ { Name: "create_before_destroy", @@ -569,4 +633,8 @@ var resourceLifecycleBlockSchema = &hcl.BodySchema{ Name: "ignore_changes", }, }, + Blocks: []hcl.BlockHeaderSchema{ + {Type: "precondition"}, + {Type: "postcondition"}, + }, } diff --git a/internal/configs/testdata/error-files/precondition-postcondition-constant.tf b/internal/configs/testdata/error-files/precondition-postcondition-constant.tf new file mode 100644 index 000000000000..30f44313e374 --- /dev/null +++ b/internal/configs/testdata/error-files/precondition-postcondition-constant.tf @@ -0,0 +1,34 @@ +resource "test" "test" { + lifecycle { + precondition { + condition = true # ERROR: Invalid precondition expression + error_message = "Must be true." + } + postcondition { + condition = true # ERROR: Invalid postcondition expression + error_message = "Must be true." + } + } +} + +data "test" "test" { + lifecycle { + precondition { + condition = true # ERROR: Invalid precondition expression + error_message = "Must be true." + } + postcondition { + condition = true # ERROR: Invalid postcondition expression + error_message = "Must be true." + } + } +} + +output "test" { + value = "" + + precondition { + condition = true # ERROR: Invalid precondition expression + error_message = "Must be true." + } +} diff --git a/internal/configs/testdata/invalid-files/data-reserved-lifecycle.tf b/internal/configs/testdata/invalid-files/data-reserved-lifecycle.tf deleted file mode 100644 index a1e1a1e6e72f..000000000000 --- a/internal/configs/testdata/invalid-files/data-reserved-lifecycle.tf +++ /dev/null @@ -1,3 +0,0 @@ -data "test" "foo" { - lifecycle {} -} diff --git a/internal/configs/testdata/invalid-files/data-resource-lifecycle.tf b/internal/configs/testdata/invalid-files/data-resource-lifecycle.tf index b0c34d4633c9..7c1aebe5a0b1 100644 --- a/internal/configs/testdata/invalid-files/data-resource-lifecycle.tf +++ b/internal/configs/testdata/invalid-files/data-resource-lifecycle.tf @@ -1,5 +1,7 @@ data "example" "example" { lifecycle { - # This block intentionally left blank + # The lifecycle arguments are not valid for data resources: + # only the precondition and postcondition blocks are allowed. + ignore_changes = [] } } diff --git a/internal/configs/testdata/invalid-modules/preconditions-postconditions-experiment/preconditions-postconditions-experiment.tf b/internal/configs/testdata/invalid-modules/preconditions-postconditions-experiment/preconditions-postconditions-experiment.tf new file mode 100644 index 000000000000..8b63e77f3766 --- /dev/null +++ b/internal/configs/testdata/invalid-modules/preconditions-postconditions-experiment/preconditions-postconditions-experiment.tf @@ -0,0 +1,34 @@ +resource "test" "test" { + lifecycle { + precondition { # ERROR: Preconditions are experimental + condition = path.module != "" + error_message = "Must be true." + } + postcondition { # ERROR: Postconditions are experimental + condition = path.module != "" + error_message = "Must be true." + } + } +} + +data "test" "test" { + lifecycle { + precondition { # ERROR: Preconditions are experimental + condition = path.module != "" + error_message = "Must be true." + } + postcondition { # ERROR: Postconditions are experimental + condition = path.module != "" + error_message = "Must be true." + } + } +} + +output "test" { + value = "" + + precondition { # ERROR: Preconditions are experimental + condition = path.module != "" + error_message = "Must be true." + } +} diff --git a/internal/configs/testdata/warning-files/preconditions-postconditions-experiment.tf b/internal/configs/testdata/warning-files/preconditions-postconditions-experiment.tf new file mode 100644 index 000000000000..35dac3472c13 --- /dev/null +++ b/internal/configs/testdata/warning-files/preconditions-postconditions-experiment.tf @@ -0,0 +1,38 @@ +terraform { + experiments = [preconditions_postconditions] # WARNING: Experimental feature "preconditions_postconditions" is active +} + +resource "test" "test" { + lifecycle { + precondition { + condition = path.module != "" + error_message = "Must be true." + } + postcondition { + condition = path.module != "" + error_message = "Must be true." + } + } +} + +data "test" "test" { + lifecycle { + precondition { + condition = path.module != "" + error_message = "Must be true." + } + postcondition { + condition = path.module != "" + error_message = "Must be true." + } + } +} + +output "test" { + value = "" + + precondition { + condition = path.module != "" + error_message = "Must be true." + } +} From c827c049fe688f3ad2b705aa1adf8a72bbcec37c Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 20 Nov 2020 15:10:08 -0800 Subject: [PATCH 561/644] terraform: Precondition and postcondition blocks generate dependencies If a resource or output value has a precondition or postcondition rule then anything the condition depends on is a dependency of the object, because the condition rules will be evaluated as part of visiting the relevant graph node. --- internal/terraform/node_output.go | 5 ++++- internal/terraform/node_resource_abstract.go | 10 ++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/internal/terraform/node_output.go b/internal/terraform/node_output.go index 93ff30aae8b4..0532a3d61cf6 100644 --- a/internal/terraform/node_output.go +++ b/internal/terraform/node_output.go @@ -237,8 +237,11 @@ func referencesForOutput(c *configs.Output) []*addrs.Reference { refs := make([]*addrs.Reference, 0, l) refs = append(refs, impRefs...) refs = append(refs, expRefs...) + for _, check := range c.Preconditions { + checkRefs, _ := lang.ReferencesInExpr(check.Condition) + refs = append(refs, checkRefs...) + } return refs - } // GraphNodeReferencer diff --git a/internal/terraform/node_resource_abstract.go b/internal/terraform/node_resource_abstract.go index fb3f4a945b4d..bc22d4be78b6 100644 --- a/internal/terraform/node_resource_abstract.go +++ b/internal/terraform/node_resource_abstract.go @@ -172,6 +172,16 @@ func (n *NodeAbstractResource) References() []*addrs.Reference { result = append(result, refs...) } } + + for _, check := range c.Preconditions { + refs, _ := lang.ReferencesInExpr(check.Condition) + result = append(result, refs...) + } + for _, check := range c.Postconditions { + refs, _ := lang.ReferencesInExpr(check.Condition) + result = append(result, refs...) + } + return result } From 6e80276cc9dd11b42240c57e6441e852c92891fb Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 28 Jan 2022 14:44:56 -0500 Subject: [PATCH 562/644] Remove invisible space --- website/docs/cli/commands/taint.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/taint.mdx b/website/docs/cli/commands/taint.mdx index 40ac0526db6a..b37a34b3eb1c 100644 --- a/website/docs/cli/commands/taint.mdx +++ b/website/docs/cli/commands/taint.mdx @@ -16,7 +16,7 @@ propose to replace it in the next plan you create. ## Recommended Alternative -For Terraform v0.15.2 and later, we recommend using the [`-replace` option](/cli/commands/plan#replace-address) with `terraform apply` to force Terraform to replace an object even though there are no configuration changes that would require it. +For Terraform v0.15.2 and later, we recommend using the [`-replace` option](/cli/commands/plan#replace-address) with `terraform apply` to force Terraform to replace an object even though there are no configuration changes that would require it. ``` $ terraform apply -replace="aws_instance.example[0]" From a2f83ef7b61e14d858c87f0b25b769852a6c86a3 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Fri, 28 Jan 2022 15:28:35 -0500 Subject: [PATCH 563/644] Try to fix wording so it's clearer and more cohesive --- website/docs/cli/commands/plan.mdx | 44 ++++++++---------------------- 1 file changed, 11 insertions(+), 33 deletions(-) diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index d36611f9aab2..e59297981274 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -138,46 +138,25 @@ the previous section, are also available with the same meanings on `terraform apply`. - `-refresh=false` - Disables the default behavior of synchronizing the - Terraform state with remote objects before checking for configuration changes. + Terraform state with remote objects before checking for configuration changes. This can make the planning operation faster by reducing the number of remote API requests. However, setting `refresh=false` causes Terraform to ignore external changes, which could result in an incomplete or incorrect plan. - This option can potentially make the planning operation faster by reducing - the number of remote API requests, but it comes at the expense of having - Terraform not take into account any changes that might've happened outside - of Terraform, and thus the resulting plan may not be complete or correct. + -> **Note:** You cannot use `refresh=false` in "refresh only" planning mode, because it would effectively disable the entirety of the planning operation. - This option is not available in the "refresh only" planning mode, because - it would effectively disable the entirety of the planning operation in that - case. +- `-replace=ADDRESS` - Instructs Terraform to plan to replace the + resource instance with the given address. This is helpful when one or more remote objects have become degraded, and you can use replacement objects with the same configuratation to align with immutable infrastructure patterns. Terraform will use a "replace" action if the specified resource would normally cause an "update" action or no action at all. Use this option multiple times to replace several objects at once. -- `-replace=ADDRESS` - Instructs Terraform to plan to replace the single - resource instance with the given address. If the given instance would - normally have caused only an "update" action, or no action at all, then - Terraform will choose a "replace" action instead. - - You can use this option if you have learned that one or more remote objects - have become degraded in some way. Add multiple `-replace` flags to replace several objects at once. If you are using immutable infrastructure patterns, you may wish to replace the malfunctioning objects with new objects that have the same configuration. - - This option is allowed only in the normal planning mode, so this option - is incompatible with the `-destroy` option. - - The `-replace=...` option is available only from Terraform v0.15.2 onwards. - For earlier versions, you can achieve a similar effect (with some caveats) - using [`terraform taint`](/cli/commands/taint). + -> **Note:** You cannot use `-replace` with the `-destroy` option, and it is only available from Terraform v0.15.2 onwards. For earlier versions, use [`terraform taint`](/cli/commands/taint) to achieve a similar result. - `-target=ADDRESS` - Instructs Terraform to focus its planning efforts only on resource instances which match the given address and on any objects that - those instances depend on. - - This command is for exceptional use only. See - [Resource Targeting](#resource-targeting) - below for more information. + those instances depend on. This command is for exceptional use only. Refer to + [Resource Targeting](#resource-targeting) for more information. - `-var 'NAME=VALUE'` - Sets a value for a single [input variable](/language/values/variables) declared in the root module of the configuration. Use this option multiple times to set - more than one variable. For more information see - [Input Variables on the Command Line](#input-variables-on-the-command-line), - below. + more than one variable. Refer to + [Input Variables on the Command Line](#input-variables-on-the-command-line) for more information. - `-var-file=FILENAME` - Sets values for potentially many [input variables](/language/values/variables) declared in the @@ -186,9 +165,8 @@ the previous section, are also available with the same meanings on Use this option multiple times to include values from more than one file. There are several other ways to set values for input variables in the root -module, aside from the `-var` and `-var-file` options. For more information, -see -[Assigning Values to Root Module Variables](/language/values/variables#assigning-values-to-root-module-variables). +module, aside from the `-var` and `-var-file` options. Refer to +[Assigning Values to Root Module Variables](/language/values/variables#assigning-values-to-root-module-variables) for more information. ### Input Variables on the Command Line From 5573868cd0ef7add96487b5327fc8ba39a2a9eee Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Fri, 20 Nov 2020 16:03:11 -0800 Subject: [PATCH 564/644] core: Check pre- and postconditions for resources and output values If the configuration contains preconditions and/or postconditions for any objects, we'll check them during evaluation of those objects and generate errors if any do not pass. The handling of post-conditions is particularly interesting here because we intentionally evaluate them _after_ we've committed our record of the resulting side-effects to the state/plan, with the intent that future plans against the same object will keep failing until the problem is addressed either by changing the object so it would pass the precondition or changing the precondition to accept the current object. That then avoids the need for us to proactively taint managed resources whose postconditions fail, as we would for provisioner failures: instead, we can leave the resolution approach up to the user to decide. Co-authored-by: Alisdair McDiarmid --- internal/terraform/eval_conditions.go | 115 ++++++++++++++ internal/terraform/node_output.go | 10 ++ .../node_resource_abstract_instance.go | 148 +++++++++++------- .../terraform/node_resource_apply_instance.go | 31 +++- internal/terraform/node_resource_destroy.go | 2 +- .../node_resource_destroy_deposed.go | 2 +- .../terraform/node_resource_plan_instance.go | 29 +++- 7 files changed, 277 insertions(+), 60 deletions(-) create mode 100644 internal/terraform/eval_conditions.go diff --git a/internal/terraform/eval_conditions.go b/internal/terraform/eval_conditions.go new file mode 100644 index 000000000000..302f88160830 --- /dev/null +++ b/internal/terraform/eval_conditions.go @@ -0,0 +1,115 @@ +package terraform + +import ( + "fmt" + "log" + + "github.com/hashicorp/hcl/v2" + "github.com/zclconf/go-cty/cty" + "github.com/zclconf/go-cty/cty/convert" + + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/instances" + "github.com/hashicorp/terraform/internal/lang" + "github.com/hashicorp/terraform/internal/tfdiags" +) + +type checkType int + +const ( + checkInvalid checkType = 0 + checkResourcePrecondition checkType = 1 + checkResourcePostcondition checkType = 2 + checkOutputPrecondition checkType = 3 +) + +func (c checkType) FailureSummary() string { + switch c { + case checkResourcePrecondition: + return "Resource precondition failed" + case checkResourcePostcondition: + return "Resource postcondition failed" + case checkOutputPrecondition: + return "Module output value precondition failed" + default: + // This should not happen + return "Failed condition for invalid check type" + } +} + +// evalCheckRules ensures that all of the given check rules pass against +// the given HCL evaluation context. +// +// If any check rules produce an unknown result then they will be silently +// ignored on the assumption that the same checks will be run again later +// with fewer unknown values in the EvalContext. +// +// If any of the rules do not pass, the returned diagnostics will contain +// errors. Otherwise, it will either be empty or contain only warnings. +func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, self addrs.Referenceable, keyData instances.RepetitionData) (diags tfdiags.Diagnostics) { + if len(rules) == 0 { + // Nothing to do + return nil + } + + for _, rule := range rules { + const errInvalidCondition = "Invalid condition result" + var ruleDiags tfdiags.Diagnostics + + refs, moreDiags := lang.ReferencesInExpr(rule.Condition) + ruleDiags = ruleDiags.Append(moreDiags) + scope := ctx.EvaluationScope(self, keyData) + hclCtx, moreDiags := scope.EvalContext(refs) + ruleDiags = ruleDiags.Append(moreDiags) + + result, hclDiags := rule.Condition.Value(hclCtx) + ruleDiags = ruleDiags.Append(hclDiags) + diags = diags.Append(ruleDiags) + + if ruleDiags.HasErrors() { + log.Printf("[TRACE] evalCheckRules: %s: %s", typ.FailureSummary(), ruleDiags.Err().Error()) + } + + if !result.IsKnown() { + continue // We'll wait until we've learned more, then. + } + if result.IsNull() { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errInvalidCondition, + Detail: "Condition expression must return either true or false, not null.", + Subject: rule.Condition.Range().Ptr(), + Expression: rule.Condition, + EvalContext: hclCtx, + }) + continue + } + var err error + result, err = convert.Convert(result, cty.Bool) + if err != nil { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errInvalidCondition, + Detail: fmt.Sprintf("Invalid validation condition result value: %s.", tfdiags.FormatError(err)), + Subject: rule.Condition.Range().Ptr(), + Expression: rule.Condition, + EvalContext: hclCtx, + }) + continue + } + + if result.False() { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: typ.FailureSummary(), + Detail: rule.ErrorMessage, + Subject: rule.Condition.Range().Ptr(), + Expression: rule.Condition, + EvalContext: hclCtx, + }) + } + } + + return diags +} diff --git a/internal/terraform/node_output.go b/internal/terraform/node_output.go index 0532a3d61cf6..e8d72a9110ba 100644 --- a/internal/terraform/node_output.go +++ b/internal/terraform/node_output.go @@ -270,6 +270,16 @@ func (n *NodeApplyableOutput) Execute(ctx EvalContext, op walkOperation) (diags } } + checkDiags := evalCheckRules( + checkOutputPrecondition, + n.Config.Preconditions, + ctx, nil, EvalDataForNoInstanceKey, + ) + diags = diags.Append(checkDiags) + if diags.HasErrors() { + return diags // failed preconditions prevent further evaluation + } + // If there was no change recorded, or the recorded change was not wholly // known, then we need to re-evaluate the output if !changeRecorded || !val.IsWhollyKnown() { diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index 91b24cd669b8..f362758dc280 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -9,6 +9,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" + "github.com/hashicorp/terraform/internal/instances" "github.com/hashicorp/terraform/internal/plans" "github.com/hashicorp/terraform/internal/plans/objchange" "github.com/hashicorp/terraform/internal/providers" @@ -638,16 +639,17 @@ func (n *NodeAbstractResourceInstance) plan( plannedChange *plans.ResourceInstanceChange, currentState *states.ResourceInstanceObject, createBeforeDestroy bool, - forceReplace []addrs.AbsResourceInstance) (*plans.ResourceInstanceChange, *states.ResourceInstanceObject, tfdiags.Diagnostics) { + forceReplace []addrs.AbsResourceInstance) (*plans.ResourceInstanceChange, *states.ResourceInstanceObject, instances.RepetitionData, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics var state *states.ResourceInstanceObject var plan *plans.ResourceInstanceChange + var keyData instances.RepetitionData config := *n.Config resource := n.Addr.Resource.Resource provider, providerSchema, err := getProvider(ctx, n.ResolvedProvider) if err != nil { - return plan, state, diags.Append(err) + return plan, state, keyData, diags.Append(err) } if plannedChange != nil { @@ -657,7 +659,7 @@ func (n *NodeAbstractResourceInstance) plan( if providerSchema == nil { diags = diags.Append(fmt.Errorf("provider schema is unavailable for %s", n.Addr)) - return plan, state, diags + return plan, state, keyData, diags } // Evaluate the configuration @@ -665,22 +667,33 @@ func (n *NodeAbstractResourceInstance) plan( if schema == nil { // Should be caught during validation, so we don't bother with a pretty error here diags = diags.Append(fmt.Errorf("provider does not support resource type %q", resource.Type)) - return plan, state, diags + return plan, state, keyData, diags } forEach, _ := evaluateForEachExpression(n.Config.ForEach, ctx) - keyData := EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) + keyData = EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) + + checkDiags := evalCheckRules( + checkResourcePrecondition, + n.Config.Preconditions, + ctx, nil, keyData, + ) + diags = diags.Append(checkDiags) + if diags.HasErrors() { + return plan, state, keyData, diags // failed preconditions prevent further evaluation + } + origConfigVal, _, configDiags := ctx.EvaluateBlock(config.Config, schema, nil, keyData) diags = diags.Append(configDiags) if configDiags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } metaConfigVal, metaDiags := n.providerMetas(ctx) diags = diags.Append(metaDiags) if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } var priorVal cty.Value @@ -723,7 +736,7 @@ func (n *NodeAbstractResourceInstance) plan( ) diags = diags.Append(validateResp.Diagnostics.InConfigBody(config.Config, n.Addr.String())) if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } // ignore_changes is meant to only apply to the configuration, so it must @@ -736,7 +749,7 @@ func (n *NodeAbstractResourceInstance) plan( configValIgnored, ignoreChangeDiags := n.processIgnoreChanges(priorVal, origConfigVal) diags = diags.Append(ignoreChangeDiags) if ignoreChangeDiags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } // Create an unmarked version of our config val and our prior val. @@ -752,7 +765,7 @@ func (n *NodeAbstractResourceInstance) plan( return h.PreDiff(n.Addr, states.CurrentGen, priorVal, proposedNewVal) })) if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } resp := provider.PlanResourceChange(providers.PlanResourceChangeRequest{ @@ -765,7 +778,7 @@ func (n *NodeAbstractResourceInstance) plan( }) diags = diags.Append(resp.Diagnostics.InConfigBody(config.Config, n.Addr.String())) if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } plannedNewVal := resp.PlannedState @@ -793,7 +806,7 @@ func (n *NodeAbstractResourceInstance) plan( )) } if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } if errs := objchange.AssertPlanValid(schema, unmarkedPriorVal, unmarkedConfigVal, plannedNewVal); len(errs) > 0 { @@ -823,7 +836,7 @@ func (n *NodeAbstractResourceInstance) plan( ), )) } - return plan, state, diags + return plan, state, keyData, diags } } @@ -840,7 +853,7 @@ func (n *NodeAbstractResourceInstance) plan( plannedNewVal, ignoreChangeDiags = n.processIgnoreChanges(unmarkedPriorVal, plannedNewVal) diags = diags.Append(ignoreChangeDiags) if ignoreChangeDiags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } } @@ -907,7 +920,7 @@ func (n *NodeAbstractResourceInstance) plan( } } if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } } @@ -1001,7 +1014,7 @@ func (n *NodeAbstractResourceInstance) plan( // append these new diagnostics if there's at least one error inside. if resp.Diagnostics.HasErrors() { diags = diags.Append(resp.Diagnostics.InConfigBody(config.Config, n.Addr.String())) - return plan, state, diags + return plan, state, keyData, diags } plannedNewVal = resp.PlannedState plannedPrivate = resp.PlannedPrivate @@ -1021,7 +1034,7 @@ func (n *NodeAbstractResourceInstance) plan( )) } if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } } @@ -1064,7 +1077,7 @@ func (n *NodeAbstractResourceInstance) plan( return h.PostDiff(n.Addr, states.CurrentGen, action, priorVal, plannedNewVal) })) if diags.HasErrors() { - return plan, state, diags + return plan, state, keyData, diags } // Update our return plan @@ -1098,7 +1111,7 @@ func (n *NodeAbstractResourceInstance) plan( Private: plannedPrivate, } - return plan, state, diags + return plan, state, keyData, diags } func (n *NodeAbstractResource) processIgnoreChanges(prior, config cty.Value) (cty.Value, tfdiags.Diagnostics) { @@ -1470,16 +1483,17 @@ func (n *NodeAbstractResourceInstance) providerMetas(ctx EvalContext) (cty.Value // value, but it still matches the previous state, then we can record a NoNop // change. If the states don't match then we record a Read change so that the // new value is applied to the state. -func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentState *states.ResourceInstanceObject) (*plans.ResourceInstanceChange, *states.ResourceInstanceObject, tfdiags.Diagnostics) { +func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentState *states.ResourceInstanceObject) (*plans.ResourceInstanceChange, *states.ResourceInstanceObject, instances.RepetitionData, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics + var keyData instances.RepetitionData var configVal cty.Value _, providerSchema, err := getProvider(ctx, n.ResolvedProvider) if err != nil { - return nil, nil, diags.Append(err) + return nil, nil, keyData, diags.Append(err) } if providerSchema == nil { - return nil, nil, diags.Append(fmt.Errorf("provider schema not available for %s", n.Addr)) + return nil, nil, keyData, diags.Append(fmt.Errorf("provider schema not available for %s", n.Addr)) } config := *n.Config @@ -1487,7 +1501,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt if schema == nil { // Should be caught during validation, so we don't bother with a pretty error here diags = diags.Append(fmt.Errorf("provider %q does not support data source %q", n.ResolvedProvider, n.Addr.ContainingResource().Resource.Type)) - return nil, nil, diags + return nil, nil, keyData, diags } objTy := schema.ImpliedType() @@ -1497,13 +1511,26 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt } forEach, _ := evaluateForEachExpression(config.ForEach, ctx) - keyData := EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) + keyData = EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) + + checkDiags := evalCheckRules( + checkResourcePrecondition, + n.Config.Preconditions, + ctx, nil, keyData, + ) + diags = diags.Append(checkDiags) + if diags.HasErrors() { + diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { + return h.PostApply(n.Addr, states.CurrentGen, priorVal, diags.Err()) + })) + return nil, nil, keyData, diags // failed preconditions prevent further evaluation + } var configDiags tfdiags.Diagnostics configVal, _, configDiags = ctx.EvaluateBlock(config.Config, schema, nil, keyData) diags = diags.Append(configDiags) if configDiags.HasErrors() { - return nil, nil, diags + return nil, nil, keyData, diags } unmarkedConfigVal, configMarkPaths := configVal.UnmarkDeepWithPaths() @@ -1529,7 +1556,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt return h.PreDiff(n.Addr, states.CurrentGen, priorVal, proposedNewVal) })) if diags.HasErrors() { - return nil, nil, diags + return nil, nil, keyData, diags } proposedNewVal = proposedNewVal.MarkWithPaths(configMarkPaths) @@ -1555,7 +1582,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt return h.PostDiff(n.Addr, states.CurrentGen, plans.Read, priorVal, proposedNewVal) })) - return plannedChange, plannedNewState, diags + return plannedChange, plannedNewState, keyData, diags } // While this isn't a "diff", continue to call this for data sources. @@ -1563,14 +1590,14 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt return h.PreDiff(n.Addr, states.CurrentGen, priorVal, configVal) })) if diags.HasErrors() { - return nil, nil, diags + return nil, nil, keyData, diags } // We have a complete configuration with no dependencies to wait on, so we // can read the data source into the state. newVal, readDiags := n.readDataSource(ctx, configVal) diags = diags.Append(readDiags) if diags.HasErrors() { - return nil, nil, diags + return nil, nil, keyData, diags } // if we have a prior value, we can check for any irregularities in the response @@ -1603,7 +1630,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { return h.PostDiff(n.Addr, states.CurrentGen, plans.Update, priorVal, newVal) })) - return nil, plannedNewState, diags + return nil, plannedNewState, keyData, diags } // forcePlanReadData determines if we need to override the usual behavior of @@ -1649,15 +1676,16 @@ func (n *NodeAbstractResourceInstance) forcePlanReadData(ctx EvalContext) bool { // apply deals with the main part of the data resource lifecycle: either // actually reading from the data source or generating a plan to do so. -func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned *plans.ResourceInstanceChange) (*states.ResourceInstanceObject, tfdiags.Diagnostics) { +func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned *plans.ResourceInstanceChange) (*states.ResourceInstanceObject, instances.RepetitionData, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics + var keyData instances.RepetitionData _, providerSchema, err := getProvider(ctx, n.ResolvedProvider) if err != nil { - return nil, diags.Append(err) + return nil, keyData, diags.Append(err) } if providerSchema == nil { - return nil, diags.Append(fmt.Errorf("provider schema not available for %s", n.Addr)) + return nil, keyData, diags.Append(fmt.Errorf("provider schema not available for %s", n.Addr)) } if planned != nil && planned.Action != plans.Read { @@ -1667,14 +1695,14 @@ func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned "invalid action %s for %s: only Read is supported (this is a bug in Terraform; please report it!)", planned.Action, n.Addr, )) - return nil, diags + return nil, keyData, diags } diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { return h.PreApply(n.Addr, states.CurrentGen, planned.Action, planned.Before, planned.After) })) if diags.HasErrors() { - return nil, diags + return nil, keyData, diags } config := *n.Config @@ -1682,22 +1710,35 @@ func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned if schema == nil { // Should be caught during validation, so we don't bother with a pretty error here diags = diags.Append(fmt.Errorf("provider %q does not support data source %q", n.ResolvedProvider, n.Addr.ContainingResource().Resource.Type)) - return nil, diags + return nil, keyData, diags } forEach, _ := evaluateForEachExpression(config.ForEach, ctx) - keyData := EvalDataForInstanceKey(n.Addr.Resource.Key, forEach) + keyData = EvalDataForInstanceKey(n.Addr.Resource.Key, forEach) + + checkDiags := evalCheckRules( + checkResourcePrecondition, + n.Config.Preconditions, + ctx, nil, keyData, + ) + diags = diags.Append(checkDiags) + if diags.HasErrors() { + diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { + return h.PostApply(n.Addr, states.CurrentGen, planned.Before, diags.Err()) + })) + return nil, keyData, diags // failed preconditions prevent further evaluation + } configVal, _, configDiags := ctx.EvaluateBlock(config.Config, schema, nil, keyData) diags = diags.Append(configDiags) if configDiags.HasErrors() { - return nil, diags + return nil, keyData, diags } newVal, readDiags := n.readDataSource(ctx, configVal) diags = diags.Append(readDiags) if diags.HasErrors() { - return nil, diags + return nil, keyData, diags } state := &states.ResourceInstanceObject{ @@ -1709,7 +1750,7 @@ func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned return h.PostApply(n.Addr, states.CurrentGen, newVal, diags.Err()) })) - return state, diags + return state, keyData, diags } // evalApplyProvisioners determines if provisioners need to be run, and if so @@ -1981,22 +2022,23 @@ func (n *NodeAbstractResourceInstance) apply( state *states.ResourceInstanceObject, change *plans.ResourceInstanceChange, applyConfig *configs.Resource, - createBeforeDestroy bool) (*states.ResourceInstanceObject, tfdiags.Diagnostics) { + createBeforeDestroy bool) (*states.ResourceInstanceObject, instances.RepetitionData, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics + var keyData instances.RepetitionData if state == nil { state = &states.ResourceInstanceObject{} } provider, providerSchema, err := getProvider(ctx, n.ResolvedProvider) if err != nil { - return nil, diags.Append(err) + return nil, keyData, diags.Append(err) } schema, _ := providerSchema.SchemaForResourceType(n.Addr.Resource.Resource.Mode, n.Addr.Resource.Resource.Type) if schema == nil { // Should be caught during validation, so we don't bother with a pretty error here diags = diags.Append(fmt.Errorf("provider does not support resource type %q", n.Addr.Resource.Resource.Type)) - return nil, diags + return nil, keyData, diags } log.Printf("[INFO] Starting apply for %s", n.Addr) @@ -2005,11 +2047,11 @@ func (n *NodeAbstractResourceInstance) apply( if applyConfig != nil { var configDiags tfdiags.Diagnostics forEach, _ := evaluateForEachExpression(applyConfig.ForEach, ctx) - keyData := EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) + keyData = EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) configVal, _, configDiags = ctx.EvaluateBlock(applyConfig.Config, schema, nil, keyData) diags = diags.Append(configDiags) if configDiags.HasErrors() { - return nil, diags + return nil, keyData, diags } } @@ -2018,13 +2060,13 @@ func (n *NodeAbstractResourceInstance) apply( "configuration for %s still contains unknown values during apply (this is a bug in Terraform; please report it!)", n.Addr, )) - return nil, diags + return nil, keyData, diags } metaConfigVal, metaDiags := n.providerMetas(ctx) diags = diags.Append(metaDiags) if diags.HasErrors() { - return nil, diags + return nil, keyData, diags } log.Printf("[DEBUG] %s: applying the planned %s change", n.Addr, change.Action) @@ -2052,7 +2094,7 @@ func (n *NodeAbstractResourceInstance) apply( Status: state.Status, Value: change.After, } - return newState, diags + return newState, keyData, diags } resp := provider.ApplyResourceChange(providers.ApplyResourceChangeRequest{ @@ -2123,7 +2165,7 @@ func (n *NodeAbstractResourceInstance) apply( // Bail early in this particular case, because an object that doesn't // conform to the schema can't be saved in the state anyway -- the // serializer will reject it. - return nil, diags + return nil, keyData, diags } // After this point we have a type-conforming result object and so we @@ -2249,7 +2291,7 @@ func (n *NodeAbstractResourceInstance) apply( // prior state as the new value, making this effectively a no-op. If // the item really _has_ been deleted then our next refresh will detect // that and fix it up. - return state.DeepCopy(), diags + return state.DeepCopy(), keyData, diags case diags.HasErrors() && !newVal.IsNull(): // if we have an error, make sure we restore the object status in the new state @@ -2266,7 +2308,7 @@ func (n *NodeAbstractResourceInstance) apply( newState.Dependencies = state.Dependencies } - return newState, diags + return newState, keyData, diags case !newVal.IsNull(): // Non error case with a new state @@ -2276,11 +2318,11 @@ func (n *NodeAbstractResourceInstance) apply( Private: resp.Private, CreateBeforeDestroy: createBeforeDestroy, } - return newState, diags + return newState, keyData, diags default: // Non error case, were the object was deleted - return nil, diags + return nil, keyData, diags } } diff --git a/internal/terraform/node_resource_apply_instance.go b/internal/terraform/node_resource_apply_instance.go index 6835f5e0417d..aa9237b9b2a4 100644 --- a/internal/terraform/node_resource_apply_instance.go +++ b/internal/terraform/node_resource_apply_instance.go @@ -160,7 +160,7 @@ func (n *NodeApplyableResourceInstance) dataResourceExecute(ctx EvalContext) (di // In this particular call to applyDataSource we include our planned // change, which signals that we expect this read to complete fully // with no unknown values; it'll produce an error if not. - state, applyDiags := n.applyDataSource(ctx, change) + state, repeatData, applyDiags := n.applyDataSource(ctx, change) diags = diags.Append(applyDiags) if diags.HasErrors() { return diags @@ -174,6 +174,19 @@ func (n *NodeApplyableResourceInstance) dataResourceExecute(ctx EvalContext) (di diags = diags.Append(n.writeChange(ctx, nil, "")) diags = diags.Append(updateStateHook(ctx)) + + // Post-conditions might block further progress. We intentionally do this + // _after_ writing the state/diff because we want to check against + // the result of the operation, and to fail on future operations + // until the user makes the condition succeed. + checkDiags := evalCheckRules( + checkResourcePostcondition, + n.Config.Postconditions, + ctx, n.ResourceInstanceAddr().Resource, + repeatData, + ) + diags = diags.Append(checkDiags) + return diags } @@ -238,7 +251,7 @@ func (n *NodeApplyableResourceInstance) managedResourceExecute(ctx EvalContext) // Make a new diff, in case we've learned new values in the state // during apply which we can now incorporate. - diffApply, _, planDiags := n.plan(ctx, diff, state, false, n.forceReplace) + diffApply, _, _, planDiags := n.plan(ctx, diff, state, false, n.forceReplace) diags = diags.Append(planDiags) if diags.HasErrors() { return diags @@ -269,7 +282,7 @@ func (n *NodeApplyableResourceInstance) managedResourceExecute(ctx EvalContext) return diags } - state, applyDiags := n.apply(ctx, state, diffApply, n.Config, n.CreateBeforeDestroy()) + state, repeatData, applyDiags := n.apply(ctx, state, diffApply, n.Config, n.CreateBeforeDestroy()) diags = diags.Append(applyDiags) // We clear the change out here so that future nodes don't see a change @@ -339,6 +352,18 @@ func (n *NodeApplyableResourceInstance) managedResourceExecute(ctx EvalContext) diags = diags.Append(n.postApplyHook(ctx, state, diags.Err())) diags = diags.Append(updateStateHook(ctx)) + + // Post-conditions might block further progress. We intentionally do this + // _after_ writing the state because we want to check against + // the result of the operation, and to fail on future operations + // until the user makes the condition succeed. + checkDiags := evalCheckRules( + checkResourcePostcondition, + n.Config.Postconditions, + ctx, addr, repeatData, + ) + diags = diags.Append(checkDiags) + return diags } diff --git a/internal/terraform/node_resource_destroy.go b/internal/terraform/node_resource_destroy.go index 8dd9e21b946e..d0cc7276bb2a 100644 --- a/internal/terraform/node_resource_destroy.go +++ b/internal/terraform/node_resource_destroy.go @@ -210,7 +210,7 @@ func (n *NodeDestroyResourceInstance) managedResourceExecute(ctx EvalContext) (d // Managed resources need to be destroyed, while data sources // are only removed from state. // we pass a nil configuration to apply because we are destroying - s, d := n.apply(ctx, state, changeApply, nil, false) + s, _, d := n.apply(ctx, state, changeApply, nil, false) state, diags = s, diags.Append(d) // we don't return immediately here on error, so that the state can be // finalized diff --git a/internal/terraform/node_resource_destroy_deposed.go b/internal/terraform/node_resource_destroy_deposed.go index 7d639d135c66..2c042386a380 100644 --- a/internal/terraform/node_resource_destroy_deposed.go +++ b/internal/terraform/node_resource_destroy_deposed.go @@ -249,7 +249,7 @@ func (n *NodeDestroyDeposedResourceInstanceObject) Execute(ctx EvalContext, op w } // we pass a nil configuration to apply because we are destroying - state, applyDiags := n.apply(ctx, state, change, nil, false) + state, _, applyDiags := n.apply(ctx, state, change, nil, false) diags = diags.Append(applyDiags) // don't return immediately on errors, we need to handle the state diff --git a/internal/terraform/node_resource_plan_instance.go b/internal/terraform/node_resource_plan_instance.go index 2006355668bd..df61ad61d92a 100644 --- a/internal/terraform/node_resource_plan_instance.go +++ b/internal/terraform/node_resource_plan_instance.go @@ -95,7 +95,7 @@ func (n *NodePlannableResourceInstance) dataResourceExecute(ctx EvalContext) (di return diags } - change, state, planDiags := n.planDataSource(ctx, state) + change, state, repeatData, planDiags := n.planDataSource(ctx, state) diags = diags.Append(planDiags) if diags.HasErrors() { return diags @@ -113,6 +113,18 @@ func (n *NodePlannableResourceInstance) dataResourceExecute(ctx EvalContext) (di } diags = diags.Append(n.writeChange(ctx, change, "")) + + // Post-conditions might block further progress. We intentionally do this + // _after_ writing the state/diff because we want to check against + // the result of the operation, and to fail on future operations + // until the user makes the condition succeed. + checkDiags := evalCheckRules( + checkResourcePostcondition, + n.Config.Postconditions, + ctx, addr.Resource, repeatData, + ) + diags = diags.Append(checkDiags) + return diags } @@ -193,7 +205,7 @@ func (n *NodePlannableResourceInstance) managedResourceExecute(ctx EvalContext) // Plan the instance, unless we're in the refresh-only mode if !n.skipPlanChanges { - change, instancePlanState, planDiags := n.plan( + change, instancePlanState, repeatData, planDiags := n.plan( ctx, change, instanceRefreshState, n.ForceCreateBeforeDestroy, n.forceReplace, ) diags = diags.Append(planDiags) @@ -240,6 +252,19 @@ func (n *NodePlannableResourceInstance) managedResourceExecute(ctx EvalContext) return diags } } + + // Post-conditions might block completion. We intentionally do this + // _after_ writing the state/diff because we want to check against + // the result of the operation, and to fail on future operations + // until the user makes the condition succeed. + // (Note that some preconditions will end up being skipped during + // planning, because their conditions depend on values not yet known.) + checkDiags := evalCheckRules( + checkResourcePostcondition, + n.Config.Postconditions, + ctx, addr.Resource, repeatData, + ) + diags = diags.Append(checkDiags) } else { // Even if we don't plan changes, we do still need to at least update // the working state to reflect the refresh result. If not, then e.g. From f1b7f12f1c4c4ad1aadf4461e00564d05f9d2f75 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 18 Nov 2021 16:54:40 -0800 Subject: [PATCH 565/644] website: Initial draft docs for Preconditions and Postconditions --- .../preconditions-postconditions.html.mdx | 391 ++++++++++++++++++ 1 file changed, 391 insertions(+) create mode 100644 website/docs/language/expressions/preconditions-postconditions.html.mdx diff --git a/website/docs/language/expressions/preconditions-postconditions.html.mdx b/website/docs/language/expressions/preconditions-postconditions.html.mdx new file mode 100644 index 000000000000..1aebff3b7eed --- /dev/null +++ b/website/docs/language/expressions/preconditions-postconditions.html.mdx @@ -0,0 +1,391 @@ +--- +page_title: Preconditions and Postconditions - Configuration Language +--- + +# Preconditions and Postconditions + +Terraform providers can automatically detect and report problems related to +the remote system they are interacting with, but they typically do so using +language that describes implementation details of the target system, which +can sometimes make it hard to find the root cause of the problem in your +Terraform configuration. + +Preconditions and postconditions allow you to optionally describe the +assumptions you are making as a module author, so that Terraform can detect +situations where those assumptions don't hold and potentially return an +error earlier or an error with better context about where the problem +originated. + +Preconditions and postconditions both follow a similar structure, and differ +only in when Terraform evaluates them: Terraform checks a precondition prior +to evaluating the object it is associated with, and a postcondition _after_ +evaluating the object. That means that preconditions are useful for stating +assumptions about data from elsewhere that the resource configuration relies +on, while postconditions are more useful for stating assumptions about the +result of the resource itself. + +The following example shows some different possible uses of preconditions and +postconditions. + +```hcl +variable "aws_ami_id" { + type = string + + # Input variable validation can check that the AMI ID is syntactically valid. + validation { + condition = can(regex("^ami-", var.aws_ami_id)) + error_message = "The AMI ID must have the prefix \"ami-\"." + } +} + +data "aws_ami" "example" { + id = var.aws_ami_id + + lifecycle { + # A data resource with a postcondition can ensure that the selected AMI + # meets this module's expectations, by reacting to the dynamically-loaded + # AMI attributes. + postcondition { + condition = self.tags["Component"] == "nomad-server" + error_message = "The selected AMI must be tagged with the Component value \"nomad-server\"." + } + } +} + +resource "aws_instance" "example" { + instance_type = "t2.micro" + ami = "ami-abc123" + + lifecycle { + # A resource with a precondition can ensure that the selected AMI + # is set up correctly to work with the instance configuration. + precondition { + condition = data.aws_ami.example.architecture == "x86_64" + error_message = "The selected AMI must be for the x86_64 architecture." + } + + # A resource with a postcondition can react to server-decided values + # during the apply step and halt work immediately if the result doesn't + # meet expectations. + postcondition { + condition = self.private_dns != "" + error_message = "EC2 instance must be in a VPC that has private DNS hostnames enabled." + } + } +} + +data "aws_ebs_volume" "example" { + # We can use data resources that refer to other resources in order to + # load extra data that isn't directly exported by a resource. + # + # This example reads the details about the root storage volume for + # the EC2 instance declared by aws_instance.example, using the exported ID. + + filter { + name = "volume-id" + values = [aws_instance.example.root_block_device.volume_id] + } +} + +output "api_base_url" { + value = "https://${aws_instance.example.private_dns}:8433/" + + # An output value with a precondition can check the object that the + # output value is describing to make sure it meets expectations before + # any caller of this module can use it. + precondition { + condition = data.aws_ebs_volume.example.encrypted + error_message = "The server's root volume is not encrypted." + } +} +``` + +The input variable validation rule, preconditions, and postconditions in the +above example declare explicitly some assumptions and guarantees that the +module developer is making in the design of this module: + +* The caller of the module must provide a syntactically-valid AMI ID in the + `aws_ami_id` input variable. + + This would detect if the caller accidentally assigned an AMI name to the + argument, instead of an AMI ID. + +* The AMI ID must refer to an AMI that exists and that has been tagged as + being intended for the component "nomad-server". + + This would detect if the caller accidentally provided an AMI intended for + some other system component, which might otherwise be detected only after + booting the EC2 instance and noticing that the expected network service + isn't running. Terraform can therefore detect that problem earlier and + return a more actionable error message for it. + +* The AMI ID must refer to an AMI which contains an operating system for the + `x86_64` architecture. + + This would detect if the caller accidentally built an AMI for a different + architecture, which might therefore not be able to run the software this + virtual machine is intended to host. + +* The EC2 instance must be allocated a private DNS hostname. + + In AWS, EC2 instances are assigned private DNS hostnames only if they + belong to a virtual network configured in a certain way. This would + detect if the selected virtual network is not configured correctly, + giving explicit feedback to prompt the user to debug the network settings. + +* The EC2 instance will have an encrypted root volume. + + This ensures that the root volume is encrypted even though the software + running in this EC2 instance would probably still operate as expected + on an unencrypted volume. Therefore Terraform can draw attention to the + problem immediately, before any other components rely on the + insecurely-configured component. + +Writing explicit preconditions and postconditions is always optional, but it +can be helpful to users and future maintainers of a Terraform module by +capturing assumptions that might otherwise be only implied, and by allowing +Terraform to check those assumptions and halt more quickly if they don't +hold in practice for a particular set of input variables. + +## Precondition and Postcondition Locations + +Terraform supports preconditions and postconditions in a number of different +locations in a module: + +* The `lifecycle` block inside a `resource` or `data` block can include both + `precondition` and `postcondition` blocks associated with the containing + resource. + + Terraform evaluates resource preconditions before evaluating the resource's + configuration arguments. Resource preconditions can take precedence over + argument evaluation errors. + + Terraform evaluates resource postconditions after planning and after + applying changes to a managed resource, or after reading from a data + resource. Resource postcondition failures will therefore prevent applying + changes to other resources that depend on the failing resource. + +* An `output` block declaring an output value can include a `precondition` + block. + + Terraform evaluates output value preconditions before evaluating the + `value` expression to finalize the result. Output value preconditions + can take precedence over potential errors in the `value` expression. + + Output value preconditions can be particularly useful in a root module, + to prevent saving an invalid new output value in the state and to preserve + the value from the previous apply, if any. + + Output value preconditions can serve a symmetrical purpose to input + variable `validation` blocks: whereas input variable validation checks + assumptions the module makes about its inputs, output value preconditions + check guarantees that the module makes about its outputs. + +## Condition Expressions + +`precondition` and `postcondition` blocks both require an argument named +`condition`, whose value is a boolean expression which should return `true` +if the intended assumption holds or `false` if it does not. + +Preconditions and postconditions can both refer to any other objects in the +same module, as long as the references don't create any cyclic dependencies. + +Resource postconditions can additionally refer to attributes of each instance +of the resource where they are configured, using the special symbol `self`. +For example, `self.private_dns` refers to the `private_dns` attribute of +each instance of the containing resource. + +Condition expressions are otherwise just normal Terraform expressions, and +so you can use any of Terraform's built-in functions or language operators +as long as the expression is valid and returns a boolean result. + +### Common Condition Expression Features + +Because condition expressions must produce boolean results, they can often +use built-in functions and language features that are less common elsewhere +in the Terraform language. The following language features are particularly +useful when writing condition expressions: + +* You can use the built-in function `contains` to test whether a given + value is one of a set of predefined valid values: + + ```hcl + condition = contains(["STAGE", "PROD"], var.environment) + ``` + +* You can use the boolean operators `&&` (AND), `||` (OR), and `!` (NOT) to + combine multiple simpler conditions together: + + ```hcl + condition = var.name != "" && lower(var.name) == var.name + ``` + +* You can require a non-empty list or map by testing the collection's length: + + ```hcl + condition = length(var.items) != 0 + ``` + + This is a better approach than directly comparing with another collection + using `==` or `!=`, because the comparison operators can only return `true` + if both operands have exactly the same type, which is often ambiguous + for empty collections. + +* You can use `for` expressions which produce lists of boolean results + themselves in conjunction with the functions `alltrue` and `anytrue` to + test whether a condition holds for all or for any elements of a collection: + + ```hcl + condition = alltrue([ + for v in var.instances : contains(["t2.micro", "m3.medium"], v.type) + ]) + ``` + +* You can use the `can` function to concisely use the validity of an expression + as a condition. It returns `true` if its given expression evaluates + successfully and `false` if it returns any error, so you can use various + other functions that typically return errors as a part of your condition + expressions. + + For example, you can use `can` with `regex` to test if a string matches + a particular pattern, because `regex` returns an error when given a + non-matching string: + + ```hcl + condition = can(regex("^[a-z]+$", var.name) + ``` + + You can also use `can` with the type conversion functions to test whether + a value is convertible to a type or type constraint: + + ```hcl + # This remote output value must have a value that can + # be used as a string, which includes strings themselves + # but also allows numbers and boolean values. + condition = can(tostring(data.terraform_remote_state.example.outputs["name"])) + ``` + + ```hcl + # This remote output value must be convertible to a list + # type of with element type. + condition = can(tolist(data.terraform_remote_state.example.outputs["items"])) + ``` + + You can also use `can` with attribute access or index operators to + concisely test whether a collection or structural value has a particular + element or index: + + ```hcl + # var.example must have an attribute named "foo" + condition = can(var.example.foo) + ``` + + ```hcl + # var.example must be a sequence with at least one element + condition = can(var.example[0]) + # (although it would typically be clearer to write this as a + # test like length(var.example) > 0 to better represent the + # intent of the condition.) + ``` + +## Early Evaluation + +Terraform will evaluate conditions as early as possible. + +If the condition expression depends on a resource attribute that won't be known +until the apply phase then Terraform will delay checking the condition until +the apply phase, but Terraform can check all other expressions during the +planning phase, and therefore block applying a plan that would violate the +conditions. + +In the earlier example on this page, Terraform would typically be able to +detect invalid AMI tags during the planning phase, as long as `var.aws_ami_id` +is not itself derived from another resource. However, Terraform will not +detect a non-encrypted root volume until the EC2 instance was already created +during the apply step, because that condition depends on the root volume's +assigned ID, which AWS decides only when the EC2 instance is actually started. + +For conditions which Terraform must defer to the apply phase, a _precondition_ +will prevent taking whatever action was planned for a related resource, whereas +a _postcondition_ will merely halt processing after that action was already +taken, preventing any downstream actions that rely on it but not undoing the +action. + +Terraform typically has less information during the initial creation of a +full configuration than when applying subsequent changes to that configuration. +Conditions checked only during apply during initial creation may therefore +be checked during planning on subsequent updates, detecting problems sooner +in that case. + +## Error Messages + +Each `precondition` or `postcondition` block must include an argument +`error_message`, which provides some custom error sentences that Terraform +will include as part of error messages when it detects an unmet condition. + +``` +Error: Resource postcondition failed + + with data.aws_ami.example, + on ec2.tf line 19, in data "aws_ami" "example": + 72: condition = self.tags["Component"] == "nomad-server" + |---------------- + | self.tags["Component"] is "consul-server" + +The selected AMI must be tagged with the Component value "nomad-server". +``` + +The `error_message` argument must always be a literal string, and should +typically be written as a full sentence in a style similar to Terraform's own +error messages. Terraform will show the given message alongside the name +of the resource that detected the problem and any outside values used as part +of the condition expression. + +## Preconditions or Postconditions? + +Because preconditions can refer to the result attributes of other resources +in the same module, it's typically true that a particular check could be +implemented either as a postcondition of the resource producing the data +or as a precondition of a resource or output value using the data. + +To decide which is most appropriate for a particular situation, consider +whether the check is representing either an assumption or a guarantee: + +* An _assumption_ is a condition that must be true in order for the + configuration of a particular resource to be usable. In the earlier + example on this page, the `aws_instance` configuration had the _assumption_ + that the given AMI will always be for the `x86_64` CPU architecture. + + Assumptions should typically be written as preconditions, so that future + maintainers can find them close to the other expressions that rely on + that condition, and thus know more about what different variations that + resource is intended to allow. + +* A _guarantee_ is a characteristic or behavior of an object that the rest of + the configuration ought to be able to rely on. In the earlier example on + this page, the `aws_instance` configuration had the _guarantee_ that the + EC2 instance will be running in a network that assigns it a private DNS + record. + + Guarantees should typically be written as postconditions, so that + future maintainers can find them close to the resource configuration that + is responsible for implementing those guarantees and more easily see + which behaviors are important to preserve when changing the configuration. + +In practice though, the distinction between these two is subjective: is the +AMI being tagged as Component `"nomad-server"` a guarantee about the AMI or +an assumption made by the EC2 instance? To decide, it might help to consider +which resource or output value would be most helpful to report in a resulting +error message, because Terraform will always report errors in the location +where the condition was declared. + +The decision between the two may also be a matter of convenience. If a +particular resource has many dependencies that _all_ make an assumption about +that resource then it can be pragmatic to declare that just once as a +post-condition of the resource, rather than many times as preconditions on +each of the dependencies. + +It may sometimes be helpful to declare the same or similar conditions as both +preconditions _and_ postconditions, particularly if the postcondition is +in a different module than the precondition, so that they can verify one +another as the two modules evolve independently. From d14e04bf36139721284aa03e970916126f516915 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 31 Jan 2022 14:03:03 -0500 Subject: [PATCH 566/644] Fix notes according to PR feedback --- website/docs/cli/commands/plan.mdx | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index e59297981274..23c75812094c 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -138,19 +138,16 @@ the previous section, are also available with the same meanings on `terraform apply`. - `-refresh=false` - Disables the default behavior of synchronizing the - Terraform state with remote objects before checking for configuration changes. This can make the planning operation faster by reducing the number of remote API requests. However, setting `refresh=false` causes Terraform to ignore external changes, which could result in an incomplete or incorrect plan. - - -> **Note:** You cannot use `refresh=false` in "refresh only" planning mode, because it would effectively disable the entirety of the planning operation. + Terraform state with remote objects before checking for configuration changes. This can make the planning operation faster by reducing the number of remote API requests. However, setting `refresh=false` causes Terraform to ignore external changes, which could result in an incomplete or incorrect plan. You cannot use `refresh=false` in "refresh only" planning mode because it would effectively disable the entirety of the planning operation. - `-replace=ADDRESS` - Instructs Terraform to plan to replace the - resource instance with the given address. This is helpful when one or more remote objects have become degraded, and you can use replacement objects with the same configuratation to align with immutable infrastructure patterns. Terraform will use a "replace" action if the specified resource would normally cause an "update" action or no action at all. Use this option multiple times to replace several objects at once. - - -> **Note:** You cannot use `-replace` with the `-destroy` option, and it is only available from Terraform v0.15.2 onwards. For earlier versions, use [`terraform taint`](/cli/commands/taint) to achieve a similar result. + resource instance with the given address. This is helpful when one or more remote objects have become degraded, and you can use replacement objects with the same configuratation to align with immutable infrastructure patterns. Terraform will use a "replace" action if the specified resource would normally cause an "update" action or no action at all. Include this option multiple times to replace several objects at once. You cannot use `-replace` with the `-destroy` option, and it is only available from Terraform v0.15.2 onwards. For earlier versions, use [`terraform taint`](/cli/commands/taint) to achieve a similar result. - `-target=ADDRESS` - Instructs Terraform to focus its planning efforts only on resource instances which match the given address and on any objects that - those instances depend on. This command is for exceptional use only. Refer to - [Resource Targeting](#resource-targeting) for more information. + those instances depend on. + + -> **Note:** Use `-target=ADDRESS` in exceptional circumstances only, such as recovering from mistakes or working around Terraform limitations. Refer to [Resource Targeting](#resource-targeting) for more details. - `-var 'NAME=VALUE'` - Sets a value for a single [input variable](/language/values/variables) declared in the From a794c80e0d6e9c0aa390f261b745c79cdad746eb Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 31 Jan 2022 14:17:36 -0500 Subject: [PATCH 567/644] final nits --- website/docs/cli/commands/plan.mdx | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index 23c75812094c..7ae1152bcd43 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -82,12 +82,9 @@ The remaining sections on this page describe the various options: ## Planning Modes -The section above described Terraform's default planning behavior, which is -intended for changing the remote system to match with changes you've made to -your configuration. - -Terraform has two alternative planning modes, each of which creates a plan with -a different intended outcome: +The previous section describes Terraform's default planning behavior, which +changes the remote system to match the changes you make to +your configuration. Terraform has two alternative planning modes, each of which creates a plan with a different intended outcome. These options are available for both `terraform plan` and [`terraform apply`](/cli/commands/apply). * **Destroy mode:** creates a plan whose goal is to destroy all remote objects that currently exist, leaving an empty Terraform state. This can be useful @@ -127,18 +124,10 @@ and later. ## Planning Options -In addition to the planning _modes_ described above, there are also several -additional options that can modify details of the behavior of the planning -step. - -When you use `terraform apply` without passing it a saved plan file, it -incorporates the `terraform plan` command functionality and so the planning -options in this section, along with the planning mode selection options in -the previous section, are also available with the same meanings on -`terraform apply`. +In addition to alternate [planning modes](#planning-modes), there are several options that can modify planning behavior. These options are available for both `terraform plan` and [`terraform apply`](/cli/commands/apply). - `-refresh=false` - Disables the default behavior of synchronizing the - Terraform state with remote objects before checking for configuration changes. This can make the planning operation faster by reducing the number of remote API requests. However, setting `refresh=false` causes Terraform to ignore external changes, which could result in an incomplete or incorrect plan. You cannot use `refresh=false` in "refresh only" planning mode because it would effectively disable the entirety of the planning operation. + Terraform state with remote objects before checking for configuration changes. This can make the planning operation faster by reducing the number of remote API requests. However, setting `refresh=false` causes Terraform to ignore external changes, which could result in an incomplete or incorrect plan. You cannot use `refresh=false` in refresh-only planning mode because it would effectively disable the entirety of the planning operation. - `-replace=ADDRESS` - Instructs Terraform to plan to replace the resource instance with the given address. This is helpful when one or more remote objects have become degraded, and you can use replacement objects with the same configuratation to align with immutable infrastructure patterns. Terraform will use a "replace" action if the specified resource would normally cause an "update" action or no action at all. Include this option multiple times to replace several objects at once. You cannot use `-replace` with the `-destroy` option, and it is only available from Terraform v0.15.2 onwards. For earlier versions, use [`terraform taint`](/cli/commands/taint) to achieve a similar result. From a95ad997e1c7bc49f54bccfaf3007cfbb4c6d1bb Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 31 Jan 2022 14:32:27 -0500 Subject: [PATCH 568/644] core: Document postconditions as valid use of self This is not currently gated by the experiment only because it is awkward to do so in the context of evaluationStateData, which doesn't have any concept of experiments at the moment. --- internal/lang/eval.go | 2 +- internal/terraform/evaluate_valid.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/lang/eval.go b/internal/lang/eval.go index c1faca9e617b..fe5fc1b76469 100644 --- a/internal/lang/eval.go +++ b/internal/lang/eval.go @@ -296,7 +296,7 @@ func (s *Scope) evalContext(refs []*addrs.Reference, selfAddr addrs.Referenceabl // this codepath doesn't really "know about". If the "self" // object starts being supported in more contexts later then // we'll need to adjust this message. - Detail: `The "self" object is not available in this context. This object can be used only in resource provisioner and connection blocks.`, + Detail: `The "self" object is not available in this context. This object can be used only in resource provisioner, connection, and postcondition blocks.`, Subject: ref.SourceRange.ToHCL().Ptr(), }) continue diff --git a/internal/terraform/evaluate_valid.go b/internal/terraform/evaluate_valid.go index 232f6913da77..1d43cc4fce64 100644 --- a/internal/terraform/evaluate_valid.go +++ b/internal/terraform/evaluate_valid.go @@ -58,7 +58,7 @@ func (d *evaluationStateData) staticValidateReference(ref *addrs.Reference, self // this codepath doesn't really "know about". If the "self" // object starts being supported in more contexts later then // we'll need to adjust this message. - Detail: `The "self" object is not available in this context. This object can be used only in resource provisioner and connection blocks.`, + Detail: `The "self" object is not available in this context. This object can be used only in resource provisioner, connection, and postcondition blocks.`, Subject: ref.SourceRange.ToHCL().Ptr(), }) return diags From cdae6d43962276cddd71060134a2852fd18bea11 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 31 Jan 2022 15:38:26 -0500 Subject: [PATCH 569/644] core: Add context tests for pre/post conditions --- internal/terraform/context_apply2_test.go | 180 +++++++++ internal/terraform/context_plan2_test.go | 435 ++++++++++++++++++++++ 2 files changed, 615 insertions(+) diff --git a/internal/terraform/context_apply2_test.go b/internal/terraform/context_apply2_test.go index 512f3dab3c9c..38b9d26f67cc 100644 --- a/internal/terraform/context_apply2_test.go +++ b/internal/terraform/context_apply2_test.go @@ -7,6 +7,7 @@ import ( "testing" "time" + "github.com/google/go-cmp/cmp" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/lang/marks" @@ -736,3 +737,182 @@ resource "test_object" "b" { t.Fatal("expected cycle error from apply") } } + +func TestContext2Apply_resourcePostcondition(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "boop" { + type = string +} + +resource "test_resource" "a" { + value = var.boop +} + +resource "test_resource" "b" { + value = test_resource.a.output + lifecycle { + postcondition { + condition = self.output != "" + error_message = "Output must not be blank." + } + } +} + +resource "test_resource" "c" { + value = test_resource.b.output +} +`, + }) + + p := testProvider("test") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "test_resource": { + Attributes: map[string]*configschema.Attribute{ + "value": { + Type: cty.String, + Required: true, + }, + "output": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + }) + p.PlanResourceChangeFn = func(req providers.PlanResourceChangeRequest) (resp providers.PlanResourceChangeResponse) { + m := req.ProposedNewState.AsValueMap() + m["output"] = cty.UnknownVal(cty.String) + + resp.PlannedState = cty.ObjectVal(m) + resp.LegacyTypeSystem = true + return resp + } + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + t.Run("condition pass", func(t *testing.T) { + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if len(plan.Changes.Resources) != 3 { + t.Fatalf("unexpected plan changes: %#v", plan.Changes) + } + + p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) (resp providers.ApplyResourceChangeResponse) { + m := req.PlannedState.AsValueMap() + m["output"] = cty.StringVal(fmt.Sprintf("new-%s", m["value"].AsString())) + + resp.NewState = cty.ObjectVal(m) + return resp + } + state, diags := ctx.Apply(plan, m) + assertNoErrors(t, diags) + + wantResourceAttrs := map[string]struct{ value, output string }{ + "a": {"boop", "new-boop"}, + "b": {"new-boop", "new-new-boop"}, + "c": {"new-new-boop", "new-new-new-boop"}, + } + for name, attrs := range wantResourceAttrs { + addr := mustResourceInstanceAddr(fmt.Sprintf("test_resource.%s", name)) + r := state.ResourceInstance(addr) + rd, err := r.Current.Decode(cty.Object(map[string]cty.Type{ + "value": cty.String, + "output": cty.String, + })) + if err != nil { + t.Fatalf("error decoding test_resource.a: %s", err) + } + want := cty.ObjectVal(map[string]cty.Value{ + "value": cty.StringVal(attrs.value), + "output": cty.StringVal(attrs.output), + }) + if !cmp.Equal(want, rd.Value, valueComparer) { + t.Errorf("wrong attrs for %s\n%s", addr, cmp.Diff(want, rd.Value, valueComparer)) + } + } + }) + t.Run("condition fail", func(t *testing.T) { + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if len(plan.Changes.Resources) != 3 { + t.Fatalf("unexpected plan changes: %#v", plan.Changes) + } + + p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) (resp providers.ApplyResourceChangeResponse) { + m := req.PlannedState.AsValueMap() + + // For the resource with a constraint, fudge the output to make the + // condition fail. + if value := m["value"].AsString(); value == "new-boop" { + m["output"] = cty.StringVal("") + } else { + m["output"] = cty.StringVal(fmt.Sprintf("new-%s", value)) + } + + resp.NewState = cty.ObjectVal(m) + return resp + } + state, diags := ctx.Apply(plan, m) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := diags.Err().Error(), "Resource postcondition failed: Output must not be blank."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + + // Resources a and b should still be recorded in state + wantResourceAttrs := map[string]struct{ value, output string }{ + "a": {"boop", "new-boop"}, + "b": {"new-boop", ""}, + } + for name, attrs := range wantResourceAttrs { + addr := mustResourceInstanceAddr(fmt.Sprintf("test_resource.%s", name)) + r := state.ResourceInstance(addr) + rd, err := r.Current.Decode(cty.Object(map[string]cty.Type{ + "value": cty.String, + "output": cty.String, + })) + if err != nil { + t.Fatalf("error decoding test_resource.a: %s", err) + } + want := cty.ObjectVal(map[string]cty.Value{ + "value": cty.StringVal(attrs.value), + "output": cty.StringVal(attrs.output), + }) + if !cmp.Equal(want, rd.Value, valueComparer) { + t.Errorf("wrong attrs for %s\n%s", addr, cmp.Diff(want, rd.Value, valueComparer)) + } + } + + // Resource c should not be in state + if state.ResourceInstance(mustResourceInstanceAddr("test_resource.c")) != nil { + t.Error("test_resource.c should not exist in state, but is") + } + }) +} diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index d1771b1f397f..622c4c803f6e 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -2178,3 +2178,438 @@ func TestContext2Plan_moduleExpandOrphansResourceInstance(t *testing.T) { } }) } + +func TestContext2Plan_resourcePreconditionPostcondition(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "boop" { + type = string +} + +resource "test_resource" "a" { + value = var.boop + lifecycle { + precondition { + condition = var.boop == "boop" + error_message = "Wrong boop." + } + postcondition { + condition = self.output != "" + error_message = "Output must not be blank." + } + } +} + +`, + }) + + p := testProvider("test") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "test_resource": { + Attributes: map[string]*configschema.Attribute{ + "value": { + Type: cty.String, + Required: true, + }, + "output": { + Type: cty.String, + Computed: true, + }, + }, + }, + }, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + t.Run("conditions pass", func(t *testing.T) { + p.PlanResourceChangeFn = func(req providers.PlanResourceChangeRequest) (resp providers.PlanResourceChangeResponse) { + m := req.ProposedNewState.AsValueMap() + m["output"] = cty.StringVal("bar") + + resp.PlannedState = cty.ObjectVal(m) + resp.LegacyTypeSystem = true + return resp + } + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + for _, res := range plan.Changes.Resources { + switch res.Addr.String() { + case "test_resource.a": + if res.Action != plans.Create { + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + default: + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + } + }) + + t.Run("precondition fail", func(t *testing.T) { + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := diags.Err().Error(), "Resource precondition failed: Wrong boop."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + if p.PlanResourceChangeCalled { + t.Errorf("Provider's PlanResourceChange was called; should'nt've been") + } + }) + + t.Run("postcondition fail", func(t *testing.T) { + p.PlanResourceChangeFn = func(req providers.PlanResourceChangeRequest) (resp providers.PlanResourceChangeResponse) { + m := req.ProposedNewState.AsValueMap() + m["output"] = cty.StringVal("") + + resp.PlannedState = cty.ObjectVal(m) + resp.LegacyTypeSystem = true + return resp + } + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := diags.Err().Error(), "Resource postcondition failed: Output must not be blank."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + if !p.PlanResourceChangeCalled { + t.Errorf("Provider's PlanResourceChangeCalled wasn't called; should've been") + } + }) +} + +func TestContext2Plan_dataSourcePreconditionPostcondition(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "boop" { + type = string +} + +data "test_data_source" "a" { + foo = var.boop + lifecycle { + precondition { + condition = var.boop == "boop" + error_message = "Wrong boop." + } + postcondition { + condition = length(self.results) > 0 + error_message = "Results cannot be empty." + } + } +} + +resource "test_resource" "a" { + value = data.test_data_source.a.results[0] +} +`, + }) + + p := testProvider("test") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "test_resource": { + Attributes: map[string]*configschema.Attribute{ + "value": { + Type: cty.String, + Required: true, + }, + }, + }, + }, + DataSources: map[string]*configschema.Block{ + "test_data_source": { + Attributes: map[string]*configschema.Attribute{ + "foo": { + Type: cty.String, + Required: true, + }, + "results": { + Type: cty.List(cty.String), + Computed: true, + }, + }, + }, + }, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + t.Run("conditions pass", func(t *testing.T) { + p.ReadDataSourceResponse = &providers.ReadDataSourceResponse{ + State: cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("boop"), + "results": cty.ListVal([]cty.Value{cty.StringVal("boop")}), + }), + } + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + for _, res := range plan.Changes.Resources { + switch res.Addr.String() { + case "test_resource.a": + if res.Action != plans.Create { + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + case "data.test_data_source.a": + if res.Action != plans.Read { + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + default: + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + } + }) + + t.Run("precondition fail", func(t *testing.T) { + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := diags.Err().Error(), "Resource precondition failed: Wrong boop."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + if p.ReadDataSourceCalled { + t.Errorf("Provider's ReadResource was called; should'nt've been") + } + }) + + t.Run("postcondition fail", func(t *testing.T) { + p.ReadDataSourceResponse = &providers.ReadDataSourceResponse{ + State: cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("boop"), + "results": cty.ListValEmpty(cty.String), + }), + } + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := diags.Err().Error(), "Resource postcondition failed: Results cannot be empty."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + if !p.ReadDataSourceCalled { + t.Errorf("Provider's ReadDataSource wasn't called; should've been") + } + }) +} + +func TestContext2Plan_outputPrecondition(t *testing.T) { + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "boop" { + type = string +} + +output "a" { + value = var.boop + precondition { + condition = var.boop == "boop" + error_message = "Wrong boop." + } +} +`, + }) + + p := testProvider("test") + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + t.Run("condition pass", func(t *testing.T) { + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + addr := addrs.RootModuleInstance.OutputValue("a") + outputPlan := plan.Changes.OutputValue(addr) + if outputPlan == nil { + t.Fatalf("no plan for %s at all", addr) + } + if got, want := outputPlan.Addr, addr; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := outputPlan.Action, plans.Create; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + }) + + t.Run("condition fail", func(t *testing.T) { + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := diags.Err().Error(), "Module output value precondition failed: Wrong boop."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + }) +} + +func TestContext2Plan_preconditionErrors(t *testing.T) { + testCases := []struct { + condition string + wantSummary string + wantDetail string + }{ + { + "data.test_data_source", + "Invalid reference", + `The "data" object must be followed by two attribute names`, + }, + { + "self.value", + `Invalid "self" reference`, + "only in resource provisioner, connection, and postcondition blocks", + }, + { + "data.foo.bar", + "Reference to undeclared resource", + `A data resource "foo" "bar" has not been declared in the root module`, + }, + { + "test_resource.b.value", + "Invalid condition result", + "Condition expression must return either true or false", + }, + { + "test_resource.c.value", + "Invalid condition result", + "Invalid validation condition result value: a bool is required", + }, + } + + p := testProvider("test") + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + for _, tc := range testCases { + t.Run(tc.condition, func(t *testing.T) { + main := fmt.Sprintf(` + terraform { + experiments = [preconditions_postconditions] + } + + resource "test_resource" "a" { + value = var.boop + lifecycle { + precondition { + condition = %s + error_message = "Not relevant." + } + } + } + + resource "test_resource" "b" { + value = null + } + + resource "test_resource" "c" { + value = "bar" + } + `, tc.condition) + m := testModuleInline(t, map[string]string{"main.tf": main}) + + _, diags := ctx.Plan(m, states.NewState(), DefaultPlanOpts) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + diag := diags[0] + if got, want := diag.Description().Summary, tc.wantSummary; got != want { + t.Errorf("unexpected summary\n got: %s\nwant: %s", got, want) + } + if got, want := diag.Description().Detail, tc.wantDetail; !strings.Contains(got, want) { + t.Errorf("unexpected summary\ngot: %s\nwant to contain %q", got, want) + } + }) + } +} From 013170dd1b0ec39a76f399589c70bb9bb0e017ff Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 2 Feb 2022 15:45:14 -0500 Subject: [PATCH 570/644] Update CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 86538555d80e..8ade630341b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ ## 1.2.0 (Unreleased) +NEW FEATURES: + +* `precondition` and `postcondition` check blocks for resources, data sources, and module output values: module authors can now document assumptions and assertions about configuration and state values. If these conditions are not met, Terraform will report a custom error message to the user and halt further evaluation. + ENHANCEMENTS: * The "Invalid for_each argument" error message for unknown maps/sets now includes an additional paragraph to try to help the user notice they can move apply-time values into the map _values_ instead of the map _keys_, and thus avoid the problem without resorting to `-target`. [GH-30327] From 7ded73f266f05ea118c3a0cf74a4ea65544446c1 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 2 Feb 2022 16:08:07 -0500 Subject: [PATCH 571/644] configs: Validate pre/postcondition self-refs Preconditions and postconditions for resources and data sources may not refer to the address of the containing resource or data source. This commit adds a parse-time validation for this rule. --- internal/configs/checks.go | 33 +++++++++++ internal/configs/resource.go | 8 +++ .../precondition-postcondition-selfref.tf | 55 +++++++++++++++++++ 3 files changed, 96 insertions(+) create mode 100644 internal/configs/testdata/error-files/precondition-postcondition-selfref.tf diff --git a/internal/configs/checks.go b/internal/configs/checks.go index 8339640ccb39..0980ec16c013 100644 --- a/internal/configs/checks.go +++ b/internal/configs/checks.go @@ -6,6 +6,8 @@ import ( "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/gohcl" + "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/lang" ) // CheckRule represents a configuration-defined validation rule, precondition, @@ -32,6 +34,37 @@ type CheckRule struct { DeclRange hcl.Range } +// validateSelfReferences looks for references in the check rule matching the +// specified resource address, returning error diagnostics if such a reference +// is found. +func (cr *CheckRule) validateSelfReferences(checkType string, addr addrs.Resource) hcl.Diagnostics { + var diags hcl.Diagnostics + refs, _ := lang.References(cr.Condition.Variables()) + for _, ref := range refs { + var refAddr addrs.Resource + + switch rs := ref.Subject.(type) { + case addrs.Resource: + refAddr = rs + case addrs.ResourceInstance: + refAddr = rs.Resource + default: + continue + } + + if refAddr.Equal(addr) { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: fmt.Sprintf("Invalid reference in %s", checkType), + Detail: fmt.Sprintf("Configuration for %s may not refer to itself.", addr.String()), + Subject: cr.Condition.Range().Ptr(), + }) + break + } + } + return diags +} + // decodeCheckRuleBlock decodes the contents of the given block as a check rule. // // Unlike most of our "decode..." functions, this one can be applied to blocks diff --git a/internal/configs/resource.go b/internal/configs/resource.go index 0928f701e78f..3d9e72533d1f 100644 --- a/internal/configs/resource.go +++ b/internal/configs/resource.go @@ -245,6 +245,10 @@ func decodeResourceBlock(block *hcl.Block, override bool) (*Resource, hcl.Diagno case "precondition", "postcondition": cr, moreDiags := decodeCheckRuleBlock(block, override) diags = append(diags, moreDiags...) + + moreDiags = cr.validateSelfReferences(block.Type, r.Addr()) + diags = append(diags, moreDiags...) + switch block.Type { case "precondition": r.Preconditions = append(r.Preconditions, cr) @@ -445,6 +449,10 @@ func decodeDataBlock(block *hcl.Block, override bool) (*Resource, hcl.Diagnostic case "precondition", "postcondition": cr, moreDiags := decodeCheckRuleBlock(block, override) diags = append(diags, moreDiags...) + + moreDiags = cr.validateSelfReferences(block.Type, r.Addr()) + diags = append(diags, moreDiags...) + switch block.Type { case "precondition": r.Preconditions = append(r.Preconditions, cr) diff --git a/internal/configs/testdata/error-files/precondition-postcondition-selfref.tf b/internal/configs/testdata/error-files/precondition-postcondition-selfref.tf new file mode 100644 index 000000000000..5f295c1c9864 --- /dev/null +++ b/internal/configs/testdata/error-files/precondition-postcondition-selfref.tf @@ -0,0 +1,55 @@ +resource "test" "test" { + lifecycle { + precondition { + condition = test.test.foo # ERROR: Invalid reference in precondition + error_message = "Cannot refer to self." + } + postcondition { + condition = test.test.foo # ERROR: Invalid reference in postcondition + error_message = "Cannot refer to self." + } + } +} + +data "test" "test" { + lifecycle { + precondition { + condition = data.test.test.foo # ERROR: Invalid reference in precondition + error_message = "Cannot refer to self." + } + postcondition { + condition = data.test.test.foo # ERROR: Invalid reference in postcondition + error_message = "Cannot refer to self." + } + } +} + +resource "test" "test_counted" { + count = 1 + + lifecycle { + precondition { + condition = test.test_counted[0].foo # ERROR: Invalid reference in precondition + error_message = "Cannot refer to self." + } + postcondition { + condition = test.test_counted[0].foo # ERROR: Invalid reference in postcondition + error_message = "Cannot refer to self." + } + } +} + +data "test" "test_counted" { + count = 1 + + lifecycle { + precondition { + condition = data.test.test_counted[0].foo # ERROR: Invalid reference in precondition + error_message = "Cannot refer to self." + } + postcondition { + condition = data.test.test_counted[0].foo # ERROR: Invalid reference in postcondition + error_message = "Cannot refer to self." + } + } +} From 639eb5212f27fe482a064b3649f41a7ebd37d1b2 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 3 Feb 2022 14:16:25 -0500 Subject: [PATCH 572/644] core: Remove unused PlanOpts.Validate This vestigial field was written to but never read. --- internal/terraform/context_plan.go | 9 +++------ internal/terraform/context_validate.go | 1 - internal/terraform/graph_builder_plan.go | 8 ++------ 3 files changed, 5 insertions(+), 13 deletions(-) diff --git a/internal/terraform/context_plan.go b/internal/terraform/context_plan.go index f114b2a5f7dc..8366ffe90984 100644 --- a/internal/terraform/context_plan.go +++ b/internal/terraform/context_plan.go @@ -462,7 +462,7 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, o return nil, diags } - graph, walkOp, moreDiags := c.planGraph(config, prevRunState, opts, true) + graph, walkOp, moreDiags := c.planGraph(config, prevRunState, opts) diags = diags.Append(moreDiags) if diags.HasErrors() { return nil, diags @@ -517,7 +517,7 @@ func (c *Context) planWalk(config *configs.Config, prevRunState *states.State, o return plan, diags } -func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, opts *PlanOpts, validate bool) (*Graph, walkOperation, tfdiags.Diagnostics) { +func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*Graph, walkOperation, tfdiags.Diagnostics) { switch mode := opts.Mode; mode { case plans.NormalMode: graph, diags := (&PlanGraphBuilder{ @@ -527,7 +527,6 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, Plugins: c.plugins, Targets: opts.Targets, ForceReplace: opts.ForceReplace, - Validate: validate, skipRefresh: opts.SkipRefresh, }).Build(addrs.RootModuleInstance) return graph, walkPlan, diags @@ -538,7 +537,6 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, RootVariableValues: opts.SetVariables, Plugins: c.plugins, Targets: opts.Targets, - Validate: validate, skipRefresh: opts.SkipRefresh, skipPlanChanges: true, // this activates "refresh only" mode. }).Build(addrs.RootModuleInstance) @@ -550,7 +548,6 @@ func (c *Context) planGraph(config *configs.Config, prevRunState *states.State, RootVariableValues: opts.SetVariables, Plugins: c.plugins, Targets: opts.Targets, - Validate: validate, skipRefresh: opts.SkipRefresh, }).Build(addrs.RootModuleInstance) return graph, walkPlanDestroy, diags @@ -714,7 +711,7 @@ func (c *Context) PlanGraphForUI(config *configs.Config, prevRunState *states.St opts := &PlanOpts{Mode: mode} - graph, _, moreDiags := c.planGraph(config, prevRunState, opts, false) + graph, _, moreDiags := c.planGraph(config, prevRunState, opts) diags = diags.Append(moreDiags) return graph, diags } diff --git a/internal/terraform/context_validate.go b/internal/terraform/context_validate.go index 4fb02f767164..070694920ca5 100644 --- a/internal/terraform/context_validate.go +++ b/internal/terraform/context_validate.go @@ -58,7 +58,6 @@ func (c *Context) Validate(config *configs.Config) tfdiags.Diagnostics { graph, moreDiags := ValidateGraphBuilder(&PlanGraphBuilder{ Config: config, Plugins: c.plugins, - Validate: true, State: states.NewState(), RootVariableValues: varValues, }).Build(addrs.RootModuleInstance) diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index 1b8ce58338a9..d51e13be2ba1 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -45,9 +45,6 @@ type PlanGraphBuilder struct { // action instead. Create and Delete actions are not affected. ForceReplace []addrs.AbsResourceInstance - // Validate will do structural validation of the graph. - Validate bool - // skipRefresh indicates that we should skip refreshing managed resources skipRefresh bool @@ -72,9 +69,8 @@ type PlanGraphBuilder struct { // See GraphBuilder func (b *PlanGraphBuilder) Build(path addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics) { return (&BasicGraphBuilder{ - Steps: b.Steps(), - Validate: b.Validate, - Name: "PlanGraphBuilder", + Steps: b.Steps(), + Name: "PlanGraphBuilder", }).Build(path) } From fa8a87fab58166de33b7ceeb63bb906bc20bfbb2 Mon Sep 17 00:00:00 2001 From: Ben Partridge Date: Mon, 7 Feb 2022 15:12:22 +1100 Subject: [PATCH 573/644] Adds documentation to `substr` function to cover when `length` longer than input `string` The `substr` function allows the `length` parameter to be longer than the remaining characters in the input after the offset. This is useful for when you want to truncate a string to a maximum number of characters. However, the documentation isn't clear on this so I had to do a test deployment to confirm the behaviour after finding the behaviour in an old issue https://github.com/hashicorp/terraform/issues/15751 --- website/docs/language/functions/substr.mdx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/website/docs/language/functions/substr.mdx b/website/docs/language/functions/substr.mdx index dab4e3a8f92b..1ccd24cc1d48 100644 --- a/website/docs/language/functions/substr.mdx +++ b/website/docs/language/functions/substr.mdx @@ -7,7 +7,7 @@ description: |- # `substr` Function -`substr` extracts a substring from a given string by offset and length. +`substr` extracts a substring from a given string by offset and (maximum) length. ```hcl substr(string, offset, length) @@ -36,3 +36,11 @@ string after the given offset will be returned. > substr("hello world", -5, -1) world ``` + +The length may be greater than the length of the string, in which case the substring +will be the length of all remaining characters. + +``` +> substr("hello world", 6, 10) +world +``` From 834f65e4f068c99a76d071f3ab4e46f250521018 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 7 Feb 2022 11:59:28 -0500 Subject: [PATCH 574/644] Fix formatting issues that would prevent website from loading --- website/data/language-nav-data.json | 4 + .../preconditions-postconditions.html.mdx | 391 ------------------ 2 files changed, 4 insertions(+), 391 deletions(-) delete mode 100644 website/docs/language/expressions/preconditions-postconditions.html.mdx diff --git a/website/data/language-nav-data.json b/website/data/language-nav-data.json index 3efdda76640f..74310b84b522 100644 --- a/website/data/language-nav-data.json +++ b/website/data/language-nav-data.json @@ -278,6 +278,10 @@ { "title": "Version Constraints", "path": "expressions/version-constraints" + }, + { + "title": "Pre and Postconditions", + "path": "expressions/preconditions-postconditions" } ] }, diff --git a/website/docs/language/expressions/preconditions-postconditions.html.mdx b/website/docs/language/expressions/preconditions-postconditions.html.mdx deleted file mode 100644 index 1aebff3b7eed..000000000000 --- a/website/docs/language/expressions/preconditions-postconditions.html.mdx +++ /dev/null @@ -1,391 +0,0 @@ ---- -page_title: Preconditions and Postconditions - Configuration Language ---- - -# Preconditions and Postconditions - -Terraform providers can automatically detect and report problems related to -the remote system they are interacting with, but they typically do so using -language that describes implementation details of the target system, which -can sometimes make it hard to find the root cause of the problem in your -Terraform configuration. - -Preconditions and postconditions allow you to optionally describe the -assumptions you are making as a module author, so that Terraform can detect -situations where those assumptions don't hold and potentially return an -error earlier or an error with better context about where the problem -originated. - -Preconditions and postconditions both follow a similar structure, and differ -only in when Terraform evaluates them: Terraform checks a precondition prior -to evaluating the object it is associated with, and a postcondition _after_ -evaluating the object. That means that preconditions are useful for stating -assumptions about data from elsewhere that the resource configuration relies -on, while postconditions are more useful for stating assumptions about the -result of the resource itself. - -The following example shows some different possible uses of preconditions and -postconditions. - -```hcl -variable "aws_ami_id" { - type = string - - # Input variable validation can check that the AMI ID is syntactically valid. - validation { - condition = can(regex("^ami-", var.aws_ami_id)) - error_message = "The AMI ID must have the prefix \"ami-\"." - } -} - -data "aws_ami" "example" { - id = var.aws_ami_id - - lifecycle { - # A data resource with a postcondition can ensure that the selected AMI - # meets this module's expectations, by reacting to the dynamically-loaded - # AMI attributes. - postcondition { - condition = self.tags["Component"] == "nomad-server" - error_message = "The selected AMI must be tagged with the Component value \"nomad-server\"." - } - } -} - -resource "aws_instance" "example" { - instance_type = "t2.micro" - ami = "ami-abc123" - - lifecycle { - # A resource with a precondition can ensure that the selected AMI - # is set up correctly to work with the instance configuration. - precondition { - condition = data.aws_ami.example.architecture == "x86_64" - error_message = "The selected AMI must be for the x86_64 architecture." - } - - # A resource with a postcondition can react to server-decided values - # during the apply step and halt work immediately if the result doesn't - # meet expectations. - postcondition { - condition = self.private_dns != "" - error_message = "EC2 instance must be in a VPC that has private DNS hostnames enabled." - } - } -} - -data "aws_ebs_volume" "example" { - # We can use data resources that refer to other resources in order to - # load extra data that isn't directly exported by a resource. - # - # This example reads the details about the root storage volume for - # the EC2 instance declared by aws_instance.example, using the exported ID. - - filter { - name = "volume-id" - values = [aws_instance.example.root_block_device.volume_id] - } -} - -output "api_base_url" { - value = "https://${aws_instance.example.private_dns}:8433/" - - # An output value with a precondition can check the object that the - # output value is describing to make sure it meets expectations before - # any caller of this module can use it. - precondition { - condition = data.aws_ebs_volume.example.encrypted - error_message = "The server's root volume is not encrypted." - } -} -``` - -The input variable validation rule, preconditions, and postconditions in the -above example declare explicitly some assumptions and guarantees that the -module developer is making in the design of this module: - -* The caller of the module must provide a syntactically-valid AMI ID in the - `aws_ami_id` input variable. - - This would detect if the caller accidentally assigned an AMI name to the - argument, instead of an AMI ID. - -* The AMI ID must refer to an AMI that exists and that has been tagged as - being intended for the component "nomad-server". - - This would detect if the caller accidentally provided an AMI intended for - some other system component, which might otherwise be detected only after - booting the EC2 instance and noticing that the expected network service - isn't running. Terraform can therefore detect that problem earlier and - return a more actionable error message for it. - -* The AMI ID must refer to an AMI which contains an operating system for the - `x86_64` architecture. - - This would detect if the caller accidentally built an AMI for a different - architecture, which might therefore not be able to run the software this - virtual machine is intended to host. - -* The EC2 instance must be allocated a private DNS hostname. - - In AWS, EC2 instances are assigned private DNS hostnames only if they - belong to a virtual network configured in a certain way. This would - detect if the selected virtual network is not configured correctly, - giving explicit feedback to prompt the user to debug the network settings. - -* The EC2 instance will have an encrypted root volume. - - This ensures that the root volume is encrypted even though the software - running in this EC2 instance would probably still operate as expected - on an unencrypted volume. Therefore Terraform can draw attention to the - problem immediately, before any other components rely on the - insecurely-configured component. - -Writing explicit preconditions and postconditions is always optional, but it -can be helpful to users and future maintainers of a Terraform module by -capturing assumptions that might otherwise be only implied, and by allowing -Terraform to check those assumptions and halt more quickly if they don't -hold in practice for a particular set of input variables. - -## Precondition and Postcondition Locations - -Terraform supports preconditions and postconditions in a number of different -locations in a module: - -* The `lifecycle` block inside a `resource` or `data` block can include both - `precondition` and `postcondition` blocks associated with the containing - resource. - - Terraform evaluates resource preconditions before evaluating the resource's - configuration arguments. Resource preconditions can take precedence over - argument evaluation errors. - - Terraform evaluates resource postconditions after planning and after - applying changes to a managed resource, or after reading from a data - resource. Resource postcondition failures will therefore prevent applying - changes to other resources that depend on the failing resource. - -* An `output` block declaring an output value can include a `precondition` - block. - - Terraform evaluates output value preconditions before evaluating the - `value` expression to finalize the result. Output value preconditions - can take precedence over potential errors in the `value` expression. - - Output value preconditions can be particularly useful in a root module, - to prevent saving an invalid new output value in the state and to preserve - the value from the previous apply, if any. - - Output value preconditions can serve a symmetrical purpose to input - variable `validation` blocks: whereas input variable validation checks - assumptions the module makes about its inputs, output value preconditions - check guarantees that the module makes about its outputs. - -## Condition Expressions - -`precondition` and `postcondition` blocks both require an argument named -`condition`, whose value is a boolean expression which should return `true` -if the intended assumption holds or `false` if it does not. - -Preconditions and postconditions can both refer to any other objects in the -same module, as long as the references don't create any cyclic dependencies. - -Resource postconditions can additionally refer to attributes of each instance -of the resource where they are configured, using the special symbol `self`. -For example, `self.private_dns` refers to the `private_dns` attribute of -each instance of the containing resource. - -Condition expressions are otherwise just normal Terraform expressions, and -so you can use any of Terraform's built-in functions or language operators -as long as the expression is valid and returns a boolean result. - -### Common Condition Expression Features - -Because condition expressions must produce boolean results, they can often -use built-in functions and language features that are less common elsewhere -in the Terraform language. The following language features are particularly -useful when writing condition expressions: - -* You can use the built-in function `contains` to test whether a given - value is one of a set of predefined valid values: - - ```hcl - condition = contains(["STAGE", "PROD"], var.environment) - ``` - -* You can use the boolean operators `&&` (AND), `||` (OR), and `!` (NOT) to - combine multiple simpler conditions together: - - ```hcl - condition = var.name != "" && lower(var.name) == var.name - ``` - -* You can require a non-empty list or map by testing the collection's length: - - ```hcl - condition = length(var.items) != 0 - ``` - - This is a better approach than directly comparing with another collection - using `==` or `!=`, because the comparison operators can only return `true` - if both operands have exactly the same type, which is often ambiguous - for empty collections. - -* You can use `for` expressions which produce lists of boolean results - themselves in conjunction with the functions `alltrue` and `anytrue` to - test whether a condition holds for all or for any elements of a collection: - - ```hcl - condition = alltrue([ - for v in var.instances : contains(["t2.micro", "m3.medium"], v.type) - ]) - ``` - -* You can use the `can` function to concisely use the validity of an expression - as a condition. It returns `true` if its given expression evaluates - successfully and `false` if it returns any error, so you can use various - other functions that typically return errors as a part of your condition - expressions. - - For example, you can use `can` with `regex` to test if a string matches - a particular pattern, because `regex` returns an error when given a - non-matching string: - - ```hcl - condition = can(regex("^[a-z]+$", var.name) - ``` - - You can also use `can` with the type conversion functions to test whether - a value is convertible to a type or type constraint: - - ```hcl - # This remote output value must have a value that can - # be used as a string, which includes strings themselves - # but also allows numbers and boolean values. - condition = can(tostring(data.terraform_remote_state.example.outputs["name"])) - ``` - - ```hcl - # This remote output value must be convertible to a list - # type of with element type. - condition = can(tolist(data.terraform_remote_state.example.outputs["items"])) - ``` - - You can also use `can` with attribute access or index operators to - concisely test whether a collection or structural value has a particular - element or index: - - ```hcl - # var.example must have an attribute named "foo" - condition = can(var.example.foo) - ``` - - ```hcl - # var.example must be a sequence with at least one element - condition = can(var.example[0]) - # (although it would typically be clearer to write this as a - # test like length(var.example) > 0 to better represent the - # intent of the condition.) - ``` - -## Early Evaluation - -Terraform will evaluate conditions as early as possible. - -If the condition expression depends on a resource attribute that won't be known -until the apply phase then Terraform will delay checking the condition until -the apply phase, but Terraform can check all other expressions during the -planning phase, and therefore block applying a plan that would violate the -conditions. - -In the earlier example on this page, Terraform would typically be able to -detect invalid AMI tags during the planning phase, as long as `var.aws_ami_id` -is not itself derived from another resource. However, Terraform will not -detect a non-encrypted root volume until the EC2 instance was already created -during the apply step, because that condition depends on the root volume's -assigned ID, which AWS decides only when the EC2 instance is actually started. - -For conditions which Terraform must defer to the apply phase, a _precondition_ -will prevent taking whatever action was planned for a related resource, whereas -a _postcondition_ will merely halt processing after that action was already -taken, preventing any downstream actions that rely on it but not undoing the -action. - -Terraform typically has less information during the initial creation of a -full configuration than when applying subsequent changes to that configuration. -Conditions checked only during apply during initial creation may therefore -be checked during planning on subsequent updates, detecting problems sooner -in that case. - -## Error Messages - -Each `precondition` or `postcondition` block must include an argument -`error_message`, which provides some custom error sentences that Terraform -will include as part of error messages when it detects an unmet condition. - -``` -Error: Resource postcondition failed - - with data.aws_ami.example, - on ec2.tf line 19, in data "aws_ami" "example": - 72: condition = self.tags["Component"] == "nomad-server" - |---------------- - | self.tags["Component"] is "consul-server" - -The selected AMI must be tagged with the Component value "nomad-server". -``` - -The `error_message` argument must always be a literal string, and should -typically be written as a full sentence in a style similar to Terraform's own -error messages. Terraform will show the given message alongside the name -of the resource that detected the problem and any outside values used as part -of the condition expression. - -## Preconditions or Postconditions? - -Because preconditions can refer to the result attributes of other resources -in the same module, it's typically true that a particular check could be -implemented either as a postcondition of the resource producing the data -or as a precondition of a resource or output value using the data. - -To decide which is most appropriate for a particular situation, consider -whether the check is representing either an assumption or a guarantee: - -* An _assumption_ is a condition that must be true in order for the - configuration of a particular resource to be usable. In the earlier - example on this page, the `aws_instance` configuration had the _assumption_ - that the given AMI will always be for the `x86_64` CPU architecture. - - Assumptions should typically be written as preconditions, so that future - maintainers can find them close to the other expressions that rely on - that condition, and thus know more about what different variations that - resource is intended to allow. - -* A _guarantee_ is a characteristic or behavior of an object that the rest of - the configuration ought to be able to rely on. In the earlier example on - this page, the `aws_instance` configuration had the _guarantee_ that the - EC2 instance will be running in a network that assigns it a private DNS - record. - - Guarantees should typically be written as postconditions, so that - future maintainers can find them close to the resource configuration that - is responsible for implementing those guarantees and more easily see - which behaviors are important to preserve when changing the configuration. - -In practice though, the distinction between these two is subjective: is the -AMI being tagged as Component `"nomad-server"` a guarantee about the AMI or -an assumption made by the EC2 instance? To decide, it might help to consider -which resource or output value would be most helpful to report in a resulting -error message, because Terraform will always report errors in the location -where the condition was declared. - -The decision between the two may also be a matter of convenience. If a -particular resource has many dependencies that _all_ make an assumption about -that resource then it can be pragmatic to declare that just once as a -post-condition of the resource, rather than many times as preconditions on -each of the dependencies. - -It may sometimes be helpful to declare the same or similar conditions as both -preconditions _and_ postconditions, particularly if the postcondition is -in a different module than the precondition, so that they can verify one -another as the two modules evolve independently. From 6e399dfbe02098deb22c89a1dd069a2931964cd6 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 7 Feb 2022 12:04:50 -0500 Subject: [PATCH 575/644] Update filename --- .../preconditions-postconditions.mdx | 391 ++++++++++++++++++ 1 file changed, 391 insertions(+) create mode 100644 website/docs/language/expressions/preconditions-postconditions.mdx diff --git a/website/docs/language/expressions/preconditions-postconditions.mdx b/website/docs/language/expressions/preconditions-postconditions.mdx new file mode 100644 index 000000000000..1aebff3b7eed --- /dev/null +++ b/website/docs/language/expressions/preconditions-postconditions.mdx @@ -0,0 +1,391 @@ +--- +page_title: Preconditions and Postconditions - Configuration Language +--- + +# Preconditions and Postconditions + +Terraform providers can automatically detect and report problems related to +the remote system they are interacting with, but they typically do so using +language that describes implementation details of the target system, which +can sometimes make it hard to find the root cause of the problem in your +Terraform configuration. + +Preconditions and postconditions allow you to optionally describe the +assumptions you are making as a module author, so that Terraform can detect +situations where those assumptions don't hold and potentially return an +error earlier or an error with better context about where the problem +originated. + +Preconditions and postconditions both follow a similar structure, and differ +only in when Terraform evaluates them: Terraform checks a precondition prior +to evaluating the object it is associated with, and a postcondition _after_ +evaluating the object. That means that preconditions are useful for stating +assumptions about data from elsewhere that the resource configuration relies +on, while postconditions are more useful for stating assumptions about the +result of the resource itself. + +The following example shows some different possible uses of preconditions and +postconditions. + +```hcl +variable "aws_ami_id" { + type = string + + # Input variable validation can check that the AMI ID is syntactically valid. + validation { + condition = can(regex("^ami-", var.aws_ami_id)) + error_message = "The AMI ID must have the prefix \"ami-\"." + } +} + +data "aws_ami" "example" { + id = var.aws_ami_id + + lifecycle { + # A data resource with a postcondition can ensure that the selected AMI + # meets this module's expectations, by reacting to the dynamically-loaded + # AMI attributes. + postcondition { + condition = self.tags["Component"] == "nomad-server" + error_message = "The selected AMI must be tagged with the Component value \"nomad-server\"." + } + } +} + +resource "aws_instance" "example" { + instance_type = "t2.micro" + ami = "ami-abc123" + + lifecycle { + # A resource with a precondition can ensure that the selected AMI + # is set up correctly to work with the instance configuration. + precondition { + condition = data.aws_ami.example.architecture == "x86_64" + error_message = "The selected AMI must be for the x86_64 architecture." + } + + # A resource with a postcondition can react to server-decided values + # during the apply step and halt work immediately if the result doesn't + # meet expectations. + postcondition { + condition = self.private_dns != "" + error_message = "EC2 instance must be in a VPC that has private DNS hostnames enabled." + } + } +} + +data "aws_ebs_volume" "example" { + # We can use data resources that refer to other resources in order to + # load extra data that isn't directly exported by a resource. + # + # This example reads the details about the root storage volume for + # the EC2 instance declared by aws_instance.example, using the exported ID. + + filter { + name = "volume-id" + values = [aws_instance.example.root_block_device.volume_id] + } +} + +output "api_base_url" { + value = "https://${aws_instance.example.private_dns}:8433/" + + # An output value with a precondition can check the object that the + # output value is describing to make sure it meets expectations before + # any caller of this module can use it. + precondition { + condition = data.aws_ebs_volume.example.encrypted + error_message = "The server's root volume is not encrypted." + } +} +``` + +The input variable validation rule, preconditions, and postconditions in the +above example declare explicitly some assumptions and guarantees that the +module developer is making in the design of this module: + +* The caller of the module must provide a syntactically-valid AMI ID in the + `aws_ami_id` input variable. + + This would detect if the caller accidentally assigned an AMI name to the + argument, instead of an AMI ID. + +* The AMI ID must refer to an AMI that exists and that has been tagged as + being intended for the component "nomad-server". + + This would detect if the caller accidentally provided an AMI intended for + some other system component, which might otherwise be detected only after + booting the EC2 instance and noticing that the expected network service + isn't running. Terraform can therefore detect that problem earlier and + return a more actionable error message for it. + +* The AMI ID must refer to an AMI which contains an operating system for the + `x86_64` architecture. + + This would detect if the caller accidentally built an AMI for a different + architecture, which might therefore not be able to run the software this + virtual machine is intended to host. + +* The EC2 instance must be allocated a private DNS hostname. + + In AWS, EC2 instances are assigned private DNS hostnames only if they + belong to a virtual network configured in a certain way. This would + detect if the selected virtual network is not configured correctly, + giving explicit feedback to prompt the user to debug the network settings. + +* The EC2 instance will have an encrypted root volume. + + This ensures that the root volume is encrypted even though the software + running in this EC2 instance would probably still operate as expected + on an unencrypted volume. Therefore Terraform can draw attention to the + problem immediately, before any other components rely on the + insecurely-configured component. + +Writing explicit preconditions and postconditions is always optional, but it +can be helpful to users and future maintainers of a Terraform module by +capturing assumptions that might otherwise be only implied, and by allowing +Terraform to check those assumptions and halt more quickly if they don't +hold in practice for a particular set of input variables. + +## Precondition and Postcondition Locations + +Terraform supports preconditions and postconditions in a number of different +locations in a module: + +* The `lifecycle` block inside a `resource` or `data` block can include both + `precondition` and `postcondition` blocks associated with the containing + resource. + + Terraform evaluates resource preconditions before evaluating the resource's + configuration arguments. Resource preconditions can take precedence over + argument evaluation errors. + + Terraform evaluates resource postconditions after planning and after + applying changes to a managed resource, or after reading from a data + resource. Resource postcondition failures will therefore prevent applying + changes to other resources that depend on the failing resource. + +* An `output` block declaring an output value can include a `precondition` + block. + + Terraform evaluates output value preconditions before evaluating the + `value` expression to finalize the result. Output value preconditions + can take precedence over potential errors in the `value` expression. + + Output value preconditions can be particularly useful in a root module, + to prevent saving an invalid new output value in the state and to preserve + the value from the previous apply, if any. + + Output value preconditions can serve a symmetrical purpose to input + variable `validation` blocks: whereas input variable validation checks + assumptions the module makes about its inputs, output value preconditions + check guarantees that the module makes about its outputs. + +## Condition Expressions + +`precondition` and `postcondition` blocks both require an argument named +`condition`, whose value is a boolean expression which should return `true` +if the intended assumption holds or `false` if it does not. + +Preconditions and postconditions can both refer to any other objects in the +same module, as long as the references don't create any cyclic dependencies. + +Resource postconditions can additionally refer to attributes of each instance +of the resource where they are configured, using the special symbol `self`. +For example, `self.private_dns` refers to the `private_dns` attribute of +each instance of the containing resource. + +Condition expressions are otherwise just normal Terraform expressions, and +so you can use any of Terraform's built-in functions or language operators +as long as the expression is valid and returns a boolean result. + +### Common Condition Expression Features + +Because condition expressions must produce boolean results, they can often +use built-in functions and language features that are less common elsewhere +in the Terraform language. The following language features are particularly +useful when writing condition expressions: + +* You can use the built-in function `contains` to test whether a given + value is one of a set of predefined valid values: + + ```hcl + condition = contains(["STAGE", "PROD"], var.environment) + ``` + +* You can use the boolean operators `&&` (AND), `||` (OR), and `!` (NOT) to + combine multiple simpler conditions together: + + ```hcl + condition = var.name != "" && lower(var.name) == var.name + ``` + +* You can require a non-empty list or map by testing the collection's length: + + ```hcl + condition = length(var.items) != 0 + ``` + + This is a better approach than directly comparing with another collection + using `==` or `!=`, because the comparison operators can only return `true` + if both operands have exactly the same type, which is often ambiguous + for empty collections. + +* You can use `for` expressions which produce lists of boolean results + themselves in conjunction with the functions `alltrue` and `anytrue` to + test whether a condition holds for all or for any elements of a collection: + + ```hcl + condition = alltrue([ + for v in var.instances : contains(["t2.micro", "m3.medium"], v.type) + ]) + ``` + +* You can use the `can` function to concisely use the validity of an expression + as a condition. It returns `true` if its given expression evaluates + successfully and `false` if it returns any error, so you can use various + other functions that typically return errors as a part of your condition + expressions. + + For example, you can use `can` with `regex` to test if a string matches + a particular pattern, because `regex` returns an error when given a + non-matching string: + + ```hcl + condition = can(regex("^[a-z]+$", var.name) + ``` + + You can also use `can` with the type conversion functions to test whether + a value is convertible to a type or type constraint: + + ```hcl + # This remote output value must have a value that can + # be used as a string, which includes strings themselves + # but also allows numbers and boolean values. + condition = can(tostring(data.terraform_remote_state.example.outputs["name"])) + ``` + + ```hcl + # This remote output value must be convertible to a list + # type of with element type. + condition = can(tolist(data.terraform_remote_state.example.outputs["items"])) + ``` + + You can also use `can` with attribute access or index operators to + concisely test whether a collection or structural value has a particular + element or index: + + ```hcl + # var.example must have an attribute named "foo" + condition = can(var.example.foo) + ``` + + ```hcl + # var.example must be a sequence with at least one element + condition = can(var.example[0]) + # (although it would typically be clearer to write this as a + # test like length(var.example) > 0 to better represent the + # intent of the condition.) + ``` + +## Early Evaluation + +Terraform will evaluate conditions as early as possible. + +If the condition expression depends on a resource attribute that won't be known +until the apply phase then Terraform will delay checking the condition until +the apply phase, but Terraform can check all other expressions during the +planning phase, and therefore block applying a plan that would violate the +conditions. + +In the earlier example on this page, Terraform would typically be able to +detect invalid AMI tags during the planning phase, as long as `var.aws_ami_id` +is not itself derived from another resource. However, Terraform will not +detect a non-encrypted root volume until the EC2 instance was already created +during the apply step, because that condition depends on the root volume's +assigned ID, which AWS decides only when the EC2 instance is actually started. + +For conditions which Terraform must defer to the apply phase, a _precondition_ +will prevent taking whatever action was planned for a related resource, whereas +a _postcondition_ will merely halt processing after that action was already +taken, preventing any downstream actions that rely on it but not undoing the +action. + +Terraform typically has less information during the initial creation of a +full configuration than when applying subsequent changes to that configuration. +Conditions checked only during apply during initial creation may therefore +be checked during planning on subsequent updates, detecting problems sooner +in that case. + +## Error Messages + +Each `precondition` or `postcondition` block must include an argument +`error_message`, which provides some custom error sentences that Terraform +will include as part of error messages when it detects an unmet condition. + +``` +Error: Resource postcondition failed + + with data.aws_ami.example, + on ec2.tf line 19, in data "aws_ami" "example": + 72: condition = self.tags["Component"] == "nomad-server" + |---------------- + | self.tags["Component"] is "consul-server" + +The selected AMI must be tagged with the Component value "nomad-server". +``` + +The `error_message` argument must always be a literal string, and should +typically be written as a full sentence in a style similar to Terraform's own +error messages. Terraform will show the given message alongside the name +of the resource that detected the problem and any outside values used as part +of the condition expression. + +## Preconditions or Postconditions? + +Because preconditions can refer to the result attributes of other resources +in the same module, it's typically true that a particular check could be +implemented either as a postcondition of the resource producing the data +or as a precondition of a resource or output value using the data. + +To decide which is most appropriate for a particular situation, consider +whether the check is representing either an assumption or a guarantee: + +* An _assumption_ is a condition that must be true in order for the + configuration of a particular resource to be usable. In the earlier + example on this page, the `aws_instance` configuration had the _assumption_ + that the given AMI will always be for the `x86_64` CPU architecture. + + Assumptions should typically be written as preconditions, so that future + maintainers can find them close to the other expressions that rely on + that condition, and thus know more about what different variations that + resource is intended to allow. + +* A _guarantee_ is a characteristic or behavior of an object that the rest of + the configuration ought to be able to rely on. In the earlier example on + this page, the `aws_instance` configuration had the _guarantee_ that the + EC2 instance will be running in a network that assigns it a private DNS + record. + + Guarantees should typically be written as postconditions, so that + future maintainers can find them close to the resource configuration that + is responsible for implementing those guarantees and more easily see + which behaviors are important to preserve when changing the configuration. + +In practice though, the distinction between these two is subjective: is the +AMI being tagged as Component `"nomad-server"` a guarantee about the AMI or +an assumption made by the EC2 instance? To decide, it might help to consider +which resource or output value would be most helpful to report in a resulting +error message, because Terraform will always report errors in the location +where the condition was declared. + +The decision between the two may also be a matter of convenience. If a +particular resource has many dependencies that _all_ make an assumption about +that resource then it can be pragmatic to declare that just once as a +post-condition of the resource, rather than many times as preconditions on +each of the dependencies. + +It may sometimes be helpful to declare the same or similar conditions as both +preconditions _and_ postconditions, particularly if the postcondition is +in a different module than the precondition, so that they can verify one +another as the two modules evolve independently. From d81335a55edda7d8e333791979bf2a5f9fe58f75 Mon Sep 17 00:00:00 2001 From: sian Date: Mon, 7 Feb 2022 18:12:26 +0000 Subject: [PATCH 576/644] delete comma from single entry list --- website/docs/language/meta-arguments/depends_on.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/meta-arguments/depends_on.mdx b/website/docs/language/meta-arguments/depends_on.mdx index 0792e721afc1..4e722064fc0a 100644 --- a/website/docs/language/meta-arguments/depends_on.mdx +++ b/website/docs/language/meta-arguments/depends_on.mdx @@ -61,7 +61,7 @@ resource "aws_instance" "example" { # dependency on the aws_iam_role_policy that Terraform cannot # automatically infer, so it must be declared explicitly: depends_on = [ - aws_iam_role_policy.example, + aws_iam_role_policy.example ] } ``` From f5b90f84a8f309d295d1dc53536d5b7f7f7a4753 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 10 Dec 2021 12:48:32 -0500 Subject: [PATCH 577/644] jsonconfig: Improve provider configuration output When rendering configuration as JSON, we have a single map of provider configurations at the top level, since these are globally applicable. Each resource has an opaque key into this map which points at the configuration data for the provider. This commit fixes two bugs in this implementation: - Resources in non-root modules had an invalid provider config key, which meant that there was never a valid reference to the provider config block. These keys were prefixed with the local module name instead of the path to the module. This is now corrected. - Modules with passed provider configs would point to either an empty provider config block or one which is not present at all. This has been fixed so that these resources point to the provider config block from the calling module (or wherever up the module tree it was originally defined). We also add a "full_name" key-value pair to the provider config block, with the entire fully-qualified provider name including hostname and namespace. --- internal/command/jsonconfig/config.go | 110 +++- .../testdata/show-json-sensitive/output.json | 1 + .../show-json/basic-create/output.json | 1 + .../testdata/show-json/modules/output.json | 7 +- .../show-json/nested-modules/output.json | 2 +- .../show-json/provider-aliasing/child/main.tf | 26 + .../provider-aliasing/child/nested/main.tf | 18 + .../show-json/provider-aliasing/main.tf | 34 ++ .../show-json/provider-aliasing/output.json | 567 ++++++++++++++++++ .../provider-version-no-config/output.json | 1 + .../show-json/provider-version/output.json | 1 + website/docs/internals/json-format.mdx | 11 +- 12 files changed, 768 insertions(+), 11 deletions(-) create mode 100644 internal/command/testdata/show-json/provider-aliasing/child/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing/child/nested/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing/main.tf create mode 100755 internal/command/testdata/show-json/provider-aliasing/output.json diff --git a/internal/command/jsonconfig/config.go b/internal/command/jsonconfig/config.go index 617181ba608b..807444d6e4f1 100644 --- a/internal/command/jsonconfig/config.go +++ b/internal/command/jsonconfig/config.go @@ -27,10 +27,12 @@ type config struct { // module boundaries. type providerConfig struct { Name string `json:"name,omitempty"` + FullName string `json:"full_name,omitempty"` Alias string `json:"alias,omitempty"` VersionConstraint string `json:"version_constraint,omitempty"` ModuleAddress string `json:"module_address,omitempty"` Expressions map[string]interface{} `json:"expressions,omitempty"` + parentKey string } type module struct { @@ -120,7 +122,6 @@ func Marshal(c *configs.Config, schemas *terraform.Schemas) ([]byte, error) { pcs := make(map[string]providerConfig) marshalProviderConfigs(c, schemas, pcs) - output.ProviderConfigs = pcs rootModule, err := marshalModule(c, schemas, "") if err != nil { @@ -128,6 +129,15 @@ func Marshal(c *configs.Config, schemas *terraform.Schemas) ([]byte, error) { } output.RootModule = rootModule + normalizeModuleProviderKeys(&rootModule, pcs) + + for name, pc := range pcs { + if pc.parentKey != "" { + delete(pcs, name) + } + } + output.ProviderConfigs = pcs + ret, err := json.Marshal(output) return ret, err } @@ -154,6 +164,7 @@ func marshalProviderConfigs( p := providerConfig{ Name: pc.Name, + FullName: providerFqn.String(), Alias: pc.Alias, ModuleAddress: c.Path.String(), Expressions: marshalExpressions(pc.Config, schema), @@ -176,6 +187,30 @@ func marshalProviderConfigs( // Ensure that any required providers with no associated configuration // block are included in the set. for k, pr := range c.Module.ProviderRequirements.RequiredProviders { + // If a provider has aliases defined, process those first. + for _, alias := range pr.Aliases { + // If there exists a value for this provider, we have nothing to add + // to it, so skip. + key := opaqueProviderKey(alias.StringCompact(), c.Path.String()) + if _, exists := m[key]; exists { + continue + } + // Given no provider configuration block exists, the only fields we can + // fill here are the local name, FQN, module address, and version + // constraints. + p := providerConfig{ + Name: pr.Name, + FullName: pr.Type.String(), + ModuleAddress: c.Path.String(), + } + + if vc, ok := reqs[pr.Type]; ok { + p.VersionConstraint = getproviders.VersionConstraintsString(vc) + } + + m[key] = p + } + // If there exists a value for this provider, we have nothing to add // to it, so skip. key := opaqueProviderKey(k, c.Path.String()) @@ -188,6 +223,7 @@ func marshalProviderConfigs( // constraints. p := providerConfig{ Name: pr.Name, + FullName: pr.Type.String(), ModuleAddress: c.Path.String(), } @@ -199,7 +235,53 @@ func marshalProviderConfigs( } // Must also visit our child modules, recursively. - for _, cc := range c.Children { + for name, mc := range c.Module.ModuleCalls { + // Keys in c.Children are guaranteed to match those in c.Module.ModuleCalls + cc := c.Children[name] + + // Add provider config map entries for passed provider configs, + // pointing at the passed configuration + for _, ppc := range mc.Providers { + // These provider names include aliases, if set + moduleProviderName := ppc.InChild.String() + parentProviderName := ppc.InParent.String() + + // Look up the provider FQN from the module context, using the non-aliased local name + providerFqn := cc.ProviderForConfigAddr(addrs.LocalProviderConfig{LocalName: ppc.InChild.Name}) + + // The presence of passed provider configs means that we cannot have + // any configuration expressions or version constraints here + p := providerConfig{ + Name: moduleProviderName, + FullName: providerFqn.String(), + ModuleAddress: cc.Path.String(), + } + + key := opaqueProviderKey(moduleProviderName, cc.Path.String()) + parentKey := opaqueProviderKey(parentProviderName, cc.Parent.Path.String()) + + // Traverse up the module call tree until we find the provider + // configuration which has no linked parent config. This is then + // the source of the configuration used in this module call, so + // we link to it directly + for { + parent, exists := m[parentKey] + if !exists { + break + } + p.parentKey = parentKey + parentKey = parent.parentKey + if parentKey == "" { + break + } + } + + m[key] = p + } + + // Finally, marshal any other provider configs within the called module. + // It is safe to do this last because it is invalid to configure a + // provider which has passed provider configs in the module call. marshalProviderConfigs(cc, schemas, m) } } @@ -319,7 +401,9 @@ func marshalModuleCall(c *configs.Config, mc *configs.ModuleCall, schemas *terra } ret.Expressions = marshalExpressions(mc.Config, schema) - module, _ := marshalModule(c, schemas, mc.Name) + + module, _ := marshalModule(c, schemas, c.Path.String()) + ret.Module = module if len(mc.DependsOn) > 0 { @@ -342,11 +426,12 @@ func marshalModuleCall(c *configs.Config, mc *configs.ModuleCall, schemas *terra func marshalResources(resources map[string]*configs.Resource, schemas *terraform.Schemas, moduleAddr string) ([]resource, error) { var rs []resource for _, v := range resources { + providerConfigKey := opaqueProviderKey(v.ProviderConfigAddr().StringCompact(), moduleAddr) r := resource{ Address: v.Addr().String(), Type: v.Type, Name: v.Name, - ProviderConfigKey: opaqueProviderKey(v.ProviderConfigAddr().StringCompact(), moduleAddr), + ProviderConfigKey: providerConfigKey, } switch v.Mode { @@ -416,6 +501,23 @@ func marshalResources(resources map[string]*configs.Resource, schemas *terraform return rs, nil } +// Flatten all resource provider keys in a module and its descendents, such +// that any resources from providers using a configuration passed through the +// module call have a direct refernce to that provider configuration. +func normalizeModuleProviderKeys(m *module, pcs map[string]providerConfig) { + for i, r := range m.Resources { + if pc, exists := pcs[r.ProviderConfigKey]; exists { + if _, hasParent := pcs[pc.parentKey]; hasParent { + m.Resources[i].ProviderConfigKey = pc.parentKey + } + } + } + + for _, mc := range m.ModuleCalls { + normalizeModuleProviderKeys(&mc.Module, pcs) + } +} + // opaqueProviderKey generates a unique absProviderConfig-like string from the module // address and provider func opaqueProviderKey(provider string, addr string) (key string) { diff --git a/internal/command/testdata/show-json-sensitive/output.json b/internal/command/testdata/show-json-sensitive/output.json index 206fbb7f6e60..9d1ec24bc800 100644 --- a/internal/command/testdata/show-json-sensitive/output.json +++ b/internal/command/testdata/show-json-sensitive/output.json @@ -164,6 +164,7 @@ "provider_config": { "test": { "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", "expressions": { "region": { "constant_value": "somewhere" diff --git a/internal/command/testdata/show-json/basic-create/output.json b/internal/command/testdata/show-json/basic-create/output.json index d1b8aae5361b..83c14458066c 100644 --- a/internal/command/testdata/show-json/basic-create/output.json +++ b/internal/command/testdata/show-json/basic-create/output.json @@ -152,6 +152,7 @@ "provider_config": { "test": { "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", "expressions": { "region": { "constant_value": "somewhere" diff --git a/internal/command/testdata/show-json/modules/output.json b/internal/command/testdata/show-json/modules/output.json index 4ed0ea45d692..1728282592de 100644 --- a/internal/command/testdata/show-json/modules/output.json +++ b/internal/command/testdata/show-json/modules/output.json @@ -224,7 +224,7 @@ "mode": "managed", "type": "test_instance", "name": "test", - "provider_config_key": "module_test_bar:test", + "provider_config_key": "module.module_test_bar:test", "expressions": { "ami": { "references": [ @@ -265,7 +265,7 @@ "mode": "managed", "type": "test_instance", "name": "test", - "provider_config_key": "module_test_foo:test", + "provider_config_key": "module.module_test_foo:test", "expressions": { "ami": { "references": [ @@ -291,7 +291,8 @@ "provider_config": { "module.module_test_foo:test": { "module_address": "module.module_test_foo", - "name": "test" + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" } } } diff --git a/internal/command/testdata/show-json/nested-modules/output.json b/internal/command/testdata/show-json/nested-modules/output.json index 359ea9ae181c..6d0af8a1468c 100644 --- a/internal/command/testdata/show-json/nested-modules/output.json +++ b/internal/command/testdata/show-json/nested-modules/output.json @@ -68,7 +68,7 @@ "mode": "managed", "type": "test_instance", "name": "test", - "provider_config_key": "more:test", + "provider_config_key": "module.my_module.module.more:test", "expressions": { "ami": { "references": [ diff --git a/internal/command/testdata/show-json/provider-aliasing/child/main.tf b/internal/command/testdata/show-json/provider-aliasing/child/main.tf new file mode 100644 index 000000000000..42555752cfd1 --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing/child/main.tf @@ -0,0 +1,26 @@ +terraform { + required_providers { + test = { + source = "hashicorp/test" + configuration_aliases = [test, test.second] + } + } +} + +resource "test_instance" "test_primary" { + ami = "primary" + provider = test +} + +resource "test_instance" "test_secondary" { + ami = "secondary" + provider = test.second +} + +module "grandchild" { + source = "./nested" + providers = { + test = test + test.alt = test.second + } +} diff --git a/internal/command/testdata/show-json/provider-aliasing/child/nested/main.tf b/internal/command/testdata/show-json/provider-aliasing/child/nested/main.tf new file mode 100644 index 000000000000..ff1fe9a1afba --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing/child/nested/main.tf @@ -0,0 +1,18 @@ +terraform { + required_providers { + test = { + source = "hashicorp/test" + configuration_aliases = [test, test.alt] + } + } +} + +resource "test_instance" "test_main" { + ami = "main" + provider = test +} + +resource "test_instance" "test_alternate" { + ami = "secondary" + provider = test.alt +} diff --git a/internal/command/testdata/show-json/provider-aliasing/main.tf b/internal/command/testdata/show-json/provider-aliasing/main.tf new file mode 100644 index 000000000000..7f6b0a3e337a --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing/main.tf @@ -0,0 +1,34 @@ +provider "test" { + region = "somewhere" +} + +provider "test" { + alias = "backup" + region = "elsewhere" +} + +resource "test_instance" "test" { + ami = "foo" + provider = test +} + +resource "test_instance" "test_backup" { + ami = "foo-backup" + provider = test.backup +} + +module "child" { + source = "./child" + providers = { + test = test + test.second = test.backup + } +} + +module "sibling" { + source = "./child" + providers = { + test = test + test.second = test + } +} diff --git a/internal/command/testdata/show-json/provider-aliasing/output.json b/internal/command/testdata/show-json/provider-aliasing/output.json new file mode 100755 index 000000000000..187141c9cf88 --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing/output.json @@ -0,0 +1,567 @@ +{ + "format_version": "1.0", + "terraform_version": "1.1.0-dev", + "planned_values": { + "root_module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "foo" + }, + "sensitive_values": {} + }, + { + "address": "test_instance.test_backup", + "mode": "managed", + "type": "test_instance", + "name": "test_backup", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "foo-backup" + }, + "sensitive_values": {} + } + ], + "child_modules": [ + { + "resources": [ + { + "address": "module.child.test_instance.test_primary", + "mode": "managed", + "type": "test_instance", + "name": "test_primary", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "primary" + }, + "sensitive_values": {} + }, + { + "address": "module.child.test_instance.test_secondary", + "mode": "managed", + "type": "test_instance", + "name": "test_secondary", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "secondary" + }, + "sensitive_values": {} + } + ], + "address": "module.child", + "child_modules": [ + { + "resources": [ + { + "address": "module.child.module.grandchild.test_instance.test_alternate", + "mode": "managed", + "type": "test_instance", + "name": "test_alternate", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "secondary" + }, + "sensitive_values": {} + }, + { + "address": "module.child.module.grandchild.test_instance.test_main", + "mode": "managed", + "type": "test_instance", + "name": "test_main", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "main" + }, + "sensitive_values": {} + } + ], + "address": "module.child.module.grandchild" + } + ] + }, + { + "resources": [ + { + "address": "module.sibling.test_instance.test_primary", + "mode": "managed", + "type": "test_instance", + "name": "test_primary", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "primary" + }, + "sensitive_values": {} + }, + { + "address": "module.sibling.test_instance.test_secondary", + "mode": "managed", + "type": "test_instance", + "name": "test_secondary", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "secondary" + }, + "sensitive_values": {} + } + ], + "address": "module.sibling", + "child_modules": [ + { + "resources": [ + { + "address": "module.sibling.module.grandchild.test_instance.test_alternate", + "mode": "managed", + "type": "test_instance", + "name": "test_alternate", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "secondary" + }, + "sensitive_values": {} + }, + { + "address": "module.sibling.module.grandchild.test_instance.test_main", + "mode": "managed", + "type": "test_instance", + "name": "test_main", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "main" + }, + "sensitive_values": {} + } + ], + "address": "module.sibling.module.grandchild" + } + ] + } + ] + } + }, + "resource_changes": [ + { + "address": "module.child.module.grandchild.test_instance.test_alternate", + "module_address": "module.child.module.grandchild", + "mode": "managed", + "type": "test_instance", + "name": "test_alternate", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "secondary" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.child.module.grandchild.test_instance.test_main", + "module_address": "module.child.module.grandchild", + "mode": "managed", + "type": "test_instance", + "name": "test_main", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "main" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.child.test_instance.test_primary", + "module_address": "module.child", + "mode": "managed", + "type": "test_instance", + "name": "test_primary", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "primary" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.child.test_instance.test_secondary", + "module_address": "module.child", + "mode": "managed", + "type": "test_instance", + "name": "test_secondary", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "secondary" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.sibling.module.grandchild.test_instance.test_alternate", + "module_address": "module.sibling.module.grandchild", + "mode": "managed", + "type": "test_instance", + "name": "test_alternate", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "secondary" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.sibling.module.grandchild.test_instance.test_main", + "module_address": "module.sibling.module.grandchild", + "mode": "managed", + "type": "test_instance", + "name": "test_main", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "main" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.sibling.test_instance.test_primary", + "module_address": "module.sibling", + "mode": "managed", + "type": "test_instance", + "name": "test_primary", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "primary" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.sibling.test_instance.test_secondary", + "module_address": "module.sibling", + "mode": "managed", + "type": "test_instance", + "name": "test_secondary", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "secondary" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "foo" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "test_instance.test_backup", + "mode": "managed", + "type": "test_instance", + "name": "test_backup", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "foo-backup" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + } + ], + "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", + "expressions": { + "region": { + "constant_value": "somewhere" + } + } + }, + "test.backup": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", + "alias": "backup", + "expressions": { + "region": { + "constant_value": "elsewhere" + } + } + } + }, + "root_module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "foo" + } + }, + "schema_version": 0 + }, + { + "address": "test_instance.test_backup", + "mode": "managed", + "type": "test_instance", + "name": "test_backup", + "provider_config_key": "test.backup", + "expressions": { + "ami": { + "constant_value": "foo-backup" + } + }, + "schema_version": 0 + } + ], + "module_calls": { + "child": { + "source": "./child", + "module": { + "resources": [ + { + "address": "test_instance.test_primary", + "mode": "managed", + "type": "test_instance", + "name": "test_primary", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "primary" + } + }, + "schema_version": 0 + }, + { + "address": "test_instance.test_secondary", + "mode": "managed", + "type": "test_instance", + "name": "test_secondary", + "provider_config_key": "test.backup", + "expressions": { + "ami": { + "constant_value": "secondary" + } + }, + "schema_version": 0 + } + ], + "module_calls": { + "grandchild": { + "source": "./nested", + "module": { + "resources": [ + { + "address": "test_instance.test_alternate", + "mode": "managed", + "type": "test_instance", + "name": "test_alternate", + "provider_config_key": "test.backup", + "expressions": { + "ami": { + "constant_value": "secondary" + } + }, + "schema_version": 0 + }, + { + "address": "test_instance.test_main", + "mode": "managed", + "type": "test_instance", + "name": "test_main", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "main" + } + }, + "schema_version": 0 + } + ] + } + } + } + } + }, + "sibling": { + "source": "./child", + "module": { + "resources": [ + { + "address": "test_instance.test_primary", + "mode": "managed", + "type": "test_instance", + "name": "test_primary", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "primary" + } + }, + "schema_version": 0 + }, + { + "address": "test_instance.test_secondary", + "mode": "managed", + "type": "test_instance", + "name": "test_secondary", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "secondary" + } + }, + "schema_version": 0 + } + ], + "module_calls": { + "grandchild": { + "source": "./nested", + "module": { + "resources": [ + { + "address": "test_instance.test_alternate", + "mode": "managed", + "type": "test_instance", + "name": "test_alternate", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "secondary" + } + }, + "schema_version": 0 + }, + { + "address": "test_instance.test_main", + "mode": "managed", + "type": "test_instance", + "name": "test_main", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "main" + } + }, + "schema_version": 0 + } + ] + } + } + } + } + } + } + } + } +} diff --git a/internal/command/testdata/show-json/provider-version-no-config/output.json b/internal/command/testdata/show-json/provider-version-no-config/output.json index 6a8b1f451dc0..b5e78402d8b6 100644 --- a/internal/command/testdata/show-json/provider-version-no-config/output.json +++ b/internal/command/testdata/show-json/provider-version-no-config/output.json @@ -152,6 +152,7 @@ "provider_config": { "test": { "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", "version_constraint": ">= 1.2.3" } }, diff --git a/internal/command/testdata/show-json/provider-version/output.json b/internal/command/testdata/show-json/provider-version/output.json index 11fd3bd64c15..4d86a29b05ca 100644 --- a/internal/command/testdata/show-json/provider-version/output.json +++ b/internal/command/testdata/show-json/provider-version/output.json @@ -152,6 +152,7 @@ "provider_config": { "test": { "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", "expressions": { "region": { "constant_value": "somewhere" diff --git a/website/docs/internals/json-format.mdx b/website/docs/internals/json-format.mdx index 556d442eeb36..9d76f4c7473c 100644 --- a/website/docs/internals/json-format.mdx +++ b/website/docs/internals/json-format.mdx @@ -323,7 +323,7 @@ Because the configuration models are produced at a stage prior to expression eva // the configuration tree, flattened into a single map for convenience since // provider configurations are the one concept in Terraform that can span // across module boundaries. - "provider_configs": { + "provider_config": { // Keys in the provider_configs map are to be considered opaque by callers, // and used just for lookups using the "provider_config_key" property in each @@ -333,6 +333,9 @@ Because the configuration models are produced at a stage prior to expression eva // "name" is the name of the provider without any alias "name": "aws", + // "full_name" is the fully-qualified provider name + "full_name": "registry.terraform.io/hashicorp/aws", + // "alias" is the alias set for a non-default configuration, or unset for // a default configuration. "alias": "foo", @@ -378,7 +381,9 @@ Because the configuration models are produced at a stage prior to expression eva // "provider_config_key" is the key into "provider_configs" (shown // above) for the provider configuration that this resource is - // associated with. + // associated with. If the provider configuration was passed into + // this module from the parent module, the key will point to the + // original provider config block. "provider_config_key": "opaque_provider_ref_aws", // "provisioners" is an optional field which describes any provisioners. @@ -440,7 +445,7 @@ Because the configuration models are produced at a stage prior to expression eva // "module" is a representation of the configuration of the child module // itself, using the same structure as the "root_module" object, // recursively describing the full module tree. - "module": , + "module": } } } From ddc81a204f8ce950329f1d5f2d0f8b6cce08c472 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 7 Feb 2022 15:04:49 -0500 Subject: [PATCH 578/644] json: Disregard format version in tests Instead of manually updating every JSON output test fixture when we change the format version, disregard any differences when testing. --- internal/command/show_test.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/internal/command/show_test.go b/internal/command/show_test.go index 5f220e906ee0..00a9e555a2e5 100644 --- a/internal/command/show_test.go +++ b/internal/command/show_test.go @@ -576,6 +576,9 @@ func TestShow_json_output(t *testing.T) { } json.Unmarshal([]byte(byteValue), &want) + // Disregard format version to reduce needless test fixture churn + want.FormatVersion = got.FormatVersion + if !cmp.Equal(got, want) { t.Fatalf("wrong result:\n %v\n", cmp.Diff(got, want)) } @@ -667,6 +670,9 @@ func TestShow_json_output_sensitive(t *testing.T) { } json.Unmarshal([]byte(byteValue), &want) + // Disregard format version to reduce needless test fixture churn + want.FormatVersion = got.FormatVersion + if !cmp.Equal(got, want) { t.Fatalf("wrong result:\n %v\n", cmp.Diff(got, want)) } From fe8183c4af882bd92dd52e86e9b11e7251174d1c Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 7 Feb 2022 15:06:05 -0500 Subject: [PATCH 579/644] json: Increment JSON plan format version The JSON plan configuration data now includes a `full_name` field for providers. This addition warrants a backwards compatible increment to the version number. --- internal/command/jsonplan/plan.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index 06ed97961012..53fe8ec01b45 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -22,7 +22,7 @@ import ( // FormatVersion represents the version of the json format and will be // incremented for any change to this format that requires changes to a // consuming parser. -const FormatVersion = "1.0" +const FormatVersion = "1.1" // Plan is the top-level representation of the json format of a plan. It includes // the complete config and current state. From 879edcae726ba93a18b9615ba42942ced298a2d7 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 7 Feb 2022 18:09:07 -0500 Subject: [PATCH 580/644] wording changes --- .../language/meta-arguments/depends_on.mdx | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/website/docs/language/meta-arguments/depends_on.mdx b/website/docs/language/meta-arguments/depends_on.mdx index 0792e721afc1..a5674a40693b 100644 --- a/website/docs/language/meta-arguments/depends_on.mdx +++ b/website/docs/language/meta-arguments/depends_on.mdx @@ -7,24 +7,30 @@ description: >- # The `depends_on` Meta-Argument --> **Version note:** Module support for `depends_on` was added in Terraform 0.13, and -previous versions can only use it with resources. +Use the `depends_on` meta-argument to handle hidden resource or module dependencies that Terraform cannot automatically infer. You only need to explicitly specify a dependency when a resource or module relies on another resource's behavior but does not access any of that resource's data in its arguments. -Use the `depends_on` meta-argument to handle hidden resource or module dependencies that -Terraform can't automatically infer. +-> **Note:** Module support for `depends_on` was added in Terraform version 0.13, and prior versions can only use it with resources. -Explicitly specifying a dependency is only necessary when a resource or module relies on -some other resource's behavior but _doesn't_ access any of that resource's data -in its arguments. -This argument is available in `module` blocks and in all `resource` blocks, -regardless of resource type. For example: +## Processing and Planning Consequences + +The `depends_on` meta-argument instructs Terraform to complete all actions on the the dependency object (including Read actions) before performing actions on the object declaring the dependency. When one the dependency object is an entire module, `depends_on` affects the order in which Terraform processes all of the resources and data sources associated with that module. Refer to [Resource Dependencies](/language/resources/behavior#resource-dependencies) and [Data Resource Dependencies](/language/data-sources#data-resource-dependencies) for more details. + +You should use `depends_on` as a last resort because it can cause Terraform to create more conservative plans that replace more resources than necessary. For example, Terraform may treat more values as unknown “(known after apply)” because it is uncertain what changes will occur on the upstream object. This is especially likely when you use `depends_on` for modules. + +Instead of `depends_on`, we recommend using [expression references](/language/expressions/references) to imply dependencies when possible. Expression references let Terraform understand which value the reference derives from and avoid planning changes if that particular value hasn’t changed, even if other parts of the upstream object have planned changes. + +## Usage + +You can use the `depends_on` meta-argument in `module` blocks and in all `resource` blocks, regardless of resource type. It requires a list of references to other resources or child modules in the same calling module. This list cannot include arbitrary expressions because the `depends_on` value must be known before Terraform knows resource relationships and thus before it can safely evaluate expressions. + +We recommend always including a comment that explains why using `depends_on` is necessary. The following example uses `depends_on` to handle a "hidden" dependency on the `aws_iam_instance_profile.example`. ```hcl resource "aws_iam_role" "example" { name = "example" - # assume_role_policy is omitted for brevity in this example. See the + # assume_role_policy is omitted for brevity in this example. Refer to the # documentation for aws_iam_role for a complete example. assume_role_policy = "..." } @@ -66,12 +72,6 @@ resource "aws_instance" "example" { } ``` -The `depends_on` meta-argument, if present, must be a list of references -to other resources or child modules in the same calling module. -Arbitrary expressions are not allowed in the `depends_on` argument value, -because its value must be known before Terraform knows resource relationships -and thus before it can safely evaluate expressions. -The `depends_on` argument should be used only as a last resort. When using it, -always include a comment explaining why it is being used, to help future -maintainers understand the purpose of the additional dependency. + + From 7eee8c674e44a8bc8a69a3e5af61c497dd253dfc Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 7 Feb 2022 18:16:16 -0500 Subject: [PATCH 581/644] Remove extra spaces --- website/docs/language/meta-arguments/depends_on.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/website/docs/language/meta-arguments/depends_on.mdx b/website/docs/language/meta-arguments/depends_on.mdx index a5674a40693b..269675b2927b 100644 --- a/website/docs/language/meta-arguments/depends_on.mdx +++ b/website/docs/language/meta-arguments/depends_on.mdx @@ -70,8 +70,4 @@ resource "aws_instance" "example" { aws_iam_role_policy.example, ] } -``` - - - - +``` \ No newline at end of file From fe6092f325a494e0029b26829c8d0f455c0e5161 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Mon, 7 Feb 2022 18:45:07 -0500 Subject: [PATCH 582/644] Add line about how you can't use console during a run --- website/docs/cli/commands/console.mdx | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/website/docs/cli/commands/console.mdx b/website/docs/cli/commands/console.mdx index 2f7edcfa5379..a9f8feac2882 100644 --- a/website/docs/cli/commands/console.mdx +++ b/website/docs/cli/commands/console.mdx @@ -16,15 +16,12 @@ Usage: `terraform console [options]` This command provides an interactive command-line console for evaluating and experimenting with [expressions](/language/expressions). -This is useful for testing interpolations before using them in configurations, -and for interacting with any values currently saved in -[state](/language/state). +You can use it to test interpolations before using them in configurations +and to interact with any values currently saved in +[state](/language/state). If the current state is empty or has not yet been created, you can use the console to experiment with the expression syntax and +[built-in functions](/language/functions). You cannot use the console during a run because Terraform prevents read actions while it is writing new state. -If the current state is empty or has not yet been created, the console can be -used to experiment with the expression syntax and -[built-in functions](/language/functions). - -You can close the console with the `exit` command or by pressing Control-C +To close the console, enter the `exit` command or press Control-C or Control-D. For configurations using From 3c40dac0bc9a45d83a5e6987e3632ffa2be51c8d Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Tue, 8 Feb 2022 16:22:44 -0500 Subject: [PATCH 583/644] Fix according to PR comments --- website/docs/cli/commands/console.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/console.mdx b/website/docs/cli/commands/console.mdx index a9f8feac2882..40e3b5e6fdd2 100644 --- a/website/docs/cli/commands/console.mdx +++ b/website/docs/cli/commands/console.mdx @@ -19,7 +19,7 @@ experimenting with [expressions](/language/expressions). You can use it to test interpolations before using them in configurations and to interact with any values currently saved in [state](/language/state). If the current state is empty or has not yet been created, you can use the console to experiment with the expression syntax and -[built-in functions](/language/functions). You cannot use the console during a run because Terraform prevents read actions while it is writing new state. +[built-in functions](/language/functions). The console holds a [lock on the state](/language/state/locking), and you will not be able to use the console while performing other actions that modify state. To close the console, enter the `exit` command or press Control-C or Control-D. From ba0e2c1133f0ec26445aa478fada1897e2311e20 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 9 Feb 2022 14:10:11 -0500 Subject: [PATCH 584/644] Update remote backend page to clarify workspace.name expression --- .../language/settings/backends/remote.mdx | 60 +++++++++++-------- 1 file changed, 36 insertions(+), 24 deletions(-) diff --git a/website/docs/language/settings/backends/remote.mdx b/website/docs/language/settings/backends/remote.mdx index e67c90e27b6d..d15fd21624a7 100644 --- a/website/docs/language/settings/backends/remote.mdx +++ b/website/docs/language/settings/backends/remote.mdx @@ -14,7 +14,7 @@ The remote backend is unique among all other Terraform backends because it can b When using full remote operations, operations like `terraform plan` or `terraform apply` can be executed in Terraform Cloud's run environment, with log output streaming to the local terminal. Remote plans and applies use variable values from the associated Terraform Cloud workspace. -Terraform Cloud can also be used with local operations, in which case only state is stored in the Terraform Cloud backend. +You can also use Terraform Cloud with local operations, in which case only state is stored in the Terraform Cloud backend. ## Command Support @@ -41,9 +41,7 @@ Currently the remote backend supports the following Terraform commands: ## Workspaces -The remote backend can work with either a single remote Terraform Cloud workspace, -or with multiple similarly-named remote workspaces (like `networking-dev` -and `networking-prod`). The `workspaces` block of the backend configuration +The remote backend can work with either a single remote Terraform Cloud workspace, or with multiple similarly-named remote workspaces (like `networking-dev` and `networking-prod`). The `workspaces` block of the backend configuration determines which mode it uses: - To use a single remote Terraform Cloud workspace, set `workspaces.name` to the @@ -57,34 +55,48 @@ determines which mode it uses: used in a single Terraform configuration to multiple Terraform Cloud workspaces. -When interacting with workspaces on the command line, Terraform uses -shortened names without the common prefix. For example, if -`prefix = "networking-"`, use `terraform workspace select prod` to switch to -the Terraform CLI workspace `prod` within the current configuration. Remote -Terraform operations such as `plan` and `apply` executed against that Terraform -CLI workspace will be executed in the Terraform Cloud workspace `networking-prod`. - -Additionally, the [`terraform.workspace`](/language/state/workspaces#current-workspace-interpolation) -expression shouldn't be used in Terraform configurations that use Terraform 1.0.x or earlier and run -remote operations against Terraform Cloud workspaces. The reason for this is that -prior to Terraform 1.1.0, Terraform Cloud workspaces only used the single `default` Terraform -CLI workspace internally. In other words, if your Terraform configuration -used `${terraform.workspace}` to return `dev` or `prod`, remote runs in Terraform Cloud -would always evaluate it as `default` regardless of -which workspace you had set with the `terraform workspace select` command. That -would most likely not be what you wanted. (It is ok to use `terraform.workspace` -in local operations, and with remote operations in workspaces configured to use Terraform 1.1.0 or later.) The backend configuration requires either `name` or `prefix`. Omitting both or setting both results in a configuration error. If previous state is present when you run `terraform init` and the corresponding -remote workspaces are empty or absent, Terraform will create workspaces and/or -update the remote state accordingly. However, if your workspace needs variables -set or requires a specific version of Terraform for remote operations, we +remote workspaces are empty or absent, Terraform will create workspaces and +update the remote state accordingly. However, if your workspace requires variables or a specific version of Terraform for remote operations, we recommend that you create your remote workspaces on Terraform Cloud before running any remote operations against them. +### Workspace Names + +Terraform uses shortened names without the common prefix to interact with workspaces on the command line. For example, if `prefix = "networking-"`, use `terraform workspace select prod` to switch to the Terraform CLI workspace `prod` within the current configuration. However, remote Terraform operations such as `plan` and `apply` for that Terraform CLI workspace will take place in the Terraform Cloud workspace `networking-prod`. + +Because of this, the [`terraform.workspace`](/language/state/workspaces#current-workspace-interpolation) interpolation expression produces different results depending on whether a remote workspace is configured to perform operations locally or remotely. For example, in a remote workspace called `networking-prod` created with `prefix = "networking-"` the expression produces the following: + +- For local operations, `terraform.workspace` = `prod` +- For remote operations, `terraform.workspace`= `networking-prod` + +Prior to Terraform version 1.1.0, Terraform Cloud workspaces used only the single `default` Terraform CLI workspace internally. So if a Terraform configuration used `terraform.workspace` to return `dev` or `prod`, remote runs in Terraform Cloud would always evaluate it as `default`, regardless of +which workspace you set with the `terraform workspace select` command. Therefore, we do not recommend using `terraform.workspace` in Terraform configurations that use Terraform 1.0.x or earlier and run remote operations against Terraform Cloud workspaces. + +### Determining Run Environment + +To determine whether a run is local or remote, we recommend using [Terraform Cloud run environment variables](/cloud-docs/run/run-environment#environment-variables). The example below uses `TFC_RUN_ID`. + +``` +output "current_workspace_name" { + value = terraform.workspace +} + +variable "TFC_RUN_ID" { + type = string + default = "" +} + +output "remote_execution_determine" { + value = "Remote run environment? %{if var.TFC_RUN_ID != ""}Yes%{else}No this is local%{endif}!" +} +``` + + ## Example Configurations -> **Note:** We recommend omitting the token from the configuration, and instead using From faffa11e08d0be227682d7dc3fd09472abce613a Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 9 Feb 2022 14:21:46 -0500 Subject: [PATCH 585/644] Update workspaces page --- website/docs/language/state/workspaces.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/website/docs/language/state/workspaces.mdx b/website/docs/language/state/workspaces.mdx index a3f38d44783c..ffd2020743a7 100644 --- a/website/docs/language/state/workspaces.mdx +++ b/website/docs/language/state/workspaces.mdx @@ -201,8 +201,6 @@ The important thing about workspace internals is that workspaces are meant to be a shared resource. They aren't a private, local-only notion (unless you're using purely local state and not committing it). -The "current workspace" name is stored only locally in the ignored +The "current workspace" name is stored locally in the ignored `.terraform` directory. This allows multiple team members to work on -different workspaces concurrently. The "current workspace" name is **not** -currently meaningful in Terraform Cloud workspaces since it will always -have the value `default`. +different workspaces concurrently. Workspace names are also attached to associated remote workspaces in Terraform Cloud. For more details about workspace names in Terraform Cloud, refer to the [remote backend](/language/settings/backends/remote#workspaces) and [CLI Integration](/cli/cloud/settings#arguments) (recommended) documentation. From 8be2c4a3972f706c52c4b8df88e37cd2fd0ca6a2 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 9 Feb 2022 14:30:02 -0500 Subject: [PATCH 586/644] fix link --- website/docs/language/state/workspaces.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/state/workspaces.mdx b/website/docs/language/state/workspaces.mdx index ffd2020743a7..cca44194424b 100644 --- a/website/docs/language/state/workspaces.mdx +++ b/website/docs/language/state/workspaces.mdx @@ -203,4 +203,4 @@ meant to be a shared resource. They aren't a private, local-only notion The "current workspace" name is stored locally in the ignored `.terraform` directory. This allows multiple team members to work on -different workspaces concurrently. Workspace names are also attached to associated remote workspaces in Terraform Cloud. For more details about workspace names in Terraform Cloud, refer to the [remote backend](/language/settings/backends/remote#workspaces) and [CLI Integration](/cli/cloud/settings#arguments) (recommended) documentation. +different workspaces concurrently. Workspace names are also attached to associated remote workspaces in Terraform Cloud. For more details about workspace names in Terraform Cloud, refer to the [remote backend](/language/settings/backends/remote#workspaces) and [CLI Integration (recommended)](/cli/cloud/settings#arguments) documentation. From 422b47618c7919fbca1a1197d4e51760e1334903 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 9 Feb 2022 17:37:06 -0500 Subject: [PATCH 587/644] Change name example to match new edits --- website/docs/language/settings/backends/remote.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/remote.mdx b/website/docs/language/settings/backends/remote.mdx index d15fd21624a7..30227e1a0ba6 100644 --- a/website/docs/language/settings/backends/remote.mdx +++ b/website/docs/language/settings/backends/remote.mdx @@ -45,7 +45,7 @@ The remote backend can work with either a single remote Terraform Cloud workspac determines which mode it uses: - To use a single remote Terraform Cloud workspace, set `workspaces.name` to the - remote workspace's full name (like `networking`). + remote workspace's full name (like `networking-prod`). - To use multiple remote workspaces, set `workspaces.prefix` to a prefix used in all of the desired remote workspace names. For example, set From 24cffb5ff3046530537473c0b2336e8ed5cbc430 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Wed, 9 Feb 2022 17:41:12 -0500 Subject: [PATCH 588/644] Soften language for determining run environment --- website/docs/language/settings/backends/remote.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/settings/backends/remote.mdx b/website/docs/language/settings/backends/remote.mdx index 30227e1a0ba6..f4b09be33e51 100644 --- a/website/docs/language/settings/backends/remote.mdx +++ b/website/docs/language/settings/backends/remote.mdx @@ -79,7 +79,7 @@ which workspace you set with the `terraform workspace select` command. Therefore ### Determining Run Environment -To determine whether a run is local or remote, we recommend using [Terraform Cloud run environment variables](/cloud-docs/run/run-environment#environment-variables). The example below uses `TFC_RUN_ID`. +If you need to determine whether a run is local or remote in your Terraform configuration, we recommend using [Terraform Cloud run environment variables](/cloud-docs/run/run-environment#environment-variables). The example below uses `TFC_RUN_ID`. ``` output "current_workspace_name" { From 691b98b612e54bfd7d43adbac48d106d6f869a66 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 4 Feb 2022 10:32:06 -0500 Subject: [PATCH 589/644] cli: Prevent overuse of console-only type function The console-only `type` function allows interrogation of any value's type. An implementation quirk is that we use a cty.Mark to allow the console to display this type information without the usual HCL quoting. For example: > type("boop") string instead of: > type("boop") "string" Because these marks can propagate when used in complex expressions, using the type function as part of a complex expression could result in this "print as raw" mark being attached to a collection. When this happened, it would result in a crash when we tried to iterate over a marked value. The `type` function was never intended to be used in this way, which is why its use is limited to the console command. Its purpose was as a pseudo-builtin, used only at the top level to display the type of a given value. This commit goes some way to preventing the use of the `type` function in complex expressions, by refusing to display any non-string value which was marked by `type`, or contains a sub-value which was so marked. --- internal/repl/format.go | 4 ---- internal/repl/session.go | 24 ++++++++++++++++++++++++ internal/repl/session_test.go | 29 +++++++++++++++++++++++++++++ 3 files changed, 53 insertions(+), 4 deletions(-) diff --git a/internal/repl/format.go b/internal/repl/format.go index 70fb66abf0a3..fbdd44f58194 100644 --- a/internal/repl/format.go +++ b/internal/repl/format.go @@ -17,10 +17,6 @@ func FormatValue(v cty.Value, indent int) string { if !v.IsKnown() { return "(known after apply)" } - if v.Type().Equals(cty.String) && v.HasMark(marks.Raw) { - raw, _ := v.Unmark() - return raw.AsString() - } if v.HasMark(marks.Sensitive) { return "(sensitive)" } diff --git a/internal/repl/session.go b/internal/repl/session.go index a9b7b1b124c2..41a6c359b810 100644 --- a/internal/repl/session.go +++ b/internal/repl/session.go @@ -8,6 +8,7 @@ import ( "github.com/hashicorp/hcl/v2" "github.com/hashicorp/hcl/v2/hclsyntax" "github.com/hashicorp/terraform/internal/lang" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -54,6 +55,29 @@ func (s *Session) handleEval(line string) (string, tfdiags.Diagnostics) { return "", diags } + // The raw mark is used only by the console-only `type` function, in order + // to allow display of a string value representation of the type without the + // usual HCL formatting. If we receive a string value with this mark, we do + // not want to format it any further. + // + // Due to mark propagation in cty, calling `type` as part of a larger + // expression can lead to other values being marked, which can in turn lead + // to unpredictable results. If any non-string value has the raw mark, we + // return a diagnostic explaining that this use of `type` is not permitted. + if marks.Contains(val, marks.Raw) { + if val.Type().Equals(cty.String) { + raw, _ := val.Unmark() + return raw.AsString(), diags + } else { + diags = diags.Append(tfdiags.Sourceless( + tfdiags.Error, + "Invalid use of type function", + "The console-only \"type\" function cannot be used as part of an expression.", + )) + return "", diags + } + } + return FormatValue(val, 0), diags } diff --git a/internal/repl/session_test.go b/internal/repl/session_test.go index 7110324e1ecc..bf060f60702b 100644 --- a/internal/repl/session_test.go +++ b/internal/repl/session_test.go @@ -120,6 +120,20 @@ func TestSession_basicState(t *testing.T) { }, }) }) + + t.Run("type function", func(t *testing.T) { + testSession(t, testSessionTest{ + State: state, + Inputs: []testSessionInput{ + { + Input: "type(test_instance.foo)", + Output: `object({ + id: string, +})`, + }, + }, + }) + }) } func TestSession_stateless(t *testing.T) { @@ -178,6 +192,18 @@ func TestSession_stateless(t *testing.T) { }, }) }) + + t.Run("type function cannot be used in expressions", func(t *testing.T) { + testSession(t, testSessionTest{ + Inputs: []testSessionInput{ + { + Input: `[for i in [1, "two", true]: type(i)]`, + Error: true, + ErrorContains: "Invalid use of type function", + }, + }, + }) + }) } func testSession(t *testing.T, test testSessionTest) { @@ -221,6 +247,9 @@ func testSession(t *testing.T, test testSessionTest) { t.Fatalf("failed to create scope: %s", diags.Err()) } + // Ensure that any console-only functions are available + scope.ConsoleMode = true + // Build the session s := &Session{ Scope: scope, From 903d6f105584d0b91fc3c73ad0d12a3e22d5f545 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 9 Feb 2022 17:15:53 -0500 Subject: [PATCH 590/644] lang: Remove use of marks.Raw in tests These instances of marks.Raw usage were semantically only testing the properties of combining multiple marks. Testing this with an arbitrary value for the mark is just as valid and clearer. --- internal/lang/funcs/number_test.go | 4 ++-- internal/lang/funcs/redact_test.go | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/internal/lang/funcs/number_test.go b/internal/lang/funcs/number_test.go index 260e0127cea8..6caf19af1899 100644 --- a/internal/lang/funcs/number_test.go +++ b/internal/lang/funcs/number_test.go @@ -215,9 +215,9 @@ func TestParseInt(t *testing.T) { ``, }, { - cty.StringVal("128").Mark(marks.Raw), + cty.StringVal("128").Mark("boop"), cty.NumberIntVal(10).Mark(marks.Sensitive), - cty.NumberIntVal(128).WithMarks(cty.NewValueMarks(marks.Raw, marks.Sensitive)), + cty.NumberIntVal(128).WithMarks(cty.NewValueMarks("boop", marks.Sensitive)), ``, }, { diff --git a/internal/lang/funcs/redact_test.go b/internal/lang/funcs/redact_test.go index b45721fb99c2..e378d5f5afe7 100644 --- a/internal/lang/funcs/redact_test.go +++ b/internal/lang/funcs/redact_test.go @@ -18,14 +18,14 @@ func TestRedactIfSensitive(t *testing.T) { marks: []cty.ValueMarks{cty.NewValueMarks(marks.Sensitive)}, want: "(sensitive value)", }, - "raw non-sensitive string": { + "marked non-sensitive string": { value: "foo", - marks: []cty.ValueMarks{cty.NewValueMarks(marks.Raw)}, + marks: []cty.ValueMarks{cty.NewValueMarks("boop")}, want: `"foo"`, }, - "raw sensitive string": { + "sensitive string with other marks": { value: "foo", - marks: []cty.ValueMarks{cty.NewValueMarks(marks.Raw), cty.NewValueMarks(marks.Sensitive)}, + marks: []cty.ValueMarks{cty.NewValueMarks("boop"), cty.NewValueMarks(marks.Sensitive)}, want: "(sensitive value)", }, "sensitive number": { From 843c50e8ce815ba233816e06bd68503a771abd93 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 9 Feb 2022 17:17:14 -0500 Subject: [PATCH 591/644] lang: Further limit the console-only type function This commit introduces a capsule type, `TypeType`, which is used to extricate type information from the console-only `type` function. In combination with the `TypeType` mark, this allows us to restrict the use of this function to top-level display of a value's type. Any other use of `type()` will result in an error diagnostic. --- internal/lang/funcs/conversion.go | 117 ++------------------- internal/lang/funcs/conversion_test.go | 90 ----------------- internal/lang/marks/marks.go | 7 +- internal/lang/types/type_type.go | 12 +++ internal/lang/types/types.go | 2 + internal/repl/session.go | 135 ++++++++++++++++++++++--- internal/repl/session_test.go | 132 ++++++++++++++++++++++++ 7 files changed, 278 insertions(+), 217 deletions(-) create mode 100644 internal/lang/types/type_type.go create mode 100644 internal/lang/types/types.go diff --git a/internal/lang/funcs/conversion.go b/internal/lang/funcs/conversion.go index b0f9d2a6b5b0..8eebb3a6200b 100644 --- a/internal/lang/funcs/conversion.go +++ b/internal/lang/funcs/conversion.go @@ -1,12 +1,10 @@ package funcs import ( - "fmt" - "sort" "strconv" - "strings" "github.com/hashicorp/terraform/internal/lang/marks" + "github.com/hashicorp/terraform/internal/lang/types" "github.com/zclconf/go-cty/cty" "github.com/zclconf/go-cty/cty/convert" "github.com/zclconf/go-cty/cty/function" @@ -97,6 +95,9 @@ func MakeToFunc(wantTy cty.Type) function.Function { }) } +// TypeFunc returns an encapsulated value containing its argument's type. This +// value is marked to allow us to limit the use of this function at the moment +// to only a few supported use cases. var TypeFunc = function.New(&function.Spec{ Params: []function.Parameter{ { @@ -107,117 +108,13 @@ var TypeFunc = function.New(&function.Spec{ AllowNull: true, }, }, - Type: function.StaticReturnType(cty.String), + Type: function.StaticReturnType(types.TypeType), Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) { - return cty.StringVal(TypeString(args[0].Type())).Mark(marks.Raw), nil + givenType := args[0].Type() + return cty.CapsuleVal(types.TypeType, &givenType).Mark(marks.TypeType), nil }, }) -// Modified copy of TypeString from go-cty: -// https://github.com/zclconf/go-cty-debug/blob/master/ctydebug/type_string.go -// -// TypeString returns a string representation of a given type that is -// reminiscent of Go syntax calling into the cty package but is mainly -// intended for easy human inspection of values in tests, debug output, etc. -// -// The resulting string will include newlines and indentation in order to -// increase the readability of complex structures. It always ends with a -// newline, so you can print this result directly to your output. -func TypeString(ty cty.Type) string { - var b strings.Builder - writeType(ty, &b, 0) - return b.String() -} - -func writeType(ty cty.Type, b *strings.Builder, indent int) { - switch { - case ty == cty.NilType: - b.WriteString("nil") - return - case ty.IsObjectType(): - atys := ty.AttributeTypes() - if len(atys) == 0 { - b.WriteString("object({})") - return - } - attrNames := make([]string, 0, len(atys)) - for name := range atys { - attrNames = append(attrNames, name) - } - sort.Strings(attrNames) - b.WriteString("object({\n") - indent++ - for _, name := range attrNames { - aty := atys[name] - b.WriteString(indentSpaces(indent)) - fmt.Fprintf(b, "%s: ", name) - writeType(aty, b, indent) - b.WriteString(",\n") - } - indent-- - b.WriteString(indentSpaces(indent)) - b.WriteString("})") - case ty.IsTupleType(): - etys := ty.TupleElementTypes() - if len(etys) == 0 { - b.WriteString("tuple([])") - return - } - b.WriteString("tuple([\n") - indent++ - for _, ety := range etys { - b.WriteString(indentSpaces(indent)) - writeType(ety, b, indent) - b.WriteString(",\n") - } - indent-- - b.WriteString(indentSpaces(indent)) - b.WriteString("])") - case ty.IsCollectionType(): - ety := ty.ElementType() - switch { - case ty.IsListType(): - b.WriteString("list(") - case ty.IsMapType(): - b.WriteString("map(") - case ty.IsSetType(): - b.WriteString("set(") - default: - // At the time of writing there are no other collection types, - // but we'll be robust here and just pass through the GoString - // of anything we don't recognize. - b.WriteString(ty.FriendlyName()) - return - } - // Because object and tuple types render split over multiple - // lines, a collection type container around them can end up - // being hard to see when scanning, so we'll generate some extra - // indentation to make a collection of structural type more visually - // distinct from the structural type alone. - complexElem := ety.IsObjectType() || ety.IsTupleType() - if complexElem { - indent++ - b.WriteString("\n") - b.WriteString(indentSpaces(indent)) - } - writeType(ty.ElementType(), b, indent) - if complexElem { - indent-- - b.WriteString(",\n") - b.WriteString(indentSpaces(indent)) - } - b.WriteString(")") - default: - // For any other type we'll just use its GoString and assume it'll - // follow the usual GoString conventions. - b.WriteString(ty.FriendlyName()) - } -} - -func indentSpaces(level int) string { - return strings.Repeat(" ", level) -} - func Type(input []cty.Value) (cty.Value, error) { return TypeFunc.Call(input) } diff --git a/internal/lang/funcs/conversion_test.go b/internal/lang/funcs/conversion_test.go index cec2e23c90c2..40317ba134a5 100644 --- a/internal/lang/funcs/conversion_test.go +++ b/internal/lang/funcs/conversion_test.go @@ -4,7 +4,6 @@ import ( "fmt" "testing" - "github.com/google/go-cmp/cmp" "github.com/hashicorp/terraform/internal/lang/marks" "github.com/zclconf/go-cty/cty" ) @@ -191,92 +190,3 @@ func TestTo(t *testing.T) { }) } } - -func TestType(t *testing.T) { - tests := []struct { - Input cty.Value - Want string - }{ - // Primititves - { - cty.StringVal("a"), - "string", - }, - { - cty.NumberIntVal(42), - "number", - }, - { - cty.BoolVal(true), - "bool", - }, - // Collections - { - cty.EmptyObjectVal, - `object({})`, - }, - { - cty.EmptyTupleVal, - `tuple([])`, - }, - { - cty.ListValEmpty(cty.String), - `list(string)`, - }, - { - cty.MapValEmpty(cty.String), - `map(string)`, - }, - { - cty.SetValEmpty(cty.String), - `set(string)`, - }, - { - cty.ListVal([]cty.Value{cty.StringVal("a")}), - `list(string)`, - }, - { - cty.ListVal([]cty.Value{cty.ListVal([]cty.Value{cty.NumberIntVal(42)})}), - `list(list(number))`, - }, - { - cty.ListVal([]cty.Value{cty.MapValEmpty(cty.String)}), - `list(map(string))`, - }, - { - cty.ListVal([]cty.Value{cty.ObjectVal(map[string]cty.Value{ - "foo": cty.StringVal("bar"), - })}), - "list(\n object({\n foo: string,\n }),\n)", - }, - // Unknowns and Nulls - { - cty.UnknownVal(cty.String), - "string", - }, - { - cty.NullVal(cty.Object(map[string]cty.Type{ - "foo": cty.String, - })), - "object({\n foo: string,\n})", - }, - { // irrelevant marks do nothing - cty.ListVal([]cty.Value{cty.ObjectVal(map[string]cty.Value{ - "foo": cty.StringVal("bar").Mark("ignore me"), - })}), - "list(\n object({\n foo: string,\n }),\n)", - }, - } - for _, test := range tests { - got, err := Type([]cty.Value{test.Input}) - if err != nil { - t.Fatalf("unexpected error: %s", err) - } - // The value is marked to help with formatting - got, _ = got.Unmark() - - if got.AsString() != test.Want { - t.Errorf("wrong result:\n%s", cmp.Diff(got.AsString(), test.Want)) - } - } -} diff --git a/internal/lang/marks/marks.go b/internal/lang/marks/marks.go index 7e5bb3d0d486..0a174d9156da 100644 --- a/internal/lang/marks/marks.go +++ b/internal/lang/marks/marks.go @@ -38,6 +38,7 @@ func Contains(val cty.Value, mark valueMark) bool { // Terraform. var Sensitive = valueMark("sensitive") -// Raw is used to indicate to the repl that the value should be written without -// any formatting. -var Raw = valueMark("raw") +// TypeType is used to indicate that the value contains a representation of +// another value's type. This is part of the implementation of the console-only +// `type` function. +var TypeType = valueMark("typeType") diff --git a/internal/lang/types/type_type.go b/internal/lang/types/type_type.go new file mode 100644 index 000000000000..14edf5ece232 --- /dev/null +++ b/internal/lang/types/type_type.go @@ -0,0 +1,12 @@ +package types + +import ( + "reflect" + + "github.com/zclconf/go-cty/cty" +) + +// TypeType is a capsule type used to represent a cty.Type as a cty.Value. This +// is used by the `type()` console function to smuggle cty.Type values to the +// REPL session, where it can be displayed to the user directly. +var TypeType = cty.Capsule("type", reflect.TypeOf(cty.Type{})) diff --git a/internal/lang/types/types.go b/internal/lang/types/types.go new file mode 100644 index 000000000000..69355d90af6a --- /dev/null +++ b/internal/lang/types/types.go @@ -0,0 +1,2 @@ +// Package types contains non-standard cty types used only within Terraform. +package types diff --git a/internal/repl/session.go b/internal/repl/session.go index 41a6c359b810..f07363ec1a16 100644 --- a/internal/repl/session.go +++ b/internal/repl/session.go @@ -1,6 +1,8 @@ package repl import ( + "fmt" + "sort" "strings" "github.com/zclconf/go-cty/cty" @@ -9,6 +11,7 @@ import ( "github.com/hashicorp/hcl/v2/hclsyntax" "github.com/hashicorp/terraform/internal/lang" "github.com/hashicorp/terraform/internal/lang/marks" + "github.com/hashicorp/terraform/internal/lang/types" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -55,20 +58,19 @@ func (s *Session) handleEval(line string) (string, tfdiags.Diagnostics) { return "", diags } - // The raw mark is used only by the console-only `type` function, in order - // to allow display of a string value representation of the type without the - // usual HCL formatting. If we receive a string value with this mark, we do - // not want to format it any further. - // - // Due to mark propagation in cty, calling `type` as part of a larger - // expression can lead to other values being marked, which can in turn lead - // to unpredictable results. If any non-string value has the raw mark, we - // return a diagnostic explaining that this use of `type` is not permitted. - if marks.Contains(val, marks.Raw) { - if val.Type().Equals(cty.String) { - raw, _ := val.Unmark() - return raw.AsString(), diags - } else { + // The TypeType mark is used only by the console-only `type` function, in + // order to smuggle the type of a given value back here. We can then + // display a representation of the type directly. + if marks.Contains(val, marks.TypeType) { + val, _ = val.UnmarkDeep() + + valType := val.Type() + switch { + case valType.Equals(types.TypeType): + // An encapsulated type value, which should be displayed directly. + valType := val.EncapsulatedValue().(*cty.Type) + return typeString(*valType), diags + default: diags = diags.Append(tfdiags.Sourceless( tfdiags.Error, "Invalid use of type function", @@ -96,3 +98,108 @@ Control-D. return strings.TrimSpace(text), nil } + +// Modified copy of TypeString from go-cty: +// https://github.com/zclconf/go-cty-debug/blob/master/ctydebug/type_string.go +// +// TypeString returns a string representation of a given type that is +// reminiscent of Go syntax calling into the cty package but is mainly +// intended for easy human inspection of values in tests, debug output, etc. +// +// The resulting string will include newlines and indentation in order to +// increase the readability of complex structures. It always ends with a +// newline, so you can print this result directly to your output. +func typeString(ty cty.Type) string { + var b strings.Builder + writeType(ty, &b, 0) + return b.String() +} + +func writeType(ty cty.Type, b *strings.Builder, indent int) { + switch { + case ty == cty.NilType: + b.WriteString("nil") + return + case ty.IsObjectType(): + atys := ty.AttributeTypes() + if len(atys) == 0 { + b.WriteString("object({})") + return + } + attrNames := make([]string, 0, len(atys)) + for name := range atys { + attrNames = append(attrNames, name) + } + sort.Strings(attrNames) + b.WriteString("object({\n") + indent++ + for _, name := range attrNames { + aty := atys[name] + b.WriteString(indentSpaces(indent)) + fmt.Fprintf(b, "%s: ", name) + writeType(aty, b, indent) + b.WriteString(",\n") + } + indent-- + b.WriteString(indentSpaces(indent)) + b.WriteString("})") + case ty.IsTupleType(): + etys := ty.TupleElementTypes() + if len(etys) == 0 { + b.WriteString("tuple([])") + return + } + b.WriteString("tuple([\n") + indent++ + for _, ety := range etys { + b.WriteString(indentSpaces(indent)) + writeType(ety, b, indent) + b.WriteString(",\n") + } + indent-- + b.WriteString(indentSpaces(indent)) + b.WriteString("])") + case ty.IsCollectionType(): + ety := ty.ElementType() + switch { + case ty.IsListType(): + b.WriteString("list(") + case ty.IsMapType(): + b.WriteString("map(") + case ty.IsSetType(): + b.WriteString("set(") + default: + // At the time of writing there are no other collection types, + // but we'll be robust here and just pass through the GoString + // of anything we don't recognize. + b.WriteString(ty.FriendlyName()) + return + } + // Because object and tuple types render split over multiple + // lines, a collection type container around them can end up + // being hard to see when scanning, so we'll generate some extra + // indentation to make a collection of structural type more visually + // distinct from the structural type alone. + complexElem := ety.IsObjectType() || ety.IsTupleType() + if complexElem { + indent++ + b.WriteString("\n") + b.WriteString(indentSpaces(indent)) + } + writeType(ty.ElementType(), b, indent) + if complexElem { + indent-- + b.WriteString(",\n") + b.WriteString(indentSpaces(indent)) + } + b.WriteString(")") + default: + // For any other type we'll just use its GoString and assume it'll + // follow the usual GoString conventions. + b.WriteString(ty.FriendlyName()) + } +} + +func indentSpaces(level int) string { + return strings.Repeat(" ", level) +} diff --git a/internal/repl/session_test.go b/internal/repl/session_test.go index bf060f60702b..3e976cadc0bf 100644 --- a/internal/repl/session_test.go +++ b/internal/repl/session_test.go @@ -6,6 +6,7 @@ import ( "strings" "testing" + "github.com/google/go-cmp/cmp" "github.com/zclconf/go-cty/cty" "github.com/hashicorp/terraform/internal/addrs" @@ -193,11 +194,59 @@ func TestSession_stateless(t *testing.T) { }) }) + t.Run("type function", func(t *testing.T) { + testSession(t, testSessionTest{ + Inputs: []testSessionInput{ + { + Input: `type("foo")`, + Output: "string", + }, + }, + }) + }) + + t.Run("type type is type", func(t *testing.T) { + testSession(t, testSessionTest{ + Inputs: []testSessionInput{ + { + Input: `type(type("foo"))`, + Output: "type", + }, + }, + }) + }) + + t.Run("interpolating type with strings is not possible", func(t *testing.T) { + testSession(t, testSessionTest{ + Inputs: []testSessionInput{ + { + Input: `"quin${type([])}"`, + Error: true, + ErrorContains: "Invalid template interpolation value", + }, + }, + }) + }) + t.Run("type function cannot be used in expressions", func(t *testing.T) { testSession(t, testSessionTest{ Inputs: []testSessionInput{ { Input: `[for i in [1, "two", true]: type(i)]`, + Output: "", + Error: true, + ErrorContains: "Invalid use of type function", + }, + }, + }) + }) + + t.Run("type equality checks are not permitted", func(t *testing.T) { + testSession(t, testSessionTest{ + Inputs: []testSessionInput{ + { + Input: `type("foo") == type("bar")`, + Output: "", Error: true, ErrorContains: "Invalid use of type function", }, @@ -311,3 +360,86 @@ type testSessionInput struct { Exit bool // Exit is true if exiting is expected ErrorContains string } + +func TestTypeString(t *testing.T) { + tests := []struct { + Input cty.Value + Want string + }{ + // Primititves + { + cty.StringVal("a"), + "string", + }, + { + cty.NumberIntVal(42), + "number", + }, + { + cty.BoolVal(true), + "bool", + }, + // Collections + { + cty.EmptyObjectVal, + `object({})`, + }, + { + cty.EmptyTupleVal, + `tuple([])`, + }, + { + cty.ListValEmpty(cty.String), + `list(string)`, + }, + { + cty.MapValEmpty(cty.String), + `map(string)`, + }, + { + cty.SetValEmpty(cty.String), + `set(string)`, + }, + { + cty.ListVal([]cty.Value{cty.StringVal("a")}), + `list(string)`, + }, + { + cty.ListVal([]cty.Value{cty.ListVal([]cty.Value{cty.NumberIntVal(42)})}), + `list(list(number))`, + }, + { + cty.ListVal([]cty.Value{cty.MapValEmpty(cty.String)}), + `list(map(string))`, + }, + { + cty.ListVal([]cty.Value{cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("bar"), + })}), + "list(\n object({\n foo: string,\n }),\n)", + }, + // Unknowns and Nulls + { + cty.UnknownVal(cty.String), + "string", + }, + { + cty.NullVal(cty.Object(map[string]cty.Type{ + "foo": cty.String, + })), + "object({\n foo: string,\n})", + }, + { // irrelevant marks do nothing + cty.ListVal([]cty.Value{cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("bar").Mark("ignore me"), + })}), + "list(\n object({\n foo: string,\n }),\n)", + }, + } + for _, test := range tests { + got := typeString(test.Input.Type()) + if got != test.Want { + t.Errorf("wrong result:\n%s", cmp.Diff(got, test.Want)) + } + } +} From 98f80bc5dad9e7f6441f97c6fd210953f1c34af2 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 9 Feb 2022 17:41:05 -0500 Subject: [PATCH 592/644] website: Explain limitations of type function --- website/docs/language/functions/type.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/language/functions/type.mdx b/website/docs/language/functions/type.mdx index 28319a8a4c2d..0f742fe7fcb2 100644 --- a/website/docs/language/functions/type.mdx +++ b/website/docs/language/functions/type.mdx @@ -13,7 +13,9 @@ Sometimes a Terraform configuration can result in confusing errors regarding inconsistent types. This function displays terraform's evaluation of a given value's type, which is useful in understanding this error message. -This is a special function which is only available in the `terraform console` command. +This is a special function which is only available in the `terraform console` +command. It can only be used to examine the type of a given value, and should +not be used in more complex expressions. ## Examples From 7a20c07cb0e4e30b6177cb86401ea1edd192eeea Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 10 Feb 2022 10:35:34 -0500 Subject: [PATCH 593/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ade630341b0..eb72139d792a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ ENHANCEMENTS: BUG FIXES: * Terraform now handles type constraints, nullability, and custom variable validation properly for root module variables. Previously there was an order of operations problem where the nullability and custom variable validation were checked too early, prior to dealing with the type constraints, and thus that logic could potentially "see" an incorrectly-typed value in spite of the type constraint, leading to incorrect errors. [GH-29959] +* `terraform show -json`: JSON plan output now correctly maps aliased providers to their configurations, and includes the full provider source address alongside the short provider name. [GH-30138] ## Previous Releases From aed7162e9a59aa7e3c1d35c7d2166a339c29a70f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20Bel=C3=A9m?= Date: Mon, 14 Feb 2022 20:20:03 +0000 Subject: [PATCH 594/644] cli: Fix state mv exit code for missing resource (#29839) --- internal/command/state_mv.go | 2 ++ internal/command/state_mv_test.go | 28 ++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/internal/command/state_mv.go b/internal/command/state_mv.go index a35cfd6aaa55..99bc82aa53a0 100644 --- a/internal/command/state_mv.go +++ b/internal/command/state_mv.go @@ -176,6 +176,8 @@ func (c *StateMvCommand) Run(args []string) int { msgInvalidSource, fmt.Sprintf("Cannot move %s: does not match anything in the current state.", sourceAddr), )) + c.showDiagnostics(diags) + return 1 } for _, rawAddrFrom := range sourceAddrs { switch addrFrom := rawAddrFrom.(type) { diff --git a/internal/command/state_mv_test.go b/internal/command/state_mv_test.go index 2778de61b0c9..b183a8668779 100644 --- a/internal/command/state_mv_test.go +++ b/internal/command/state_mv_test.go @@ -1685,6 +1685,34 @@ func TestStateMvHelp(t *testing.T) { } } +func TestStateMvInvalidSourceAddress(t *testing.T) { + state := states.BuildState(func(s *states.SyncState) {}) + statePath := testStateFile(t, state) + + p := testProvider() + ui := new(cli.MockUi) + view, _ := testView(t) + c := &StateMvCommand{ + StateMeta{ + Meta: Meta{ + testingOverrides: metaOverridesForProvider(p), + Ui: ui, + View: view, + }, + }, + } + + args := []string{ + "-state", statePath, + "foo.bar1", + "foo.bar2", + } + code := c.Run(args) + if code != 1 { + t.Fatalf("expected error code 1, got:\n%d", code) + } +} + const testStateMvOutputOriginal = ` test_instance.baz: ID = foo From 252865c6a034301f521565d14518e73be39ff650 Mon Sep 17 00:00:00 2001 From: Ben Partridge Date: Tue, 15 Feb 2022 10:23:37 +1100 Subject: [PATCH 595/644] Improvements to wording of substr function documentation Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/language/functions/substr.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/functions/substr.mdx b/website/docs/language/functions/substr.mdx index 1ccd24cc1d48..8317848de791 100644 --- a/website/docs/language/functions/substr.mdx +++ b/website/docs/language/functions/substr.mdx @@ -37,7 +37,7 @@ string after the given offset will be returned. world ``` -The length may be greater than the length of the string, in which case the substring +If the length is greater than the length of the string, the substring will be the length of all remaining characters. ``` From 7f4019e1f65f7cdc98426e9152473aca9b1731ff Mon Sep 17 00:00:00 2001 From: nozaq Date: Wed, 16 Feb 2022 01:12:55 +0900 Subject: [PATCH 596/644] jsonconfig: fix keys for default providers Fixes provider config keys to reflect implicit provider inheritance. --- internal/command/jsonconfig/config.go | 62 ++-- .../provider-aliasing-default/child/main.tf | 19 ++ .../child/nested-no-requirements/main.tf | 3 + .../child/nested/main.tf | 11 + .../provider-aliasing-default/main.tf | 19 ++ .../provider-aliasing-default/output.json | 270 ++++++++++++++++++ 6 files changed, 368 insertions(+), 16 deletions(-) create mode 100644 internal/command/testdata/show-json/provider-aliasing-default/child/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing-default/child/nested-no-requirements/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing-default/child/nested/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing-default/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing-default/output.json diff --git a/internal/command/jsonconfig/config.go b/internal/command/jsonconfig/config.go index 807444d6e4f1..9670fd5e6428 100644 --- a/internal/command/jsonconfig/config.go +++ b/internal/command/jsonconfig/config.go @@ -231,9 +231,37 @@ func marshalProviderConfigs( p.VersionConstraint = getproviders.VersionConstraintsString(vc) } + if c.Parent != nil { + parentKey := opaqueProviderKey(pr.Name, c.Parent.Path.String()) + p.parentKey = findSourceProviderKey(parentKey, m) + } + m[key] = p } + // In child modules, providers defined in the parent module can be implicitly used. + // Such providers could have no requirements and configuration blocks defined. + if c.Parent != nil { + for req := range reqs { + // Implicit inheritance only applies to the default provider, + // so the provider name must be same as the provider type. + key := opaqueProviderKey(req.Type, c.Path.String()) + if _, exists := m[key]; exists { + continue + } + + parentKey := opaqueProviderKey(req.Type, c.Parent.Path.String()) + p := providerConfig{ + Name: req.Type, + FullName: req.String(), + ModuleAddress: c.Path.String(), + parentKey: findSourceProviderKey(parentKey, m), + } + + m[key] = p + } + } + // Must also visit our child modules, recursively. for name, mc := range c.Module.ModuleCalls { // Keys in c.Children are guaranteed to match those in c.Module.ModuleCalls @@ -259,22 +287,7 @@ func marshalProviderConfigs( key := opaqueProviderKey(moduleProviderName, cc.Path.String()) parentKey := opaqueProviderKey(parentProviderName, cc.Parent.Path.String()) - - // Traverse up the module call tree until we find the provider - // configuration which has no linked parent config. This is then - // the source of the configuration used in this module call, so - // we link to it directly - for { - parent, exists := m[parentKey] - if !exists { - break - } - p.parentKey = parentKey - parentKey = parent.parentKey - if parentKey == "" { - break - } - } + p.parentKey = findSourceProviderKey(parentKey, m) m[key] = p } @@ -527,3 +540,20 @@ func opaqueProviderKey(provider string, addr string) (key string) { } return key } + +// Traverse up the module call tree until we find the provider +// configuration which has no linked parent config. This is then +// the source of the configuration used in this module call, so +// we link to it directly +func findSourceProviderKey(startKey string, m map[string]providerConfig) string { + parentKey := startKey + for { + parent, exists := m[parentKey] + if !exists || parent.parentKey == "" { + break + } + parentKey = parent.parentKey + } + + return parentKey +} diff --git a/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf b/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf new file mode 100644 index 000000000000..1ff9e896966f --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf @@ -0,0 +1,19 @@ +terraform { + required_providers { + test = { + source = "hashicorp/test" + } + } +} + +resource "test_instance" "test" { + ami = "bar" +} + +module "with_requirement" { + source = "./nested" +} + +module "no_requirements" { + source = "./nested-no-requirements" +} diff --git a/internal/command/testdata/show-json/provider-aliasing-default/child/nested-no-requirements/main.tf b/internal/command/testdata/show-json/provider-aliasing-default/child/nested-no-requirements/main.tf new file mode 100644 index 000000000000..20781869684d --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-default/child/nested-no-requirements/main.tf @@ -0,0 +1,3 @@ +resource "test_instance" "test" { + ami = "qux" +} diff --git a/internal/command/testdata/show-json/provider-aliasing-default/child/nested/main.tf b/internal/command/testdata/show-json/provider-aliasing-default/child/nested/main.tf new file mode 100644 index 000000000000..1590c5cea371 --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-default/child/nested/main.tf @@ -0,0 +1,11 @@ +terraform { + required_providers { + test = { + source = "hashicorp/test" + } + } +} + +resource "test_instance" "test" { + ami = "baz" +} diff --git a/internal/command/testdata/show-json/provider-aliasing-default/main.tf b/internal/command/testdata/show-json/provider-aliasing-default/main.tf new file mode 100644 index 000000000000..f5e63f0aa3bd --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-default/main.tf @@ -0,0 +1,19 @@ +provider "test" { + region = "somewhere" +} + +provider "test" { + alias = "backup" + region = "elsewhere" +} + +resource "test_instance" "test" { + ami = "foo" +} + +module "child" { + source = "./child" + providers = { + test = test.backup + } +} diff --git a/internal/command/testdata/show-json/provider-aliasing-default/output.json b/internal/command/testdata/show-json/provider-aliasing-default/output.json new file mode 100644 index 000000000000..d59e111b412b --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-default/output.json @@ -0,0 +1,270 @@ +{ + "format_version": "1.0", + "terraform_version": "1.1.0-dev", + "planned_values": { + "root_module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "foo" + }, + "sensitive_values": {} + } + ], + "child_modules": [ + { + "resources": [ + { + "address": "module.child.test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "bar" + }, + "sensitive_values": {} + } + ], + "address": "module.child", + "child_modules": [ + { + "resources": [ + { + "address": "module.child.module.with_requirement.test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "baz" + }, + "sensitive_values": {} + } + ], + "address": "module.child.module.with_requirement" + }, + { + "resources": [ + { + "address": "module.child.module.no_requirements.test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "qux" + }, + "sensitive_values": {} + } + ], + "address": "module.child.module.no_requirements" + } + ] + } + ] + } + }, + "resource_changes": [ + { + "address": "module.child.module.no_requirements.test_instance.test", + "module_address": "module.child.module.no_requirements", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "qux" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.child.module.with_requirement.test_instance.test", + "module_address": "module.child.module.with_requirement", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "baz" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "module.child.test_instance.test", + "module_address": "module.child", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "bar" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "foo" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + } + ], + "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", + "expressions": { + "region": { + "constant_value": "somewhere" + } + } + }, + "test.backup": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", + "alias": "backup", + "expressions": { + "region": { + "constant_value": "elsewhere" + } + } + } + }, + "root_module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "foo" + } + }, + "schema_version": 0 + } + ], + "module_calls": { + "child": { + "source": "./child", + "module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "test.backup", + "expressions": { + "ami": { + "constant_value": "bar" + } + }, + "schema_version": 0 + } + ], + "module_calls": { + "no_requirements": { + "source": "./nested-no-requirements", + "module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "test.backup", + "expressions": { + "ami": { + "constant_value": "qux" + } + }, + "schema_version": 0 + } + ] + } + }, + "with_requirement": { + "source": "./nested", + "module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "test.backup", + "expressions": { + "ami": { + "constant_value": "baz" + } + }, + "schema_version": 0 + } + ] + } + } + } + } + } + } + } + } +} From 161374725c7feb57ee9aa978403b8c6019c6901d Mon Sep 17 00:00:00 2001 From: kmoe <5575356+kmoe@users.noreply.github.com> Date: Fri, 18 Feb 2022 10:38:29 +0000 Subject: [PATCH 597/644] Warn when ignore_changes includes a Computed attribute (#30517) * ignore_changes attributes must exist in schema Add a test verifying that attempting to add a nonexistent attribute to ignore_changes throws an error. * ignore_changes cannot be used with Computed attrs Return a warning if a Computed attribute is present in ignore_changes, unless the attribute is also Optional. ignore_changes on a non-Optional Computed attribute is a no-op, so the user likely did not want to set this in config. An Optional Computed attribute, however, is still subject to ignore_changes behaviour, since it is possible to make changes in the configuration that Terraform must ignore. --- .../node_resource_abstract_instance.go | 43 +++--- internal/terraform/node_resource_validate.go | 29 +++- .../terraform/node_resource_validate_test.go | 145 ++++++++++++++++++ 3 files changed, 194 insertions(+), 23 deletions(-) diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index f362758dc280..fb431df53f34 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -1146,30 +1146,35 @@ func (n *NodeAbstractResource) processIgnoreChanges(prior, config cty.Value) (ct func traversalsToPaths(traversals []hcl.Traversal) []cty.Path { paths := make([]cty.Path, len(traversals)) for i, traversal := range traversals { - path := make(cty.Path, len(traversal)) - for si, step := range traversal { - switch ts := step.(type) { - case hcl.TraverseRoot: - path[si] = cty.GetAttrStep{ - Name: ts.Name, - } - case hcl.TraverseAttr: - path[si] = cty.GetAttrStep{ - Name: ts.Name, - } - case hcl.TraverseIndex: - path[si] = cty.IndexStep{ - Key: ts.Key, - } - default: - panic(fmt.Sprintf("unsupported traversal step %#v", step)) - } - } + path := traversalToPath(traversal) paths[i] = path } return paths } +func traversalToPath(traversal hcl.Traversal) cty.Path { + path := make(cty.Path, len(traversal)) + for si, step := range traversal { + switch ts := step.(type) { + case hcl.TraverseRoot: + path[si] = cty.GetAttrStep{ + Name: ts.Name, + } + case hcl.TraverseAttr: + path[si] = cty.GetAttrStep{ + Name: ts.Name, + } + case hcl.TraverseIndex: + path[si] = cty.IndexStep{ + Key: ts.Key, + } + default: + panic(fmt.Sprintf("unsupported traversal step %#v", step)) + } + } + return path +} + func processIgnoreChangesIndividual(prior, config cty.Value, ignoreChangesPath []cty.Path) (cty.Value, tfdiags.Diagnostics) { type ignoreChange struct { // Path is the full path, minus any trailing map index diff --git a/internal/terraform/node_resource_validate.go b/internal/terraform/node_resource_validate.go index cd4ec91fe80b..f3eda571ea3e 100644 --- a/internal/terraform/node_resource_validate.go +++ b/internal/terraform/node_resource_validate.go @@ -2,6 +2,7 @@ package terraform import ( "fmt" + "strings" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/terraform/internal/addrs" @@ -383,10 +384,30 @@ func (n *NodeValidatableResource) validateResource(ctx EvalContext) tfdiags.Diag moreDiags := schema.StaticValidateTraversal(traversal) diags = diags.Append(moreDiags) - // TODO: we want to notify users that they can't use - // ignore_changes for computed attributes, but we don't have an - // easy way to correlate the config value, schema and - // traversal together. + // ignore_changes cannot be used for Computed attributes, + // unless they are also Optional. + // If the traversal was valid, convert it to a cty.Path and + // use that to check whether the Attribute is Computed and + // non-Optional. + if !diags.HasErrors() { + path := traversalToPath(traversal) + + attrSchema := schema.AttributeByPath(path) + + if attrSchema != nil && !attrSchema.Optional && attrSchema.Computed { + // ignore_changes uses absolute traversal syntax in config despite + // using relative traversals, so we strip the leading "." added by + // FormatCtyPath for a better error message. + attrDisplayPath := strings.TrimPrefix(tfdiags.FormatCtyPath(path), ".") + + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagWarning, + Summary: "Redundant ignore_changes element", + Detail: fmt.Sprintf("Adding an attribute name to ignore_changes tells Terraform to ignore future changes to the argument in configuration after the object has been created, retaining the value originally configured.\n\nThe attribute %s is decided by the provider alone and therefore there can be no configured value to compare with. Including this attribute in ignore_changes has no effect. Remove the attribute from ignore_changes to quiet this warning.", attrDisplayPath), + Subject: &n.Config.TypeRange, + }) + } + } } } diff --git a/internal/terraform/node_resource_validate_test.go b/internal/terraform/node_resource_validate_test.go index 3f22cd7e7e24..d0e08c7306d7 100644 --- a/internal/terraform/node_resource_validate_test.go +++ b/internal/terraform/node_resource_validate_test.go @@ -488,3 +488,148 @@ func TestNodeValidatableResource_ValidateResource_invalidDependsOn(t *testing.T) t.Fatalf("wrong error\ngot: %s\nwant: Message containing %q", got, want) } } + +func TestNodeValidatableResource_ValidateResource_invalidIgnoreChangesNonexistent(t *testing.T) { + mp := simpleMockProvider() + mp.ValidateResourceConfigFn = func(req providers.ValidateResourceConfigRequest) providers.ValidateResourceConfigResponse { + return providers.ValidateResourceConfigResponse{} + } + + // We'll check a _valid_ config first, to make sure we're not failing + // for some other reason, and then make it invalid. + p := providers.Interface(mp) + rc := &configs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_object", + Name: "foo", + Config: configs.SynthBody("", map[string]cty.Value{}), + Managed: &configs.ManagedResource{ + IgnoreChanges: []hcl.Traversal{ + { + hcl.TraverseAttr{ + Name: "test_string", + }, + }, + }, + }, + } + node := NodeValidatableResource{ + NodeAbstractResource: &NodeAbstractResource{ + Addr: mustConfigResourceAddr("test_foo.bar"), + Config: rc, + ResolvedProvider: mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), + }, + } + + ctx := &MockEvalContext{} + ctx.installSimpleEval() + + ctx.ProviderSchemaSchema = mp.ProviderSchema() + ctx.ProviderProvider = p + + diags := node.validateResource(ctx) + if diags.HasErrors() { + t.Fatalf("error for supposedly-valid config: %s", diags.ErrWithWarnings()) + } + + // Now we'll make it invalid by attempting to ignore a nonexistent + // attribute. + rc.Managed.IgnoreChanges = append(rc.Managed.IgnoreChanges, hcl.Traversal{ + hcl.TraverseAttr{ + Name: "nonexistent", + }, + }) + + diags = node.validateResource(ctx) + if !diags.HasErrors() { + t.Fatal("no error for invalid ignore_changes") + } + if got, want := diags.Err().Error(), "Unsupported attribute: This object has no argument, nested block, or exported attribute named \"nonexistent\""; !strings.Contains(got, want) { + t.Fatalf("wrong error\ngot: %s\nwant: Message containing %q", got, want) + } +} + +func TestNodeValidatableResource_ValidateResource_invalidIgnoreChangesComputed(t *testing.T) { + // construct a schema with a computed attribute + ms := &configschema.Block{ + Attributes: map[string]*configschema.Attribute{ + "test_string": { + Type: cty.String, + Optional: true, + }, + "computed_string": { + Type: cty.String, + Computed: true, + Optional: false, + }, + }, + } + + mp := &MockProvider{ + GetProviderSchemaResponse: &providers.GetProviderSchemaResponse{ + Provider: providers.Schema{Block: ms}, + ResourceTypes: map[string]providers.Schema{ + "test_object": providers.Schema{Block: ms}, + }, + }, + } + + mp.ValidateResourceConfigFn = func(req providers.ValidateResourceConfigRequest) providers.ValidateResourceConfigResponse { + return providers.ValidateResourceConfigResponse{} + } + + // We'll check a _valid_ config first, to make sure we're not failing + // for some other reason, and then make it invalid. + p := providers.Interface(mp) + rc := &configs.Resource{ + Mode: addrs.ManagedResourceMode, + Type: "test_object", + Name: "foo", + Config: configs.SynthBody("", map[string]cty.Value{}), + Managed: &configs.ManagedResource{ + IgnoreChanges: []hcl.Traversal{ + { + hcl.TraverseAttr{ + Name: "test_string", + }, + }, + }, + }, + } + node := NodeValidatableResource{ + NodeAbstractResource: &NodeAbstractResource{ + Addr: mustConfigResourceAddr("test_foo.bar"), + Config: rc, + ResolvedProvider: mustProviderConfig(`provider["registry.terraform.io/hashicorp/aws"]`), + }, + } + + ctx := &MockEvalContext{} + ctx.installSimpleEval() + + ctx.ProviderSchemaSchema = mp.ProviderSchema() + ctx.ProviderProvider = p + + diags := node.validateResource(ctx) + if diags.HasErrors() { + t.Fatalf("error for supposedly-valid config: %s", diags.ErrWithWarnings()) + } + + // Now we'll make it invalid by attempting to ignore a computed + // attribute. + rc.Managed.IgnoreChanges = append(rc.Managed.IgnoreChanges, hcl.Traversal{ + hcl.TraverseAttr{ + Name: "computed_string", + }, + }) + + diags = node.validateResource(ctx) + if diags.HasErrors() { + t.Fatalf("got unexpected error: %s", diags.ErrWithWarnings()) + } + if got, want := diags.ErrWithWarnings().Error(), `Redundant ignore_changes element: Adding an attribute name to ignore_changes tells Terraform to ignore future changes to the argument in configuration after the object has been created, retaining the value originally configured. + +The attribute computed_string is decided by the provider alone and therefore there can be no configured value to compare with. Including this attribute in ignore_changes has no effect. Remove the attribute from ignore_changes to quiet this warning.`; !strings.Contains(got, want) { + t.Fatalf("wrong error\ngot: %s\nwant: Message containing %q", got, want) + } +} From 0ce040405cfeacc8c32759aa457ccc81c6b3c81f Mon Sep 17 00:00:00 2001 From: nozaq Date: Sat, 19 Feb 2022 00:19:39 +0900 Subject: [PATCH 598/644] jsonconfig: fix provider mappings with same names --- internal/command/command_test.go | 3 +- internal/command/jsonconfig/config.go | 22 +-- internal/command/jsonconfig/config_test.go | 100 ++++++++++++ internal/command/show_test.go | 3 +- .../provider-aliasing-conflict/child/main.tf | 11 ++ .../provider-aliasing-conflict/main.tf | 11 ++ .../provider-aliasing-conflict/output.json | 143 ++++++++++++++++++ .../provider-aliasing-default/child/main.tf | 3 +- .../provider-aliasing-default/output.json | 13 +- 9 files changed, 291 insertions(+), 18 deletions(-) create mode 100644 internal/command/jsonconfig/config_test.go create mode 100644 internal/command/testdata/show-json/provider-aliasing-conflict/child/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing-conflict/main.tf create mode 100644 internal/command/testdata/show-json/provider-aliasing-conflict/output.json diff --git a/internal/command/command_test.go b/internal/command/command_test.go index 4a56ecc73b23..2f75ec30de1b 100644 --- a/internal/command/command_test.go +++ b/internal/command/command_test.go @@ -171,7 +171,8 @@ func testFixturePath(name string) string { func metaOverridesForProvider(p providers.Interface) *testingOverrides { return &testingOverrides{ Providers: map[addrs.Provider]providers.Factory{ - addrs.NewDefaultProvider("test"): providers.FactoryFixed(p), + addrs.NewDefaultProvider("test"): providers.FactoryFixed(p), + addrs.NewProvider(addrs.DefaultProviderRegistryHost, "hashicorp2", "test"): providers.FactoryFixed(p), }, } } diff --git a/internal/command/jsonconfig/config.go b/internal/command/jsonconfig/config.go index 9670fd5e6428..4727bc0982d7 100644 --- a/internal/command/jsonconfig/config.go +++ b/internal/command/jsonconfig/config.go @@ -233,7 +233,7 @@ func marshalProviderConfigs( if c.Parent != nil { parentKey := opaqueProviderKey(pr.Name, c.Parent.Path.String()) - p.parentKey = findSourceProviderKey(parentKey, m) + p.parentKey = findSourceProviderKey(parentKey, p.FullName, m) } m[key] = p @@ -255,7 +255,7 @@ func marshalProviderConfigs( Name: req.Type, FullName: req.String(), ModuleAddress: c.Path.String(), - parentKey: findSourceProviderKey(parentKey, m), + parentKey: findSourceProviderKey(parentKey, req.String(), m), } m[key] = p @@ -287,7 +287,7 @@ func marshalProviderConfigs( key := opaqueProviderKey(moduleProviderName, cc.Path.String()) parentKey := opaqueProviderKey(parentProviderName, cc.Parent.Path.String()) - p.parentKey = findSourceProviderKey(parentKey, m) + p.parentKey = findSourceProviderKey(parentKey, p.FullName, m) m[key] = p } @@ -545,14 +545,18 @@ func opaqueProviderKey(provider string, addr string) (key string) { // configuration which has no linked parent config. This is then // the source of the configuration used in this module call, so // we link to it directly -func findSourceProviderKey(startKey string, m map[string]providerConfig) string { - parentKey := startKey - for { - parent, exists := m[parentKey] - if !exists || parent.parentKey == "" { +func findSourceProviderKey(startKey string, fullName string, m map[string]providerConfig) string { + var parentKey string + + key := startKey + for key != "" { + parent, exists := m[key] + if !exists || parent.FullName != fullName { break } - parentKey = parent.parentKey + + parentKey = key + key = parent.parentKey } return parentKey diff --git a/internal/command/jsonconfig/config_test.go b/internal/command/jsonconfig/config_test.go new file mode 100644 index 000000000000..69aeae3f0318 --- /dev/null +++ b/internal/command/jsonconfig/config_test.go @@ -0,0 +1,100 @@ +package jsonconfig + +import ( + "testing" +) + +func TestFindSourceProviderConfig(t *testing.T) { + tests := []struct { + StartKey string + FullName string + ProviderMap map[string]providerConfig + Want string + }{ + { + StartKey: "null", + FullName: "hashicorp/null", + ProviderMap: map[string]providerConfig{}, + Want: "", + }, + { + StartKey: "null", + FullName: "hashicorp/null", + ProviderMap: map[string]providerConfig{ + "null": { + Name: "null", + FullName: "hashicorp/null", + ModuleAddress: "", + }, + }, + Want: "null", + }, + { + StartKey: "null2", + FullName: "hashicorp/null", + ProviderMap: map[string]providerConfig{ + "null": { + Name: "null", + FullName: "hashicorp/null", + ModuleAddress: "", + }, + }, + Want: "", + }, + { + StartKey: "null", + FullName: "hashicorp2/null", + ProviderMap: map[string]providerConfig{ + "null": { + Name: "null", + FullName: "hashicorp/null", + ModuleAddress: "", + }, + }, + Want: "", + }, + { + StartKey: "module.a:null", + FullName: "hashicorp/null", + ProviderMap: map[string]providerConfig{ + "null": { + Name: "null", + FullName: "hashicorp/null", + ModuleAddress: "", + }, + "module.a:null": { + Name: "module.a:null", + FullName: "hashicorp/null", + ModuleAddress: "module.a", + parentKey: "null", + }, + }, + Want: "null", + }, + { + StartKey: "module.a:null", + FullName: "hashicorp2/null", + ProviderMap: map[string]providerConfig{ + "null": { + Name: "null", + FullName: "hashicorp/null", + ModuleAddress: "", + }, + "module.a:null": { + Name: "module.a:null", + FullName: "hashicorp2/null", + ModuleAddress: "module.a", + parentKey: "null", + }, + }, + Want: "module.a:null", + }, + } + + for _, test := range tests { + got := findSourceProviderKey(test.StartKey, test.FullName, test.ProviderMap) + if got != test.Want { + t.Errorf("wrong result:\nGot: %#v\nWant: %#v\n", got, test.Want) + } + } +} diff --git a/internal/command/show_test.go b/internal/command/show_test.go index 00a9e555a2e5..80ae6a9f2294 100644 --- a/internal/command/show_test.go +++ b/internal/command/show_test.go @@ -493,7 +493,8 @@ func TestShow_json_output(t *testing.T) { expectError := strings.Contains(entry.Name(), "error") providerSource, close := newMockProviderSource(t, map[string][]string{ - "test": {"1.2.3"}, + "test": {"1.2.3"}, + "hashicorp2/test": {"1.2.3"}, }) defer close() diff --git a/internal/command/testdata/show-json/provider-aliasing-conflict/child/main.tf b/internal/command/testdata/show-json/provider-aliasing-conflict/child/main.tf new file mode 100644 index 000000000000..2479df3359f4 --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-conflict/child/main.tf @@ -0,0 +1,11 @@ +terraform { + required_providers { + test = { + source = "hashicorp2/test" + } + } +} + +resource "test_instance" "test" { + ami = "bar" +} diff --git a/internal/command/testdata/show-json/provider-aliasing-conflict/main.tf b/internal/command/testdata/show-json/provider-aliasing-conflict/main.tf new file mode 100644 index 000000000000..2d8bc0b90120 --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-conflict/main.tf @@ -0,0 +1,11 @@ +provider "test" { + region = "somewhere" +} + +resource "test_instance" "test" { + ami = "foo" +} + +module "child" { + source = "./child" +} diff --git a/internal/command/testdata/show-json/provider-aliasing-conflict/output.json b/internal/command/testdata/show-json/provider-aliasing-conflict/output.json new file mode 100644 index 000000000000..6b7ee48c8da0 --- /dev/null +++ b/internal/command/testdata/show-json/provider-aliasing-conflict/output.json @@ -0,0 +1,143 @@ +{ + "format_version": "1.0", + "terraform_version": "1.1.0-dev", + "planned_values": { + "root_module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "schema_version": 0, + "values": { + "ami": "foo" + }, + "sensitive_values": {} + } + ], + "child_modules": [ + { + "resources": [ + { + "address": "module.child.test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp2/test", + "schema_version": 0, + "values": { + "ami": "bar" + }, + "sensitive_values": {} + } + ], + "address": "module.child" + } + ] + } + }, + "resource_changes": [ + { + "address": "module.child.test_instance.test", + "module_address": "module.child", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp2/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "bar" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + }, + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_name": "registry.terraform.io/hashicorp/test", + "change": { + "actions": [ + "create" + ], + "before": null, + "after": { + "ami": "foo" + }, + "after_unknown": { + "id": true + }, + "before_sensitive": false, + "after_sensitive": {} + } + } + ], + "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test", + "expressions": { + "region": { + "constant_value": "somewhere" + } + } + }, + "module.child:test": { + "module_address": "module.child", + "name": "test", + "full_name": "registry.terraform.io/hashicorp2/test" + } + }, + "root_module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "test", + "expressions": { + "ami": { + "constant_value": "foo" + } + }, + "schema_version": 0 + } + ], + "module_calls": { + "child": { + "source": "./child", + "module": { + "resources": [ + { + "address": "test_instance.test", + "mode": "managed", + "type": "test_instance", + "name": "test", + "provider_config_key": "module.child:test", + "expressions": { + "ami": { + "constant_value": "bar" + } + }, + "schema_version": 0 + } + ] + } + } + } + } + } +} diff --git a/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf b/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf index 1ff9e896966f..b865e3e14a97 100644 --- a/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf +++ b/internal/command/testdata/show-json/provider-aliasing-default/child/main.tf @@ -11,7 +11,8 @@ resource "test_instance" "test" { } module "with_requirement" { - source = "./nested" + source = "./nested" + depends_on = [module.no_requirements] } module "no_requirements" { diff --git a/internal/command/testdata/show-json/provider-aliasing-default/output.json b/internal/command/testdata/show-json/provider-aliasing-default/output.json index d59e111b412b..d6b1706437de 100644 --- a/internal/command/testdata/show-json/provider-aliasing-default/output.json +++ b/internal/command/testdata/show-json/provider-aliasing-default/output.json @@ -38,36 +38,36 @@ { "resources": [ { - "address": "module.child.module.with_requirement.test_instance.test", + "address": "module.child.module.no_requirements.test_instance.test", "mode": "managed", "type": "test_instance", "name": "test", "provider_name": "registry.terraform.io/hashicorp/test", "schema_version": 0, "values": { - "ami": "baz" + "ami": "qux" }, "sensitive_values": {} } ], - "address": "module.child.module.with_requirement" + "address": "module.child.module.no_requirements" }, { "resources": [ { - "address": "module.child.module.no_requirements.test_instance.test", + "address": "module.child.module.with_requirement.test_instance.test", "mode": "managed", "type": "test_instance", "name": "test", "provider_name": "registry.terraform.io/hashicorp/test", "schema_version": 0, "values": { - "ami": "qux" + "ami": "baz" }, "sensitive_values": {} } ], - "address": "module.child.module.no_requirements" + "address": "module.child.module.with_requirement" } ] } @@ -243,6 +243,7 @@ }, "with_requirement": { "source": "./nested", + "depends_on": ["module.no_requirements"], "module": { "resources": [ { From 3c32f7a56cc0dfbd68f0eeef3534fe488c1f919e Mon Sep 17 00:00:00 2001 From: nozaq Date: Sat, 19 Feb 2022 01:15:58 +0900 Subject: [PATCH 599/644] jsonconfig: add implicitly created provider configs --- internal/command/jsonconfig/config.go | 38 ++++++++++--------- .../show-json/basic-delete/output.json | 6 +++ .../show-json/basic-update/output.json | 6 +++ .../testdata/show-json/drift/output.json | 6 +++ .../show-json/module-depends-on/output.json | 6 +++ .../testdata/show-json/modules/output.json | 5 +++ .../show-json/moved-drift/output.json | 6 +++ .../testdata/show-json/moved/output.json | 6 +++ .../multi-resource-update/output.json | 6 +++ .../show-json/nested-modules/output.json | 15 +++++--- .../show-json/requires-replace/output.json | 6 +++ .../show-json/sensitive-values/output.json | 6 +++ 12 files changed, 88 insertions(+), 24 deletions(-) diff --git a/internal/command/jsonconfig/config.go b/internal/command/jsonconfig/config.go index 4727bc0982d7..f744c91086f8 100644 --- a/internal/command/jsonconfig/config.go +++ b/internal/command/jsonconfig/config.go @@ -239,27 +239,29 @@ func marshalProviderConfigs( m[key] = p } - // In child modules, providers defined in the parent module can be implicitly used. - // Such providers could have no requirements and configuration blocks defined. - if c.Parent != nil { - for req := range reqs { - // Implicit inheritance only applies to the default provider, - // so the provider name must be same as the provider type. - key := opaqueProviderKey(req.Type, c.Path.String()) - if _, exists := m[key]; exists { - continue - } + // Providers could be implicitly created or inherited from the parent module + // when no requirements and configuration block defined. + for req := range reqs { + // Only default providers could implicitly exist, + // so the provider name must be same as the provider type. + key := opaqueProviderKey(req.Type, c.Path.String()) + if _, exists := m[key]; exists { + continue + } - parentKey := opaqueProviderKey(req.Type, c.Parent.Path.String()) - p := providerConfig{ - Name: req.Type, - FullName: req.String(), - ModuleAddress: c.Path.String(), - parentKey: findSourceProviderKey(parentKey, req.String(), m), - } + p := providerConfig{ + Name: req.Type, + FullName: req.String(), + ModuleAddress: c.Path.String(), + } - m[key] = p + // In child modules, providers defined in the parent module can be implicitly used. + if c.Parent != nil { + parentKey := opaqueProviderKey(req.Type, c.Parent.Path.String()) + p.parentKey = findSourceProviderKey(parentKey, p.FullName, m) } + + m[key] = p } // Must also visit our child modules, recursively. diff --git a/internal/command/testdata/show-json/basic-delete/output.json b/internal/command/testdata/show-json/basic-delete/output.json index e1779c04cc2a..4b10cc283a1c 100644 --- a/internal/command/testdata/show-json/basic-delete/output.json +++ b/internal/command/testdata/show-json/basic-delete/output.json @@ -130,6 +130,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/basic-update/output.json b/internal/command/testdata/show-json/basic-update/output.json index e4b4731426a1..a81cc2b5d174 100644 --- a/internal/command/testdata/show-json/basic-update/output.json +++ b/internal/command/testdata/show-json/basic-update/output.json @@ -96,6 +96,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/drift/output.json b/internal/command/testdata/show-json/drift/output.json index 2d5c071b4300..08029bf37e77 100644 --- a/internal/command/testdata/show-json/drift/output.json +++ b/internal/command/testdata/show-json/drift/output.json @@ -141,6 +141,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "resources": [ { diff --git a/internal/command/testdata/show-json/module-depends-on/output.json b/internal/command/testdata/show-json/module-depends-on/output.json index d02efaa22f0d..c76c762659d9 100644 --- a/internal/command/testdata/show-json/module-depends-on/output.json +++ b/internal/command/testdata/show-json/module-depends-on/output.json @@ -43,6 +43,12 @@ } ], "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "resources": [ { diff --git a/internal/command/testdata/show-json/modules/output.json b/internal/command/testdata/show-json/modules/output.json index 1728282592de..e4ef8deb18ae 100644 --- a/internal/command/testdata/show-json/modules/output.json +++ b/internal/command/testdata/show-json/modules/output.json @@ -293,6 +293,11 @@ "module_address": "module.module_test_foo", "name": "test", "full_name": "registry.terraform.io/hashicorp/test" + }, + "module.module_test_bar:test": { + "module_address": "module.module_test_bar", + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" } } } diff --git a/internal/command/testdata/show-json/moved-drift/output.json b/internal/command/testdata/show-json/moved-drift/output.json index ad6b0564135e..db3ac21c257e 100644 --- a/internal/command/testdata/show-json/moved-drift/output.json +++ b/internal/command/testdata/show-json/moved-drift/output.json @@ -143,6 +143,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "resources": [ { diff --git a/internal/command/testdata/show-json/moved/output.json b/internal/command/testdata/show-json/moved/output.json index 3e74a4ddb4e4..d8b9f2a245ea 100644 --- a/internal/command/testdata/show-json/moved/output.json +++ b/internal/command/testdata/show-json/moved/output.json @@ -68,6 +68,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "resources": [ { diff --git a/internal/command/testdata/show-json/multi-resource-update/output.json b/internal/command/testdata/show-json/multi-resource-update/output.json index 6da29965e29c..279a8d5593fb 100644 --- a/internal/command/testdata/show-json/multi-resource-update/output.json +++ b/internal/command/testdata/show-json/multi-resource-update/output.json @@ -137,6 +137,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "outputs": { "test": { diff --git a/internal/command/testdata/show-json/nested-modules/output.json b/internal/command/testdata/show-json/nested-modules/output.json index 6d0af8a1468c..cf1ab978c912 100644 --- a/internal/command/testdata/show-json/nested-modules/output.json +++ b/internal/command/testdata/show-json/nested-modules/output.json @@ -37,9 +37,7 @@ "name": "test", "provider_name": "registry.terraform.io/hashicorp/test", "change": { - "actions": [ - "create" - ], + "actions": ["create"], "before": null, "after": { "ami": "bar-var" @@ -53,6 +51,13 @@ } ], "configuration": { + "provider_config": { + "module.my_module.module.more:test": { + "module_address": "module.my_module.module.more", + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "module_calls": { "my_module": { @@ -71,9 +76,7 @@ "provider_config_key": "module.my_module.module.more:test", "expressions": { "ami": { - "references": [ - "var.test_var" - ] + "references": ["var.test_var"] } }, "schema_version": 0 diff --git a/internal/command/testdata/show-json/requires-replace/output.json b/internal/command/testdata/show-json/requires-replace/output.json index e71df784f4f7..1eb37ea1cfbd 100644 --- a/internal/command/testdata/show-json/requires-replace/output.json +++ b/internal/command/testdata/show-json/requires-replace/output.json @@ -70,6 +70,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "resources": [ { diff --git a/internal/command/testdata/show-json/sensitive-values/output.json b/internal/command/testdata/show-json/sensitive-values/output.json index d7e4719c71f5..0047c0b60042 100644 --- a/internal/command/testdata/show-json/sensitive-values/output.json +++ b/internal/command/testdata/show-json/sensitive-values/output.json @@ -81,6 +81,12 @@ } }, "configuration": { + "provider_config": { + "test": { + "name": "test", + "full_name": "registry.terraform.io/hashicorp/test" + } + }, "root_module": { "outputs": { "test": { From 3e4d6b252f1ad4540b792ce4516654ade76a18dd Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 18 Feb 2022 16:43:23 -0500 Subject: [PATCH 600/644] jsonplan: Improve performance for deep objects When calculating the unknown values for JSON plan output, we would previously recursively call the `unknownAsBool` function on the current sub-tree twice, if any values were unknown. This was wasteful, but not noticeable for normal Terraform resource shapes. However for deeper nested object values, such as Kubernetes manifests, this was a severe performance problem, causing `terraform show -json` to take several hours to render a plan. This commit reuses the already calculated unknown value for the subtree, and adds benchmark coverage to demonstrate the improvement. --- internal/command/jsonplan/plan.go | 2 +- internal/command/jsonplan/plan_test.go | 56 ++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 1 deletion(-) diff --git a/internal/command/jsonplan/plan.go b/internal/command/jsonplan/plan.go index 53fe8ec01b45..c68cfe8021c0 100644 --- a/internal/command/jsonplan/plan.go +++ b/internal/command/jsonplan/plan.go @@ -597,7 +597,7 @@ func unknownAsBool(val cty.Value) cty.Value { // Omit all of the "false"s for known values for more compact // serialization if !vAsBool.RawEquals(cty.False) { - vals[k.AsString()] = unknownAsBool(v) + vals[k.AsString()] = vAsBool } } // The above transform may have changed the types of some of the diff --git a/internal/command/jsonplan/plan_test.go b/internal/command/jsonplan/plan_test.go index cf23187e506f..3c640cf6dadf 100644 --- a/internal/command/jsonplan/plan_test.go +++ b/internal/command/jsonplan/plan_test.go @@ -304,3 +304,59 @@ func TestEncodePaths(t *testing.T) { }) } } + +func deepObjectValue(depth int) cty.Value { + v := cty.ObjectVal(map[string]cty.Value{ + "a": cty.StringVal("a"), + "b": cty.NumberIntVal(2), + "c": cty.True, + "d": cty.UnknownVal(cty.String), + }) + + result := v + + for i := 0; i < depth; i++ { + result = cty.ObjectVal(map[string]cty.Value{ + "a": result, + "b": result, + "c": result, + }) + } + + return result +} + +func BenchmarkUnknownAsBool_2(b *testing.B) { + value := deepObjectValue(2) + for n := 0; n < b.N; n++ { + unknownAsBool(value) + } +} + +func BenchmarkUnknownAsBool_3(b *testing.B) { + value := deepObjectValue(3) + for n := 0; n < b.N; n++ { + unknownAsBool(value) + } +} + +func BenchmarkUnknownAsBool_5(b *testing.B) { + value := deepObjectValue(5) + for n := 0; n < b.N; n++ { + unknownAsBool(value) + } +} + +func BenchmarkUnknownAsBool_7(b *testing.B) { + value := deepObjectValue(7) + for n := 0; n < b.N; n++ { + unknownAsBool(value) + } +} + +func BenchmarkUnknownAsBool_9(b *testing.B) { + value := deepObjectValue(9) + for n := 0; n < b.N; n++ { + unknownAsBool(value) + } +} From a26b551d4790beb5f09b3df7d640cd7a04eeac6a Mon Sep 17 00:00:00 2001 From: Drew Hodun Date: Tue, 22 Feb 2022 11:09:22 -0500 Subject: [PATCH 601/644] added github.com commit reference example --- website/docs/language/modules/sources.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docs/language/modules/sources.mdx b/website/docs/language/modules/sources.mdx index 0ca91108b1c1..ea06f0dea748 100644 --- a/website/docs/language/modules/sources.mdx +++ b/website/docs/language/modules/sources.mdx @@ -472,6 +472,7 @@ the version control sources, the sub-directory portion must be _before_ those arguments: - `git::https://example.com/network.git//modules/vpc?ref=v1.2.0` +- `github.com/hashicorp/example//modules/vpc?ref=v1.2.0` Terraform will still extract the entire package to local disk, but will read the module from the subdirectory. As a result, it is safe for a module in From 2393c48720369df91bf6541e980ea81c82e9f535 Mon Sep 17 00:00:00 2001 From: kmoe <5575356+kmoe@users.noreply.github.com> Date: Wed, 23 Feb 2022 11:59:01 +0000 Subject: [PATCH 602/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index eb72139d792a..818cdde3fefc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,7 @@ BUG FIXES: * Terraform now handles type constraints, nullability, and custom variable validation properly for root module variables. Previously there was an order of operations problem where the nullability and custom variable validation were checked too early, prior to dealing with the type constraints, and thus that logic could potentially "see" an incorrectly-typed value in spite of the type constraint, leading to incorrect errors. [GH-29959] * `terraform show -json`: JSON plan output now correctly maps aliased providers to their configurations, and includes the full provider source address alongside the short provider name. [GH-30138] +* Terraform now prints a warning when adding an attribute to `ignore_changes` that is managed only by the provider (non-optional computed attribute). [GH-30517] ## Previous Releases From 3e9ae69a1298e9a08c6b338d13d5b7e1fe090793 Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Tue, 7 Dec 2021 15:35:04 -0800 Subject: [PATCH 603/644] [cloud] run tasks integration This change will await the completion of pre-apply run tasks if they exist on a run and then report the results. It also adds an abstraction when interacting with cloud integrations such as policy checking and cost estimation that simplify and unify output, although I did not go so far as to refactor those callers to use it yet. --- go.mod | 1 + go.sum | 4 +- internal/backend/remote/backend_common.go | 2 +- internal/cloud/backend_plan.go | 15 +++ internal/cloud/backend_runTasks.go | 139 ++++++++++++++++++++ internal/cloud/backend_runTasks_test.go | 146 ++++++++++++++++++++++ internal/cloud/cloud_integration.go | 117 +++++++++++++++++ 7 files changed, 421 insertions(+), 3 deletions(-) create mode 100644 internal/cloud/backend_runTasks.go create mode 100644 internal/cloud/backend_runTasks_test.go create mode 100644 internal/cloud/cloud_integration.go diff --git a/go.mod b/go.mod index 2cbdb0fc0ece..8b780419bdb3 100644 --- a/go.mod +++ b/go.mod @@ -42,6 +42,7 @@ require ( github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 github.com/hashicorp/go-tfe v0.21.0 + github.com/hashicorp/go-safetemp v1.0.0 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index 447f84bbb664..e8ef3c7f2ef2 100644 --- a/go.sum +++ b/go.sum @@ -407,8 +407,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.21.0 h1:P1QoeLkigDi4BXGQ//42kyXwfcHUqbh5jJemml6iQJs= -github.com/hashicorp/go-tfe v0.21.0/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.20.1-0.20211210153426-243d1b1eb033 h1:SoQhT2l6xHh7LOprw1F6MPzxSk65kSXdyfubOs8D+Ho= +github.com/hashicorp/go-tfe v0.20.1-0.20211210153426-243d1b1eb033/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= diff --git a/internal/backend/remote/backend_common.go b/internal/backend/remote/backend_common.go index dc102f59449f..07437f3a39a5 100644 --- a/internal/backend/remote/backend_common.go +++ b/internal/backend/remote/backend_common.go @@ -299,7 +299,7 @@ func (b *Remote) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Op deltaRepr := strings.Replace(ce.DeltaMonthlyCost, "-", "", 1) if b.CLI != nil { - b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color("[bold]" + msgPrefix + ":\n")) b.CLI.Output(b.Colorize().Color(fmt.Sprintf("Resources: %d of %d estimated", ce.MatchedResourcesCount, ce.ResourcesCount))) b.CLI.Output(b.Colorize().Color(fmt.Sprintf(" $%s/mo %s$%s", ce.ProposedMonthlyCost, sign, deltaRepr))) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 1956a9c82954..2ec1439ea58f 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -351,9 +351,24 @@ in order to capture the filesystem context the remote workspace expects: } } + // Await collective run tasks + if len(r.TaskStage) > 0 { + context := NewIntegrationContext(stopCtx, cancelCtx, b, op, r) + err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), r.TaskStage[0].ID) + + if err != nil { + return r, err + } + } + return r, nil } +// String returns a pointer to the given string. +func String(v string) *string { + return &v +} + const planDefaultHeader = ` [reset][yellow]Running plan in Terraform Cloud. Output will stream here. Pressing Ctrl-C will stop streaming the logs, but will not stop the plan running remotely.[reset] diff --git a/internal/cloud/backend_runTasks.go b/internal/cloud/backend_runTasks.go new file mode 100644 index 000000000000..8ef8679e40ca --- /dev/null +++ b/internal/cloud/backend_runTasks.go @@ -0,0 +1,139 @@ +package cloud + +import ( + "context" + "fmt" + "strings" + + "github.com/hashicorp/go-tfe" +) + +type taskResultSummary struct { + pending int + failed int + failedMandatory int + passed int +} + +type taskStageReadFunc func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) + +func summarizeTaskResults(taskResults []*tfe.TaskResult) taskResultSummary { + var pe, er, erm, pa int + for _, task := range taskResults { + if task.Status == "running" || task.Status == "pending" { + pe++ + } else if task.Status == "passed" { + pa++ + } else { + // Everything else is a failure + er++ + if task.WorkspaceTaskEnforcementLevel == "mandatory" { + erm++ + } + } + } + + return taskResultSummary{ + pending: pe, + failed: er, + failedMandatory: erm, + passed: pa, + } +} + +// elapsedMessageMax is 50 chars: the length of this message with 6 digits +// 99 tasks still pending, 99 passed, 99 failed ... +const elapsedMessageMax int = 50 + +func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output IntegrationOutputWriter, fetchTaskStage taskStageReadFunc) error { + // TODO: Do not fetch run tasks if there are no changes to infrastructure + // if !context.Run.HasChanges { + // output.Output("No Changes. Tasks will not run") + // output.End() + + // return nil + // } + + return context.Poll(func(i int) (bool, error) { + // TODO: get the stage that corresponds to an argument passed to this function + stage, err := fetchTaskStage(b, context.StopContext) + + if err != nil { + return false, generalError("Failed to retrieve pre-apply task stage", err) + } + + summary := summarizeTaskResults(stage.TaskResults) + if summary.pending > 0 { + message := fmt.Sprintf("%d tasks still pending, %d passed, %d failed ... ", summary.pending, summary.passed, summary.failed) + + if i%4 == 0 { + if i > 0 { + output.OutputElapsed(message, elapsedMessageMax) + } + } + return true, nil + } + + // No more tasks pending/running. Print all the results. + + // Track the first task name that is a mandatory enforcement level breach. + var firstMandatoryTaskFailed *string = nil + + if i == 0 { + output.Output(fmt.Sprintf("All tasks completed! %d passed, %d failed", summary.passed, summary.failed)) + } else { + output.OutputElapsed(fmt.Sprintf("All tasks completed! %d passed, %d failed", summary.passed, summary.failed), 50) + } + + output.Output("") + + for _, t := range stage.TaskResults { + capitalizedStatus := string(t.Status) + capitalizedStatus = strings.ToUpper(capitalizedStatus[:1]) + capitalizedStatus[1:] + + status := "[green]" + capitalizedStatus + if t.Status != "passed" { + level := string(t.WorkspaceTaskEnforcementLevel) + level = strings.ToUpper(level[:1]) + level[1:] + status = fmt.Sprintf("[red]%s (%s)", capitalizedStatus, level) + + if t.WorkspaceTaskEnforcementLevel == "mandatory" && firstMandatoryTaskFailed == nil { + firstMandatoryTaskFailed = &t.TaskName + } + } + + title := fmt.Sprintf(`%s ⸺ %s`, t.TaskName, status) + output.SubOutput(title) + + output.SubOutput(fmt.Sprintf("[dim]%s", t.Message)) + output.SubOutput("") + } + + // If a mandatory enforcement level is breached, return an error. + var taskErr error = nil + var overall string = "[green]Passed" + if firstMandatoryTaskFailed != nil { + overall = "[red]Failed" + taskErr = fmt.Errorf("the run failed because the run task, %s, is required to succeed", *firstMandatoryTaskFailed) + } else if summary.failed > 0 { // we have failures but none of them mandatory + overall = "[green]Passed with advisory failures" + } + + output.SubOutput("") + output.SubOutput("[bold]Overall Result: " + overall) + + output.End() + + return false, taskErr + }) +} + +func (b *Cloud) runTasks(ctx *IntegrationContext, output IntegrationOutputWriter, stageID string) error { + return b.runTasksWithTaskResults(ctx, output, func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) { + options := tfe.TaskStageReadOptions{ + Include: "task_results", + } + + return b.client.TaskStages.Read(ctx.StopContext, stageID, &options) + }) +} diff --git a/internal/cloud/backend_runTasks_test.go b/internal/cloud/backend_runTasks_test.go new file mode 100644 index 000000000000..9cb133cd5520 --- /dev/null +++ b/internal/cloud/backend_runTasks_test.go @@ -0,0 +1,146 @@ +package cloud + +import ( + "context" + "strings" + "testing" + + "github.com/hashicorp/go-tfe" +) + +type testIntegrationOutput struct { + ctx *IntegrationContext + output *strings.Builder + t *testing.T +} + +var _ IntegrationOutputWriter = (*testIntegrationOutput)(nil) // Compile time check + +func (s *testIntegrationOutput) End() { + s.output.WriteString("END\n") +} + +func (s *testIntegrationOutput) SubOutput(str string) { + s.output.WriteString(s.ctx.B.Colorize().Color("[reset]│ "+str) + "\n") +} + +func (s *testIntegrationOutput) Output(str string) { + s.output.WriteString(s.ctx.B.Colorize().Color("[reset]│ ") + str + "\n") +} + +func (s *testIntegrationOutput) OutputElapsed(message string, maxMessage int) { + s.output.WriteString("PENDING MESSAGE: " + message) +} + +func newMockIntegrationContext(b *Cloud, t *testing.T) (*IntegrationContext, *testIntegrationOutput) { + ctx := context.Background() + + // Retrieve the workspace used to run this operation in. + w, err := b.client.Workspaces.Read(ctx, b.organization, b.WorkspaceMapping.Name) + if err != nil { + t.Fatalf("error retrieving workspace: %v", err) + } + + // Create a new configuration version. + c, err := b.client.ConfigurationVersions.Create(ctx, w.ID, tfe.ConfigurationVersionCreateOptions{}) + if err != nil { + t.Fatalf("error creating configuration version: %v", err) + } + + // Create a pending run to block this run. + r, err := b.client.Runs.Create(ctx, tfe.RunCreateOptions{ + ConfigurationVersion: c, + Workspace: w, + }) + if err != nil { + t.Fatalf("error creating pending run: %v", err) + } + + op, configCleanup, done := testOperationPlan(t, "./testdata/plan") + defer configCleanup() + defer done(t) + + integrationContext := &IntegrationContext{ + B: b, + StopContext: ctx, + CancelContext: ctx, + Op: op, + Run: r, + } + + return integrationContext, &testIntegrationOutput{ + ctx: integrationContext, + output: &strings.Builder{}, + t: t, + } +} + +func TestCloud_runTasksWithTaskResults(t *testing.T) { + b, bCleanup := testBackendWithName(t) + defer bCleanup() + + integrationContext, writer := newMockIntegrationContext(b, t) + + cases := map[string]struct { + taskResults []*tfe.TaskResult + context *IntegrationContext + writer *testIntegrationOutput + expectedOutputs []string + isError bool + }{ + "all-succeeded": { + taskResults: []*tfe.TaskResult{ + {ID: "1", TaskName: "Mandatory", Message: "A-OK", Status: "passed", WorkspaceTaskEnforcementLevel: "mandatory"}, + {ID: "2", TaskName: "Advisory", Message: "A-OK", Status: "passed", WorkspaceTaskEnforcementLevel: "advisory"}, + }, + writer: writer, + context: integrationContext, + expectedOutputs: []string{"Overall Result: Passed\n"}, + isError: false, + }, + "mandatory-failed": { + taskResults: []*tfe.TaskResult{ + {ID: "1", TaskName: "Mandatory", Message: "500 Error", Status: "failed", WorkspaceTaskEnforcementLevel: "mandatory"}, + {ID: "2", TaskName: "Advisory", Message: "A-OK", Status: "passed", WorkspaceTaskEnforcementLevel: "advisory"}, + }, + writer: writer, + context: integrationContext, + expectedOutputs: []string{"Passed\n", "A-OK\n", "Overall Result: Failed\n"}, + isError: true, + }, + "advisory-failed": { + taskResults: []*tfe.TaskResult{ + {ID: "1", TaskName: "Mandatory", Message: "A-OK", Status: "passed", WorkspaceTaskEnforcementLevel: "mandatory"}, + {ID: "2", TaskName: "Advisory", Message: "500 Error", Status: "failed", WorkspaceTaskEnforcementLevel: "advisory"}, + }, + writer: writer, + context: integrationContext, + expectedOutputs: []string{"Failed (Advisory)", "Overall Result: Passed with advisory failure"}, + isError: false, + }, + } + + for caseName, c := range cases { + c.writer.output.Reset() + err := b.runTasksWithTaskResults(c.writer.ctx, c.writer, func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) { + return &tfe.TaskStage{ + TaskResults: c.taskResults, + }, nil + }) + + if c.isError && err == nil { + t.Fatalf("Expected %s to be error", caseName) + } + + if !c.isError && err != nil { + t.Errorf("Expected %s to not be error but received %s", caseName, err) + } + + output := c.writer.output.String() + for _, expected := range c.expectedOutputs { + if !strings.Contains(output, expected) { + t.Fatalf("Expected output to contain '%s' but it was:\n\n%s", expected, output) + } + } + } +} diff --git a/internal/cloud/cloud_integration.go b/internal/cloud/cloud_integration.go new file mode 100644 index 000000000000..168e1ae2647b --- /dev/null +++ b/internal/cloud/cloud_integration.go @@ -0,0 +1,117 @@ +package cloud + +import ( + "context" + "fmt" + "strconv" + "time" + + "github.com/hashicorp/go-tfe" + "github.com/hashicorp/terraform/internal/backend" +) + +type IntegrationOutputWriter interface { + End() + OutputElapsed(message string, maxMessage int) + Output(str string) + SubOutput(str string) +} + +type IntegrationContext struct { + started time.Time + B *Cloud + StopContext context.Context + CancelContext context.Context + Op *backend.Operation + Run *tfe.Run +} + +type integrationCLIOutput struct { + ctx *IntegrationContext +} + +var _ IntegrationOutputWriter = (*integrationCLIOutput)(nil) // Compile time check + +func NewIntegrationContext(stopCtx, cancelCtx context.Context, b *Cloud, op *backend.Operation, r *tfe.Run) *IntegrationContext { + return &IntegrationContext{ + B: b, + StopContext: stopCtx, + CancelContext: cancelCtx, + Op: op, + Run: r, + } +} + +func (s *IntegrationContext) Poll(every func(i int) (bool, error)) error { + for i := 0; ; i++ { + select { + case <-s.StopContext.Done(): + return s.StopContext.Err() + case <-s.CancelContext.Done(): + return s.CancelContext.Err() + case <-time.After(backoff(backoffMin, backoffMax, i)): + // blocks for a time between min and max + } + + cont, err := every(i) + if !cont { + return err + } + } +} + +func (s *IntegrationContext) BeginOutput(name string) IntegrationOutputWriter { + var result IntegrationOutputWriter = &integrationCLIOutput{ + ctx: s, + } + + s.started = time.Now() + + if s.HasCLI() { + s.B.CLI.Output("\n------------------------------------------------------------------------\n") + } + + result.Output("[bold]" + name + ":\n") + + return result +} + +func (s *IntegrationContext) HasCLI() bool { + return s.B.CLI != nil +} + +func (s *integrationCLIOutput) End() { + if !s.ctx.HasCLI() { + return + } + + s.ctx.B.CLI.Output("\n------------------------------------------------------------------------\n") +} + +func (s *integrationCLIOutput) Output(str string) { + if !s.ctx.HasCLI() { + return + } + s.ctx.B.CLI.Output(s.ctx.B.Colorize().Color(str)) +} + +func (s *integrationCLIOutput) SubOutput(str string) { + if !s.ctx.HasCLI() { + return + } + s.ctx.B.CLI.Output(s.ctx.B.Colorize().Color(fmt.Sprintf("[reset]│ %s", str))) +} + +// Example pending output; the variable spacing (50 chars) allows up to 99 tasks (two digits) in each category: +// --------------- +// 13 tasks still pending, 0 passed, 0 failed ... +// 13 tasks still pending, 0 passed, 0 failed ... (8s elapsed) +// 13 tasks still pending, 0 passed, 0 failed ... (19s elapsed) +// 13 tasks still pending, 0 passed, 0 failed ... (33s elapsed) +func (s *integrationCLIOutput) OutputElapsed(message string, maxMessage int) { + if !s.ctx.HasCLI() { + return + } + elapsed := time.Since(s.ctx.started).Truncate(1 * time.Second) + s.ctx.B.CLI.Output(fmt.Sprintf("%-"+strconv.FormatInt(int64(maxMessage), 10)+"s", message) + s.ctx.B.Colorize().Color(fmt.Sprintf("[dim](%s elapsed)", elapsed))) +} From 2938ec43fa0e6a09d0cf1a80778329f72fc7ca3c Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Wed, 15 Dec 2021 10:02:48 -0700 Subject: [PATCH 604/644] [cloud] handle unreachable run tasks --- internal/cloud/backend_plan.go | 3 ++- internal/cloud/backend_runTasks.go | 36 +++++++++++++------------ internal/cloud/backend_runTasks_test.go | 10 +++++++ 3 files changed, 31 insertions(+), 18 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 2ec1439ea58f..0a7975d64f52 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -351,9 +351,10 @@ in order to capture the filesystem context the remote workspace expects: } } - // Await collective run tasks + // Await pre-apply run tasks if len(r.TaskStage) > 0 { context := NewIntegrationContext(stopCtx, cancelCtx, b, op, r) + // TODO: this only works while there is exactly 1 task stage err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), r.TaskStage[0].ID) if err != nil { diff --git a/internal/cloud/backend_runTasks.go b/internal/cloud/backend_runTasks.go index 8ef8679e40ca..ab00a6aaca09 100644 --- a/internal/cloud/backend_runTasks.go +++ b/internal/cloud/backend_runTasks.go @@ -9,6 +9,7 @@ import ( ) type taskResultSummary struct { + unreachable bool pending int failed int failedMandatory int @@ -17,10 +18,14 @@ type taskResultSummary struct { type taskStageReadFunc func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) -func summarizeTaskResults(taskResults []*tfe.TaskResult) taskResultSummary { +func summarizeTaskResults(taskResults []*tfe.TaskResult) *taskResultSummary { var pe, er, erm, pa int for _, task := range taskResults { - if task.Status == "running" || task.Status == "pending" { + if task.Status == "unreachable" { + return &taskResultSummary{ + unreachable: true, + } + } else if task.Status == "running" || task.Status == "pending" { pe++ } else if task.Status == "passed" { pa++ @@ -33,7 +38,8 @@ func summarizeTaskResults(taskResults []*tfe.TaskResult) taskResultSummary { } } - return taskResultSummary{ + return &taskResultSummary{ + unreachable: false, pending: pe, failed: er, failedMandatory: erm, @@ -41,19 +47,7 @@ func summarizeTaskResults(taskResults []*tfe.TaskResult) taskResultSummary { } } -// elapsedMessageMax is 50 chars: the length of this message with 6 digits -// 99 tasks still pending, 99 passed, 99 failed ... -const elapsedMessageMax int = 50 - func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output IntegrationOutputWriter, fetchTaskStage taskStageReadFunc) error { - // TODO: Do not fetch run tasks if there are no changes to infrastructure - // if !context.Run.HasChanges { - // output.Output("No Changes. Tasks will not run") - // output.End() - - // return nil - // } - return context.Poll(func(i int) (bool, error) { // TODO: get the stage that corresponds to an argument passed to this function stage, err := fetchTaskStage(b, context.StopContext) @@ -63,12 +57,20 @@ func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output Inte } summary := summarizeTaskResults(stage.TaskResults) + + if summary.unreachable { + output.Output("Skipping task results.") + output.End() + return false, nil + } + if summary.pending > 0 { - message := fmt.Sprintf("%d tasks still pending, %d passed, %d failed ... ", summary.pending, summary.passed, summary.failed) + pendingMessage := "%d tasks still pending, %d passed, %d failed ... " + message := fmt.Sprintf(pendingMessage, summary.pending, summary.passed, summary.failed) if i%4 == 0 { if i > 0 { - output.OutputElapsed(message, elapsedMessageMax) + output.OutputElapsed(message, len(pendingMessage)) // Up to 2 digits are allowed by the max message allocation } } return true, nil diff --git a/internal/cloud/backend_runTasks_test.go b/internal/cloud/backend_runTasks_test.go index 9cb133cd5520..d33220446aa3 100644 --- a/internal/cloud/backend_runTasks_test.go +++ b/internal/cloud/backend_runTasks_test.go @@ -118,6 +118,16 @@ func TestCloud_runTasksWithTaskResults(t *testing.T) { expectedOutputs: []string{"Failed (Advisory)", "Overall Result: Passed with advisory failure"}, isError: false, }, + "unreachable": { + taskResults: []*tfe.TaskResult{ + {ID: "1", TaskName: "Mandatory", Message: "", Status: "unreachable", WorkspaceTaskEnforcementLevel: "mandatory"}, + {ID: "2", TaskName: "Advisory", Message: "", Status: "unreachable", WorkspaceTaskEnforcementLevel: "advisory"}, + }, + writer: writer, + context: integrationContext, + expectedOutputs: []string{"Skipping"}, + isError: false, + }, } for caseName, c := range cases { From 6b5da4d43cf4b99f897b31f3c7be1f4556e5d13c Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Wed, 15 Dec 2021 09:09:07 -0800 Subject: [PATCH 605/644] [cloud] run tasks output formatting --- internal/backend/remote/backend_common.go | 2 +- internal/cloud/backend_common.go | 14 +++++++------- internal/cloud/backend_runTasks.go | 6 +++++- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/internal/backend/remote/backend_common.go b/internal/backend/remote/backend_common.go index 07437f3a39a5..dc102f59449f 100644 --- a/internal/backend/remote/backend_common.go +++ b/internal/backend/remote/backend_common.go @@ -299,7 +299,7 @@ func (b *Remote) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Op deltaRepr := strings.Replace(ce.DeltaMonthlyCost, "-", "", 1) if b.CLI != nil { - b.CLI.Output(b.Colorize().Color("[bold]" + msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) b.CLI.Output(b.Colorize().Color(fmt.Sprintf("Resources: %d of %d estimated", ce.MatchedResourcesCount, ce.ResourcesCount))) b.CLI.Output(b.Colorize().Color(fmt.Sprintf(" $%s/mo %s$%s", ce.ProposedMonthlyCost, sign, deltaRepr))) diff --git a/internal/cloud/backend_common.go b/internal/cloud/backend_common.go index 2ca3fc1a2d8d..da4500ec6b11 100644 --- a/internal/cloud/backend_common.go +++ b/internal/cloud/backend_common.go @@ -213,7 +213,7 @@ func (b *Cloud) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Ope return nil } - msgPrefix := "Cost estimation" + msgPrefix := "Cost Estimation" started := time.Now() updated := started for i := 0; ; i++ { @@ -260,7 +260,7 @@ func (b *Cloud) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Ope deltaRepr := strings.Replace(ce.DeltaMonthlyCost, "-", "", 1) if b.CLI != nil { - b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color("[bold]" + msgPrefix + ":\n")) b.CLI.Output(b.Colorize().Color(fmt.Sprintf("Resources: %d of %d estimated", ce.MatchedResourcesCount, ce.ResourcesCount))) b.CLI.Output(b.Colorize().Color(fmt.Sprintf(" $%s/mo %s$%s", ce.ProposedMonthlyCost, sign, deltaRepr))) @@ -282,12 +282,12 @@ func (b *Cloud) costEstimate(stopCtx, cancelCtx context.Context, op *backend.Ope elapsed = fmt.Sprintf( " (%s elapsed)", current.Sub(started).Truncate(30*time.Second)) } - b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color("[bold]" + msgPrefix + ":\n")) b.CLI.Output(b.Colorize().Color("Waiting for cost estimate to complete..." + elapsed + "\n")) } continue case tfe.CostEstimateSkippedDueToTargeting: - b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color("[bold]" + msgPrefix + ":\n")) b.CLI.Output("Not available for this plan, because it was created with the -target option.") b.CLI.Output("\n------------------------------------------------------------------------") return nil @@ -334,15 +334,15 @@ func (b *Cloud) checkPolicy(stopCtx, cancelCtx context.Context, op *backend.Oper var msgPrefix string switch pc.Scope { case tfe.PolicyScopeOrganization: - msgPrefix = "Organization policy check" + msgPrefix = "Organization Policy Check" case tfe.PolicyScopeWorkspace: - msgPrefix = "Workspace policy check" + msgPrefix = "Workspace Policy Check" default: msgPrefix = fmt.Sprintf("Unknown policy check (%s)", pc.Scope) } if b.CLI != nil { - b.CLI.Output(b.Colorize().Color(msgPrefix + ":\n")) + b.CLI.Output(b.Colorize().Color("[bold]" + msgPrefix + ":\n")) } if b.CLI != nil { diff --git a/internal/cloud/backend_runTasks.go b/internal/cloud/backend_runTasks.go index ab00a6aaca09..6c4d4a270c2d 100644 --- a/internal/cloud/backend_runTasks.go +++ b/internal/cloud/backend_runTasks.go @@ -116,7 +116,11 @@ func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output Inte var overall string = "[green]Passed" if firstMandatoryTaskFailed != nil { overall = "[red]Failed" - taskErr = fmt.Errorf("the run failed because the run task, %s, is required to succeed", *firstMandatoryTaskFailed) + if summary.failedMandatory > 1 { + taskErr = fmt.Errorf("the run failed because %d mandatory tasks are required to succeed", summary.failedMandatory) + } else { + taskErr = fmt.Errorf("the run failed because the run task, %s, is required to succeed", *firstMandatoryTaskFailed) + } } else if summary.failed > 0 { // we have failures but none of them mandatory overall = "[green]Passed with advisory failures" } From 791c36c5045940cad626f66dd04a217d2af5ae16 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Wed, 15 Dec 2021 14:43:02 -0700 Subject: [PATCH 606/644] [cloud] report run tasks by name instead of assuming pre_apply --- internal/cloud/backend_plan.go | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 0a7975d64f52..658b0191c483 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -324,7 +324,9 @@ in order to capture the filesystem context the remote workspace expects: } // Retrieve the run to get its current status. - r, err = b.client.Runs.Read(stopCtx, r.ID) + r, err = b.client.Runs.ReadWithOptions(stopCtx, r.ID, &tfe.RunReadOptions{ + Include: "task_stages", + }) if err != nil { return r, generalError("Failed to retrieve run", err) } @@ -354,11 +356,12 @@ in order to capture the filesystem context the remote workspace expects: // Await pre-apply run tasks if len(r.TaskStage) > 0 { context := NewIntegrationContext(stopCtx, cancelCtx, b, op, r) - // TODO: this only works while there is exactly 1 task stage - err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), r.TaskStage[0].ID) - if err != nil { - return r, err + if stageID := getTaskStageIDByName(r.TaskStage, "pre_apply"); stageID != nil { + err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), *stageID) + if err != nil { + return r, err + } } } @@ -370,6 +373,15 @@ func String(v string) *string { return &v } +func getTaskStageIDByName(stages []*tfe.TaskStage, name string) *string { + for _, stage := range stages { + if stage.Stage == name { + return &stage.ID + } + } + return nil +} + const planDefaultHeader = ` [reset][yellow]Running plan in Terraform Cloud. Output will stream here. Pressing Ctrl-C will stop streaming the logs, but will not stop the plan running remotely.[reset] From 0b8bb29a618d247da3f89a271d939753ad4b3ddb Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Wed, 15 Dec 2021 14:55:46 -0700 Subject: [PATCH 607/644] [cloud] refactor integration context and add code documentation --- internal/cloud/backend_plan.go | 8 +++- internal/cloud/backend_runTasks.go | 1 - internal/cloud/backend_runTasks_test.go | 2 +- internal/cloud/cloud_integration.go | 61 ++++++++++++------------- 4 files changed, 36 insertions(+), 36 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 658b0191c483..1d6099378f1c 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -355,7 +355,13 @@ in order to capture the filesystem context the remote workspace expects: // Await pre-apply run tasks if len(r.TaskStage) > 0 { - context := NewIntegrationContext(stopCtx, cancelCtx, b, op, r) + context := &IntegrationContext{ + B: b, + StopContext: stopCtx, + CancelContext: cancelCtx, + Op: op, + Run: r, + } if stageID := getTaskStageIDByName(r.TaskStage, "pre_apply"); stageID != nil { err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), *stageID) diff --git a/internal/cloud/backend_runTasks.go b/internal/cloud/backend_runTasks.go index 6c4d4a270c2d..6b5b0a812673 100644 --- a/internal/cloud/backend_runTasks.go +++ b/internal/cloud/backend_runTasks.go @@ -49,7 +49,6 @@ func summarizeTaskResults(taskResults []*tfe.TaskResult) *taskResultSummary { func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output IntegrationOutputWriter, fetchTaskStage taskStageReadFunc) error { return context.Poll(func(i int) (bool, error) { - // TODO: get the stage that corresponds to an argument passed to this function stage, err := fetchTaskStage(b, context.StopContext) if err != nil { diff --git a/internal/cloud/backend_runTasks_test.go b/internal/cloud/backend_runTasks_test.go index d33220446aa3..0e0bddc202ab 100644 --- a/internal/cloud/backend_runTasks_test.go +++ b/internal/cloud/backend_runTasks_test.go @@ -132,7 +132,7 @@ func TestCloud_runTasksWithTaskResults(t *testing.T) { for caseName, c := range cases { c.writer.output.Reset() - err := b.runTasksWithTaskResults(c.writer.ctx, c.writer, func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) { + err := b.runTasksWithTaskResults(c.context, writer, func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) { return &tfe.TaskStage{ TaskResults: c.taskResults, }, nil diff --git a/internal/cloud/cloud_integration.go b/internal/cloud/cloud_integration.go index 168e1ae2647b..047fc5709396 100644 --- a/internal/cloud/cloud_integration.go +++ b/internal/cloud/cloud_integration.go @@ -8,8 +8,11 @@ import ( "github.com/hashicorp/go-tfe" "github.com/hashicorp/terraform/internal/backend" + "github.com/mitchellh/cli" ) +// IntegrationOutputWriter is an interface used to to write output tailored for +// Terraform Cloud integrations type IntegrationOutputWriter interface { End() OutputElapsed(message string, maxMessage int) @@ -17,8 +20,8 @@ type IntegrationOutputWriter interface { SubOutput(str string) } +// IntegrationContext is a set of data that is useful when performing Terraform Cloud integration operations type IntegrationContext struct { - started time.Time B *Cloud StopContext context.Context CancelContext context.Context @@ -26,22 +29,15 @@ type IntegrationContext struct { Run *tfe.Run } +// integrationCLIOutput implements IntegrationOutputWriter type integrationCLIOutput struct { - ctx *IntegrationContext + CLI cli.Ui + Colorizer Colorer + started time.Time } var _ IntegrationOutputWriter = (*integrationCLIOutput)(nil) // Compile time check -func NewIntegrationContext(stopCtx, cancelCtx context.Context, b *Cloud, op *backend.Operation, r *tfe.Run) *IntegrationContext { - return &IntegrationContext{ - B: b, - StopContext: stopCtx, - CancelContext: cancelCtx, - Op: op, - Run: r, - } -} - func (s *IntegrationContext) Poll(every func(i int) (bool, error)) error { for i := 0; ; i++ { select { @@ -60,48 +56,47 @@ func (s *IntegrationContext) Poll(every func(i int) (bool, error)) error { } } +// BeginOutput writes a preamble to the CLI and creates a new IntegrationOutputWriter interface +// to write the remaining CLI output to. Use IntegrationOutputWriter.End() to complete integration +// output func (s *IntegrationContext) BeginOutput(name string) IntegrationOutputWriter { var result IntegrationOutputWriter = &integrationCLIOutput{ - ctx: s, - } - - s.started = time.Now() - - if s.HasCLI() { - s.B.CLI.Output("\n------------------------------------------------------------------------\n") + CLI: s.B.CLI, + Colorizer: s.B.Colorize(), + started: time.Now(), } - result.Output("[bold]" + name + ":\n") + result.Output("\n[bold]" + name + ":\n") return result } -func (s *IntegrationContext) HasCLI() bool { - return s.B.CLI != nil -} - +// End writes the termination output for the integration func (s *integrationCLIOutput) End() { - if !s.ctx.HasCLI() { + if s.CLI == nil { return } - s.ctx.B.CLI.Output("\n------------------------------------------------------------------------\n") + s.CLI.Output("\n------------------------------------------------------------------------\n") } +// Output writes a string after colorizing it using any [colorstrings](https://github.com/mitchellh/colorstring) it contains func (s *integrationCLIOutput) Output(str string) { - if !s.ctx.HasCLI() { + if s.CLI == nil { return } - s.ctx.B.CLI.Output(s.ctx.B.Colorize().Color(str)) + s.CLI.Output(s.Colorizer.Color(str)) } +// SubOutput writes a string prefixed by a "│ " after colorizing it using any [colorstrings](https://github.com/mitchellh/colorstring) it contains func (s *integrationCLIOutput) SubOutput(str string) { - if !s.ctx.HasCLI() { + if s.CLI == nil { return } - s.ctx.B.CLI.Output(s.ctx.B.Colorize().Color(fmt.Sprintf("[reset]│ %s", str))) + s.CLI.Output(s.Colorizer.Color(fmt.Sprintf("[reset]│ %s", str))) } +// OutputElapsed writes a string followed by the amount of time that has elapsed since calling BeginOutput. // Example pending output; the variable spacing (50 chars) allows up to 99 tasks (two digits) in each category: // --------------- // 13 tasks still pending, 0 passed, 0 failed ... @@ -109,9 +104,9 @@ func (s *integrationCLIOutput) SubOutput(str string) { // 13 tasks still pending, 0 passed, 0 failed ... (19s elapsed) // 13 tasks still pending, 0 passed, 0 failed ... (33s elapsed) func (s *integrationCLIOutput) OutputElapsed(message string, maxMessage int) { - if !s.ctx.HasCLI() { + if s.CLI == nil { return } - elapsed := time.Since(s.ctx.started).Truncate(1 * time.Second) - s.ctx.B.CLI.Output(fmt.Sprintf("%-"+strconv.FormatInt(int64(maxMessage), 10)+"s", message) + s.ctx.B.Colorize().Color(fmt.Sprintf("[dim](%s elapsed)", elapsed))) + elapsed := time.Since(s.started).Truncate(1 * time.Second) + s.CLI.Output(fmt.Sprintf("%-"+strconv.FormatInt(int64(maxMessage), 10)+"s", message) + s.Colorizer.Color(fmt.Sprintf("[dim](%s elapsed)", elapsed))) } From 8090b23db7565a89d82daa1d9e3e7eeb53dacf49 Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Wed, 15 Dec 2021 14:22:32 -0800 Subject: [PATCH 608/644] delete unused function --- internal/cloud/backend_plan.go | 5 ----- 1 file changed, 5 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 1d6099378f1c..5f70934bf053 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -374,11 +374,6 @@ in order to capture the filesystem context the remote workspace expects: return r, nil } -// String returns a pointer to the given string. -func String(v string) *string { - return &v -} - func getTaskStageIDByName(stages []*tfe.TaskStage, name string) *string { for _, stage := range stages { if stage.Stage == name { From 77946af4720caeea85397fc787ecc17e6b77b683 Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Wed, 15 Dec 2021 14:53:31 -0800 Subject: [PATCH 609/644] pull latest changes from go-tfe branch and use use new field name that previously was incorrectly named TaskStage --- go.sum | 2 ++ internal/cloud/backend_plan.go | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/go.sum b/go.sum index e8ef3c7f2ef2..88a064562e5c 100644 --- a/go.sum +++ b/go.sum @@ -409,6 +409,8 @@ github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerX github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= github.com/hashicorp/go-tfe v0.20.1-0.20211210153426-243d1b1eb033 h1:SoQhT2l6xHh7LOprw1F6MPzxSk65kSXdyfubOs8D+Ho= github.com/hashicorp/go-tfe v0.20.1-0.20211210153426-243d1b1eb033/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c h1:S35GDGdpbcmTFDZj+JQDO84CANiYdUMs++JxBXwJyvU= +github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 5f70934bf053..a0ae59d2c2e4 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -354,7 +354,7 @@ in order to capture the filesystem context the remote workspace expects: } // Await pre-apply run tasks - if len(r.TaskStage) > 0 { + if len(r.TaskStages) > 0 { context := &IntegrationContext{ B: b, StopContext: stopCtx, @@ -363,7 +363,7 @@ in order to capture the filesystem context the remote workspace expects: Run: r, } - if stageID := getTaskStageIDByName(r.TaskStage, "pre_apply"); stageID != nil { + if stageID := getTaskStageIDByName(r.TaskStages, "pre_apply"); stageID != nil { err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), *stageID) if err != nil { return r, err From 385589e1a4fb07ff80f790a1656cf56531482aad Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Wed, 15 Dec 2021 14:54:02 -0800 Subject: [PATCH 610/644] run go mod tidy --- go.sum | 2 -- 1 file changed, 2 deletions(-) diff --git a/go.sum b/go.sum index 88a064562e5c..cdb215df8d6c 100644 --- a/go.sum +++ b/go.sum @@ -407,8 +407,6 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.20.1-0.20211210153426-243d1b1eb033 h1:SoQhT2l6xHh7LOprw1F6MPzxSk65kSXdyfubOs8D+Ho= -github.com/hashicorp/go-tfe v0.20.1-0.20211210153426-243d1b1eb033/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c h1:S35GDGdpbcmTFDZj+JQDO84CANiYdUMs++JxBXwJyvU= github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= From a9da859ee5d8cc1dcb919779546040060d9d8876 Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Tue, 4 Jan 2022 16:39:43 -0500 Subject: [PATCH 611/644] rename variables to something more descriptive --- internal/cloud/backend_runTasks.go | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/internal/cloud/backend_runTasks.go b/internal/cloud/backend_runTasks.go index 6b5b0a812673..890bf9231d0a 100644 --- a/internal/cloud/backend_runTasks.go +++ b/internal/cloud/backend_runTasks.go @@ -19,31 +19,31 @@ type taskResultSummary struct { type taskStageReadFunc func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) func summarizeTaskResults(taskResults []*tfe.TaskResult) *taskResultSummary { - var pe, er, erm, pa int + var pendingCount, errCount, errMandatoryCount, passedCount int for _, task := range taskResults { if task.Status == "unreachable" { return &taskResultSummary{ unreachable: true, } - } else if task.Status == "running" || task.Status == "pending" { - pe++ + } else if task.Status == "running" || task.Status == "pendingCountnding" { + pendingCount++ } else if task.Status == "passed" { - pa++ + passedCount++ } else { // Everything else is a failure - er++ + errCount++ if task.WorkspaceTaskEnforcementLevel == "mandatory" { - erm++ + errMandatoryCount++ } } } return &taskResultSummary{ unreachable: false, - pending: pe, - failed: er, - failedMandatory: erm, - passed: pa, + pending: pendingCount, + failed: errCount, + failedMandatory: errMandatoryCount, + passed: passedCount, } } From 46aaaa0a959fb3e9ca83d40b8440e9320a1c048f Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Tue, 4 Jan 2022 16:43:05 -0500 Subject: [PATCH 612/644] run go mod tidy --- go.mod | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/go.mod b/go.mod index 8b780419bdb3..3a4c80264843 100644 --- a/go.mod +++ b/go.mod @@ -41,8 +41,12 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 +<<<<<<< HEAD github.com/hashicorp/go-tfe v0.21.0 github.com/hashicorp/go-safetemp v1.0.0 +======= + github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c +>>>>>>> fd151e0fc (run go mod tidy) github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f From 391b9c497c29d6c9c020f6da56ff8dd9b5d4ec74 Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Thu, 6 Jan 2022 09:28:29 -0700 Subject: [PATCH 613/644] update go-tfe go-tfe is pinned to branch run-tasks-integration pending API changes until run tasks support in the CLI is closer to release --- go.mod | 7 +------ go.sum | 4 ++-- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/go.mod b/go.mod index 3a4c80264843..9e9dc9b15a67 100644 --- a/go.mod +++ b/go.mod @@ -41,12 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 -<<<<<<< HEAD - github.com/hashicorp/go-tfe v0.21.0 - github.com/hashicorp/go-safetemp v1.0.0 -======= - github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c ->>>>>>> fd151e0fc (run go mod tidy) + github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index cdb215df8d6c..5bebf9ac66e4 100644 --- a/go.sum +++ b/go.sum @@ -407,8 +407,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c h1:S35GDGdpbcmTFDZj+JQDO84CANiYdUMs++JxBXwJyvU= -github.com/hashicorp/go-tfe v0.20.1-0.20211215223223-3057a43c4f5c/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193 h1:qS5VXxtPFVbghgCjs8nLv54MNaUOPMWU9ZKKGNfhKwM= +github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= From aa0dda81b4e4d765e78fcc337777b31387a5571e Mon Sep 17 00:00:00 2001 From: Brandon Croft Date: Fri, 7 Jan 2022 06:59:20 -0700 Subject: [PATCH 614/644] Fall back to reading latest run without task_stages Older versions of TFE will not allow "task_stages" as an include parameter. In this case, fall back to reading the Run without additional options. --- internal/cloud/backend_plan.go | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index a0ae59d2c2e4..ad24f85254f8 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -324,11 +324,20 @@ in order to capture the filesystem context the remote workspace expects: } // Retrieve the run to get its current status. - r, err = b.client.Runs.ReadWithOptions(stopCtx, r.ID, &tfe.RunReadOptions{ + runID := r.ID + r, err = b.client.Runs.ReadWithOptions(stopCtx, runID, &tfe.RunReadOptions{ Include: "task_stages", }) if err != nil { - return r, generalError("Failed to retrieve run", err) + // This error would be expected for older versions of TFE that do not allow + // fetching task_stages. + if strings.HasSuffix(err.Error(), "Invalid include parameter") { + r, err = b.client.Runs.Read(stopCtx, runID) + } + + if err != nil { + return r, generalError("Failed to retrieve run", err) + } } // If the run is canceled or errored, we still continue to the @@ -355,7 +364,7 @@ in order to capture the filesystem context the remote workspace expects: // Await pre-apply run tasks if len(r.TaskStages) > 0 { - context := &IntegrationContext{ + integration := &IntegrationContext{ B: b, StopContext: stopCtx, CancelContext: cancelCtx, @@ -364,7 +373,7 @@ in order to capture the filesystem context the remote workspace expects: } if stageID := getTaskStageIDByName(r.TaskStages, "pre_apply"); stageID != nil { - err = b.runTasks(context, context.BeginOutput("Run Tasks (pre-apply)"), *stageID) + err = b.runTasks(integration, integration.BeginOutput("Run Tasks (pre-apply)"), *stageID) if err != nil { return r, err } From e46683d2c7e82042d1a5f1b4c36e461dc08aa16c Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Thu, 13 Jan 2022 16:35:04 -0500 Subject: [PATCH 615/644] pull latest changes from go-tfe run-tasks-integration branch --- go.mod | 2 +- go.sum | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/go.mod b/go.mod index 9e9dc9b15a67..5e5cbda64263 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193 + github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f diff --git a/go.sum b/go.sum index 5bebf9ac66e4..12f0cb7f920e 100644 --- a/go.sum +++ b/go.sum @@ -409,6 +409,8 @@ github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerX github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193 h1:qS5VXxtPFVbghgCjs8nLv54MNaUOPMWU9ZKKGNfhKwM= github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa h1:F3tr6mgTq2WooNQ48OkRDPn6pM8VJMlj/UEvUblacc8= +github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= From 383da4893bd161e3f3e4578d688e63dfaa14a39b Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Thu, 13 Jan 2022 16:37:29 -0500 Subject: [PATCH 616/644] use new enum string for task stages --- internal/cloud/backend_plan.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index ad24f85254f8..32b35a413c75 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -372,7 +372,7 @@ in order to capture the filesystem context the remote workspace expects: Run: r, } - if stageID := getTaskStageIDByName(r.TaskStages, "pre_apply"); stageID != nil { + if stageID := getTaskStageIDByName(r.TaskStages, tfe.PreApply); stageID != nil { err = b.runTasks(integration, integration.BeginOutput("Run Tasks (pre-apply)"), *stageID) if err != nil { return r, err @@ -383,9 +383,9 @@ in order to capture the filesystem context the remote workspace expects: return r, nil } -func getTaskStageIDByName(stages []*tfe.TaskStage, name string) *string { +func getTaskStageIDByName(stages []*tfe.TaskStage, stageName tfe.Stage) *string { for _, stage := range stages { - if stage.Stage == name { + if stage.Stage == stageName { return &stage.ID } } From 542e3f901db4dee959336db4d5913efb0762e756 Mon Sep 17 00:00:00 2001 From: uturunku1 Date: Thu, 13 Jan 2022 16:38:25 -0500 Subject: [PATCH 617/644] run go mod tidy --- go.sum | 2 -- 1 file changed, 2 deletions(-) diff --git a/go.sum b/go.sum index 12f0cb7f920e..d1ca3d91e276 100644 --- a/go.sum +++ b/go.sum @@ -407,8 +407,6 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193 h1:qS5VXxtPFVbghgCjs8nLv54MNaUOPMWU9ZKKGNfhKwM= -github.com/hashicorp/go-tfe v0.22.1-0.20220106162344-481afccea193/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa h1:F3tr6mgTq2WooNQ48OkRDPn6pM8VJMlj/UEvUblacc8= github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= From 126d6df08846463200d2895a980861aa2676073f Mon Sep 17 00:00:00 2001 From: Sebastian Rivera Date: Tue, 1 Feb 2022 16:41:29 -0500 Subject: [PATCH 618/644] Added run task support for post plan run stage, removed pre apply This commit stems from the change to make post plan the default run task stage, at the time of this commit's writing! Since pre apply is under internal revision, we have removed the block that polls the pre apply stage until the team decides to re-add support for pre apply run tasks. --- internal/cloud/backend_plan.go | 38 ++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/internal/cloud/backend_plan.go b/internal/cloud/backend_plan.go index 32b35a413c75..206093c40712 100644 --- a/internal/cloud/backend_plan.go +++ b/internal/cloud/backend_plan.go @@ -346,6 +346,22 @@ in order to capture the filesystem context the remote workspace expects: // status of the run will be "errored", but there is still policy // information which should be shown. + // Await post-plan run tasks + integration := &IntegrationContext{ + B: b, + StopContext: stopCtx, + CancelContext: cancelCtx, + Op: op, + Run: r, + } + + if stageID := getTaskStageIDByName(r.TaskStages, tfe.PostPlan); stageID != nil { + err = b.runTasks(integration, integration.BeginOutput("Run Tasks (post-plan)"), *stageID) + if err != nil { + return r, err + } + } + // Show any cost estimation output. if r.CostEstimate != nil { err = b.costEstimate(stopCtx, cancelCtx, op, r) @@ -362,28 +378,14 @@ in order to capture the filesystem context the remote workspace expects: } } - // Await pre-apply run tasks - if len(r.TaskStages) > 0 { - integration := &IntegrationContext{ - B: b, - StopContext: stopCtx, - CancelContext: cancelCtx, - Op: op, - Run: r, - } - - if stageID := getTaskStageIDByName(r.TaskStages, tfe.PreApply); stageID != nil { - err = b.runTasks(integration, integration.BeginOutput("Run Tasks (pre-apply)"), *stageID) - if err != nil { - return r, err - } - } - } - return r, nil } func getTaskStageIDByName(stages []*tfe.TaskStage, stageName tfe.Stage) *string { + if len(stages) == 0 { + return nil + } + for _, stage := range stages { if stage.Stage == stageName { return &stage.ID From ad1ba5ef125f72135c4b8ba964ca71e4df1dd810 Mon Sep 17 00:00:00 2001 From: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> Date: Thu, 24 Feb 2022 18:15:05 -0500 Subject: [PATCH 619/644] fix broken link on provisioners connection page --- website/docs/language/resources/provisioners/connection.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 987ac7892f1f..8821599619d5 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -110,7 +110,7 @@ indirectly with a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). | `bastion_port` | The port to use connect to the bastion host. | The value of the `port` field.| | `bastion_user`| The user for the connection to the bastion host. | The value of the `user` field. | | `bastion_password` | The password to use for the bastion host. | The value of the `password` field. | -| `bastion_private_key` | The contents of an SSH key file to use for the bastion host. These can be loaded from a file on disk using [the `file` function](language/functions/file). | The value of the `private_key` field. | +| `bastion_private_key` | The contents of an SSH key file to use for the bastion host. These can be loaded from a file on disk using [the `file` function](/language/functions/file). | The value of the `private_key` field. | | `bastion_certificate` | The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a `bastion_private_key`. These can be loaded from a file on disk using the [the `file` function](/language/functions/file). | ## How Provisioners Execute Remote Scripts From 52c5f9f6b7a1399d917081222fdf1b8c13d739fe Mon Sep 17 00:00:00 2001 From: Sebastian Rivera Date: Fri, 25 Feb 2022 15:32:16 -0500 Subject: [PATCH 620/644] Updated for latest go-tfe run task changes --- go.mod | 45 ++++----- go.sum | 144 ++++++++++++++++++----------- internal/cloud/backend_runTasks.go | 2 +- 3 files changed, 113 insertions(+), 78 deletions(-) diff --git a/go.mod b/go.mod index 5e5cbda64263..99130b0e4bf2 100644 --- a/go.mod +++ b/go.mod @@ -41,7 +41,7 @@ require ( github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-plugin v1.4.3 github.com/hashicorp/go-retryablehttp v0.7.0 - github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa + github.com/hashicorp/go-tfe v0.26.0 github.com/hashicorp/go-uuid v1.0.2 github.com/hashicorp/go-version v1.3.0 github.com/hashicorp/hcl v0.0.0-20170504190234-a4b07c25de5f @@ -85,24 +85,24 @@ require ( golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa golang.org/x/mod v0.4.2 golang.org/x/net v0.0.0-20211216030914-fe4d6282115f - golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c - golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e - golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d - golang.org/x/text v0.3.6 + golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f + golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e + golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b + golang.org/x/text v0.3.7 golang.org/x/tools v0.1.7 google.golang.org/api v0.44.0-impersonate-preview - google.golang.org/grpc v1.36.0 + google.golang.org/grpc v1.36.1 google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 google.golang.org/protobuf v1.27.1 honnef.co/go/tools v0.3.0-0.dev - k8s.io/api v0.21.3 - k8s.io/apimachinery v0.21.3 - k8s.io/client-go v0.21.3 - k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b + k8s.io/api v0.23.4 + k8s.io/apimachinery v0.23.4 + k8s.io/client-go v0.23.4 + k8s.io/utils v0.0.0-20211116205334-6203023598ed ) require ( - cloud.google.com/go v0.79.0 // indirect + cloud.google.com/go v0.81.0 // indirect github.com/Azure/go-autorest v14.2.0+incompatible // indirect github.com/Azure/go-autorest/autorest/adal v0.9.17 // indirect github.com/Azure/go-autorest/autorest/azure/cli v0.4.4 // indirect @@ -131,15 +131,15 @@ require ( github.com/dimchansky/utfbom v1.1.1 // indirect github.com/dylanmei/iso8601 v0.1.0 // indirect github.com/fatih/color v1.9.0 // indirect - github.com/go-logr/logr v0.4.0 // indirect + github.com/go-logr/logr v1.2.0 // indirect github.com/gofrs/uuid v3.3.0+incompatible // indirect github.com/gogo/protobuf v1.3.2 // indirect github.com/golang-jwt/jwt/v4 v4.1.0 // indirect - github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect + github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect github.com/google/go-querystring v1.1.0 // indirect github.com/google/gofuzz v1.1.0 // indirect github.com/googleapis/gax-go/v2 v2.0.5 // indirect - github.com/googleapis/gnostic v0.4.1 // indirect + github.com/googleapis/gnostic v0.5.5 // indirect github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 // indirect github.com/hashicorp/go-immutable-radix v1.0.0 // indirect github.com/hashicorp/go-msgpack v0.5.4 // indirect @@ -152,7 +152,7 @@ require ( github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect github.com/huandu/xstrings v1.3.2 // indirect github.com/imdario/mergo v0.3.12 // indirect - github.com/json-iterator/go v1.1.10 // indirect + github.com/json-iterator/go v1.1.12 // indirect github.com/jstemmer/go-junit-report v0.9.1 // indirect github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect @@ -163,7 +163,7 @@ require ( github.com/mitchellh/go-testing-interface v1.0.4 // indirect github.com/mitchellh/iochan v1.0.0 // indirect github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect - github.com/modern-go/reflect2 v1.0.1 // indirect + github.com/modern-go/reflect2 v1.0.2 // indirect github.com/mozillazg/go-httpheader v0.3.0 // indirect github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d // indirect github.com/oklog/run v1.0.0 // indirect @@ -180,20 +180,23 @@ require ( go.uber.org/multierr v1.1.0 // indirect go.uber.org/zap v1.10.0 // indirect golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5 // indirect - golang.org/x/time v0.0.0-20211116232009-f0f3c7e86c11 // indirect + golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 // indirect golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect google.golang.org/appengine v1.6.7 // indirect - google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 // indirect + google.golang.org/genproto v0.0.0-20210402141018-6c239bbf2bb1 // indirect gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect gopkg.in/inf.v0 v0.9.1 // indirect gopkg.in/ini.v1 v1.42.0 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect - k8s.io/klog/v2 v2.8.0 // indirect - sigs.k8s.io/structured-merge-diff/v4 v4.1.2 // indirect + gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect + k8s.io/klog/v2 v2.30.0 // indirect + k8s.io/kube-openapi v0.0.0-20211115234752-e816edb12b65 // indirect + sigs.k8s.io/json v0.0.0-20211020170558-c049b76a60c6 // indirect + sigs.k8s.io/structured-merge-diff/v4 v4.2.1 // indirect sigs.k8s.io/yaml v1.2.0 // indirect ) -replace google.golang.org/grpc v1.36.0 => google.golang.org/grpc v1.27.1 +replace google.golang.org/grpc v1.36.1 => google.golang.org/grpc v1.27.1 replace github.com/golang/mock v1.5.0 => github.com/golang/mock v1.4.4 diff --git a/go.sum b/go.sum index d1ca3d91e276..389fea0223c3 100644 --- a/go.sum +++ b/go.sum @@ -17,8 +17,9 @@ cloud.google.com/go v0.65.0/go.mod h1:O5N8zS7uWy9vkA9vayVHs65eM1ubvY4h553ofrNHOb cloud.google.com/go v0.72.0/go.mod h1:M+5Vjvlc2wnp6tjzE102Dw08nGShTscUx2nZMufOKPI= cloud.google.com/go v0.74.0/go.mod h1:VV1xSbzvo+9QJOxLDaJfTjx5e+MePCpCWwvftOeQmWk= cloud.google.com/go v0.78.0/go.mod h1:QjdrLG0uq+YwhjoVOLsS1t7TW8fs36kLs4XO5R5ECHg= -cloud.google.com/go v0.79.0 h1:oqqswrt4x6b9OGBnNqdssxBl1xf0rSUNjU2BR4BZar0= cloud.google.com/go v0.79.0/go.mod h1:3bzgcEeQlzbuEAYu4mrWhKqWjmpprinYgKJLgKHnbb8= +cloud.google.com/go v0.81.0 h1:at8Tk2zUz63cLPR0JPWm5vp77pEZmzxEQBEfRKn1VV8= +cloud.google.com/go v0.81.0/go.mod h1:mk/AM35KwGk/Nm2YSeZbxXdrNK3KZOYHmLkOqC2V6E0= cloud.google.com/go/bigquery v1.0.1/go.mod h1:i/xbL2UlR5RvWAURpBYZTtm/cXjCha9lbfbpx4poX+o= cloud.google.com/go/bigquery v1.3.0/go.mod h1:PjpwJnslEMmckchkHFfq+HTD2DmtT67aNFKH1/VBDHE= cloud.google.com/go/bigquery v1.4.0/go.mod h1:S8dzgnTigyfTmLBfrtrhyYhwRxG72rYxvftPBK2Dvzc= @@ -46,12 +47,13 @@ github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= github.com/Azure/go-autorest/autorest v0.11.3/go.mod h1:JFgpikqFJ/MleTTxwepExTKnFUKKszPS8UavbQYUMuw= github.com/Azure/go-autorest/autorest v0.11.10/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= -github.com/Azure/go-autorest/autorest v0.11.12/go.mod h1:eipySxLmqSyC5s5k1CLupqet0PSENBEDP93LQ9a8QYw= +github.com/Azure/go-autorest/autorest v0.11.18/go.mod h1:dSiJPy22c3u0OtOKDNttNgqpNFY/GeWa7GH/Pz56QRA= github.com/Azure/go-autorest/autorest v0.11.21/go.mod h1:Do/yuMSW/13ayUkcVREpsMHGG+MvV81uzSCFgYPj4tM= github.com/Azure/go-autorest/autorest v0.11.22 h1:bXiQwDjrRmBQOE67bwlvUKAC1EU1yZTPQ38c+bstZws= github.com/Azure/go-autorest/autorest v0.11.22/go.mod h1:BAWYUWGPEtKPzjVkp0Q6an0MJcJDsoh5Z1BFAEFs4Xs= github.com/Azure/go-autorest/autorest/adal v0.9.0/go.mod h1:/c022QCutn2P7uY+/oQWWNcK9YU+MH96NgK+jErpbcg= github.com/Azure/go-autorest/autorest/adal v0.9.5/go.mod h1:B7KF7jKIeC9Mct5spmyCB/A8CG/sEz1vwIRGv/bbw7A= +github.com/Azure/go-autorest/autorest/adal v0.9.13/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= github.com/Azure/go-autorest/autorest/adal v0.9.14/go.mod h1:W/MM4U6nLxnIskrw4UwWzlHfGjwUS50aOsc/I3yuU8M= github.com/Azure/go-autorest/autorest/adal v0.9.17 h1:esOPl2dhcz9P3jqBSJ8tPGEj2EqzPPT6zfyuloiogKY= github.com/Azure/go-autorest/autorest/adal v0.9.17/go.mod h1:XVVeme+LZwABT8K5Lc3hA4nAe8LDBVle26gTrguhhPQ= @@ -210,13 +212,17 @@ github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1m github.com/envoyproxy/go-control-plane v0.9.7/go.mod h1:cwu0lG7PUMfa9snN8LXBig5ynNVH9qI8YYLbd1fK2po= github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk= github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c= -github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= +github.com/evanphx/json-patch v4.12.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk= github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s= github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU= github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc= github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= +github.com/form3tech-oss/jwt-go v3.2.3+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4= +github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ= +github.com/getkin/kin-openapi v0.76.0/go.mod h1:660oXbgy5JFMKreazJaQTw7o+X00qeSyhcnluiMv+Xg= github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0= github.com/go-git/gcfg v1.5.0/go.mod h1:5m20vg6GwYabIxaOonVkTdrILxQMpEShl1xiMF4ua+E= @@ -230,14 +236,12 @@ github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2 github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= github.com/go-logr/logr v0.1.0/go.mod h1:ixOQHD9gLJUVQQ2ZOR7zLEifBX6tGkNJF4QyIY7sIas= -github.com/go-logr/logr v0.4.0 h1:K7/B1jt6fIBQVd4Owv2MqGQClcgf0R266+7C/QjRcLc= -github.com/go-logr/logr v0.4.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU= -github.com/go-openapi/jsonpointer v0.19.2/go.mod h1:3akKfEdA7DF1sugOqz1dVQHBcuDBPKZGEoHC/NkiQRg= +github.com/go-logr/logr v0.2.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU= +github.com/go-logr/logr v1.2.0 h1:QK40JKJyMdUDz+h+xvCsru/bJhvG0UxvePV0ufL/AcE= +github.com/go-logr/logr v1.2.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= -github.com/go-openapi/jsonreference v0.19.2/go.mod h1:jMjeRr2HHw6nAVajTXJ4eiUwohSTlpa0o73RUL1owJc= +github.com/go-openapi/jsonpointer v0.19.5/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= github.com/go-openapi/jsonreference v0.19.3/go.mod h1:rjx6GuL8TTa9VaixXglHmQmIL98+wF9xc8zWvFonSJ8= -github.com/go-openapi/spec v0.19.3/go.mod h1:FpwSN1ksY1eteniUU7X0N/BgJ7a4WvBFVA8Lj9mJglo= -github.com/go-openapi/swag v0.19.2/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= @@ -261,8 +265,9 @@ github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfU github.com/golang/groupcache v0.0.0-20160516000752-02826c3e7903/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20190702054246-869f871628b6/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/groupcache v0.0.0-20191227052852-215e87163ea7/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= -github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e h1:1r7pUrabqp18hOBcwBwiTsbnFeTZHV9eER/QT5JVZxY= github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y= @@ -288,11 +293,13 @@ github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QD github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/golang/protobuf v1.4.3/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= +github.com/golang/protobuf v1.5.1/go.mod h1:DopwsBzvsk0Fs44TXzsVbJyPhcCPeIwnvohx4u74HPM= github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= -github.com/google/btree v1.0.0 h1:0udJVsspx3VBr5FwtLhQQtuAsVc79tTq0ocGIPAU6qo= github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= +github.com/google/btree v1.0.1 h1:gK4Kx5IaGY9CD5sPJ36FHiBJ6ZXl0kilRiiCj+jdYp4= +github.com/google/btree v1.0.1/go.mod h1:xXMiIv4Fb/0kKde4SpL7qlzvu5cMJDRkFDxJfI9uaxA= github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= @@ -337,8 +344,9 @@ github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+ github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= github.com/googleapis/gax-go/v2 v2.0.5 h1:sjZBwGj9Jlw33ImPtvFviGYvseOtDM7hkSKB7+Tv3SM= github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= -github.com/googleapis/gnostic v0.4.1 h1:DLJCy1n/vrD4HPjOvYcT8aYQXpPIzoRZONaYwyycI+I= -github.com/googleapis/gnostic v0.4.1/go.mod h1:LRhVm6pbyptWbWbuZ38d1eyptfvIytN3ir6b65WBswg= +github.com/googleapis/gnostic v0.5.1/go.mod h1:6U4PtQXGIEt/Z3h5MAT7FNofLnw9vXk2cUuW7uA/OeU= +github.com/googleapis/gnostic v0.5.5 h1:9fHAtK0uDfpveeqqo1hkEZJcFvYXAiCN3UutL8F9xHw= +github.com/googleapis/gnostic v0.5.5/go.mod h1:7+EbHbldMins07ALC74bsA81Ovc97DwqyJO1AENw9kA= github.com/gophercloud/gophercloud v0.6.1-0.20191122030953-d8ac278c1c9d/go.mod h1:ozGNgr9KYOVATV5jsgHl/ceCDXGuguqOZAzoQ/2vcNM= github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 h1:Ciwp7ro4LyptUOkili/TX/ecuYr7vGtEIFnOOOKUjD8= github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5/go.mod h1:gmC5oQqMDOMO1t1gq5DquX/yAU808e/4mzjjDA76+Ss= @@ -346,6 +354,7 @@ github.com/gophercloud/utils v0.0.0-20200423144003-7c72efc7435d h1:fduaPzWwIfvOM github.com/gophercloud/utils v0.0.0-20200423144003-7c72efc7435d/go.mod h1:ehWUbLQJPqS0Ep+CxeD559hsm9pthPXadJNKwZkp43w= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= +github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7/go.mod h1:FecbI9+v66THATjSRHfNgh1IVFe/9kFxbXtjV0ctIMA= @@ -407,8 +416,8 @@ github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41 github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= -github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa h1:F3tr6mgTq2WooNQ48OkRDPn6pM8VJMlj/UEvUblacc8= -github.com/hashicorp/go-tfe v0.22.1-0.20220112184200-c36b8c8fd7aa/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= +github.com/hashicorp/go-tfe v0.26.0 h1:6vQshg2NW5CkN4fkM64qhX+Z5Ua7ip74n8nAJRlhKKg= +github.com/hashicorp/go-tfe v0.26.0/go.mod h1:gyXLXbpBVxA2F/6opah8XBsOkZJxHYQmghl0OWi8keI= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.1/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.2 h1:cfejS+Tpcp13yd5nYHWDI6qVCny6wyX2Mt5SGur2IGE= @@ -473,8 +482,8 @@ github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926 h1:kie3qOosvRKqwi github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926/go.mod h1:U+RSyWxWd04xTqnuOQxnai7XGS2PrPY2cfGoDKtMHjA= github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= -github.com/json-iterator/go v1.1.10 h1:Kz6Cvnvv2wGdaG/V8yMvfkmNiXq9Ya2KUv4rouJJr68= -github.com/json-iterator/go v1.1.10/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= github.com/jstemmer/go-junit-report v0.9.1 h1:6QPYqodiu3GuPL+7mfx+NwDdp2eTkp9IfEUpgAwUN0o= github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= @@ -574,8 +583,9 @@ github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJ github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= -github.com/modern-go/reflect2 v1.0.1 h1:9f412s+6RmYXLWZSEzVVgPGK7C2PphHj5RJrvfx9AWI= github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= github.com/mozillazg/go-httpheader v0.2.1/go.mod h1:jJ8xECTlalr6ValeXYdOF8fFUISeBAdw6E61aqQma60= github.com/mozillazg/go-httpheader v0.3.0 h1:3brX5z8HTH+0RrNA1362Rc3HsaxyWEKtGY45YrhuINM= github.com/mozillazg/go-httpheader v0.3.0/go.mod h1:PuT8h0pw6efvp8ZeUec1Rs7dwjK08bt6gKSReGMqtdA= @@ -588,14 +598,20 @@ github.com/nishanths/exhaustive v0.2.3/go.mod h1:bhIX678Nx8inLM9PbpvK1yv6oGtoP8B github.com/nsf/jsondiff v0.0.0-20200515183724-f29ed568f4ce/go.mod h1:uFMI8w+ref4v2r9jz+c9i1IfIttS/OkmLfrk1jne5hs= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d h1:VhgPp6v9qf9Agr/56bj7Y/xa04UccTW04VP0Qed4vnQ= github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d/go.mod h1:YUTz3bUH2ZwIWBy3CJBeOBEugqcmXREj14T+iG/4k4U= +github.com/nxadm/tail v1.4.4 h1:DQuhQpB1tVlglWS2hLQ5OV6B5r8aGxSrPc5Qo6uTN78= +github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A= github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw= github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA= github.com/olekukonko/tablewriter v0.0.0-20170122224234-a0225b3f23b5/go.mod h1:vsDQFd/mU46D+Z4whnwzcISnGGzXWMclvtLoiIKAKIo= github.com/onsi/ginkgo v0.0.0-20170829012221-11459a886d9c/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= -github.com/onsi/ginkgo v1.11.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk= +github.com/onsi/ginkgo v1.14.0 h1:2mOpI4JVVPBN+WQRa0WKH2eXR+Ey+uK4n7Zj0aYpIQA= +github.com/onsi/ginkgo v1.14.0/go.mod h1:iSB4RoI2tjJc9BBv4NKIKWKya62Rps+oPG/Lv9klQyY= github.com/onsi/gomega v0.0.0-20170829124025-dcabb60a477c/go.mod h1:C1qb7wdrVGGVU+Z6iS04AVkA3Q65CEZX59MT0QO5uiA= -github.com/onsi/gomega v1.7.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= +github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY= +github.com/onsi/gomega v1.10.1 h1:o0+MgICZLuZ7xjH7Vx6zS/zcu93/BEp1VwkIW1mEXCE= +github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo= github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db h1:9uViuKtx1jrlXLBW/pMnhOfzn3iSEdLase/But/IZRU= github.com/packer-community/winrmcp v0.0.0-20180921211025-c76d91c1e7db/go.mod h1:f6Izs6JvFTdnRbziASagjZ2vmf55NSIkC/weStxCHqk= github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c h1:Lgl0gzECD8GnQ5QCWA8o6BtfL6mDH5rQgM4/fX3avOs= @@ -650,16 +666,15 @@ github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4k github.com/spf13/afero v1.2.2 h1:5jhuqJyZCZf2JRofRvN/nIFgIWNzPa3/Vz8mYylgbWc= github.com/spf13/afero v1.2.2/go.mod h1:9ZxEEn6pIJ8Rxe320qSDBk6AsU0r9pR7Q4OcevTdifk= github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ= -github.com/spf13/pflag v0.0.0-20170130214245-9ff6c6923cff/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/pflag v1.0.1/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/pflag v1.0.2/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stoewer/go-strcase v1.2.0/go.mod h1:IBiWB2sKIp3wVVQ3Y035++gc+knqhUQag1KpM8ahLw8= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.2.0 h1:Hbg2NidpLE8veEBkEZTL3CvlkUIVzuU9jDplZO54c48= -github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= @@ -740,7 +755,6 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk golang.org/x/crypto v0.0.0-20190426145343-a29dc8fdc734/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= -golang.org/x/crypto v0.0.0-20190611184440-5c40567a22f8/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190923035154-9ee001bba392/go.mod h1:/lpIB1dKB+9EgE3H3cr1v9wB50oz8l4C4h62xy7jSTY= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191202143827-86a70503ff7e/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= @@ -748,11 +762,11 @@ golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPh golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20201002170205-7f63de1d35b0/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= -golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4= golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8= golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa h1:idItI2DDfCokpg0N51B2VtiLdJ4vAuXC9fnCb2gACo4= golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= @@ -807,7 +821,6 @@ golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn golang.org/x/net v0.0.0-20190501004415-9ce7a6920f09/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190503192946-f4e77d36d62c/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= -golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -825,6 +838,7 @@ golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/ golang.org/x/net v0.0.0-20200501053045-e0ff5e5a1de5/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200506145744-7e3656a0809f/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200513185701-a91f0712d120/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20200707034311-ab3426394381/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= @@ -834,12 +848,13 @@ golang.org/x/net v0.0.0-20201031054903-ff519b6c9102/go.mod h1:sp8m0HH+o8qH0wwXwY golang.org/x/net v0.0.0-20201110031124-69a78807bb2b/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= golang.org/x/net v0.0.0-20201209123823-ac852fbbde11/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210119194325-5f4716e94777/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20210224082022-3d97a244fca7/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210316092652-d523dce5a7f4/go.mod h1:RBQZq4jEuRlivfhVLdyRGr576XBO4/greRjx4P4O3yc= golang.org/x/net v0.0.0-20210326060303-6b1517762897/go.mod h1:uSPa2vr4CLtc/ILN5odXGNXS6mhrKVzTaCXzk9m6W3k= golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= golang.org/x/net v0.0.0-20210525063256-abc453219eb5/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20211209124913-491a49abca63/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20211216030914-fe4d6282115f h1:hEYJvxw1lSnWIl8X9ofsYMklzaDs90JI2az5YMd4fPM= golang.org/x/net v0.0.0-20211216030914-fe4d6282115f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= @@ -853,8 +868,9 @@ golang.org/x/oauth2 v0.0.0-20201208152858-08078c50e5b5/go.mod h1:KelEdhl1UZF7XfJ golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210220000619-9bb904979d93/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= -golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c h1:pkQiBZBvdos9qq4wBAHqlzuZHEXo07pqV06ef90u1WI= golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= +golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f h1:Qmd2pbz05z7z6lm0DrgQVVPuBm92jqujBKMHMOlOQEw= +golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -883,15 +899,17 @@ golang.org/x/sys v0.0.0-20190502175342-a43fa875dd82/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190509141414-a5b02f93d862/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20190616124812-15dcb6c0061f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190922100055-0a153f010e69/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191008105621-543471e840be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191128015809-6d18c012aee9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191228213918-04cbcbbfeed8/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -908,6 +926,7 @@ golang.org/x/sys v0.0.0-20200331124033-c3d80250170d/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20200501052902-10377860bb8e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200511232937-7e40ca221e25/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200519105757-fe76b779f299/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200803210538-64077c9b5642/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200905004654-be1d3432aa8f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -919,21 +938,21 @@ golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210220050731-9a76102bfb43/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210305230114-8fe3ee5dd75b/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210315160823-c6e025ad8005/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210324051608-47abb6519492/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210502180810-71e4cd670f79/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e h1:WUoyKPm6nCo1BnNUvPGnFG3T5DUVem42yDJZZ4CNxMA= golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= +golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e h1:XMgFehsDnnLGtjvjOfqWSUzt0alpTR1RSEuznObga2c= +golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d h1:SZxvLBoTP5yHO3Frd4z4vrF+DBX9vMVanchswa69toE= -golang.org/x/term v0.0.0-20210220032956-6a3ed077a48d/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b h1:9zKuko04nR4gjZ4+DNjHqRlAJqbJETHwiNKDqTfOjfE= +golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -941,15 +960,16 @@ golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/time v0.0.0-20180412165947-fbb02b2291d2/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/time v0.0.0-20211116232009-f0f3c7e86c11 h1:GZokNIeuVkl3aZHJchRrr13WCsols02MLUcz1U9is6M= -golang.org/x/time v0.0.0-20211116232009-f0f3c7e86c11/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 h1:M73Iuj3xbbb9Uk1DYhzydthsj6oOd6l9bpuFcNoUvTs= +golang.org/x/time v0.0.0-20220224211638-0e9765cccd65/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= @@ -961,7 +981,6 @@ golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBn golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= -golang.org/x/tools v0.0.0-20190614205625-5aca471b1d59/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= @@ -988,6 +1007,7 @@ golang.org/x/tools v0.0.0-20200304193943-95d2e580d8eb/go.mod h1:o4KQGtdN14AW+yjs golang.org/x/tools v0.0.0-20200312045724-11d5b4c81c7d/go.mod h1:o4KQGtdN14AW+yjsvvwRTJJuXz8XRtIHtEnmAXLyFUw= golang.org/x/tools v0.0.0-20200331025713-a30bf2db82d4/go.mod h1:Sl4aGygMT6LrqrWclx+PTx3U+LnKx/seiNR+3G19Ar8= golang.org/x/tools v0.0.0-20200501065659-ab2804fb9c9d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= +golang.org/x/tools v0.0.0-20200505023115-26f46d2f7ef8/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200512131952-2bc93b1c0c88/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200515010526-7d3b6ebf133d/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20200618134242-20370b0cb4b2/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= @@ -1005,6 +1025,7 @@ golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.7 h1:6j8CgantCy3yc8JGBqkDLMKWqZ0RDU2g1HVgacojGWQ= golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -1032,6 +1053,7 @@ google.golang.org/api v0.35.0/go.mod h1:/XrVsuzM0rZmrsbjJutiuftIzeuTQcEeaYcSk/mQ google.golang.org/api v0.36.0/go.mod h1:+z5ficQTmoYpPn8LCUNVpK5I7hwkpjbcgqA7I34qYtE= google.golang.org/api v0.40.0/go.mod h1:fYKFpnQN0DsDSKRVRcQSDQNtqWPfM9i+zNPxepjRCQ8= google.golang.org/api v0.41.0/go.mod h1:RkxM5lITDfTzmyKFPt+wGrCJbVfniCr2ool8kTBzRTU= +google.golang.org/api v0.43.0/go.mod h1:nQsDGjRXMo4lvh5hP0TKqF244gqhGcr/YSIykhUk/94= google.golang.org/api v0.44.0-impersonate-preview h1:/7twr+Es8HH6URUkpfcnn6mCadE7NCYmogHzBXNQZh4= google.golang.org/api v0.44.0-impersonate-preview/go.mod h1:nQsDGjRXMo4lvh5hP0TKqF244gqhGcr/YSIykhUk/94= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= @@ -1074,6 +1096,7 @@ google.golang.org/genproto v0.0.0-20200729003335-053ba62fc06f/go.mod h1:FWY/as6D google.golang.org/genproto v0.0.0-20200804131852-c06518451d9c/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200825200019-8632dd797987/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20200904004341-0bd0a958aa1d/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= +google.golang.org/genproto v0.0.0-20201019141844-1ed22bb0c154/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201109203340-2640f1f9cdfb/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201201144952-b05cb90ed32e/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20201210142538-e3217bee35cc/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= @@ -1081,8 +1104,9 @@ google.golang.org/genproto v0.0.0-20201214200347-8c77b98c765d/go.mod h1:FWY/as6D google.golang.org/genproto v0.0.0-20210222152913-aa3ee6e6a81c/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210303154014-9728d6b83eeb/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= google.golang.org/genproto v0.0.0-20210310155132-4ce2db91004e/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= -google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6 h1:4Xw2NwItrJOFR5s6PnK98PI6Bgw1LhMP1j/rO5WP0S4= google.golang.org/genproto v0.0.0-20210319143718-93e7006c17a6/go.mod h1:FWY/as6DDZQgahTzZj3fqbO1CbirC29ZNUFHwi0/+no= +google.golang.org/genproto v0.0.0-20210402141018-6c239bbf2bb1 h1:E7wSQBXkH3T3diucK+9Z1kjn4+/9tNG7lZLr75oOhh8= +google.golang.org/genproto v0.0.0-20210402141018-6c239bbf2bb1/go.mod h1:9lPAdzaEmUacj36I+k7YKbEc5CXzPIeORRgDAUOu28A= google.golang.org/grpc v1.8.0/go.mod h1:yo6s7OP7yaDglbqo1J04qKzAhqBH6lvTonzMVmEdcZw= google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= google.golang.org/grpc v1.20.1/go.mod h1:10oTOabMzJvdu6/UiuZezV6QK5dSlG84ov/aaiqXj38= @@ -1102,6 +1126,7 @@ google.golang.org/grpc v1.32.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM google.golang.org/grpc v1.33.2/go.mod h1:JMHMWHQWaTccqQQlmk3MJZS+GWXOdAesneDmEnv2fbc= google.golang.org/grpc v1.34.0/go.mod h1:WotjhfgOW/POjDeRt8vscBtXq+2VjORFy659qA51WJ8= google.golang.org/grpc v1.35.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= +google.golang.org/grpc v1.36.0/go.mod h1:qjiiYl8FncCW8feJPdyg3v6XW24KsRHe+dy9BAGRRjU= google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0 h1:M1YKkFIboKNieVO5DLUEVzQfGwJD30Nv2jfUgzb5UcE= google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0/go.mod h1:6Kw0yEErY5E/yWrBtf03jp27GLLJujG4z/JK95pnjjw= google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8= @@ -1134,6 +1159,7 @@ gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw= gopkg.in/ini.v1 v1.42.0 h1:7N3gPTt50s8GuLortA00n8AqRTk75qOP98+mTPpgzRk= gopkg.in/ini.v1 v1.42.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= @@ -1145,8 +1171,10 @@ gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= -gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= @@ -1156,26 +1184,30 @@ honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9 honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k= honnef.co/go/tools v0.3.0-0.dev h1:6vzhjcOJu1nJRa2G8QLXf3DPeg601NuerY16vrb01GY= honnef.co/go/tools v0.3.0-0.dev/go.mod h1:lPVVZ2BS5TfnjLyizF7o7hv7j9/L+8cZY2hLyjP9cGY= -k8s.io/api v0.21.3 h1:cblWILbLO8ar+Fj6xdDGr603HRsf8Wu9E9rngJeprZQ= -k8s.io/api v0.21.3/go.mod h1:hUgeYHUbBp23Ue4qdX9tR8/ANi/g3ehylAqDn9NWVOg= -k8s.io/apimachinery v0.21.3 h1:3Ju4nvjCngxxMYby0BimUk+pQHPOQp3eCGChk5kfVII= -k8s.io/apimachinery v0.21.3/go.mod h1:H/IM+5vH9kZRNJ4l3x/fXP/5bOPJaVP/guptnZPeCFI= -k8s.io/client-go v0.21.3 h1:J9nxZTOmvkInRDCzcSNQmPJbDYN/PjlxXT9Mos3HcLg= -k8s.io/client-go v0.21.3/go.mod h1:+VPhCgTsaFmGILxR/7E1N0S+ryO010QBeNCv5JwRGYU= -k8s.io/gengo v0.0.0-20200413195148-3a45101e95ac/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8IAqLxYwwyPxAX1Pzy0ii0= +k8s.io/api v0.23.4 h1:85gnfXQOWbJa1SiWGpE9EEtHs0UVvDyIsSMpEtl2D4E= +k8s.io/api v0.23.4/go.mod h1:i77F4JfyNNrhOjZF7OwwNJS5Y1S9dpwvb9iYRYRczfI= +k8s.io/apimachinery v0.23.4 h1:fhnuMd/xUL3Cjfl64j5ULKZ1/J9n8NuQEgNL+WXWfdM= +k8s.io/apimachinery v0.23.4/go.mod h1:BEuFMMBaIbcOqVIJqNZJXGFTP4W6AycEpb5+m/97hrM= +k8s.io/client-go v0.23.4 h1:YVWvPeerA2gpUudLelvsolzH7c2sFoXXR5wM/sWqNFU= +k8s.io/client-go v0.23.4/go.mod h1:PKnIL4pqLuvYUK1WU7RLTMYKPiIh7MYShLshtRY9cj0= +k8s.io/gengo v0.0.0-20210813121822-485abfe95c7c/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E= k8s.io/klog/v2 v2.0.0/go.mod h1:PBfzABfn139FHAV07az/IF9Wp1bkk3vpT2XSJ76fSDE= -k8s.io/klog/v2 v2.8.0 h1:Q3gmuM9hKEjefWFFYF0Mat+YyFJvsUyYuwyNNJ5C9Ts= -k8s.io/klog/v2 v2.8.0/go.mod h1:hy9LJ/NvuK+iVyP4Ehqva4HxZG/oXyIS3n3Jmire4Ec= -k8s.io/kube-openapi v0.0.0-20210305001622-591a79e4bda7/go.mod h1:wXW5VT87nVfh/iLV8FpR2uDvrFyomxbtb1KivDbvPTE= -k8s.io/utils v0.0.0-20201110183641-67b214c5f920/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= -k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b h1:wxEMGetGMur3J1xuGLQY7GEQYg9bZxKn3tKo5k/eYcs= -k8s.io/utils v0.0.0-20210930125809-cb0fa318a74b/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= +k8s.io/klog/v2 v2.2.0/go.mod h1:Od+F08eJP+W3HUb4pSrPpgp9DGU4GzlpG/TmITuYh/Y= +k8s.io/klog/v2 v2.30.0 h1:bUO6drIvCIsvZ/XFgfxoGFQU/a4Qkh0iAlvUR7vlHJw= +k8s.io/klog/v2 v2.30.0/go.mod h1:y1WjHnz7Dj687irZUWR/WLkLc5N1YHtjLdmgWjndZn0= +k8s.io/kube-openapi v0.0.0-20211115234752-e816edb12b65 h1:E3J9oCLlaobFUqsjG9DfKbP2BmgwBL2p7pn0A3dG9W4= +k8s.io/kube-openapi v0.0.0-20211115234752-e816edb12b65/go.mod h1:sX9MT8g7NVZM5lVL/j8QyCCJe8YSMW30QvGZWaCIDIk= +k8s.io/utils v0.0.0-20210802155522-efc7438f0176/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= +k8s.io/utils v0.0.0-20211116205334-6203023598ed h1:ck1fRPWPJWsMd8ZRFsWc6mh/zHp5fZ/shhbrgPUxDAE= +k8s.io/utils v0.0.0-20211116205334-6203023598ed/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0= rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA= +sigs.k8s.io/json v0.0.0-20211020170558-c049b76a60c6 h1:fD1pz4yfdADVNfFmcP2aBEtudwUQ1AlLnRBALr33v3s= +sigs.k8s.io/json v0.0.0-20211020170558-c049b76a60c6/go.mod h1:p4QtZmO4uMYipTQNzagwnNoseA6OxSUutVw05NhYDRs= sigs.k8s.io/structured-merge-diff/v4 v4.0.2/go.mod h1:bJZC9H9iH24zzfZ/41RGcq60oK1F7G282QMXDPYydCw= -sigs.k8s.io/structured-merge-diff/v4 v4.1.2 h1:Hr/htKFmJEbtMgS/UD0N+gtgctAqz81t3nu+sPzynno= -sigs.k8s.io/structured-merge-diff/v4 v4.1.2/go.mod h1:j/nl6xW8vLS49O8YvXW1ocPhZawJtm+Yrr7PPRQ0Vg4= +sigs.k8s.io/structured-merge-diff/v4 v4.2.1 h1:bKCqE9GvQ5tiVHn5rfn1r+yao3aLQEaLzkkmAkf+A6Y= +sigs.k8s.io/structured-merge-diff/v4 v4.2.1/go.mod h1:j/nl6xW8vLS49O8YvXW1ocPhZawJtm+Yrr7PPRQ0Vg4= sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o= sigs.k8s.io/yaml v1.2.0 h1:kr/MCeFWJWTwyaHoR9c8EjH9OumOmoF9YGiZd7lFm/Q= sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc= diff --git a/internal/cloud/backend_runTasks.go b/internal/cloud/backend_runTasks.go index 890bf9231d0a..2712151b23b1 100644 --- a/internal/cloud/backend_runTasks.go +++ b/internal/cloud/backend_runTasks.go @@ -136,7 +136,7 @@ func (b *Cloud) runTasksWithTaskResults(context *IntegrationContext, output Inte func (b *Cloud) runTasks(ctx *IntegrationContext, output IntegrationOutputWriter, stageID string) error { return b.runTasksWithTaskResults(ctx, output, func(b *Cloud, stopCtx context.Context) (*tfe.TaskStage, error) { options := tfe.TaskStageReadOptions{ - Include: "task_results", + Include: []tfe.TaskStageIncludeOps{tfe.TaskStageTaskResults}, } return b.client.TaskStages.Read(ctx.StopContext, stageID, &options) From dc63fda44b67300d5161dabcd803426d0d2f468e Mon Sep 17 00:00:00 2001 From: Sebastian Rivera Date: Fri, 25 Feb 2022 16:02:18 -0500 Subject: [PATCH 621/644] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 818cdde3fefc..5e0659f55384 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,10 +3,12 @@ NEW FEATURES: * `precondition` and `postcondition` check blocks for resources, data sources, and module output values: module authors can now document assumptions and assertions about configuration and state values. If these conditions are not met, Terraform will report a custom error message to the user and halt further evaluation. +* Terraform now supports [run tasks](https://www.terraform.io/cloud-docs/workspaces/settings/run-tasks), a Terraform Cloud integration for executing remote operations, for the post plan stage of a run. ENHANCEMENTS: * The "Invalid for_each argument" error message for unknown maps/sets now includes an additional paragraph to try to help the user notice they can move apply-time values into the map _values_ instead of the map _keys_, and thus avoid the problem without resorting to `-target`. [GH-30327] +* When showing the progress of a remote operation running in Terraform Cloud, Terraform CLI will include information about post-plan [run tasks](https://www.terraform.io/cloud-docs/workspaces/settings/run-tasks). [GH-30141] BUG FIXES: From 51a08c79a4e4ac0124f89d389623846415356988 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Tue, 1 Mar 2022 16:52:17 -0500 Subject: [PATCH 622/644] go get github.com/aliyun/alibaba-cloud-sdk-go/sdk --- go.mod | 8 ++------ go.sum | 18 ++++++------------ 2 files changed, 8 insertions(+), 18 deletions(-) diff --git a/go.mod b/go.mod index 99130b0e4bf2..c29e1135c395 100644 --- a/go.mod +++ b/go.mod @@ -6,7 +6,7 @@ require ( github.com/Azure/go-autorest/autorest v0.11.22 github.com/Netflix/go-expect v0.0.0-20211003183012-e1a7c020ce25 github.com/agext/levenshtein v1.2.3 - github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a + github.com/aliyun/alibaba-cloud-sdk-go v1.61.1501 github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70 github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible github.com/apparentlymart/go-cidr v1.1.0 @@ -140,7 +140,6 @@ require ( github.com/google/gofuzz v1.1.0 // indirect github.com/googleapis/gax-go/v2 v2.0.5 // indirect github.com/googleapis/gnostic v0.5.5 // indirect - github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 // indirect github.com/hashicorp/go-immutable-radix v1.0.0 // indirect github.com/hashicorp/go-msgpack v0.5.4 // indirect github.com/hashicorp/go-rootcerts v1.0.2 // indirect @@ -154,7 +153,6 @@ require ( github.com/imdario/mergo v0.3.12 // indirect github.com/json-iterator/go v1.1.12 // indirect github.com/jstemmer/go-junit-report v0.9.1 // indirect - github.com/jtolds/gls v4.2.1+incompatible // indirect github.com/klauspost/compress v1.11.2 // indirect github.com/kr/pretty v0.2.1 // indirect github.com/kr/pty v1.1.5 // indirect @@ -169,8 +167,6 @@ require ( github.com/oklog/run v1.0.0 // indirect github.com/satori/go.uuid v1.2.0 // indirect github.com/sergi/go-diff v1.2.0 // indirect - github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect - github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a // indirect github.com/spf13/pflag v1.0.5 // indirect github.com/ulikunitz/xz v0.5.8 // indirect github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect @@ -186,7 +182,7 @@ require ( google.golang.org/genproto v0.0.0-20210402141018-6c239bbf2bb1 // indirect gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect gopkg.in/inf.v0 v0.9.1 // indirect - gopkg.in/ini.v1 v1.42.0 // indirect + gopkg.in/ini.v1 v1.66.2 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect k8s.io/klog/v2 v2.30.0 // indirect diff --git a/go.sum b/go.sum index 389fea0223c3..8e1df83ffc02 100644 --- a/go.sum +++ b/go.sum @@ -111,8 +111,8 @@ github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7l github.com/agext/levenshtein v1.2.3/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= -github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a h1:APorzFpCcv6wtD5vmRWYqNm4N55kbepL7c7kTq9XI6A= -github.com/aliyun/alibaba-cloud-sdk-go v0.0.0-20190329064014-6e358769c32a/go.mod h1:T9M45xf79ahXVelWoOBmH0y4aC1t5kXO5BxwyakgIGA= +github.com/aliyun/alibaba-cloud-sdk-go v1.61.1501 h1:Ij3S0pNUMgHlhx3Ew8g9RNrt59EKhHYdMODGtFXJfSc= +github.com/aliyun/alibaba-cloud-sdk-go v1.61.1501/go.mod h1:RcDobYh8k5VP6TNybz9m++gL3ijVI5wueVr0EM10VsU= github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70 h1:FrF4uxA24DF3ARNXVbUin3wa5fDLaB1Cy8mKks/LRz4= github.com/aliyun/aliyun-oss-go-sdk v0.0.0-20190103054945-8205d1f41e70/go.mod h1:T/Aws4fEfogEE9v+HPhhw+CntffsBHJ8nXQCwKr0/g8= github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible h1:ABQ7FF+IxSFHDMOTtjCfmMDMHiCq6EsAoCV/9sFinaM= @@ -255,6 +255,7 @@ github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7a github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= +github.com/goji/httpauth v0.0.0-20160601135302-2da839ab0f4d/go.mod h1:nnjvkQ9ptGaCkuDUx6wNykzzlUixGxvkme+H/lnzb+A= github.com/golang-jwt/jwt v3.2.1+incompatible h1:73Z+4BJcrTC+KczS6WvTPvRGOp1WmfEP4Q1lOd9Z/+c= github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I= github.com/golang-jwt/jwt/v4 v4.0.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg= @@ -352,8 +353,6 @@ github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5 h1:Ciwp github.com/gophercloud/gophercloud v0.10.1-0.20200424014253-c3bfe50899e5/go.mod h1:gmC5oQqMDOMO1t1gq5DquX/yAU808e/4mzjjDA76+Ss= github.com/gophercloud/utils v0.0.0-20200423144003-7c72efc7435d h1:fduaPzWwIfvOMLuHk2Al3GZH0XbUqG8MbElPop+Igzs= github.com/gophercloud/utils v0.0.0-20200423144003-7c72efc7435d/go.mod h1:ehWUbLQJPqS0Ep+CxeD559hsm9pthPXadJNKwZkp43w= -github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= -github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= @@ -480,6 +479,7 @@ github.com/jonboulle/clockwork v0.1.0 h1:VKV+ZcuP6l3yW9doeqz6ziZGgcynBVQO+obU0+0 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926 h1:kie3qOosvRKqwij2HGzXWffwpXvcqfPPXRUw8I4F/mg= github.com/joyent/triton-go v0.0.0-20180313100802-d8f9c0314926/go.mod h1:U+RSyWxWd04xTqnuOQxnai7XGS2PrPY2cfGoDKtMHjA= +github.com/json-iterator/go v1.1.5/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= github.com/json-iterator/go v1.1.7/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= @@ -487,8 +487,6 @@ github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHm github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= github.com/jstemmer/go-junit-report v0.9.1 h1:6QPYqodiu3GuPL+7mfx+NwDdp2eTkp9IfEUpgAwUN0o= github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk= -github.com/jtolds/gls v4.2.1+incompatible h1:fSuqC+Gmlu6l/ZYAoZzx2pyucC8Xza35fpRVWLVmUEE= -github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 h1:iQTw/8FWTuc7uiaSepXwyf3o52HaUYcV+Tu66S3F5GA= github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0/go.mod h1:1NbS8ALrpOvjt0rHPNLyCIeMtbizbir8U//inJ+zuB8= @@ -657,10 +655,6 @@ github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMB github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= github.com/sirupsen/logrus v1.7.0 h1:ShrD1U9pZB12TX0cVy0DtePoCH97K8EtX+mg7ZARUtM= github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= -github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= -github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= -github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a h1:JSvGDIbmil4Ui/dDdFBExb7/cmkNjyX5F97oglmvCDo= -github.com/smartystreets/goconvey v0.0.0-20180222194500-ef6db91d284a/go.mod h1:XDJAKZRPZ1CvBcN2aX5YOUTYGHki24fSF0Iv48Ibg0s= github.com/soheilhy/cmux v0.1.4 h1:0HKaf1o97UwFjHH9o5XsHUOF+tqmdA7KEzXLpiyaw0E= github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM= github.com/spf13/afero v1.2.2 h1:5jhuqJyZCZf2JRofRvN/nIFgIWNzPa3/Vz8mYylgbWc= @@ -1156,8 +1150,8 @@ gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= gopkg.in/inf.v0 v0.9.1 h1:73M5CoZyi3ZLMOyDlQh031Cx6N9NDJ2Vvfl76EDAgDc= gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw= -gopkg.in/ini.v1 v1.42.0 h1:7N3gPTt50s8GuLortA00n8AqRTk75qOP98+mTPpgzRk= -gopkg.in/ini.v1 v1.42.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= +gopkg.in/ini.v1 v1.66.2 h1:XfR1dOYubytKy4Shzc2LHrrGhU0lDCfDGG1yLPmpgsI= +gopkg.in/ini.v1 v1.66.2/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ= gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= From fe6ce539fa450cf9a1de62550244268deb5abf16 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Tue, 1 Mar 2022 16:52:48 -0500 Subject: [PATCH 623/644] go get github.com/dylanmei/winrmtest --- go.mod | 8 ++++---- go.sum | 17 +++++++++-------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/go.mod b/go.mod index c29e1135c395..7b47e433bd53 100644 --- a/go.mod +++ b/go.mod @@ -21,7 +21,7 @@ require ( github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f github.com/davecgh/go-spew v1.1.1 - github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 + github.com/dylanmei/winrmtest v0.0.0-20210303004826-fbc9ae56efb6 github.com/go-test/deep v1.0.3 github.com/golang/mock v1.6.0 github.com/golang/protobuf v1.5.2 @@ -119,8 +119,8 @@ require ( github.com/Masterminds/sprig v2.22.0+incompatible // indirect github.com/Microsoft/go-winio v0.5.0 // indirect github.com/abdullin/seq v0.0.0-20160510034733-d5467c17e7af // indirect - github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e // indirect - github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0 // indirect + github.com/antchfx/xmlquery v1.3.5 // indirect + github.com/antchfx/xpath v1.1.10 // indirect github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da // indirect github.com/armon/go-radix v1.0.0 // indirect @@ -132,7 +132,7 @@ require ( github.com/dylanmei/iso8601 v0.1.0 // indirect github.com/fatih/color v1.9.0 // indirect github.com/go-logr/logr v1.2.0 // indirect - github.com/gofrs/uuid v3.3.0+incompatible // indirect + github.com/gofrs/uuid v4.0.0+incompatible // indirect github.com/gogo/protobuf v1.3.2 // indirect github.com/golang-jwt/jwt/v4 v4.1.0 // indirect github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect diff --git a/go.sum b/go.sum index 8e1df83ffc02..1e0aa12138cc 100644 --- a/go.sum +++ b/go.sum @@ -119,10 +119,10 @@ github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible h1:ABQ7FF+IxSFHDM github.com/aliyun/aliyun-tablestore-go-sdk v4.1.2+incompatible/go.mod h1:LDQHRZylxvcg8H7wBIDfvO5g/cy4/sz1iucBlc2l3Jw= github.com/andybalholm/crlf v0.0.0-20171020200849-670099aa064f/go.mod h1:k8feO4+kXDxro6ErPXBRTJ/ro2mf0SsFG8s7doP9kJE= github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c= -github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e h1:ptBAamGVd6CfRsUtyHD+goy2JGhv1QC32v3gqM8mYAM= -github.com/antchfx/xpath v0.0.0-20190129040759-c8489ed3251e/go.mod h1:Yee4kTMuNiPYJ7nSNorELQMr1J33uOpXDMByNYhvtNk= -github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0 h1:JaCC8jz0zdMLk2m+qCCVLLLM/PL93p84w4pK3aJWj60= -github.com/antchfx/xquery v0.0.0-20180515051857-ad5b8c7a47b0/go.mod h1:LzD22aAzDP8/dyiCKFp31He4m2GPjl0AFyzDtZzUu9M= +github.com/antchfx/xmlquery v1.3.5 h1:I7TuBRqsnfFuL11ruavGm911Awx9IqSdiU6W/ztSmVw= +github.com/antchfx/xmlquery v1.3.5/go.mod h1:64w0Xesg2sTaawIdNqMB+7qaW/bSqkQm+ssPaCMWNnc= +github.com/antchfx/xpath v1.1.10 h1:cJ0pOvEdN/WvYXxvRrzQH9x5QWKpzHacYO8qzCcDYAg= +github.com/antchfx/xpath v1.1.10/go.mod h1:Yee4kTMuNiPYJ7nSNorELQMr1J33uOpXDMByNYhvtNk= github.com/apparentlymart/go-cidr v1.0.1/go.mod h1:EBcsNrHc3zQeuaeCeCtQruQm+n9/YjEn/vI25Lg7Gwc= github.com/apparentlymart/go-cidr v1.1.0 h1:2mAhrMoF+nhXqxTzSZMUzDHkLjmIHC+Zzn4tdgBZjnU= github.com/apparentlymart/go-cidr v1.1.0/go.mod h1:EBcsNrHc3zQeuaeCeCtQruQm+n9/YjEn/vI25Lg7Gwc= @@ -201,8 +201,8 @@ github.com/dustin/go-humanize v0.0.0-20171111073723-bb3d318650d4 h1:qk/FSDDxo05w github.com/dustin/go-humanize v0.0.0-20171111073723-bb3d318650d4/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= github.com/dylanmei/iso8601 v0.1.0 h1:812NGQDBcqquTfH5Yeo7lwR0nzx/cKdsmf3qMjPURUI= github.com/dylanmei/iso8601 v0.1.0/go.mod h1:w9KhXSgIyROl1DefbMYIE7UVSIvELTbMrCfx+QkYnoQ= -github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1 h1:r1oACdS2XYiAWcfF8BJXkoU8l1J71KehGR+d99yWEDA= -github.com/dylanmei/winrmtest v0.0.0-20190225150635-99b7fe2fddf1/go.mod h1:lcy9/2gH1jn/VCLouHA6tOEwLoNVd4GW6zhuKLmHC2Y= +github.com/dylanmei/winrmtest v0.0.0-20210303004826-fbc9ae56efb6 h1:zWydSUQBJApHwpQ4guHi+mGyQN/8yN6xbKWdDtL3ZNM= +github.com/dylanmei/winrmtest v0.0.0-20210303004826-fbc9ae56efb6/go.mod h1:6BLLhzn1VEiJ4veuAGhINBTrBlV889Wd+aU4auxKOww= github.com/elazarl/goproxy v0.0.0-20180725130230-947c36da3153/go.mod h1:/Zj4wYkgs4iZTTu3o/KG3Itv/qCCa8VVMlb3i9OVuzc= github.com/emicklei/go-restful v0.0.0-20170410110728-ff4f55a20633/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs= github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o= @@ -249,8 +249,8 @@ github.com/go-test/deep v1.0.1/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3a github.com/go-test/deep v1.0.3 h1:ZrJSEWsXzPOxaZnFteGEfooLba+ju3FYIbOrS+rQd68= github.com/go-test/deep v1.0.3/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= github.com/gofrs/uuid v3.2.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= -github.com/gofrs/uuid v3.3.0+incompatible h1:8K4tyRfvU1CYPgJsveYFQMhpFd/wXNM7iK6rR7UHz84= -github.com/gofrs/uuid v3.3.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= +github.com/gofrs/uuid v4.0.0+incompatible h1:1SD/1F5pU8p29ybwgQSwpQk+mwdRrXCYuPhW6m+TnJw= +github.com/gofrs/uuid v4.0.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= @@ -836,6 +836,7 @@ golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/ golang.org/x/net v0.0.0-20200520182314-0ba52f642ac2/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= golang.org/x/net v0.0.0-20200625001655-4c5254603344/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20200707034311-ab3426394381/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= +golang.org/x/net v0.0.0-20200813134508-3edf25e44fcc/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= golang.org/x/net v0.0.0-20201031054903-ff519b6c9102/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= From ecf76add752d840f1d570a7b56db534f53eb55b9 Mon Sep 17 00:00:00 2001 From: Barrett Clark Date: Wed, 2 Mar 2022 10:12:18 -0600 Subject: [PATCH 624/644] Update go-slug for terraform.tfstate exclusion `go-slug` has been updated to not upload `terraform.tfstate` to the slug so that a user will no longer receive the error message about the leftover state file after migrating from the local backend to TFC. --- go.mod | 2 +- go.sum | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/go.mod b/go.mod index 99130b0e4bf2..36f3d5f96d94 100644 --- a/go.mod +++ b/go.mod @@ -145,7 +145,7 @@ require ( github.com/hashicorp/go-msgpack v0.5.4 // indirect github.com/hashicorp/go-rootcerts v1.0.2 // indirect github.com/hashicorp/go-safetemp v1.0.0 // indirect - github.com/hashicorp/go-slug v0.7.0 // indirect + github.com/hashicorp/go-slug v0.8.0 // indirect github.com/hashicorp/golang-lru v0.5.1 // indirect github.com/hashicorp/jsonapi v0.0.0-20210826224640-ee7dae0fb22d // indirect github.com/hashicorp/serf v0.9.5 // indirect diff --git a/go.sum b/go.sum index 389fea0223c3..9e723f008de0 100644 --- a/go.sum +++ b/go.sum @@ -411,8 +411,9 @@ github.com/hashicorp/go-rootcerts v1.0.2 h1:jzhAVGtqPKbwpyCPELlgNWhE1znq+qwJtW5O github.com/hashicorp/go-rootcerts v1.0.2/go.mod h1:pqUvnprVnM5bf7AOirdbb01K4ccR319Vf4pU3K5EGc8= github.com/hashicorp/go-safetemp v1.0.0 h1:2HR189eFNrjHQyENnQMMpCiBAsRxzbTMIgBhEyExpmo= github.com/hashicorp/go-safetemp v1.0.0/go.mod h1:oaerMy3BhqiTbVye6QuFhFtIceqFoDHxNAB65b+Rj1I= -github.com/hashicorp/go-slug v0.7.0 h1:8HIi6oreWPtnhpYd8lIGQBgp4rXzDWQTOhfILZm+nok= github.com/hashicorp/go-slug v0.7.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41RKLH301v4= +github.com/hashicorp/go-slug v0.8.0 h1:h7AGtXVAI/cJ/Wwa/JQQaftQnWQmZbAzkzgZeZVVmLw= +github.com/hashicorp/go-slug v0.8.0/go.mod h1:Ib+IWBYfEfJGI1ZyXMGNbu2BU+aa3Dzu41RKLH301v4= github.com/hashicorp/go-sockaddr v1.0.0 h1:GeH6tui99pF4NJgfnhp+L6+FfobzVW3Ah46sLo0ICXs= github.com/hashicorp/go-sockaddr v1.0.0/go.mod h1:7Xibr9yA9JjQq1JpNB2Vw7kxv8xerXegt+ozgdvDeDU= github.com/hashicorp/go-syslog v1.0.0/go.mod h1:qPfqrKkXGihmCqbJM2mZgkZGvKG1dFdvsLplgctolz4= From b06fe04621d7aa252ae616b209071a82b5d25dde Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 3 Feb 2022 14:14:21 -0500 Subject: [PATCH 625/644] core: Check rule error message expressions Error messages for preconditions, postconditions, and custom variable validations have until now been string literals. This commit changes this to treat the field as an HCL expression, which must evaluate to a string. Most commonly this will either be a string literal or a template expression. When the check rule condition is evaluated, we also evaluate the error message. This means that the error message should always evaluate to a string value, even if the condition passes. If it does not, this will result in an error diagnostic. If the condition fails, and the error message also fails to evaluate, we fall back to a default error message. This means that the check rule failure will still be reported, alongside diagnostics explaining why the custom error message failed to render. As part of this change, we also necessarily remove the heuristic about the error message format. This guidance can be readded in future as part of a configuration hint system. --- internal/configs/checks.go | 82 ++----------------- internal/configs/named_values.go | 25 ++++++ internal/configs/named_values_test.go | 33 -------- .../variable-validation-bad-msg.tf | 6 -- .../variable-validation-condition-badref.tf | 7 ++ .../valid-files/variable_validation.tf | 16 ++++ internal/terraform/context_plan2_test.go | 2 +- internal/terraform/eval_conditions.go | 51 +++++++++--- internal/terraform/eval_variable.go | 70 ++++++++++++---- internal/terraform/node_resource_abstract.go | 4 + internal/terraform/node_root_variable_test.go | 3 +- 11 files changed, 157 insertions(+), 142 deletions(-) delete mode 100644 internal/configs/named_values_test.go delete mode 100644 internal/configs/testdata/invalid-files/variable-validation-bad-msg.tf diff --git a/internal/configs/checks.go b/internal/configs/checks.go index 0980ec16c013..10ad62b69a42 100644 --- a/internal/configs/checks.go +++ b/internal/configs/checks.go @@ -2,10 +2,8 @@ package configs import ( "fmt" - "unicode" "github.com/hashicorp/hcl/v2" - "github.com/hashicorp/hcl/v2/gohcl" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/lang" ) @@ -24,12 +22,15 @@ type CheckRule struct { // input variables can only refer to the variable that is being validated. Condition hcl.Expression - // ErrorMessage is one or more full sentences, which would need to be in + // ErrorMessage should be one or more full sentences, which should be in // English for consistency with the rest of the error message output but - // can in practice be in any language as long as it ends with a period. - // The message should describe what is required for the condition to return - // true in a way that would make sense to a caller of the module. - ErrorMessage string + // can in practice be in any language. The message should describe what is + // required for the condition to return true in a way that would make sense + // to a caller of the module. + // + // The error message expression has the same variables available for + // interpolation as the corresponding condition. + ErrorMessage hcl.Expression DeclRange hcl.Range } @@ -111,77 +112,12 @@ func decodeCheckRuleBlock(block *hcl.Block, override bool) (*CheckRule, hcl.Diag } if attr, exists := content.Attributes["error_message"]; exists { - moreDiags := gohcl.DecodeExpression(attr.Expr, nil, &cr.ErrorMessage) - diags = append(diags, moreDiags...) - if !moreDiags.HasErrors() { - const errSummary = "Invalid validation error message" - switch { - case cr.ErrorMessage == "": - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: errSummary, - Detail: "An empty string is not a valid nor useful error message.", - Subject: attr.Expr.Range().Ptr(), - }) - case !looksLikeSentences(cr.ErrorMessage): - // Because we're going to include this string verbatim as part - // of a bigger error message written in our usual style in - // English, we'll require the given error message to conform - // to that. We might relax this in future if e.g. we start - // presenting these error messages in a different way, or if - // Terraform starts supporting producing error messages in - // other human languages, etc. - // For pragmatism we also allow sentences ending with - // exclamation points, but we don't mention it explicitly here - // because that's not really consistent with the Terraform UI - // writing style. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: errSummary, - Detail: "The validation error message must be at least one full sentence starting with an uppercase letter and ending with a period or question mark.\n\nYour given message will be included as part of a larger Terraform error message, written as English prose. For broadly-shared modules we suggest using a similar writing style so that the overall result will be consistent.", - Subject: attr.Expr.Range().Ptr(), - }) - } - } + cr.ErrorMessage = attr.Expr } return cr, diags } -// looksLikeSentence is a simple heuristic that encourages writing error -// messages that will be presentable when included as part of a larger -// Terraform error diagnostic whose other text is written in the Terraform -// UI writing style. -// -// This is intentionally not a very strong validation since we're assuming -// that module authors want to write good messages and might just need a nudge -// about Terraform's specific style, rather than that they are going to try -// to work around these rules to write a lower-quality message. -func looksLikeSentences(s string) bool { - if len(s) < 1 { - return false - } - runes := []rune(s) // HCL guarantees that all strings are valid UTF-8 - first := runes[0] - last := runes[len(runes)-1] - - // If the first rune is a letter then it must be an uppercase letter. - // (This will only see the first rune in a multi-rune combining sequence, - // but the first rune is generally the letter if any are, and if not then - // we'll just ignore it because we're primarily expecting English messages - // right now anyway, for consistency with all of Terraform's other output.) - if unicode.IsLetter(first) && !unicode.IsUpper(first) { - return false - } - - // The string must be at least one full sentence, which implies having - // sentence-ending punctuation. - // (This assumes that if a sentence ends with quotes then the period - // will be outside the quotes, which is consistent with Terraform's UI - // writing style.) - return last == '.' || last == '?' || last == '!' -} - var checkRuleBlockSchema = &hcl.BodySchema{ Attributes: []hcl.AttributeSchema{ { diff --git a/internal/configs/named_values.go b/internal/configs/named_values.go index 970656511a41..10882ac088f4 100644 --- a/internal/configs/named_values.go +++ b/internal/configs/named_values.go @@ -345,6 +345,31 @@ func decodeVariableValidationBlock(varName string, block *hcl.Block, override bo } } + if vv.ErrorMessage != nil { + // The same applies to the validation error message, except that + // references are not required. A string literal is a valid error + // message. + goodRefs := 0 + for _, traversal := range vv.ErrorMessage.Variables() { + ref, moreDiags := addrs.ParseRef(traversal) + if !moreDiags.HasErrors() { + if addr, ok := ref.Subject.(addrs.InputVariable); ok { + if addr.Name == varName { + goodRefs++ + continue // Reference is valid + } + } + } + // If we fall out here then the reference is invalid. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid reference in variable validation", + Detail: fmt.Sprintf("The error message for variable %q can only refer to the variable itself, using var.%s.", varName, varName), + Subject: traversal.SourceRange().Ptr(), + }) + } + } + return vv, diags } diff --git a/internal/configs/named_values_test.go b/internal/configs/named_values_test.go deleted file mode 100644 index 3a44438a4685..000000000000 --- a/internal/configs/named_values_test.go +++ /dev/null @@ -1,33 +0,0 @@ -package configs - -import ( - "testing" -) - -func Test_looksLikeSentences(t *testing.T) { - tests := map[string]struct { - args string - want bool - }{ - "empty sentence": { - args: "", - want: false, - }, - "valid sentence": { - args: "A valid sentence.", - want: true, - }, - "valid sentence with an accent": { - args: `A Valid sentence with an accent "é".`, - want: true, - }, - } - - for name, tt := range tests { - t.Run(name, func(t *testing.T) { - if got := looksLikeSentences(tt.args); got != tt.want { - t.Errorf("looksLikeSentences() = %v, want %v", got, tt.want) - } - }) - } -} diff --git a/internal/configs/testdata/invalid-files/variable-validation-bad-msg.tf b/internal/configs/testdata/invalid-files/variable-validation-bad-msg.tf deleted file mode 100644 index 65df45579c4d..000000000000 --- a/internal/configs/testdata/invalid-files/variable-validation-bad-msg.tf +++ /dev/null @@ -1,6 +0,0 @@ -variable "validation" { - validation { - condition = var.validation != 4 - error_message = "not four" # ERROR: Invalid validation error message - } -} diff --git a/internal/configs/testdata/invalid-files/variable-validation-condition-badref.tf b/internal/configs/testdata/invalid-files/variable-validation-condition-badref.tf index 42f4aa5f25ee..9b9e935767af 100644 --- a/internal/configs/testdata/invalid-files/variable-validation-condition-badref.tf +++ b/internal/configs/testdata/invalid-files/variable-validation-condition-badref.tf @@ -9,3 +9,10 @@ variable "validation" { error_message = "Must be five." } } + +variable "validation_error_expression" { + validation { + condition = var.validation_error_expression != 1 + error_message = "Cannot equal ${local.foo}." # ERROR: Invalid reference in variable validation + } +} diff --git a/internal/configs/testdata/valid-files/variable_validation.tf b/internal/configs/testdata/valid-files/variable_validation.tf index 0a0c2dd50e72..20e227e06112 100644 --- a/internal/configs/testdata/valid-files/variable_validation.tf +++ b/internal/configs/testdata/valid-files/variable_validation.tf @@ -4,3 +4,19 @@ variable "validation" { error_message = "Must be five." } } + +variable "validation_function" { + type = list(string) + validation { + condition = length(var.validation_function) > 0 + error_message = "Must not be empty." + } +} + +variable "validation_error_expression" { + type = list(string) + validation { + condition = length(var.validation_error_expression) < 10 + error_message = "Too long (${length(var.validation_error_expression)} is greater than 10)." + } +} diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index 622c4c803f6e..ba153230c9bb 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -2561,7 +2561,7 @@ func TestContext2Plan_preconditionErrors(t *testing.T) { { "test_resource.c.value", "Invalid condition result", - "Invalid validation condition result value: a bool is required", + "Invalid condition result value: a bool is required", }, } diff --git a/internal/terraform/eval_conditions.go b/internal/terraform/eval_conditions.go index 302f88160830..ad4d0cc4d5a4 100644 --- a/internal/terraform/eval_conditions.go +++ b/internal/terraform/eval_conditions.go @@ -3,6 +3,7 @@ package terraform import ( "fmt" "log" + "strings" "github.com/hashicorp/hcl/v2" "github.com/zclconf/go-cty/cty" @@ -59,12 +60,20 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, refs, moreDiags := lang.ReferencesInExpr(rule.Condition) ruleDiags = ruleDiags.Append(moreDiags) + moreRefs, moreDiags := lang.ReferencesInExpr(rule.ErrorMessage) + ruleDiags = ruleDiags.Append(moreDiags) + refs = append(refs, moreRefs...) + scope := ctx.EvaluationScope(self, keyData) hclCtx, moreDiags := scope.EvalContext(refs) ruleDiags = ruleDiags.Append(moreDiags) result, hclDiags := rule.Condition.Value(hclCtx) ruleDiags = ruleDiags.Append(hclDiags) + + errorValue, errorDiags := rule.ErrorMessage.Value(hclCtx) + ruleDiags = ruleDiags.Append(errorDiags) + diags = diags.Append(ruleDiags) if ruleDiags.HasErrors() { @@ -91,7 +100,7 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, diags = diags.Append(&hcl.Diagnostic{ Severity: hcl.DiagError, Summary: errInvalidCondition, - Detail: fmt.Sprintf("Invalid validation condition result value: %s.", tfdiags.FormatError(err)), + Detail: fmt.Sprintf("Invalid condition result value: %s.", tfdiags.FormatError(err)), Subject: rule.Condition.Range().Ptr(), Expression: rule.Condition, EvalContext: hclCtx, @@ -99,16 +108,38 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, continue } - if result.False() { - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: typ.FailureSummary(), - Detail: rule.ErrorMessage, - Subject: rule.Condition.Range().Ptr(), - Expression: rule.Condition, - EvalContext: hclCtx, - }) + if result.True() { + continue + } + + var errorMessage string + if !errorDiags.HasErrors() && errorValue.IsKnown() && !errorValue.IsNull() { + var err error + errorValue, err = convert.Convert(errorValue, cty.String) + if err != nil { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Invalid error message", + Detail: fmt.Sprintf("Unsuitable value for error message: %s.", tfdiags.FormatError(err)), + Subject: rule.ErrorMessage.Range().Ptr(), + Expression: rule.ErrorMessage, + EvalContext: hclCtx, + }) + } else { + errorMessage = strings.TrimSpace(errorValue.AsString()) + } + } + if errorMessage == "" { + errorMessage = "Failed to evaluate condition error message." } + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: typ.FailureSummary(), + Detail: errorMessage, + Subject: rule.Condition.Range().Ptr(), + Expression: rule.Condition, + EvalContext: hclCtx, + }) } return diags diff --git a/internal/terraform/eval_variable.go b/internal/terraform/eval_variable.go index fd57a136f290..4ac53ed33532 100644 --- a/internal/terraform/eval_variable.go +++ b/internal/terraform/eval_variable.go @@ -3,6 +3,7 @@ package terraform import ( "fmt" "log" + "strings" "github.com/hashicorp/hcl/v2" "github.com/hashicorp/terraform/internal/addrs" @@ -205,11 +206,17 @@ func evalVariableValidations(addr addrs.AbsInputVariableInstance, config *config for _, validation := range config.Validations { const errInvalidCondition = "Invalid variable validation result" const errInvalidValue = "Invalid value for variable" + var ruleDiags tfdiags.Diagnostics result, moreDiags := validation.Condition.Value(hclCtx) - diags = diags.Append(moreDiags) - if moreDiags.HasErrors() { - log.Printf("[TRACE] evalVariableValidations: %s rule %s condition expression failed: %s", addr, validation.DeclRange, diags.Err().Error()) + ruleDiags = ruleDiags.Append(moreDiags) + errorValue, errorDiags := validation.ErrorMessage.Value(hclCtx) + ruleDiags = ruleDiags.Append(errorDiags) + + diags = diags.Append(ruleDiags) + + if ruleDiags.HasErrors() { + log.Printf("[TRACE] evalVariableValidations: %s rule %s condition expression failed: %s", addr, validation.DeclRange, ruleDiags.Err().Error()) } if !result.IsKnown() { log.Printf("[TRACE] evalVariableValidations: %s rule %s condition value is unknown, so skipping validation for now", addr, validation.DeclRange) @@ -245,26 +252,53 @@ func evalVariableValidations(addr addrs.AbsInputVariableInstance, config *config // we discard the marks now. result, _ = result.Unmark() - if result.False() { - if expr != nil { + if result.True() { + continue + } + + var errorMessage string + if !errorDiags.HasErrors() && errorValue.IsKnown() && !errorValue.IsNull() { + var err error + errorValue, err = convert.Convert(errorValue, cty.String) + if err != nil { diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: errInvalidValue, - Detail: fmt.Sprintf("%s\n\nThis was checked by the validation rule at %s.", validation.ErrorMessage, validation.DeclRange.String()), - Subject: expr.Range().Ptr(), + Severity: hcl.DiagError, + Summary: "Invalid error message", + Detail: fmt.Sprintf("Unsuitable value for error message: %s.", tfdiags.FormatError(err)), + Subject: validation.ErrorMessage.Range().Ptr(), + Expression: validation.ErrorMessage, + EvalContext: hclCtx, }) } else { - // Since we don't have a source expression for a root module - // variable, we'll just report the error from the perspective - // of the variable declaration itself. - diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: errInvalidValue, - Detail: fmt.Sprintf("%s\n\nThis was checked by the validation rule at %s.", validation.ErrorMessage, validation.DeclRange.String()), - Subject: config.DeclRange.Ptr(), - }) + errorMessage = strings.TrimSpace(errorValue.AsString()) } } + if errorMessage == "" { + errorMessage = "Failed to evaluate condition error message." + } + + if expr != nil { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errInvalidValue, + Detail: fmt.Sprintf("%s\n\nThis was checked by the validation rule at %s.", errorMessage, validation.DeclRange.String()), + Subject: expr.Range().Ptr(), + Expression: validation.Condition, + EvalContext: hclCtx, + }) + } else { + // Since we don't have a source expression for a root module + // variable, we'll just report the error from the perspective + // of the variable declaration itself. + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errInvalidValue, + Detail: fmt.Sprintf("%s\n\nThis was checked by the validation rule at %s.", errorMessage, validation.DeclRange.String()), + Subject: config.DeclRange.Ptr(), + Expression: validation.Condition, + EvalContext: hclCtx, + }) + } } return diags diff --git a/internal/terraform/node_resource_abstract.go b/internal/terraform/node_resource_abstract.go index bc22d4be78b6..a15214b790ad 100644 --- a/internal/terraform/node_resource_abstract.go +++ b/internal/terraform/node_resource_abstract.go @@ -176,10 +176,14 @@ func (n *NodeAbstractResource) References() []*addrs.Reference { for _, check := range c.Preconditions { refs, _ := lang.ReferencesInExpr(check.Condition) result = append(result, refs...) + refs, _ = lang.ReferencesInExpr(check.ErrorMessage) + result = append(result, refs...) } for _, check := range c.Postconditions { refs, _ := lang.ReferencesInExpr(check.Condition) result = append(result, refs...) + refs, _ = lang.ReferencesInExpr(check.ErrorMessage) + result = append(result, refs...) } return result diff --git a/internal/terraform/node_root_variable_test.go b/internal/terraform/node_root_variable_test.go index ccf3b3e41a9f..537cecce9f7d 100644 --- a/internal/terraform/node_root_variable_test.go +++ b/internal/terraform/node_root_variable_test.go @@ -4,6 +4,7 @@ import ( "testing" "github.com/hashicorp/hcl/v2" + "github.com/hashicorp/hcl/v2/hcltest" "github.com/zclconf/go-cty/cty" "github.com/hashicorp/terraform/internal/addrs" @@ -101,7 +102,7 @@ func TestNodeRootVariableExecute(t *testing.T) { } return cty.True, nil }), - ErrorMessage: "Must be a number.", + ErrorMessage: hcltest.MockExprLiteral(cty.StringVal("Must be a number.")), }, }, }, From b59bffada68eec94b7d8741cce452b028c73543d Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 3 Feb 2022 14:14:21 -0500 Subject: [PATCH 626/644] core: Evaluate pre/postconditions during validate During the validation walk, we attempt to proactively evaluate check rule condition and error message expressions. This will help catch some errors as early as possible. At present, resource values in the validation walk are of dynamic type. This means that any references to resources will cause validation to be delayed, rather than presenting useful errors. Validation may still catch other errors, and any future changes which cause better type propagation will result in better validation too. --- internal/terraform/context_validate_test.go | 290 +++++++++++++++++++ internal/terraform/node_resource_validate.go | 26 ++ 2 files changed, 316 insertions(+) diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index 1f0491f1a906..c049b17cec22 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -2095,3 +2095,293 @@ func TestContext2Validate_nonNullableVariableDefaultValidation(t *testing.T) { t.Fatal(diags.ErrWithWarnings()) } } + +func TestContext2Validate_precondition_good(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "input" { + type = string + default = "foo" +} + +resource "aws_instance" "test" { + foo = var.input + + lifecycle { + precondition { + condition = length(var.input) > 0 + error_message = "Input cannot be empty." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if diags.HasErrors() { + t.Fatal(diags.ErrWithWarnings()) + } +} + +func TestContext2Validate_precondition_badCondition(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "input" { + type = string + default = "foo" +} + +resource "aws_instance" "test" { + foo = var.input + + lifecycle { + precondition { + condition = length(one(var.input)) == 1 + error_message = "You can't do that." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if !diags.HasErrors() { + t.Fatalf("succeeded; want error") + } + if got, want := diags.Err().Error(), "Invalid function argument"; !strings.Contains(got, want) { + t.Errorf("unexpected error.\ngot: %s\nshould contain: %q", got, want) + } +} + +func TestContext2Validate_precondition_badErrorMessage(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "input" { + type = string + default = "foo" +} + +resource "aws_instance" "test" { + foo = var.input + + lifecycle { + precondition { + condition = var.input != "foo" + error_message = "This is a bad use of a function: ${one(var.input)}." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if !diags.HasErrors() { + t.Fatalf("succeeded; want error") + } + if got, want := diags.Err().Error(), "Invalid function argument"; !strings.Contains(got, want) { + t.Errorf("unexpected error.\ngot: %s\nshould contain: %q", got, want) + } +} + +func TestContext2Validate_postcondition_good(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +resource "aws_instance" "test" { + foo = "foo" + + lifecycle { + postcondition { + condition = length(self.foo) > 0 + error_message = "Input cannot be empty." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if diags.HasErrors() { + t.Fatal(diags.ErrWithWarnings()) + } +} + +func TestContext2Validate_postcondition_badCondition(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + // This postcondition's condition expression does not refer to self, which + // is unrealistic. This is because at the time of writing the test, self is + // always an unknown value of dynamic type during validation. As a result, + // validation of conditions which refer to resource arguments is not + // possible until plan time. For now we exercise the code by referring to + // an input variable. + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "input" { + type = string + default = "foo" +} + +resource "aws_instance" "test" { + foo = var.input + + lifecycle { + postcondition { + condition = length(one(var.input)) == 1 + error_message = "You can't do that." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if !diags.HasErrors() { + t.Fatalf("succeeded; want error") + } + if got, want := diags.Err().Error(), "Invalid function argument"; !strings.Contains(got, want) { + t.Errorf("unexpected error.\ngot: %s\nshould contain: %q", got, want) + } +} + +func TestContext2Validate_postcondition_badErrorMessage(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +resource "aws_instance" "test" { + foo = "foo" + + lifecycle { + postcondition { + condition = self.foo != "foo" + error_message = "This is a bad use of a function: ${one("foo")}." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if !diags.HasErrors() { + t.Fatalf("succeeded; want error") + } + if got, want := diags.Err().Error(), "Invalid function argument"; !strings.Contains(got, want) { + t.Errorf("unexpected error.\ngot: %s\nshould contain: %q", got, want) + } +} diff --git a/internal/terraform/node_resource_validate.go b/internal/terraform/node_resource_validate.go index f3eda571ea3e..4f316906db25 100644 --- a/internal/terraform/node_resource_validate.go +++ b/internal/terraform/node_resource_validate.go @@ -41,6 +41,18 @@ func (n *NodeValidatableResource) Path() addrs.ModuleInstance { func (n *NodeValidatableResource) Execute(ctx EvalContext, op walkOperation) (diags tfdiags.Diagnostics) { diags = diags.Append(n.validateResource(ctx)) + var self addrs.Referenceable + switch { + case n.Config.Count != nil: + self = n.Addr.Resource.Instance(addrs.IntKey(0)) + case n.Config.ForEach != nil: + self = n.Addr.Resource.Instance(addrs.StringKey("")) + default: + self = n.Addr.Resource.Instance(addrs.NoKey) + } + diags = diags.Append(validateCheckRules(ctx, n.Config.Preconditions, nil)) + diags = diags.Append(validateCheckRules(ctx, n.Config.Postconditions, self)) + if managed := n.Config.Managed; managed != nil { hasCount := n.Config.Count != nil hasForEach := n.Config.ForEach != nil @@ -466,6 +478,20 @@ func (n *NodeValidatableResource) validateResource(ctx EvalContext) tfdiags.Diag return diags } +func validateCheckRules(ctx EvalContext, crs []*configs.CheckRule, self addrs.Referenceable) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + for _, cr := range crs { + _, conditionDiags := ctx.EvaluateExpr(cr.Condition, cty.Bool, self) + diags = diags.Append(conditionDiags) + + _, errorMessageDiags := ctx.EvaluateExpr(cr.ErrorMessage, cty.String, self) + diags = diags.Append(errorMessageDiags) + } + + return diags +} + func validateCount(ctx EvalContext, expr hcl.Expression) (diags tfdiags.Diagnostics) { val, countDiags := evaluateCountExpressionValue(expr, ctx) // If the value isn't known then that's the best we can do for now, but From 45d0c04707777a9d25b8349c2f61caef5ccef16a Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 7 Feb 2022 14:46:31 -0500 Subject: [PATCH 627/644] core: Add fallback for JSON syntax error messages Custom variable validations specified using JSON syntax would always parse error messages as string literals, even if they included template expressions. We need to be as backwards compatible with this behaviour as possible, which results in this complex fallback logic. More detail about this in the extensive code comments. --- internal/terraform/eval_variable.go | 55 +++++++- internal/terraform/eval_variable_test.go | 154 +++++++++++++++++++++++ 2 files changed, 207 insertions(+), 2 deletions(-) diff --git a/internal/terraform/eval_variable.go b/internal/terraform/eval_variable.go index 4ac53ed33532..629da70510e0 100644 --- a/internal/terraform/eval_variable.go +++ b/internal/terraform/eval_variable.go @@ -6,6 +6,7 @@ import ( "strings" "github.com/hashicorp/hcl/v2" + "github.com/hashicorp/hcl/v2/gohcl" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/tfdiags" @@ -211,12 +212,62 @@ func evalVariableValidations(addr addrs.AbsInputVariableInstance, config *config result, moreDiags := validation.Condition.Value(hclCtx) ruleDiags = ruleDiags.Append(moreDiags) errorValue, errorDiags := validation.ErrorMessage.Value(hclCtx) - ruleDiags = ruleDiags.Append(errorDiags) + + // The following error handling is a workaround to preserve backwards + // compatibility. Due to an implementation quirk, all prior versions of + // Terraform would treat error messages specified using JSON + // configuration syntax (.tf.json) as string literals, even if they + // contained the "${" template expression operator. This behaviour did + // not match that of HCL configuration syntax, where a template + // expression would result in a validation error. + // + // As a result, users writing or generating JSON configuration syntax + // may have specified error messages which are invalid template + // expressions. As we add support for error message expressions, we are + // unable to perfectly distinguish between these two cases. + // + // To ensure that we don't break backwards compatibility, we have the + // below fallback logic if the error message fails to evaluate. This + // should only have any effect for JSON configurations. The gohcl + // DecodeExpression function behaves differently when the source of the + // expression is a JSON configuration file and a nil context is passed. + if errorDiags.HasErrors() { + // Attempt to decode the expression as a string literal. Passing + // nil as the context forces a JSON syntax string value to be + // interpreted as a string literal. + var errorString string + moreErrorDiags := gohcl.DecodeExpression(validation.ErrorMessage, nil, &errorString) + if !moreErrorDiags.HasErrors() { + // Decoding succeeded, meaning that this is a JSON syntax + // string value. We rewrap that as a cty value to allow later + // decoding to succeed. + errorValue = cty.StringVal(errorString) + + // This warning diagnostic explains this odd behaviour, while + // giving us an escape hatch to change this to a hard failure + // in some future Terraform 1.x version. + errorDiags = hcl.Diagnostics{ + &hcl.Diagnostic{ + Severity: hcl.DiagWarning, + Summary: "Validation error message expression is invalid", + Detail: fmt.Sprintf("The error message provided could not be evaluated as an expression, so Terraform is interpreting it as a string literal.\n\nIn future versions of Terraform, this will be considered an error. Please file a GitHub issue if this would break your workflow.\n\n%s", errorDiags.Error()), + Subject: validation.ErrorMessage.Range().Ptr(), + Context: validation.DeclRange.Ptr(), + Expression: validation.ErrorMessage, + EvalContext: hclCtx, + }, + } + } + + // We want to either report the original diagnostics if the + // fallback failed, or the warning generated above if it succeeded. + ruleDiags = ruleDiags.Append(errorDiags) + } diags = diags.Append(ruleDiags) if ruleDiags.HasErrors() { - log.Printf("[TRACE] evalVariableValidations: %s rule %s condition expression failed: %s", addr, validation.DeclRange, ruleDiags.Err().Error()) + log.Printf("[TRACE] evalVariableValidations: %s rule %s check rule evaluation failed: %s", addr, validation.DeclRange, ruleDiags.Err().Error()) } if !result.IsKnown() { log.Printf("[TRACE] evalVariableValidations: %s rule %s condition value is unknown, so skipping validation for now", addr, validation.DeclRange) diff --git a/internal/terraform/eval_variable_test.go b/internal/terraform/eval_variable_test.go index 0ebea982f57b..c84a969e8c09 100644 --- a/internal/terraform/eval_variable_test.go +++ b/internal/terraform/eval_variable_test.go @@ -2,12 +2,14 @@ package terraform import ( "fmt" + "strings" "testing" "github.com/hashicorp/hcl/v2" "github.com/zclconf/go-cty/cty" "github.com/hashicorp/terraform/internal/addrs" + "github.com/hashicorp/terraform/internal/lang" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -561,3 +563,155 @@ func TestPrepareFinalInputVariableValue(t *testing.T) { } }) } + +// These tests cover the JSON syntax configuration edge case handling, +// the background of which is described in detail in comments in the +// evalVariableValidations function. Future versions of Terraform may +// be able to remove this behaviour altogether. +func TestEvalVariableValidations_jsonErrorMessageEdgeCase(t *testing.T) { + cfgSrc := `{ + "variable": { + "valid": { + "type": "string", + "validation": { + "condition": "${var.valid != \"bar\"}", + "error_message": "Valid template string ${var.valid}" + } + }, + "invalid": { + "type": "string", + "validation": { + "condition": "${var.invalid != \"bar\"}", + "error_message": "Invalid template string ${" + } + } + } +} +` + cfg := testModuleInline(t, map[string]string{ + "main.tf.json": cfgSrc, + }) + variableConfigs := cfg.Module.Variables + + // Because we loaded our pseudo-module from a temporary file, the + // declaration source ranges will have unpredictable filenames. We'll + // fix that here just to make things easier below. + for _, vc := range variableConfigs { + vc.DeclRange.Filename = "main.tf.json" + for _, v := range vc.Validations { + v.DeclRange.Filename = "main.tf.json" + } + } + + tests := []struct { + varName string + given cty.Value + wantErr []string + wantWarn []string + }{ + // Valid variable validation declaration, assigned value which passes + // the condition generates no diagnostics. + { + varName: "valid", + given: cty.StringVal("foo"), + }, + // Assigning a value which fails the condition generates an error + // message with the expression successfully evaluated. + { + varName: "valid", + given: cty.StringVal("bar"), + wantErr: []string{ + "Invalid value for variable", + "Valid template string bar", + }, + }, + // Invalid variable validation declaration due to an unparseable + // template string. Assigning a value which passes the condition + // results in a warning about the error message. + { + varName: "invalid", + given: cty.StringVal("foo"), + wantWarn: []string{ + "Validation error message expression is invalid", + "Missing expression; Expected the start of an expression, but found the end of the file.", + }, + }, + // Assigning a value which fails the condition generates an error + // message including the configured string interpreted as a literal + // value, and the same warning diagnostic as above. + { + varName: "invalid", + given: cty.StringVal("bar"), + wantErr: []string{ + "Invalid value for variable", + "Invalid template string ${", + }, + wantWarn: []string{ + "Validation error message expression is invalid", + "Missing expression; Expected the start of an expression, but found the end of the file.", + }, + }, + } + + for _, test := range tests { + t.Run(fmt.Sprintf("%s %#v", test.varName, test.given), func(t *testing.T) { + varAddr := addrs.InputVariable{Name: test.varName}.Absolute(addrs.RootModuleInstance) + varCfg := variableConfigs[test.varName] + if varCfg == nil { + t.Fatalf("invalid variable name %q", test.varName) + } + + // Build a mock context to allow the function under test to + // retrieve the variable value and evaluate the expressions + ctx := &MockEvalContext{} + + // We need a minimal scope to allow basic functions to be passed to + // the HCL scope + ctx.EvaluationScopeScope = &lang.Scope{} + ctx.GetVariableValueFunc = func(addr addrs.AbsInputVariableInstance) cty.Value { + if got, want := addr.String(), varAddr.String(); got != want { + t.Errorf("incorrect argument to GetVariableValue: got %s, want %s", got, want) + } + return test.given + } + + gotDiags := evalVariableValidations( + varAddr, varCfg, nil, ctx, + ) + + if len(test.wantErr) == 0 && len(test.wantWarn) == 0 { + if len(gotDiags) > 0 { + t.Errorf("no diags expected, got %s", gotDiags.Err().Error()) + } + } else { + wantErrs: + for _, want := range test.wantErr { + for _, diag := range gotDiags { + if diag.Severity() != tfdiags.Error { + continue + } + desc := diag.Description() + if strings.Contains(desc.Summary, want) || strings.Contains(desc.Detail, want) { + continue wantErrs + } + } + t.Errorf("no error diagnostics found containing %q\ngot: %s", want, gotDiags.Err().Error()) + } + + wantWarns: + for _, want := range test.wantWarn { + for _, diag := range gotDiags { + if diag.Severity() != tfdiags.Warning { + continue + } + desc := diag.Description() + if strings.Contains(desc.Summary, want) || strings.Contains(desc.Detail, want) { + continue wantWarns + } + } + t.Errorf("no warning diagnostics found containing %q\ngot: %s", want, gotDiags.Err().Error()) + } + } + }) + } +} From f21d0e8bf60fd921772b783dacbba6be19629326 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Tue, 8 Feb 2022 10:42:50 -0500 Subject: [PATCH 628/644] website: Update docs for check rule error messages --- .../expressions/preconditions-postconditions.mdx | 14 +++++++++----- website/docs/language/values/variables.mdx | 5 ++++- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/website/docs/language/expressions/preconditions-postconditions.mdx b/website/docs/language/expressions/preconditions-postconditions.mdx index 1aebff3b7eed..635cb1b63c2a 100644 --- a/website/docs/language/expressions/preconditions-postconditions.mdx +++ b/website/docs/language/expressions/preconditions-postconditions.mdx @@ -335,11 +335,15 @@ Error: Resource postcondition failed The selected AMI must be tagged with the Component value "nomad-server". ``` -The `error_message` argument must always be a literal string, and should -typically be written as a full sentence in a style similar to Terraform's own -error messages. Terraform will show the given message alongside the name -of the resource that detected the problem and any outside values used as part -of the condition expression. +The `error_message` argument can be any expression which evaluates to a string. +This includes literal strings, heredocs, and template expressions. Multi-line +error messages are supported, and lines with leading whitespace will not be +word wrapped. + +Error message should typically be written as one or more full sentences in a +style similar to Terraform's own error messages. Terraform will show the given +message alongside the name of the resource that detected the problem and any +outside values used as part of the condition expression. ## Preconditions or Postconditions? diff --git a/website/docs/language/values/variables.mdx b/website/docs/language/values/variables.mdx index 4bfe6e053230..434c88a24f1b 100644 --- a/website/docs/language/values/variables.mdx +++ b/website/docs/language/values/variables.mdx @@ -198,10 +198,13 @@ variable "image_id" { ``` If `condition` evaluates to `false`, Terraform will produce an error message -that includes the sentences given in `error_message`. The error message string +that includes the result of the `error_message` expression. The error message should be at least one full sentence explaining the constraint that failed, using a sentence structure similar to the above examples. +Error messages can be literal strings, heredocs, or template expressions. The +only valid reference in an error message is the variable under validation. + Multiple `validation` blocks can be declared in which case error messages will be returned for _all_ failed conditions. From e75bcdc01627a41d8303e80a8772b1cd9a9f195c Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Mon, 7 Mar 2022 12:12:28 -0500 Subject: [PATCH 629/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e0659f55384..126babcaed6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ENHANCEMENTS: * The "Invalid for_each argument" error message for unknown maps/sets now includes an additional paragraph to try to help the user notice they can move apply-time values into the map _values_ instead of the map _keys_, and thus avoid the problem without resorting to `-target`. [GH-30327] * When showing the progress of a remote operation running in Terraform Cloud, Terraform CLI will include information about post-plan [run tasks](https://www.terraform.io/cloud-docs/workspaces/settings/run-tasks). [GH-30141] +* Error messages for preconditions, postconditions, and custom variable validations are now evaluated as expressions, allowing interpolation of relevant values into the output. [GH-30613] BUG FIXES: From dc668dff386b70a8c151ded6cd1af5ff32867956 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 8 Mar 2022 13:06:30 -0500 Subject: [PATCH 630/644] ensure UI hooks are called for data sources The UI hooks for data source reads were missed during planning. Move the hook calls to immediatley before and after the ReadDataSource calls to ensure they are called during both plan and apply. --- internal/terraform/context_apply_test.go | 9 ++++++++ .../node_resource_abstract_instance.go | 22 +++++++++---------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 46dcbd58b8b9..5963b224267e 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -1428,7 +1428,9 @@ func TestContext2Apply_dataBasic(t *testing.T) { }), } + hook := new(MockHook) ctx := testContext2(t, &ContextOpts{ + Hooks: []Hook{hook}, Providers: map[addrs.Provider]providers.Factory{ addrs.NewDefaultProvider("null"): testProviderFuncFixed(p), }, @@ -1449,6 +1451,13 @@ func TestContext2Apply_dataBasic(t *testing.T) { if actual != expected { t.Fatalf("wrong result\n\ngot:\n%s\n\nwant:\n%s", actual, expected) } + + if !hook.PreApplyCalled { + t.Fatal("PreApply not called for data source read") + } + if !hook.PostApplyCalled { + t.Fatal("PostApply not called for data source read") + } } func TestContext2Apply_destroyData(t *testing.T) { diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index fb431df53f34..67298b65a2a3 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -1381,6 +1381,13 @@ func (n *NodeAbstractResourceInstance) readDataSource(ctx EvalContext, configVal // to actually call the provider to read the data. log.Printf("[TRACE] readDataSource: %s configuration is complete, so reading from provider", n.Addr) + diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { + return h.PreApply(n.Addr, states.CurrentGen, plans.Read, cty.NullVal(configVal.Type()), configVal) + })) + if diags.HasErrors() { + return newVal, diags + } + resp := provider.ReadDataSource(providers.ReadDataSourceRequest{ TypeName: n.Addr.ContainingResource().Resource.Type, Config: configVal, @@ -1445,6 +1452,10 @@ func (n *NodeAbstractResourceInstance) readDataSource(ctx EvalContext, configVal newVal = newVal.MarkWithPaths(pvm) } + diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { + return h.PostApply(n.Addr, states.CurrentGen, newVal, diags.Err()) + })) + return newVal, diags } @@ -1703,13 +1714,6 @@ func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned return nil, keyData, diags } - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PreApply(n.Addr, states.CurrentGen, planned.Action, planned.Before, planned.After) - })) - if diags.HasErrors() { - return nil, keyData, diags - } - config := *n.Config schema, _ := providerSchema.SchemaForResourceAddr(n.Addr.ContainingResource().Resource) if schema == nil { @@ -1751,10 +1755,6 @@ func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned Status: states.ObjectReady, } - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PostApply(n.Addr, states.CurrentGen, newVal, diags.Err()) - })) - return state, keyData, diags } From 05a10f06d11ad3c2d6bceb1287e829f786f8becf Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 8 Mar 2022 13:48:41 -0500 Subject: [PATCH 631/644] remove PreDiff and PostDiff hook calls PreDiff and PostDiff hooks were designed to be called immediately before and after the PlanResourceChange calls to the provider. Probably due to the confusing legacy naming of the hooks, these were scattered about the nodes involved with planning, causing the hooks to be called in a number of places where they were designed, including data sources and destroy plans. Since these hooks are not used at all any longer anyway, we can removed the extra calls with no effect. If we choose in the future to call PlanResourceChange for resource destroy plans, the hooks can be re-inserted (even though they currently are unused) into the new code path which must diverge from the current combined path of managed and data sources. --- internal/terraform/context_apply_test.go | 6 +-- .../node_resource_abstract_instance.go | 40 ------------------- 2 files changed, 2 insertions(+), 44 deletions(-) diff --git a/internal/terraform/context_apply_test.go b/internal/terraform/context_apply_test.go index 5963b224267e..64f357700ba0 100644 --- a/internal/terraform/context_apply_test.go +++ b/internal/terraform/context_apply_test.go @@ -1512,10 +1512,8 @@ func TestContext2Apply_destroyData(t *testing.T) { } wantHookCalls := []*testHookCall{ - {"PreDiff", "data.null_data_source.testing"}, - {"PostDiff", "data.null_data_source.testing"}, - {"PreDiff", "data.null_data_source.testing"}, - {"PostDiff", "data.null_data_source.testing"}, + {"PreApply", "data.null_data_source.testing"}, + {"PostApply", "data.null_data_source.testing"}, {"PostStateUpdate", ""}, } if !reflect.DeepEqual(hook.Calls, wantHookCalls) { diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index 67298b65a2a3..f0bedd11bc59 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -410,18 +410,6 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState return noop, nil } - // Call pre-diff hook - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PreDiff( - absAddr, deposedKey.Generation(), - currentState.Value, - cty.NullVal(cty.DynamicPseudoType), - ) - })) - if diags.HasErrors() { - return nil, diags - } - // Plan is always the same for a destroy. We don't need the provider's // help for this one. plan := &plans.ResourceInstanceChange{ @@ -437,17 +425,6 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState ProviderAddr: n.ResolvedProvider, } - // Call post-diff hook - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PostDiff( - absAddr, - deposedKey.Generation(), - plan.Action, - plan.Before, - plan.After, - ) - })) - return plan, diags } @@ -1567,13 +1544,6 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt } proposedNewVal := objchange.PlannedDataResourceObject(schema, unmarkedConfigVal) - - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PreDiff(n.Addr, states.CurrentGen, priorVal, proposedNewVal) - })) - if diags.HasErrors() { - return nil, nil, keyData, diags - } proposedNewVal = proposedNewVal.MarkWithPaths(configMarkPaths) // Apply detects that the data source will need to be read by the After @@ -1601,13 +1571,6 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt return plannedChange, plannedNewState, keyData, diags } - // While this isn't a "diff", continue to call this for data sources. - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PreDiff(n.Addr, states.CurrentGen, priorVal, configVal) - })) - if diags.HasErrors() { - return nil, nil, keyData, diags - } // We have a complete configuration with no dependencies to wait on, so we // can read the data source into the state. newVal, readDiags := n.readDataSource(ctx, configVal) @@ -1643,9 +1606,6 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt Status: states.ObjectReady, } - diags = diags.Append(ctx.Hook(func(h Hook) (HookAction, error) { - return h.PostDiff(n.Addr, states.CurrentGen, plans.Update, priorVal, newVal) - })) return nil, plannedNewState, keyData, diags } From d6a98ac22b0a571ec2f1fd9e7841815f000384f0 Mon Sep 17 00:00:00 2001 From: savage-tm <79486015+savage-tm@users.noreply.github.com> Date: Wed, 9 Mar 2022 17:10:06 +1300 Subject: [PATCH 632/644] Document logical operators not short-circuiting Including a note about logical operators not short-circuiting will make the documentation clearer and more useful. https://github.com/hashicorp/terraform/issues/24128 includes examples of people being caught out by this lack of clarity. --- website/docs/language/expressions/operators.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/language/expressions/operators.mdx b/website/docs/language/expressions/operators.mdx index be284e96cc1e..cb177e8cff8e 100644 --- a/website/docs/language/expressions/operators.mdx +++ b/website/docs/language/expressions/operators.mdx @@ -103,3 +103,5 @@ The logical operators all expect bool values and produce bool values as results. Terraform does not have an operator for the "exclusive OR" operation. If you know that both operators are boolean values then exclusive OR is equivalent to the `!=` ("not equal") operator. + +The logical operators in Terraform do not short-circuit, meaning `var.foo || var.foo.bar` will produce an error message if `var.foo` is `null` because both `var.foo` and `var.foo.bar` are evaluated. From 0ea6874bc1f80437a04a5e0a59caa271c0158625 Mon Sep 17 00:00:00 2001 From: Kyle Davies <98526301+kderck@users.noreply.github.com> Date: Wed, 9 Mar 2022 20:26:10 +0000 Subject: [PATCH 633/644] Change aws.dest to aws.dst Documentation is wrong the `configuration_aliases` should be `[ aws.src, aws.dst ]` not `[ aws.src, aws.dest ]`. --- website/docs/language/modules/develop/providers.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/language/modules/develop/providers.mdx b/website/docs/language/modules/develop/providers.mdx index 32864a6b6d74..8c173e7fa7b1 100644 --- a/website/docs/language/modules/develop/providers.mdx +++ b/website/docs/language/modules/develop/providers.mdx @@ -221,7 +221,7 @@ terraform { aws = { source = "hashicorp/aws" version = ">= 2.7.0" - configuration_aliases = [ aws.src, aws.dest ] + configuration_aliases = [ aws.src, aws.dst ] } } } From 1879a39d2d558292bc4b8fc0dced4a9034bc1834 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Wed, 9 Mar 2022 12:26:37 -0800 Subject: [PATCH 634/644] configs: Refined error messages for mismatched provider passing This set of diagnostic messages is under a number of unusual constraints that make them tough to get right: - They are discussing a couple finicky concepts which authors are likely to be encountering for the first time in these error messages: the idea of "local names" for providers, the relationship between those and provider source addresses, and additional ("aliased") provider configurations. - They are reporting concerns that span across a module call boundary, and so need to take care to be clear about whether they are talking about a problem in the caller or a problem in the callee. - Some of them are effectively deprecation warnings for features that might be in use by a third-party module that the user doesn't control, in which case they have no recourse to address them aside from opening a feature request with the upstream module maintainer. - Terraform has, for backward-compatibility reasons, a lot of implied default behaviors regarding providers and provider configurations, and these errors can arise in situations where Terraform's assumptions don't match the author's intent, and so we need to be careful to explain what Terraform assumed in order to make the messages understandable. After seeing some confusion with these messages in the community, and being somewhat confused by some of them myself, I decided to try to edit them a bit for consistency of terminology (both between the messages and with terminology in our docs), being explicit about caller vs. callee by naming them in the messages, and making explicit what would otherwise be implicit with regard to the correspondences between provider source addresses and local names. My assumed audience for all of these messages is the author of the caller module, because it's the caller who is responsible for creating the relationship between caller and callee. As much as possible I tried to make the messages include specific actions for that author to take to quiet the warning or fix the error, but some of the warnings are only fixable by the callee's maintainer and so those messages are, in effect, a suggestion to send a request to the author to stop using a deprecated feature. I think these new messages are also not ideal by any means, because it's just tough to pack so much information into concise messages while being clear and consistent, but I hope at least this will give users seeing these messages enough context to infer what's going on, possibly with the help of our documentation. I intentionally didn't change which cases Terraform will return warnings or errors -- only the message texts -- although I did highlight in a comment in one of the tests that what it is a asserting seems a bit suspicious to me. I don't intend to address that here; instead, I intend that note to be something to refer to if we later see a bug report that calls that behavior into question. This does actually silence some _unrelated_ warnings and errors in cases where a provider block has an invalid provider local name as its label, because our other functions for dealing with provider addresses are written to panic if given invalid addresses under the assumption that earlier code will have guarded against that. Doing this allowed for the provider configuration validation logic to safely include more information about the configuration as helpful context, without risking tripping over known-invalid configuration and panicking in the process. --- internal/configs/config_build.go | 2 +- internal/configs/config_build_test.go | 8 +- internal/configs/provider.go | 5 + internal/configs/provider_validation.go | 261 +++++++++++++----- .../config-diagnostics/empty-configs/warnings | 8 +- .../config-diagnostics/incorrect-type/errors | 2 +- .../incorrect-type/warnings | 2 +- .../invalid-provider/warnings | 1 - .../config-diagnostics/nested-provider/errors | 4 +- .../override-provider/errors | 2 +- .../pass-inherited-provider/main.tf | 16 ++ .../pass-inherited-provider/warnings | 2 +- .../config-diagnostics/required-alias/errors | 2 +- .../unexpected-provider/warnings | 3 +- .../unknown-root-provider/warnings | 2 +- 15 files changed, 235 insertions(+), 85 deletions(-) delete mode 100644 internal/configs/testdata/config-diagnostics/invalid-provider/warnings diff --git a/internal/configs/config_build.go b/internal/configs/config_build.go index 96dcbed25c1c..4e2dddaa1b06 100644 --- a/internal/configs/config_build.go +++ b/internal/configs/config_build.go @@ -31,7 +31,7 @@ func BuildConfig(root *Module, walker ModuleWalker) (*Config, hcl.Diagnostics) { cfg.resolveProviderTypes() } - diags = append(diags, validateProviderConfigs(nil, cfg, false)...) + diags = append(diags, validateProviderConfigs(nil, cfg, nil)...) return cfg, diags } diff --git a/internal/configs/config_build_test.go b/internal/configs/config_build_test.go index 8a2134b480d2..274a5cd01b4f 100644 --- a/internal/configs/config_build_test.go +++ b/internal/configs/config_build_test.go @@ -224,7 +224,7 @@ func TestBuildConfigInvalidModules(t *testing.T) { } if !found { - t.Errorf("Expected error diagnostic containing %q", msg) + t.Errorf("Expected error diagnostic containing:\n %s", msg) } } @@ -241,7 +241,7 @@ func TestBuildConfigInvalidModules(t *testing.T) { } if !found { - t.Errorf("Unexpected error: %q", diag) + t.Errorf("Unexpected error:\n %s", diag) } } @@ -255,7 +255,7 @@ func TestBuildConfigInvalidModules(t *testing.T) { } if !found { - t.Errorf("Expected warning diagnostic containing %q", msg) + t.Errorf("Expected warning diagnostic containing:\n %s", msg) } } @@ -272,7 +272,7 @@ func TestBuildConfigInvalidModules(t *testing.T) { } if !found { - t.Errorf("Unexpected warning: %q", diag) + t.Errorf("Unexpected warning:\n %s", diag) } } diff --git a/internal/configs/provider.go b/internal/configs/provider.go index 62e047d15bb4..40484123da51 100644 --- a/internal/configs/provider.go +++ b/internal/configs/provider.go @@ -46,6 +46,11 @@ func decodeProviderBlock(block *hcl.Block) (*Provider, hcl.Diagnostics) { name := block.Labels[0] nameDiags := checkProviderNameNormalized(name, block.DefRange) diags = append(diags, nameDiags...) + if nameDiags.HasErrors() { + // If the name is invalid then we mustn't produce a result because + // downstreams could try to use it as a provider type and then crash. + return nil, diags + } provider := &Provider{ Name: name, diff --git a/internal/configs/provider_validation.go b/internal/configs/provider_validation.go index 14fde97f78ed..0e6452c26b16 100644 --- a/internal/configs/provider_validation.go +++ b/internal/configs/provider_validation.go @@ -2,6 +2,7 @@ package configs import ( "fmt" + "sort" "strings" "github.com/hashicorp/hcl/v2" @@ -20,10 +21,11 @@ import ( // passed in through the module call. // // The call argument is the ModuleCall for the provided Config cfg. The -// noProviderConfig argument is passed down the call stack, indicating that the -// module call, or a parent module call, has used a feature that precludes -// providers from being configured at all within the module. -func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConfig bool) (diags hcl.Diagnostics) { +// noProviderConfigRange argument is passed down the call stack, indicating +// that the module call, or a parent module call, has used a feature (at the +// specified source location) that precludes providers from being configured at +// all within the module. +func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConfigRange *hcl.Range) (diags hcl.Diagnostics) { mod := cfg.Module for name, child := range cfg.Children { @@ -32,8 +34,24 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf // if the module call has any of count, for_each or depends_on, // providers are prohibited from being configured in this module, or // any module beneath this module. - nope := noProviderConfig || mc.Count != nil || mc.ForEach != nil || mc.DependsOn != nil - diags = append(diags, validateProviderConfigs(mc, child, nope)...) + // NOTE: If noProviderConfigRange was already set but we encounter + // a nested conflicting argument then we'll overwrite the caller's + // range, which allows us to report the problem as close to its + // cause as possible. + switch { + case mc.Count != nil: + noProviderConfigRange = mc.Count.Range().Ptr() + case mc.ForEach != nil: + noProviderConfigRange = mc.ForEach.Range().Ptr() + case mc.DependsOn != nil: + if len(mc.DependsOn) > 0 { + noProviderConfigRange = mc.DependsOn[0].SourceRange().Ptr() + } else { + // Weird! We'll just use the call itself, then. + noProviderConfigRange = mc.DeclRange.Ptr() + } + } + diags = append(diags, validateProviderConfigs(mc, child, noProviderConfigRange)...) } // the set of provider configuration names passed into the module, with the @@ -42,11 +60,11 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf // the set of empty configurations that could be proxy configurations, with // the source range of the empty configuration block. - emptyConfigs := map[string]*hcl.Range{} + emptyConfigs := map[string]hcl.Range{} // the set of provider with a defined configuration, with the source range // of the configuration block declaration. - configured := map[string]*hcl.Range{} + configured := map[string]hcl.Range{} // the set of configuration_aliases defined in the required_providers // block, with the fully qualified provider type. @@ -54,26 +72,22 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf // the set of provider names defined in the required_providers block, and // their provider types. - localNames := map[string]addrs.AbsProviderConfig{} + localNames := map[string]addrs.Provider{} for _, pc := range mod.ProviderConfigs { name := providerName(pc.Name, pc.Alias) // Validate the config against an empty schema to see if it's empty. _, pcConfigDiags := pc.Config.Content(&hcl.BodySchema{}) if pcConfigDiags.HasErrors() || pc.Version.Required != nil { - configured[name] = &pc.DeclRange + configured[name] = pc.DeclRange } else { - emptyConfigs[name] = &pc.DeclRange + emptyConfigs[name] = pc.DeclRange } } if mod.ProviderRequirements != nil { for _, req := range mod.ProviderRequirements.RequiredProviders { - addr := addrs.AbsProviderConfig{ - Module: cfg.Path, - Provider: req.Type, - } - localNames[req.Name] = addr + localNames[req.Name] = req.Type for _, alias := range req.Aliases { addr := addrs.AbsProviderConfig{ Module: cfg.Path, @@ -125,11 +139,15 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf // configuration. We ignore empty configs, because they will // already produce a warning. if !(confOK || localOK) { + defAddr := addrs.NewDefaultProvider(name) diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagWarning, - Summary: fmt.Sprintf("Provider %s is undefined", name), - Detail: fmt.Sprintf("No provider named %s has been declared in %s.\n", name, moduleText) + - fmt.Sprintf("If you wish to refer to the %s provider within the module, add a provider configuration, or an entry in the required_providers block.", name), + Summary: "Reference to undefined provider", + Detail: fmt.Sprintf( + "There is no explicit declaration for local provider name %q in %s, so Terraform is assuming you mean to pass a configuration for provider %q.\n\nTo clarify your intent and silence this warning, add to %s a required_providers entry named %q with source = %q, or a different source address if appropriate.", + name, moduleText, defAddr.ForDisplay(), + parentModuleText, name, defAddr.ForDisplay(), + ), Subject: &passed.InParent.NameRange, }) continue @@ -139,12 +157,16 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf // there won't be a configuration available at runtime if the // parent module did not pass one in. if !cfg.Path.IsRoot() && !(confOK || passedOK) { + defAddr := addrs.NewDefaultProvider(name) diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagWarning, - Summary: fmt.Sprintf("No configuration passed in for provider %s in %s", name, cfg.Path), - Detail: fmt.Sprintf("Provider %s is referenced within %s, but no configuration has been supplied.\n", name, moduleText) + - fmt.Sprintf("Add a provider named %s to the providers map for %s in %s.", name, cfg.Path, parentModuleText), - Subject: &passed.InParent.NameRange, + Summary: "Missing required provider configuration", + Detail: fmt.Sprintf( + "The configuration for %s expects to inherit a configuration for provider %s with local name %q, but %s doesn't pass a configuration under that name.\n\nTo satisfy this requirement, add an entry for %q to the \"providers\" argument in the module %q block.", + moduleText, defAddr.ForDisplay(), name, parentModuleText, + name, parentCall.Name, + ), + Subject: parentCall.DeclRange.Ptr(), }) } } @@ -156,11 +178,20 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf } // there cannot be any configurations if no provider config is allowed - if len(configured) > 0 && noProviderConfig { + if len(configured) > 0 && noProviderConfigRange != nil { + // We report this from the perspective of the use of count, for_each, + // or depends_on rather than from inside the module, because the + // recipient of this message is more likely to be the author of the + // calling module (trying to use an older module that hasn't been + // updated yet) than of the called module. diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagError, - Summary: fmt.Sprintf("Module %s contains provider configuration", cfg.Path), - Detail: "Providers cannot be configured within modules using count, for_each or depends_on.", + Summary: "Module is incompatible with count, for_each, and depends_on", + Detail: fmt.Sprintf( + "The module at %s is a legacy module which contains its own local provider configurations, and so calls to it may not use the count, for_each, or depends_on arguments.\n\nIf you also control the module %q, consider updating this module to instead expect provider configurations to be passed by its caller.", + cfg.Path, cfg.SourceAddr, + ), + Subject: noProviderConfigRange, }) } @@ -170,8 +201,11 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagError, Summary: "Cannot override provider configuration", - Detail: fmt.Sprintf("Provider %s is configured within the module %s and cannot be overridden.", name, cfg.Path), - Subject: &passed.InChild.NameRange, + Detail: fmt.Sprintf( + "The configuration of %s has its own local configuration for %s, and so it cannot accept an overridden configuration provided by %s.", + moduleText, name, parentModuleText, + ), + Subject: &passed.InChild.NameRange, }) } } @@ -188,9 +222,12 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagError, - Summary: fmt.Sprintf("No configuration for provider %s", name), - Detail: fmt.Sprintf("Configuration required for %s.\n", providerAddr) + - fmt.Sprintf("Add a provider named %s to the providers map for %s in %s.", name, cfg.Path, parentModuleText), + Summary: "Missing required provider configuration", + Detail: fmt.Sprintf( + "The child module requires an additional configuration for provider %s, with the local name %q.\n\nRefer to the module's documentation to understand the intended purpose of this additional provider configuration, and then add an entry for %s in the \"providers\" meta-argument in the module block to choose which provider configuration the module should use for that purpose.", + providerAddr.Provider.ForDisplay(), name, + name, + ), Subject: &parentCall.DeclRange, }) } @@ -214,7 +251,7 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf localAddr, localName := localNames[name] if localName { - providerAddr = localAddr + providerAddr.Provider = localAddr } aliasAddr, configAlias := configAliases[name] @@ -225,20 +262,30 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf _, emptyConfig := emptyConfigs[name] if !(localName || configAlias || emptyConfig) { - severity := hcl.DiagError // we still allow default configs, so switch to a warning if the incoming provider is a default if providerAddr.Provider.IsDefault() { - severity = hcl.DiagWarning + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagWarning, + Summary: "Reference to undefined provider", + Detail: fmt.Sprintf( + "There is no explicit declaration for local provider name %q in %s, so Terraform is assuming you mean to pass a configuration for %q.\n\nIf you also control the child module, add a required_providers entry named %q with the source address %q.", + name, moduleText, providerAddr.Provider.ForDisplay(), + name, providerAddr.Provider.ForDisplay(), + ), + Subject: &passed.InChild.NameRange, + }) + } else { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: "Reference to undefined provider", + Detail: fmt.Sprintf( + "The child module does not declare any provider requirement with the local name %q.\n\nIf you also control the child module, you can add a required_providers entry named %q with the source address %q to accept this provider configuration.", + name, name, providerAddr.Provider.ForDisplay(), + ), + Subject: &passed.InChild.NameRange, + }) } - - diags = append(diags, &hcl.Diagnostic{ - Severity: severity, - Summary: fmt.Sprintf("Provider %s is undefined", name), - Detail: fmt.Sprintf("Module %s does not declare a provider named %s.\n", cfg.Path, name) + - fmt.Sprintf("If you wish to specify a provider configuration for the module, add an entry for %s in the required_providers block within the module.", name), - Subject: &passed.InChild.NameRange, - }) } // The provider being passed in must also be of the correct type. @@ -264,40 +311,126 @@ func validateProviderConfigs(parentCall *ModuleCall, cfg *Config, noProviderConf } if !providerAddr.Provider.Equals(parentAddr.Provider) { - diags = append(diags, &hcl.Diagnostic{ - Severity: hcl.DiagError, - Summary: fmt.Sprintf("Invalid type for provider %s", providerAddr), - Detail: fmt.Sprintf("Cannot use configuration from %s for %s. ", parentAddr, providerAddr) + - "The given provider configuration is for a different provider type.", - Subject: &passed.InChild.NameRange, - }) + // If this module declares the same source address for a different + // local name then we'll prefer to suggest changing to match + // the child module's chosen name, assuming that it was the local + // name that was wrong rather than the source address. + var otherLocalName string + for localName, sourceAddr := range localNames { + if sourceAddr.Equals(parentAddr.Provider) { + otherLocalName = localName + break + } + } + + const errSummary = "Provider type mismatch" + if otherLocalName != "" { + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errSummary, + Detail: fmt.Sprintf( + "The assigned configuration is for provider %q, but local name %q in %s represents %q.\n\nTo pass this configuration to the child module, use the local name %q instead.", + parentAddr.Provider.ForDisplay(), passed.InChild.Name, + parentModuleText, providerAddr.Provider.ForDisplay(), + otherLocalName, + ), + Subject: &passed.InChild.NameRange, + }) + } else { + // If there is no declared requirement for the provider the + // caller is trying to pass under any name then we'll instead + // report it as an unsuitable configuration to pass into the + // child module's provider configuration slot. + diags = append(diags, &hcl.Diagnostic{ + Severity: hcl.DiagError, + Summary: errSummary, + Detail: fmt.Sprintf( + "The local name %q in %s represents provider %q, but %q in %s represents %q.\n\nEach provider has its own distinct configuration schema and provider types, so this module's %q can be assigned only a configuration for %s, which is not required by %s.", + passed.InParent, parentModuleText, parentAddr.Provider.ForDisplay(), + passed.InChild, moduleText, providerAddr.Provider.ForDisplay(), + passed.InChild, providerAddr.Provider.ForDisplay(), + moduleText, + ), + Subject: passed.InParent.NameRange.Ptr(), + }) + } } } - // Empty configurations are no longer needed + // Empty configurations are no longer needed. Since the replacement for + // this calls for one entry per provider rather than one entry per + // provider _configuration_, we'll first gather them up by provider + // and then report a single warning for each, whereby we can show a direct + // example of what the replacement should look like. + type ProviderReqSuggestion struct { + SourceAddr addrs.Provider + SourceRanges []hcl.Range + RequiredConfigs []string + AliasCount int + } + providerReqSuggestions := make(map[string]*ProviderReqSuggestion) for name, src := range emptyConfigs { - detail := fmt.Sprintf("Remove the %s provider block from %s.", name, cfg.Path) + providerLocalName := name + if idx := strings.IndexByte(providerLocalName, '.'); idx >= 0 { + providerLocalName = providerLocalName[:idx] + } - isAlias := strings.Contains(name, ".") - _, isConfigAlias := configAliases[name] - _, isLocalName := localNames[name] + sourceAddr, ok := localNames[name] + if !ok { + sourceAddr = addrs.NewDefaultProvider(providerLocalName) + } - if isAlias && !isConfigAlias { - localName := strings.Split(name, ".")[0] - detail = fmt.Sprintf("Remove the %s provider block from %s. Add %s to the list of configuration_aliases for %s in required_providers to define the provider configuration name.", name, cfg.Path, name, localName) + suggestion := providerReqSuggestions[providerLocalName] + if suggestion == nil { + providerReqSuggestions[providerLocalName] = &ProviderReqSuggestion{ + SourceAddr: sourceAddr, + } + suggestion = providerReqSuggestions[providerLocalName] } - if !isAlias && !isLocalName { - // if there is no local name, add a note to include it in the - // required_provider block - detail += fmt.Sprintf("\nTo ensure the correct provider configuration is used, add %s to the required_providers configuration", name) + if providerLocalName != name { + // It's an aliased provider config, then. + suggestion.AliasCount++ } + suggestion.RequiredConfigs = append(suggestion.RequiredConfigs, name) + suggestion.SourceRanges = append(suggestion.SourceRanges, src) + } + for name, suggestion := range providerReqSuggestions { + var buf strings.Builder + + fmt.Fprintf( + &buf, + "Earlier versions of Terraform used empty provider blocks (\"proxy provider configurations\") for child modules to declare their need to be passed a provider configuration by their callers. That approach was ambiguous and is now deprecated.\n\nIf you control this module, you can migrate to the new declaration syntax by removing all of the empty provider %q blocks and then adding or updating an entry like the following to the required_providers block of %s:\n", + name, moduleText, + ) + fmt.Fprintf(&buf, " %s = {\n", name) + fmt.Fprintf(&buf, " source = %q\n", suggestion.SourceAddr.ForDisplay()) + if suggestion.AliasCount > 0 { + // A lexical sort is fine because all of these strings are + // guaranteed to start with the same provider local name, and + // so we're only really sorting by the alias part. + sort.Strings(suggestion.RequiredConfigs) + fmt.Fprintln(&buf, " configuration_aliases = [") + for _, addrStr := range suggestion.RequiredConfigs { + fmt.Fprintf(&buf, " %s,\n", addrStr) + } + fmt.Fprintln(&buf, " ]") + + } + fmt.Fprint(&buf, " }") + + // We're arbitrarily going to just take the one source range that + // sorts earliest here. Multiple should be rare, so this is only to + // ensure that we produce a deterministic result in the edge case. + sort.Slice(suggestion.SourceRanges, func(i, j int) bool { + return suggestion.SourceRanges[i].String() < suggestion.SourceRanges[j].String() + }) diags = append(diags, &hcl.Diagnostic{ Severity: hcl.DiagWarning, - Summary: "Empty provider configuration blocks are not required", - Detail: detail, - Subject: src, + Summary: "Redundant empty provider block", + Detail: buf.String(), + Subject: suggestion.SourceRanges[0].Ptr(), }) } diff --git a/internal/configs/testdata/config-diagnostics/empty-configs/warnings b/internal/configs/testdata/config-diagnostics/empty-configs/warnings index dcf6736e9313..d2fe48dd532d 100644 --- a/internal/configs/testdata/config-diagnostics/empty-configs/warnings +++ b/internal/configs/testdata/config-diagnostics/empty-configs/warnings @@ -1,4 +1,4 @@ -empty-configs/mod/main.tf:10,1-15: Empty provider configuration blocks are not required; Remove the foo provider block from module.mod -empty-configs/mod/main.tf:13,1-15: Empty provider configuration blocks are not required; Remove the foo.bar provider block from module.mod -empty-configs/mod/main.tf:17,1-15: Empty provider configuration blocks are not required; Remove the baz provider block from module.mod.\nTo ensure the correct provider configuration is used, add baz to the required_providers configuration -empty-configs/mod/main.tf:20,1-15: Empty provider configuration blocks are not required; Remove the baz.bing provider block from module.mod. Add baz.bing to the list of configuration_aliases for baz in required_providers to define the provider configuration name +empty-configs/mod/main.tf:10,1-15: Redundant empty provider block; Earlier versions of Terraform used empty provider blocks ("proxy provider configurations") for child modules to declare their need to be passed a provider configuration by their callers. That approach was ambiguous and is now deprecated. +If you control this module, you can migrate to the new declaration syntax by removing all of the empty provider "foo" blocks and then adding or updating an entry like the following to the required_providers block of module.mod: +empty-configs/mod/main.tf:17,1-15: Redundant empty provider block; Earlier versions of Terraform used empty provider blocks ("proxy provider configurations") for child modules to declare their need to be passed a provider configuration by their callers. That approach was ambiguous and is now deprecated. +If you control this module, you can migrate to the new declaration syntax by removing all of the empty provider "baz" blocks and then adding or updating an entry like the following to the required_providers block of module.mod: diff --git a/internal/configs/testdata/config-diagnostics/incorrect-type/errors b/internal/configs/testdata/config-diagnostics/incorrect-type/errors index 28b2108506f9..97a31fe526e7 100644 --- a/internal/configs/testdata/config-diagnostics/incorrect-type/errors +++ b/internal/configs/testdata/config-diagnostics/incorrect-type/errors @@ -1 +1 @@ -incorrect-type/main.tf:15,5-8: Invalid type for provider module.mod.provider["example.com/vendor/foo"]; Cannot use configuration from provider["registry.terraform.io/hashicorp/foo"] for module.mod.provider["example.com/vendor/foo"] +incorrect-type/main.tf:15,11-14: Provider type mismatch; The local name "foo" in the root module represents provider "hashicorp/foo", but "foo" in module.mod represents "example.com/vendor/foo". diff --git a/internal/configs/testdata/config-diagnostics/incorrect-type/warnings b/internal/configs/testdata/config-diagnostics/incorrect-type/warnings index a87f1f7421c8..1e35e8896c93 100644 --- a/internal/configs/testdata/config-diagnostics/incorrect-type/warnings +++ b/internal/configs/testdata/config-diagnostics/incorrect-type/warnings @@ -1 +1 @@ -incorrect-type/main.tf:16,5-8: Provider baz is undefined; Module module.mod does not declare a provider named baz.\nIf you wish to specify a provider configuration for the module +incorrect-type/main.tf:16,5-8: Reference to undefined provider; There is no explicit declaration for local provider name "baz" in module.mod, so Terraform is assuming you mean to pass a configuration for "hashicorp/baz". diff --git a/internal/configs/testdata/config-diagnostics/invalid-provider/warnings b/internal/configs/testdata/config-diagnostics/invalid-provider/warnings deleted file mode 100644 index 8bdc68eebf85..000000000000 --- a/internal/configs/testdata/config-diagnostics/invalid-provider/warnings +++ /dev/null @@ -1 +0,0 @@ -Empty provider configuration blocks are not required diff --git a/internal/configs/testdata/config-diagnostics/nested-provider/errors b/internal/configs/testdata/config-diagnostics/nested-provider/errors index 8f44cac78f13..df929d81f7cc 100644 --- a/internal/configs/testdata/config-diagnostics/nested-provider/errors +++ b/internal/configs/testdata/config-diagnostics/nested-provider/errors @@ -1,3 +1 @@ -Module module.child.module.child2 contains provider configuration; Providers cannot be configured within modules using count, for_each or depends_on - - +nested-provider/root.tf:2,11-12: Module is incompatible with count, for_each, and depends_on; The module at module.child.module.child2 is a legacy module which contains its own local provider configurations, and so calls to it may not use the count, for_each, or depends_on arguments. diff --git a/internal/configs/testdata/config-diagnostics/override-provider/errors b/internal/configs/testdata/config-diagnostics/override-provider/errors index a8d59d6e5697..6529dd959706 100644 --- a/internal/configs/testdata/config-diagnostics/override-provider/errors +++ b/internal/configs/testdata/config-diagnostics/override-provider/errors @@ -1 +1 @@ -override-provider/main.tf:17,5-8: Cannot override provider configuration; Provider bar is configured within the module module.mod and cannot be overridden. +override-provider/main.tf:17,5-8: Cannot override provider configuration; The configuration of module.mod has its own local configuration for bar, and so it cannot accept an overridden configuration provided by the root module. diff --git a/internal/configs/testdata/config-diagnostics/pass-inherited-provider/main.tf b/internal/configs/testdata/config-diagnostics/pass-inherited-provider/main.tf index 76456399c5bc..aa4b7e9f7ac9 100644 --- a/internal/configs/testdata/config-diagnostics/pass-inherited-provider/main.tf +++ b/internal/configs/testdata/config-diagnostics/pass-inherited-provider/main.tf @@ -5,3 +5,19 @@ provider "test" { module "mod" { source = "./mod" } + +# FIXME: This test is for an awkward interaction that we've preserved for +# compatibility with what was arguably a bug in earlier versions: if a +# child module tries to use an inherited provider configuration explicitly by +# name then Terraform would historically use the wrong provider configuration. +# +# Since we weren't able to address that bug without breaking backward +# compatibility, instead we emit a warning to prompt the author to be explicit, +# passing in the configuration they intend to use. +# +# This case is particularly awkward because a change in the child module +# (previously referring to a provider only implicitly, but now naming it +# explicitly) can cause a required change in _this_ module (the caller), +# even though the author of the child module would've seen no explicit warning +# that they were making a breaking change. Hopefully we can improve on this +# in a future language edition. diff --git a/internal/configs/testdata/config-diagnostics/pass-inherited-provider/warnings b/internal/configs/testdata/config-diagnostics/pass-inherited-provider/warnings index fee53bc4f03b..692e14ecf6d3 100644 --- a/internal/configs/testdata/config-diagnostics/pass-inherited-provider/warnings +++ b/internal/configs/testdata/config-diagnostics/pass-inherited-provider/warnings @@ -1 +1 @@ -pass-inherited-provider/mod/main.tf:15,16-20: No configuration passed in for provider test in module.mod; Provider test is referenced within module.mod, but no configuration has been supplied +pass-inherited-provider/main.tf:5,1-13: Missing required provider configuration; The configuration for module.mod expects to inherit a configuration for provider hashicorp/test with local name "test", but the root module doesn't pass a configuration under that name. diff --git a/internal/configs/testdata/config-diagnostics/required-alias/errors b/internal/configs/testdata/config-diagnostics/required-alias/errors index a1b944a43be7..b010244325b9 100644 --- a/internal/configs/testdata/config-diagnostics/required-alias/errors +++ b/internal/configs/testdata/config-diagnostics/required-alias/errors @@ -1 +1 @@ -required-alias/main.tf:1,1-13: No configuration for provider foo.bar; Configuration required for module.mod.provider["registry.terraform.io/hashicorp/foo"].bar +required-alias/main.tf:1,1-13: Missing required provider configuration; The child module requires an additional configuration for provider hashicorp/foo, with the local name "foo.bar". diff --git a/internal/configs/testdata/config-diagnostics/unexpected-provider/warnings b/internal/configs/testdata/config-diagnostics/unexpected-provider/warnings index 0e41b39a94cb..82be3b70969d 100644 --- a/internal/configs/testdata/config-diagnostics/unexpected-provider/warnings +++ b/internal/configs/testdata/config-diagnostics/unexpected-provider/warnings @@ -1,2 +1 @@ -unexpected-provider/main.tf:13,5-8: Provider foo is undefined; Module module.mod does not declare a provider named foo. - +unexpected-provider/main.tf:13,5-8: Reference to undefined provider; There is no explicit declaration for local provider name "foo" in module.mod, so Terraform is assuming you mean to pass a configuration for "hashicorp/foo". diff --git a/internal/configs/testdata/config-diagnostics/unknown-root-provider/warnings b/internal/configs/testdata/config-diagnostics/unknown-root-provider/warnings index 766670d93d6e..4d85a512cb05 100644 --- a/internal/configs/testdata/config-diagnostics/unknown-root-provider/warnings +++ b/internal/configs/testdata/config-diagnostics/unknown-root-provider/warnings @@ -1 +1 @@ -unknown-root-provider/main.tf:5,11-14: Provider bar is undefined; No provider named bar has been declared in the root module +unknown-root-provider/main.tf:5,11-14: Reference to undefined provider; There is no explicit declaration for local provider name "bar" in the root module, so Terraform is assuming you mean to pass a configuration for provider "hashicorp/bar". From 2aa1613c1915a984adbbc7a9950105f05ea9c600 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 10 Mar 2022 10:07:33 -0800 Subject: [PATCH 635/644] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 126babcaed6f..b8632ad3a6c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ ENHANCEMENTS: * The "Invalid for_each argument" error message for unknown maps/sets now includes an additional paragraph to try to help the user notice they can move apply-time values into the map _values_ instead of the map _keys_, and thus avoid the problem without resorting to `-target`. [GH-30327] * When showing the progress of a remote operation running in Terraform Cloud, Terraform CLI will include information about post-plan [run tasks](https://www.terraform.io/cloud-docs/workspaces/settings/run-tasks). [GH-30141] * Error messages for preconditions, postconditions, and custom variable validations are now evaluated as expressions, allowing interpolation of relevant values into the output. [GH-30613] +* There are some small improvements to the error and warning messages Terraform will emit in the case of invalid provider configuration passing between modules. There are no changes to which situations will produce errors and warnings, but the messages now include additional information intended to clarify what problem Terraform is describing and how to address it. [GH-30639] BUG FIXES: From ad995322e1f36ba148a67de16082b0edbbdeeb11 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 10 Mar 2022 13:46:40 -0500 Subject: [PATCH 636/644] core: Fix expanded condition block validation The previous precondition/postcondition block validation implementation failed if the enclosing resource was expanded. This commit fixes this by generating appropriate placeholder instance data for the resource, depending on whether `count` or `for_each` is used. --- internal/terraform/context_validate_test.go | 94 ++++++++++++++++++++ internal/terraform/node_resource_validate.go | 77 ++++++++++++---- 2 files changed, 156 insertions(+), 15 deletions(-) diff --git a/internal/terraform/context_validate_test.go b/internal/terraform/context_validate_test.go index c049b17cec22..5b6b98da8e16 100644 --- a/internal/terraform/context_validate_test.go +++ b/internal/terraform/context_validate_test.go @@ -2385,3 +2385,97 @@ resource "aws_instance" "test" { t.Errorf("unexpected error.\ngot: %s\nshould contain: %q", got, want) } } + +func TestContext2Validate_precondition_count(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +locals { + foos = ["bar", "baz"] +} + +resource "aws_instance" "test" { + count = 3 + foo = local.foos[count.index] + + lifecycle { + precondition { + condition = count.index < length(local.foos) + error_message = "Insufficient foos." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if diags.HasErrors() { + t.Fatal(diags.ErrWithWarnings()) + } +} + +func TestContext2Validate_postcondition_forEach(t *testing.T) { + p := testProvider("aws") + p.GetProviderSchemaResponse = getProviderSchemaResponseFromProviderSchema(&ProviderSchema{ + ResourceTypes: map[string]*configschema.Block{ + "aws_instance": { + Attributes: map[string]*configschema.Attribute{ + "foo": {Type: cty.String, Optional: true}, + }, + }, + }, + }) + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +locals { + foos = toset(["bar", "baz", "boop"]) +} + +resource "aws_instance" "test" { + for_each = local.foos + foo = "foo" + + lifecycle { + postcondition { + condition = length(each.value) == 3 + error_message = "Short foo required, not \"${each.key}\"." + } + } +} + `, + }) + + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("aws"): testProviderFuncFixed(p), + }, + }) + + diags := ctx.Validate(m) + if diags.HasErrors() { + t.Fatal(diags.ErrWithWarnings()) + } +} diff --git a/internal/terraform/node_resource_validate.go b/internal/terraform/node_resource_validate.go index 4f316906db25..41c1231ca077 100644 --- a/internal/terraform/node_resource_validate.go +++ b/internal/terraform/node_resource_validate.go @@ -9,6 +9,8 @@ import ( "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/configs/configschema" "github.com/hashicorp/terraform/internal/didyoumean" + "github.com/hashicorp/terraform/internal/instances" + "github.com/hashicorp/terraform/internal/lang" "github.com/hashicorp/terraform/internal/providers" "github.com/hashicorp/terraform/internal/provisioners" "github.com/hashicorp/terraform/internal/tfdiags" @@ -41,17 +43,7 @@ func (n *NodeValidatableResource) Path() addrs.ModuleInstance { func (n *NodeValidatableResource) Execute(ctx EvalContext, op walkOperation) (diags tfdiags.Diagnostics) { diags = diags.Append(n.validateResource(ctx)) - var self addrs.Referenceable - switch { - case n.Config.Count != nil: - self = n.Addr.Resource.Instance(addrs.IntKey(0)) - case n.Config.ForEach != nil: - self = n.Addr.Resource.Instance(addrs.StringKey("")) - default: - self = n.Addr.Resource.Instance(addrs.NoKey) - } - diags = diags.Append(validateCheckRules(ctx, n.Config.Preconditions, nil)) - diags = diags.Append(validateCheckRules(ctx, n.Config.Postconditions, self)) + diags = diags.Append(n.validateCheckRules(ctx, n.Config)) if managed := n.Config.Managed; managed != nil { hasCount := n.Config.Count != nil @@ -478,14 +470,69 @@ func (n *NodeValidatableResource) validateResource(ctx EvalContext) tfdiags.Diag return diags } -func validateCheckRules(ctx EvalContext, crs []*configs.CheckRule, self addrs.Referenceable) tfdiags.Diagnostics { +func (n *NodeValidatableResource) evaluateExpr(ctx EvalContext, expr hcl.Expression, wantTy cty.Type, self addrs.Referenceable, keyData instances.RepetitionData) (cty.Value, tfdiags.Diagnostics) { + var diags tfdiags.Diagnostics + + refs, refDiags := lang.ReferencesInExpr(expr) + diags = diags.Append(refDiags) + + scope := ctx.EvaluationScope(self, keyData) + + hclCtx, moreDiags := scope.EvalContext(refs) + diags = diags.Append(moreDiags) + + result, hclDiags := expr.Value(hclCtx) + diags = diags.Append(hclDiags) + + return result, diags +} + +func (n *NodeValidatableResource) validateCheckRules(ctx EvalContext, config *configs.Resource) tfdiags.Diagnostics { var diags tfdiags.Diagnostics - for _, cr := range crs { - _, conditionDiags := ctx.EvaluateExpr(cr.Condition, cty.Bool, self) + keyData := EvalDataForNoInstanceKey + selfAddr := n.ResourceAddr().Resource.Instance(addrs.NoKey) + + if n.Config.Count != nil { + // For a resource that has count, we allow count.index but don't + // know at this stage what it will return. + keyData = InstanceKeyEvalData{ + CountIndex: cty.UnknownVal(cty.Number), + } + + // "self" can't point to an unknown key, but we'll force it to be + // key 0 here, which should return an unknown value of the + // expected type since none of these elements are known at this + // point anyway. + selfAddr = n.ResourceAddr().Resource.Instance(addrs.IntKey(0)) + } else if n.Config.ForEach != nil { + // For a resource that has for_each, we allow each.value and each.key + // but don't know at this stage what it will return. + keyData = InstanceKeyEvalData{ + EachKey: cty.UnknownVal(cty.String), + EachValue: cty.DynamicVal, + } + + // "self" can't point to an unknown key, but we'll force it to be + // key "" here, which should return an unknown value of the + // expected type since none of these elements are known at + // this point anyway. + selfAddr = n.ResourceAddr().Resource.Instance(addrs.StringKey("")) + } + + for _, cr := range config.Preconditions { + _, conditionDiags := n.evaluateExpr(ctx, cr.Condition, cty.Bool, nil, keyData) + diags = diags.Append(conditionDiags) + + _, errorMessageDiags := n.evaluateExpr(ctx, cr.ErrorMessage, cty.Bool, nil, keyData) + diags = diags.Append(errorMessageDiags) + } + + for _, cr := range config.Postconditions { + _, conditionDiags := n.evaluateExpr(ctx, cr.Condition, cty.Bool, selfAddr, keyData) diags = diags.Append(conditionDiags) - _, errorMessageDiags := ctx.EvaluateExpr(cr.ErrorMessage, cty.String, self) + _, errorMessageDiags := n.evaluateExpr(ctx, cr.ErrorMessage, cty.Bool, selfAddr, keyData) diags = diags.Append(errorMessageDiags) } From ef0d859af761f2b25140fc051d067a461db733f4 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 10 Mar 2022 13:52:03 -0500 Subject: [PATCH 637/644] core: Refactor stub repetition data generation --- internal/terraform/node_resource_validate.go | 55 +++++-------------- .../terraform/node_resource_validate_test.go | 6 +- 2 files changed, 18 insertions(+), 43 deletions(-) diff --git a/internal/terraform/node_resource_validate.go b/internal/terraform/node_resource_validate.go index 41c1231ca077..867cfc25723e 100644 --- a/internal/terraform/node_resource_validate.go +++ b/internal/terraform/node_resource_validate.go @@ -46,9 +46,6 @@ func (n *NodeValidatableResource) Execute(ctx EvalContext, op walkOperation) (di diags = diags.Append(n.validateCheckRules(ctx, n.Config)) if managed := n.Config.Managed; managed != nil { - hasCount := n.Config.Count != nil - hasForEach := n.Config.ForEach != nil - // Validate all the provisioners for _, p := range managed.Provisioners { if p.Connection == nil { @@ -58,7 +55,7 @@ func (n *NodeValidatableResource) Execute(ctx EvalContext, op walkOperation) (di } // Validate Provisioner Config - diags = diags.Append(n.validateProvisioner(ctx, p, hasCount, hasForEach)) + diags = diags.Append(n.validateProvisioner(ctx, p)) if diags.HasErrors() { return diags } @@ -70,7 +67,7 @@ func (n *NodeValidatableResource) Execute(ctx EvalContext, op walkOperation) (di // validateProvisioner validates the configuration of a provisioner belonging to // a resource. The provisioner config is expected to contain the merged // connection configurations. -func (n *NodeValidatableResource) validateProvisioner(ctx EvalContext, p *configs.Provisioner, hasCount, hasForEach bool) tfdiags.Diagnostics { +func (n *NodeValidatableResource) validateProvisioner(ctx EvalContext, p *configs.Provisioner) tfdiags.Diagnostics { var diags tfdiags.Diagnostics provisioner, err := ctx.Provisioner(p.Type) @@ -91,7 +88,7 @@ func (n *NodeValidatableResource) validateProvisioner(ctx EvalContext, p *config } // Validate the provisioner's own config first - configVal, _, configDiags := n.evaluateBlock(ctx, p.Config, provisionerSchema, hasCount, hasForEach) + configVal, _, configDiags := n.evaluateBlock(ctx, p.Config, provisionerSchema) diags = diags.Append(configDiags) if configVal == cty.NilVal { @@ -115,42 +112,14 @@ func (n *NodeValidatableResource) validateProvisioner(ctx EvalContext, p *config // configuration keys that are not valid for *any* communicator, catching // typos early rather than waiting until we actually try to run one of // the resource's provisioners. - _, _, connDiags := n.evaluateBlock(ctx, p.Connection.Config, connectionBlockSupersetSchema, hasCount, hasForEach) + _, _, connDiags := n.evaluateBlock(ctx, p.Connection.Config, connectionBlockSupersetSchema) diags = diags.Append(connDiags) } return diags } -func (n *NodeValidatableResource) evaluateBlock(ctx EvalContext, body hcl.Body, schema *configschema.Block, hasCount, hasForEach bool) (cty.Value, hcl.Body, tfdiags.Diagnostics) { - keyData := EvalDataForNoInstanceKey - selfAddr := n.ResourceAddr().Resource.Instance(addrs.NoKey) - - if hasCount { - // For a resource that has count, we allow count.index but don't - // know at this stage what it will return. - keyData = InstanceKeyEvalData{ - CountIndex: cty.UnknownVal(cty.Number), - } - - // "self" can't point to an unknown key, but we'll force it to be - // key 0 here, which should return an unknown value of the - // expected type since none of these elements are known at this - // point anyway. - selfAddr = n.ResourceAddr().Resource.Instance(addrs.IntKey(0)) - } else if hasForEach { - // For a resource that has for_each, we allow each.value and each.key - // but don't know at this stage what it will return. - keyData = InstanceKeyEvalData{ - EachKey: cty.UnknownVal(cty.String), - EachValue: cty.DynamicVal, - } - - // "self" can't point to an unknown key, but we'll force it to be - // key "" here, which should return an unknown value of the - // expected type since none of these elements are known at - // this point anyway. - selfAddr = n.ResourceAddr().Resource.Instance(addrs.StringKey("")) - } +func (n *NodeValidatableResource) evaluateBlock(ctx EvalContext, body hcl.Body, schema *configschema.Block) (cty.Value, hcl.Body, tfdiags.Diagnostics) { + keyData, selfAddr := n.stubRepetitionData(n.Config.Count != nil, n.Config.ForEach != nil) return ctx.EvaluateBlock(body, schema, selfAddr, keyData) } @@ -487,9 +456,7 @@ func (n *NodeValidatableResource) evaluateExpr(ctx EvalContext, expr hcl.Express return result, diags } -func (n *NodeValidatableResource) validateCheckRules(ctx EvalContext, config *configs.Resource) tfdiags.Diagnostics { - var diags tfdiags.Diagnostics - +func (n *NodeValidatableResource) stubRepetitionData(hasCount, hasForEach bool) (instances.RepetitionData, addrs.Referenceable) { keyData := EvalDataForNoInstanceKey selfAddr := n.ResourceAddr().Resource.Instance(addrs.NoKey) @@ -520,6 +487,14 @@ func (n *NodeValidatableResource) validateCheckRules(ctx EvalContext, config *co selfAddr = n.ResourceAddr().Resource.Instance(addrs.StringKey("")) } + return keyData, selfAddr +} + +func (n *NodeValidatableResource) validateCheckRules(ctx EvalContext, config *configs.Resource) tfdiags.Diagnostics { + var diags tfdiags.Diagnostics + + keyData, selfAddr := n.stubRepetitionData(n.Config.Count != nil, n.Config.ForEach != nil) + for _, cr := range config.Preconditions { _, conditionDiags := n.evaluateExpr(ctx, cr.Condition, cty.Bool, nil, keyData) diags = diags.Append(conditionDiags) diff --git a/internal/terraform/node_resource_validate_test.go b/internal/terraform/node_resource_validate_test.go index d0e08c7306d7..b5b2af74cd29 100644 --- a/internal/terraform/node_resource_validate_test.go +++ b/internal/terraform/node_resource_validate_test.go @@ -51,7 +51,7 @@ func TestNodeValidatableResource_ValidateProvisioner_valid(t *testing.T) { }, } - diags := node.validateProvisioner(ctx, pc, false, false) + diags := node.validateProvisioner(ctx, pc) if diags.HasErrors() { t.Fatalf("node.Eval failed: %s", diags.Err()) } @@ -96,7 +96,7 @@ func TestNodeValidatableResource_ValidateProvisioner__warning(t *testing.T) { } } - diags := node.validateProvisioner(ctx, pc, false, false) + diags := node.validateProvisioner(ctx, pc) if len(diags) != 1 { t.Fatalf("wrong number of diagnostics in %s; want one warning", diags.ErrWithWarnings()) } @@ -141,7 +141,7 @@ func TestNodeValidatableResource_ValidateProvisioner__connectionInvalid(t *testi }, } - diags := node.validateProvisioner(ctx, pc, false, false) + diags := node.validateProvisioner(ctx, pc) if !diags.HasErrors() { t.Fatalf("node.Eval succeeded; want error") } From cfe6e5168a759c6bc2a846850771c7318dc11193 Mon Sep 17 00:00:00 2001 From: Till Hoffmann Date: Fri, 11 Mar 2022 13:06:28 +0100 Subject: [PATCH 638/644] Add type of resource id --- website/docs/cli/import/usage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/import/usage.mdx b/website/docs/cli/import/usage.mdx index e5d448990ba8..7610fa68a61e 100644 --- a/website/docs/cli/import/usage.mdx +++ b/website/docs/cli/import/usage.mdx @@ -46,7 +46,7 @@ resource configuration: $ terraform import aws_instance.example i-abcd1234 ``` -This command locates the AWS instance with ID `i-abcd1234`. Then it attaches +This command locates the AWS EC2 instance with ID `i-abcd1234`. Then it attaches the existing settings of the instance, as described by the EC2 API, to the name `aws_instance.example` of a module. In this example the module path implies that the root module is used. Finally, the mapping is saved in the From c847e6634f296d631b0488e3bbe6b018b7aff011 Mon Sep 17 00:00:00 2001 From: Till Hoffmann Date: Fri, 11 Mar 2022 13:07:28 +0100 Subject: [PATCH 639/644] Add type of resource id --- website/docs/cli/commands/import.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/import.mdx b/website/docs/cli/commands/import.mdx index ed2e5df9e178..97476f66bd53 100644 --- a/website/docs/cli/commands/import.mdx +++ b/website/docs/cli/commands/import.mdx @@ -22,7 +22,7 @@ ADDRESS must be a valid [resource address](/cli/state/resource-addressing). Because any resource address is valid, the import command can import resources into modules as well as directly into the root of your state. -ID is dependent on the resource type being imported. For example, for AWS +ID is dependent on the resource type being imported. For example, for AWS EC2 instances it is the instance ID (`i-abcd1234`) but for AWS Route53 zones it is the zone ID (`Z12ABC4UGMOZ2N`). Please reference the provider documentation for details on the ID format. If you're unsure, feel free to just try an ID. If the ID From 0bc69d64ec124e82400460ea3141b303fa28d5b1 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 11 Mar 2022 09:31:24 -0500 Subject: [PATCH 640/644] always validate all graphs Complete the removal of the Validate option for graph building. There is no case where we want to allow an invalid graph, as the primary reason for validation is to ensure we have no cycles, and we can't walk a graph with cycles. The only code which specifically relied on there being no validation was a test to ensure the Validate flag prevented it. --- internal/terraform/context_apply.go | 1 - internal/terraform/graph_builder.go | 14 +++++--------- internal/terraform/graph_builder_apply.go | 8 ++------ internal/terraform/graph_builder_destroy_plan.go | 8 ++------ internal/terraform/graph_builder_eval.go | 5 ++--- internal/terraform/graph_builder_import.go | 5 ++--- internal/terraform/graph_builder_test.go | 16 ---------------- internal/terraform/node_resource_plan.go | 5 ++--- 8 files changed, 15 insertions(+), 47 deletions(-) diff --git a/internal/terraform/context_apply.go b/internal/terraform/context_apply.go index d3cd9dc2d575..fdc835f3075b 100644 --- a/internal/terraform/context_apply.go +++ b/internal/terraform/context_apply.go @@ -110,7 +110,6 @@ func (c *Context) applyGraph(plan *plans.Plan, config *configs.Config, validate Plugins: c.plugins, Targets: plan.TargetAddrs, ForceReplace: plan.ForceReplaceAddrs, - Validate: validate, }).Build(addrs.RootModuleInstance) diags = diags.Append(moreDiags) if moreDiags.HasErrors() { diff --git a/internal/terraform/graph_builder.go b/internal/terraform/graph_builder.go index 9d0cadde41c3..1c69ee41f82d 100644 --- a/internal/terraform/graph_builder.go +++ b/internal/terraform/graph_builder.go @@ -21,8 +21,7 @@ type GraphBuilder interface { // series of transforms and (optionally) validates the graph is a valid // structure. type BasicGraphBuilder struct { - Steps []GraphTransformer - Validate bool + Steps []GraphTransformer // Optional name to add to the graph debug log Name string } @@ -56,13 +55,10 @@ func (b *BasicGraphBuilder) Build(path addrs.ModuleInstance) (*Graph, tfdiags.Di } } - // Validate the graph structure - if b.Validate { - if err := g.Validate(); err != nil { - log.Printf("[ERROR] Graph validation failed. Graph:\n\n%s", g.String()) - diags = diags.Append(err) - return nil, diags - } + if err := g.Validate(); err != nil { + log.Printf("[ERROR] Graph validation failed. Graph:\n\n%s", g.String()) + diags = diags.Append(err) + return nil, diags } return g, diags diff --git a/internal/terraform/graph_builder_apply.go b/internal/terraform/graph_builder_apply.go index 86d825560276..eea3235cd1ab 100644 --- a/internal/terraform/graph_builder_apply.go +++ b/internal/terraform/graph_builder_apply.go @@ -46,17 +46,13 @@ type ApplyGraphBuilder struct { // The apply step refers to these as part of verifying that the planned // actions remain consistent between plan and apply. ForceReplace []addrs.AbsResourceInstance - - // Validate will do structural validation of the graph. - Validate bool } // See GraphBuilder func (b *ApplyGraphBuilder) Build(path addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics) { return (&BasicGraphBuilder{ - Steps: b.Steps(), - Validate: b.Validate, - Name: "ApplyGraphBuilder", + Steps: b.Steps(), + Name: "ApplyGraphBuilder", }).Build(path) } diff --git a/internal/terraform/graph_builder_destroy_plan.go b/internal/terraform/graph_builder_destroy_plan.go index def1aa3739aa..ade01c629bdc 100644 --- a/internal/terraform/graph_builder_destroy_plan.go +++ b/internal/terraform/graph_builder_destroy_plan.go @@ -35,9 +35,6 @@ type DestroyPlanGraphBuilder struct { // Targets are resources to target Targets []addrs.Targetable - // Validate will do structural validation of the graph. - Validate bool - // If set, skipRefresh will cause us stop skip refreshing any existing // resource instances as part of our planning. This will cause us to fail // to detect if an object has already been deleted outside of Terraform. @@ -47,9 +44,8 @@ type DestroyPlanGraphBuilder struct { // See GraphBuilder func (b *DestroyPlanGraphBuilder) Build(path addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics) { return (&BasicGraphBuilder{ - Steps: b.Steps(), - Validate: b.Validate, - Name: "DestroyPlanGraphBuilder", + Steps: b.Steps(), + Name: "DestroyPlanGraphBuilder", }).Build(path) } diff --git a/internal/terraform/graph_builder_eval.go b/internal/terraform/graph_builder_eval.go index 78031e21f9f3..4e205045f7a3 100644 --- a/internal/terraform/graph_builder_eval.go +++ b/internal/terraform/graph_builder_eval.go @@ -43,9 +43,8 @@ type EvalGraphBuilder struct { // See GraphBuilder func (b *EvalGraphBuilder) Build(path addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics) { return (&BasicGraphBuilder{ - Steps: b.Steps(), - Validate: true, - Name: "EvalGraphBuilder", + Steps: b.Steps(), + Name: "EvalGraphBuilder", }).Build(path) } diff --git a/internal/terraform/graph_builder_import.go b/internal/terraform/graph_builder_import.go index d8d609ebaa85..79c0724f76d0 100644 --- a/internal/terraform/graph_builder_import.go +++ b/internal/terraform/graph_builder_import.go @@ -30,9 +30,8 @@ type ImportGraphBuilder struct { // Build builds the graph according to the steps returned by Steps. func (b *ImportGraphBuilder) Build(path addrs.ModuleInstance) (*Graph, tfdiags.Diagnostics) { return (&BasicGraphBuilder{ - Steps: b.Steps(), - Validate: true, - Name: "ImportGraphBuilder", + Steps: b.Steps(), + Name: "ImportGraphBuilder", }).Build(path) } diff --git a/internal/terraform/graph_builder_test.go b/internal/terraform/graph_builder_test.go index 91d703f42cb0..414fc0b8d766 100644 --- a/internal/terraform/graph_builder_test.go +++ b/internal/terraform/graph_builder_test.go @@ -42,7 +42,6 @@ func TestBasicGraphBuilder_validate(t *testing.T) { &testBasicGraphBuilderTransform{1}, &testBasicGraphBuilderTransform{2}, }, - Validate: true, } _, err := b.Build(addrs.RootModuleInstance) @@ -51,21 +50,6 @@ func TestBasicGraphBuilder_validate(t *testing.T) { } } -func TestBasicGraphBuilder_validateOff(t *testing.T) { - b := &BasicGraphBuilder{ - Steps: []GraphTransformer{ - &testBasicGraphBuilderTransform{1}, - &testBasicGraphBuilderTransform{2}, - }, - Validate: false, - } - - _, err := b.Build(addrs.RootModuleInstance) - if err != nil { - t.Fatalf("expected no error, got: %s", err) - } -} - type testBasicGraphBuilderTransform struct { V dag.Vertex } diff --git a/internal/terraform/node_resource_plan.go b/internal/terraform/node_resource_plan.go index a9f3ca0e5dfd..5a01d9337dcf 100644 --- a/internal/terraform/node_resource_plan.go +++ b/internal/terraform/node_resource_plan.go @@ -390,9 +390,8 @@ func (n *NodePlannableResource) DynamicExpand(ctx EvalContext) (*Graph, error) { // Build the graph b := &BasicGraphBuilder{ - Steps: steps, - Validate: true, - Name: "NodePlannableResource", + Steps: steps, + Name: "NodePlannableResource", } graph, diags := b.Build(ctx.Path()) return graph, diags.ErrWithWarnings() From b1de94a1768cfecdd31d7b065976cc4bc8dafa16 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 11 Mar 2022 09:33:33 -0500 Subject: [PATCH 641/644] make sure CBD test graphs are valid The graphs used for the CBD tests wouldn't validate because they skipped adding the root module node. Re add the root module transformer and transitive reduction transformer to the build steps, and match the new reduced output in the test fixtures. --- internal/terraform/transform_destroy_cbd_test.go | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/internal/terraform/transform_destroy_cbd_test.go b/internal/terraform/transform_destroy_cbd_test.go index 629ca54778be..8f5712b57449 100644 --- a/internal/terraform/transform_destroy_cbd_test.go +++ b/internal/terraform/transform_destroy_cbd_test.go @@ -46,7 +46,12 @@ func cbdTestSteps(steps []GraphTransformer) []GraphTransformer { panic("CBDEdgeTransformer not found") } - return steps[:i+1] + // re-add the root node so we have a valid graph for a walk, then reduce + // the graph for less output + steps = append(steps[:i+1], &CloseRootModuleTransformer{}) + steps = append(steps, &TransitiveReductionTransformer{}) + + return steps } // remove extra nodes for easier test comparisons @@ -105,7 +110,6 @@ func TestCBDEdgeTransformer(t *testing.T) { expected := regexp.MustCompile(strings.TrimSpace(` (?m)test_object.A test_object.A \(destroy deposed \w+\) - test_object.A test_object.B test_object.B test_object.A @@ -178,11 +182,9 @@ func TestCBDEdgeTransformerMulti(t *testing.T) { expected := regexp.MustCompile(strings.TrimSpace(` (?m)test_object.A test_object.A \(destroy deposed \w+\) - test_object.A test_object.C test_object.B test_object.B \(destroy deposed \w+\) - test_object.B test_object.C test_object.C test_object.A @@ -253,7 +255,6 @@ func TestCBDEdgeTransformer_depNonCBDCount(t *testing.T) { expected := regexp.MustCompile(strings.TrimSpace(` (?m)test_object.A test_object.A \(destroy deposed \w+\) - test_object.A test_object.B\[0\] test_object.B\[1\] test_object.B\[0\] @@ -339,12 +340,10 @@ func TestCBDEdgeTransformer_depNonCBDCountBoth(t *testing.T) { expected := regexp.MustCompile(strings.TrimSpace(` test_object.A\[0\] test_object.A\[0\] \(destroy deposed \w+\) - test_object.A\[0\] test_object.B\[0\] test_object.B\[1\] test_object.A\[1\] test_object.A\[1\] \(destroy deposed \w+\) - test_object.A\[1\] test_object.B\[0\] test_object.B\[1\] test_object.B\[0\] From a103c65140679e351b6ccd2c2ba12fba2015a2ce Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Wed, 9 Mar 2022 16:04:01 -0500 Subject: [PATCH 642/644] core: Eval pre/postconditions in refresh-only mode Evaluate precondition and postcondition blocks in refresh-only mode, but report any failures as warnings instead of errors. This ensures that any deviation from the contract defined by condition blocks is reported as early as possible, without preventing the completion of a state refresh operation. Prior to this commit, Terraform evaluated output preconditions and data source pre/postconditions as normal in refresh-only mode, while managed resource pre/postconditions were not evaluated at all. This omission could lead to confusing partial condition errors, or failure to detect undesired changes which would otherwise cause resources to become invalid. Reporting the failures as errors also meant that changes retrieved during refresh could cause the refresh operation to fail. This is also undesirable, as the primary purpose of the operation is to update local state. Precondition/postcondition checks are still valuable here, but should be informative rather than blocking. --- internal/terraform/context_plan2_test.go | 248 +++++++++++++++++- internal/terraform/eval_conditions.go | 12 +- internal/terraform/graph_builder_plan.go | 2 +- internal/terraform/node_output.go | 32 ++- .../node_resource_abstract_instance.go | 5 +- .../terraform/node_resource_apply_instance.go | 2 + .../terraform/node_resource_plan_instance.go | 40 ++- internal/terraform/transform_output.go | 24 +- internal/tfdiags/diagnostic.go | 16 ++ internal/tfdiags/hcl.go | 18 +- 10 files changed, 357 insertions(+), 42 deletions(-) diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index ba153230c9bb..e6315c31363c 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -2283,6 +2283,34 @@ resource "test_resource" "a" { } }) + t.Run("precondition fail refresh-only", func(t *testing.T) { + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent(mustResourceInstanceAddr("test_resource.a"), &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"value":"boop","output":"blorp"}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if len(diags) == 0 { + t.Fatalf("no diags, but should have warnings") + } + if got, want := diags.ErrWithWarnings().Error(), "Resource precondition failed: Wrong boop."; got != want { + t.Fatalf("wrong warning:\ngot: %s\nwant: %q", got, want) + } + if !p.ReadResourceCalled { + t.Errorf("Provider's ReadResource wasn't called; should've been") + } + }) + t.Run("postcondition fail", func(t *testing.T) { p.PlanResourceChangeFn = func(req providers.PlanResourceChangeRequest) (resp providers.PlanResourceChangeResponse) { m := req.ProposedNewState.AsValueMap() @@ -2308,7 +2336,108 @@ resource "test_resource" "a" { t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) } if !p.PlanResourceChangeCalled { - t.Errorf("Provider's PlanResourceChangeCalled wasn't called; should've been") + t.Errorf("Provider's PlanResourceChange wasn't called; should've been") + } + }) + + t.Run("postcondition fail refresh-only", func(t *testing.T) { + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent(mustResourceInstanceAddr("test_resource.a"), &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"value":"boop","output":"blorp"}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + p.ReadResourceFn = func(req providers.ReadResourceRequest) (resp providers.ReadResourceResponse) { + newVal, err := cty.Transform(req.PriorState, func(path cty.Path, v cty.Value) (cty.Value, error) { + if len(path) == 1 && path[0] == (cty.GetAttrStep{Name: "output"}) { + return cty.StringVal(""), nil + } + return v, nil + }) + if err != nil { + // shouldn't get here + t.Fatalf("ReadResourceFn transform failed") + return providers.ReadResourceResponse{} + } + return providers.ReadResourceResponse{ + NewState: newVal, + } + } + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if len(diags) == 0 { + t.Fatalf("no diags, but should have warnings") + } + if got, want := diags.ErrWithWarnings().Error(), "Resource postcondition failed: Output must not be blank."; got != want { + t.Fatalf("wrong warning:\ngot: %s\nwant: %q", got, want) + } + if !p.ReadResourceCalled { + t.Errorf("Provider's ReadResource wasn't called; should've been") + } + if p.PlanResourceChangeCalled { + t.Errorf("Provider's PlanResourceChange was called; should'nt've been") + } + }) + + t.Run("precondition and postcondition fail refresh-only", func(t *testing.T) { + state := states.BuildState(func(s *states.SyncState) { + s.SetResourceInstanceCurrent(mustResourceInstanceAddr("test_resource.a"), &states.ResourceInstanceObjectSrc{ + AttrsJSON: []byte(`{"value":"boop","output":"blorp"}`), + Status: states.ObjectReady, + }, mustProviderConfig(`provider["registry.terraform.io/hashicorp/test"]`)) + }) + p.ReadResourceFn = func(req providers.ReadResourceRequest) (resp providers.ReadResourceResponse) { + newVal, err := cty.Transform(req.PriorState, func(path cty.Path, v cty.Value) (cty.Value, error) { + if len(path) == 1 && path[0] == (cty.GetAttrStep{Name: "output"}) { + return cty.StringVal(""), nil + } + return v, nil + }) + if err != nil { + // shouldn't get here + t.Fatalf("ReadResourceFn transform failed") + return providers.ReadResourceResponse{} + } + return providers.ReadResourceResponse{ + NewState: newVal, + } + } + _, diags := ctx.Plan(m, state, &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if got, want := len(diags), 2; got != want { + t.Errorf("wrong number of warnings, got %d, want %d", got, want) + } + warnings := diags.ErrWithWarnings().Error() + wantWarnings := []string{ + "Resource precondition failed: Wrong boop.", + "Resource postcondition failed: Output must not be blank.", + } + for _, want := range wantWarnings { + if !strings.Contains(warnings, want) { + t.Errorf("missing warning:\ngot: %s\nwant to contain: %q", warnings, want) + } + } + if !p.ReadResourceCalled { + t.Errorf("Provider's ReadResource wasn't called; should've been") + } + if p.PlanResourceChangeCalled { + t.Errorf("Provider's PlanResourceChange was called; should'nt've been") } }) } @@ -2432,6 +2561,39 @@ resource "test_resource" "a" { } }) + t.Run("precondition fail refresh-only", func(t *testing.T) { + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if len(diags) == 0 { + t.Fatalf("no diags, but should have warnings") + } + if got, want := diags.ErrWithWarnings().Error(), "Resource precondition failed: Wrong boop."; got != want { + t.Fatalf("wrong warning:\ngot: %s\nwant: %q", got, want) + } + for _, res := range plan.Changes.Resources { + switch res.Addr.String() { + case "test_resource.a": + if res.Action != plans.Create { + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + case "data.test_data_source.a": + if res.Action != plans.Read { + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + default: + t.Fatalf("unexpected %s change for %s", res.Action, res.Addr) + } + } + }) + t.Run("postcondition fail", func(t *testing.T) { p.ReadDataSourceResponse = &providers.ReadDataSourceResponse{ State: cty.ObjectVal(map[string]cty.Value{ @@ -2458,6 +2620,60 @@ resource "test_resource" "a" { t.Errorf("Provider's ReadDataSource wasn't called; should've been") } }) + + t.Run("postcondition fail refresh-only", func(t *testing.T) { + p.ReadDataSourceResponse = &providers.ReadDataSourceResponse{ + State: cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("boop"), + "results": cty.ListValEmpty(cty.String), + }), + } + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("boop"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if got, want := diags.ErrWithWarnings().Error(), "Resource postcondition failed: Results cannot be empty."; got != want { + t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) + } + }) + + t.Run("precondition and postcondition fail refresh-only", func(t *testing.T) { + p.ReadDataSourceResponse = &providers.ReadDataSourceResponse{ + State: cty.ObjectVal(map[string]cty.Value{ + "foo": cty.StringVal("nope"), + "results": cty.ListValEmpty(cty.String), + }), + } + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if got, want := len(diags), 2; got != want { + t.Errorf("wrong number of warnings, got %d, want %d", got, want) + } + warnings := diags.ErrWithWarnings().Error() + wantWarnings := []string{ + "Resource precondition failed: Wrong boop.", + "Resource postcondition failed: Results cannot be empty.", + } + for _, want := range wantWarnings { + if !strings.Contains(warnings, want) { + t.Errorf("missing warning:\ngot: %s\nwant to contain: %q", warnings, want) + } + } + }) } func TestContext2Plan_outputPrecondition(t *testing.T) { @@ -2530,6 +2746,36 @@ output "a" { t.Fatalf("wrong error:\ngot: %s\nwant: %q", got, want) } }) + + t.Run("condition fail refresh-only", func(t *testing.T) { + plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.RefreshOnlyMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("nope"), + SourceType: ValueFromCLIArg, + }, + }, + }) + assertNoErrors(t, diags) + if len(diags) == 0 { + t.Fatalf("no diags, but should have warnings") + } + if got, want := diags.ErrWithWarnings().Error(), "Module output value precondition failed: Wrong boop."; got != want { + t.Errorf("wrong warning:\ngot: %s\nwant: %q", got, want) + } + addr := addrs.RootModuleInstance.OutputValue("a") + outputPlan := plan.Changes.OutputValue(addr) + if outputPlan == nil { + t.Fatalf("no plan for %s at all", addr) + } + if got, want := outputPlan.Addr, addr; !got.Equal(want) { + t.Errorf("wrong current address\ngot: %s\nwant: %s", got, want) + } + if got, want := outputPlan.Action, plans.Create; got != want { + t.Errorf("wrong planned action\ngot: %s\nwant: %s", got, want) + } + }) } func TestContext2Plan_preconditionErrors(t *testing.T) { diff --git a/internal/terraform/eval_conditions.go b/internal/terraform/eval_conditions.go index ad4d0cc4d5a4..4bf3114287ad 100644 --- a/internal/terraform/eval_conditions.go +++ b/internal/terraform/eval_conditions.go @@ -48,12 +48,14 @@ func (c checkType) FailureSummary() string { // // If any of the rules do not pass, the returned diagnostics will contain // errors. Otherwise, it will either be empty or contain only warnings. -func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, self addrs.Referenceable, keyData instances.RepetitionData) (diags tfdiags.Diagnostics) { +func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, self addrs.Referenceable, keyData instances.RepetitionData, diagSeverity tfdiags.Severity) (diags tfdiags.Diagnostics) { if len(rules) == 0 { // Nothing to do return nil } + severity := diagSeverity.ToHCL() + for _, rule := range rules { const errInvalidCondition = "Invalid condition result" var ruleDiags tfdiags.Diagnostics @@ -85,7 +87,7 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, } if result.IsNull() { diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, + Severity: severity, Summary: errInvalidCondition, Detail: "Condition expression must return either true or false, not null.", Subject: rule.Condition.Range().Ptr(), @@ -98,7 +100,7 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, result, err = convert.Convert(result, cty.Bool) if err != nil { diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, + Severity: severity, Summary: errInvalidCondition, Detail: fmt.Sprintf("Invalid condition result value: %s.", tfdiags.FormatError(err)), Subject: rule.Condition.Range().Ptr(), @@ -118,7 +120,7 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, errorValue, err = convert.Convert(errorValue, cty.String) if err != nil { diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, + Severity: severity, Summary: "Invalid error message", Detail: fmt.Sprintf("Unsuitable value for error message: %s.", tfdiags.FormatError(err)), Subject: rule.ErrorMessage.Range().Ptr(), @@ -133,7 +135,7 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, errorMessage = "Failed to evaluate condition error message." } diags = diags.Append(&hcl.Diagnostic{ - Severity: hcl.DiagError, + Severity: severity, Summary: typ.FailureSummary(), Detail: errorMessage, Subject: rule.Condition.Range().Ptr(), diff --git a/internal/terraform/graph_builder_plan.go b/internal/terraform/graph_builder_plan.go index d51e13be2ba1..b5e080526e25 100644 --- a/internal/terraform/graph_builder_plan.go +++ b/internal/terraform/graph_builder_plan.go @@ -99,7 +99,7 @@ func (b *PlanGraphBuilder) Steps() []GraphTransformer { &RootVariableTransformer{Config: b.Config, RawValues: b.RootVariableValues}, &ModuleVariableTransformer{Config: b.Config}, &LocalTransformer{Config: b.Config}, - &OutputTransformer{Config: b.Config}, + &OutputTransformer{Config: b.Config, RefreshOnly: b.skipPlanChanges}, // Add orphan resources &OrphanResourceInstanceTransformer{ diff --git a/internal/terraform/node_output.go b/internal/terraform/node_output.go index e8d72a9110ba..271e3c70a660 100644 --- a/internal/terraform/node_output.go +++ b/internal/terraform/node_output.go @@ -19,11 +19,12 @@ import ( // nodeExpandOutput is the placeholder for a non-root module output that has // not yet had its module path expanded. type nodeExpandOutput struct { - Addr addrs.OutputValue - Module addrs.Module - Config *configs.Output - Changes []*plans.OutputChangeSrc - Destroy bool + Addr addrs.OutputValue + Module addrs.Module + Config *configs.Output + Changes []*plans.OutputChangeSrc + Destroy bool + RefreshOnly bool } var ( @@ -66,9 +67,10 @@ func (n *nodeExpandOutput) DynamicExpand(ctx EvalContext) (*Graph, error) { } o := &NodeApplyableOutput{ - Addr: absAddr, - Config: n.Config, - Change: change, + Addr: absAddr, + Config: n.Config, + Change: change, + RefreshOnly: n.RefreshOnly, } log.Printf("[TRACE] Expanding output: adding %s as %T", o.Addr.String(), o) g.Add(o) @@ -157,6 +159,10 @@ type NodeApplyableOutput struct { Config *configs.Output // Config is the output in the config // If this is being evaluated during apply, we may have a change recorded already Change *plans.OutputChangeSrc + + // Refresh-only mode means that any failing output preconditions are + // reported as warnings rather than errors + RefreshOnly bool } var ( @@ -270,10 +276,15 @@ func (n *NodeApplyableOutput) Execute(ctx EvalContext, op walkOperation) (diags } } + checkRuleSeverity := tfdiags.Error + if n.RefreshOnly { + checkRuleSeverity = tfdiags.Warning + } checkDiags := evalCheckRules( checkOutputPrecondition, n.Config.Preconditions, ctx, nil, EvalDataForNoInstanceKey, + checkRuleSeverity, ) diags = diags.Append(checkDiags) if diags.HasErrors() { @@ -285,7 +296,10 @@ func (n *NodeApplyableOutput) Execute(ctx EvalContext, op walkOperation) (diags if !changeRecorded || !val.IsWhollyKnown() { // This has to run before we have a state lock, since evaluation also // reads the state - val, diags = ctx.EvaluateExpr(n.Config.Expr, cty.DynamicPseudoType, nil) + var evalDiags tfdiags.Diagnostics + val, evalDiags = ctx.EvaluateExpr(n.Config.Expr, cty.DynamicPseudoType, nil) + diags = diags.Append(evalDiags) + // We'll handle errors below, after we have loaded the module. // Outputs don't have a separate mode for validation, so validate // depends_on expressions here too diff --git a/internal/terraform/node_resource_abstract_instance.go b/internal/terraform/node_resource_abstract_instance.go index f0bedd11bc59..b41fb41263d8 100644 --- a/internal/terraform/node_resource_abstract_instance.go +++ b/internal/terraform/node_resource_abstract_instance.go @@ -655,6 +655,7 @@ func (n *NodeAbstractResourceInstance) plan( checkResourcePrecondition, n.Config.Preconditions, ctx, nil, keyData, + tfdiags.Error, ) diags = diags.Append(checkDiags) if diags.HasErrors() { @@ -1476,7 +1477,7 @@ func (n *NodeAbstractResourceInstance) providerMetas(ctx EvalContext) (cty.Value // value, but it still matches the previous state, then we can record a NoNop // change. If the states don't match then we record a Read change so that the // new value is applied to the state. -func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentState *states.ResourceInstanceObject) (*plans.ResourceInstanceChange, *states.ResourceInstanceObject, instances.RepetitionData, tfdiags.Diagnostics) { +func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentState *states.ResourceInstanceObject, checkRuleSeverity tfdiags.Severity) (*plans.ResourceInstanceChange, *states.ResourceInstanceObject, instances.RepetitionData, tfdiags.Diagnostics) { var diags tfdiags.Diagnostics var keyData instances.RepetitionData var configVal cty.Value @@ -1510,6 +1511,7 @@ func (n *NodeAbstractResourceInstance) planDataSource(ctx EvalContext, currentSt checkResourcePrecondition, n.Config.Preconditions, ctx, nil, keyData, + checkRuleSeverity, ) diags = diags.Append(checkDiags) if diags.HasErrors() { @@ -1689,6 +1691,7 @@ func (n *NodeAbstractResourceInstance) applyDataSource(ctx EvalContext, planned checkResourcePrecondition, n.Config.Preconditions, ctx, nil, keyData, + tfdiags.Error, ) diags = diags.Append(checkDiags) if diags.HasErrors() { diff --git a/internal/terraform/node_resource_apply_instance.go b/internal/terraform/node_resource_apply_instance.go index aa9237b9b2a4..462d52c1d183 100644 --- a/internal/terraform/node_resource_apply_instance.go +++ b/internal/terraform/node_resource_apply_instance.go @@ -184,6 +184,7 @@ func (n *NodeApplyableResourceInstance) dataResourceExecute(ctx EvalContext) (di n.Config.Postconditions, ctx, n.ResourceInstanceAddr().Resource, repeatData, + tfdiags.Error, ) diags = diags.Append(checkDiags) @@ -361,6 +362,7 @@ func (n *NodeApplyableResourceInstance) managedResourceExecute(ctx EvalContext) checkResourcePostcondition, n.Config.Postconditions, ctx, addr, repeatData, + tfdiags.Error, ) diags = diags.Append(checkDiags) diff --git a/internal/terraform/node_resource_plan_instance.go b/internal/terraform/node_resource_plan_instance.go index df61ad61d92a..7ccd825c0c8c 100644 --- a/internal/terraform/node_resource_plan_instance.go +++ b/internal/terraform/node_resource_plan_instance.go @@ -95,7 +95,12 @@ func (n *NodePlannableResourceInstance) dataResourceExecute(ctx EvalContext) (di return diags } - change, state, repeatData, planDiags := n.planDataSource(ctx, state) + checkRuleSeverity := tfdiags.Error + if n.skipPlanChanges { + checkRuleSeverity = tfdiags.Warning + } + + change, state, repeatData, planDiags := n.planDataSource(ctx, state, checkRuleSeverity) diags = diags.Append(planDiags) if diags.HasErrors() { return diags @@ -122,6 +127,7 @@ func (n *NodePlannableResourceInstance) dataResourceExecute(ctx EvalContext) (di checkResourcePostcondition, n.Config.Postconditions, ctx, addr.Resource, repeatData, + checkRuleSeverity, ) diags = diags.Append(checkDiags) @@ -263,9 +269,28 @@ func (n *NodePlannableResourceInstance) managedResourceExecute(ctx EvalContext) checkResourcePostcondition, n.Config.Postconditions, ctx, addr.Resource, repeatData, + tfdiags.Error, ) diags = diags.Append(checkDiags) } else { + // In refresh-only mode we need to evaluate the for-each expression in + // order to supply the value to the pre- and post-condition check + // blocks. This has the unfortunate edge case of a refresh-only plan + // executing with a for-each map which has the same keys but different + // values, which could result in a post-condition check relying on that + // value being inaccurate. Unless we decide to store the value of the + // for-each expression in state, this is unavoidable. + forEach, _ := evaluateForEachExpression(n.Config.ForEach, ctx) + repeatData := EvalDataForInstanceKey(n.ResourceInstanceAddr().Resource.Key, forEach) + + checkDiags := evalCheckRules( + checkResourcePrecondition, + n.Config.Preconditions, + ctx, nil, repeatData, + tfdiags.Warning, + ) + diags = diags.Append(checkDiags) + // Even if we don't plan changes, we do still need to at least update // the working state to reflect the refresh result. If not, then e.g. // any output values refering to this will not react to the drift. @@ -275,6 +300,19 @@ func (n *NodePlannableResourceInstance) managedResourceExecute(ctx EvalContext) if diags.HasErrors() { return diags } + + // Here we also evaluate post-conditions after updating the working + // state, because we want to check against the result of the refresh. + // Unlike in normal planning mode, these checks are still evaluated + // even if pre-conditions generated diagnostics, because we have no + // planned changes to block. + checkDiags = evalCheckRules( + checkResourcePostcondition, + n.Config.Postconditions, + ctx, addr.Resource, repeatData, + tfdiags.Warning, + ) + diags = diags.Append(checkDiags) } return diags diff --git a/internal/terraform/transform_output.go b/internal/terraform/transform_output.go index 598840084bf8..9308ade79fd2 100644 --- a/internal/terraform/transform_output.go +++ b/internal/terraform/transform_output.go @@ -19,9 +19,13 @@ type OutputTransformer struct { Config *configs.Config Changes *plans.Changes - // if this is a planed destroy, root outputs are still in the configuration + // If this is a planned destroy, root outputs are still in the configuration // so we need to record that we wish to remove them Destroy bool + + // Refresh-only mode means that any failing output preconditions are + // reported as warnings rather than errors + RefreshOnly bool } func (t *OutputTransformer) Transform(g *Graph) error { @@ -80,18 +84,20 @@ func (t *OutputTransformer) transform(g *Graph, c *configs.Config) error { case c.Path.IsRoot(): node = &NodeApplyableOutput{ - Addr: addr.Absolute(addrs.RootModuleInstance), - Config: o, - Change: rootChange, + Addr: addr.Absolute(addrs.RootModuleInstance), + Config: o, + Change: rootChange, + RefreshOnly: t.RefreshOnly, } default: node = &nodeExpandOutput{ - Addr: addr, - Module: c.Path, - Config: o, - Changes: changes, - Destroy: t.Destroy, + Addr: addr, + Module: c.Path, + Config: o, + Changes: changes, + Destroy: t.Destroy, + RefreshOnly: t.RefreshOnly, } } diff --git a/internal/tfdiags/diagnostic.go b/internal/tfdiags/diagnostic.go index d84fa666f244..c241ab4220c4 100644 --- a/internal/tfdiags/diagnostic.go +++ b/internal/tfdiags/diagnostic.go @@ -1,6 +1,8 @@ package tfdiags import ( + "fmt" + "github.com/hashicorp/hcl/v2" ) @@ -24,6 +26,20 @@ const ( Warning Severity = 'W' ) +// ToHCL converts a Severity to the equivalent HCL diagnostic severity. +func (s Severity) ToHCL() hcl.DiagnosticSeverity { + switch s { + case Warning: + return hcl.DiagWarning + case Error: + return hcl.DiagError + default: + // The above should always be exhaustive for all of the valid + // Severity values in this package. + panic(fmt.Sprintf("unknown diagnostic severity %s", s)) + } +} + type Description struct { Address string Summary string diff --git a/internal/tfdiags/hcl.go b/internal/tfdiags/hcl.go index 66e3e4258242..ad0d8220f996 100644 --- a/internal/tfdiags/hcl.go +++ b/internal/tfdiags/hcl.go @@ -1,8 +1,6 @@ package tfdiags import ( - "fmt" - "github.com/hashicorp/hcl/v2" ) @@ -110,19 +108,9 @@ func (diags Diagnostics) ToHCL() hcl.Diagnostics { fromExpr := diag.FromExpr() hclDiag := &hcl.Diagnostic{ - Summary: desc.Summary, - Detail: desc.Detail, - } - - switch severity { - case Warning: - hclDiag.Severity = hcl.DiagWarning - case Error: - hclDiag.Severity = hcl.DiagError - default: - // The above should always be exhaustive for all of the valid - // Severity values in this package. - panic(fmt.Sprintf("unknown diagnostic severity %s", severity)) + Summary: desc.Summary, + Detail: desc.Detail, + Severity: severity.ToHCL(), } if source.Subject != nil { hclDiag.Subject = source.Subject.ToHCL().Ptr() From 6db174e21039e9d243bbc7caeef1b3dfe9a91701 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 11 Mar 2022 11:09:28 -0500 Subject: [PATCH 643/644] core: Fix crash for sensitive values in conditions Precondition and postcondition blocks which evaluated expressions resulting in sensitive values would previously crash. This commit fixes the crashes, and adds an additional diagnostic if the error message expression produces a sensitive value (which we also elide). --- internal/terraform/context_plan2_test.go | 62 ++++++++++++++++++++++++ internal/terraform/eval_conditions.go | 23 ++++++++- 2 files changed, 84 insertions(+), 1 deletion(-) diff --git a/internal/terraform/context_plan2_test.go b/internal/terraform/context_plan2_test.go index e6315c31363c..3964fac98734 100644 --- a/internal/terraform/context_plan2_test.go +++ b/internal/terraform/context_plan2_test.go @@ -2859,3 +2859,65 @@ func TestContext2Plan_preconditionErrors(t *testing.T) { }) } } + +func TestContext2Plan_preconditionSensitiveValues(t *testing.T) { + p := testProvider("test") + ctx := testContext2(t, &ContextOpts{ + Providers: map[addrs.Provider]providers.Factory{ + addrs.NewDefaultProvider("test"): testProviderFuncFixed(p), + }, + }) + + m := testModuleInline(t, map[string]string{ + "main.tf": ` +terraform { + experiments = [preconditions_postconditions] +} + +variable "boop" { + sensitive = true + type = string +} + +output "a" { + sensitive = true + value = var.boop + + precondition { + condition = length(var.boop) <= 4 + error_message = "Boop is too long, ${length(var.boop)} > 4" + } +} +`, + }) + + _, diags := ctx.Plan(m, states.NewState(), &PlanOpts{ + Mode: plans.NormalMode, + SetVariables: InputValues{ + "boop": &InputValue{ + Value: cty.StringVal("bleep"), + SourceType: ValueFromCLIArg, + }, + }, + }) + if !diags.HasErrors() { + t.Fatal("succeeded; want errors") + } + if got, want := len(diags), 2; got != want { + t.Errorf("wrong number of diags, got %d, want %d", got, want) + } + for _, diag := range diags { + desc := diag.Description() + if desc.Summary == "Module output value precondition failed" { + if got, want := desc.Detail, "The error message included a sensitive value, so it will not be displayed."; !strings.Contains(got, want) { + t.Errorf("unexpected detail\ngot: %s\nwant to contain %q", got, want) + } + } else if desc.Summary == "Error message refers to sensitive values" { + if got, want := desc.Detail, "The error expression used to explain this condition refers to sensitive values."; !strings.Contains(got, want) { + t.Errorf("unexpected detail\ngot: %s\nwant to contain %q", got, want) + } + } else { + t.Errorf("unexpected summary\ngot: %s", desc.Summary) + } + } +} diff --git a/internal/terraform/eval_conditions.go b/internal/terraform/eval_conditions.go index 4bf3114287ad..80858eee8af0 100644 --- a/internal/terraform/eval_conditions.go +++ b/internal/terraform/eval_conditions.go @@ -13,6 +13,7 @@ import ( "github.com/hashicorp/terraform/internal/configs" "github.com/hashicorp/terraform/internal/instances" "github.com/hashicorp/terraform/internal/lang" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -110,6 +111,10 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, continue } + // The condition result may be marked if the expression refers to a + // sensitive value. + result, _ = result.Unmark() + if result.True() { continue } @@ -128,7 +133,23 @@ func evalCheckRules(typ checkType, rules []*configs.CheckRule, ctx EvalContext, EvalContext: hclCtx, }) } else { - errorMessage = strings.TrimSpace(errorValue.AsString()) + if marks.Has(errorValue, marks.Sensitive) { + diags = diags.Append(&hcl.Diagnostic{ + Severity: severity, + + Summary: "Error message refers to sensitive values", + Detail: `The error expression used to explain this condition refers to sensitive values. Terraform will not display the resulting message. + +You can correct this by removing references to sensitive values, or by carefully using the nonsensitive() function if the expression will not reveal the sensitive data.`, + + Subject: rule.ErrorMessage.Range().Ptr(), + Expression: rule.ErrorMessage, + EvalContext: hclCtx, + }) + errorMessage = "The error message included a sensitive value, so it will not be displayed." + } else { + errorMessage = strings.TrimSpace(errorValue.AsString()) + } } } if errorMessage == "" { From b5cfc0bb8bc4f9f4ffca495a80d167bc0da02f97 Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Fri, 11 Mar 2022 11:11:30 -0500 Subject: [PATCH 644/644] core: Fix sensitive variable validation errors Variable validation error message expressions which generated sensitive values would previously crash. This commit updates the logic to align with preconditions and postconditions, eliding sensitive error message values and adding a separate diagnostic explaining why. --- internal/terraform/eval_variable.go | 19 +++- internal/terraform/eval_variable_test.go | 133 +++++++++++++++++++++++ 2 files changed, 151 insertions(+), 1 deletion(-) diff --git a/internal/terraform/eval_variable.go b/internal/terraform/eval_variable.go index 629da70510e0..f6c927e5e476 100644 --- a/internal/terraform/eval_variable.go +++ b/internal/terraform/eval_variable.go @@ -9,6 +9,7 @@ import ( "github.com/hashicorp/hcl/v2/gohcl" "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/configs" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/hashicorp/terraform/internal/tfdiags" "github.com/zclconf/go-cty/cty" "github.com/zclconf/go-cty/cty/convert" @@ -321,7 +322,23 @@ func evalVariableValidations(addr addrs.AbsInputVariableInstance, config *config EvalContext: hclCtx, }) } else { - errorMessage = strings.TrimSpace(errorValue.AsString()) + if marks.Has(errorValue, marks.Sensitive) { + diags = diags.Append(&hcl.Diagnostic{ + Severity: hcl.DiagError, + + Summary: "Error message refers to sensitive values", + Detail: `The error expression used to explain this condition refers to sensitive values. Terraform will not display the resulting message. + +You can correct this by removing references to sensitive values, or by carefully using the nonsensitive() function if the expression will not reveal the sensitive data.`, + + Subject: validation.ErrorMessage.Range().Ptr(), + Expression: validation.ErrorMessage, + EvalContext: hclCtx, + }) + errorMessage = "The error message included a sensitive value, so it will not be displayed." + } else { + errorMessage = strings.TrimSpace(errorValue.AsString()) + } } } if errorMessage == "" { diff --git a/internal/terraform/eval_variable_test.go b/internal/terraform/eval_variable_test.go index c84a969e8c09..662bf56267aa 100644 --- a/internal/terraform/eval_variable_test.go +++ b/internal/terraform/eval_variable_test.go @@ -10,6 +10,7 @@ import ( "github.com/hashicorp/terraform/internal/addrs" "github.com/hashicorp/terraform/internal/lang" + "github.com/hashicorp/terraform/internal/lang/marks" "github.com/hashicorp/terraform/internal/tfdiags" ) @@ -715,3 +716,135 @@ func TestEvalVariableValidations_jsonErrorMessageEdgeCase(t *testing.T) { }) } } + +func TestEvalVariableValidations_sensitiveValues(t *testing.T) { + cfgSrc := ` +variable "foo" { + type = string + sensitive = true + default = "boop" + + validation { + condition = length(var.foo) == 4 + error_message = "Foo must be 4 characters, not ${length(var.foo)}" + } +} + +variable "bar" { + type = string + sensitive = true + default = "boop" + + validation { + condition = length(var.bar) == 4 + error_message = "Bar must be 4 characters, not ${nonsensitive(length(var.bar))}." + } +} +` + cfg := testModuleInline(t, map[string]string{ + "main.tf": cfgSrc, + }) + variableConfigs := cfg.Module.Variables + + // Because we loaded our pseudo-module from a temporary file, the + // declaration source ranges will have unpredictable filenames. We'll + // fix that here just to make things easier below. + for _, vc := range variableConfigs { + vc.DeclRange.Filename = "main.tf" + for _, v := range vc.Validations { + v.DeclRange.Filename = "main.tf" + } + } + + tests := []struct { + varName string + given cty.Value + wantErr []string + }{ + // Validations pass on a sensitive variable with an error message which + // would generate a sensitive value + { + varName: "foo", + given: cty.StringVal("boop"), + }, + // Assigning a value which fails the condition generates a sensitive + // error message, which is elided and generates another error + { + varName: "foo", + given: cty.StringVal("bap"), + wantErr: []string{ + "Invalid value for variable", + "The error message included a sensitive value, so it will not be displayed.", + "Error message refers to sensitive values", + }, + }, + // Validations pass on a sensitive variable with a correctly defined + // error message + { + varName: "bar", + given: cty.StringVal("boop"), + }, + // Assigning a value which fails the condition generates a nonsensitive + // error message, which is displayed + { + varName: "bar", + given: cty.StringVal("bap"), + wantErr: []string{ + "Invalid value for variable", + "Bar must be 4 characters, not 3.", + }, + }, + } + + for _, test := range tests { + t.Run(fmt.Sprintf("%s %#v", test.varName, test.given), func(t *testing.T) { + varAddr := addrs.InputVariable{Name: test.varName}.Absolute(addrs.RootModuleInstance) + varCfg := variableConfigs[test.varName] + if varCfg == nil { + t.Fatalf("invalid variable name %q", test.varName) + } + + // Build a mock context to allow the function under test to + // retrieve the variable value and evaluate the expressions + ctx := &MockEvalContext{} + + // We need a minimal scope to allow basic functions to be passed to + // the HCL scope + ctx.EvaluationScopeScope = &lang.Scope{} + ctx.GetVariableValueFunc = func(addr addrs.AbsInputVariableInstance) cty.Value { + if got, want := addr.String(), varAddr.String(); got != want { + t.Errorf("incorrect argument to GetVariableValue: got %s, want %s", got, want) + } + if varCfg.Sensitive { + return test.given.Mark(marks.Sensitive) + } else { + return test.given + } + } + + gotDiags := evalVariableValidations( + varAddr, varCfg, nil, ctx, + ) + + if len(test.wantErr) == 0 { + if len(gotDiags) > 0 { + t.Errorf("no diags expected, got %s", gotDiags.Err().Error()) + } + } else { + wantErrs: + for _, want := range test.wantErr { + for _, diag := range gotDiags { + if diag.Severity() != tfdiags.Error { + continue + } + desc := diag.Description() + if strings.Contains(desc.Summary, want) || strings.Contains(desc.Detail, want) { + continue wantErrs + } + } + t.Errorf("no error diagnostics found containing %q\ngot: %s", want, gotDiags.Err().Error()) + } + } + }) + } +}