@squiz/component-cli-lib 1.2.1-alpha.100

package/lib/upload-component-folder.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadComponentFolder = exports.logger = void 0;
+const virus_scanner_lib_1 = require("@squiz/virus-scanner-lib");
+const component_lib_1 = require("@squiz/component-lib");
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const axios_1 = __importDefault(require("axios"));
+const cli_color_1 = __importDefault(require("cli-color"));
+const dx_logger_lib_1 = require("@squiz/dx-logger-lib");
+exports.logger = (0, dx_logger_lib_1.getLogger)({ name: 'upload-component', format: 'human' });
+async function uploadComponentFolder(folderPath, componentServiceManagementUrl, componentRenderServiceUrl) {
+    const tmpDir = path_1.default.resolve(await promises_1.default.mkdtemp('cmp-upload'));
+    try {
+        const axiosInstance = axios_1.default.create({
+            baseURL: componentServiceManagementUrl,
+            headers: {
+                'content-type': 'application/json',
+            },
+        });
+        await preUploadChecks(folderPath, componentRenderServiceUrl);
+        exports.logger.info('Initial scanning');
+        const zip = await (0, component_lib_1.zipDirectory)(folderPath, tmpDir);
+        const initialUpload = await handleResponse(axiosInstance.post('upload-component'));
+        exports.logger.info(`deployment id: ${initialUpload.id} status: transferring`);
+        await (0, virus_scanner_lib_1.uploadFile)(initialUpload, zip);
+        await watchAndWaitForUploadAndScanComplete(initialUpload.id, axiosInstance);
+        exports.logger.info(`deployment id: ${initialUpload.id} status: deploying component folder`);
+        const result = await handleResponse(axiosInstance.post(`upload-component/next/${initialUpload.id}`));
+        await promises_1.default.rm(tmpDir, { force: true, recursive: true });
+        if (result.status === 'successful') {
+            exports.logger.info(`deployment id: ${initialUpload.id} status: ${cli_color_1.default.green('success')}`);
+            exports.logger.info(`uploaded location: ${result.accessLink}`);
+        }
+        else {
+            exports.logger.error('failed for an unknown reason', cli_color_1.default.red(result));
+        }
+    }
+    catch (e) {
+        await promises_1.default.rm(tmpDir, { force: true, recursive: true });
+        if (e instanceof Error) {
+            exports.logger.error(cli_color_1.default.red(e.message));
+        }
+        else {
+            throw e;
+        }
+    }
+}
+exports.uploadComponentFolder = uploadComponentFolder;
+async function preUploadChecks(folderPath, renderService) {
+    const result = await (0, component_lib_1.loadManifest)(path_1.default.join(folderPath, `manifest.json`));
+    if (await checkIfVersionExists(result, renderService)) {
+        throw new Error(`Cannot upload component version, ${result.name} ${result.version} already exists`);
+    }
+}
+async function checkIfVersionExists(inputManifest, renderService) {
+    const axiosInstance = axios_1.default.create({
+        baseURL: renderService,
+    });
+    try {
+        const response = await axiosInstance.get(`d/${inputManifest.name}/${inputManifest.version}/manifest.json`);
+        if (response.status === 200) {
+            return true;
+        }
+        throw new Error(`Unexpected response code ${response.status}`);
+    }
+    catch (error) {
+        if (isAxiosError(error)) {
+            const { response } = error;
+            if ((response === null || response === void 0 ? void 0 : response.status) === 404) {
+                return false;
+            }
+        }
+        throw error;
+    }
+}
+async function watchAndWaitForUploadAndScanComplete(id, axiosInstance) {
+    const poll = () => handleResponse(axiosInstance.get('upload-component/status/' + id));
+    return new Promise((resolve, reject) => {
+        const recurse = () => poll().then(async (req) => {
+            if (req.status == 'Success') {
+                resolve();
+            }
+            else if (req.status == 'Flagged') {
+                reject(new Error('upload has been flagged as a virus'));
+            }
+            else if (req.status == 'Error') {
+                reject(new Error('there has been an error'));
+            }
+            else {
+                setTimeout(async () => {
+                    await recurse();
+                }, 1000);
+            }
+        });
+        recurse();
+    });
+}
+async function handleResponse(axiosInstance) {
+    try {
+        const response = await axiosInstance;
+        return response.data;
+    }
+    catch (error) {
+        throw handleError(error);
+    }
+}
+function handleError(error) {
+    const { response } = error;
+    if (!response || !isAxiosError(error)) {
+        return error;
+    }
+    const message = response.data.message;
+    if (message) {
+        return new Error(`Unexpected response code ${response.status}. message: ${message}`);
+    }
+    else {
+        return new Error(`Unexpected response code ${response.status}.`);
+    }
+}
+function isAxiosError(error) {
+    return error && error.isAxiosError === true;
+}
+//# sourceMappingURL=upload-component-folder.js.map

package/lib/upload-component-folder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-component-folder.js","sourceRoot":"","sources":["../src/upload-component-folder.ts"],"names":[],"mappings":";;;;;;AAAA,gEAAkE;AAClE,wDAAkE;AAElE,2DAA8B;AAC9B,gDAAwB;AACxB,kDAAwE;AACxE,0DAA8B;AAC9B,wDAAyD;AAE5C,QAAA,MAAM,GAAW,IAAA,yBAAS,EAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAEhF,KAAK,UAAU,qBAAqB,CACzC,UAAkB,EAClB,6BAAqC,EACrC,yBAAiC;IAEjC,MAAM,MAAM,GAAG,cAAI,CAAC,OAAO,CAAC,MAAM,kBAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IAE7D,IAAI;QACF,MAAM,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YACjC,OAAO,EAAE,6BAA6B;YACtC,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAC;QAEH,MAAM,eAAe,CAAC,UAAU,EAAE,yBAAyB,CAAC,CAAC;QAC7D,cAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChC,MAAM,GAAG,GAAG,MAAM,IAAA,4BAAY,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAEnD,MAAM,aAAa,GAAG,MAAM,cAAc,CAAM,aAAa,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;QAExF,cAAM,CAAC,IAAI,CAAC,kBAAkB,aAAa,CAAC,EAAE,uBAAuB,CAAC,CAAC;QACvE,MAAM,IAAA,8BAAU,EAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QAErC,MAAM,oCAAoC,CAAC,aAAa,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QAE5E,cAAM,CAAC,IAAI,CAAC,kBAAkB,aAAa,CAAC,EAAE,qCAAqC,CAAC,CAAC;QACrF,MAAM,MAAM,GAAG,MAAM,cAAc,CAAM,aAAa,CAAC,IAAI,CAAC,yBAAyB,aAAa,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAE1G,MAAM,kBAAG,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,MAAM,CAAC,MAAM,KAAK,YAAY,EAAE;YAClC,cAAM,CAAC,IAAI,CAAC,kBAAkB,aAAa,CAAC,EAAE,YAAY,mBAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACpF,cAAM,CAAC,IAAI,CAAC,sBAAsB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;SACxD;aAAM;YACL,cAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,mBAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;SACjE;KACF;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,kBAAG,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,YAAY,KAAK,EAAE;YACtB,cAAM,CAAC,KAAK,CAAC,mBAAK,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;SACpC;aAAM;YACL,MAAM,CAAC,CAAC;SACT;KACF;AACH,CAAC;AA9CD,sDA8CC;AAED,KAAK,UAAU,eAAe,CAAC,UAAkB,EAAE,aAAqB;IACtE,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAY,EAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;IAC1E,IAAI,MAAM,oBAAoB,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE;QACrD,MAAM,IAAI,KAAK,CAAC,oCAAoC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;KACrG;AACH,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,aAAiB,EAAE,aAAqB;IAC1E,MAAM,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;QACjC,OAAO,EAAE,aAAa;KACvB,CAAC,CAAC;IAEH,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,KAAK,aAAa,CAAC,IAAI,IAAI,aAAa,CAAC,OAAO,gBAAgB,CAAC,CAAC;QAC3G,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,OAAO,IAAI,CAAC;SACb;QACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;KAChE;IAAC,OAAO,KAAK,EAAE;QACd,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE;YACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,MAAK,GAAG,EAAE;gBAC5B,OAAO,KAAK,CAAC;aACd;SACF;QACD,MAAM,KAAK,CAAC;KACb;AACH,CAAC;AAED,KAAK,UAAU,oCAAoC,CAAC,EAAU,EAAE,aAA4B;IAC1F,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,cAAc,CAAa,aAAa,CAAC,GAAG,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC,CAAC;IAElG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,GAAG,EAAE,CACnB,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACxB,IAAI,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE;gBAC3B,OAAO,EAAE,CAAC;aACX;iBAAM,IAAI,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE;gBAClC,MAAM,CAAC,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC,CAAC;aACzD;iBAAM,IAAI,GAAG,CAAC,MAAM,IAAI,OAAO,EAAE;gBAChC,MAAM,CAAC,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;aAC9C;iBAAM;gBACL,UAAU,CAAC,KAAK,IAAI,EAAE;oBACpB,MAAM,OAAO,EAAE,CAAC;gBAClB,CAAC,EAAE,IAAI,CAAC,CAAC;aACV;QACH,CAAC,CAAC,CAAC;QAEL,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,cAAc,CAAI,aAAwC;IACvE,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC;QACrC,OAAO,QAAQ,CAAC,IAAI,CAAC;KACtB;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,WAAW,CAAC,KAAK,CAAC,CAAC;KAC1B;AACH,CAAC;AAED,SAAS,WAAW,CAAC,KAAU;IAC7B,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAC3B,IAAI,CAAC,QAAQ,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACrC,OAAO,KAAK,CAAC;KACd;IACD,MAAM,OAAO,GAAI,QAAQ,CAAC,IAAY,CAAC,OAAO,CAAC;IAC/C,IAAI,OAAO,EAAE;QACX,OAAO,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,MAAM,cAAc,OAAO,EAAE,CAAC,CAAC;KACtF;SAAM;QACL,OAAO,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;KAClE;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAU;IAC9B,OAAO,KAAK,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAAC;AAC9C,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@squiz/component-cli-lib",
+  "version": "1.2.1-alpha.100",
+  "description": "",
+  "main": "lib/index.js",
+  "scripts": {
+    "start": "node ./lib/index.js",
+    "compile": "tsc",
+    "lint": "eslint ./src --ext .ts",
+    "test": "jest -c jest.config.ts",
+    "test:integration": "jest -c jest.integration.config.ts",
+    "clean": "rimraf \".tsbuildinfo\" \"./lib\""
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/cli-color": "2.0.2",
+    "@types/express": "4.17.13",
+    "@types/jest": "28.1.6",
+    "@types/node": "17.0.27",
+    "@types/supertest": "2.0.12",
+    "dotenv": "16.0.1",
+    "eslint": "8.22.0",
+    "jest": "28.1.3",
+    "ts-jest": "28.0.7",
+    "ts-loader": "9.3.1",
+    "ts-node": "10.9.1",
+    "typescript": "4.7.4"
+  },
+  "dependencies": {
+    "@squiz/component-lib": "^1.2.1-alpha.100",
+    "@squiz/dx-logger-lib": "^1.2.1-alpha.100",
+    "@squiz/render-runtime-lib": "^1.2.1-alpha.100",
+    "@squiz/virus-scanner-lib": "^1.2.1-alpha.100",
+    "archiver": "5.3.1",
+    "axios": "0.27.2",
+    "cli-color": "^2.0.2",
+    "supertest": "^6.2.3"
+  },
+  "gitHead": "909ab48128b72579f5f1390b7f045a3a41958795"
+}

package/src/component-dev.spec.ts

@@ -0,0 +1,111 @@
+import path from 'path';
+import fsp from 'fs/promises';
+
+import { routeTests, TestHelpers } from '@squiz/render-runtime-lib';
+import { startDevelopmentRender } from './component-dev';
+import supertest from 'supertest';
+
+jest.setTimeout(20_000);
+
+describe('component-dev', () => {
+  describe('production style folder structure', () => {
+    let doStopStack: Awaited<ReturnType<typeof startDevelopmentRender>>;
+
+    beforeAll(async () => {
+      doStopStack = await startDevelopmentRender(path.join(__dirname, '../../../test-components'), { port: 0 });
+    });
+
+    afterAll(async () => {
+      await doStopStack();
+    });
+
+    it('should find the component', async () => {
+      const testServer = TestHelpers.getTestServer();
+      const response = await testServer.get(`/r/set/test-component/1.0.0?something=hello`);
+      expect(response.text).toEqual('<h1>hello</h1>');
+    });
+  });
+
+  describe('local developer style folders', () => {
+    let doStopStack: Awaited<ReturnType<typeof startDevelopmentRender>>;
+    let version: string;
+    let componentName: string;
+    let fixtureDirectory: string;
+
+    beforeAll(async () => {
+      const {
+        fixtureDirectory: ceratedFixtureDirectory,
+        version: createdVersion,
+        componentName: createdName,
+      } = await TestHelpers.ComponentFixture.setupFullComponentDirectory('<h1>Hello World</h1>');
+
+      version = createdVersion;
+      fixtureDirectory = ceratedFixtureDirectory;
+      componentName = createdName;
+
+      doStopStack = await startDevelopmentRender(fixtureDirectory, { port: 0 });
+    });
+
+    afterAll(async () => {
+      await doStopStack();
+      await fsp.rm(path.join(fixtureDirectory, componentName), { force: true, recursive: true });
+    });
+
+    it('should handle recursing folders to find the component', async () => {
+      const testServer = TestHelpers.getTestServer();
+      const response = await testServer.get(`/r/set/${componentName}/${version}/`);
+      expect(response.text).toEqual('<h1>Hello World</h1>');
+    });
+
+    it('should handle serving static files from single component directory', async () => {
+      const testServer = TestHelpers.getTestServer();
+      const response = await testServer.get(`/s/${componentName}/${version}/static.txt`);
+      expect(response.text).toEqual('hello');
+    });
+  });
+
+  describe('accessing local dev routes', () => {
+    let stopServer: Awaited<ReturnType<typeof startDevelopmentRender>>;
+    const port = 3006;
+    const url = `http://localhost:${port}`;
+    const request = supertest(url);
+
+    beforeAll(async () => {
+      const compDir = path.join(__dirname, '../', '../../test-components');
+
+      stopServer = await startDevelopmentRender(compDir, {
+        port: port,
+      });
+    });
+
+    afterAll(async () => {
+      await stopServer();
+    });
+
+    describe('definition routes', () => {
+      routeTests.definition(url, url);
+    });
+
+    describe('static routes', () => {
+      routeTests.static(url);
+    });
+
+    describe('render routes', () => {
+      routeTests.render(url, url);
+    });
+
+    describe('GET /r/set/test-component/1.0.1', () => {
+      //
+      // this scenario is different to the 'production' tests
+      // this is should 500 in prod and 404 locally
+      it('should fail validation if trying to render a component with an invalid schema', async () => {
+        const response = await request.get('/r/set/test-component/1.0.1?something=not-used');
+
+        expect(response.statusCode).toEqual(404);
+        expect(response.body).toEqual({
+          message: 'manifest could not be found',
+        });
+      });
+    });
+  });
+});

package/src/component-dev.ts

@@ -0,0 +1,34 @@
+import { startRenderStack, stopRenderStack } from '@squiz/render-runtime-lib';
+import { getLogger } from '@squiz/dx-logger-lib';
+import path from 'path';
+
+/**
+ * startDevelopmentRender starts a dev-mode render stack for any
+ * local directory. This should start an express server on a random unused port
+ * which can be accessed for viewing the component in development.
+ *
+ * @param {string} componentPath - The directory with the component to be rendered
+ * @param {object} options - Additional configuration for the dev stack
+ * @returns a function to stop the render stack
+ */
+export async function startDevelopmentRender(componentPath: string, options: { port: number; previewFile?: string }) {
+  const logger = getLogger({ name: 'component-dev', format: 'human' });
+  await startRenderStack({
+    logger: logger,
+    webserver: {
+      port: options.port,
+      rootUrl: `http://localhost:${options.port}`,
+      shouldRunMigrations: false,
+    },
+    componentRunner: {
+      // Considering the component path will be passed in from CLI
+      // We need to generate the path from the calling directory
+      dataMountPoint: path.resolve(process.cwd(), componentPath),
+      localDevMode: true,
+      previewFile: options.previewFile,
+      workerTimeout: 20_000,
+    },
+  });
+
+  return () => stopRenderStack();
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { uploadComponentFolder } from './upload-component-folder';
+export { startDevelopmentRender } from './component-dev';

package/src/integration-tests/__components__/big-package/manifest.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://localhost:3000/schemas/v1.json#",
+
+  "name": "big-package",
+  "version": "1.0.2",
+  "main-function": "render-json",
+  "functions": [
+    {
+      "name": "render-json",
+      "entry": "render-json.js",
+      "input": {
+        "type": "object",
+        "properties": {
+          "something": {
+            "type": "string"
+          }
+        },
+        "required": ["something"]
+      },
+      "output": {
+        "response-type": "json",
+        "definition": {
+          "properties": {
+            "my-prop": {
+              "type": "string"
+            }
+          },
+          "required": ["my-prop"]
+        }
+      }
+    }
+  ]
+}

package/src/integration-tests/__components__/big-package/render-json.js

@@ -0,0 +1,5 @@
+module.exports = async function () {
+  return {
+    'my-prop': 'test value for my-prop',
+  };
+};

package/src/integration-tests/__components__/cmp-static-file-test/main.js

@@ -0,0 +1,10 @@
+/**
+ * @param {object} input
+ * @param {ComponentInfo} info
+ */
+module.exports = async function (input, info) {
+  return (
+    `<div>Input: ${input.something}</div>` +
+    `<div>${info.ctx.componentName} ${info.ctx.version} ${info.ctx.getStaticResourceUrl('birthday-cake.png')}</div>`
+  );
+};

package/src/integration-tests/__components__/cmp-static-file-test/manifest.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "http://localhost:3000/schemas/v1.json#",
+
+  "name": "cmp-static-file-test",
+  "version": "1.0.0",
+  "main-function": "main",
+
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "input": {
+        "type": "object",
+        "properties": {
+          "something": {
+            "type": "string"
+          }
+        },
+        "required": ["something"]
+      },
+      "output": {
+        "response-type": "html",
+
+        "static-files": [
+          {
+            "location": "header",
+            "file": {
+              "filepath": "static-library-file.js",
+              "type": "js"
+            }
+          }
+        ]
+      }
+    }
+  ],
+
+  "static-files": {
+    "location-root": "public"
+  }
+}

package/src/integration-tests/__components__/cmp-static-file-test/public/static-library-file.js

@@ -0,0 +1 @@
+const name = 'foo';

package/src/integration-tests/__components__/invalid-manifest/main.js

@@ -0,0 +1,7 @@
+/**
+ * @param {object} input
+ * @param {ComponentInfo} info
+ */
+module.exports = async function (input, info) {
+  return '<div>test</div>';
+};

package/src/integration-tests/__components__/invalid-manifest/manifest.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://localhost:3000/schemas/v1.json#",
+
+  "name": "invalid-manifes@t",
+  "version": "1.0.0",
+  "main-function": "main",
+
+  "functions": [
+    {
+      "entry": "main.js",
+      "name": "main",
+      "input": {
+        "type": "object",
+        "properties": {
+          "something": {
+            "type": "string"
+          }
+        },
+        "required": ["something"]
+      },
+      "output": {
+        "response-type": "html"
+      }
+    }
+  ]
+}

package/src/integration-tests/__components__/invalid-upload/main.js

@@ -0,0 +1,7 @@
+/**
+ * @param {object} input
+ * @param {ComponentInfo} info
+ */
+module.exports = async function (input, info) {
+  return '<div>test</div>';
+};

package/src/integration-tests/helper.ts

@@ -0,0 +1,74 @@
+import axios from 'axios';
+import fs from 'fs';
+import path from 'path';
+
+import fsp from 'fs/promises';
+import { randomBytes } from 'crypto';
+import { ComponentSet, parseEnvVarForVar } from '@squiz/component-lib';
+import { config } from 'dotenv';
+
+config();
+
+interface Config {
+  managementServiceUrl: string;
+  renderServiceUrl: string;
+  ci_buildVersion: string;
+  ci_buildBranch: string;
+}
+
+const configObj: Config = {
+  managementServiceUrl: parseEnvVarForVar('COMPONENT_MANAGEMENT_SERVICE_URL').replace(/\/+$/, ''),
+  renderServiceUrl: parseEnvVarForVar('COMPONENT_RENDER_SERVICE_URL').replace(/\/+$/, ''),
+  ci_buildVersion: parseEnvVarForVar('CI_COMMIT_SHORT_SHA'),
+  ci_buildBranch: parseEnvVarForVar('CI_COMMIT_REF_NAME'),
+};
+
+export default configObj;
+
+export const managementService = axios.create({
+  baseURL: configObj.managementServiceUrl,
+});
+
+export const renderService = axios.create({
+  baseURL: configObj.renderServiceUrl,
+});
+
+export const ci_buildVersion = configObj.ci_buildVersion;
+export const ci_buildBranch = configObj.ci_buildBranch;
+
+export function getTestComponents(): string[] {
+  const componets = [];
+  const componentsDir = path.join(__dirname, '/__components__/');
+  const files = fs.readdirSync(componentsDir);
+  for (const file of files) {
+    const stat = fs.statSync(path.join(componentsDir, file));
+    if (stat.isDirectory() && file.substring(0, 4) === 'cmp-') {
+      componets.push(file);
+    }
+  }
+  return componets;
+}
+export async function createFile(filePath: string, sizeInMB: number) {
+  const content = randomBytes(sizeInMB * 1000000);
+  await fsp.writeFile(`${filePath}`, content);
+}
+
+export function removeFile(filePath: string) {
+  fsp.unlink(filePath);
+}
+
+export async function deleteComponentSet(webPath: string) {
+  try {
+    await managementService.delete(`/component-set/${webPath}`);
+  } catch (error) {
+    // no ops
+  }
+}
+
+export async function addComponentSet(componentSet: ComponentSet) {
+  try {
+    await managementService.post(`/component-set`, componentSet);
+  } catch (error) {
+    //no ops
+  }
+}

package/src/integration-tests/service-deployment.spec.ts

@@ -0,0 +1,21 @@
+import { renderService, managementService, ci_buildVersion, ci_buildBranch } from './helper';
+
+interface HealthInfo {
+  status: string;
+  buildVersion: string;
+  buildBranch: string;
+}
+
+describe('Verify latest services deployments', () => {
+  it('Should have latest Management API service', async () => {
+    const response: HealthInfo = (await managementService.get('/health')).data;
+    expect(response.buildVersion).toBe(ci_buildVersion);
+    expect(response.buildBranch).toBe(ci_buildBranch);
+  });
+
+  it('Should have latest Render Runtime service', async () => {
+    const response: HealthInfo = (await renderService.get('/health')).data;
+    expect(response.buildVersion).toBe(ci_buildVersion);
+    expect(response.buildBranch).toBe(ci_buildBranch);
+  });
+});

package/src/integration-tests/test-setup.ts

@@ -0,0 +1 @@
+jest.setTimeout(60_000);