yarn/__tests__/normalize-manifest.js

/* @flow */
/* eslint max-len: 0 */

import normalizeManifest from '../src/util/normalize-manifest/index.js';
import {BufferReporter} from '../src/reporters/index.js';
import Config from '../src/config.js';
import map from '../src/util/map.js';
import * as util from '../src/util/normalize-manifest/util.js';
import * as fs from '../src/util/fs.js';

const nativeFs = require('fs');
const path = require('path');

jasmine.DEFAULT_TIMEOUT_INTERVAL = 60000;

const fixturesLoc = path.join(__dirname, 'fixtures', 'normalize-manifest');

async function _compareManifests(name, loc, {globalFolder} = {}): Promise<void> {
  const reporter = new BufferReporter();
  const config = await Config.create({cwd: loc, globalFolder}, reporter);

  let actual = await fs.readJson(path.join(loc, 'actual.json'));
  const expected = await fs.readJson(path.join(loc, 'expected.json'));

  let isRoot = actual._root;
  if (isRoot == null) {
    isRoot = true;
  } else {
    delete actual._root;
  }

  const error = expected._error;
  if (error) {
    delete expected._error;
  }

  try {
    actual = await normalizeManifest(actual, loc, config, isRoot);
  } catch (err) {
    if (error && err.message === error) {
      return;
    } else {
      throw err;
    }
  }

  if (error) {
    throw new Error(`Expected to throw error: ${error}`);
  }

  expect(map(actual)).toEqual(expand(expected));
  expect(
    reporter.getBuffer().filter(d => d.type === 'warning').map(d => String(d.data).replace(/\\/g, '/')),
  ).toMatchSnapshot(name);
}

for (const name of nativeFs.readdirSync(fixturesLoc)) {
  if (name[0] === '.') {
    continue;
  }

  const loc = path.join(fixturesLoc, name);

  test(name, () => _compareManifests(name, loc));
}

const globalFolder = path.join(__dirname, 'fixtures', 'normalize-manifest', 'name');

test('license warnings should not be thrown with global commands', () =>
  _compareManifests('license warnings should not be thrown with global commands', globalFolder, {globalFolder}));

test('util.stringifyPerson', () => {
  expect(util.stringifyPerson({name: 'Sebastian McKenzie'})).toEqual('Sebastian McKenzie');
  expect(
    util.stringifyPerson({
      name: 'Sebastian McKenzie',
      email: 'sebmck@gmail.com',
    }),
  ).toEqual('Sebastian McKenzie <sebmck@gmail.com>');
  expect(util.stringifyPerson({email: 'sebmck@gmail.com'})).toEqual('<sebmck@gmail.com>');
  expect(
    util.stringifyPerson({
      name: 'Sebastian McKenzie',
      email: 'sebmck@gmail.com',
      url: 'https://sebmck.com',
    }),
  ).toEqual('Sebastian McKenzie <sebmck@gmail.com> (https://sebmck.com)');
});

test('util.parsePerson', () => {
  expect(util.parsePerson({})).toEqual({});
  expect(util.parsePerson('Sebastian McKenzie')).toEqual({
    name: 'Sebastian McKenzie',
  });
  expect(util.parsePerson(' <sebmck@gmail.com>')).toEqual({
    email: 'sebmck@gmail.com',
  });
  expect(util.parsePerson('Sebastian McKenzie <sebmck@gmail.com>')).toEqual({
    name: 'Sebastian McKenzie',
    email: 'sebmck@gmail.com',
  });
  expect(util.parsePerson('Sebastian McKenzie <sebmck@gmail.com> (https://sebmck.com)')).toEqual({
    name: 'Sebastian McKenzie',
    email: 'sebmck@gmail.com',
    url: 'https://sebmck.com',
  });
});

test('util.extractDescription', () => {
  expect(util.extractDescription('# header\n\ndescription here')).toEqual('description here');
  expect(util.extractDescription('# header\ndescription here')).toEqual('description here');
  expect(util.extractDescription('# header\ndescription here\nfoobar')).toEqual('description here foobar');
  expect(util.extractDescription('# header\ndescription here\n\nfoobar')).toEqual('description here');
  expect(util.extractDescription('')).toEqual(undefined);
  expect(util.extractDescription(null)).toEqual(undefined);
  expect(util.extractDescription(undefined)).toEqual(undefined);
});

test('util.extractRepositoryUrl', () => {
  expect(util.extractRepositoryUrl('https://github.com/yarnpkg/yarn.git')).toEqual(
    'https://github.com/yarnpkg/yarn.git',
  );
  expect(
    util.extractRepositoryUrl({
      type: 'git',
      url: 'https://github.com/yarnpkg/yarn.git',
    }),
  ).toEqual('https://github.com/yarnpkg/yarn.git');
});

// fill out expected and normalize paths
function expand<T: Object>(expected: T): T {
  if (expected.man && Array.isArray(expected.man)) {
    expected = {...expected, man: normalizePaths(expected.man)};
  }

  if (expected.bin && typeof expected.bin === 'object') {
    expected = {...expected, bin: normalizePathDict(expected.bin)};
  }

  return expected;
}

function normalize(input: string): string {
  return path.normalize(input);
}

function normalizePath<T>(path: T): ?string {
  if (typeof path === 'string') {
    return normalize(path);
  } else {
    return null;
  }
}

function normalizePaths(paths: mixed): ?(string[]) {
  if (Array.isArray(paths)) {
    return paths.map(p => {
      if (typeof p !== 'string') {
        throw new Error(`Expected string in paths, got ${JSON.stringify(paths)}`);
      }
      return normalize(p);
    });
  } else {
    return null;
  }
}

function normalizePathDict(paths: mixed): ?{[key: string]: mixed} {
  const out = {};

  if (!paths || typeof paths !== 'object') {
    return null;
  }

  for (const prop in paths) {
    if (typeof paths[prop] === 'string') {
      out[prop] = normalizePath(paths[prop]);
    } else {
      out[prop] = paths[prop];
    }
  }

  return out;
}