Support/Document Debugger Processes

[bflad]

terraform-plugin-mux version

v0.4.0

Use cases

Similar to solely SDKv2 or framework based providers, developers may wish to easily run debugging and testing processes against a muxed provider. Currently, it would require a lot of manual main function setup to essentially reimplement what those two projects implement.

Proposal

Natively support and/or document how to enable debugger functionality, similar to that which is available for SDKv2 and framework based providers. It may make more sense to implement a "DebugServe" method in terraform-plugin-go, rather than necessarily implement anything in this project.

References

• tfsdk: Added Debug field to ServeOpts for running providers via debugger and testing processes terraform-plugin-framework#243
• https://www.terraform.io/plugin/sdkv2/debugging

[bflad]

terraform-plugin-go v0.6.0 and a slightly refreshed mux API should make this relatively straightforward with something like:

func main() {
	debugFlag := flag.Bool("debug", false, "Start provider in debug mode.")
	flag.Parse()

	ctx := context.Background()
	opts := []tf6server.ServeOpt{}
	providers := []func() tfprotov6.ProviderServer{
		/* providers */
	}

	if *debugFlag {
		opts = append(opts, tf6server.WithManagedDebug())
	}

	muxedProvider, err := tf6muxserver.NewMuxServer(ctx, providers...)

	if err != nil {
		log.Fatal(err.Error())
	}

	tf6server.Serve("registry.terraform.io/namespace/example", muxedProvider.ProviderServer, opts...)
}

[bflad]

This is waiting on #37 / #39

[github-actions]

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.