Connect Kube gateway part 4: frontend

integration/proxy/teleterm_test.go

@@ -332,7 +332,10 @@ func testKubeGatewayCertRenewal(t *testing.T, suite *Suite, albAddr string, kube
 			kubeGateway, err := gateway.AsKube(gw)
 			require.NoError(t, err)
 
-			client = kubeClientForLocalProxy(t, kubeGateway.KubeconfigPath(), teleportCluster, kubeCluster)
+			kubeconfigPath := kubeGateway.KubeconfigPath()
+			checkKubeconfigPathInCommandEnv(t, gw, kubeconfigPath)
+
+			client = kubeClientForLocalProxy(t, kubeconfigPath, teleportCluster, kubeCluster)
 		})
 
 		mustGetKubePod(t, client, kubePodName)
@@ -350,3 +353,11 @@ func testKubeGatewayCertRenewal(t *testing.T, suite *Suite, albAddr string, kube
 	)
 
 }
+
+func checkKubeconfigPathInCommandEnv(t *testing.T, gw gateway.Gateway, wantKubeconfigPath string) {
+	t.Helper()
+
+	cmd, err := gw.CLICommand()
+	require.NoError(t, err)
+	require.Equal(t, cmd.Env, []string{"KUBECONFIG=" + wantKubeconfigPath})
+}

lib/teleterm/gateway/base.go

@@ -193,7 +193,10 @@ func (b *base) CLICommand() (*api.GatewayCLICommand, error) {
 	if err != nil {
 		return nil, trace.Wrap(err)
 	}
+	return makeCLICommand(cmd), nil
+}
 
+func makeCLICommand(cmd *exec.Cmd) *api.GatewayCLICommand {
 	cmdString := strings.TrimSpace(
 		fmt.Sprintf("%s %s",
 			strings.Join(cmd.Env, " "),
@@ -204,7 +207,7 @@ func (b *base) CLICommand() (*api.GatewayCLICommand, error) {
 		Args:    cmd.Args,
 		Env:     cmd.Env,
 		Preview: cmdString,
-	}, nil
+	}
 }
 
 // ReloadCert loads the key pair from cfg.CertPath & cfg.KeyPath and updates the cert of the running

lib/teleterm/gateway/kube.go

@@ -26,6 +26,7 @@ import (
 
 	"github.com/gravitational/teleport/api/utils/keypaths"
 	"github.com/gravitational/teleport/api/utils/keys"
+	api "github.com/gravitational/teleport/gen/proto/go/teleport/lib/teleterm/v1"
 	"github.com/gravitational/teleport/lib/client"
 	"github.com/gravitational/teleport/lib/kube/kubeconfig"
 	"github.com/gravitational/teleport/lib/srv/alpnproxy"
@@ -209,3 +210,15 @@ func (k *kube) writeKubeconfig(key *keys.PrivateKey, cas map[string]tls.Certific
 	})
 	return nil
 }
+
+func (k *kube) CLICommand() (*api.GatewayCLICommand, error) {
+	// TODO(greedy52) currently kube must implement CLICommand in order to pass
+	// Kube to CLICommandProvider. We should revisit gateway design/flows like
+	// this. For example, one alternative is to move gateway.CLICommand to
+	// daemon.GatewayCLICommand as daemon owns all CLICommandProvider.
+	cmd, err := k.cfg.CLICommandProvider.GetCommand(k)
+	if err != nil {
+		return nil, trace.Wrap(err)
+	}
+	return makeCLICommand(cmd), nil
+}

web/packages/teleterm/src/services/pty/ptyHost/buildPtyOptions.test.ts

@@ -16,7 +16,7 @@
 
 import { makeRuntimeSettings } from 'teleterm/mainProcess/fixtures/mocks';
 
-import { GatewayCliClientCommand } from '../types';
+import { ShellCommand, GatewayCliClientCommand } from '../types';
 
 import { getPtyProcessOptions } from './buildPtyOptions';
 
@@ -50,4 +50,32 @@ describe('getPtyProcessOptions', () => {
       expect(env.shared).toBe('fromCmd');
     });
   });
+
+  describe('pty.shell', () => {
+    it('merges process env with the env from cmd', () => {
+      const processEnv = {
+        processExclusive: 'process',
+        shared: 'fromProcess',
+      };
+      const cmd: ShellCommand = {
+        kind: 'pty.shell',
+        clusterName: 'bar',
+        proxyHost: 'baz',
+        env: {
+          cmdExclusive: 'cmd',
+          shared: 'fromCmd',
+        },
+      };
+
+      const { env } = getPtyProcessOptions(
+        makeRuntimeSettings(),
+        cmd,
+        processEnv
+      );
+
+      expect(env.processExclusive).toBe('process');
+      expect(env.cmdExclusive).toBe('cmd');
+      expect(env.shared).toBe('fromCmd');
+    });
+  });
 });

web/packages/teleterm/src/services/pty/ptyHost/buildPtyOptions.ts

@@ -92,7 +92,8 @@ export function getPtyProcessOptions(
         path: settings.defaultShell,
         args: [],
         cwd: cmd.cwd,
-        env,
+        env: { ...env, ...cmd.env },
+        initMessage: cmd.initMessage,
       };
     }
 

web/packages/teleterm/src/services/pty/ptyHost/ptyHostClient.ts

@@ -42,6 +42,9 @@ export function createPtyHostClient(
       if (ptyOptions.cwd) {
         request.setCwd(ptyOptions.cwd);
       }
+      if (ptyOptions.initMessage) {
+        request.setInitMessage(ptyOptions.initMessage);
+      }
 
       return new Promise<string>((resolve, reject) => {
         client.createPtyProcess(request, (error, response) => {

web/packages/teleterm/src/services/pty/types.ts

@@ -41,6 +41,15 @@ export type PtyServiceClient = {
 export type ShellCommand = PtyCommandBase & {
   kind: 'pty.shell';
   cwd?: string;
+  // env is a record of additional env variables that need to be set for the shell terminal and it
+  // will be merged with process env.
+  env?: Record<string, string>;
+  // initMessage is a help message presented to the user at the beginning of
+  // the shell to provide extra context.
+  //
+  // The initMessage is rendered on the terminal UI without being written or
+  // read by the underlying PTY.
+  initMessage?: string;
 };
 
 export type TshLoginCommand = PtyCommandBase & {

web/packages/teleterm/src/services/tshd/testHelpers.ts

@@ -27,6 +27,7 @@ export const makeServer = (props: Partial<tsh.Server> = {}): tsh.Server => ({
 });
 
 export const databaseUri = '/clusters/teleport-local/dbs/foo';
+export const kubeUri = '/clusters/teleport-local/kubes/foo';
 
 export const makeDatabase = (
   props: Partial<tsh.Database> = {}
@@ -74,7 +75,9 @@ export const makeRootCluster = (
   ...props,
 });
 
-export const makeGateway = (props: Partial<tsh.Gateway> = {}): tsh.Gateway => ({
+export const makeDatabaseGateway = (
+  props: Partial<tsh.Gateway> = {}
+): tsh.Gateway => ({
   uri: '/gateways/foo',
   targetName: 'sales-production',
   targetUri: databaseUri,
@@ -91,3 +94,23 @@ export const makeGateway = (props: Partial<tsh.Gateway> = {}): tsh.Gateway => ({
   targetSubresourceName: 'bar',
   ...props,
 });
+
+export const makeKubeGateway = (
+  props: Partial<tsh.Gateway> = {}
+): tsh.Gateway => ({
+  uri: '/gateways/foo',
+  targetName: 'foo',
+  targetUri: kubeUri,
+  targetUser: '',
+  localAddress: 'localhost',
+  localPort: '1337',
+  protocol: '',
+  gatewayCliCommand: {
+    path: '/bin/kubectl',
+    argsList: ['version'],
+    envList: ['KUBECONFIG=/path/to/kubeconfig'],
+    preview: 'KUBECONFIG=/path/to/kubeconfig /bin/kubectl version',
+  },
+  targetSubresourceName: '',
+  ...props,
+});

web/packages/teleterm/src/services/tshd/types.ts

@@ -46,7 +46,7 @@ export interface Server extends apiServer.Server.AsObject {
 
 export interface Gateway extends apiGateway.Gateway.AsObject {
   uri: uri.GatewayUri;
-  targetUri: uri.DatabaseUri;
+  targetUri: uri.DatabaseUri | uri.KubeUri;
   // The type of gatewayCliCommand was repeated here just to refer to the type with the JSDoc.
   gatewayCliCommand: GatewayCLICommand;
 }
@@ -272,7 +272,7 @@ export interface LoginPasswordlessParams extends LoginParamsBase {
 }
 
 export type CreateGatewayParams = {
-  targetUri: uri.DatabaseUri;
+  targetUri: uri.DatabaseUri | uri.KubeUri;
   port?: string;
   user: string;
   subresource_name?: string;

web/packages/teleterm/src/services/tshdNotifications.ts

@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright 2023 Gravitational, Inc
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,27 +31,31 @@ export class TshdNotificationsService {
         request.cannotProxyGatewayConnection;
       const gateway = this.clustersService.findGateway(gatewayUri);
       const clusterName = routing.parseClusterName(targetUri);
-      let shortTargetDesc: string;
-      let longTargetDesc: string;
+      let targetName: string;
+      let targetUser: string;
+      let targetDesc: string;
 
+      // Try to get target name and user from gateway object.
       if (gateway) {
-        shortTargetDesc = `${gateway.targetName} as ${gateway.targetUser}`;
-        longTargetDesc = shortTargetDesc;
+        targetName = gateway.targetName;
+        targetUser = gateway.targetUser;
       } else {
-        const targetName = routing.parseDbUri(targetUri)?.params['dbId'];
+        // Try to get target name from target URI.
+        targetName =
+          routing.parseDbUri(targetUri)?.params['dbId'] ||
+          routing.parseKubeUri(targetUri)?.params['kubeId'] ||
+          targetUri;
+      }
 
-        if (targetName) {
-          shortTargetDesc = targetName;
-          longTargetDesc = shortTargetDesc;
-        } else {
-          shortTargetDesc = 'a database server';
-          longTargetDesc = `a database server under ${targetUri}`;
-        }
+      if (targetUser) {
+        targetDesc = `${targetName} as ${targetUser}`;
+      } else {
+        targetDesc = targetName;
       }
 
       const notificationContent = {
-        title: `Cannot connect to ${shortTargetDesc} (${clusterName})`,
-        description: `You tried to connect to ${longTargetDesc} but we encountered an unexpected error: ${error}`,
+        title: `Cannot connect to ${targetDesc} (${clusterName})`,
+        description: `You tried to connect to ${targetDesc} but we encountered an unexpected error: ${error}`,
       };
 
       this.notificationsService.notifyError(notificationContent);

web/packages/teleterm/src/sharedProcess/api/proto/ptyHostService.proto

@@ -36,6 +36,7 @@ message PtyCreate {
   reserved 6;
   reserved "init_command";
   google.protobuf.Struct env = 7;
+  string init_message = 8;
 }
 
 message PtyClientEvent {

web/packages/teleterm/src/sharedProcess/ptyHost/ptyHostService.ts

@@ -38,6 +38,7 @@ export function createPtyHostService(): IPtyHostServer {
           cwd: ptyOptions.cwd,
           ptyId,
           env: call.request.getEnv()?.toJavaScript() as Record<string, string>,
+          initMessage: ptyOptions.initMessage,
         });
         ptyProcesses.set(ptyId, ptyProcess);
       } catch (error) {

web/packages/teleterm/src/sharedProcess/ptyHost/ptyProcess.ts

@@ -76,6 +76,13 @@ export class PtyProcess extends EventEmitter implements IPtyProcess {
     this._setStatus('open');
     this.emit(TermEventEnum.Open);
 
+    // Emit the init/help message before registering data handler. This ensures
+    // the message is printed first and will not conflict with data coming from
+    // the PTY.
+    if (this.options.initMessage) {
+      this.emit(TermEventEnum.Data, this.options.initMessage);
+    }
+
     this._process.onData(data => this._handleData(data));
     this._process.onExit(ev => this._handleExit(ev));
   }

web/packages/teleterm/src/sharedProcess/ptyHost/types.ts

@@ -19,6 +19,7 @@ export type PtyProcessOptions = {
   path: string;
   args: string[];
   cwd?: string;
+  initMessage?: string;
 };
 
 export type IPtyProcess = {