src/config.test.ts

import os from "os";
import path from "path";
import fs from "fs";
import shell from "shelljs";
import uuid from "uuid/v4";
import {
  Bedrock,
  Config,
  defaultConfigFile,
  loadConfiguration,
  saveConfiguration,
  updateVariableWithLocalEnv,
} from "./config";
import { createTempDir } from "./lib/ioUtil";
import { disableVerboseLogging, enableVerboseLogging } from "./logger";
import { BedrockFile } from "./types";
import { getErrorMessage } from "./lib/errorBuilder";
import { getVersionMessage } from "./lib/fileutils";
import * as bedrockYaml from "./lib/bedrockYaml";

beforeAll(() => {
  enableVerboseLogging();
});

afterAll(() => {
  disableVerboseLogging();
});

describe("Test updateVariableWithLocalEnv function", () => {
  beforeAll(() => {
    process.env.hello = "world";
    process.env.hello1 = "world1";
  });
  afterAll(() => {
    delete process.env.hello;
    delete process.env.hello1;
  });
  it("positive test", () => {
    expect(
      updateVariableWithLocalEnv("${env:hello} - ${env:hello} : ${env:hello1}")
    ).toBe("world - world : world1");
  });
  it("negative test", () => {
    expect(() => {
      updateVariableWithLocalEnv(
        "${env:hello2} - ${env:hello} : ${env:hello1}"
      );
    }).toThrow(
      getErrorMessage({
        errorKey: "spk-config-yaml-var-undefined",
        values: ["hello2"],
      })
    );
  });
});

describe("Bedrock", () => {
  const writeSpy = jest.spyOn(fs, "writeFileSync");
  test("valid helm configuration passes", () => {
    const randomTmpDir = path.join(os.tmpdir(), uuid());
    shell.mkdir("-p", randomTmpDir);
    const validBedrockYaml: BedrockFile = {
      rings: {},
      services: [
        {
          path: "foo/a",
          helm: {
            chart: {
              chart: "elastic",
              repository: "some-repo",
            },
          },
          k8sBackend: "backendservice",
          k8sBackendPort: 1337,
          pathPrefix: "servicepath",
          pathPrefixMajorVersion: "v1",
        },
        {
          path: "foo/b",
          helm: {
            chart: {
              git: "foo",
              path: "some/path",
              sha: "cef8361c62e7a91887625336eb13a8f90dbcf8df",
            },
          },
          k8sBackend: "backendservice",
          k8sBackendPort: 1337,
          pathPrefix: "servicepath",
          pathPrefixMajorVersion: "v1",
        },
      ],
      version: "1.0",
    };

    bedrockYaml.create(randomTmpDir, validBedrockYaml);
    const expectedFilePath = path.join(randomTmpDir, "bedrock.yaml");
    expect(writeSpy).toBeCalledWith(
      expectedFilePath,
      `${getVersionMessage()}\n`,
      "utf8"
    );

    const bedrockConfig = Bedrock(randomTmpDir);
    expect(bedrockConfig).toBeTruthy();
  });

  test("invalid helm configuration fails", () => {
    const randomTmpDir = path.join(os.tmpdir(), uuid());
    shell.mkdir("-p", randomTmpDir);
    const validBedrockYaml: BedrockFile = {
      rings: {},
      services: {
        "foo/a": {
          helm: {
            // Missing 'chart'
            chart: {
              repository: "some-repo",
            },
          },
        },
        "foo/b": {
          helm: {
            // missing 'path'
            chart: {
              git: "foo",
              sha: "cef8361c62e7a91887625336eb13a8f90dbcf8df",
            },
          },
        },
      },
      version: "1.0",
      // eslint-disable-next-line @typescript-eslint/no-explicit-any
    } as any;
    bedrockYaml.create(randomTmpDir, validBedrockYaml);
    const expectedFilePath = path.join(randomTmpDir, "bedrock.yaml");
    expect(writeSpy).toBeCalledWith(
      expectedFilePath,
      `${getVersionMessage()}\n`,
      "utf8"
    );

    expect(() => {
      Bedrock(randomTmpDir);
    }).toThrow();
  });
});

const mockFileName = "src/commands/mocks/spk-config.yaml";

describe("Initializing a project to use spk with a config file", () => {
  test("init command basic file test", async () => {
    // Create random directory to initialize
    const randomTmpDir = createTempDir();
    process.env["test_name"] = "my_storage_account";
    process.env["test_key"] = "my_storage_key";
    const filename = path.resolve(mockFileName);
    saveConfiguration(filename, randomTmpDir);
    loadConfiguration(path.join(randomTmpDir, "config.yaml"));

    const config = Config();
    expect(config.introspection).toBeDefined();
    expect(config.introspection?.azure?.account_name).toBe(
      process.env.test_name
    );
    const key = await config.introspection?.azure?.key;
    expect(key).toBe(process.env.test_key);
    expect(config.introspection?.azure?.table_name).toBe(
      process.env.test_name + "+" + process.env.test_key
    );
  });
});

describe("Initializing a project a config file but no env vars", () => {
  test("init command basic file without env vars", () => {
    const filename = path.resolve(mockFileName);
    process.env["test_name"] = "";
    process.env["test_key"] = "";
    expect(() => {
      loadConfiguration(filename);
    }).toThrow();
  });
});

describe("Initializing a project with a non-existent file", () => {
  test("Non-existent file test", () => {
    const filename = path.resolve("./spk-config-test.yaml");
    expect(() => {
      loadConfiguration(filename);
    }).toThrow(getErrorMessage("spk-config-yaml-load-err"));
  });
});

describe("Writing to default config location", () => {
  test("Default config location exists", () => {
    const filename = path.resolve(mockFileName);
    process.env["test_name"] = "testStorageName";
    process.env["test_key"] = "testStorageKey";
    loadConfiguration(filename);

    saveConfiguration(filename);
    loadConfiguration(defaultConfigFile());
    expect(Config().azure_devops).toBeDefined();
  });
});