Add run integration test

.gitignore

@@ -45,3 +45,6 @@ vers.toml
 .actrc
 # Added by goreleaser init:
 dist/
+
+# Allow for testing
+!test/testdata/vers.toml

README.md

@@ -2,19 +2,19 @@
 
 A command-line interface for managing virtual machine/container-based development environments.
 
-
 ## Development
 
-The scripts you should use as models are `status.go`, `execute.go`, `up.go`, `branch.go`. 
+The scripts you should use as models are `status.go`, `execute.go`, `up.go`, `branch.go`.
+
+You can largely have AI generate new command scripts with those previous scripts as a model. You'll have to manually adjust the SDK calls, though, since the AI won't have access to the details of the SDK.
 
-You can largely have AI generate new command scripts with those previous scripts as a model. You'll have to manually adjust the SDK calls, though, since the AI won't have access to the details of the SDK. 
+If a request specifies a parameter you'll see this type
 
-If a request specifies a parameter you'll see this type 
 ```
 Command param.Field[string] `json:"command,required"`
 ```
-Make sure that you prepare the parameter as follows: `vers.F(commandStr)`. See the "Request Fields" section of the [Go SDK Readme](https://github.com/hdresearch/vers-sdk-go) for more details. You can also look at the example of `execute.go`. 
 
+Make sure that you prepare the parameter as follows: `vers.F(commandStr)`. See the "Request Fields" section of the [Go SDK Readme](https://github.com/hdresearch/vers-sdk-go) for more details. You can also look at the example of `execute.go`.
 
 ## Features
 
@@ -29,7 +29,6 @@ Make sure that you prepare the parameter as follows: `vers.F(commandStr)`. See t
 go install github.com/hdresearch/vers-cli/cmd/vers@latest
 ```
 
-
 ## Usage
 
 ### Available Commands
@@ -53,7 +52,7 @@ vers branch <vm-id>
 
 ## Configuration
 
-Vers CLI uses a `vers.toml` configuration file to define your environment. 
+Vers CLI uses a `vers.toml` configuration file to define your environment.
 The file should be created manually and can be customized for your specific needs.
 
 Example:
@@ -74,20 +73,38 @@ command = "python main.py"
 DATABASE_URL = "postgres://localhost:5432/mydb"
 ```
 
-
 ## Development
 
 To build the binary locally, run:
+
 ```bash
 go build -o bin/vers ./cmd/vers
 ```
 
-This repository uses [Air](https://github.com/air-verse/air?tab=readme-ov-file) for development with hot reloading. You can run 
+This repository uses [Air](https://github.com/air-verse/air?tab=readme-ov-file) for development with hot reloading. You can run
+
 ```
 air
 ```
+
 which will take the place of running the binary. So to develop on e.g. `vers status` you would run
 
 ```
 air status
-```
+```
+
+### Integration Testing
+
+Add environment the following environment variables to a .env file at the root of this repository.
+
+```bash
+VERS_URL="https://api.vers.sh"
+VERS_API_KEY="sk-vers-api…"
+GO_PATH=…  # Path to your go executable. E.g. "/usr/local/go/bin/go"
+```
+
+To run the integration tests in the `test` package, run
+
+```bash
+cd test && go test -v
+```

test/run_test.go

@@ -0,0 +1,200 @@
+package test
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"path/filepath"
+	"regexp"
+	"testing"
+
+	"os/exec"
+
+	"github.com/joho/godotenv"
+
+	"time"
+)
+
+func TestVersRun(t *testing.T) {
+	loadEnv(t)
+
+	checkEnv(t)
+
+	var installPath string = createTempInstallDir(t)
+
+	var versCliPath string = installVersCli(t, installPath)
+
+	login(t, versCliPath)
+
+	copyVersToml(t, installPath)
+
+	var got = execVersRun(t, versCliPath)
+
+	validateOutput(t, got)
+
+	clusterId, err := extractClusterId(got)
+
+	if err != nil {
+		t.Fatalf("Failed to extract cluster ID. Cannot kill cluster. Got error: %v", err)
+	}
+
+	killNewCluster(t, clusterId, versCliPath)
+}
+
+// Load VERS_API_KEY and GO_PATH
+// The .env file should be located in the root directory of the project.
+func loadEnv(t *testing.T) {
+	var rootDirPath string = getRootDirPath(t)
+	godotenv.Load(
+		filepath.Join(
+			rootDirPath,
+			".env",
+		),
+	)
+}
+
+// Validate that the necessary environment variables are set.
+func checkEnv(t *testing.T) {
+	var goPath, versApiKey string = os.Getenv("GO_PATH"), os.Getenv("VERS_API_KEY")
+	var missing []string = []string{}
+
+	if goPath == "" {
+		missing = append(missing, "GO_PATH")
+	}
+	if versApiKey == "" {
+		missing = append(missing, "VERS_API_KEY")
+	}
+	if len(missing) > 0 {
+		t.Skipf("Skipping test because environment variables are not set. Missing: %v", missing)
+	}
+}
+
+// Create a temporary directory for installing the CLI.
+// We also use this directory for the vers.toml
+func createTempInstallDir(t *testing.T) string {
+	var currentDate string = time.Now().Format(time.DateTime)
+
+	tmpDir, err := filepath.Abs("/tmp")
+	if err != nil {
+		t.Fatal("Failed to resolve tmp directory. ")
+	}
+
+	installPath := filepath.Join(tmpDir, "vers-cli-run-test-"+currentDate)
+
+	execCommand(t, "", make(map[string]string), "mkdir", "-p", installPath)
+	return installPath
+}
+
+// Compile and install the local cmd/vers package
+func installVersCli(t *testing.T, installPath string) string {
+	var goPath string = filepath.Clean(os.Getenv("GO_PATH"))
+	rootDirPath := getRootDirPath(t)
+
+	execCommand(
+		t, "", map[string]string{
+			"GOBIN": installPath,
+		}, goPath, "install", filepath.Join(rootDirPath, "cmd", "vers"),
+	)
+	return filepath.Join(installPath, "vers")
+}
+
+// Login to the locally installed CLI
+func login(t *testing.T, versCliPath string) {
+
+	var apiKey string = os.Getenv("VERS_API_KEY")
+	execCommand(
+		t, "", make(map[string]string), versCliPath, "login", "--token", apiKey,
+	)
+}
+
+// Copy the test vers.toml to the testing directory
+func copyVersToml(t *testing.T, installPath string) {
+	rootDirPath := getRootDirPath(t)
+	var versTomlPath string = filepath.Join(rootDirPath, "test", "testdata", "vers.toml")
+	var destPath string = filepath.Join(installPath, "vers.toml")
+
+	execCommand(
+		t, "", make(map[string]string), "cp", versTomlPath, destPath,
+	)
+}
+
+// Exec 'vers run'
+func execVersRun(t *testing.T, versCliPath string) string {
+	return execCommand(
+		t, "./testdata", make(map[string]string), versCliPath, "run",
+	)
+}
+
+// Validate the output of 'vers run'
+func validateOutput(t *testing.T, got string) {
+	var want = regexp.MustCompile(`Sending request to start cluster...\nCluster \(ID: \w+\) started successfully with root vm '[\w-]+'\.`)
+
+	if !want.MatchString(got) {
+		t.Errorf("Unexpected output. Want = %#q \nGot = %v", want, got)
+	}
+}
+
+// Extract the cluster ID
+func extractClusterId(got string) (string, error) {
+	var re = regexp.MustCompile(`Cluster \(ID: (\w+)\) started successfully`)
+	var matches = re.FindStringSubmatch(got)
+
+	if len(matches) == 2 {
+		var clusterId = matches[1]
+		return clusterId, nil
+	}
+
+	return "", errors.New("Failed to extract cluster ID. No match found in output.")
+}
+
+// Teardown the newly created cluster
+func killNewCluster(t *testing.T, clusterId string, versCliPath string) {
+	execCommand(t, "", make(map[string]string), versCliPath, "kill", "-c", "-y", clusterId)
+}
+
+// Utility functions
+
+// Get the root directory path
+func getRootDirPath(t *testing.T) string {
+	var rootDirPath string
+	var err error
+	rootDirPath, err = filepath.Abs("..")
+	if err != nil {
+		t.Fatal("Failed to resolve root directory. ")
+	}
+	return rootDirPath
+}
+
+// Executes commands in the specified directory
+// Logs stdout and errors
+// Command failures are fatal
+func execCommand(t *testing.T, dir string, env map[string]string, command string, args ...string) string {
+
+	t.Logf("Executing command %v with args %v…\n", command, args)
+	var cmd = exec.Command(
+		command, args...,
+	)
+
+	// Set the command's directory
+	cmd.Dir = dir
+
+	// Update the command's environment variables
+	for k, v := range env {
+		cmd.Env = append(cmd.Environ(), fmt.Sprintf("%s=%s", k, v))
+	}
+
+	// Execute the command and capture the output
+	var output, err = cmd.Output()
+
+	var stdout string = ""
+	if output != nil {
+		stdout = string(output)
+		t.Logf("Got output: %v\n", stdout)
+	}
+
+	if err != nil {
+		t.Fatalf("Failed to execute command. Got error: %v\n", err)
+	}
+
+	return stdout
+}

test/testdata/vers.toml

@@ -0,0 +1,14 @@
+[machine]
+  mem_size_mib = 512
+  vcpu_count = 1
+  fs_size_cluster_mib = 1024
+  fs_size_vm_mib = 512
+
+[rootfs]
+  name = "default"
+
+[builder]
+  name = "none"
+
+[kernel]
+  name = "default.bin"