delve: Can't debug github.com/hashicorp/terraform

What version of Delve are you using (dlv version)? Delve Debugger Version: 0.11.0-alpha Build: 26ce16f1db3fdd6fdd915f2ec7d11e4bfe72baed
What version of Go are you using? (go version)? go version go1.6 darwin/amd64
What operating system and processor architecture are you using? OS X
What did you do? I tried to debug hashicorp/terraform application.

$ dlv debug github.com/hashicorp/terraform -- apply
Type 'help' for list of commands.
(dlv) c

What did you expect to see? I expected to debugger to be able to find the other plugins that Terraform depends.
What did you see instead?

Error configuring: 3 error(s) occurred:

* triton_firewall_rule.inet-to-bastion: provider triton couldn't be found
* triton_firewall_rule.bastion-to-vms: provider triton couldn't be found
* triton_machine.bastion: provider triton couldn't be found
Process 40980 has exited with status 1

About this issue

Original URL
State: closed
Created 8 years ago
Reactions: 1
Comments: 20 (7 by maintainers)

Most upvoted comments

For @farvour and anyone else looking for an answer: This is quite a late reply, but I thought I’d drop in and say: providers are actually one of the easier things to debug in Terraform with Delve!

The key to doing it is to debug it through Delve’s test functionality, through an acceptance test. Write an acceptance test for the scenario that you want to test on, if one does not exist already.

Then, run:

TF_ACC=1 dlv test ./YOUR_PROVIDER_NAME -- -test.v -test.run=TestAccSomeResourceHere_basic

The key to remember is that since you have to pass your test arguments over to the actual test binary directly instead of proxying them with go test, prefixing your test-specific arguments with test. is necessary after the -- terminator.

In the debugger, set your breakpoints, continue, and debug away!

In some of the providers I have worked on, you will see a debugacc make target that helps with this a bit, although you will still need to supply the -test.run= to run a specific test:

debugacc: fmtcheck
	TF_ACC=1 dlv test $(TEST) -- -test.v $(TESTARGS)

vancluever on Aug 14, 2018

@vancluever

Environment vars didn’t pass in properly,

This should be fixed on master for OSX.

derekparker on May 8, 2017

I just returned from Hashicon and got a tip from the core Terraform team (they use delve too!). This is how I got debugging to work with Terraform:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "remotePath": "",
            "port": 2345,
            "host": "127.0.0.1",
            "program": "${workspaceRoot}",
            "env": {
                "cccf35992f8f3cd8d1d28f0109dd953e26664531": "7c28215aca87789f95b406b8dd91aa5198406750"
            },
            "args": ["plan", "/my_terraform_config_file_directory"],
            "showLog": true
        }
    ]
}

NOTE: this technique only works with Terraform core. Debugging the Terraform plug-ins is still an issue.

The key is setting the above environment variable. I won’t even try to pretend explaining why this works, but you can find where I got the mysterious values from here: https://github.com/mitchellh/panicwrap/search?utf8=✓&q=DEFAULT_COOKIE_KEY

sjwl on Sep 13, 2016