-
Notifications
You must be signed in to change notification settings - Fork 7
fix(executors): launch Forge without shell interpretation #210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,62 @@ | ||
| import { resolve } from 'path'; | ||
| import { ExecutorContext } from '@nx/devkit'; | ||
| import { runForgeCommandAsync } from '../../utils/forge/async-commands'; | ||
| import runExecutor from './executor'; | ||
| import { patchManifestYml } from './lib/patch-manifest-yml'; | ||
| import { RegisterExecutorOptions } from './schema'; | ||
|
|
||
| jest.mock('../../utils/forge/async-commands', () => ({ | ||
| runForgeCommandAsync: jest.fn().mockResolvedValue(undefined), | ||
| })); | ||
| jest.mock('./lib/patch-manifest-yml', () => ({ | ||
| patchManifestYml: jest.fn().mockResolvedValue(undefined), | ||
| })); | ||
|
|
||
| const runForgeCommandAsyncMock = jest.mocked(runForgeCommandAsync); | ||
| const patchManifestYmlMock = jest.mocked(patchManifestYml); | ||
|
|
||
| describe('register executor', () => { | ||
| const context = { | ||
| root: '/workspace', | ||
| projectName: 'example', | ||
| projectsConfigurations: { | ||
| version: 2, | ||
| projects: { | ||
| example: { | ||
| root: 'apps/example', | ||
| sourceRoot: 'apps/example/src', | ||
| }, | ||
| }, | ||
| }, | ||
| } as unknown as ExecutorContext; | ||
|
|
||
| const defaultOptions: RegisterExecutorOptions = { | ||
| outputPath: 'dist/apps/example', | ||
| appName: 'Example app', | ||
| verbose: false, | ||
| developerSpaceId: '', | ||
| acceptTerms: false, | ||
| }; | ||
|
|
||
| beforeEach(() => { | ||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| it('forwards the developer space flag and value as separate arguments', async () => { | ||
| const developerSpaceId = 'space id;$(untrusted)'; | ||
|
|
||
| await runExecutor( | ||
| { | ||
| ...defaultOptions, | ||
| developerSpaceId, | ||
| }, | ||
| context | ||
| ); | ||
|
|
||
| expect(runForgeCommandAsyncMock).toHaveBeenCalledWith( | ||
| ['register', '--developer-space-id', developerSpaceId, 'Example app'], | ||
| { cwd: resolve('/workspace', 'dist/apps/example') } | ||
| ); | ||
| expect(patchManifestYmlMock).toHaveBeenCalledTimes(1); | ||
| }); | ||
| }); |
This file contains hidden or 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
160 changes: 160 additions & 0 deletions
160
packages/nx-forge/src/utils/forge/async-commands.spec.ts
This file contains hidden or 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,160 @@ | ||
| import { | ||
| chmodSync, | ||
| existsSync, | ||
| mkdtempSync, | ||
| mkdirSync, | ||
| readFileSync, | ||
| realpathSync, | ||
| rmSync, | ||
| writeFileSync, | ||
| } from 'fs'; | ||
| import { tmpdir } from 'os'; | ||
| import { delimiter, join } from 'path'; | ||
| import { getPackageManagerCommand } from '@nx/devkit'; | ||
| import { runForgeCommandAsync } from './async-commands'; | ||
|
|
||
| jest.mock('@nx/devkit', () => ({ | ||
| ...jest.requireActual('@nx/devkit'), | ||
| getPackageManagerCommand: jest.fn(), | ||
| })); | ||
|
|
||
| const getPackageManagerCommandMock = jest.mocked(getPackageManagerCommand); | ||
|
|
||
| describe('runForgeCommandAsync', () => { | ||
| let testRoot: string; | ||
| let binPath: string; | ||
| let invocationPath: string; | ||
| let sideEffectPath: string; | ||
|
|
||
| beforeEach(() => { | ||
| testRoot = mkdtempSync(join(tmpdir(), 'nx-forge-command-')); | ||
| binPath = join(testRoot, 'bin'); | ||
| invocationPath = join(testRoot, 'invocation.json'); | ||
| sideEffectPath = join(testRoot, 'shell-side-effect'); | ||
| mkdirSync(binPath); | ||
|
|
||
| createPackageManagerShim(binPath, 'pnpm'); | ||
| mockPackageManagerCommand('pnpm exec'); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| rmSync(testRoot, { recursive: true, force: true }); | ||
| jest.clearAllMocks(); | ||
| }); | ||
|
|
||
| it('preserves Forge arguments without shell interpretation', async () => { | ||
| const injectedCommand = | ||
| process.platform === 'win32' | ||
| ? "approval value&node -e \"require('fs').writeFileSync(process.env.FORGE_SIDE_EFFECT,'created')\"" | ||
| : "approval value;node -e \"require('fs').writeFileSync(process.env.FORGE_SIDE_EFFECT,'created')\""; | ||
| const forgeArgs = [ | ||
| 'deploy', | ||
| '--approve', | ||
| injectedCommand, | ||
| '--major-version', | ||
| '2', | ||
| ]; | ||
|
|
||
| await runForgeCommandAsync(forgeArgs, { | ||
| cwd: testRoot, | ||
| env: createEnvironment(binPath, invocationPath, { | ||
| FORGE_SIDE_EFFECT: sideEffectPath, | ||
| FORGE_TEST_ENV: 'forwarded', | ||
| }), | ||
| }); | ||
|
|
||
| expect(JSON.parse(readFileSync(invocationPath, 'utf8'))).toEqual({ | ||
| args: ['exec', 'forge', ...forgeArgs], | ||
| cwd: realpathSync(testRoot), | ||
| environmentValue: 'forwarded', | ||
| }); | ||
| expect(existsSync(sideEffectPath)).toBe(false); | ||
| }); | ||
|
|
||
| it.each([ | ||
| { exec: 'npx', executable: 'npx', prefixArgs: [] }, | ||
| { exec: 'pnpm exec', executable: 'pnpm', prefixArgs: ['exec'] }, | ||
| { exec: 'yarn', executable: 'yarn', prefixArgs: [] }, | ||
| { exec: 'bun', executable: 'bun', prefixArgs: [] }, | ||
| ])('supports the $exec package-manager command shape', async (command) => { | ||
| createPackageManagerShim(binPath, command.executable); | ||
| mockPackageManagerCommand(command.exec); | ||
|
|
||
| await runForgeCommandAsync(['version'], { | ||
| cwd: testRoot, | ||
| env: createEnvironment(binPath, invocationPath), | ||
| }); | ||
|
|
||
| expect(JSON.parse(readFileSync(invocationPath, 'utf8')).args).toEqual([ | ||
| ...command.prefixArgs, | ||
| 'forge', | ||
| 'version', | ||
| ]); | ||
| }); | ||
|
|
||
| it('rejects when Forge exits with a non-zero code', async () => { | ||
| await expect( | ||
| runForgeCommandAsync(['lint'], { | ||
| cwd: testRoot, | ||
| env: createEnvironment(binPath, invocationPath, { | ||
| FORGE_EXIT_CODE: '7', | ||
| }), | ||
| }) | ||
| ).rejects.toThrow('Exit with error code: 7'); | ||
| }); | ||
| }); | ||
|
|
||
| function mockPackageManagerCommand(exec: string): void { | ||
| getPackageManagerCommandMock.mockReturnValue({ | ||
| exec, | ||
| } as ReturnType<typeof getPackageManagerCommand>); | ||
| } | ||
|
|
||
| function createEnvironment( | ||
| binPath: string, | ||
| invocationPath: string, | ||
| extraEnvironment: NodeJS.ProcessEnv = {} | ||
| ): NodeJS.ProcessEnv { | ||
| const pathKey = | ||
| Object.keys(process.env).find((key) => key.toLowerCase() === 'path') ?? | ||
| 'PATH'; | ||
|
|
||
| return { | ||
| [pathKey]: `${binPath}${delimiter}${process.env[pathKey] ?? ''}`, | ||
| FORGE_INVOCATION_PATH: invocationPath, | ||
| ...extraEnvironment, | ||
| }; | ||
| } | ||
|
|
||
| function createPackageManagerShim(directory: string, command: string): void { | ||
| const scriptPath = join(directory, 'fake-package-manager.cjs'); | ||
| writeFileSync( | ||
| scriptPath, | ||
| [ | ||
| "const { writeFileSync } = require('fs');", | ||
| 'writeFileSync(', | ||
| ' process.env.FORGE_INVOCATION_PATH,', | ||
| ' JSON.stringify({', | ||
| ' args: process.argv.slice(2),', | ||
| ' cwd: process.cwd(),', | ||
| ' environmentValue: process.env.FORGE_TEST_ENV,', | ||
| ' })', | ||
| ');', | ||
| 'process.exitCode = Number(process.env.FORGE_EXIT_CODE ?? 0);', | ||
| ].join('\n') | ||
| ); | ||
|
|
||
| if (process.platform === 'win32') { | ||
| writeFileSync( | ||
| join(directory, `${command}.cmd`), | ||
| `@echo off\r\n"${process.execPath}" "%~dp0\\fake-package-manager.cjs" %*\r\n` | ||
| ); | ||
| } else { | ||
| const executablePath = join(directory, command); | ||
| writeFileSync( | ||
| executablePath, | ||
| `#!/usr/bin/env node\nrequire('./fake-package-manager.cjs');\n` | ||
| ); | ||
| chmodSync(executablePath, 0o755); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.