-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
389 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| 'skuba': minor | ||
| --- | ||
|
|
||
| template, format: Mount `.npmrc` files in `/tmp/` rather than `<workdir>/tmp/`, to avoid accidental inclusion in commits or published artifacts, as per the original intent of this handling. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
289 changes: 289 additions & 0 deletions
289
src/cli/lint/internalLints/upgrade/patches/8.2.1/moveNpmrcMounts.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,289 @@ | ||
| // eslint-disable-next-line no-restricted-imports -- fs-extra is mocked | ||
| import fsp from 'fs/promises'; | ||
|
|
||
| import memfs, { vol } from 'memfs'; | ||
|
|
||
| import type { PatchConfig } from '../..'; | ||
| import { configForPackageManager } from '../../../../../../utils/packageManager'; | ||
|
|
||
| import { tryMoveNpmrcMounts } from './moveNpmrcMounts'; | ||
|
|
||
| const volToJson = () => vol.toJSON(process.cwd(), undefined, true); | ||
|
|
||
| jest.mock('fs-extra', () => memfs); | ||
| jest.mock('fast-glob', () => ({ | ||
| glob: (pat: any, opts: any) => | ||
| jest.requireActual('fast-glob').glob(pat, { ...opts, fs: memfs }), | ||
| })); | ||
|
|
||
| beforeEach(() => vol.reset()); | ||
|
|
||
| describe('moveNpmrcMounts', () => { | ||
| const baseArgs = { | ||
| manifest: {} as PatchConfig['manifest'], | ||
| packageManager: configForPackageManager('pnpm'), | ||
| }; | ||
|
|
||
| afterEach(() => jest.resetAllMocks()); | ||
|
|
||
| describe.each(['lint', 'format'] as const)('%s', (mode) => { | ||
| it('should not need to modify any of the template pipelines', async () => { | ||
| for (const template of await fsp.readdir('template')) { | ||
| const pipelineFile = `template/${template}/.buildkite/pipeline.yml`; | ||
| try { | ||
| await fsp.stat(pipelineFile); | ||
| } catch { | ||
| continue; | ||
| } | ||
|
|
||
| const contents = await fsp.readFile(pipelineFile, 'utf-8'); | ||
|
|
||
| vol.fromJSON({ | ||
| '.buildkite/pipeline.yml': contents, | ||
| }); | ||
|
|
||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ | ||
| result: 'skip', | ||
| reason: 'no .npmrc mounts found need to be updated', | ||
| }); | ||
|
|
||
| expect(volToJson()).toEqual({ | ||
| '.buildkite/pipeline.yml': contents, | ||
| }); | ||
| } | ||
| }); | ||
|
|
||
| it('should skip if no Buildkite files are found', async () => { | ||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ | ||
| result: 'skip', | ||
| reason: 'no Buildkite files found', | ||
| }); | ||
|
|
||
| expect(volToJson()).toEqual({}); | ||
| }); | ||
|
|
||
| it('should skip on a pipeline without mounts', async () => { | ||
| const input = `steps: | ||
| - label: 'My Step' | ||
| command: echo 'Hello, world!' | ||
| `; | ||
|
|
||
| vol.fromJSON({ | ||
| '.buildkite/pipeline.yml': input, | ||
| }); | ||
|
|
||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ | ||
| result: 'skip', | ||
| reason: 'no .npmrc mounts found need to be updated', | ||
| }); | ||
|
|
||
| expect(volToJson()).toEqual({ | ||
| '.buildkite/pipeline.yml': input, | ||
| }); | ||
| }); | ||
|
|
||
| it('should fix an incorrect mount', async () => { | ||
| const input = `configs: | ||
| plugins: | ||
| - &docker-ecr-cache | ||
| seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - .npmrc | ||
| - package.json#.packageManager | ||
| - pnpm-lock.yaml | ||
| dockerfile: Dockerfile.dev-deps | ||
| ecr-name: build-cache/my-service | ||
| secrets: id=npm,src=tmp/.npmrc | ||
|
|
||
| - &private-npm | ||
| seek-oss/private-npm#v1.2.0: | ||
| env: NPM_READ_TOKEN | ||
| output-path: tmp/ | ||
|
|
||
| steps: []`; | ||
|
|
||
| vol.fromJSON({ | ||
| '.buildkite/pipeline.yml': input, | ||
| }); | ||
|
|
||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ result: 'apply' }); | ||
|
|
||
| expect(volToJson()).toEqual({ | ||
| '.buildkite/pipeline.yml': | ||
| mode === 'lint' | ||
| ? input | ||
| : `configs: | ||
| plugins: | ||
| - &docker-ecr-cache | ||
| seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - .npmrc | ||
| - package.json#.packageManager | ||
| - pnpm-lock.yaml | ||
| dockerfile: Dockerfile.dev-deps | ||
| ecr-name: build-cache/my-service | ||
| secrets: id=npm,src=/tmp/.npmrc | ||
|
|
||
| - &private-npm | ||
| seek-oss/private-npm#v1.2.0: | ||
| env: NPM_READ_TOKEN | ||
| output-path: /tmp/ | ||
|
|
||
| steps: []`, | ||
| }); | ||
| }); | ||
|
|
||
| it('should fix an incorrect mount with comments', async () => { | ||
| const input = `configs: | ||
| plugins: | ||
| - &docker-ecr-cache | ||
| seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - .npmrc | ||
| - package.json#.packageManager | ||
| - pnpm-lock.yaml | ||
| dockerfile: Dockerfile.dev-deps | ||
| ecr-name: build-cache/my-service | ||
| secrets: id=npm,src=tmp/.npmrc # hello | ||
|
|
||
| - &private-npm | ||
| seek-oss/private-npm#v1.2.0: | ||
| env: NPM_READ_TOKEN | ||
| output-path: tmp/#world | ||
|
|
||
| steps: []`; | ||
|
|
||
| vol.fromJSON({ | ||
| '.buildkite/pipeline.yml': input, | ||
| }); | ||
|
|
||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ result: 'apply' }); | ||
|
|
||
| expect(volToJson()).toEqual({ | ||
| '.buildkite/pipeline.yml': | ||
| mode === 'lint' | ||
| ? input | ||
| : `configs: | ||
| plugins: | ||
| - &docker-ecr-cache | ||
| seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - .npmrc | ||
| - package.json#.packageManager | ||
| - pnpm-lock.yaml | ||
| dockerfile: Dockerfile.dev-deps | ||
| ecr-name: build-cache/my-service | ||
| secrets: id=npm,src=/tmp/.npmrc # hello | ||
|
|
||
| - &private-npm | ||
| seek-oss/private-npm#v1.2.0: | ||
| env: NPM_READ_TOKEN | ||
| output-path: /tmp/#world | ||
|
|
||
| steps: []`, | ||
| }); | ||
| }); | ||
|
|
||
| it('should skip a mount without tmp', async () => { | ||
| const input = `configs: | ||
| plugins: | ||
| - &docker-ecr-cache | ||
| seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - .npmrc | ||
| - package.json#.packageManager | ||
| - pnpm-lock.yaml | ||
| dockerfile: Dockerfile.dev-deps | ||
| ecr-name: build-cache/my-service | ||
| secrets: id=npm,src=.npmrc | ||
|
|
||
| - &private-npm | ||
| seek-oss/private-npm#v1.2.0: | ||
| env: NPM_READ_TOKEN | ||
|
|
||
| steps: []`; | ||
|
|
||
| vol.fromJSON({ | ||
| '.buildkite/pipeline.yml': input, | ||
| }); | ||
|
|
||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ | ||
| result: 'skip', | ||
| reason: 'no .npmrc mounts found need to be updated', | ||
| }); | ||
|
|
||
| expect(volToJson()).toEqual({ | ||
| '.buildkite/pipeline.yml': input, | ||
| }); | ||
| }); | ||
|
|
||
| it('should skip a /tmp/ mount', async () => { | ||
| const input = `configs: | ||
| plugins: | ||
| - &docker-ecr-cache | ||
| seek-oss/docker-ecr-cache#v2.2.0: | ||
| cache-on: | ||
| - .npmrc | ||
| - package.json#.packageManager | ||
| - pnpm-lock.yaml | ||
| dockerfile: Dockerfile.dev-deps | ||
| ecr-name: build-cache/my-service | ||
| secrets: id=npm,src=/tmp/.npmrc | ||
|
|
||
| - &private-npm | ||
| seek-oss/private-npm#v1.2.0: | ||
| env: NPM_READ_TOKEN | ||
| output-path: /tmp/ | ||
|
|
||
| steps: []`; | ||
|
|
||
| vol.fromJSON({ | ||
| 'packages/stuff/.buildkite/pipeline.yaml': input, | ||
| }); | ||
|
|
||
| await expect( | ||
| tryMoveNpmrcMounts({ | ||
| ...baseArgs, | ||
| mode, | ||
| }), | ||
| ).resolves.toEqual({ | ||
| result: 'skip', | ||
| reason: 'no .npmrc mounts found need to be updated', | ||
| }); | ||
|
|
||
| expect(volToJson()).toEqual({ | ||
| 'packages/stuff/.buildkite/pipeline.yaml': input, | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.