Add referencingTask method to TaskBuilder

Signed-off-by: snehajais22 <[email protected]>
cloud-native-toolkit · Jul 15, 2024 · ed3c7b5 · ed3c7b5
1 parent 5cc33a9
commit ed3c7b5
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 8 deletions.
diff --git a/API.md b/API.md
diff --git a/src/builders.ts b/src/builders.ts
@@ -653,6 +653,7 @@ export class TaskBuilder {
   private _steps?: TaskStepBuilder[];
   private _name?: string;
   private _description?: string;
+  private _taskref?: string;
   // These were initially arrays, but converted them to maps so that if
   // multiple values are added that the last one will win.
   private _workspaces = new Map<string, WorkspaceBuilder>;
@@ -828,6 +829,24 @@ export class TaskBuilder {
     return this._runafter;
   }
 
+  /**
+   * Sets the taskRef field of the 'Task'. Use only for tasks within pipelines:
+   * overrides logicalID as the name of the 'Task' in its individual yaml.
+   * @param taskRef
+   */
+  public referencingTask(taskRef: string): TaskBuilder {
+    this._taskref = taskRef;
+    return this;
+  }
+
+  /**
+   * Gets the taskRef field of the `Task` for use within a pipeline.
+   * If not set, the 'Task' id is used.
+   */
+  public get taskRef(): string {
+    return this._taskref || this._id;
+  }
+
   /**
    * Builds the `Task`.
    */
@@ -861,7 +880,7 @@ export class TaskBuilder {
 
     const props: TaskProps = {
       metadata: {
-        name: this.logicalID,
+        name: this.taskRef,
         labels: this._labels,
         annotations: this._annotations,
       },
@@ -1084,13 +1103,13 @@ export class PipelineBuilder {
       if (opts.includeDependencies) {
         // Build the task if the user has asked for the dependencies to be
         // built along with the pipeline, but only if we haven't already
-        // built the task yet.
+        // built the taskRef yet.
         if (!taskList.find(it => {
-          return it == t.logicalID;
+          return it == t.taskRef;
         })) {
           t.buildTask();
         }
-        taskList.push(t.logicalID);
+        taskList.push(t.taskRef);
       }
     });
 
@@ -1114,7 +1133,7 @@ function createOrderedPipelineTask(t: TaskBuilder, after: string[], params: Task
     return {
       name: t.name,
       taskRef: {
-        name: t.logicalID,
+        name: t.taskRef,
       },
       runAfter: after,
       params: params,
@@ -1124,7 +1143,7 @@ function createOrderedPipelineTask(t: TaskBuilder, after: string[], params: Task
   return {
     name: t.name,
     taskRef: {
-      name: t.logicalID,
+      name: t.taskRef,
     },
     params: params,
     workspaces: ws,

diff --git a/test/pipelinebuilder.test.ts b/test/pipelinebuilder.test.ts
@@ -290,12 +290,14 @@ class MyTestChartWithSimilarTasks extends Chart {
       .withValue(fromPipelineParam(pipelineParam));
 
     const myTask = new TaskBuilder(this, 'fetch-source')
+      .referencingTask('fetch-source')
       .withName('git-clone')
       .withWorkspace(myWorkspace)
       .withStringParam(urlParam)
     ;
 
-    const myTask2 = new TaskBuilder(this, 'fetch-source')
+    const myTask2 = new TaskBuilder(this, 'fetch-source-2')
+      .referencingTask('fetch-source')
       .withName('git-clone-2')
       .withWorkspace(myWorkspace)
       .withStringParam(urlParam);
@@ -317,7 +319,8 @@ class MyTestChartWithRunAfter extends Chart {
       .withName('fetch-source')
       .specifyRunAfter([]);
 
-    const secondTask = new TaskBuilder(this, 'git-clone')
+    const secondTask = new TaskBuilder(this, 'git-clone-2')
+      .referencingTask('git-clone')
       .withName('fetch-again');
 
     const thirdTask = new TaskBuilder(this, 'print-readme')