set-npmrc-auth.test.js

import path from 'path';
import test from 'ava';
import {readFile, appendFile} from 'fs-extra';
import {stub} from 'sinon';
import tempy from 'tempy';
import clearModule from 'clear-module';

const {HOME} = process.env;
const cwd = process.cwd();

test.beforeEach(t => {
  // Stub the logger
  t.context.log = stub();
  t.context.logger = {log: t.context.log};

  clearModule('rc');
  clearModule('../lib/set-npmrc-auth');
});

test.afterEach.always(() => {
  process.env.HOME = HOME;
  process.chdir(cwd);
});

test.serial('Set auth with "NPM_TOKEN"', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_TOKEN: 'npm_token'};

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger});

  t.regex((await readFile(npmrc)).toString(), /\/\/custom.registry.com\/:_authToken = \$\{NPM_TOKEN\}/);
  t.deepEqual(t.context.log.args[1], [`Wrote NPM_TOKEN to ${npmrc}`]);
});

test.serial('Set auth with "NPM_USERNAME", "NPM_PASSWORD" and "NPM_EMAIL"', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_USERNAME: 'npm_username', NPM_PASSWORD: 'npm_pasword', NPM_EMAIL: 'npm_email'};

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger});

  t.is((await readFile(npmrc)).toString(), `_auth = \${LEGACY_TOKEN}\nemail = \${NPM_EMAIL}`);
  t.deepEqual(t.context.log.args[1], [`Wrote NPM_USERNAME, NPM_PASSWORD and NPM_EMAIL to ${npmrc}`]);
});

test.serial('Preserve home ".npmrc"', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_TOKEN: 'npm_token'};

  await appendFile(path.resolve(process.env.HOME, '.npmrc'), 'home_config = test');

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger});

  t.is((await readFile(npmrc)).toString(), `home_config = test\n//custom.registry.com/:_authToken = \${NPM_TOKEN}`);
  t.deepEqual(t.context.log.args[1], [
    'Reading npm config from %s',
    [path.resolve(process.env.HOME, '.npmrc')].join(', '),
  ]);
  t.deepEqual(t.context.log.args[2], [`Wrote NPM_TOKEN to ${npmrc}`]);
});

test.serial('Preserve home and local ".npmrc"', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_TOKEN: 'npm_token'};

  await appendFile(path.resolve(cwd, '.npmrc'), 'cwd_config = test');
  await appendFile(path.resolve(process.env.HOME, '.npmrc'), 'home_config = test');

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger});

  t.is(
    (await readFile(npmrc)).toString(),
    `home_config = test\ncwd_config = test\n//custom.registry.com/:_authToken = \${NPM_TOKEN}`
  );
  t.deepEqual(t.context.log.args[1], [
    'Reading npm config from %s',
    [path.resolve(process.env.HOME, '.npmrc'), path.resolve(cwd, '.npmrc')].join(', '),
  ]);
  t.deepEqual(t.context.log.args[2], [`Wrote NPM_TOKEN to ${npmrc}`]);
});

test.serial('Preserve all ".npmrc" if auth is already configured', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});

  await appendFile(path.resolve(cwd, '.npmrc'), `//custom.registry.com/:_authToken = \${NPM_TOKEN}`);
  await appendFile(path.resolve(process.env.HOME, '.npmrc'), 'home_config = test');

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env: {}, logger: t.context.logger});

  t.is((await readFile(npmrc)).toString(), `home_config = test\n//custom.registry.com/:_authToken = \${NPM_TOKEN}`);
  t.deepEqual(t.context.log.args[1], [
    'Reading npm config from %s',
    [path.resolve(process.env.HOME, '.npmrc'), path.resolve(cwd, '.npmrc')].join(', '),
  ]);
});

test.serial('Preserve ".npmrc" if auth is already configured for a scoped package', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});

  await appendFile(
    path.resolve(cwd, '.npmrc'),
    `@scope:registry=http://custom.registry.com\n//custom.registry.com/:_authToken = \${NPM_TOKEN}`
  );
  await appendFile(path.resolve(process.env.HOME, '.npmrc'), 'home_config = test');

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env: {}, logger: t.context.logger});

  t.is(
    (await readFile(npmrc)).toString(),
    `home_config = test\n@scope:registry=http://custom.registry.com\n//custom.registry.com/:_authToken = \${NPM_TOKEN}`
  );
  t.deepEqual(t.context.log.args[1], [
    'Reading npm config from %s',
    [path.resolve(process.env.HOME, '.npmrc'), path.resolve(cwd, '.npmrc')].join(', '),
  ]);
});

test.serial('Throw error if "NPM_TOKEN" is missing', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});

  const [error] = await t.throwsAsync(
    require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env: {}, logger: t.context.logger})
  );

  t.is(error.name, 'SemanticReleaseError');
  t.is(error.message, 'No npm token specified.');
  t.is(error.code, 'ENONPMTOKEN');
});

test.serial('Emulate npm config resolution if "NPM_CONFIG_USERCONFIG" is set', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});

  await appendFile(path.resolve(cwd, '.custom-npmrc'), `//custom.registry.com/:_authToken = \${NPM_TOKEN}`);

  await require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {
    cwd,
    env: {NPM_CONFIG_USERCONFIG: path.resolve(cwd, '.custom-npmrc')},
    logger: t.context.logger,
  });

  t.is((await readFile(npmrc)).toString(), `//custom.registry.com/:_authToken = \${NPM_TOKEN}`);
  t.deepEqual(t.context.log.args[1], ['Reading npm config from %s', [path.resolve(cwd, '.custom-npmrc')].join(', ')]);
});

test.serial('Throw error if "NPM_USERNAME" is missing', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_PASSWORD: 'npm_pasword', NPM_EMAIL: 'npm_email'};

  const [error] = await t.throwsAsync(
    require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger})
  );

  t.is(error.name, 'SemanticReleaseError');
  t.is(error.message, 'No npm token specified.');
  t.is(error.code, 'ENONPMTOKEN');
});

test.serial('Throw error if "NPM_PASSWORD" is missing', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_USERNAME: 'npm_username', NPM_EMAIL: 'npm_email'};

  const [error] = await t.throwsAsync(
    require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger})
  );

  t.is(error.name, 'SemanticReleaseError');
  t.is(error.message, 'No npm token specified.');
  t.is(error.code, 'ENONPMTOKEN');
});

test.serial('Throw error if "NPM_EMAIL" is missing', async t => {
  process.env.HOME = tempy.directory();
  const cwd = tempy.directory();
  process.chdir(cwd);
  const npmrc = tempy.file({name: '.npmrc'});
  const env = {NPM_USERNAME: 'npm_username', NPM_PASSWORD: 'npm_password'};

  const [error] = await t.throwsAsync(
    require('../lib/set-npmrc-auth')(npmrc, 'http://custom.registry.com', {cwd, env, logger: t.context.logger})
  );

  t.is(error.name, 'SemanticReleaseError');
  t.is(error.message, 'No npm token specified.');
  t.is(error.code, 'ENONPMTOKEN');
});