fix: Stabilise the CI

.github/workflows/ci.yml

@@ -54,18 +54,6 @@ jobs:
       - name: Run fast tests
         run: go test -v -race ./internal/...
 
-      - name: Download Remoteproc Simulator
-        uses: robinraju/release-downloader@daf26c55d821e836577a15f77d86ddc078948b05 # v1.12
-        with:
-          repository: arm/remoteproc-simulator
-          tag: 'v0.0.8'
-          fileName: remoteproc-simulator_*_linux_amd64.tar.gz
-          out-file-path: remoteproc-simulator
-          extract: true
-
-      - name: Install Remoteproc Simulator
-        run: echo "$PWD/remoteproc-simulator" >> $GITHUB_PATH
-
       - name: Set up Lima
         uses: lima-vm/lima-actions/setup@03b96d61959e83b2c737e44162c3088e81de0886 # v1.0.1
         id: lima-actions-setup

e2e/limavm/debian.go

@@ -4,8 +4,8 @@ type Debian struct {
 	VM
 }
 
-func NewDebian(mountDir string) (Debian, error) {
-	vm, err := newVM("debian", mountDir)
+func NewDebian() (Debian, error) {
+	vm, err := newVM("debian")
 	if err != nil {
 		return Debian{}, err
 	}

e2e/limavm/docker.go

@@ -8,8 +8,8 @@ type Docker struct {
 	VM
 }
 
-func NewDocker(mountDir string) (Docker, error) {
-	vm, err := newVM("docker", mountDir)
+func NewDocker() (Docker, error) {
+	vm, err := newVM("docker")
 	if err != nil {
 		return Docker{}, err
 	}

e2e/limavm/limavm.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/arm/remoteproc-runtime/e2e/limavm/scripts"
@@ -19,8 +20,8 @@ var BinBuildEnv = map[string]string{
 	"GOOS": "linux",
 }
 
-func newVM(template string, mountDir string) (VM, error) {
-	vmName, err := scripts.PrepareLimaVM(template, mountDir)
+func newVM(template string) (VM, error) {
+	vmName, err := scripts.PrepareLimaVM(template)
 	return VM{name: vmName}, err
 }
 
@@ -84,6 +85,29 @@ func (vm VM) RunCommand(name string, args ...string) (stdout, stderr string, err
 	return stdout, stderr, nil
 }
 
+func (vm VM) ReadFileAsString(path string) (string, error) {
+	stdout, stderr, err := vm.RunCommand("cat", path)
+	if err != nil {
+		return "", fmt.Errorf("failed to read file %s: %w\nstderr:\n%s", path, err, stderr)
+	}
+	return stdout, nil
+}
+
+func (vm VM) ReadDir(path string) ([]string, error) {
+	stdout, stderr, err := vm.RunCommand("ls", "-1", path)
+	if err != nil {
+		return nil, fmt.Errorf("failed to read directory %s: %w\nstderr:\n%s", path, err, stderr)
+	}
+	entries := []string{}
+	for _, line := range strings.Split(stdout, "\n") {
+		line = strings.TrimSpace(line)
+		if line != "" {
+			entries = append(entries, line)
+		}
+	}
+	return entries, nil
+}
+
 type Runnable interface {
 	Run(args ...string) (stdout, stderr string, err error)
 }
@@ -97,6 +121,10 @@ func (b InstalledBin) Run(args ...string) (stdout, stderr string, err error) {
 	return b.vm.RunCommand(b.pathToBin, args...)
 }
 
+func (b InstalledBin) Command(args ...string) *exec.Cmd {
+	return b.vm.cmd(b.pathToBin, args...)
+}
+
 func (b InstalledBin) Path() string {
 	return b.pathToBin
 }

e2e/limavm/podman.go

@@ -8,8 +8,8 @@ type Podman struct {
 	VM
 }
 
-func NewPodman(mountDir string) (Podman, error) {
-	vm, err := newVM("podman", mountDir)
+func NewPodman() (Podman, error) {
+	vm, err := newVM("podman")
 	if err != nil {
 		return Podman{}, err
 	}

e2e/limavm/scripts/prepare-lima-vm.sh

@@ -8,9 +8,8 @@ TEMPLATE=""
 MOUNT_DIR=""
 
 usage() {
-    echo "Usage: $0 <template> <mount-dir>" >&2
+    echo "Usage: $0 <template>" >&2
     echo "  template:         Lima template to use (docker or podman)" >&2
-    echo "  mount-dir:        Directory attached in the vm" >&2
     exit 1
 }
 
@@ -22,7 +21,7 @@ cleanup_on_failure() {
 
 create_vm() {
     echo "Creating Lima VM..." >&2
-    if ! limactl create --tty=false --name "$VM_NAME" --set ".mounts += [{\"location\":\"$MOUNT_DIR\",\"writable\":true}]" "template://$TEMPLATE"; then
+    if ! limactl create --tty=false --name "$VM_NAME" "template://$TEMPLATE"; then
         echo "Error: Failed to create VM" >&2
         exit 1
     fi
@@ -38,12 +37,11 @@ start_vm() {
 }
 
 main() {
-    if [ $# -ne 2 ]; then
+    if [ $# -ne 1 ]; then
         usage
     fi
 
     TEMPLATE="$1"
-    MOUNT_DIR="$2"
 
     VM_NAME="remoteproc-test-vm-$(date +%s)"
     echo "Creating VM: $VM_NAME" >&2

e2e/limavm/scripts/scripts.go

@@ -18,8 +18,8 @@ var (
 	teardownLimaVMScript = filepath.Join(scriptsDir, "teardown-lima-vm.sh")
 )
 
-func PrepareLimaVM(template string, mountDir string) (string, error) {
-	prepareCmd := exec.Command(prepareLimaVMScript, template, mountDir)
+func PrepareLimaVM(template string) (string, error) {
+	prepareCmd := exec.Command(prepareLimaVMScript, template)
 	prepareStreamer := runner.NewStreamingCmd(prepareCmd).WithPrefix("prepare-vm")
 
 	if err := prepareStreamer.Start(); err != nil {

e2e/remoteproc/assert.go

@@ -1,38 +1,38 @@
 package remoteproc
 
 import (
-	"os"
 	"path/filepath"
 	"testing"
 	"time"
 
+	"github.com/arm/remoteproc-runtime/e2e/limavm"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
-func AssertState(t testing.TB, deviceDir string, wantState string) {
+func AssertState(t testing.TB, vm limavm.VM, deviceDir, wantState string) {
 	t.Helper()
 	const waitFor = 500 * time.Millisecond
 	const tickEvery = 100 * time.Millisecond
 	stateFilePath := filepath.Join(deviceDir, "state")
 	assert.EventuallyWithT(t, func(c *assert.CollectT) {
-		assertFileContent(c, stateFilePath, wantState)
+		assertFileContent(c, vm, stateFilePath, wantState)
 	}, waitFor, tickEvery)
 }
 
-func RequireState(t testing.TB, deviceDir string, wantState string) {
+func RequireState(t testing.TB, vm limavm.VM, deviceDir, wantState string) {
 	t.Helper()
 	const waitFor = 500 * time.Millisecond
 	const tickEvery = 100 * time.Millisecond
 	stateFilePath := filepath.Join(deviceDir, "state")
 	require.EventuallyWithT(t, func(c *assert.CollectT) {
-		assertFileContent(c, stateFilePath, wantState)
+		assertFileContent(c, vm, stateFilePath, wantState)
 	}, waitFor, tickEvery)
 }
 
-func assertFileContent(t assert.TestingT, path string, wantContent string) {
-	gotContent, err := os.ReadFile(path)
+func assertFileContent(t assert.TestingT, vm limavm.VM, path, wantContent string) {
+	gotContent, err := vm.ReadFileAsString(path)
 	if assert.NoError(t, err) {
-		assert.Equal(t, wantContent, string(gotContent))
+		assert.Equal(t, wantContent, gotContent)
 	}
 }

e2e/remoteproc/simulator.go

@@ -1,22 +1,28 @@
 package remoteproc
 
 import (
+	"bufio"
 	"fmt"
-	"os/exec"
+	"io"
 	"path/filepath"
+	"strings"
+	"time"
 
+	"github.com/arm/remoteproc-runtime/e2e/limavm"
 	"github.com/arm/remoteproc-runtime/e2e/runner"
 )
 
 type Simulator struct {
+	vm      limavm.InstalledBin
 	cmd     *runner.StreamingCmd
 	name    string
 	index   uint
 	rootDir string
 }
 
-func NewSimulator(rootDir string) *Simulator {
+func NewSimulator(vm limavm.InstalledBin, rootDir string) *Simulator {
 	return &Simulator{
+		vm:      vm,
 		rootDir: rootDir,
 		index:   0,
 		name:    "some-cpu",
@@ -29,20 +35,68 @@ func (r *Simulator) WithName(name string) *Simulator {
 }
 
 func (r *Simulator) Start() error {
-	cmd := exec.Command(
-		"remoteproc-simulator",
+	cmd := r.vm.Command(
 		"--root-dir", r.rootDir,
 		"--index", fmt.Sprintf("%d", r.index),
 		"--name", r.name,
 	)
-	streamer := runner.NewStreamingCmd(cmd).WithPrefix("remoteproc-simulator")
+	reader, writer := io.Pipe()
+	streamer := runner.NewStreamingCmd(cmd).WithPrefix("simulator: " + r.name + ": ").WithAdditionalOutput(writer)
 	if err := streamer.Start(); err != nil {
 		return fmt.Errorf("failed to start simulator: %w", err)
 	}
 	r.cmd = streamer
+
+	if err := r.waitForBoot(15*time.Second, reader); err != nil {
+		stopError := r.Stop()
+		if stopError != nil {
+			return fmt.Errorf("simulator failed to create remoteproc device: %w: %s", err, stopError)
+		}
+		return fmt.Errorf("simulator failed to create remoteproc device: %w", err)
+	}
+
 	return nil
 }
 
+func (r *Simulator) waitForBoot(waitingTime time.Duration, outputBuf *io.PipeReader) error {
+	const targetMessage = "Remoteproc initialized at"
+
+	deadline := time.Now().Add(waitingTime)
+	scanner := bufio.NewScanner(outputBuf)
+	timer := time.NewTimer(time.Until(deadline))
+	defer timer.Stop()
+	scanCh := make(chan string)
+	errCh := make(chan error)
+
+	go func() {
+		for scanner.Scan() {
+			scanCh <- scanner.Text()
+		}
+		if err := scanner.Err(); err != nil {
+			errCh <- err
+		} else {
+			close(scanCh)
+		}
+	}()
+
+	for {
+		select {
+		case <-timer.C:
+			return fmt.Errorf("timeout waiting for simulator to create remoteproc device")
+		case line, ok := <-scanCh:
+			if !ok {
+				return fmt.Errorf("simulator output closed before remoteproc device was created")
+			}
+			if strings.Contains(line, targetMessage) {
+				_ = outputBuf.Close()
+				return nil
+			}
+		case err := <-errCh:
+			return fmt.Errorf("scanner error: %w", err)
+		}
+	}
+}
+
 func (r *Simulator) Stop() error {
 	if r.cmd != nil {
 		return r.cmd.Stop()

e2e/repo/bin.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"runtime"
 )
 
 func BuildRuntimeBin(binOutDir string, rootPathPrefix string, env map[string]string) (string, error) {
@@ -72,3 +73,38 @@ func BuildBothBins(binOutDir string, rootPathPrefix string, env map[string]strin
 
 	return []string{runtime, shim}, nil
 }
+
+func BuildRemoteprocSimulator(binOutDir string, env map[string]string) (string, error) {
+	const repoDirName = "remoteproc-simulator"
+	const version = "0.0.8"
+
+	artifactURL := fmt.Sprintf(
+		"https://github.com/arm/remoteproc-simulator/releases/download/v%s/remoteproc-simulator_%s_linux_%s.tar.gz",
+		version,
+		version,
+		runtime.GOARCH,
+	)
+
+	downloader := exec.Command("curl", "-L", "-o", filepath.Join(binOutDir, "simulator.tar.gz"), artifactURL)
+	downloader.Env = os.Environ()
+	for k, v := range env {
+		downloader.Env = append(downloader.Env, fmt.Sprintf("%s=%s", k, v))
+	}
+
+	if out, err := downloader.CombinedOutput(); err != nil {
+		return "", fmt.Errorf("failed to download remoteproc-simulator: %s\n%s", err, out)
+	}
+
+	extractor := exec.Command("tar", "-xzf", filepath.Join(binOutDir, "simulator.tar.gz"), "-C", binOutDir)
+	extractor.Env = os.Environ()
+	for k, v := range env {
+		extractor.Env = append(extractor.Env, fmt.Sprintf("%s=%s", k, v))
+	}
+
+	if out, err := extractor.CombinedOutput(); err != nil {
+		return "", fmt.Errorf("failed to extract remoteproc-simulator: %s\n%s", err, out)
+	}
+
+	simulatorPath := filepath.Join(binOutDir, repoDirName)
+	return simulatorPath, nil
+}