feat(aap): support workflow job templates in catalog provider (#674)

janus-idp · Aug 29, 2023 · c90bc30 · c90bc30
1 parent c4f4ddd
commit c90bc30
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 19 deletions.
diff --git a/plugins/aap-backend/README.md b/plugins/aap-backend/README.md
@@ -1,6 +1,6 @@
 # AAP Backstage provider
 
-The AAP Backstage provider plugin synchronizes the AAP content into the [Backstage](https://backstage.io/) catalog.
+The AAP Backstage provider plugin synchronizes the AAP job templates and workflow job templates into the [Backstage](https://backstage.io/) catalog.
 
 ## For administrators
 

diff --git a/plugins/aap-backend/src/clients/AapResourceConnector.ts b/plugins/aap-backend/src/clients/AapResourceConnector.ts
@@ -18,3 +18,22 @@ export function listJobTemplates(
     return resData.results as Promise<JobTemplates>;
   });
 }
+
+export function listWorkflowJobTemplates(
+  baseUrl: string,
+  access_token: string,
+): Promise<JobTemplates> {
+  return fetch(`${baseUrl}/api/v2/workflow_job_templates`, {
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: access_token,
+    },
+    method: 'GET',
+  }).then(async response => {
+    if (!response.ok) {
+      throw new Error(response.statusText);
+    }
+    const resData = await response.json();
+    return resData.results as Promise<JobTemplates>;
+  });
+}
diff --git a/plugins/aap-backend/src/providers/AapResourceEntityProvider.test.ts b/plugins/aap-backend/src/providers/AapResourceEntityProvider.test.ts
@@ -3,7 +3,10 @@ import { TaskRunner } from '@backstage/backend-tasks';
 import { ConfigReader } from '@backstage/config';
 import { EntityProviderConnection } from '@backstage/plugin-catalog-node';
 
-import { listJobTemplates } from '../clients/AapResourceConnector';
+import {
+  listJobTemplates,
+  listWorkflowJobTemplates,
+} from '../clients/AapResourceConnector';
 import { AapResourceEntityProvider } from './AapResourceEntityProvider';
 
 const BASIC_VALID_CONFIG = {
@@ -39,11 +42,13 @@ const connection = {
 jest.mock('../clients/AapResourceConnector', () => ({
   ...jest.requireActual('../clients/AapResourceConnector'),
   listJobTemplates: jest.fn().mockReturnValue({}),
+  listWorkflowJobTemplates: jest.fn().mockReturnValue({}),
 }));
 
 describe('AapResourceEntityProvider', () => {
   beforeEach(() => {
     (listJobTemplates as jest.Mock).mockClear();
+    (listWorkflowJobTemplates as jest.Mock).mockClear();
   });
 
   it('should return an empty array if no providers are configured', () => {
@@ -118,14 +123,53 @@ describe('AapResourceEntityProvider', () => {
   });
 
   it('should connect and run should resolves', async () => {
-    (listJobTemplates as jest.Mock).mockReturnValue([
-      {
-        url: 'https://aap.com',
-        name: 'demoJobTemplate',
-        description: 'test description',
-        type: 'job_template',
-      },
-    ]);
+    (listJobTemplates as jest.Mock).mockReturnValue(
+      Promise.resolve([
+        {
+          url: 'https://aap.com',
+          name: 'demoJobTemplate',
+          description: 'test description',
+          type: 'job_template',
+        },
+      ]),
+    );
+    (listWorkflowJobTemplates as jest.Mock).mockReturnValue(
+      Promise.resolve([
+        {
+          url: 'https://aap.worfkllow.com',
+          name: 'demoWorkflowJobTemplate',
+          description: 'test workflow description',
+          type: 'workflow_job_template',
+        },
+      ]),
+    );
+    const config = new ConfigReader(BASIC_VALID_CONFIG_2);
+
+    const aap = AapResourceEntityProvider.fromConfig(config, {
+      logger: getVoidLogger(),
+      schedule: { run: jest.fn() } as TaskRunner,
+    });
+
+    for await (const k of aap) {
+      await k.connect(connection);
+      await expect(k.run()).resolves.toBeUndefined();
+    }
+  });
+
+  it('should connect and run should resolves even if one api call fails', async () => {
+    (listJobTemplates as jest.Mock).mockReturnValue(
+      Promise.reject(new Error('404')),
+    );
+    (listWorkflowJobTemplates as jest.Mock).mockReturnValue(
+      Promise.resolve([
+        {
+          url: 'https://aap.worfkllow.com',
+          name: 'demoWorkflowJobTemplate',
+          description: 'test workflow description',
+          type: 'workflow_job_template',
+        },
+      ]),
+    );
     const config = new ConfigReader(BASIC_VALID_CONFIG_2);
 
     const aap = AapResourceEntityProvider.fromConfig(config, {

diff --git a/plugins/aap-backend/src/providers/AapResourceEntityProvider.ts b/plugins/aap-backend/src/providers/AapResourceEntityProvider.ts
@@ -13,7 +13,10 @@ import {
 
 import { Logger } from 'winston';
 
-import { listJobTemplates } from '../clients/AapResourceConnector';
+import {
+  listJobTemplates,
+  listWorkflowJobTemplates,
+} from '../clients/AapResourceConnector';
 import { JobTemplate } from '../clients/types';
 import { readAapApiEntityConfigs } from './config';
 import { AapConfig } from './types';
@@ -111,12 +114,22 @@ export class AapResourceEntityProvider implements EntityProvider {
 
     const entities: Entity[] = [];
 
-    const jobTemplates = await listJobTemplates(
-      this.baseUrl,
-      this.authorization,
-    );
+    const templatesData = await Promise.allSettled([
+      listJobTemplates(this.baseUrl, this.authorization),
+      listWorkflowJobTemplates(this.baseUrl, this.authorization),
+    ]);
+
+    const templates: JobTemplate[] = [];
+
+    templatesData.forEach(results => {
+      if (results.status === 'fulfilled') {
+        templates.push(...results.value);
+      } else if (results.status === 'rejected') {
+        console.error('Failed to fetch AAP job templates', results.reason);
+      }
+    });
 
-    for (const template of jobTemplates) {
+    for (const template of templates) {
       const resourceEntity: ResourceEntity =
         this.buildApiEntityFromJobTemplate(template);
       entities.push(resourceEntity);
@@ -135,10 +148,12 @@ export class AapResourceEntityProvider implements EntityProvider {
   }
 
   private buildApiEntityFromJobTemplate(template: JobTemplate): ResourceEntity {
-    const templateDetailsUrl = `${this.baseUrl}/#/templates/job_template/${template.id}/details`;
+    const templateDetailsUrl = `${this.baseUrl}/#/templates/${template.type}/${template.id}/details`;
     const jobTemplateTransformedName = `${template.name.replace(/ /g, '_')}-${
       template.summary_fields?.organization?.name || template.id
     }-${this.env}`;
+    // format template type i.e job_template to job template
+    const templateType = template.type.split('_')?.join(' ');
 
     return {
       kind: 'Resource',
@@ -157,12 +172,12 @@ export class AapResourceEntityProvider implements EntityProvider {
           },
           {
             url: `${templateDetailsUrl}`,
-            title: 'Job Template Details',
+            title: 'Template Details',
           },
         ],
       },
       spec: {
-        type: `${template.type}`,
+        type: `${templateType}`,
         owner: `${this.owner}`,
         ...(this.system && { system: `${this.system}` }),
       },