const tspawk = require('../../fixtures/tspawk') const { cleanCwd, cleanTime, cleanDate, cleanPackumentCache, } = require('../../fixtures/clean-snapshot.js') const path = require('node:path') const t = require('tap') t.cleanSnapshot = (str) => cleanPackumentCache(cleanDate(cleanTime(cleanCwd(str)))) const { loadNpmWithRegistry: loadMockNpm, workspaceMock, } = require('../../fixtures/mock-npm') // tspawk calls preventUnmatched which assures that no scripts run if we don't mock any const spawk = tspawk(t) const abbrev = { 'package.json': '{"name": "abbrev", "version": "1.0.0"}', test: 'test file', } const packageJson = { name: '@npmcli/test-package', version: '1.0.0', dependencies: { abbrev: '^1.0.0', }, } t.test('exec commands', async t => { await t.test('with args does not run lifecycle scripts', async t => { const { npm, registry } = await loadMockNpm(t, { config: { audit: false, }, prefixDir: { 'package.json': JSON.stringify({ ...packageJson, scripts: { install: 'echo install', }, }), abbrev, }, }) const manifest = registry.manifest({ name: 'abbrev' }) await registry.package({ manifest }) await registry.tarball({ manifest: manifest.versions['1.0.0'], tarball: path.join(npm.prefix, 'abbrev'), }) await npm.exec('install', ['abbrev']) }) await t.test('without args runs lifecycle scripts', async t => { const lifecycleScripts = [ 'preinstall', 'install', 'postinstall', 'prepublish', 'preprepare', 'prepare', 'postprepare', ] const scripts = {} for (const script of lifecycleScripts) { spawk.spawn(/.*/, a => { runOrder.push(script) return a.includes(`${script} lifecycle script`) }) scripts[script] = `${script} lifecycle script` } const { npm, registry } = await loadMockNpm(t, { config: { audit: false, }, prefixDir: { 'package.json': JSON.stringify({ ...packageJson, scripts, }), abbrev, }, }) const runOrder = [] const manifest = registry.manifest({ name: 'abbrev' }) await registry.package({ manifest }) await registry.tarball({ manifest: manifest.versions['1.0.0'], tarball: path.join(npm.prefix, 'abbrev'), }) await npm.exec('install') t.strictSame(lifecycleScripts, runOrder, 'all script ran in the correct order') }) await t.test('should ignore scripts with --ignore-scripts', async t => { const { npm, registry } = await loadMockNpm(t, { config: { 'ignore-scripts': true, audit: false, }, prefixDir: { 'package.json': JSON.stringify({ ...packageJson, scripts: { install: 'echo install', }, }), abbrev, }, }) const manifest = registry.manifest({ name: 'abbrev' }) await registry.package({ manifest }) await registry.tarball({ manifest: manifest.versions['1.0.0'], tarball: path.join(npm.prefix, 'abbrev'), }) await npm.exec('install') }) await t.test('should not install invalid global package name', async t => { const { npm } = await loadMockNpm(t, { config: { global: true, }, }) await t.rejects( npm.exec('install', ['']), /Usage:/, 'should not install invalid package name' ) }) await t.test('npm i -g npm engines check success', async t => { const { npm, registry } = await loadMockNpm(t, { prefixDir: { npm: { 'package.json': JSON.stringify({ name: 'npm', version: '1.0.0' }), 'index.js': 'console.log("this is npm")', }, }, config: { global: true }, }) const manifest = registry.manifest({ name: 'npm', packuments: [{ version: '1.0.0', engines: { node: '>1' } }], }) await registry.package({ manifest, times: 2 }) await registry.tarball({ manifest: manifest.versions['1.0.0'], tarball: path.join(npm.localPrefix, 'npm'), }) await npm.exec('install', ['npm']) t.ok('No exceptions happen') }) await t.test('npm i -g npm engines check failure', async t => { const { npm, registry } = await loadMockNpm(t, { prefixDir: { npm: { 'package.json': JSON.stringify({ name: 'npm', version: '1.0.0' }), 'index.js': 'console.log("this is the npm we are installing")', }, }, config: { global: true }, }) const manifest = registry.manifest({ name: 'npm', packuments: [{ version: '1.0.0', engines: { node: '~1' } }], }) await registry.package({ manifest }) await t.rejects( npm.exec('install', ['npm']), { message: 'Unsupported engine', pkgid: 'npm@1.0.0', current: { node: process.version, npm: '1.0.0', }, required: { node: '~1', }, code: 'EBADENGINE', } ) }) await t.test('npm i -g npm engines check failure forced override', async t => { const { npm, registry } = await loadMockNpm(t, { prefixDir: { npm: { 'package.json': JSON.stringify({ name: 'npm', version: '1.0.0' }), 'index.js': 'console.log("this is npm")', }, }, config: { global: true, force: true }, }) const manifest = registry.manifest({ name: 'npm', packuments: [{ version: '1.0.0', engines: { node: '~1' } }], }) await registry.package({ manifest, times: 2 }) await registry.tarball({ manifest: manifest.versions['1.0.0'], tarball: path.join(npm.localPrefix, 'npm'), }) await npm.exec('install', ['npm']) t.ok('No exceptions happen') }) }) t.test('completion', async t => { const mockComp = async (t, { noChdir } = {}) => loadMockNpm(t, { command: 'install', prefixDir: { arborist: { 'package.json': '{}', }, 'arborist.txt': 'just a file', 'other-dir': { a: 'a' }, }, ...(noChdir ? { chdir: false } : {}), }) await t.test('completion to folder - has a match', async t => { const { install } = await mockComp(t) const res = await install.completion({ partialWord: './ar' }) t.strictSame(res, ['arborist'], 'package dir match') }) await t.test('completion to folder - invalid dir', async t => { const { install } = await mockComp(t, { noChdir: true }) const res = await install.completion({ partialWord: '/does/not/exist' }) t.strictSame(res, [], 'invalid dir: no matching') }) await t.test('completion to folder - no matches', async t => { const { install } = await mockComp(t) const res = await install.completion({ partialWord: './pa' }) t.strictSame(res, [], 'no name match') }) await t.test('completion to folder - match is not a package', async t => { const { install } = await mockComp(t) const res = await install.completion({ partialWord: './othe' }) t.strictSame(res, [], 'no name match') }) await t.test('completion to url', async t => { const { install } = await mockComp(t) const res = await install.completion({ partialWord: 'http://path/to/url' }) t.strictSame(res, []) }) await t.test('no /', async t => { const { install } = await mockComp(t) const res = await install.completion({ partialWord: 'toto' }) t.notOk(res) }) await t.test('only /', async t => { const { install } = await mockComp(t) const res = await install.completion({ partialWord: '/' }) t.strictSame(res, []) }) }) t.test('should install in workspace with unhoisted module', async t => { const { npm, registry, assert } = await loadMockNpm(t, { prefixDir: workspaceMock(t, { clean: true, workspaces: { 'workspace-a': { 'abbrev@1.1.0': { hoist: true }, }, 'workspace-b': { 'abbrev@1.1.1': { hoist: false }, }, }, }), }) await registry.setup({ 'abbrev@1.1.0': path.join(npm.prefix, 'tarballs/abbrev@1.1.0'), 'abbrev@1.1.1': path.join(npm.prefix, 'tarballs/abbrev@1.1.1'), }) registry.nock.post('/-/npm/v1/security/advisories/bulk').reply(200, {}) assert.packageMissing('node_modules/abbrev@1.1.0') assert.packageMissing('workspace-b/node_modules/abbrev@1.1.1') await npm.exec('install', []) assert.packageInstalled('node_modules/abbrev@1.1.0') assert.packageInstalled('workspace-b/node_modules/abbrev@1.1.1') }) t.test('should install in workspace with hoisted modules', async t => { const prefixDir = workspaceMock(t, { clean: true, workspaces: { 'workspace-a': { 'abbrev@1.1.0': { hoist: true }, }, 'workspace-b': { 'lodash@1.1.1': { hoist: true }, }, }, }) const { npm, registry, assert } = await loadMockNpm(t, { prefixDir }) await registry.setup({ 'abbrev@1.1.0': path.join(npm.prefix, 'tarballs/abbrev@1.1.0'), 'lodash@1.1.1': path.join(npm.prefix, 'tarballs/lodash@1.1.1'), }) registry.nock.post('/-/npm/v1/security/advisories/bulk').reply(200, {}) assert.packageMissing('node_modules/abbrev@1.1.0') assert.packageMissing('node_modules/lodash@1.1.1') await npm.exec('install', []) assert.packageInstalled('node_modules/abbrev@1.1.0') assert.packageInstalled('node_modules/lodash@1.1.1') }) t.test('should install unhoisted module with --workspace flag', async t => { const { npm, registry, assert } = await loadMockNpm(t, { config: { workspace: 'workspace-b', }, prefixDir: workspaceMock(t, { clean: true, workspaces: { 'workspace-a': { 'abbrev@1.1.0': { hoist: true }, }, 'workspace-b': { 'abbrev@1.1.1': { hoist: false }, }, }, }), }) await registry.setup({ 'abbrev@1.1.1': path.join(npm.prefix, 'tarballs/abbrev@1.1.1'), }) registry.nock.post('/-/npm/v1/security/advisories/bulk').reply(200, {}) assert.packageMissing('node_modules/abbrev@1.1.0') assert.packageMissing('workspace-b/node_modules/abbrev@1.1.1') await npm.exec('install', []) assert.packageMissing('node_modules/abbrev@1.1.0') assert.packageInstalled('workspace-b/node_modules/abbrev@1.1.1') }) t.test('should install hoisted module with --workspace flag', async t => { const { npm, registry, assert } = await loadMockNpm(t, { config: { workspace: 'workspace-b', }, prefixDir: workspaceMock(t, { clean: true, workspaces: { 'workspace-a': { 'abbrev@1.1.0': { hoist: true }, }, 'workspace-b': { 'lodash@1.1.1': { hoist: true }, }, }, }), }) await registry.setup({ 'lodash@1.1.1': path.join(npm.prefix, 'tarballs/lodash@1.1.1'), }) registry.nock.post('/-/npm/v1/security/advisories/bulk').reply(200, {}) assert.packageMissing('node_modules/abbrev@1.1.0') assert.packageMissing('node_modules/lodash@1.1.1') await npm.exec('install', []) assert.packageMissing('node_modules/abbrev@1.1.0') assert.packageInstalled('node_modules/lodash@1.1.1') }) t.test('should show install keeps dirty --workspace flag', async t => { const { npm, registry, assert } = await loadMockNpm(t, { config: { workspace: 'workspace-b', }, prefixDir: workspaceMock(t, { workspaces: { 'workspace-a': { 'abbrev@1.1.0': { clean: false, hoist: true }, }, 'workspace-b': { 'lodash@1.1.1': { clean: true, hoist: true }, }, }, }), }) await registry.setup({ 'lodash@1.1.1': path.join(npm.prefix, 'tarballs/lodash@1.1.1'), }) registry.nock.post('/-/npm/v1/security/advisories/bulk').reply(200, {}) assert.packageDirty('node_modules/abbrev@1.1.0') assert.packageMissing('node_modules/lodash@1.1.1') await npm.exec('install', []) assert.packageDirty('node_modules/abbrev@1.1.0') assert.packageInstalled('node_modules/lodash@1.1.1') }) t.test('devEngines', async t => { const mockArguments = { globals: { 'process.platform': 'linux', 'process.arch': 'x86', 'process.version': 'v1337.0.0', }, mocks: { '{ROOT}/package.json': { version: '42.0.0' }, }, } t.test('should utilize devEngines success case', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'test-package', version: '1.0.0', devEngines: { runtime: { name: 'node', }, }, }), }, }) await npm.exec('install', []) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(!output.includes('EBADDEVENGINES')) }) t.test('should utilize devEngines failure case', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'test-package', version: '1.0.0', devEngines: { runtime: { name: 'nondescript', }, }, }), }, }) await t.rejects( npm.exec('install', []) ) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('error EBADDEVENGINES')) }) t.test('should utilize devEngines failure force case', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, config: { force: true, }, prefixDir: { 'package.json': JSON.stringify({ name: 'test-package', version: '1.0.0', devEngines: { runtime: { name: 'nondescript', }, }, }), }, }) await npm.exec('install', []) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('warn EBADDEVENGINES')) }) t.test('should utilize devEngines 2x warning case', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'test-package', version: '1.0.0', devEngines: { runtime: { name: 'nondescript', onFail: 'warn', }, cpu: { name: 'risv', onFail: 'warn', }, }, }), }, }) await npm.exec('install', []) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('warn EBADDEVENGINES')) }) t.test('should utilize devEngines 2x error case', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'test-package', version: '1.0.0', devEngines: { runtime: { name: 'nondescript', onFail: 'error', }, cpu: { name: 'risv', onFail: 'error', }, }, }), }, }) await t.rejects( npm.exec('install', []) ) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('error EBADDEVENGINES')) }) t.test('should utilize devEngines failure and warning case', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'test-package', version: '1.0.0', devEngines: { runtime: { name: 'nondescript', }, cpu: { name: 'risv', onFail: 'warn', }, }, }), }, }) await t.rejects( npm.exec('install', []) ) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('EBADDEVENGINES')) }) t.test('should show devEngines has no effect on package install', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { alpha: { 'package.json': JSON.stringify({ name: 'alpha', devEngines: { runtime: { name: 'node', version: '1.0.0' } }, }), 'index.js': 'console.log("this is alpha index")', }, 'package.json': JSON.stringify({ name: 'project', }), }, }) await npm.exec('install', ['./alpha']) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(!output.includes('EBADDEVENGINES')) }) t.test('should show devEngines has no effect on dev package install', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { alpha: { 'package.json': JSON.stringify({ name: 'alpha', devEngines: { runtime: { name: 'node', version: '1.0.0' } }, }), 'index.js': 'console.log("this is alpha index")', }, 'package.json': JSON.stringify({ name: 'project', }), }, config: { 'save-dev': true, }, }) await npm.exec('install', ['./alpha']) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(!output.includes('EBADDEVENGINES')) }) t.test('should show devEngines doesnt break engines', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { alpha: { 'package.json': JSON.stringify({ name: 'alpha', devEngines: { runtime: { name: 'node', version: '1.0.0' } }, engines: { node: '1.0.0' }, }), 'index.js': 'console.log("this is alpha index")', }, 'package.json': JSON.stringify({ name: 'project', }), }, config: { global: true }, }) await npm.exec('install', ['./alpha']) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('warn EBADENGINE')) }) t.test('should not utilize engines in root if devEngines is provided', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'alpha', engines: { node: '0.0.1', }, devEngines: { runtime: { name: 'node', version: '0.0.1', onFail: 'warn', }, }, }), 'index.js': 'console.log("this is alpha index")', }, }) await npm.exec('install') const output = joinedFullOutput() t.matchSnapshot(output) t.ok(!output.includes('EBADENGINE')) t.ok(output.includes('warn EBADDEVENGINES')) }) t.test('should utilize engines in root if devEngines is not provided', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'alpha', engines: { node: '0.0.1', }, }), 'index.js': 'console.log("this is alpha index")', }, }) await npm.exec('install') const output = joinedFullOutput() t.matchSnapshot(output) t.ok(output.includes('EBADENGINE')) t.ok(!output.includes('EBADDEVENGINES')) }) t.test('should show devEngines has no effect on global package install', async t => { const { npm, joinedFullOutput } = await loadMockNpm(t, { ...mockArguments, prefixDir: { 'package.json': JSON.stringify({ name: 'alpha', bin: { alpha: 'index.js', }, devEngines: { runtime: { name: 'node', version: '0.0.1', }, }, }), 'index.js': 'console.log("this is alpha index")', }, config: { global: true, }, }) await npm.exec('install', ['.']) const output = joinedFullOutput() t.matchSnapshot(output) t.ok(!output.includes('EBADENGINE')) t.ok(!output.includes('EBADDEVENGINES')) }) })