Wrapper behavior is unexpected: please update log message #85

colindembovsky · 2021-01-07T15:16:55Z

Hi team - thank you for your work on this action! I have one piece of feedback: the wrapper behavior is unexpected. Here's a snippet of a workflow that I was attempting:

steps:
  - name: Install TF
    uses: hashicorp/setup-terraform@v1
  - name: Get webappURL
    run: |
      $url=$(terraform output -raw webappURL)
      echo "::set-output name=webapp_url::$url"

Instead of url being cdtailwindgha-dev.azurewebsites.net (the expected value from the terraform output), the value was set to:

[command]/home/runner/work/_temp/d6cc4736-dad6-4784-b42d-6c80ea5e10da/terraform-bin output -raw slotURL cdtailwindgha-dev.azurewebsites.net::debug::Terraform exited with code 0. ::debug::stdout: cdtailwindgha-dev.azurewebsites.net ::debug::stderr: ::debug::exitcode: 0 ::set-output name=stdout::cdtailwindgha-dev.azurewebsites.net ::set-output name=stderr:: ::set-output name=exitcode::0

Admittedly, without reading the docs on the setup-terraform action I expected the above to work - but the output webapp_url was set to the output of the wrapper. I thrashed for hours trying to figure out what was going on.

Eventually I was pointed to this behavior by some helpful folks at GitHub.

Can I request that you put a log message stating that the wrapper is being used and a link to the readme? That way users like me who don't read the docs initially can be prompted to do so!

The text was updated successfully, but these errors were encountered:

allanmc · 2021-01-28T09:54:17Z

I have the same issue. As a workaround, try disabling terraform_wrapper as described here: https://github.com/hashicorp/setup-terraform

till · 2021-10-27T11:59:08Z

In addition, it would be nice to add that since the wrapper is used by default, this action requires nodejs to be installed.

Presently using a command such as `terraform output -json | jq` does not work with the wrapper enabled, as it is by default. In order to consume terraform's output having set it up with this Action, it is necessary either to disable the wrapper (`with: terraform_wrapper: false`) or run it in its own Actions step with an explicit `id` (e.g. `id: foo`) so that it can be referred to and consumed (`${{steps.foo.outputs.stdout}}` et al.) in later steps. This seems to be the result of much confusion (issues passim) and is not at all easy (hashicorp#338) to debug/diagnose and come to the realisation that it's due to the wrapper, or even that such a thing exists. This commit aims to address the issue by passing through stdout & stderr, so that they're available in Unix pipelines and variable assignment etc. as expected within a single step, while still retaining the wrapper's listening behaviour to provide them as Actions outputs. Closes hashicorp#20, hashicorp#80, hashicorp#85, hashicorp#149, hashicorp#338, and probably more.

@austinvalle

Presently using a command such as `terraform output -json | jq` does not work with the wrapper enabled, as it is by default. In order to consume terraform's output having set it up with this Action, it is necessary either to disable the wrapper (`with: terraform_wrapper: false`) or run it in its own Actions step with an explicit `id` (e.g. `id: foo`) so that it can be referred to and consumed (`${{steps.foo.outputs.stdout}}` et al.) in later steps. This seems to be the result of much confusion (issues passim) and is not at all easy (hashicorp#338) to debug/diagnose and come to the realisation that it's due to the wrapper, or even that such a thing exists. @austinvalle identified the issue as being due to the `@actions/exec` package writing the spawned command to stdout (along with then its actual stdout). This has previously been reported upstream in actions/toolkit#649; I've proposed actions/toolkit#1573 to fix it. This commit aims to address the issue for `setup-terraform` in the meantime by silencing `@actions/exec` and then writing out to stdout & stderr from the listener buffers, which it writes to without this additional logging. Closes hashicorp#20, hashicorp#80, hashicorp#85, hashicorp#149, hashicorp#338, and probably more.

@austinvalle

Presently using a command such as `terraform output -json | jq` does not work with the wrapper enabled, as it is by default. In order to consume terraform's output having set it up with this Action, it is necessary either to disable the wrapper (`with: terraform_wrapper: false`) or run it in its own Actions step with an explicit `id` (e.g. `id: foo`) so that it can be referred to and consumed (`${{steps.foo.outputs.stdout}}` et al.) in later steps. This seems to be the result of much confusion (issues passim) and is not at all easy (hashicorp#338) to debug/diagnose and come to the realisation that it's due to the wrapper, or even that such a thing exists. @austinvalle identified the issue as being due to the `@actions/exec` package writing the spawned command to stdout (along with then its actual stdout). This has previously been reported upstream in actions/toolkit#649; I've proposed actions/toolkit#1573 to fix it. This commit aims to address the issue for `setup-terraform` in the meantime by silencing `@actions/exec` and then writing out to stdout & stderr from the listener buffers, which it writes to without this additional logging. Closes hashicorp#20, hashicorp#80, hashicorp#85, hashicorp#149, hashicorp#338, and probably more.

@austinvalle

Presently using a command such as `terraform output -json | jq` does not work with the wrapper enabled, as it is by default. In order to consume terraform's output having set it up with this Action, it is necessary either to disable the wrapper (`with: terraform_wrapper: false`) or run it in its own Actions step with an explicit `id` (e.g. `id: foo`) so that it can be referred to and consumed (`${{steps.foo.outputs.stdout}}` et al.) in later steps. This seems to be the result of much confusion (issues passim) and is not at all easy (hashicorp#338) to debug/diagnose and come to the realisation that it's due to the wrapper, or even that such a thing exists. @austinvalle identified the issue as being due to the `@actions/exec` package writing the spawned command to stdout (along with then its actual stdout). This has previously been reported upstream in actions/toolkit#649; I've proposed actions/toolkit#1573 to fix it. This commit aims to address the issue for `setup-terraform` in the meantime by silencing `@actions/exec` and then writing out to stdout & stderr from the listener buffers, which it writes to without this additional logging. Closes hashicorp#20, hashicorp#80, hashicorp#85, hashicorp#149, hashicorp#338, and probably more.

@austinvalle

* Fix output malformed when wrapper enabled Presently using a command such as `terraform output -json | jq` does not work with the wrapper enabled, as it is by default. In order to consume terraform's output having set it up with this Action, it is necessary either to disable the wrapper (`with: terraform_wrapper: false`) or run it in its own Actions step with an explicit `id` (e.g. `id: foo`) so that it can be referred to and consumed (`${{steps.foo.outputs.stdout}}` et al.) in later steps. This seems to be the result of much confusion (issues passim) and is not at all easy (#338) to debug/diagnose and come to the realisation that it's due to the wrapper, or even that such a thing exists. @austinvalle identified the issue as being due to the `@actions/exec` package writing the spawned command to stdout (along with then its actual stdout). This has previously been reported upstream in actions/toolkit#649; I've proposed actions/toolkit#1573 to fix it. This commit aims to address the issue for `setup-terraform` in the meantime by silencing `@actions/exec` and then writing out to stdout & stderr from the listener buffers, which it writes to without this additional logging. Closes #20, #80, #85, #149, #338, and probably more. * add test for stdout with jq * update test name * remove debug lines and add changelog * add additional note about the bug fix to wrapper --------- Co-authored-by: Austin Valle <[email protected]>

austinvalle · 2023-10-27T18:09:26Z

This issue will be fixed in an upcoming v3.0.0 release next week. Please see this comment for more info

github-actions · 2024-05-23T10:08:33Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

aeschright added the bug Something isn't working label Apr 20, 2021

danopia mentioned this issue Apr 7, 2022

terraform-bin state rm ::debug::stdout: #167

Closed

OJFord mentioned this issue Oct 25, 2023

Fix output malformed when wrapper enabled #367

Merged

austinvalle closed this as completed Oct 27, 2023

github-actions bot locked as resolved and limited conversation to collaborators May 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrapper behavior is unexpected: please update log message #85

Wrapper behavior is unexpected: please update log message #85

colindembovsky commented Jan 7, 2021

allanmc commented Jan 28, 2021

till commented Oct 27, 2021

austinvalle commented Oct 27, 2023

github-actions bot commented May 23, 2024

Wrapper behavior is unexpected: please update log message #85

Wrapper behavior is unexpected: please update log message #85

Comments

colindembovsky commented Jan 7, 2021

allanmc commented Jan 28, 2021

till commented Oct 27, 2021

austinvalle commented Oct 27, 2023

github-actions bot commented May 23, 2024