fix: change type *int32 to string

Signed-off-by: Oleksii Kurinnyi <[email protected]>

Author: akurinnoy

apis/controller/v1alpha1/devworkspaceoperatorconfig_types.go

@@ -192,12 +192,10 @@ type WorkspaceConfig struct {
 	// PostStartTimeout defines the maximum duration the PostStart hook can run
 	// before it is automatically failed. This timeout is used for the postStart lifecycle hook
 	// that is used to run commands in the workspace container. The timeout is specified in seconds.
-	// If not specified, the timeout is disabled (0 seconds).
-	// +kubebuilder:validation:Minimum=0
+	// Duration should be specified in a format parseable by Go's time package, e.g. "20s", "2m".
+	// If not specified or "0", the timeout is disabled.
 	// +kubebuilder:validation:Optional
-	// +kubebuilder:validation:Type=integer
-	// +kubebuilder:validation:Format=int32
-	PostStartTimeout *int32 `json:"postStartTimeout,omitempty"`
+	PostStartTimeout string `json:"postStartTimeout,omitempty"`
 }
 
 type WebhookConfig struct {

pkg/config/sync.go

@@ -432,7 +432,7 @@ func mergeConfig(from, to *controller.OperatorConfiguration) {
 			}
 		}
 
-		if from.Workspace.PostStartTimeout != nil {
+		if from.Workspace.PostStartTimeout != "" {
 			to.Workspace.PostStartTimeout = from.Workspace.PostStartTimeout
 		}
 	}
@@ -605,8 +605,8 @@ func GetCurrentConfigString(currConfig *controller.OperatorConfiguration) string
 		if workspace.IdleTimeout != defaultConfig.Workspace.IdleTimeout {
 			config = append(config, fmt.Sprintf("workspace.idleTimeout=%s", workspace.IdleTimeout))
 		}
-		if workspace.PostStartTimeout != nil && workspace.PostStartTimeout != defaultConfig.Workspace.PostStartTimeout {
-			config = append(config, fmt.Sprintf("workspace.postStartTimeout=%d", *workspace.PostStartTimeout))
+		if workspace.PostStartTimeout != defaultConfig.Workspace.PostStartTimeout {
+			config = append(config, fmt.Sprintf("workspace.postStartTimeout=%s", workspace.PostStartTimeout))
 		}
 		if workspace.ProgressTimeout != "" && workspace.ProgressTimeout != defaultConfig.Workspace.ProgressTimeout {
 			config = append(config, fmt.Sprintf("workspace.progressTimeout=%s", workspace.ProgressTimeout))

pkg/library/container/container.go

@@ -45,7 +45,7 @@ import (
 // rewritten as Volumes are added to PodAdditions, in order to support e.g. using one PVC to hold all volumes
 //
 // Note: Requires DevWorkspace to be flattened (i.e. the DevWorkspace contains no Parent or Components of type Plugin)
-func GetKubeContainersFromDevfile(workspace *dw.DevWorkspaceTemplateSpec, securityContext *corev1.SecurityContext, pullPolicy string, defaultResources *corev1.ResourceRequirements, postStartTimeout *int32) (*v1alpha1.PodAdditions, error) {
+func GetKubeContainersFromDevfile(workspace *dw.DevWorkspaceTemplateSpec, securityContext *corev1.SecurityContext, pullPolicy string, defaultResources *corev1.ResourceRequirements, postStartTimeout string) (*v1alpha1.PodAdditions, error) {
 	if !flatten.DevWorkspaceIsFlattened(workspace, nil) {
 		return nil, fmt.Errorf("devfile is not flattened")
 	}

pkg/library/container/container_test.go

@@ -87,7 +87,7 @@ func TestGetKubeContainersFromDevfile(t *testing.T) {
 		t.Run(tt.Name, func(t *testing.T) {
 			// sanity check that file is read correctly.
 			assert.True(t, len(tt.Input.Components) > 0, "Input defines no components")
-			gotPodAdditions, err := GetKubeContainersFromDevfile(tt.Input, nil, testImagePullPolicy, defaultResources, nil)
+			gotPodAdditions, err := GetKubeContainersFromDevfile(tt.Input, nil, testImagePullPolicy, defaultResources, "")
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {

pkg/library/lifecycle/poststart.go

@@ -16,9 +16,11 @@ package lifecycle
 import (
 	"fmt"
 	"strings"
+	"time"
 
 	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	corev1 "k8s.io/api/core/v1"
+	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
 const (
@@ -39,7 +41,7 @@ const (
 `
 )
 
-func AddPostStartLifecycleHooks(wksp *dw.DevWorkspaceTemplateSpec, containers []corev1.Container, postStartTimeout *int32) error {
+func AddPostStartLifecycleHooks(wksp *dw.DevWorkspaceTemplateSpec, containers []corev1.Container, postStartTimeout string) error {
 	if wksp.Events == nil || len(wksp.Events.PostStart) == 0 {
 		return nil
 	}
@@ -83,8 +85,8 @@ func AddPostStartLifecycleHooks(wksp *dw.DevWorkspaceTemplateSpec, containers []
 
 // processCommandsForPostStart processes a list of DevWorkspace commands
 // and generates a corev1.LifecycleHandler for the PostStart lifecycle hook.
-func processCommandsForPostStart(commands []dw.Command, postStartTimeout *int32) (*corev1.LifecycleHandler, error) {
-	if postStartTimeout == nil || *postStartTimeout == 0 {
+func processCommandsForPostStart(commands []dw.Command, postStartTimeout string) (*corev1.LifecycleHandler, error) {
+	if postStartTimeout == "" {
 		// use the fallback if no timeout propagated
 		return processCommandsWithoutTimeoutFallback(commands)
 	}
@@ -99,7 +101,7 @@ func processCommandsForPostStart(commands []dw.Command, postStartTimeout *int32)
 	scriptToExecute := "set -e\n" + originalUserScript
 	escapedUserScriptForTimeoutWrapper := strings.ReplaceAll(scriptToExecute, "'", `'\''`)
 
-	fullScriptWithTimeout := generateScriptWithTimeout(escapedUserScriptForTimeoutWrapper, *postStartTimeout)
+	fullScriptWithTimeout := generateScriptWithTimeout(escapedUserScriptForTimeoutWrapper, postStartTimeout)
 
 	finalScriptForHook := fmt.Sprintf(redirectOutputFmt, fullScriptWithTimeout)
 
@@ -185,7 +187,19 @@ func buildUserScript(commands []dw.Command) (string, error) {
 // environment variable exports, and specific exit code handling.
 // The killAfterDurationSeconds is hardcoded to 5s within this generated script.
 // It conditionally prefixes the user script with the timeout command if available.
-func generateScriptWithTimeout(escapedUserScript string, timeoutSeconds int32) string {
+func generateScriptWithTimeout(escapedUserScript string, postStartTimeout string) string {
+	// Convert `postStartTimeout` into the `timeout` format
+	var timeoutSeconds int64
+	if postStartTimeout != "" && postStartTimeout != "0" {
+		duration, err := time.ParseDuration(postStartTimeout)
+		if err != nil {
+			log.Log.Error(err, "Could not parse post-start timeout, disabling timeout", "value", postStartTimeout)
+			timeoutSeconds = 0
+		} else {
+			timeoutSeconds = int64(duration.Seconds())
+		}
+	}
+
 	return fmt.Sprintf(`
 export POSTSTART_TIMEOUT_DURATION="%d"
 export POSTSTART_KILL_AFTER_DURATION="5"

pkg/library/lifecycle/poststart_test.go

@@ -75,8 +75,8 @@ func TestAddPostStartLifecycleHooks(t *testing.T) {
 	tests := loadAllPostStartTestCasesOrPanic(t, "./testdata/postStart")
 	for _, tt := range tests {
 		t.Run(fmt.Sprintf("%s (%s)", tt.Name, tt.testPath), func(t *testing.T) {
-			var timeout int32
-			err := AddPostStartLifecycleHooks(tt.Input.Devfile, tt.Input.Containers, &timeout)
+			var timeout string
+			err := AddPostStartLifecycleHooks(tt.Input.Devfile, tt.Input.Containers, timeout)
 			if tt.Output.ErrRegexp != nil && assert.Error(t, err) {
 				assert.Regexp(t, *tt.Output.ErrRegexp, err.Error(), "Error message should match")
 			} else {
@@ -298,13 +298,13 @@ func TestGenerateScriptWithTimeout(t *testing.T) {
 	tests := []struct {
 		name              string
 		escapedUserScript string
-		timeoutSeconds    int32
+		timeout           string
 		expectedScript    string
 	}{
 		{
 			name:              "Basic script with timeout",
 			escapedUserScript: "echo 'hello world'\nsleep 1",
-			timeoutSeconds:    10,
+			timeout:           "10s",
 			expectedScript: `
 export POSTSTART_TIMEOUT_DURATION="10"
 export POSTSTART_KILL_AFTER_DURATION="5"
@@ -350,7 +350,7 @@ exit $exit_code
 		{
 			name:              "Script with zero timeout (no timeout)",
 			escapedUserScript: "echo 'running indefinitely...'",
-			timeoutSeconds:    0,
+			timeout:           "0s",
 			expectedScript: `
 export POSTSTART_TIMEOUT_DURATION="0"
 export POSTSTART_KILL_AFTER_DURATION="5"
@@ -395,7 +395,7 @@ exit $exit_code
 		{
 			name:              "Empty user script",
 			escapedUserScript: "",
-			timeoutSeconds:    5,
+			timeout:           "5s",
 			expectedScript: `
 export POSTSTART_TIMEOUT_DURATION="5"
 export POSTSTART_KILL_AFTER_DURATION="5"
@@ -440,7 +440,7 @@ exit $exit_code
 		{
 			name:              "User script with already escaped single quotes",
 			escapedUserScript: "echo 'it'\\''s complex'",
-			timeoutSeconds:    30,
+			timeout:           "30s",
 			expectedScript: `
 export POSTSTART_TIMEOUT_DURATION="30"
 export POSTSTART_KILL_AFTER_DURATION="5"
@@ -479,14 +479,59 @@ else
   fi
 fi
 
+exit $exit_code
+`,
+		},
+		{
+			name:              "User script with minute timeout",
+			escapedUserScript: "echo 'wait for it...'",
+			timeout:           "2m",
+			expectedScript: `
+export POSTSTART_TIMEOUT_DURATION="120"
+export POSTSTART_KILL_AFTER_DURATION="5"
+
+_TIMEOUT_COMMAND_PART=""
+_WAS_TIMEOUT_USED="false" # Use strings "true" or "false" for shell boolean
+
+if command -v timeout >/dev/null 2>&1; then
+  echo "[postStart hook] Executing commands with timeout: ${POSTSTART_TIMEOUT_DURATION} seconds, kill after: ${POSTSTART_KILL_AFTER_DURATION} seconds" >&2
+  _TIMEOUT_COMMAND_PART="timeout --preserve-status --kill-after=${POSTSTART_KILL_AFTER_DURATION} ${POSTSTART_TIMEOUT_DURATION}"
+  _WAS_TIMEOUT_USED="true"
+else
+  echo "[postStart hook] WARNING: 'timeout' utility not found. Executing commands without timeout." >&2
+fi
+
+# Execute the user's script
+${_TIMEOUT_COMMAND_PART} /bin/sh -c 'echo 'wait for it...''
+exit_code=$?
+
+# Check the exit code based on whether timeout was attempted
+if [ "$_WAS_TIMEOUT_USED" = "true" ]; then
+  if [ $exit_code -eq 143 ]; then # 128 + 15 (SIGTERM)
+    echo "[postStart hook] Commands terminated by SIGTERM (likely timed out after ${POSTSTART_TIMEOUT_DURATION}s). Exit code 143." >&2
+  elif [ $exit_code -eq 137 ]; then # 128 + 9 (SIGKILL)
+    echo "[postStart hook] Commands forcefully killed by SIGKILL (likely after --kill-after ${POSTSTART_KILL_AFTER_DURATION}s expired). Exit code 137." >&2
+  elif [ $exit_code -ne 0 ]; then # Catches any other non-zero exit code
+    echo "[postStart hook] Commands failed with exit code $exit_code." >&2
+  else
+    echo "[postStart hook] Commands completed successfully within the time limit." >&2
+  fi
+else
+  if [ $exit_code -ne 0 ]; then
+    echo "[postStart hook] Commands failed with exit code $exit_code (no timeout)." >&2
+  else
+    echo "[postStart hook] Commands completed successfully (no timeout)." >&2
+  fi
+fi
+
 exit $exit_code
 `,
 		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			script := generateScriptWithTimeout(tt.escapedUserScript, tt.timeoutSeconds)
+			script := generateScriptWithTimeout(tt.escapedUserScript, tt.timeout)
 			assert.Equal(t, tt.expectedScript, script)
 		})
 	}