Support setup-terraform action (with the default wrapper)

[ansgarm]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

The setup-terraform Github Action by default wraps the Terraform CLI in a wrapper which alters its output. This produces different errors, e.g. get fails and planning / deploying might also fail (haven't checked yet, but as of TF 1.0 we also parse some JSON there).

References

• Json parse Error with cdktf get #1013
• https://github.com/hashicorp/setup-terraform

Workaround (until this is closed)

Disable the wrapper:

- uses: hashicorp/setup-terraform@v1
  with:
    terraform_version: 0.14
    terraform_wrapper: false # <--

Related code locations

The following locations might need to be touched to support the prefixes to the Terraform output on stdout.
For fixing the get command:

terraform-cdk/packages/cdktf-cli/lib/get/generator/provider-schema.ts

Lines 244 to 248 in 6ff70ce

	providerSchema = JSON.parse(
	await exec(terraformBinaryName, ["providers", "schema", "-json"], {
	cwd: outdir,
	})
	) as ProviderSchema;

For parsing the plan:

terraform-cdk/packages/cdktf-cli/bin/cmds/ui/models/terraform-cli.ts

Lines 56 to 61 in 6ff70ce

	const jsonPlan = await exec(
	terraformBinaryName,
	["show", "-json", planFile],
	{ cwd: this.workdir, env: process.env }
	);
	return new TerraformCliPlan(planFile, JSON.parse(jsonPlan));

For parsing the outputs:

terraform-cdk/packages/cdktf-cli/bin/cmds/ui/models/terraform-cli.ts

Lines 111 to 116 in 6ff70ce

	const output = await exec(
	terraformBinaryName,
	["output", "-json", ...this.stateFileOption],
	{ cwd: this.workdir, env: process.env }
	);
	return JSON.parse(output);

The progress updates while deploying / destroying are interpreted line by line. Wrapping this would probably be the easiest way to hook in and remove the prefix from each line:

terraform-cdk/packages/cdktf-cli/bin/cmds/ui/models/terraform-cli.ts

Line 83 in 6ff70ce

stdout

terraform-cdk/packages/cdktf-cli/bin/cmds/ui/models/terraform-cli.ts

Line 93 in 6ff70ce

stdout