mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-25 23:11:31 +00:00
4b4d14ec00
* feat(manager): pass extracted constraints to updateArtifacts `extractedConstraints` were collected during extraction but only ever read by `fetch.ts` for the lookup. At artifact time every manager had to derive the same tool constraints a second time, and when the updated package file no longer carried the constraint there was nothing to fall back to. `generateBranchConfig()` now merges the `extractedConstraints` of all upgrades of a branch onto the branch config, which reaches `updateArtifacts()` through `patchConfigForArtifactsUpdate()`. `UpdateArtifactsConfig` declares the field and documents what it contains. The new `resolveToolConstraint()` helper implements the ladder once: user `constraints` > an optional artifact-time derivation > the extracted value. The derivation is ranked above the extracted value on purpose: it reads the package files as the branch changed them, so poetry (python is an updatable dependency there), composer, pipenv (`pipenv` can be a dev package) and pep621 (`requires-python` is an updatable dependency) would otherwise regress to a stale constraint. pipenv, pep621 uv/pdm, poetry and composer are migrated to the helper and keep their derivation. Behaviour change: these managers now use the extract-time constraint as a last resort instead of running unconstrained, for example on lock file maintenance where pipenv deletes `Pipfile.lock` before deriving. `execute-post-upgrade-commands.ts` is unaffected: it reads `upgrade.constraints` per upgrade, and the extracted values are kept in a separate field rather than folded into `constraints`, so post-upgrade task tool constraints still come from user config only. Not migrated, because their constraints are never extracted, so the fallback would be dead code: bundler (`ruby`/`bundler`), pixi (`pixi`), pep621 uv (`required-version`) and npm's node ladder, whose last step already reads `package.json` engines. * refactor(manager): resolve tool constraints through resolveToolConstraint() Every manager now obtains the constraint of a tool it runs through `resolveToolConstraint()` instead of reading `config.constraints` itself, so the precedence "user config, then a value derived from the updated files, then the constraints collected during extraction" applies everywhere. The helper treats an empty string as not set at every step and accepts the `PostUpdateConfig` shape, whose `constraints` may be `null`. Behaviour changes that go beyond the new fallback to extracted constraints: - `mix` applies its hardcoded erlang default only after the extracted constraint, so an erlang version collected at extraction can win over it. - `kustomize` decides `HELM_EXPERIMENTAL_OCI` from the fully resolved helm constraint; `generateHelmEnvs()` takes that value instead of the config. - `npm` (yarn): an upgrade of yarn without a new value now consults the user constraint before deriving one from package.json or the lock file. - The "Using <tool> constraint from config" debug lines in bundler, composer, copier and pip-compile are gone, as the helper is the only reader of the config now. Helpers that read the config synchronously became async: bundler `getBundlerConstraint()`, copier `getPythonVersionConstraint()` and `getCopierVersionConstraint()`, pip-compile `get*VersionConstraint()` and `getToolVersionConstraint()`, gomod `deriveGoToolchainConstraints()` and `getUpdateImportPathCmds()`, mise `getMiseLockToolConstraints()`. composer `getPhpConstraint()` is removed. Each converted manager has a test showing the extracted constraint reaching the executed tool, and, where a derive callback exists, that the derived value still wins over it. * refactor(linters): add prefer-resolve-tool-constraint rule Reports member reads and destructuring of `constraints` and `extractedConstraints` from a manager config in `lib/modules/manager/**`, so that tool constraints are resolved through `resolveToolConstraint()` in `lib/modules/manager/util.ts` only. Writes and the same properties on package files, which extraction has to populate, are not reported. The helper itself and spec files are exempt in `.oxlintrc.json`. * refactor(manager): inline thin resolveToolConstraint wrappers Drop copier/utils.ts and the pip-compile getPipToolsVersionConstraint / getUvVersionConstraint helpers, which only forwarded to resolveToolConstraint(). Callers now call it directly. * docs(development): note lock file maintenance in tool constraints section * refactor(manager): address review on tool constraint resolution composer only runs extractConstraints() when a user constraint is missing, via Lazy. UpdateArtifactsConfig no longer re-declares constraints and extractedConstraints, which ToolConstraintsConfig already provides.
197 lines
5.9 KiB
TypeScript
197 lines
5.9 KiB
TypeScript
import upath from 'upath';
|
|
import { fs } from '~test/util.ts';
|
|
import { GlobalConfig } from '../../../config/global.ts';
|
|
import type {
|
|
InternalGlobalConfigOptions,
|
|
RepoGlobalConfig,
|
|
} from '../../../config/types.ts';
|
|
import type { UpdateArtifactsConfig } from '../types.ts';
|
|
import { updateArtifacts } from './artifacts.ts';
|
|
|
|
vi.mock('../../../util/fs/index.ts');
|
|
vi.mock('./lockfile.ts');
|
|
|
|
const adminConfig: RepoGlobalConfig & InternalGlobalConfigOptions = {
|
|
localDir: upath.join('/tmp/github/some/repo'),
|
|
cacheDir: upath.join('/tmp/cache'),
|
|
containerbaseDir: upath.join('/tmp/cache/containerbase'),
|
|
binarySource: 'global',
|
|
};
|
|
|
|
const config: UpdateArtifactsConfig = {};
|
|
|
|
describe('modules/manager/bazel-module/artifacts', () => {
|
|
beforeEach(() => {
|
|
GlobalConfig.set(adminConfig);
|
|
});
|
|
|
|
it('returns null if no updated deps and not lockfile maintenance', async () => {
|
|
await expect(
|
|
updateArtifacts({
|
|
packageFileName: 'MODULE.bazel',
|
|
updatedDeps: [],
|
|
newPackageFileContent: '',
|
|
config,
|
|
}),
|
|
).resolves.toBeNull();
|
|
});
|
|
|
|
it('returns null if no MODULE.bazel.lock found', async () => {
|
|
fs.getSiblingFileName.mockReturnValueOnce('MODULE.bazel.lock');
|
|
fs.readLocalFile.mockResolvedValueOnce(null);
|
|
|
|
await expect(
|
|
updateArtifacts({
|
|
packageFileName: 'MODULE.bazel',
|
|
updatedDeps: [{ depName: 'rules_go' }],
|
|
newPackageFileContent:
|
|
'bazel_dep(name = "rules_go", version = "0.42.0")',
|
|
config,
|
|
}),
|
|
).resolves.toBeNull();
|
|
});
|
|
|
|
it('writes package file and delegates to updateBazelLockfile', async () => {
|
|
const { updateBazelLockfile } = await import('./lockfile.ts');
|
|
vi.mocked(updateBazelLockfile).mockResolvedValueOnce([
|
|
{
|
|
file: {
|
|
type: 'addition',
|
|
path: 'MODULE.bazel.lock',
|
|
contents: 'new lock content',
|
|
},
|
|
},
|
|
]);
|
|
fs.getSiblingFileName.mockReturnValueOnce('MODULE.bazel.lock');
|
|
fs.readLocalFile.mockResolvedValueOnce('old lock content');
|
|
|
|
const result = await updateArtifacts({
|
|
packageFileName: 'MODULE.bazel',
|
|
updatedDeps: [{ depName: 'rules_go' }],
|
|
newPackageFileContent: 'bazel_dep(name = "rules_go", version = "0.42.0")',
|
|
config,
|
|
});
|
|
|
|
expect(fs.writeLocalFile).toHaveBeenCalledWith(
|
|
'MODULE.bazel',
|
|
'bazel_dep(name = "rules_go", version = "0.42.0")',
|
|
);
|
|
expect(updateBazelLockfile).toHaveBeenCalledWith(
|
|
'MODULE.bazel.lock',
|
|
'MODULE.bazel',
|
|
undefined,
|
|
undefined,
|
|
);
|
|
expect(result).toEqual([
|
|
{
|
|
file: {
|
|
type: 'addition',
|
|
path: 'MODULE.bazel.lock',
|
|
contents: 'new lock content',
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('passes isLockFileMaintenance to updateBazelLockfile', async () => {
|
|
const { updateBazelLockfile } = await import('./lockfile.ts');
|
|
vi.mocked(updateBazelLockfile).mockResolvedValueOnce(null);
|
|
fs.getSiblingFileName.mockReturnValueOnce('MODULE.bazel.lock');
|
|
fs.readLocalFile.mockResolvedValueOnce('old lock content');
|
|
|
|
await updateArtifacts({
|
|
packageFileName: 'MODULE.bazel',
|
|
updatedDeps: [],
|
|
newPackageFileContent: '',
|
|
config: { ...config, isLockFileMaintenance: true },
|
|
});
|
|
|
|
expect(updateBazelLockfile).toHaveBeenCalledWith(
|
|
'MODULE.bazel.lock',
|
|
'MODULE.bazel',
|
|
true,
|
|
undefined,
|
|
);
|
|
});
|
|
|
|
it('passes bazelisk constraint to updateBazelLockfile', async () => {
|
|
const { updateBazelLockfile } = await import('./lockfile.ts');
|
|
vi.mocked(updateBazelLockfile).mockResolvedValueOnce(null);
|
|
fs.getSiblingFileName.mockReturnValueOnce('MODULE.bazel.lock');
|
|
fs.readLocalFile.mockResolvedValueOnce('old lock content');
|
|
|
|
await updateArtifacts({
|
|
packageFileName: 'MODULE.bazel',
|
|
updatedDeps: [{ depName: 'rules_go' }],
|
|
newPackageFileContent: 'bazel_dep(name = "rules_go", version = "0.42.0")',
|
|
config: { ...config, constraints: { bazelisk: '>=1.18.0' } },
|
|
});
|
|
|
|
expect(updateBazelLockfile).toHaveBeenCalledWith(
|
|
'MODULE.bazel.lock',
|
|
'MODULE.bazel',
|
|
undefined,
|
|
'>=1.18.0',
|
|
);
|
|
});
|
|
|
|
it('passes the extracted bazelisk constraint to updateBazelLockfile', async () => {
|
|
const { updateBazelLockfile } = await import('./lockfile.ts');
|
|
vi.mocked(updateBazelLockfile).mockResolvedValueOnce(null);
|
|
fs.getSiblingFileName.mockReturnValueOnce('MODULE.bazel.lock');
|
|
fs.readLocalFile.mockResolvedValueOnce('old lock content');
|
|
|
|
await updateArtifacts({
|
|
packageFileName: 'MODULE.bazel',
|
|
updatedDeps: [{ depName: 'rules_go' }],
|
|
newPackageFileContent: 'bazel_dep(name = "rules_go", version = "0.42.0")',
|
|
config: { ...config, extractedConstraints: { bazelisk: '>=1.19.0' } },
|
|
});
|
|
|
|
expect(updateBazelLockfile).toHaveBeenCalledWith(
|
|
'MODULE.bazel.lock',
|
|
'MODULE.bazel',
|
|
undefined,
|
|
'>=1.19.0',
|
|
);
|
|
});
|
|
|
|
it('handles subdirectory MODULE.bazel', async () => {
|
|
const { updateBazelLockfile } = await import('./lockfile.ts');
|
|
vi.mocked(updateBazelLockfile).mockResolvedValueOnce([
|
|
{
|
|
file: {
|
|
type: 'addition',
|
|
path: 'subdir/MODULE.bazel.lock',
|
|
contents: 'new lock content',
|
|
},
|
|
},
|
|
]);
|
|
fs.getSiblingFileName.mockReturnValueOnce('subdir/MODULE.bazel.lock');
|
|
fs.readLocalFile.mockResolvedValueOnce('old lock content');
|
|
|
|
const result = await updateArtifacts({
|
|
packageFileName: 'subdir/MODULE.bazel',
|
|
updatedDeps: [{ depName: 'rules_go' }],
|
|
newPackageFileContent: 'bazel_dep(name = "rules_go", version = "0.42.0")',
|
|
config,
|
|
});
|
|
|
|
expect(updateBazelLockfile).toHaveBeenCalledWith(
|
|
'subdir/MODULE.bazel.lock',
|
|
'subdir/MODULE.bazel',
|
|
undefined,
|
|
undefined,
|
|
);
|
|
expect(result).toEqual([
|
|
{
|
|
file: {
|
|
type: 'addition',
|
|
path: 'subdir/MODULE.bazel.lock',
|
|
contents: 'new lock content',
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
});
|