%PDF-
%PDF-
Mini Shell
Mini Shell
const t = require('tap')
const realFetch = require('npm-registry-fetch')
const mockNpm = require('../../fixtures/mock-npm')
const fixtures = {
workspace: {
'package.json': JSON.stringify({
name: 'root',
version: '1.0.0',
workspaces: ['workspace-a', 'workspace-b', 'workspace-c'],
}),
'workspace-a': {
'package.json': JSON.stringify({
name: 'workspace-a',
version: '1.0.0',
}),
},
'workspace-b': {
'package.json': JSON.stringify({
name: 'workspace-b',
version: '1.0.0',
}),
},
'workspace-c': {
'package.json': JSON.stringify({
name: 'workspace-c',
version: '1.0.0',
}),
},
},
}
const tags = {
'/-/package/@scoped%2fpkg/dist-tags': {
latest: '1.0.0',
a: '0.0.1',
b: '0.5.0',
},
'/-/package/@scoped%2fanother/dist-tags': {
latest: '2.0.0',
a: '0.0.2',
b: '0.6.0',
},
'/-/package/@scoped%2fanother/dist-tags/c': {
latest: '7.7.7',
a: '0.0.2',
b: '0.6.0',
c: '7.7.7',
},
'/-/package/workspace-a/dist-tags': {
latest: '1.0.0',
'latest-a': '1.0.0',
},
'/-/package/workspace-b/dist-tags': {
latest: '2.0.0',
'latest-b': '2.0.0',
},
'/-/package/workspace-c/dist-tags': {
latest: '3.0.0',
'latest-c': '3.0.0',
},
}
const mockDist = async (t, { ...npmOpts } = {}) => {
const getTag = async (url) => ({ ...tags })[url]
let fetchOpts
const nrf = async (url, opts) => {
fetchOpts = opts
if (url === '/-/package/foo/dist-tags') {
throw new Error('no package found')
}
return getTag(url)
}
const mock = await mockNpm(t, {
...npmOpts,
command: 'dist-tag',
mocks: {
'npm-registry-fetch': Object.assign(nrf, realFetch, { json: getTag }),
},
})
return {
...mock,
distTag: mock['dist-tag'],
fetchOpts: () => fetchOpts,
result: () => mock.joinedOutput(),
logs: () => {
const distLogs = mock.logs.filter(l => l[1].startsWith('dist-tag'))
return distLogs.map(([, ...parts]) => {
return parts.map(p => p.toString()).join(' ').trim()
}).join('\n').trim()
},
}
}
t.test('ls in current package', async t => {
const { distTag, result } = await mockDist(t, {
prefixDir: {
'package.json': JSON.stringify({
name: '@scoped/pkg',
}),
},
})
await distTag.exec(['ls'])
t.matchSnapshot(
result(),
'should list available tags for current package'
)
})
t.test('ls global', async t => {
const { distTag } = await mockDist(t, {
config: {
global: true,
},
})
await t.rejects(
distTag.exec(['ls']),
distTag.usage,
'should throw basic usage'
)
})
t.test('no args in current package', async t => {
const { distTag, result } = await mockDist(t, {
prefixDir: {
'package.json': JSON.stringify({
name: '@scoped/pkg',
}),
},
})
await distTag.exec([])
t.matchSnapshot(
result(),
'should default to listing available tags for current package'
)
})
t.test('borked cmd usage', async t => {
const { distTag } = await mockDist(t)
await t.rejects(
distTag.exec(['borked', '@scoped/pkg']),
distTag.usage,
'should show usage error'
)
})
t.test('ls on named package', async t => {
const { distTag, result } = await mockDist(t)
await distTag.exec(['ls', '@scoped/another'])
t.matchSnapshot(
result(),
'should list tags for the specified package'
)
})
t.test('ls on missing package', async t => {
const { distTag, logs } = await mockDist(t)
await t.rejects(
distTag.exec(['ls', 'foo']),
distTag.usage
)
t.matchSnapshot(
logs(),
'should log no dist-tag found msg'
)
})
t.test('ls on missing name in current package', async t => {
const { distTag } = await mockDist(t, {
prefixDir: {
'package.json': JSON.stringify({
version: '1.0.0',
}),
},
})
await t.rejects(
distTag.exec(['ls']),
distTag.usage,
'should throw usage error message'
)
})
t.test('only named package arg', async t => {
const { distTag, result } = await mockDist(t)
await distTag.exec(['@scoped/another'])
t.matchSnapshot(
result(),
'should default to listing tags for the specified package'
)
})
t.test('workspaces', async t => {
const mockWorkspaces = async (t, exec = [], workspaces = true, prefixDir = {}) => {
const mock = await mockDist(t, {
prefixDir: {
...fixtures.workspace,
...prefixDir,
},
config: workspaces === true ? { workspaces } : { workspace: workspaces },
})
await mock.distTag.exec(exec)
return mock
}
t.test('no args', async t => {
const { result } = await mockWorkspaces(t)
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('no args, one workspace', async t => {
const { result } = await mockWorkspaces(t, [], 'workspace-a')
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('one arg -- cwd', async t => {
const { result } = await mockWorkspaces(t, ['.'])
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('one arg -- .@1, ignores version spec', async t => {
const { result } = await mockWorkspaces(t, ['.@'])
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('one arg -- list', async t => {
const { result } = await mockWorkspaces(t, ['list'])
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('two args -- list, cwd', async t => {
const { result } = await mockWorkspaces(t, ['list', '.'])
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('two args -- list, .@1, ignores version spec', async t => {
const { result } = await mockWorkspaces(t, ['list', '.@'])
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('two args -- list, @scoped/pkg, logs a warning and ignores workspaces', async t => {
const { result, logs } = await mockWorkspaces(t, ['list', '@scoped/pkg'])
t.match(logs(), 'Ignoring workspaces for specified package', 'logs a warning')
t.matchSnapshot(result(), 'printed the expected output')
})
t.test('no args, one failing workspace sets exitCode to 1', async t => {
const { result, logs } = await mockWorkspaces(t, [], true, {
'package.json': JSON.stringify({
name: 'root',
version: '1.0.0',
workspaces: ['workspace-a', 'workspace-b', 'workspace-c', 'workspace-d'],
}),
'workspace-d': {
'package.json': JSON.stringify({
name: 'workspace-d',
version: '1.0.0',
}),
},
})
t.match(logs(), 'dist-tag ls Couldn\'t get dist-tag data for workspace-d@*', 'logs the error')
t.matchSnapshot(result(), 'printed the expected output')
})
})
t.test('add new tag', async t => {
const { distTag, result, fetchOpts } = await mockDist(t)
await distTag.exec(['add', '@scoped/another@7.7.7', 'c'])
const opts = fetchOpts()
t.equal(opts.method, 'PUT', 'should trigger request to add new tag')
t.equal(opts.body, '"7.7.7"', 'should point to expected version')
t.matchSnapshot(
result(),
'should return success msg'
)
})
t.test('add using valid semver range as name', async t => {
const { distTag, logs } = await mockDist(t)
await t.rejects(
distTag.exec(['add', '@scoped/another@7.7.7', '1.0.0']),
/Tag name must not be a valid SemVer range: 1.0.0/,
'should exit with semver range error'
)
t.matchSnapshot(
logs(),
'should return success msg'
)
})
t.test('add missing args', async t => {
const { distTag } = await mockDist(t, {
config: {
tag: '',
},
})
await t.rejects(
distTag.exec(['add', '@scoped/another@7.7.7']),
distTag.usage,
'should exit usage error message'
)
})
t.test('add missing pkg name', async t => {
const { distTag } = await mockDist(t)
await t.rejects(
distTag.exec(['add', null]),
distTag.usage,
'should exit usage error message'
)
})
t.test('set existing version', async t => {
const { distTag, logs } = await mockDist(t)
await distTag.exec(['set', '@scoped/another@0.6.0', 'b'])
t.matchSnapshot(
logs(),
'should log warn msg'
)
})
t.test('remove existing tag', async t => {
const { distTag, result, logs, fetchOpts } = await mockDist(t)
await distTag.exec(['rm', '@scoped/another', 'c'])
const opts = fetchOpts()
t.equal(opts.method, 'DELETE', 'should trigger request to remove tag')
t.matchSnapshot(logs(), 'should log remove info')
t.matchSnapshot(result(), 'should return success msg')
})
t.test('remove non-existing tag', async t => {
const { distTag, logs } = await mockDist(t)
await t.rejects(
distTag.exec(['rm', '@scoped/another', 'nonexistent']),
/nonexistent is not a dist-tag on @scoped\/another/,
'should exit with error'
)
t.matchSnapshot(logs(), 'should log error msg')
})
t.test('remove missing pkg name', async t => {
const { distTag } = await mockDist(t)
await t.rejects(
distTag.exec(['rm', null]),
distTag.usage,
'should exit usage error message'
)
})
t.test('completion', async t => {
const { distTag } = await mockDist(t)
const match = distTag.completion({ conf: { argv: { remain: ['npm', 'dist-tag'] } } })
t.resolveMatch(match, ['add', 'rm', 'ls'],
'should list npm dist-tag commands for completion')
const noMatch = distTag.completion({ conf: { argv: { remain: ['npm', 'dist-tag', 'foobar'] } } })
t.resolveMatch(noMatch, [])
})
Zerion Mini Shell 1.0