verdaccio/test/unit/modules/config/config.spec.ts

import _ from 'lodash';
import path from 'path';

import { parseConfigFile } from '@verdaccio/config';

import Config from '../../../../src/lib/config';
import { DEFAULT_REGISTRY, DEFAULT_UPLINK, ROLES, WEB_TITLE } from '../../../../src/lib/constants';
import { setup } from '../../../../src/lib/logger';

setup([]);

const resolveConf = (conf, location = `../../../../conf/${conf}.yaml`) => {
  return path.join(__dirname, location);
};

const checkDefaultUplink = (config) => {
  expect(_.isObject(config.uplinks[DEFAULT_UPLINK])).toBeTruthy();
  expect(config.uplinks[DEFAULT_UPLINK].url).toMatch(DEFAULT_REGISTRY);
};

const checkDefaultConfPackages = (config) => {
  // auth
  expect(_.isObject(config.auth)).toBeTruthy();
  expect(_.isObject(config.auth.htpasswd)).toBeTruthy();
  expect(config.auth.htpasswd.file).toMatch(/htpasswd/);

  // web
  expect(_.isObject(config.web)).toBeTruthy();
  expect(config.web.title).toBe(WEB_TITLE);
  expect(config.web.enable).toBeUndefined();

  // packages
  expect(_.isObject(config.packages)).toBeTruthy();
  expect(Object.keys(config.packages).join('|')).toBe('@*/*|**');
  expect(config.packages['@*/*'].access).toBeDefined();
  expect(config.packages['@*/*'].access).toContainEqual(ROLES.$ALL);
  expect(config.packages['@*/*'].publish).toBeDefined();
  expect(config.packages['@*/*'].publish).toContainEqual(ROLES.$AUTH);
  expect(config.packages['@*/*'].proxy).toBeDefined();
  expect(config.packages['@*/*'].proxy).toContainEqual(DEFAULT_UPLINK);
  expect(config.packages['**'].access).toBeDefined();
  expect(config.packages['**'].access).toContainEqual(ROLES.$ALL);
  expect(config.packages['**'].publish).toBeDefined();
  expect(config.packages['**'].publish).toContainEqual(ROLES.$AUTH);
  expect(config.packages['**'].proxy).toBeDefined();
  expect(config.packages['**'].proxy).toContainEqual(DEFAULT_UPLINK);
  // uplinks
  expect(config.uplinks[DEFAULT_UPLINK]).toBeDefined();
  expect(config.uplinks[DEFAULT_UPLINK].url).toEqual(DEFAULT_REGISTRY);
  // audit
  expect(config.middlewares).toBeDefined();
  expect(config.middlewares.audit).toBeDefined();
  expect(config.middlewares.audit.enabled).toBeTruthy();
  // log
  expect(config.log.type).toEqual('stdout');
  expect(config.log.format).toEqual('pretty');
  expect(config.log.level).toEqual('http');
  // must not be enabled by default
  expect(config.notify).toBeUndefined();
  expect(config.store).toBeUndefined();
  expect(config.publish).toBeUndefined();
  expect(config.url_prefix).toBeUndefined();
  expect(config.url_prefix).toBeUndefined();
  expect(config.security).toEqual({
    api: { legacy: true, migrateToSecureLegacySignature: true },
    web: { sign: { expiresIn: '1h' }, verify: {} },
  });
};

describe('Config file', () => {
  beforeAll(function () {
    /* eslint no-invalid-this: 0 */
    // @ts-ignore
    this.config = new Config(parseConfigFile(resolveConf('default')));
  });

  describe('default configurations', () => {
    test('parse docker.yaml', () => {
      const config = new Config(parseConfigFile(resolveConf('docker')));
      checkDefaultUplink(config);
      expect(config.storage).toBe('/verdaccio/storage/data');
      // @ts-ignore
      expect(config.auth.htpasswd.file).toBe('/verdaccio/storage/htpasswd');
      checkDefaultConfPackages(config);
      // @ts-expect-error
      expect(config.experiments).toBeUndefined();
    });

    test('parse default.yaml', () => {
      const config = new Config(parseConfigFile(resolveConf('default')));
      checkDefaultUplink(config);
      expect(config.storage).toBe('./storage');
      // @ts-ignore
      expect(config.auth.htpasswd.file).toBe('./htpasswd');
      checkDefaultConfPackages(config);
      // @ts-expect-error
      expect(config.experiments).toBeUndefined();
    });
  });

  describe('env variables', () => {
    test('with process.env.VERDACCIO_STORAGE_PATH', () => {
      const testPath = '/builds/project/foo/bar/baz';
      // @ts-ignore
      process.env.VERDACCIO_STORAGE_PATH = testPath;
      try {
        const config = new Config(parseConfigFile(resolveConf('default')));
        expect(config.storage).toBe(testPath);
      } finally {
        // @ts-ignore
        delete process.env.VERDACCIO_STORAGE_PATH;
      }
    });
  });

  describe('with additional configurations', () => {
    test('parse experiments.yaml', () => {
      const config = new Config(
        parseConfigFile(path.join(__dirname, './partials/experiments.yaml'))
      );
      checkDefaultUplink(config);
      checkDefaultConfPackages(config);
      // @ts-expect-error
      expect(config.experiments).toEqual({
        bytesin_off: false,
        tarball_url_redirect: 'https://mycdn.com/verdaccio/${packageName}/${filename}',
        token: false,
      });
    });
    test('backward compability with logs', () => {
      const config = new Config(parseConfigFile(path.join(__dirname, './partials/logs.yaml')));
      // @ts-expect-error
      expect(config.logs).toEqual({ format: 'pretty', level: 'http', type: 'stdout' });
    });
  });
});