Files
pnpm/packages/plugin-commands-installation/test/update/interactive.ts
Dave Brotherstone a6cf11cb77 feat(config): add support for token helper (#4163)
* feat(config): add support for token helper

Use the new interface in `pnpm/credentials-by-uri` for supporting token
helpers. A token helper is an executable, set in the user's `.npmrc`
which outputs an auth token. This can be used in situations where the
`authToken` is not a constant value, but is something that refreshes
regularly, where a script or other tool can use an existing refresh
token to obtain a new access token.

The configuration for the path to the helper must be an absolute path,
with no arguments. In order to be secure, it is _only_ permitted to set
this value in the user `.npmrc`, otherwise a project could place a value
in a project local `.npmrc` and run arbitrary executables.

A similar feature is available in many similar tools. The implementation
in `credentials-by-uri` is modelled after the `vault` (vaultproject.io)
implementation - https://github.com/hashicorp/vault/blob/main/command/token/helper_external.go

* test: fix

* docs: add changesets

Co-authored-by: Zoltan Kochan <z@kochan.io>
2021-12-30 23:16:06 +02:00

224 lines
5.6 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import path from 'path'
import { readProjects } from '@pnpm/filter-workspace-packages'
import { Lockfile } from '@pnpm/lockfile-types'
import prepare, { preparePackages } from '@pnpm/prepare'
import { REGISTRY_MOCK_PORT } from '@pnpm/registry-mock'
import readYamlFile from 'read-yaml-file'
import chalk from 'chalk'
jest.mock('enquirer', () => ({ prompt: jest.fn() }))
// eslint-disable-next-line
import * as enquirer from 'enquirer'
// eslint-disable-next-line
const prompt = enquirer.prompt as any
// eslint-disable-next-line
import { add, install, update } from '@pnpm/plugin-commands-installation'
const REGISTRY_URL = `http://localhost:${REGISTRY_MOCK_PORT}`
const DEFAULT_OPTIONS = {
argv: {
original: [],
},
bail: false,
bin: 'node_modules/.bin',
cliOptions: {},
include: {
dependencies: true,
devDependencies: true,
optionalDependencies: true,
},
lock: true,
pnpmfile: '.pnpmfile.cjs',
rawConfig: { registry: REGISTRY_URL },
rawLocalConfig: { registry: REGISTRY_URL },
registries: {
default: REGISTRY_URL,
},
sort: true,
userConfig: {},
workspaceConcurrency: 1,
}
test('interactively update', async () => {
const project = prepare({
dependencies: {
// has 1.0.0 and 1.0.1 that satisfy this range
'is-negative': '^1.0.0',
// only 2.0.0 satisfies this range
'is-positive': '^2.0.0',
// has many versions that satisfy ^3.0.0
micromatch: '^3.0.0',
},
})
const storeDir = path.resolve('pnpm-store')
await add.handler({
...DEFAULT_OPTIONS,
cacheDir: path.resolve('cache'),
dir: process.cwd(),
linkWorkspacePackages: true,
save: false,
storeDir,
}, [
'is-negative@1.0.0',
'is-positive@2.0.0',
'micromatch@3.0.0',
])
prompt.mockResolvedValue({
updateDependencies: ['is-negative'],
})
prompt.mockClear()
// t.comment('update to compatible versions')
await update.handler({
...DEFAULT_OPTIONS,
cacheDir: path.resolve('cache'),
dir: process.cwd(),
interactive: true,
linkWorkspacePackages: true,
storeDir,
})
expect(prompt.mock.calls[0][0].choices).toStrictEqual([
{
message: chalk`is-negative 1.0.0 1.0.{greenBright.bold 1} `,
name: 'is-negative',
},
{
message: chalk`micromatch 3.0.0 3.{yellowBright.bold 1.10} `,
name: 'micromatch',
},
])
expect(prompt).toBeCalledWith(expect.objectContaining({
footer: '\nEnter to start updating. Ctrl-c to cancel.',
message: 'Choose which packages to update ' +
`(Press ${chalk.cyan('<space>')} to select, ` +
`${chalk.cyan('<a>')} to toggle all, ` +
`${chalk.cyan('<i>')} to invert selection)`,
name: 'updateDependencies',
type: 'multiselect',
}))
{
const lockfile = await project.readLockfile()
expect(lockfile.packages['/micromatch/3.0.0']).toBeTruthy()
expect(lockfile.packages['/is-negative/1.0.1']).toBeTruthy()
expect(lockfile.packages['/is-positive/2.0.0']).toBeTruthy()
}
// t.comment('update to latest versions')
prompt.mockClear()
await update.handler({
...DEFAULT_OPTIONS,
cacheDir: path.resolve('cache'),
dir: process.cwd(),
interactive: true,
latest: true,
linkWorkspacePackages: true,
storeDir,
})
expect(prompt.mock.calls[0][0].choices).toStrictEqual([
{
message: chalk`is-negative 1.0.1 {redBright.bold 2.1.0} `,
name: 'is-negative',
},
{
message: chalk`is-positive 2.0.0 {redBright.bold 3.1.0} `,
name: 'is-positive',
},
{
message: chalk`micromatch 3.0.0 {redBright.bold 4.0.4} `,
name: 'micromatch',
},
])
expect(prompt).toBeCalledWith(expect.objectContaining({
footer: '\nEnter to start updating. Ctrl-c to cancel.',
message: 'Choose which packages to update ' +
`(Press ${chalk.cyan('<space>')} to select, ` +
`${chalk.cyan('<a>')} to toggle all, ` +
`${chalk.cyan('<i>')} to invert selection)`,
name: 'updateDependencies',
type: 'multiselect',
}))
{
const lockfile = await project.readLockfile()
expect(lockfile.packages['/micromatch/3.0.0']).toBeTruthy()
expect(lockfile.packages['/is-negative/2.1.0']).toBeTruthy()
expect(lockfile.packages['/is-positive/2.0.0']).toBeTruthy()
}
})
test('interactive update of dev dependencies only', async () => {
preparePackages([
{
name: 'project1',
dependencies: {
'is-negative': '^1.0.0',
},
},
{
name: 'project2',
devDependencies: {
'is-negative': '^1.0.0',
},
},
])
const storeDir = path.resolve('store')
prompt.mockResolvedValue({
updateDependencies: ['is-negative'],
})
const { allProjects, selectedProjectsGraph } = await readProjects(process.cwd(), [])
await install.handler({
...DEFAULT_OPTIONS,
cacheDir: path.resolve('cache'),
allProjects,
dir: process.cwd(),
linkWorkspacePackages: true,
lockfileDir: process.cwd(),
recursive: true,
selectedProjectsGraph,
storeDir,
workspaceDir: process.cwd(),
})
await update.handler({
...DEFAULT_OPTIONS,
cacheDir: path.resolve('cache'),
allProjects,
cliOptions: {
dev: true,
optional: false,
production: false,
},
dir: process.cwd(),
interactive: true,
latest: true,
linkWorkspacePackages: true,
lockfileDir: process.cwd(),
recursive: true,
selectedProjectsGraph,
storeDir,
workspaceDir: process.cwd(),
})
const lockfile = await readYamlFile<Lockfile>('pnpm-lock.yaml')
expect(
Object.keys(lockfile.packages ?? {})
).toStrictEqual(
['/is-negative/1.0.1', '/is-negative/2.1.0']
)
})