Refactor Integrations Backend to abstract IO

server/adaptors/integrations/__test__/builder.test.ts

@@ -5,7 +5,7 @@
 
 import { SavedObjectsClientContract } from '../../../../../../src/core/server';
 import { IntegrationInstanceBuilder } from '../integrations_builder';
-import { Integration } from '../repository/integration';
+import { IntegrationReader } from '../repository/integration';
 
 const mockSavedObjectsClient: SavedObjectsClientContract = ({
   bulkCreate: jest.fn(),
@@ -16,7 +16,7 @@ const mockSavedObjectsClient: SavedObjectsClientContract = ({
   update: jest.fn(),
 } as unknown) as SavedObjectsClientContract;
 
-const sampleIntegration: Integration = ({
+const sampleIntegration: IntegrationReader = ({
   deepCheck: jest.fn().mockResolvedValue(true),
   getAssets: jest.fn().mockResolvedValue({
     savedObjects: [
@@ -34,7 +34,7 @@ const sampleIntegration: Integration = ({
     name: 'integration-template',
     type: 'integration-type',
   }),
-} as unknown) as Integration;
+} as unknown) as IntegrationReader;
 
 describe('IntegrationInstanceBuilder', () => {
   let builder: IntegrationInstanceBuilder;
@@ -93,13 +93,23 @@ describe('IntegrationInstanceBuilder', () => {
         ],
       };
 
-      // Mock the implementation of the methods in the Integration class
-      sampleIntegration.deepCheck = jest.fn().mockResolvedValue(true);
-      sampleIntegration.getAssets = jest.fn().mockResolvedValue({ savedObjects: remappedAssets });
-      sampleIntegration.getConfig = jest.fn().mockResolvedValue({
+      const mockTemplate: Partial<IntegrationConfig> = {
         name: 'integration-template',
         type: 'integration-type',
-      });
+        assets: {
+          savedObjects: {
+            name: 'assets',
+            version: '1.0.0',
+          },
+        },
+      };
+
+      // Mock the implementation of the methods in the Integration class
+      sampleIntegration.deepCheck = jest.fn().mockResolvedValue({ ok: true, value: mockTemplate });
+      sampleIntegration.getAssets = jest
+        .fn()
+        .mockResolvedValue({ ok: true, value: { savedObjects: remappedAssets } });
+      sampleIntegration.getConfig = jest.fn().mockResolvedValue({ ok: true, value: mockTemplate });
 
       // Mock builder sub-methods
       const remapIDsSpy = jest.spyOn(builder, 'remapIDs');
@@ -121,22 +131,24 @@ describe('IntegrationInstanceBuilder', () => {
         dataSource: 'instance-datasource',
         name: 'instance-name',
       };
-      sampleIntegration.deepCheck = jest.fn().mockResolvedValue(false);
+      sampleIntegration.deepCheck = jest
+        .fn()
+        .mockResolvedValue({ ok: false, error: new Error('Mock error') });
 
-      await expect(builder.build(sampleIntegration, options)).rejects.toThrowError(
-        'Integration is not valid'
-      );
+      await expect(builder.build(sampleIntegration, options)).rejects.toThrowError('Mock error');
     });
 
-    it('should reject with an error if getAssets throws an error', async () => {
+    it('should reject with an error if getAssets rejects', async () => {
       const options = {
         dataSource: 'instance-datasource',
         name: 'instance-name',
       };
 
       const errorMessage = 'Failed to get assets';
-      sampleIntegration.deepCheck = jest.fn().mockResolvedValue(true);
-      sampleIntegration.getAssets = jest.fn().mockRejectedValue(new Error(errorMessage));
+      sampleIntegration.deepCheck = jest.fn().mockResolvedValue({ ok: true, value: {} });
+      sampleIntegration.getAssets = jest
+        .fn()
+        .mockResolvedValue({ ok: false, error: new Error(errorMessage) });
 
       await expect(builder.build(sampleIntegration, options)).rejects.toThrowError(errorMessage);
     });
@@ -153,22 +165,14 @@ describe('IntegrationInstanceBuilder', () => {
         },
       ];
       const errorMessage = 'Failed to post assets';
-      sampleIntegration.deepCheck = jest.fn().mockResolvedValue(true);
-      sampleIntegration.getAssets = jest.fn().mockResolvedValue({ savedObjects: remappedAssets });
+      sampleIntegration.deepCheck = jest.fn().mockResolvedValue({ ok: true, value: {} });
+      sampleIntegration.getAssets = jest
+        .fn()
+        .mockResolvedValue({ ok: true, value: { savedObjects: remappedAssets } });
       builder.postAssets = jest.fn().mockRejectedValue(new Error(errorMessage));
 
       await expect(builder.build(sampleIntegration, options)).rejects.toThrowError(errorMessage);
     });
-
-    it('should reject with an error if getConfig returns null', async () => {
-      const options = {
-        dataSource: 'instance-datasource',
-        name: 'instance-name',
-      };
-      sampleIntegration.getConfig = jest.fn().mockResolvedValue(null);
-
-      await expect(builder.build(sampleIntegration, options)).rejects.toThrowError();
-    });
   });
 
   describe('remapIDs', () => {
@@ -264,8 +268,11 @@ describe('IntegrationInstanceBuilder', () => {
     it('should build an integration instance', async () => {
       const integration = {
         getConfig: jest.fn().mockResolvedValue({
-          name: 'integration-template',
-          type: 'integration-type',
+          ok: true,
+          value: {
+            name: 'integration-template',
+            type: 'integration-type',
+          },
         }),
       };
       const refs = [
@@ -291,7 +298,7 @@ describe('IntegrationInstanceBuilder', () => {
       };
 
       const instance = await builder.buildInstance(
-        (integration as unknown) as Integration,
+        (integration as unknown) as IntegrationReader,
         refs,
         options
       );
@@ -319,7 +326,7 @@ describe('IntegrationInstanceBuilder', () => {
       };
 
       await expect(
-        builder.buildInstance((integration as unknown) as Integration, refs, options)
+        builder.buildInstance((integration as unknown) as IntegrationReader, refs, options)
       ).rejects.toThrowError();
     });
   });

server/adaptors/integrations/__test__/local_repository.test.ts

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Repository } from '../repository/repository';
-import { Integration } from '../repository/integration';
+import { RepositoryReader } from '../repository/repository';
+import { IntegrationReader } from '../repository/integration';
 import path from 'path';
 import * as fs from 'fs/promises';
 
@@ -20,15 +20,25 @@ describe('The local repository', () => {
           return Promise.resolve(null);
         }
         // Otherwise, all directories must be integrations
-        const integ = new Integration(integPath);
-        await expect(integ.check()).resolves.toBe(true);
+        const integ = new IntegrationReader(integPath);
+        expect(integ.getConfig()).resolves.toHaveProperty('ok', true);
       })
     );
   });
 
   it('Should pass deep validation for all local integrations.', async () => {
-    const repository: Repository = new Repository(path.join(__dirname, '../__data__/repository'));
-    const integrations: Integration[] = await repository.getIntegrationList();
-    await Promise.all(integrations.map((i) => expect(i.deepCheck()).resolves.toBeTruthy()));
+    const repository: RepositoryReader = new RepositoryReader(
+      path.join(__dirname, '../__data__/repository')
+    );
+    const integrations: IntegrationReader[] = await repository.getIntegrationList();
+    await Promise.all(
+      integrations.map(async (i) => {
+        const result = await i.deepCheck();
+        if (!result.ok) {
+          console.error(result.error);
+        }
+        expect(result.ok).toBe(true);
+      })
+    );
   });
 });