transmit signal only windows (#341)

* discard signal on non windows OS * update README (no more detached behavior since discarding signal on non windows OS) Signed-off-by: Denis Vaumoron <[email protected]>
tofuutils · Jan 28, 2025 · bde3d44 · bde3d44
1 parent d6e128a
commit bde3d44
Show file tree

Hide file tree

Showing 12 changed files with 82 additions and 176 deletions.
diff --git a/README.md b/README.md
@@ -658,15 +658,6 @@ If set to true **tenv** will automatically install missing tool versions needed.
 </details>
 
 
-<details><summary><b>TENV_DETACHED_PROXY</b></summary><br>
-
-String (Default: false on Windows OS, true on other OS without CI or PIPELINE_WORKSPACE environment variable)
-
-Enable **tenv** proxies detached behaviour (use a new process group id when launching tool command, allow to avoid killing proxied tool process earlier than expected when proxies redirect interrupt signal already sended to whole process group (issue occurrences known on macOS and Linux)).
-
-</details>
-
-
 <details><summary><b>TENV_FORCE_REMOTE</b></summary><br>
 
 String (Default: false)

diff --git a/config/envname/env.go b/config/envname/env.go
@@ -48,17 +48,15 @@ const (
 	AtmosRemoteURL   = AtmosPrefix + remoteURL
 	AtmosRemoteUser  = AtmosPrefix + remoteUser
 
-	tenvPrefix               = "TENV_"
-	TenvArch                 = tenvPrefix + arch
-	TenvAutoInstall          = tenvPrefix + autoInstall
-	TenvDetachedProxy        = tenvPrefix + "DETACHED_PROXY"
-	TenvDetachedProxyDefault = TenvDetachedProxy + "_DEFAULT"
-	TenvForceRemote          = tenvPrefix + forceRemote
-	TenvLog                  = tenvPrefix + log
-	TenvQuiet                = tenvPrefix + quiet
-	TenvRemoteConf           = tenvPrefix + "REMOTE_CONF"
-	TenvRootPath             = tenvPrefix + rootPath
-	TenvToken                = tenvPrefix + token
+	tenvPrefix      = "TENV_"
+	TenvArch        = tenvPrefix + arch
+	TenvAutoInstall = tenvPrefix + autoInstall
+	TenvForceRemote = tenvPrefix + forceRemote
+	TenvLog         = tenvPrefix + log
+	TenvQuiet       = tenvPrefix + quiet
+	TenvRemoteConf  = tenvPrefix + "REMOTE_CONF"
+	TenvRootPath    = tenvPrefix + rootPath
+	TenvToken       = tenvPrefix + token
 
 	TfenvPrefix          = "TFENV_"
 	tfenvTerraformPrefix = TfenvPrefix + "TERRAFORM_"

diff --git a/pkg/cmdproxy/proxy.go b/pkg/cmdproxy/proxy.go
@@ -130,18 +130,6 @@ func initIO(cmd *exec.Cmd, pExitCode *int, gha bool, getenv configutils.GetenvFu
 	}
 }
 
-func transmitIncreasingSignal(signalReceiver <-chan os.Signal, process *os.Process) {
-	first := true
-	for range signalReceiver {
-		if first {
-			_ = process.Signal(os.Interrupt)
-			first = false
-		} else {
-			_ = process.Signal(os.Kill)
-		}
-	}
-}
-
 func writeMultiline(file *os.File, key string, value string) error {
 	delimiter := "ghadelimeter_" + strconv.Itoa(rand.Int()) //nolint
 	if strings.Contains(key, delimiter) || strings.Contains(value, delimiter) {

diff --git a/pkg/cmdproxy/transmit_others.go b/pkg/cmdproxy/transmit_others.go
@@ -0,0 +1,29 @@
+//go:build !windows
+
+/*
+ *
+ * Copyright 2024 tofuutils authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package cmdproxy
+
+import "os"
+
+func transmitIncreasingSignal(signalReceiver <-chan os.Signal, _ *os.Process) {
+	for range signalReceiver { //nolint
+		// discard signals on non Windows OS (already send to whole process group)
+	}
+}
diff --git a/pkg/cmdproxy/transmit_windows.go b/pkg/cmdproxy/transmit_windows.go
@@ -0,0 +1,33 @@
+/*
+ *
+ * Copyright 2024 tofuutils authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package cmdproxy
+
+import "os"
+
+func transmitIncreasingSignal(signalReceiver <-chan os.Signal, process *os.Process) {
+	first := true
+	for range signalReceiver {
+		if first {
+			_ = process.Signal(os.Interrupt)
+			first = false
+		} else {
+			_ = process.Signal(os.Kill)
+		}
+	}
+}
diff --git a/versionmanager/proxy/agnostic.go b/versionmanager/proxy/agnostic.go
@@ -28,10 +28,8 @@ import (
 
 	"github.com/tofuutils/tenv/v4/config"
 	"github.com/tofuutils/tenv/v4/config/cmdconst"
-	"github.com/tofuutils/tenv/v4/config/envname"
 	cmdproxy "github.com/tofuutils/tenv/v4/pkg/cmdproxy"
 	"github.com/tofuutils/tenv/v4/versionmanager/builder"
-	detachproxy "github.com/tofuutils/tenv/v4/versionmanager/proxy/detach"
 )
 
 // Always call os.Exit.
@@ -80,12 +78,5 @@ func ExecAgnostic(conf *config.Config, hclParser *hclparse.Parser, cmdArgs []str
 
 	cmd := exec.CommandContext(ctx, execPath, cmdArgs...)
 
-	defaultDetach, err := conf.Getenv.Bool(false, envname.TenvDetachedProxyDefault)
-	if err != nil {
-		fmt.Println(msgReadDefaultDetachErr, err) //nolint
-	}
-
-	detachproxy.InitBehaviorFromEnv(cmd, conf.Getenv, defaultDetach)
-
 	cmdproxy.Run(cmd, conf.GithubActions, conf.Getenv)
 }
diff --git a/versionmanager/proxy/detach/detached_others.go b/versionmanager/proxy/detach/detached_others.go
diff --git a/versionmanager/proxy/detach/detached_windows.go b/versionmanager/proxy/detach/detached_windows.go
diff --git a/versionmanager/proxy/light/light.go b/versionmanager/proxy/light/light.go
@@ -26,7 +26,6 @@ import (
 	"os/signal"
 
 	"github.com/tofuutils/tenv/v4/config/cmdconst"
-	detachproxy "github.com/tofuutils/tenv/v4/versionmanager/proxy/detach"
 )
 
 func Exec(execName string) {
@@ -36,8 +35,6 @@ func Exec(execName string) {
 
 	// proxy to selected version
 	cmd := exec.Command(cmdconst.TenvName, cmdArgs...) //nolint
-	defaultDetach := updateDefaultDetachInCmdEnv(cmd)
-	detachproxy.InitBehaviorFromEnv(cmd, os.Getenv, defaultDetach)
 	cmd.Stderr = os.Stderr
 	cmd.Stdin = os.Stdin
 	cmd.Stdout = os.Stdout
@@ -63,9 +60,3 @@ func exitWithErrorMsg(execName string, err error) {
 	fmt.Println("Failure during", execName, "call :", err) //nolint
 	os.Exit(1)
 }
-
-func transmitSignal(signalReceiver <-chan os.Signal, process *os.Process) {
-	for range signalReceiver {
-		_ = process.Signal(os.Interrupt)
-	}
-}
diff --git a/...nmanager/proxy/light/custom_env_others.go → ...ionmanager/proxy/light/transmit_others.go b/...nmanager/proxy/light/custom_env_others.go → ...ionmanager/proxy/light/transmit_others.go
@@ -20,22 +20,10 @@
 
 package lightproxy
 
-import (
-	"os"
-	"os/exec"
+import "os"
 
-	"github.com/tofuutils/tenv/v4/config/envname"
-	"github.com/tofuutils/tenv/v4/pkg/tty"
-)
-
-const changeDefaultDetach = envname.TenvDetachedProxyDefault + "=true"
-
-func updateDefaultDetachInCmdEnv(cmd *exec.Cmd) bool {
-	if tty.Detect() {
-		cmd.Env = append(os.Environ(), changeDefaultDetach)
-
-		return true
+func transmitSignal(signalReceiver <-chan os.Signal, _ *os.Process) {
+	for range signalReceiver { //nolint
+		// discard signals on non Windows OS (already send to whole process group)
 	}
-
-	return false
 }
diff --git a/...manager/proxy/light/custom_env_windows.go → ...onmanager/proxy/light/transmit_windows.go b/...manager/proxy/light/custom_env_windows.go → ...onmanager/proxy/light/transmit_windows.go
@@ -18,8 +18,10 @@
 
 package lightproxy
 
-import "os/exec"
+import "os"
 
-func updateDefaultDetachInCmdEnv(_ *exec.Cmd) bool {
-	return false
+func transmitSignal(signalReceiver <-chan os.Signal, process *os.Process) {
+	for range signalReceiver {
+		_ = process.Signal(os.Interrupt)
+	}
 }
diff --git a/versionmanager/proxy/proxy.go b/versionmanager/proxy/proxy.go
@@ -29,19 +29,13 @@ import (
 	"github.com/hashicorp/hcl/v2/hclparse"
 
 	"github.com/tofuutils/tenv/v4/config"
-	"github.com/tofuutils/tenv/v4/config/envname"
-	cmdproxy "github.com/tofuutils/tenv/v4/pkg/cmdproxy"
+	"github.com/tofuutils/tenv/v4/pkg/cmdproxy"
 	"github.com/tofuutils/tenv/v4/pkg/loghelper"
 	"github.com/tofuutils/tenv/v4/versionmanager/builder"
 	"github.com/tofuutils/tenv/v4/versionmanager/lastuse"
-	detachproxy "github.com/tofuutils/tenv/v4/versionmanager/proxy/detach"
 )
 
-const (
-	chdirFlagPrefix = "-chdir="
-
-	msgReadDefaultDetachErr = "Failed to read " + envname.TenvDetachedProxyDefault + " environment variable, default to false :"
-)
+const chdirFlagPrefix = "-chdir="
 
 // Always call os.Exit.
 func Exec(conf *config.Config, builderFunc builder.Func, hclParser *hclparse.Parser, execName string, cmdArgs []string) {
@@ -67,13 +61,6 @@ func Exec(conf *config.Config, builderFunc builder.Func, hclParser *hclparse.Par
 
 	cmd := exec.CommandContext(ctx, execPath, cmdArgs...)
 
-	defaultDetach, err := conf.Getenv.Bool(false, envname.TenvDetachedProxyDefault)
-	if err != nil {
-		fmt.Println(msgReadDefaultDetachErr, err) //nolint
-	}
-
-	detachproxy.InitBehaviorFromEnv(cmd, conf.Getenv, defaultDetach)
-
 	cmdproxy.Run(cmd, conf.GithubActions, conf.Getenv)
 }