Add prebuild availability status to create codespaces (cli#4737)

adnamalin · web-flow · commit 15c8f291e453 · 2021-11-17T19:41:05.000+01:00
diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go
@@ -415,8 +415,9 @@ func (a *API) GetCodespaceRegionLocation(ctx context.Context) (string, error) {
 }
 
 type Machine struct {
-	Name        string `json:"name"`
-	DisplayName string `json:"display_name"`
+	Name                 string `json:"name"`
+	DisplayName          string `json:"display_name"`
+	PrebuildAvailability string `json:"prebuild_availability"`
 }
 
 // GetCodespacesMachines returns the codespaces machines for the given repo, branch and location.
diff --git a/pkg/cmd/codespace/create.go b/pkg/cmd/codespace/create.go
@@ -234,7 +234,7 @@ func getMachineName(ctx context.Context, apiClient apiClient, repoID int, machin
 	machineNames := make([]string, 0, len(machines))
 	machineByName := make(map[string]*api.Machine)
 	for _, m := range machines {
-		machineName := m.DisplayName
+		machineName := buildDisplayName(m.DisplayName, m.PrebuildAvailability)
 		machineNames = append(machineNames, machineName)
 		machineByName[machineName] = m
 	}
@@ -260,3 +260,14 @@ func getMachineName(ctx context.Context, apiClient apiClient, repoID int, machin
 
 	return selectedMachine.Name, nil
 }
+
+// buildDisplayName returns display name to be used in the machine survey prompt.
+func buildDisplayName(displayName string, prebuildAvailability string) string {
+	prebuildText := ""
+
+	if prebuildAvailability == "blob" || prebuildAvailability == "pool" {
+		prebuildText = " (Prebuild ready)"
+	}
+
+	return fmt.Sprintf("%s%s", displayName, prebuildText)
+}
diff --git a/pkg/cmd/codespace/create_test.go b/pkg/cmd/codespace/create_test.go
@@ -0,0 +1,43 @@
+package codespace
+
+import (
+	"testing"
+)
+
+func TestBuildDisplayName(t *testing.T) {
+	tests := []struct {
+		name                 string
+		prebuildAvailability string
+		expectedDisplayName  string
+	}{
+		{
+			name:                 "prebuild availability is pool",
+			prebuildAvailability: "pool",
+			expectedDisplayName:  "4 cores, 8 GB RAM, 32 GB storage (Prebuild ready)",
+		},
+		{
+			name:                 "prebuild availability is blob",
+			prebuildAvailability: "blob",
+			expectedDisplayName:  "4 cores, 8 GB RAM, 32 GB storage (Prebuild ready)",
+		},
+		{
+			name:                 "prebuild availability is none",
+			prebuildAvailability: "none",
+			expectedDisplayName:  "4 cores, 8 GB RAM, 32 GB storage",
+		},
+		{
+			name:                 "prebuild availability is empty",
+			prebuildAvailability: "",
+			expectedDisplayName:  "4 cores, 8 GB RAM, 32 GB storage",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			displayName := buildDisplayName("4 cores, 8 GB RAM, 32 GB storage", tt.prebuildAvailability)
+
+			if displayName != tt.expectedDisplayName {
+				t.Errorf("displayName = %q, expectedDisplayName %q", displayName, tt.expectedDisplayName)
+			}
+		})
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -415,8 +415,9 @@ func (a *API) GetCodespaceRegionLocation(ctx context.Context) (string, error) {`
`415`	`415`	`}`
`416`	`416`
`417`	`417`	`type Machine struct {`
`418`		- Name string `json:"name"`
`419`		- DisplayName string `json:"display_name"`
	`418`	+ Name string `json:"name"`
	`419`	+ DisplayName string `json:"display_name"`
	`420`	+ PrebuildAvailability string `json:"prebuild_availability"`
`420`	`421`	`}`
`421`	`422`
`422`	`423`	`// GetCodespacesMachines returns the codespaces machines for the given repo, branch and location.`