mirror of
https://github.com/renovatebot/renovate.git
synced 2026-11-03 02:53:40 +00:00
Jamie Tanna
9f3db00d1a
As part of future changes which will fix issues with Composer + Yarn 1
introduced by f430552de4, we need to find
a way to ignore command failure, on a per-command basis.
To do this, we can provide a refactor to introduce a new type,
`CommandWithOptions` which has the ability to specify whether to
`ignoreFailure`.
To make this less of a refactor than would otherwise require, we can
pass around a `(string | CommandWithOptions)[]`
(or a `string[]` or a `CommandWithOptions[]`) to be used, and use
helpers `asRawCommand` and `asRawCommands` to extract the underlying
command where necessary.
In the case a command's failure is being ignored, return the error code
in the `ExecResult`.
We also need to make sure that when executing in Docker, we still
provide the `|| true`s, otherwise we'll start to see commands failing
unexpectedly.
As part of future-proofing the `CommandWithOptions`, we can make sure
that it uses `string[]`s for the command it's representing, to avoid
re-parsing it.
107 lines
2.5 KiB
TypeScript
107 lines
2.5 KiB
TypeScript
import is from '@sindresorhus/is';
|
|
import traverse from 'neotraverse/legacy';
|
|
import upath from 'upath';
|
|
import { rawExec as _exec } from '../lib/util/exec/common';
|
|
import type {
|
|
CommandWithOptions,
|
|
RawExecOptions,
|
|
} from '../lib/util/exec/types';
|
|
import { regEx } from '../lib/util/regex';
|
|
|
|
export type ExecResult = { stdout: string; stderr: string } | Error;
|
|
|
|
export const exec = vi.mocked(_exec);
|
|
|
|
export interface ExecSnapshot {
|
|
cmd: string;
|
|
options?: RawExecOptions | null | undefined;
|
|
}
|
|
|
|
export type ExecSnapshots = ExecSnapshot[];
|
|
|
|
function execSnapshot(
|
|
cmd: string | CommandWithOptions,
|
|
options?: RawExecOptions,
|
|
): ExecSnapshot {
|
|
const snapshot = {
|
|
cmd,
|
|
options,
|
|
};
|
|
|
|
const cwd = upath.toUnix(process.cwd());
|
|
|
|
return traverse(snapshot).map(function fixup(v) {
|
|
if (is.string(v)) {
|
|
const val = v
|
|
.replace(regEx(/\\(\w)/g), '/$1')
|
|
.replace(regEx(/^[A-Z]:\//), '/') // replace windows paths
|
|
.replace(regEx(/"[A-Z]:\//g), '"/') // replace windows paths
|
|
.replace(cwd, '/root/project');
|
|
this.update(val);
|
|
}
|
|
});
|
|
}
|
|
|
|
const defaultExecResult = { stdout: '', stderr: '' };
|
|
|
|
export function mockExecAll(
|
|
execResult: ExecResult = defaultExecResult,
|
|
): ExecSnapshots {
|
|
const snapshots: ExecSnapshots = [];
|
|
exec.mockImplementation((cmd, options) => {
|
|
snapshots.push(execSnapshot(cmd, options));
|
|
if (execResult instanceof Error) {
|
|
throw execResult;
|
|
}
|
|
return execResult as never;
|
|
});
|
|
return snapshots;
|
|
}
|
|
|
|
export function mockExecSequence(execResults: ExecResult[]): ExecSnapshots {
|
|
const snapshots: ExecSnapshots = [];
|
|
execResults.forEach((execResult) => {
|
|
exec.mockImplementationOnce((cmd, options) => {
|
|
snapshots.push(execSnapshot(cmd, options));
|
|
if (execResult instanceof Error) {
|
|
throw execResult;
|
|
}
|
|
return execResult as never;
|
|
});
|
|
});
|
|
return snapshots;
|
|
}
|
|
|
|
const basicEnvMock = {
|
|
HTTP_PROXY: 'http://example.com',
|
|
HTTPS_PROXY: 'https://example.com',
|
|
NO_PROXY: 'localhost',
|
|
HOME: '/home/user',
|
|
PATH: '/tmp/path',
|
|
LANG: 'en_US.UTF-8',
|
|
LC_ALL: 'en_US',
|
|
};
|
|
|
|
const fullEnvMock = {
|
|
...basicEnvMock,
|
|
SELECTED_ENV_VAR: 'Can be selected',
|
|
FILTERED_ENV_VAR: 'Should be filtered',
|
|
};
|
|
|
|
const filteredEnvMock = {
|
|
...basicEnvMock,
|
|
SELECTED_ENV_VAR: fullEnvMock.SELECTED_ENV_VAR,
|
|
};
|
|
|
|
export const envMock = {
|
|
basic: basicEnvMock,
|
|
full: fullEnvMock,
|
|
filtered: filteredEnvMock,
|
|
};
|
|
|
|
// reset exec mock, otherwise there can be some left over from previous test
|
|
beforeEach(() => {
|
|
// maybe not mocked
|
|
exec.mockReset?.();
|
|
});
|