Address comments.

Author: brendandburns

examples/typescript/exec/exec-example.ts

@@ -6,10 +6,12 @@ const kc = new k8s.KubeConfig();
 kc.loadFromDefault();
 
 const exec = new k8s.Exec(kc);
-exec.exec('default', 'demo', 'demo', command,
+exec.exec('default', 'nginx-4217019353-9gl4s', 'nginx', command,
     process.stdout, process.stderr, process.stdin,
     (status: k8s.V1Status) => {
+        // tslint:disable-next-line:no-console
         console.log('Exited with status:');
+        // tslint:disable-next-line:no-console
         console.log(JSON.stringify(status, null, 2));
     },
     true /* tty */);

src/exec.ts

@@ -18,10 +18,23 @@ export class Exec {
     }
 
     // TODO: make command an array and support multiple args
+    /**
+     * @param {string}  namespace - The namespace of the pod to exec the command inside.
+     * @param {string} podName - The name of the pod to exec the command inside.
+     * @param {string} containerName - The name of the container in the pod to exec the command inside.
+     * @param {string} command - The command to execute.
+     * @param {stream.Writable} stdout - The stream to write stdout data from the command.
+     * @param {stream.Writable} stderr - The stream to write stderr data from the command.
+     * @param {stream.Readable} stdin - The strream to write stdin data into the command.
+     * @param {boolean} tty - Should the command execute in a TTY enabled session.
+     * @param {(V1Status) => void} statusCallback -
+     *       A callback to received the status (e.g. exit code) from the command, optional.
+     * @return {string} This is the result
+     */
     public async exec(namespace: string, podName: string, containerName: string, command: string,
                       stdout: stream.Writable | null, stderr: stream.Writable | null, stdin: stream.Readable | null,
-                      statusCallback: (status: V1Status) => void,
-                      tty: boolean): Promise<WebSocket> {
+                      tty: boolean,
+                      statusCallback?: (status: V1Status) => void): Promise<WebSocket> {
         const query = {
             stdout: stdout != null,
             stderr: stderr != null,

src/exec_test.ts

@@ -3,14 +3,12 @@ import WebSocket = require('isomorphic-ws');
 import { ReadableStreamBuffer, WritableStreamBuffer } from 'stream-buffers';
 import { anyFunction, capture, instance, mock, verify, when } from 'ts-mockito';
 
+import { V1Status } from './api';
 import { KubeConfig } from './config';
 import { Exec } from './exec';
 import { WebSocketHandler, WebSocketInterface } from './web-socket-handler';
 
 describe('Exec', () => {
-    // tslint:disable-next-line:no-empty
-    const nop = () => {};
-
     describe('basic', () => {
         it('should correctly exec to a url', async () => {
             const kc = new KubeConfig();
@@ -27,27 +25,27 @@ describe('Exec', () => {
             const path = `/api/v1/namespaces/${namespace}/pods/${pod}/exec`;
 
             await exec.exec(
-                namespace, pod, container, cmd, osStream, errStream, isStream, nop, false);
+                namespace, pod, container, cmd, osStream, errStream, isStream, false);
             let args = `stdout=true&stderr=true&stdin=true&tty=false&command=${cmd}&container=${container}`;
             verify(fakeWebSocket.connect(`${path}?${args}`, null,  anyFunction())).called();
 
             await exec.exec(
-                namespace, pod, container, cmd, null, errStream, isStream, nop, false);
+                namespace, pod, container, cmd, null, errStream, isStream, false);
             args = `stdout=false&stderr=true&stdin=true&tty=false&command=${cmd}&container=${container}`;
             verify(fakeWebSocket.connect(`${path}?${args}`, null,  anyFunction())).called();
 
             await exec.exec(
-                namespace, pod, container, cmd, null, null, isStream, nop, false);
+                namespace, pod, container, cmd, null, null, isStream, false);
             args = `stdout=false&stderr=false&stdin=true&tty=false&command=${cmd}&container=${container}`;
             verify(fakeWebSocket.connect(`${path}?${args}`, null,  anyFunction())).called();
 
             await exec.exec(
-                namespace, pod, container, cmd, null, null, null, nop, false);
+                namespace, pod, container, cmd, null, null, null, false);
             args = `stdout=false&stderr=false&stdin=false&tty=false&command=${cmd}&container=${container}`;
             verify(fakeWebSocket.connect(`${path}?${args}`, null,  anyFunction())).called();
 
             await exec.exec(
-                namespace, pod, container, cmd, null, errStream, isStream, nop, true);
+                namespace, pod, container, cmd, null, errStream, isStream, true);
             args = `stdout=false&stderr=true&stdin=true&tty=true&command=${cmd}&container=${container}`;
             verify(fakeWebSocket.connect(`${path}?${args}`, null,  anyFunction())).called();
         });
@@ -68,11 +66,15 @@ describe('Exec', () => {
             const path = `/api/v1/namespaces/${namespace}/pods/${pod}/exec`;
             const args = `stdout=true&stderr=true&stdin=true&tty=false&command=${cmd}&container=${container}`;
 
+            let statusOut = {} as V1Status;
+
             const fakeConn: WebSocket = mock(WebSocket);
             when(fakeWebSocket.connect(`${path}?${args}`, null, anyFunction())).thenResolve(fakeConn);
 
             await exec.exec(
-                namespace, pod, container, cmd, osStream, errStream, isStream, nop, false);
+                namespace, pod, container, cmd, osStream, errStream, isStream, false, (status: V1Status) => {
+                    statusOut = status;
+                });
 
             const [, , outputFn] = capture(fakeWebSocket.connect).last();
 
@@ -105,6 +107,14 @@ describe('Exec', () => {
             isStream.put(msg);
             verify(fakeConn.send(msg));
 
+            const statusIn = {
+                code: 100,
+                message: 'this is a test',
+            } as V1Status;
+
+            outputFn(WebSocketHandler.StatusStream, Buffer.from(JSON.stringify(statusIn)));
+            expect(statusOut).to.deep.equal(statusIn);
+
             isStream.stop();
             verify(fakeConn.close());
         });