test(firestore-translate-text): Implement tests for firestore-translate-text (#67)

Author: laurenzlong

.prettierignore

@@ -9,6 +9,7 @@ README.md
 **/functions/lib/**
 **/lib/**
 **/dist/**
+coverage
 
 # extension install md files
 #   - excluded as prettier escapes variables e.g. `${PROJECT_ID}` becomes `\${PROJECT_ID}`

.travis.yml

@@ -1,5 +1,9 @@
 language: node_js
 
+install:
+  - npm install -g codecov
+  - npm install
+
 node_js:
   - 8
   - 10
@@ -11,11 +15,10 @@ stages:
 
 jobs:
   include:
-    - stage: validate
-      name: "TypeScript Compile"
-      script: npm run clean && npm run build
     - stage: validate
       name: "Prettier Format Check"
       script: npm run lint
-    - stage: test
-      script: npm run test-coverage
+
+script:
+  - npm run test-coverage
+  - codecov

codecov.yml

@@ -0,0 +1,15 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "40...100"
+
+  status:
+    project:
+      default: true
+
+comment:
+  layout: "reach, diff, files"
+  behavior: once

firestore-translate-text/__tests__/__snapshots__/config.test.ts.snap

@@ -0,0 +1,29 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`extension config config loaded from environment variables 1`] = `
+Object {
+  "inputFieldName": "input",
+  "languages": Array [
+    "en",
+    "es",
+    "de",
+    "fr",
+  ],
+  "location": "us-central1",
+  "outputFieldName": "translated",
+}
+`;
+
+exports[`extension config config.LANGUAGES param exists 1`] = `
+Object {
+  "default": "en,es,de,fr",
+  "description": "Into which target languages do you want to translate new strings? The languages are identified using ISO-639-1 codes in a comma-separated list, for example: en,es,de,fr. For these codes, visit the [supported languages list](https://cloud.google.com/translate/docs/languages).
+",
+  "example": "en,es,de,fr",
+  "label": "Target languages for translations, as a comma-separated list",
+  "param": "LANGUAGES",
+  "required": true,
+  "validationErrorMessage": "Languages must be a comma-separated list of ISO-639-1 language codes.",
+  "validationRegex": "^[a-zA-Z,-]*[a-zA-Z-]{2,}$",
+}
+`;

firestore-translate-text/__tests__/config.test.ts

@@ -0,0 +1,101 @@
+import { readFileSync } from "fs";
+import { resolve as pathResolve } from "path";
+import * as functionsTestInit from "firebase-functions-test";
+
+import * as yaml from "js-yaml";
+import mockedEnv from "mocked-env";
+
+import { messages } from "../functions/src/logs/messages";
+
+let restoreEnv;
+let extensionYaml;
+let extensionParams;
+
+const environment = {
+  LOCATION: "us-central1",
+  LANGUAGES: "en,es,de,fr,en", // double en to test no duplicates
+  COLLECTION_PATH: "translations",
+  INPUT_FIELD_NAME: "input",
+  OUTPUT_FIELD_NAME: "translated",
+};
+
+const { mockConsoleLog, config } = global;
+
+functionsTestInit();
+
+describe("extension config", () => {
+  beforeAll(() => {
+    extensionYaml = yaml.safeLoad(
+      readFileSync(pathResolve(__dirname, "../extension.yaml"), "utf8")
+    );
+
+    extensionParams = extensionYaml.params.reduce((obj, param) => {
+      obj[param.param] = param;
+      return obj;
+    }, {});
+  });
+
+  beforeEach(() => {
+    restoreEnv = mockedEnv(environment);
+    mockConsoleLog.mockClear();
+  });
+
+  afterEach(() => restoreEnv());
+
+  test("config loaded from environment variables", () => {
+    const functionsConfig = config();
+
+    expect(functionsConfig).toMatchSnapshot({});
+  });
+
+  test("config is logged on initialize", () => {
+    jest.requireActual("../functions/src");
+
+    const functionsConfig = config();
+
+    expect(mockConsoleLog).toBeCalledWith(...messages.init(functionsConfig));
+  });
+
+  // LANGUAGES
+  describe("config.LANGUAGES", () => {
+    test("param exists", () => {
+      const extensionParam = extensionParams["LANGUAGES"];
+      expect(extensionParam).toMatchSnapshot();
+    });
+
+    test("removes any duplicated languages from user input", () => {
+      const functionsConfig = require("../functions/src/config").default;
+      expect(functionsConfig.languages).toEqual(["en", "es", "de", "fr"]);
+    });
+
+    describe("validationRegex", () => {
+      test("does not allow empty strings", () => {
+        const { validationRegex } = extensionParams["LANGUAGES"];
+        expect(Boolean("".match(new RegExp(validationRegex)))).toBeFalsy();
+      });
+
+      test("does not allow trailing delimiter", () => {
+        const { validationRegex } = extensionParams["LANGUAGES"];
+        expect(Boolean("en,".match(new RegExp(validationRegex)))).toBeFalsy();
+      });
+
+      // https://github.com/firebase/extensions/issues/43
+      test("allows a single language", () => {
+        const { validationRegex } = extensionParams["LANGUAGES"];
+        expect(Boolean("en".match(new RegExp(validationRegex)))).toBeTruthy();
+      });
+
+      test("allows multiple languages", () => {
+        const { validationRegex } = extensionParams["LANGUAGES"];
+
+        expect(
+          Boolean("en,fr".match(new RegExp(validationRegex)))
+        ).toBeTruthy();
+
+        expect(
+          Boolean("en,fr,de,es".match(new RegExp(validationRegex)))
+        ).toBeTruthy();
+      });
+    });
+  });
+});