'Tekton: Follow Log' command for PipelineRuns and TaskRuns

redhat-developer · Dec 6, 2019 · 922c693 · 922c693
1 parent dc0317a
commit 922c693
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "onCommand:tekton.pipelinerun.list",
     "onCommand:tekton.pipelinerun.describe",
     "onCommand:tekton.pipelinerun.logs",
+    "onCommand:tekton.pipelinerun.followLogs",
     "onCommand:tekton.pipelinerun.cancel",
     "onCommand:tekton.pipelinerun.delete",
     "onCommand:tekton.pipelineresource.list",
@@ -44,6 +45,7 @@
     "onCommand:tekton.taskrun.list",
     "onCommand:tekton.taskrun.listFromTask",
     "onCommand:tekton.taskrun.logs",
+    "onCommand:tekton.taskrun.followLogs",
     "onCommand:tekton.taskrun.delete",
     "onCommand:tekton.explorer.refresh",
     "onCommand:tekton.about",
@@ -132,6 +134,11 @@
         "title": "Show Logs",
         "category": "Tekton"
       },
+      {
+        "command": "tekton.pipelinerun.followLogs",
+        "title": "Follow Logs",
+        "category": "Tekton"
+      },
       {
         "command": "tekton.pipelinerun.cancel",
         "title": "Cancel",
@@ -187,6 +194,11 @@
         "title": "Show Logs",
         "category": "Tekton"
       },
+      {
+        "command": "tekton.taskrun.followLogs",
+        "title": "Follow Logs",
+        "category": "Tekton"
+      },
       {
         "command": "tekton.taskrun.delete",
         "title": "Delete",
@@ -274,6 +286,10 @@
           "command": "tekton.pipelinerun.logs",
           "when": "view == tektonPipelineExplorer"
         },
+        {
+          "command": "tekton.pipelinerun.followLogs",
+          "when": "view == tektonPipelineExplorer"
+        },
         {
           "command": "tekton.pipelinerun.cancel",
           "when": "view == tektonPipelineExplorer"
@@ -318,6 +334,10 @@
           "command": "tekton.taskrun.logs",
           "when": "view == tektonPipelineExplorer"
         },
+        {
+          "command": "tekton.taskrun.followLogs",
+          "when": "view == tektonPipelineExplorer"
+        },
         {
           "command": "tekton.taskrun.delete",
           "when": "view == tektonPipelineExplorer"
@@ -401,6 +421,11 @@
           "when": "view == tektonPipelineExplorer && viewItem == pipelinerun",
           "group": "c1@3"
         },
+        {
+          "command": "tekton.pipelinerun.followLogs",
+          "when": "view == tektonPipelineExplorer && viewItem == pipelinerun",
+          "group": "c1@4"
+        },
         {
           "command": "tekton.pipelinerun.cancel",
           "when": "view == tektonPipelineExplorer && viewItem == pipelinerun",
@@ -461,6 +486,11 @@
           "when": "view == tektonPipelineExplorer && viewItem == taskrun",
           "group": "c1"
         },
+        {
+          "command": "tekton.taskrun.followLogs",
+          "when": "view == tektonPipelineExplorer && viewItem == taskrun",
+          "group": "c1@1"
+        },
         {
           "command": "tekton.taskrun.delete",
           "when": "view == tektonPipelineExplorer && viewItem == taskrun",

diff --git a/src/extension.ts b/src/extension.ts
@@ -38,6 +38,7 @@ export async function activate(context: vscode.ExtensionContext) {
         vscode.commands.registerCommand('tekton.pipelinerun.list', (context) => execute(PipelineRun.list, context)),
         vscode.commands.registerCommand('tekton.pipelinerun.describe', (context) => execute(PipelineRun.describe, context)),
         vscode.commands.registerCommand('tekton.pipelinerun.logs', (context) => execute(PipelineRun.logs, context)),
+        vscode.commands.registerCommand('tekton.pipelinerun.followLogs', (context) => execute(PipelineRun.followLog, context)),
         vscode.commands.registerCommand('tekton.pipelinerun.cancel', (context) => execute(PipelineRun.cancel, context)),
         vscode.commands.registerCommand('tekton.pipelinerun.delete', (context) => execute(PipelineRun.delete, context)),
         vscode.commands.registerCommand('tekton.task.start', (context) => execute(Task.start, context)),
@@ -49,6 +50,7 @@ export async function activate(context: vscode.ExtensionContext) {
         vscode.commands.registerCommand('tekton.taskrun.list', (context) => execute(TaskRun.list, context)),
         vscode.commands.registerCommand('tekton.taskrun.listFromTask', (context) => execute(TaskRun.listFromTask, context)),
         vscode.commands.registerCommand('tekton.taskrun.logs', (context) => execute(TaskRun.logs, context)),
+        vscode.commands.registerCommand('tekton.taskrun.followLogs', (context) => execute(TaskRun.followLog, context)),
        // vscode.commands.registerCommand('tekton.taskrun.cancel', (context) => execute(TaskRun.cancel, context)),
         vscode.commands.registerCommand('tekton.taskrun.delete', (context) => execute(TaskRun.delete, context)),
         vscode.commands.registerCommand('tekton.explorer.reportIssue', () => PipelineExplorer.reportIssue()),

diff --git a/src/tekton/pipelinerun.ts b/src/tekton/pipelinerun.ts
@@ -40,6 +40,10 @@ export class PipelineRun extends TektonItem {
         if (pipelinerun) { PipelineRun.tkn.executeInTerminal(Command.showPipelineRunLogs(pipelinerun.getName())); }
     }
 
+    static async followLog(pipelinerun: TektonNode): Promise<void> {
+        PipelineRun.tkn.executeInTerminal(Command.showPipelineRunFollowLogs(pipelinerun.getName()));
+    }
+
      static async cancel(pipelinerun: TektonNode): Promise<void> {
         if (pipelinerun) { PipelineRun.tkn.executeInTerminal(Command.cancelPipelineRun(pipelinerun.getName())); }
     }

diff --git a/src/tekton/taskrun.ts b/src/tekton/taskrun.ts
@@ -20,6 +20,10 @@ export class TaskRun extends TektonItem {
         if (taskrun) { TaskRun.tkn.executeInTerminal(Command.showTaskRunLogs(taskrun.getName())); }
     }
 
+    static async followLog(taskrun: TektonNode): Promise<void> {
+        TaskRun.tkn.executeInTerminal(Command.showTaskRunFollowLogs(taskrun.getName()));
+    }
+
     static async delete(taskrun: TektonNode): Promise<void> {
         if (taskrun) { TaskRun.tkn.executeInTerminal(Command.deleteTaskRun(taskrun.getName())); }
     }

diff --git a/src/tkn.ts b/src/tkn.ts
@@ -208,6 +208,14 @@ export class Command {
         return `tkn version`;
     }
 
+    static showPipelineRunFollowLogs(name: string) {
+        return `tkn pipelinerun logs ${name} -f`;
+    }
+
+    static showTaskRunFollowLogs(name: string) {
+        return `tkn taskrun logs ${name} -f`;
+    }
+
 }
 
 export class TektonNodeImpl implements TektonNode {

diff --git a/test/tekton/pipelinerun.test.ts b/test/tekton/pipelinerun.test.ts
@@ -116,6 +116,16 @@ suite('Tekton/PipelineRun', () => {
 
         });
 
+        suite('followLog', () => {
+
+            test('followLog calls the correct tkn command in terminal', async () => {
+                await PipelineRun.followLog(pipelinerunItem);
+
+                expect(termStub).calledOnceWith(Command.showPipelineRunFollowLogs(pipelinerunItem.getName()));
+            });
+
+        });
+
         suite('cancel', () => {
 
             setup(() => {

diff --git a/test/tekton/taskrun.test.ts b/test/tekton/taskrun.test.ts
@@ -128,6 +128,17 @@ suite('Tekton/TaskRun', () => {
             });
 
         });
+
+        suite('followLog', () => {
+
+            test('followLog calls the correct tkn command in terminal', async () => {
+                await TaskRun.followLog(taskrunItem);
+
+                expect(termStub).calledOnceWith(Command.showTaskRunFollowLogs(taskrunItem.getName()));
+            });
+
+        });
+
         suite('delete', () => {
 
             test('delete calls the correct tkn command in terminal', async () => {