Add completion for 'conditionRef' field (#337)

* #244 add completion for 'conditionRef' field

Signed-off-by: Yevhen Vydolob <[email protected]>

* add tests

Signed-off-by: Yevhen Vydolob <[email protected]>

src/yaml-support/snippet.ts

@@ -0,0 +1,10 @@
+/*-----------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE file in the project root for license information.
+ *-----------------------------------------------------------------------------------------------*/
+
+export interface Snippet<T> {
+  label: string;
+  description?: string;
+  body: T;
+}

src/yaml-support/tkn-conditions-provider.ts

@@ -0,0 +1,24 @@
+/*-----------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE file in the project root for license information.
+ *-----------------------------------------------------------------------------------------------*/
+
+import { tkn, Command } from '../tkn';
+
+
+export async function getTknConditionsSnippets(): Promise<string[]> {
+  const result = await tkn.execute(Command.listConditions());
+  let data = [];
+  if (result.error) {
+    return [];
+  }
+  try {
+    data = JSON.parse(result.stdout).items;
+  } catch (ignore) {
+    //show no pipelines if output is not correct json
+  }
+
+  let condition: string[] = data.map((value) => value.metadata.name);
+  condition = [...new Set(condition)];
+  return condition;
+}

src/yaml-support/tkn-tasks-provider.ts

@@ -4,12 +4,8 @@
  *-----------------------------------------------------------------------------------------------*/
 import { tkn } from '../tkn';
 import { TknTask } from '../tekton';
+import { Snippet } from './snippet';
 
-export interface Snippet {
-  label: string;
-  description?: string;
-  body: TaskSnippet;
-}
 
 interface TaskSnippet {
   name: string;
@@ -56,7 +52,7 @@ interface Param {
   value: string | string[];
 }
 
-export async function getTknTasksSnippets(): Promise<Snippet[]> {
+export async function getTknTasksSnippets(): Promise<Snippet<TaskSnippet>[]> {
   const [rawClusterTasks, rawTasks] = await Promise.all([tkn.getRawClusterTasks(), tkn.getRawTasks()]);
 
   const allRawTasks = rawClusterTasks.concat(rawTasks);
@@ -65,8 +61,8 @@ export async function getTknTasksSnippets(): Promise<Snippet[]> {
   return snippets;
 }
 
-export function convertTasksToSnippet(rawTasks: TknTask[]): Snippet[] {
-  const result: Snippet[] = [];
+export function convertTasksToSnippet(rawTasks: TknTask[]): Snippet<TaskSnippet>[] {
+  const result: Snippet<TaskSnippet>[] = [];
 
   for (const task of rawTasks) {
     result.push({

src/yaml-support/tkn-yaml-scheme-generator.ts

@@ -5,9 +5,11 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
 import { readFile } from 'fs-extra'
-import { Snippet, getTknTasksSnippets } from './tkn-tasks-provider';
+import { getTknTasksSnippets } from './tkn-tasks-provider';
 import { schemeStorage } from './tkn-scheme-storage'
 import { pipelineYaml } from './tkn-yaml';
+import { Snippet } from './snippet';
+import { getTknConditionsSnippets } from './tkn-conditions-provider';
 
 let context: vscode.ExtensionContext;
 export function generateScheme(extContext: vscode.ExtensionContext, vsDocument: vscode.TextDocument): Promise<string> {
@@ -18,7 +20,7 @@ export function generateScheme(extContext: vscode.ExtensionContext, vsDocument:
 
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function injectTaskSnippets(templateObj: any, snippets: Snippet[]): {} {
+function injectTaskSnippets(templateObj: any, snippets: Snippet<{}>[]): {} {
   templateObj.definitions.PipelineSpec.properties.tasks.defaultSnippets = snippets;
   return templateObj;
 }
@@ -45,9 +47,17 @@ function injectResourceName(templateObj: any, resNames: string[]): {} {
   return templateObj;
 }
 
+function injectConditionRefs(templateObj: any, conditions: string[]): {} {
+  if (conditions && conditions.length > 0) {
+    templateObj.definitions.PipelineTaskCondition.properties.conditionRef.enum = conditions;
+  }
+  return templateObj;
+}
+
 async function generate(doc: vscode.TextDocument): Promise<string> {
   const template = await readFile(path.join(context.extensionPath, 'scheme', 'pipeline.json'), 'UTF8');
   const snippets = await getTknTasksSnippets();
+  const conditions = await getTknConditionsSnippets();
   const definedTasks = pipelineYaml.getPipelineTasksName(doc);
   const declaredResources = pipelineYaml.getDeclaredResources(doc);
 
@@ -57,5 +67,6 @@ async function generate(doc: vscode.TextDocument): Promise<string> {
   const tasksRef = snippets.map(value => value.body.taskRef.name);
   templateWithSnippets = injectTasksName(templateWithSnippets, definedTasks, tasksRef);
   templateWithSnippets = injectResourceName(templateWithSnippets, resNames);
+  templateWithSnippets = injectConditionRefs(templateWithSnippets, conditions);
   return JSON.stringify(templateWithSnippets);
 }

test/yaml-support/tkn-condition-provider.test.ts

@@ -0,0 +1,40 @@
+/*-----------------------------------------------------------------------------------------------
+ *  Copyright (c) Red Hat, Inc. All rights reserved.
+ *  Licensed under the MIT License. See LICENSE file in the project root for license information.
+ *-----------------------------------------------------------------------------------------------*/
+import * as vscode from 'vscode';
+import * as chai from 'chai';
+import * as sinonChai from 'sinon-chai';
+import * as sinon from 'sinon';
+import { tkn } from '../../src/tkn';
+import { getTknConditionsSnippets } from '../../src/yaml-support/tkn-conditions-provider';
+
+const expect = chai.expect;
+chai.use(sinonChai);
+
+suite('ConditionRef provider', () => {
+
+  const sandbox = sinon.createSandbox();
+  let tknExecute: sinon.SinonStub;
+
+  setup(() => {
+    tknExecute = sandbox.stub(tkn, 'execute');
+  });
+
+  teardown(() => {
+    sandbox.restore();
+  });
+
+  test('should return empty array if any error on getting condition list', async () => {
+    tknExecute.resolves({ error: 'Some error' });
+    const result = await getTknConditionsSnippets();
+    expect(result).eql([]);
+  });
+
+  test('should array with condition names', async () => {
+    tknExecute.resolves({ stdout: '{"items": [{"metadata": {"name": "foo"}}, {"metadata": {"name": "bar"}}]}' });
+    const result = await getTknConditionsSnippets();
+    expect(result).eql(['foo', 'bar']);
+  });
+
+});