add tests and example hat for on_start

Author: deansheather

hat-examples/on_start/Dockerfile

@@ -0,0 +1,6 @@
+FROM codercom/ubuntu-dev
+
+# The command in the on_start label will be run immediately after the
+# project starts. You could use this to reinstall dependencies or
+# perform any other bootstrapping tasks.
+LABEL on_start="touch did_on_start"

internal/dockutil/exec.go

@@ -11,6 +11,11 @@ func Exec(cntName, cmd string, args ...string) *exec.Cmd {
 	return exec.Command("docker", args...)
 }
 
+func ExecDir(cntName, dir, cmd string, args ...string) *exec.Cmd {
+	args = append([]string{"exec", "-w", dir, "-i", cntName, cmd}, args...)
+	return exec.Command("docker", args...)
+}
+
 func ExecTTY(cntName, dir, cmd string, args ...string) *exec.Cmd {
 	args = append([]string{"exec", "-w", dir, "-it", cntName, cmd}, args...)
 	return exec.Command("docker", args...)

runner_test.go

@@ -1,15 +1,18 @@
 package main
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"go.coder.com/sail/internal/dockutil"
 )
 
 func Test_runner(t *testing.T) {
 	// Ensure that the testing environment won't conflict with any running sail projects.
-	requireProjectsNotRunning(t, "cdr/nbin", "cdr/flog", "cdr/bigdur", "cdr/sshcode")
+	requireProjectsNotRunning(t, "cdr/nbin", "cdr/flog", "cdr/bigdur", "cdr/sshcode", "cdr/cli")
 	requireUbuntuDevImage(t)
 
 	// labelChecker asserts that all of the correct labels
@@ -73,6 +76,23 @@ func Test_runner(t *testing.T) {
 		})
 	}
 
+	// containsFile ensures that a container contains a file.
+	// This is used for testing the on_start label.
+	containsFile := func(name, path string) func(*testing.T, *params) {
+		return func(t *testing.T, p *params) {
+			t.Run(name, func(t *testing.T) {
+				cntDir, err := p.proj.containerDir()
+				require.NoError(t, err)
+				cntDir = resolvePath(containerHome, cntDir)
+
+				// Run the file existence check using /bin/sh.
+				cmdStr := fmt.Sprintf(`[ -f "%s" ]`, path)
+				err = dockutil.ExecDir(p.proj.cntName(), cntDir, "/bin/sh", "-c", cmdStr).Run()
+				require.NoError(t, err)
+			})
+		}
+	}
+
 	run(t, "BaseImageNoHat", "https://github.com/cdr/nbin", "",
 		labelChecker,
 		codeServerStarts,
@@ -96,4 +116,13 @@ func Test_runner(t *testing.T) {
 		codeServerStarts,
 		loadFromContainer,
 	)
+
+	run(t, "ProjImageOnStartHat", "https://github.com/cdr/cli", "./hat-examples/on_start",
+		labelChecker,
+		codeServerStarts,
+		loadFromContainer,
+
+		// ./hat-examples/on_start should create `did_on_start` in the project directory.
+		containsFile("ContainsOnStartFile", "did_on_start"),
+	)
 }