Merge branch '5-fix-ruby-needs-to-be-the-last-runtime-installed'

Author: jeremylevy

internal/grpcserver/install_runtimes.go

@@ -9,12 +9,18 @@ import (
 	"os"
 	"os/exec"
 	"path"
+	"sort"
 
 	"github.com/eleven-sh/agent/config"
 	"github.com/eleven-sh/agent/internal/env"
 	"github.com/eleven-sh/agent/proto"
 )
 
+type runtime struct {
+	name    string
+	version string
+}
+
 //go:embed runtimes/*
 var runtimeScripts embed.FS
 
@@ -23,12 +29,14 @@ func (*agentServer) InstallRuntimes(
 	stream proto.Agent_InstallRuntimesServer,
 ) error {
 
-	for runtime, runtimeVersion := range req.Runtimes {
+	sortedRuntimes := sortRuntimes(req.Runtimes)
+
+	for _, runtime := range sortedRuntimes {
 		err := stream.Send(&proto.InstallRuntimesReply{
 			LogLineHeader: fmt.Sprintf(
 				"Installing %s@%s",
-				runtime,
-				runtimeVersion,
+				runtime.name,
+				runtime.version,
 			),
 		})
 
@@ -37,7 +45,7 @@ func (*agentServer) InstallRuntimes(
 		}
 
 		installRuntimeScriptFilePath, err := createInstallRuntimeScriptFile(
-			runtime,
+			runtime.name,
 		)
 
 		if err != nil {
@@ -48,7 +56,7 @@ func (*agentServer) InstallRuntimes(
 
 		installRuntimeCmd := buildInstallRuntimeCmd(
 			installRuntimeScriptFilePath,
-			runtimeVersion,
+			runtime.version,
 		)
 
 		stdoutReader, err := buildInstallRuntimeCmdStdoutReader(installRuntimeCmd)
@@ -102,8 +110,8 @@ func (*agentServer) InstallRuntimes(
 		if err := installRuntimeCmd.Wait(); err != nil {
 			return fmt.Errorf(
 				"error installing %s@%s (%v)",
-				runtime,
-				runtimeVersion,
+				runtime.name,
+				runtime.version,
 				err,
 			)
 		}
@@ -125,6 +133,41 @@ func (*agentServer) InstallRuntimes(
 	)
 }
 
+func sortRuntimes(runtimes map[string]string) []runtime {
+	runtimeNames := []string{}
+	for runtimeName := range runtimes {
+		runtimeNames = append(runtimeNames, runtimeName)
+	}
+	sort.Strings(runtimeNames)
+
+	sortedRuntimes := []runtime{}
+	var rubyRuntime *runtime
+
+	for _, runtimeName := range runtimeNames {
+		runtimeVersion := runtimes[runtimeName]
+
+		if runtimeName == "ruby" {
+			rubyRuntime = &runtime{
+				name:    runtimeName,
+				version: runtimeVersion,
+			}
+			continue
+		}
+
+		sortedRuntimes = append(sortedRuntimes, runtime{
+			name:    runtimeName,
+			version: runtimeVersion,
+		})
+	}
+
+	// RVM needs to be the last change to the $PATH env var
+	if rubyRuntime != nil {
+		sortedRuntimes = append(sortedRuntimes, *rubyRuntime)
+	}
+
+	return sortedRuntimes
+}
+
 func createInstallRuntimeScriptFile(runtime string) (string, error) {
 	installRuntimeScriptFile, err := os.CreateTemp("", "eleven_install_runtime_*")
 

internal/grpcserver/install_runtimes_test.go

@@ -0,0 +1,90 @@
+package grpcserver
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestSortRuntimes(t *testing.T) {
+	testCases := []struct {
+		test             string
+		runtimes         map[string]string
+		expectedRuntimes []runtime
+	}{
+		{
+			test:             "with no runtimes",
+			runtimes:         map[string]string{},
+			expectedRuntimes: []runtime{},
+		},
+
+		{
+			test: "with ruby runtime",
+			runtimes: map[string]string{
+				"docker": "latest",
+				"ruby":   "3.1.2",
+				"python": "2.4.0",
+				"rust":   "1.0.1",
+			},
+			expectedRuntimes: []runtime{
+				{
+					name:    "docker",
+					version: "latest",
+				},
+
+				{
+					name:    "python",
+					version: "2.4.0",
+				},
+
+				{
+					name:    "rust",
+					version: "1.0.1",
+				},
+
+				{
+					name:    "ruby",
+					version: "3.1.2",
+				},
+			},
+		},
+
+		{
+			test: "without ruby runtime",
+			runtimes: map[string]string{
+				"docker": "latest",
+				"python": "2.4.0",
+				"node":   "1.0.1",
+			},
+			expectedRuntimes: []runtime{
+				{
+					name:    "docker",
+					version: "latest",
+				},
+
+				{
+					name:    "node",
+					version: "1.0.1",
+				},
+
+				{
+					name:    "python",
+					version: "2.4.0",
+				},
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.test, func(t *testing.T) {
+			sortedRuntimes := sortRuntimes(tc.runtimes)
+
+			if !reflect.DeepEqual(sortedRuntimes, tc.expectedRuntimes) {
+				t.Fatalf(
+					"expected runtimes to equal '%+v', got '%+v'",
+					tc.expectedRuntimes,
+					sortedRuntimes,
+				)
+			}
+		})
+	}
+}