feature(cmx): add ability to set custom username (#547)

* feature(cmx): add ability to set custom username

Signed-off-by: Kyle Squizzato <kyle@replicated.com>

Author: squizzi

cli/cmd/vm_endpoints.go

@@ -60,7 +60,10 @@ Note: %s endpoints can only be retrieved from VMs in the "running" state.`, prot
 replicated vm %s-endpoint aaaaa11
 
 # Get %s endpoint for a specific VM by name
-replicated vm %s-endpoint my-test-vm`, protocol, endpointType, protocol, endpointType)
+replicated vm %s-endpoint my-test-vm
+
+# Get %s endpoint with a custom username
+replicated vm %s-endpoint my-test-vm --username custom-user`, protocol, endpointType, protocol, endpointType, protocol, endpointType)
 
 	cmd := &cobra.Command{
 		Use:               cmdUse,
@@ -73,6 +76,8 @@ replicated vm %s-endpoint my-test-vm`, protocol, endpointType, protocol, endpoin
 		Annotations:       map[string]string{"endpointType": endpointType},
 	}
 
+	cmd.Flags().String("username", "", fmt.Sprintf("Custom username to use in %s endpoint instead of the GitHub username set in Vendor Portal", protocol))
+
 	parent.AddCommand(cmd)
 
 	return cmd
@@ -88,20 +93,24 @@ func (r *runners) VMEndpoint(cmd *cobra.Command, args []string) error {
 		}
 	}
 
+	username, err := cmd.Flags().GetString("username")
+	if err != nil {
+		return errors.Wrap(err, "get username")
+	}
+
 	vmID, err := r.getVMIDFromArg(args[0])
 	if err != nil {
 		return err
 	}
 
-	return r.getVMEndpoint(vmID, endpointType)
+	return r.getVMEndpoint(vmID, endpointType, username)
 }
 
 // getVMEndpoint retrieves and formats VM endpoint with the specified protocol
 // endpointType should be either "ssh" or "scp"
-func (r *runners) getVMEndpoint(vmID, endpointType string) error {
+func (r *runners) getVMEndpoint(vmID, endpointType, username string) error {
 	var err error
 	var vm *VM
-	var githubUsername string
 
 	// Validate endpoint type
 	if err := validateEndpointType(endpointType); err != nil {
@@ -128,19 +137,25 @@ func (r *runners) getVMEndpoint(vmID, endpointType string) error {
 		return errors.Errorf("VM %s does not have %s endpoint configured", vm.ID, endpointType)
 	}
 
-	githubUsername, err = r.kotsAPI.GetGitHubUsername()
-	if err != nil {
-		return errors.Wrap(err, "get github username")
-	}
+	// Use provided username or fetch from GitHub
+	if username == "" {
+		githubUsername, err := r.kotsAPI.GetGitHubUsername()
+		if err != nil {
+			return errors.Wrap(errors.New(`failed to obtain GitHub username from Vendor Portal
+Alternatively, you can use the --username flag to specify a custom username for the endpoint`), "get github username")
+		}
+
+		if githubUsername == "" {
+			return errors.Errorf(`no GitHub account associated with Vendor Portal user
+Visit the Account Settings page in Vendor Portal to link your account
+Alternatively, you can use the --username flag to specify a custom username for the endpoint`)
+		}
 
-	// Format the endpoint with username if available
-	if githubUsername == "" {
-		return errors.Errorf(`no github account associated with vendor portal user
-Visit the Account Settings page in Vendor Portal to link your account`)
+		username = githubUsername
 	}
 
 	// Format the endpoint URL with the appropriate protocol
-	fmt.Printf("%s://%s@%s:%d\n", endpointType, githubUsername, vm.DirectEndpoint, vm.DirectPort)
+	fmt.Printf("%s://%s@%s:%d\n", endpointType, username, vm.DirectEndpoint, vm.DirectPort)
 
 	return nil
 }

cli/cmd/vm_endpoints_test.go

@@ -23,92 +23,138 @@ func TestGetVMEndpoint(t *testing.T) {
 		name               string    // Test case name
 		vmID               string    // Virtual machine ID to test
 		endpointType       string    // Endpoint type (ssh, scp, or invalid)
+		username           string    // Custom username (empty to use GitHub username)
 		mockVM             *types.VM // Mock VM response from API
 		mockGithubUsername string    // Mock GitHub username response
+		githubAPIError     bool      // Should GitHub username API return an error
 		expectedOutput     string    // Expected output to stdout
 		expectedError      string    // Expected error string (empty for no error)
 	}{
 		{
 			name:         "Success - Get SSH endpoint for running VM",
 			vmID:         "vm-123",
 			endpointType: "ssh",
+			username:     "",
 			mockVM: &types.VM{
 				ID:                "vm-123",
 				DirectSSHEndpoint: "test-vm.example.com",
 				DirectSSHPort:     22,
 				Status:            types.VMStatusRunning,
 			},
 			mockGithubUsername: "testuser",
+			githubAPIError:     false,
 			expectedOutput:     "ssh://testuser@test-vm.example.com:22\n",
 			expectedError:      "",
 		},
 		{
 			name:         "Success - Get SCP endpoint for running VM",
 			vmID:         "vm-456",
 			endpointType: "scp",
+			username:     "",
 			mockVM: &types.VM{
 				ID:                "vm-456",
 				DirectSSHEndpoint: "test-vm.example.com",
 				DirectSSHPort:     22,
 				Status:            types.VMStatusRunning,
 			},
 			mockGithubUsername: "testuser",
+			githubAPIError:     false,
 			expectedOutput:     "scp://testuser@test-vm.example.com:22\n",
 			expectedError:      "",
 		},
+		{
+			name:         "Success - Custom username provided",
+			vmID:         "vm-123",
+			endpointType: "ssh",
+			username:     "customuser",
+			mockVM: &types.VM{
+				ID:                "vm-123",
+				DirectSSHEndpoint: "test-vm.example.com",
+				DirectSSHPort:     22,
+				Status:            types.VMStatusRunning,
+			},
+			mockGithubUsername: "testuser", // Should be ignored
+			githubAPIError:     false,      // Should be ignored
+			expectedOutput:     "ssh://customuser@test-vm.example.com:22\n",
+			expectedError:      "",
+		},
 		{
 			name:         "Error - Missing SSH endpoint configuration",
 			vmID:         "vm-789",
 			endpointType: "ssh",
+			username:     "",
 			mockVM: &types.VM{
 				ID:                "vm-789",
 				DirectSSHEndpoint: "",
 				DirectSSHPort:     0,
 				Status:            types.VMStatusRunning,
 			},
 			mockGithubUsername: "testuser",
+			githubAPIError:     false,
 			expectedOutput:     "",
 			expectedError:      "VM vm-789 does not have ssh endpoint configured",
 		},
 		{
 			name:         "Error - Missing GitHub username",
 			vmID:         "vm-123",
 			endpointType: "ssh",
+			username:     "",
 			mockVM: &types.VM{
 				ID:                "vm-123",
 				DirectSSHEndpoint: "test-vm.example.com",
 				DirectSSHPort:     22,
 				Status:            types.VMStatusRunning,
 			},
 			mockGithubUsername: "",
+			githubAPIError:     false,
 			expectedOutput:     "",
-			expectedError:      "no github account associated with vendor portal user",
+			expectedError:      "no GitHub account associated with Vendor Portal user",
+		},
+		{
+			name:         "Error - GitHub username API error",
+			vmID:         "vm-123",
+			endpointType: "ssh",
+			username:     "",
+			mockVM: &types.VM{
+				ID:                "vm-123",
+				DirectSSHEndpoint: "test-vm.example.com",
+				DirectSSHPort:     22,
+				Status:            types.VMStatusRunning,
+			},
+			mockGithubUsername: "", // Won't be used due to API error
+			githubAPIError:     true,
+			expectedOutput:     "",
+			expectedError:      "--username flag to specify a custom username", // Check for new error message
 		},
 		{
 			name:         "Error - Invalid endpoint type",
 			vmID:         "vm-123",
 			endpointType: "invalid",
+			username:     "",
 			mockVM: &types.VM{
 				ID:                "vm-123",
 				DirectSSHEndpoint: "test-vm.example.com",
 				DirectSSHPort:     22,
 				Status:            types.VMStatusRunning,
 			},
 			mockGithubUsername: "testuser",
+			githubAPIError:     false,
 			expectedOutput:     "",
 			expectedError:      "invalid endpoint type: invalid",
 		},
 		{
 			name:         "Error - VM not in running state",
 			vmID:         "vm-123",
 			endpointType: "ssh",
+			username:     "",
 			mockVM: &types.VM{
 				ID:                "vm-123",
 				DirectSSHEndpoint: "test-vm.example.com",
 				DirectSSHPort:     22,
 				Status:            types.VMStatusProvisioning,
 			},
 			mockGithubUsername: "testuser",
+			githubAPIError:     false,
 			expectedOutput:     "",
 			expectedError:      "VM vm-123 is not in running state (current state: provisioning). SSH is only available for running VMs",
 		},
@@ -117,7 +163,7 @@ func TestGetVMEndpoint(t *testing.T) {
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
 			// Create a mock server and client for API testing
-			server, apiClient := createMockServerAndClient(tc.vmID, tc.mockVM, tc.mockGithubUsername)
+			server, apiClient := createMockServerAndClient(tc.vmID, tc.mockVM, tc.mockGithubUsername, tc.githubAPIError)
 			defer server.Close()
 
 			// Capture stdout directly
@@ -131,7 +177,7 @@ func TestGetVMEndpoint(t *testing.T) {
 			}
 
 			// Execute the function under test
-			err := runner.getVMEndpoint(tc.vmID, tc.endpointType)
+			err := runner.getVMEndpoint(tc.vmID, tc.endpointType, tc.username)
 
 			// Get captured output
 			w.Close()
@@ -153,7 +199,7 @@ func TestGetVMEndpoint(t *testing.T) {
 }
 
 // createMockServerAndClient sets up a mock HTTP server and returns both kotsAPI.GetVM and kotsAPI.GetGitHubUsername
-func createMockServerAndClient(vmID string, mockVM *types.VM, mockGithubUsername string) (*httptest.Server, *kotsclient.VendorV3Client) {
+func createMockServerAndClient(vmID string, mockVM *types.VM, mockGithubUsername string, githubAPIError bool) (*httptest.Server, *kotsclient.VendorV3Client) {
 	// Create a mock HTTP server to handle API requests
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.Header().Set("Content-Type", "application/json")
@@ -168,6 +214,11 @@ func createMockServerAndClient(vmID string, mockVM *types.VM, mockGithubUsername
 
 		// Handle GetGitHubUsername request
 		case r.URL.Path == "/v1/user" && r.Method == "GET":
+			if githubAPIError {
+				w.WriteHeader(http.StatusInternalServerError)
+				json.NewEncoder(w).Encode(map[string]string{"error": "GitHub API error"})
+				return
+			}
 			response := kotsclient.GetUserResponse{
 				GitHubUsername: mockGithubUsername,
 			}