@squiz/component-cli-lib 1.2.9 → 1.2.11

package/src/integration-tests/upload-and-render-component.integration.spec.ts

@@ -14,7 +14,7 @@ import color from 'cli-color';
 import path from 'path';
 import supertest from 'supertest';
 import { logger } from '../upload-component-folder';
-import { ComponentSetWebModel } from '@squiz/component-lib';
+import { ComponentSetWebModelForCreate } from '@squiz/component-lib';
 import fsp from 'fs/promises';
 import { randomUUID } from 'crypto';
 
@@ -22,195 +22,204 @@ const mockConsoleError = jest.fn();
 const mockConsoleLog = jest.fn();
 
 const orgConsoleError = console.error;
-const webPath = 'set';
+const webPath = 'set-' + randomUUID();
 const contentItemId = randomUUID();
 const testFilesDir = path.resolve(__dirname, 'test-files');
 
-beforeAll(async () => {
-  await fsp.rm(testFilesDir, { force: true, recursive: true });
-  await fsp.mkdir(testFilesDir);
-});
-
-afterAll(async () => {
-  // clean up the component added by the test
-  await deleteComponentSet(webPath);
-  await deleteContentItem(contentItemId);
-
-  for (const componentName of getTestComponents()) {
-    try {
-      await managementService.delete(`/component/smoke-test-components/${componentName}`);
-    } catch {
-      // no op
-    }
-  }
-
-  // clean up the test componnet files
-  await fsp.rm(testFilesDir, { force: true, recursive: true });
-});
-
-describe('Test isolated test cases', () => {
-  beforeEach(() => {
-    jest.spyOn(logger, 'error').mockImplementation(mockConsoleError);
-    jest.spyOn(logger, 'info').mockImplementation(mockConsoleLog);
-  });
-
-  it('Should fail uploading a component without manifest.json', async () => {
-    mockConsoleError.mockClear();
-    const componentPath = path.join(__dirname, '/__components__/invalid-upload');
-    await uploadComponentFolder(
-      componentPath,
-      configObj.managementServiceUrl + '/v1',
-      configObj.renderServiceUrl,
-      testFilesDir,
-    );
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(color.red('manifest could not be found'));
-  });
-
-  it('Should fail uploading a component that has invalid manifest.json', async () => {
-    mockConsoleError.mockClear();
-    const componentPath = path.join(__dirname, '/__components__/invalid-manifest');
-    await uploadComponentFolder(
-      componentPath,
-      configObj.managementServiceUrl + '/v1',
-      configObj.renderServiceUrl,
-      testFilesDir,
-    );
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(
-      color.red('failed validation: /name pattern must match pattern "^[a-zA-Z0-9_\\-]+$"'),
-    );
-  });
-
-  it('Should fail uploading the component that has size more than 100MB', async () => {
-    mockConsoleError.mockClear();
-    const componentPath = path.join(__dirname, '/__components__/big-package');
-    const filePath = `${componentPath}/105mb-file`;
-    await createFile(filePath, 105); // Higher limit has been used because compression reduces the size if you use closer to 100MB
-    await uploadComponentFolder(
-      componentPath,
-      configObj.managementServiceUrl + '/v1',
-      configObj.renderServiceUrl,
-      testFilesDir,
-    );
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(
-      color.red(['File size exceeds the maximum limit of 100MB'].join('')),
-    );
-    removeFile(filePath);
+describe('uploading a component', () => {
+  beforeAll(async () => {
+    await fsp.rm(testFilesDir, { force: true, recursive: true });
+    await fsp.mkdir(testFilesDir);
   });
-});
 
-describe('Deploy basic component having a static file', () => {
-  // component to deploy for this test
-  const componentPath = path.join(__dirname, '/__components__/cmp-static-file-test');
-
-  beforeAll(async () => {
+  afterAll(async () => {
+    // clean up the component added by the test
     await deleteComponentSet(webPath);
     await deleteContentItem(contentItemId);
+
     for (const componentName of getTestComponents()) {
       try {
-        await managementService.delete(`/component/${componentName}`);
+        await managementService.delete(`/component/smoke-test-components/${componentName}`);
       } catch {
         // no op
       }
     }
-  });
 
-  beforeEach(() => {
-    console.error = mockConsoleError;
-    console.log = mockConsoleLog;
+    // clean up the test componnet files
+    await fsp.rm(testFilesDir, { force: true, recursive: true });
   });
 
-  afterEach(() => {
-    console.error = orgConsoleError;
-  });
+  describe('Test isolated test cases', () => {
+    beforeEach(() => {
+      jest.spyOn(logger, 'error').mockImplementation(mockConsoleError);
+      jest.spyOn(logger, 'info').mockImplementation(mockConsoleLog);
+    });
 
-  it('Should upload the component and return a valid url to preview', async () => {
-    await uploadComponentFolder(
-      componentPath,
-      configObj.managementServiceUrl + '/v1',
-      configObj.renderServiceUrl,
-      testFilesDir,
-    );
-
-    const uploadedComponent = '<a href="/preview/smoke-test-components/cmp-static-file-test/1.0.0">1.0.0</a>';
-    const get = await supertest(configObj.renderServiceUrl).get('/');
-    expect(get.status).toEqual(200);
-    expect((get as any)?.res?.text).toContain(uploadedComponent);
-  });
+    it('Should fail uploading a component without manifest.json', async () => {
+      mockConsoleError.mockClear();
+      const componentPath = path.join(__dirname, '/__components__/invalid-upload');
+      await uploadComponentFolder(
+        componentPath,
+        configObj.managementServiceUrl + '/v1',
+        configObj.renderServiceUrl,
+        testFilesDir,
+      );
+      expect(mockConsoleError.mock.calls[0][0]).toEqual(color.red('manifest could not be found'));
+    });
 
-  it('Should fail upload the component with same version', async () => {
-    mockConsoleError.mockClear();
-    await uploadComponentFolder(
-      componentPath,
-      configObj.managementServiceUrl + '/v1',
-      configObj.renderServiceUrl,
-      testFilesDir,
-    );
-    expect(mockConsoleError.mock.calls[0][0]).toEqual(
-      color.red('Cannot upload component version, smoke-test-components/cmp-static-file-test 1.0.0 already exists'),
-    );
-  });
+    it('Should fail uploading a component that has invalid manifest.json', async () => {
+      mockConsoleError.mockClear();
+      const componentPath = path.join(__dirname, '/__components__/invalid-manifest');
+      await uploadComponentFolder(
+        componentPath,
+        configObj.managementServiceUrl + '/v1',
+        configObj.renderServiceUrl,
+        testFilesDir,
+      );
+      expect(mockConsoleError.mock.calls[0][0]).toEqual(
+        color.red('failed validation: /name pattern must match pattern "^[a-zA-Z0-9_\\-]+$"'),
+      );
+    });
 
-  it('Should render component', async () => {
-    const componentSet: ComponentSetWebModel = {
-      webPath,
-      displayName: 'Set',
-      description: 'Set description',
-      headers: {},
-      environmentVariables: {},
-      components: {
-        'smoke-test-components/cmp-static-file-test': [{ environmentVariables: {}, version: '1.0.0' }],
-      },
-      componentVersionRules: {},
-    };
-
-    await addComponentSet(componentSet);
-
-    const response = await renderService.get(
-      '/r/set/smoke-test-components/cmp-static-file-test/1.0.0/?something=hello',
-    );
-    expect(response.status).toEqual(200);
-    expect(response.data).toEqual(
-      [
-        '<div>Input: hello</div>',
-        '<div>smoke-test-components/cmp-static-file-test 1.0.0 ',
-        `${configObj.renderServiceUrl}/s/set/smoke-test-components/cmp-static-file-test/1.0.0/birthday-cake.png</div>`,
-      ].join(''),
-    );
+    it('Should fail uploading the component that has size more than 100MB', async () => {
+      mockConsoleError.mockClear();
+      const componentPath = path.join(__dirname, '/__components__/big-package');
+      const filePath = `${componentPath}/105mb-file`;
+      await createFile(filePath, 105); // Higher limit has been used because compression reduces the size if you use closer to 100MB
+      await uploadComponentFolder(
+        componentPath,
+        configObj.managementServiceUrl + '/v1',
+        configObj.renderServiceUrl,
+        testFilesDir,
+      );
+      expect(mockConsoleError.mock.calls[0][0]).toEqual(
+        color.red(['File size exceeds the maximum limit of 100MB'].join('')),
+      );
+      removeFile(filePath);
+    });
   });
 
-  it('Should render component with content item ID input', async () => {
-    const componentSet: ComponentSetWebModel = {
-      webPath,
-      displayName: 'Set',
-      description: 'Set description',
-      headers: {},
-      environmentVariables: {},
-      components: {
-        'smoke-test-components/cmp-static-file-test': [{ environmentVariables: {}, version: '1.0.0' }],
-      },
-      componentVersionRules: {},
-    };
-    await addComponentSet(componentSet);
-
-    // add a component item for the test
-    await addContentItem({
-      id: contentItemId,
-      schemaName: 'smoke-test-components/cmp-static-file-test/1.0.0/main',
-      content: {
-        something: 'from-content-item-service',
-      },
+  describe('Deploy basic component having a static file', () => {
+    // component to deploy for this test
+    const componentPath = path.join(__dirname, '/__components__/cmp-static-file-test');
+
+    beforeAll(async () => {
+      await deleteComponentSet(webPath);
+      await deleteContentItem(contentItemId);
+      for (const componentName of getTestComponents()) {
+        try {
+          await managementService.delete(`/component/${componentName}`);
+        } catch {
+          // no op
+        }
+      }
+    });
+
+    beforeEach(() => {
+      console.error = mockConsoleError;
+      console.log = mockConsoleLog;
     });
 
-    const response = await renderService.get(
-      '/r/set/smoke-test-components/cmp-static-file-test/1.0.0/?_contentItemId=' + contentItemId,
-    );
-    expect(response.status).toEqual(200);
-    expect(response.data).toEqual(
-      [
-        '<div>Input: from-content-item-service</div>',
-        '<div>smoke-test-components/cmp-static-file-test 1.0.0 ',
-        `${configObj.renderServiceUrl}/s/set/smoke-test-components/cmp-static-file-test/1.0.0/birthday-cake.png</div>`,
-      ].join(''),
-    );
+    afterEach(() => {
+      console.error = orgConsoleError;
+    });
+
+    it('Should upload the component and return a valid url to preview', async () => {
+      await uploadComponentFolder(
+        componentPath,
+        configObj.managementServiceUrl + '/v1',
+        configObj.renderServiceUrl,
+        testFilesDir,
+      );
+
+      const uploadedComponent = '<a href="/preview/smoke-test-components/cmp-static-file-test/1.0.0">1.0.0</a>';
+      const get = await supertest(configObj.renderServiceUrl).get('/');
+      expect(get.status).toEqual(200);
+      expect((get as any)?.res?.text).toContain(uploadedComponent);
+    });
+
+    it('Should fail upload the component with same version', async () => {
+      mockConsoleError.mockClear();
+      await uploadComponentFolder(
+        componentPath,
+        configObj.managementServiceUrl + '/v1',
+        configObj.renderServiceUrl,
+        testFilesDir,
+      );
+      expect(mockConsoleError.mock.calls[0][0]).toEqual(
+        color.red('Cannot upload component version, smoke-test-components/cmp-static-file-test 1.0.0 already exists'),
+      );
+    });
+
+    it('Should render component', async () => {
+      const componentSet: ComponentSetWebModelForCreate = {
+        webPath,
+        displayName: 'some-display-name',
+        description: 'Set description',
+        headers: {},
+        environmentVariables: {},
+        components: {
+          'smoke-test-components/cmp-static-file-test': [
+            {
+              environmentVariables: {},
+              version: '1.0.0',
+            },
+          ],
+        },
+        componentVersionRules: {},
+      };
+
+      await addComponentSet(componentSet);
+
+      const response = await renderService.get(
+        `/r/${webPath}/smoke-test-components/cmp-static-file-test/1.0.0/?something=hello`,
+      );
+      expect(response.status).toEqual(200);
+      expect(response.data).toEqual(
+        [
+          '<div>Input: hello</div>',
+          '<div>smoke-test-components/cmp-static-file-test 1.0.0 ',
+          `${configObj.renderServiceUrl}/s/${webPath}/smoke-test-components/cmp-static-file-test/1.0.0/birthday-cake.png</div>`,
+        ].join(''),
+      );
+    });
+
+    it('Should render component with content item ID input', async () => {
+      const componentSet: ComponentSetWebModelForCreate = {
+        webPath,
+        displayName: 'some-display-name',
+        description: 'Set description',
+        headers: {},
+        environmentVariables: {},
+        components: {
+          'smoke-test-components/cmp-static-file-test': [{ environmentVariables: {}, version: '1.0.0' }],
+        },
+        componentVersionRules: {},
+      };
+      await addComponentSet(componentSet);
+
+      // add a component item for the test
+      await addContentItem({
+        id: contentItemId,
+        schemaName: 'smoke-test-components/cmp-static-file-test/1.0.0/main',
+        content: {
+          something: 'from-content-item-service',
+        },
+      });
+
+      console.log(`/r/${webPath}/smoke-test-components/cmp-static-file-test/1.0.0/?_contentItemId=` + contentItemId);
+
+      const response = await renderService.get(
+        `/r/${webPath}/smoke-test-components/cmp-static-file-test/1.0.0/?_contentItemId=` + contentItemId,
+      );
+      expect(response.status).toEqual(200);
+      expect(response.data).toEqual(
+        [
+          '<div>Input: from-content-item-service</div>',
+          '<div>smoke-test-components/cmp-static-file-test 1.0.0 ',
+          `${configObj.renderServiceUrl}/s/${webPath}/smoke-test-components/cmp-static-file-test/1.0.0/birthday-cake.png</div>`,
+        ].join(''),
+      );
+    });
   });
 });