feat: Add WithManagedDebugEnvFilePath() option that allows writing TF_REATTACH_PROVIDERS to an environment file (#484)

* feat: Add WithManagedDebugEnvFilePath() option that allows writing TF_REATTACH_PROVIDERS to an environment file
* add changie

Author: ansgarm

.changes/unreleased/FEATURES-20250307-153800.yaml

@@ -0,0 +1,5 @@
+kind: FEATURES
+body: Add WithManagedDebugEnvFilePath() option that allows writing TF_REATTACH_PROVIDERS to an environment file
+time: 2025-03-07T15:38:00.962006+01:00
+custom:
+    Issue: "484"

tfprotov5/tf5server/server.go

@@ -104,6 +104,7 @@ type ServeConfig struct {
 	managedDebug                      bool
 	managedDebugReattachConfigTimeout time.Duration
 	managedDebugStopSignals           []os.Signal
+	managedDebugEnvFilePath           string
 
 	disableLogInitStderr bool
 	disableLogLocation   bool
@@ -178,6 +179,15 @@ func WithManagedDebugReattachConfigTimeout(timeout time.Duration) ServeOpt {
 	})
 }
 
+// WithManagedDebugEnvFilePath returns a ServeOpt that will set the output path
+// for the managed debug process to write the reattach configuration into.
+func WithManagedDebugEnvFilePath(path string) ServeOpt {
+	return serveConfigFunc(func(in *ServeConfig) error {
+		in.managedDebugEnvFilePath = path
+		return nil
+	})
+}
+
 // WithGoPluginLogger returns a ServeOpt that will set the logger that
 // go-plugin should use to log messages.
 func WithGoPluginLogger(logger hclog.Logger) ServeOpt {
@@ -380,6 +390,15 @@ func Serve(name string, serverFactory func() tfprotov5.ProviderServer, opts ...S
 
 	fmt.Println("")
 
+	if conf.managedDebugEnvFilePath != "" {
+		fmt.Printf("Writing reattach configuration to env file at path %s\n", conf.managedDebugEnvFilePath)
+
+		err = os.WriteFile(conf.managedDebugEnvFilePath, []byte(fmt.Sprintf("%s='%s'\n", envTfReattachProviders, strings.ReplaceAll(reattachStr, `'`, `'"'"'`))), 0644)
+		if err != nil {
+			return fmt.Errorf("Error writing to env file at path %s: %w", conf.managedDebugEnvFilePath, err)
+		}
+	}
+
 	// Wait for the server to be done.
 	<-conf.debugCloseCh
 

tfprotov6/tf6server/server.go

@@ -104,6 +104,7 @@ type ServeConfig struct {
 	managedDebug                      bool
 	managedDebugReattachConfigTimeout time.Duration
 	managedDebugStopSignals           []os.Signal
+	managedDebugEnvFilePath           string
 
 	disableLogInitStderr bool
 	disableLogLocation   bool
@@ -178,6 +179,15 @@ func WithManagedDebugReattachConfigTimeout(timeout time.Duration) ServeOpt {
 	})
 }
 
+// WithManagedDebugEnvFilePath returns a ServeOpt that will set the output path
+// for the managed debug process to write the reattach configuration into.
+func WithManagedDebugEnvFilePath(path string) ServeOpt {
+	return serveConfigFunc(func(in *ServeConfig) error {
+		in.managedDebugEnvFilePath = path
+		return nil
+	})
+}
+
 // WithGoPluginLogger returns a ServeOpt that will set the logger that
 // go-plugin should use to log messages.
 func WithGoPluginLogger(logger hclog.Logger) ServeOpt {
@@ -380,6 +390,15 @@ func Serve(name string, serverFactory func() tfprotov6.ProviderServer, opts ...S
 
 	fmt.Println("")
 
+	if conf.managedDebugEnvFilePath != "" {
+		fmt.Printf("Writing reattach configuration to env file at path %s\n", conf.managedDebugEnvFilePath)
+
+		err = os.WriteFile(conf.managedDebugEnvFilePath, []byte(fmt.Sprintf("%s='%s'\n", envTfReattachProviders, strings.ReplaceAll(reattachStr, `'`, `'"'"'`))), 0644)
+		if err != nil {
+			return fmt.Errorf("Error writing to env file at path %s: %w", conf.managedDebugEnvFilePath, err)
+		}
+	}
+
 	// Wait for the server to be done.
 	<-conf.debugCloseCh