path: root/smoke-tests/test/index.js

const { readFileSync, realpathSync, mkdirSync, existsSync, writeFileSync } = require('fs')
const spawn = require('@npmcli/promise-spawn')
const { join, resolve, sep } = require('path')
const t = require('tap')
const rimraf = require('rimraf')
const which = require('which').sync
const { start, stop, registry } = require('./fixtures/server.js')

const { SMOKE_PUBLISH_NPM, CI, PATH } = process.env
const log = CI ? console.error : () => {}

const cwd = resolve(__dirname, '..', '..')
const npmCli = join('bin', 'npm-cli.js')
const execArgv = SMOKE_PUBLISH_NPM ? ['npm'] : [process.execPath, join(cwd, npmCli)]
const npmDir = SMOKE_PUBLISH_NPM ? realpathSync(which('npm')).replace(sep + npmCli, '') : cwd

// setup server
t.before(start)
t.teardown(stop)
// update notifier should never be written
t.afterEach((t) => {
  const updateExists = existsSync(join(cacheLocation, '_update-notifier-last-checked'))
  t.equal(updateExists, false)
})

const readFile = filename => readFileSync(resolve(localPrefix, filename), 'utf-8')
const normalizePath = path => path.replace(/[A-Z]:/, '').replace(/\\/g, '/')

t.cleanSnapshot = s =>
  s
    // sometimes we print normalized paths in snapshots regardless of
    // platform so replace those first
    .split(normalizePath(npmDir))
    .join('{CWD}')
    .split(normalizePath(cwd))
    .join('{CWD}')
    .split(registry)
    .join('https://registry.npmjs.org/')
    .split(normalizePath(process.execPath))
    .join('node')
    // then replace platform style paths
    .split(npmDir)
    .join('{CWD}')
    .split(cwd)
    .join('{CWD}')
    .replace(/\\+/g, '/')
    .replace(/\r\n/g, '\n')
    .replace(/ \(in a browser\)/g, '')
    .replace(/^npm@.* /gm, 'npm ')
    .replace(/^.*debug-[0-9]+.log$/gm, '')

// setup fixtures
const path = t.testdir({
  '.npmrc': '',
  cache: {},
  project: {},
  bin: {},
})
const localPrefix = resolve(path, 'project')
const userconfigLocation = resolve(path, '.npmrc')
const cacheLocation = resolve(path, 'cache')
const binLocation = resolve(path, 'bin')

const exec = async (...args) => {
  const cmd = []
  const opts = [
    `--registry=${registry}`,
    `--cache=${cacheLocation}`,
    `--userconfig=${userconfigLocation}`,
    '--no-audit',
    '--no-update-notifier',
    '--loglevel=silly',
  ]
  for (const arg of args) {
    if (arg.startsWith('--')) {
      opts.push(arg)
    } else {
      cmd.push(arg)
    }
  }

  // XXX: not sure why outdated fails with no-workspaces but works without it
  if (!opts.includes('--workspaces') && cmd[0] !== 'outdated') {
    // This is required so we dont detect any workspace roots above the testdir
    opts.push('--no-workspaces')
  }

  const spawnArgs = [execArgv[0], [...execArgv.slice(1), ...cmd, ...opts]]
  log([spawnArgs[0], ...spawnArgs[1]].join(' '))

  const res = await spawn(...spawnArgs, {
    cwd: localPrefix,
    env: {
      HOME: path,
      PATH: `${PATH}:${binLocation}`,
      COMSPEC: process.env.COMSPEC,
    },
    stdioString: true,
    encoding: 'utf-8',
  })

  log(res.stderr)
  return res.stdout
}

// this test must come first, its package.json will be destroyed and the one
// created in the next test (npm init) will create a new one that must be
// present for later tests
t.test('npm install sends correct user-agent', async t => {
  const pkgPath = join(localPrefix, 'package.json')
  const pkgContent = JSON.stringify({
    name: 'smoke-test-workspaces',
    workspaces: ['packages/*'],
  })
  writeFileSync(pkgPath, pkgContent, { encoding: 'utf8' })

  const wsRoot = join(localPrefix, 'packages')
  mkdirSync(wsRoot)

  const wsPath = join(wsRoot, 'foo')
  mkdirSync(wsPath)

  const wsPkgPath = join(wsPath, 'package.json')
  const wsContent = JSON.stringify({
    name: 'foo',
  })
  writeFileSync(wsPkgPath, wsContent, { encoding: 'utf8' })
  t.teardown(() => rimraf.sync(`${localPrefix}/*`))

  await t.rejects(
    exec('install', 'fail_reflect_user_agent'),
    {
      stderr: /workspaces\/false/,
    },
    'workspaces/false is present in output'
  )

  await t.rejects(
    exec('install', 'fail_reflect_user_agent', '--workspaces'),
    {
      stderr: /workspaces\/true/,
    },
    'workspaces/true is present in output'
  )
})

t.test('npm init', async t => {
  const cmdRes = await exec('init', '-y')

  t.matchSnapshot(cmdRes, 'should have successful npm init result')
  const pkg = JSON.parse(readFileSync(resolve(localPrefix, 'package.json')))
  t.equal(pkg.name, 'project', 'should have expected generated name')
  t.equal(pkg.version, '1.0.0', 'should have expected generated version')
})

t.test('npm --version', async t => {
  const v = await exec('--version')

  if (SMOKE_PUBLISH_NPM) {
    t.match(v.trim(), /-[0-9a-f]{40}\.\d$/, 'must have a git version')
  } else {
    t.skip('not checking version')
  }
})

t.test('npm (no args)', async t => {
  const err = await exec('--loglevel=notice').catch(e => e)

  t.equal(err.code, 1, 'should exit with error code')
  t.equal(err.stderr, '', 'should have no stderr output')
  t.matchSnapshot(err.stdout, 'should have expected no args output')
})

t.test('npm install prodDep@version', async t => {
  const cmdRes = await exec('install', 'abbrev@1.0.4')

  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected install reify output')
  t.matchSnapshot(readFile('package.json'), 'should have expected package.json result')
  t.matchSnapshot(readFile('package-lock.json'), 'should have expected lockfile result')
})

t.test('npm install dev dep', async t => {
  const cmdRes = await exec('install', 'promise-all-reject-late', '-D')

  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected dev dep added reify output')
  t.matchSnapshot(
    readFile('package.json'),
    'should have expected dev dep added package.json result'
  )
  t.matchSnapshot(
    readFile('package-lock.json'),
    'should have expected dev dep added lockfile result'
  )
})

t.test('npm ls', async t => {
  const cmdRes = await exec('ls')

  t.matchSnapshot(cmdRes, 'should have expected ls output')
})

t.test('npm fund', async t => {
  const cmdRes = await exec('fund')

  t.matchSnapshot(cmdRes, 'should have expected fund output')
})

t.test('npm explain', async t => {
  const cmdRes = await exec('explain', 'abbrev')

  t.matchSnapshot(cmdRes, 'should have expected explain output')
})

t.test('npm diff', async t => {
  const cmdRes = await exec('diff', '--diff=abbrev@1.0.4', '--diff=abbrev@1.1.1')

  t.matchSnapshot(cmdRes, 'should have expected diff output')
})

t.test('npm outdated', async t => {
  const err = await exec('outdated').catch(e => e)

  t.equal(err.code, 1, 'should exit with error code')
  t.not(err.stderr, '', 'should have stderr output')
  t.matchSnapshot(err.stdout, 'should have expected outdated output')
})

t.test('npm pkg set scripts', async t => {
  const cmdRes = await exec('pkg', 'set', 'scripts.hello=echo Hello')

  t.matchSnapshot(cmdRes, 'should have expected set-script output')
  t.matchSnapshot(
    readFile('package.json'),
    'should have expected script added package.json result'
  )
})

t.test('npm run-script', async t => {
  const cmdRes = await exec('run', 'hello')

  t.matchSnapshot(cmdRes, 'should have expected run-script output')
})

t.test('npm prefix', async t => {
  const cmdRes = await exec('prefix')

  t.matchSnapshot(cmdRes, 'should have expected prefix output')
})

t.test('npm view', async t => {
  const cmdRes = await exec('view', 'abbrev@1.0.4')

  t.matchSnapshot(cmdRes, 'should have expected view output')
})

t.test('npm update dep', async t => {
  const cmdRes = await exec('update', 'abbrev')

  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected update reify output')
  t.matchSnapshot(readFile('package.json'), 'should have expected update package.json result')
  t.matchSnapshot(readFile('package-lock.json'), 'should have expected update lockfile result')
})

t.test('npm uninstall', async t => {
  const cmdRes = await exec('uninstall', 'promise-all-reject-late')

  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected uninstall reify output')
  t.matchSnapshot(readFile('package.json'), 'should have expected uninstall package.json result')
  t.matchSnapshot(readFile('package-lock.json'), 'should have expected uninstall lockfile result')
})

t.test('npm pkg', async t => {
  let cmdRes = await exec('pkg', 'get', 'license')
  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected pkg get output')

  cmdRes = await exec('pkg', 'set', 'tap[test-env][0]=LC_ALL=sk')
  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected pkg set output')

  t.matchSnapshot(
    readFile('package.json'),
    'should have expected npm pkg set modified package.json result'
  )

  cmdRes = await exec('pkg', 'get')
  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should print package.json contents')

  cmdRes = await exec('pkg', 'delete', 'tap')
  t.matchSnapshot(cmdRes.replace(/in.*s/, ''), 'should have expected pkg delete output')

  t.matchSnapshot(
    readFile('package.json'),
    'should have expected npm pkg delete modified package.json result'
  )
})

t.test('npm update --no-save --no-package-lock', async t => {
  // setup, manually reset dep value
  await exec('pkg', 'set', 'dependencies.abbrev==1.0.4')
  await exec(`install`)
  await exec('pkg', 'set', 'dependencies.abbrev=^1.0.4')

  await exec('update', '--no-save', '--no-package-lock')

  t.equal(
    JSON.parse(readFile('package.json')).dependencies.abbrev,
    '^1.0.4',
    'should have expected update --no-save --no-package-lock package.json result'
  )
  t.equal(
    JSON.parse(readFile('package-lock.json')).packages['node_modules/abbrev'].version,
    '1.0.4',
    'should have expected update --no-save --no-package-lock lockfile result'
  )
})

t.test('npm update --no-save', async t => {
  await exec('update', '--no-save')

  t.equal(
    JSON.parse(readFile('package.json')).dependencies.abbrev,
    '^1.0.4',
    'should have expected update --no-save package.json result'
  )
  t.equal(
    JSON.parse(readFile('package-lock.json')).packages['node_modules/abbrev'].version,
    '1.1.1',
    'should have expected update --no-save lockfile result'
  )
})

t.test('npm update --save', async t => {
  await exec('update', '--save')

  t.equal(
    JSON.parse(readFile('package.json')).dependencies.abbrev,
    '^1.1.1',
    'should have expected update --save package.json result'
  )
  t.equal(
    JSON.parse(readFile('package-lock.json')).packages['node_modules/abbrev'].version,
    '1.1.1',
    'should have expected update --save lockfile result'
  )
})

t.test('npm ci', async t => {
  await exec('uninstall', 'abbrev')
  await exec('install', 'abbrev@1.0.4', '--save-exact')

  t.equal(
    JSON.parse(readFile('package-lock.json')).packages['node_modules/abbrev'].version,
    '1.0.4',
    'should have stored exact installed version'
  )

  await exec('pkg', 'set', 'dependencies.abbrev=^1.1.1')

  const err = await exec('ci', '--loglevel=error').catch(e => e)
  t.equal(err.code, 1)
  t.matchSnapshot(err.stderr, 'should throw mismatch deps in lock file error')
})