Make container startup timeout configurable (#65)

* make container startup timeout configurable

Signed-off-by: James Lamb <[email protected]>

* address linter warnings

Signed-off-by: James Lamb <[email protected]>

* simplify

Signed-off-by: James Lamb <[email protected]>

* use a different, less segfault-y path to pass configuration

Signed-off-by: James Lamb <[email protected]>

* remove startupTimeout from the Container class

Signed-off-by: James Lamb <[email protected]>

* more simplifications

Signed-off-by: James Lamb <[email protected]>

* add tests

Signed-off-by: James Lamb <[email protected]>

* revert tests

Signed-off-by: James Lamb <[email protected]>

* revert one more test thing

Signed-off-by: James Lamb <[email protected]>

---------

Signed-off-by: James Lamb <[email protected]>

Author: jameslamb

cmd/validate.go

@@ -86,5 +86,5 @@ func init() {
 	rootCmd.AddCommand(validateCmd)
 	validateCmd.PersistentFlags().String("file", "", "Path or URL of a manifest to validate against.")
 	validateCmd.PersistentFlags().Bool("debug", false, "Keep container running on failure for debugging.")
-
+	validateCmd.PersistentFlags().Int("startup-timeout", 10, "Maximum time (in seconds) to wait for the container to start up.")
 }

internal/container/container.go

@@ -37,7 +37,7 @@ type ContainerInfo struct {
 }
 
 type ContainerInterface interface {
-	Start() error
+	Start(timeoutSeconds int) error
 	Remove() error
 	Status() (*ContainerInfo, error)
 	Exec(command ...string) (string, error)

internal/container/docker.go

@@ -22,10 +22,11 @@ type DockerContainer struct {
 	Volumes    []canaryv1.Volume
 	RunOptions []string
 	runCommand string
+	StartupTimeout int
 }
 
 // Start a container
-func (c *DockerContainer) Start() error {
+func (c *DockerContainer) Start(timeoutSeconds int) error {
 
 	commandArgs := []string{"run", "-d"}
 
@@ -78,12 +79,12 @@ func (c *DockerContainer) Start() error {
 		if info.State.Running {
 			break
 		}
-		if time.Since(startTime) > (time.Second * 10) {
+		if time.Since(startTime) > (time.Second * time.Duration(timeoutSeconds)) {
 			err := c.Remove()
 			if err != nil {
 				return err
 			}
-			return errors.New("container failed to start after 10 seconds")
+			return fmt.Errorf("container failed to start after %d seconds", timeoutSeconds)
 		}
 		time.Sleep(time.Second)
 	}

internal/container/docker_test.go

@@ -39,7 +39,7 @@ func TestDockerContainer(t *testing.T) {
 	}
 	c := New("nginx", env, ports, volumes, nil, nil)
 
-	err := c.Start()
+	err := c.Start(10)
 
 	defer func() {
 		err := c.Remove()
@@ -71,7 +71,7 @@ func TestDockerContainer(t *testing.T) {
 func TestDockerContainerRemoves(t *testing.T) {
 	c := New("nginx", nil, nil, nil, nil, nil)
 
-	err := c.Start()
+	err := c.Start(10)
 	if err != nil {
 		t.Errorf("Failed to start container: %s", err.Error())
 		return

internal/validator/tui.go

@@ -28,19 +28,20 @@ import (
 )
 
 type model struct {
-	sub              chan checkResult
-	container        container.ContainerInterface
-	containerStarted bool
-	results          []checkResult
-	allChecksPassed  bool
-	spinner          spinner.Model
-	progress         progress.Model
-	debug            bool
-	image            string
-	validator        *canaryv1.Validator
-	configPath       string
-	err              error
-	tty              bool
+	sub                     chan checkResult
+	container               container.ContainerInterface
+	containerStarted        bool
+	containerStartupTimeout int
+	results                 []checkResult
+	allChecksPassed         bool
+	spinner                 spinner.Model
+	progress                progress.Model
+	debug                   bool
+	image                   string
+	validator               *canaryv1.Validator
+	configPath              string
+	err                     error
+	tty                     bool
 }
 
 func (m model) Init() tea.Cmd {
@@ -133,7 +134,7 @@ func handleConfigLoaded(m model, msg configLoaded) (model, tea.Cmd) {
 	if !m.tty {
 		commands = append(commands, tea.Printf("Starting container"))
 	}
-	commands = append(commands, startContainer(m.image, m.validator))
+	commands = append(commands, startContainer(m.image, m.validator, m.containerStartupTimeout))
 	return m, tea.Batch(commands...)
 }
 

internal/validator/validator.go

@@ -69,16 +69,21 @@ func Validate(image string, configPath string, cmd *cobra.Command, debug bool) (
 		tty = bufio.NewReader(os.Stdin)
 		isTty = false
 	}
+	startupTimeout, err := cmd.Flags().GetInt("startup-timeout")
+	if err != nil {
+		return false, err
+	}
 	m := model{
-		sub:              make(chan checkResult),
-		configPath:       configPath,
-		containerStarted: false,
-		spinner:          spinner.New(),
-		progress:         progress.New(progress.WithSolidFill("#f2e63a")),
-		allChecksPassed:  true,
-		debug:            debug,
-		image:            image,
-		tty:              isTty,
+		sub:                     make(chan checkResult),
+		configPath:              configPath,
+		containerStarted:        false,
+		containerStartupTimeout: startupTimeout,
+		spinner:                 spinner.New(),
+		progress:                progress.New(progress.WithSolidFill("#f2e63a")),
+		allChecksPassed:         true,
+		debug:                   debug,
+		image:                   image,
+		tty:                     isTty,
 	}
 	p := tea.NewProgram(m, tea.WithInput(tty), tea.WithOutput(cmd.OutOrStderr()))
 	out, err := p.Run()
@@ -123,10 +128,10 @@ func loadConfig(filePath string) tea.Cmd {
 	}
 }
 
-func startContainer(image string, validator *canaryv1.Validator) tea.Cmd {
+func startContainer(image string, validator *canaryv1.Validator, startupTimeout int) tea.Cmd {
 	return func() tea.Msg {
 		container := container.New(image, validator.Env, validator.Ports, validator.Volumes, validator.Command, validator.DockerRunOptions)
-		err := container.Start()
+		err := container.Start(startupTimeout)
 		if err != nil {
 			return containerFailed{Error: err}
 		}