Merge pull request #3550 from vishalanarase/feat/3536-create-context-flag

feat(cli): add --create-context flag to create-workspace for direct c…

Author: kcp-ci-bot

cli/pkg/workspace/plugin/context.go

@@ -39,6 +39,9 @@ type CreateContextOptions struct {
 	// Overwrite indicates the context should be updated if it already exists. This is required to perform the update.
 	Overwrite bool
 
+	// KeepCurrent indicates whether to keep the current context. When creating a new context, if KeepCurrent is true, the current context will be preserved.
+	KeepCurrent bool
+
 	startingConfig *clientcmdapi.Config
 
 	// for testing
@@ -68,10 +71,13 @@ func (o *CreateContextOptions) Complete(args []string) error {
 		return err
 	}
 
-	var err error
-	o.startingConfig, err = o.ClientConfig.ConfigAccess().GetStartingConfig()
-	if err != nil {
-		return err
+	// Get the starting config if it hasn't been set yet.
+	if o.startingConfig == nil {
+		var err error
+		o.startingConfig, err = o.ClientConfig.ConfigAccess().GetStartingConfig()
+		if err != nil {
+			return err
+		}
 	}
 
 	if o.Name == "" && len(args) > 0 {
@@ -122,6 +128,11 @@ func (o *CreateContextOptions) Run(ctx context.Context) error {
 	newKubeConfig.Contexts[o.Name] = &newContext
 	newKubeConfig.CurrentContext = o.Name
 
+	// If KeepCurrent is true, preserve the current context.
+	if o.KeepCurrent {
+		newKubeConfig.CurrentContext = config.CurrentContext
+	}
+
 	if err := o.modifyConfig(o.ClientConfig.ConfigAccess(), newKubeConfig); err != nil {
 		return err
 	}

cli/pkg/workspace/plugin/create.go

@@ -62,6 +62,9 @@ type CreateWorkspaceOptions struct {
 
 	kcpClusterClient kcpclientset.ClusterInterface
 
+	// CreateContextName is the name of the context to create after workspace creation (if set).
+	CreateContextName string
+
 	// for testing - passed to UseWorkspaceOptions
 	newKCPClusterClient func(config clientcmd.ClientConfig) (kcpclientset.ClusterInterface, error)
 	modifyConfig        func(configAccess clientcmd.ConfigAccess, newConfig *clientcmdapi.Config) error
@@ -111,6 +114,7 @@ func (o *CreateWorkspaceOptions) BindFlags(cmd *cobra.Command) {
 	cmd.Flags().BoolVar(&o.EnterAfterCreate, "enter", o.EnterAfterCreate, "Immediately enter the created workspace")
 	cmd.Flags().BoolVar(&o.IgnoreExisting, "ignore-existing", o.IgnoreExisting, "Ignore if the workspace already exists. Requires none or absolute type path.")
 	cmd.Flags().StringVar(&o.LocationSelector, "location-selector", o.LocationSelector, "A label selector to select the scheduling location of the created workspace.")
+	cmd.Flags().StringVar(&o.CreateContextName, "create-context", o.CreateContextName, "Create a kubeconfig context for the new workspace with the given name.")
 }
 
 // Run creates a workspace.
@@ -231,6 +235,48 @@ func (o *CreateWorkspaceOptions) Run(ctx context.Context) error {
 		return err
 	}
 
+	// Create context if --create-context is set
+	if o.CreateContextName != "" {
+		createContextOptions := NewCreateContextOptions(o.IOStreams)
+		createContextOptions.Name = o.CreateContextName
+		createContextOptions.ClientConfig = o.ClientConfig
+
+		// If --enter is set, switch to the new context
+		createContextOptions.KeepCurrent = !o.EnterAfterCreate
+
+		startingConfig, err := o.ClientConfig.RawConfig()
+		if err != nil {
+			return fmt.Errorf("failed to get raw config: %w", err)
+		}
+		createContextOptions.startingConfig = &startingConfig
+
+		// only for unit test needs
+		if o.modifyConfig != nil {
+			createContextOptions.modifyConfig = o.modifyConfig
+		}
+
+		if err := createContextOptions.Complete(nil); err != nil {
+			return err
+		}
+		if err := createContextOptions.Validate(); err != nil {
+			return err
+		}
+
+		if err := createContextOptions.Run(ctx); err != nil {
+			return fmt.Errorf("failed to create context: %w", err)
+		}
+
+		// Print output
+		if o.EnterAfterCreate {
+			fmt.Fprintf(o.Out, "Created context %q and switched to it.\n", o.CreateContextName)
+		} else {
+			fmt.Fprintf(o.Out, "Created context %q.\n", o.CreateContextName)
+		}
+
+		return nil
+	}
+
+	// If --enter is set, enter the newly created workspace
 	if o.EnterAfterCreate {
 		useOptions := NewUseWorkspaceOptions(o.IOStreams)
 		useOptions.Name = ws.Name

cli/pkg/workspace/plugin/create_test.go

@@ -54,6 +54,7 @@ func TestCreate(t *testing.T) {
 		newWorkspaceName                 string
 		newWorkspaceType                 *tenancyv1alpha1.WorkspaceTypeReference
 		useAfterCreation, ignoreExisting bool
+		createContextName                string
 
 		expected *clientcmdapi.Config
 		wantErr  bool
@@ -189,6 +190,64 @@ func TestCreate(t *testing.T) {
 			newWorkspaceType: &tenancyv1alpha1.WorkspaceTypeReference{Name: "universal"},
 			wantErr:          true,
 		},
+		{
+			name: "create with create-context only",
+			config: clientcmdapi.Config{
+				CurrentContext: "test",
+				Contexts: map[string]*clientcmdapi.Context{
+					"test": {Cluster: "test", AuthInfo: "test"},
+				},
+				Clusters: map[string]*clientcmdapi.Cluster{
+					"test": {Server: "https://test/clusters/root:foo"},
+				},
+				AuthInfos: map[string]*clientcmdapi.AuthInfo{"test": {Token: "test"}},
+			},
+			expected: &clientcmdapi.Config{
+				CurrentContext: "test",
+				Contexts: map[string]*clientcmdapi.Context{
+					"test": {Cluster: "test", AuthInfo: "test"},
+					"bar":  {Cluster: "bar", AuthInfo: "test"},
+				},
+				Clusters: map[string]*clientcmdapi.Cluster{
+					"test": {Server: "https://test/clusters/root:foo"},
+					"bar":  {Server: "https://test/clusters/root:foo"},
+				},
+				AuthInfos: map[string]*clientcmdapi.AuthInfo{"test": {Token: "test"}},
+			},
+			existingWorkspaces: []string{"test"},
+			createContextName:  "bar",
+			useAfterCreation:   false,
+			markReady:          true,
+		},
+		{
+			name: "create with create-context and enter",
+			config: clientcmdapi.Config{
+				CurrentContext: "test",
+				Contexts: map[string]*clientcmdapi.Context{
+					"test": {Cluster: "test", AuthInfo: "test"},
+				},
+				Clusters: map[string]*clientcmdapi.Cluster{
+					"test": {Server: "https://test/clusters/root:foo"},
+				},
+				AuthInfos: map[string]*clientcmdapi.AuthInfo{"test": {Token: "test"}},
+			},
+			expected: &clientcmdapi.Config{
+				CurrentContext: "bar",
+				Contexts: map[string]*clientcmdapi.Context{
+					"test": {Cluster: "test", AuthInfo: "test"},
+					"bar":  {Cluster: "bar", AuthInfo: "test"},
+				},
+				Clusters: map[string]*clientcmdapi.Cluster{
+					"test": {Server: "https://test/clusters/root:foo"},
+					"bar":  {Server: "https://test/clusters/root:foo"},
+				},
+				AuthInfos: map[string]*clientcmdapi.AuthInfo{"test": {Token: "test"}},
+			},
+			existingWorkspaces: []string{"test"},
+			createContextName:  "bar",
+			useAfterCreation:   true,
+			markReady:          true,
+		},
 	}
 	for _, tt := range tests {
 		// TODO(sttts): tt has a data race here due to the parallel test execution. But unaliasing it breaks the tests. WTF.
@@ -273,6 +332,9 @@ func TestCreate(t *testing.T) {
 			if !tt.skipInitialType {
 				opts.Type = workspaceType.Path + ":" + string(workspaceType.Name)
 			}
+			if tt.createContextName != "" {
+				opts.CreateContextName = tt.createContextName
+			}
 			opts.IgnoreExisting = tt.ignoreExisting
 			opts.EnterAfterCreate = tt.useAfterCreation
 			opts.ReadyWaitTimeout = time.Second