renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-13 07:26:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

feat(composer): extract contraints on update artifacts (#11022)

Browse source
This commit is contained in:
Michael Kriese 2021-07-30 13:07:28 +02:00 committed by GitHub
parent f0e1070299
commit ab800f46d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 55 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/manager/composer/__snapshots__/extract.spec.ts.snap
View file

@ -2,10 +2,6 @@
exports[`manager/composer/extract extractPackageFile() extracts dependencies with lock file 1`] = ` exports[`manager/composer/extract extractPackageFile() extracts dependencies with lock file 1`] = `
Object { Object {
"constraints": Object {
"composer": "^1.10.0",
"php": ">=5.3.2",
},
"deps": Array [ "deps": Array [
Object { Object {
"currentValue": ">=5.3.2", "currentValue": ">=5.3.2",
@ -216,10 +212,6 @@ Object {
exports[`manager/composer/extract extractPackageFile() extracts dependencies with no lock file 1`] = ` exports[`manager/composer/extract extractPackageFile() extracts dependencies with no lock file 1`] = `
Object { Object {
"constraints": Object {
"composer": "^1.10.0",
"php": ">=5.3.2",
},
"deps": Array [ "deps": Array [
Object { Object {
"currentValue": ">=5.3.2", "currentValue": ">=5.3.2",
@ -427,10 +419,6 @@ Object {
exports[`manager/composer/extract extractPackageFile() extracts object registryUrls 1`] = ` exports[`manager/composer/extract extractPackageFile() extracts object registryUrls 1`] = `
Object { Object {
"constraints": Object {
"composer": "1.*",
"php": ">=5.5",
},
"deps": Array [ "deps": Array [
Object { Object {
"currentValue": ">=5.5", "currentValue": ">=5.5",
@ -532,9 +520,6 @@ Object {
exports[`manager/composer/extract extractPackageFile() extracts object repositories and registryUrls with lock file 1`] = ` exports[`manager/composer/extract extractPackageFile() extracts object repositories and registryUrls with lock file 1`] = `
Object { Object {
"constraints": Object {
"composer": "1.*",
},
"deps": Array [ "deps": Array [
Object { Object {
"currentValue": "*", "currentValue": "*",
@ -572,9 +557,6 @@ Object {
exports[`manager/composer/extract extractPackageFile() extracts registryUrls 1`] = ` exports[`manager/composer/extract extractPackageFile() extracts registryUrls 1`] = `
Object { Object {
"constraints": Object {
"composer": "^1.10.0",
},
"deps": Array [ "deps": Array [
Object { Object {
"currentValue": "*", "currentValue": "*",
@ -617,9 +599,6 @@ Object {
exports[`manager/composer/extract extractPackageFile() extracts repositories and registryUrls 1`] = ` exports[`manager/composer/extract extractPackageFile() extracts repositories and registryUrls 1`] = `
Object { Object {
"constraints": Object {
"composer": "1.*",
},
"deps": Array [ "deps": Array [
Object { Object {
"currentValue": "*", "currentValue": "*",

63
lib/manager/composer/artifacts.spec.ts
View file

@ -1,6 +1,5 @@
import { exec as _exec } from 'child_process';
import { join } from 'upath'; import { join } from 'upath';
import { envMock, mockExecAll } from '../../../test/exec-util'; import { envMock, exec, mockExecAll } from '../../../test/exec-util';
import { env, fs, git, mocked, partial } from '../../../test/util'; import { env, fs, git, mocked, partial } from '../../../test/util';
import { setAdminConfig } from '../../config/admin'; import { setAdminConfig } from '../../config/admin';
import type { RepoAdminConfig } from '../../config/types'; import type { RepoAdminConfig } from '../../config/types';
@ -22,7 +21,6 @@ jest.mock('../../../lib/datasource');
jest.mock('../../util/fs'); jest.mock('../../util/fs');
jest.mock('../../util/git'); jest.mock('../../util/git');
const exec: jest.Mock<typeof _exec> = _exec as any;
const datasource = mocked(_datasource); const datasource = mocked(_datasource);
const config: UpdateArtifactsConfig = { const config: UpdateArtifactsConfig = {
@ -55,9 +53,11 @@ describe('.updateArtifacts()', () => {
join(adminConfig.cacheDir, './others/composer') join(adminConfig.cacheDir, './others/composer')
); );
}); });
afterEach(() => { afterEach(() => {
setAdminConfig(); setAdminConfig();
}); });
it('returns if no composer.lock found', async () => { it('returns if no composer.lock found', async () => {
expect( expect(
await composer.updateArtifacts({ await composer.updateArtifacts({
@ -68,10 +68,11 @@ describe('.updateArtifacts()', () => {
}) })
).toBeNull(); ).toBeNull();
}); });
it('returns null if unchanged', async () => { it('returns null if unchanged', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
git.getRepoStatus.mockResolvedValue(repoStatus); git.getRepoStatus.mockResolvedValue(repoStatus);
setAdminConfig({ ...adminConfig, allowScripts: true }); setAdminConfig({ ...adminConfig, allowScripts: true });
expect( expect(
@ -84,6 +85,7 @@ describe('.updateArtifacts()', () => {
).toBeNull(); ).toBeNull();
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('uses hostRules to set COMPOSER_AUTH', async () => { it('uses hostRules to set COMPOSER_AUTH', async () => {
hostRules.add({ hostRules.add({
hostType: PLATFORM_TYPE_GITHUB, hostType: PLATFORM_TYPE_GITHUB,
@ -112,9 +114,9 @@ describe('.updateArtifacts()', () => {
username: 'some-other-username', username: 'some-other-username',
password: 'some-other-password', password: 'some-other-password',
}); });
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const authConfig = { const authConfig = {
...config, ...config,
registryUrls: ['https://packagist.renovatebot.com'], registryUrls: ['https://packagist.renovatebot.com'],
@ -130,10 +132,11 @@ describe('.updateArtifacts()', () => {
).toBeNull(); ).toBeNull();
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('returns updated composer.lock', async () => { it('returns updated composer.lock', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('New composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
git.getRepoStatus.mockResolvedValue({ git.getRepoStatus.mockResolvedValue({
...repoStatus, ...repoStatus,
modified: ['composer.lock'], modified: ['composer.lock'],
@ -148,12 +151,13 @@ describe('.updateArtifacts()', () => {
).not.toBeNull(); ).not.toBeNull();
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('supports vendor directory update', async () => { it('supports vendor directory update', async () => {
const foo = join('vendor/foo/Foo.php'); const foo = join('vendor/foo/Foo.php');
const bar = join('vendor/bar/Bar.php'); const bar = join('vendor/bar/Bar.php');
const baz = join('vendor/baz/Baz.php'); const baz = join('vendor/baz/Baz.php');
fs.localPathExists.mockResolvedValueOnce(true); fs.localPathExists.mockResolvedValueOnce(true);
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
git.getRepoStatus.mockResolvedValueOnce({ git.getRepoStatus.mockResolvedValueOnce({
...repoStatus, ...repoStatus,
@ -161,10 +165,10 @@ describe('.updateArtifacts()', () => {
not_added: [bar], not_added: [bar],
deleted: [baz], deleted: [baz],
}); });
fs.readLocalFile.mockResolvedValueOnce('New composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{ }');
fs.readLocalFile.mockResolvedValueOnce('Foo' as any); fs.readLocalFile.mockResolvedValueOnce('Foo');
fs.readLocalFile.mockResolvedValueOnce('Bar' as any); fs.readLocalFile.mockResolvedValueOnce('Bar');
fs.getSiblingFileName.mockReturnValueOnce('vendor' as any); fs.getSiblingFileName.mockReturnValueOnce('vendor');
const res = await composer.updateArtifacts({ const res = await composer.updateArtifacts({
packageFileName: 'composer.json', packageFileName: 'composer.json',
updatedDeps: [], updatedDeps: [],
@ -173,17 +177,18 @@ describe('.updateArtifacts()', () => {
}); });
expect(res).not.toBeNull(); expect(res).not.toBeNull();
expect(res?.map(({ file }) => file)).toEqual([ expect(res?.map(({ file }) => file)).toEqual([
{ contents: 'New composer.lock', name: 'composer.lock' }, { contents: '{ }', name: 'composer.lock' },
{ contents: 'Foo', name: foo }, { contents: 'Foo', name: foo },
{ contents: 'Bar', name: bar }, { contents: 'Bar', name: bar },
{ contents: baz, name: '|delete|' }, { contents: baz, name: '|delete|' },
]); ]);
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('performs lockFileMaintenance', async () => { it('performs lockFileMaintenance', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('New composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{ }');
git.getRepoStatus.mockResolvedValue({ git.getRepoStatus.mockResolvedValue({
...repoStatus, ...repoStatus,
modified: ['composer.lock'], modified: ['composer.lock'],
@ -201,13 +206,14 @@ describe('.updateArtifacts()', () => {
).not.toBeNull(); ).not.toBeNull();
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('supports docker mode', async () => { it('supports docker mode', async () => {
setAdminConfig({ ...adminConfig, binarySource: 'docker' }); setAdminConfig({ ...adminConfig, binarySource: 'docker' });
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('New composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{ }');
datasource.getPkgReleases.mockResolvedValueOnce({ datasource.getPkgReleases.mockResolvedValueOnce({
releases: [ releases: [
{ version: '1.10.0' }, { version: '1.10.0' },
@ -232,11 +238,12 @@ describe('.updateArtifacts()', () => {
).not.toBeNull(); ).not.toBeNull();
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('supports global mode', async () => { it('supports global mode', async () => {
setAdminConfig({ ...adminConfig, binarySource: 'global' }); setAdminConfig({ ...adminConfig, binarySource: 'global' });
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('New composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{ }');
git.getRepoStatus.mockResolvedValue({ git.getRepoStatus.mockResolvedValue({
...repoStatus, ...repoStatus,
modified: ['composer.lock'], modified: ['composer.lock'],
@ -251,8 +258,9 @@ describe('.updateArtifacts()', () => {
).not.toBeNull(); ).not.toBeNull();
expect(execSnapshots).toMatchSnapshot(); expect(execSnapshots).toMatchSnapshot();
}); });
it('catches errors', async () => { it('catches errors', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
fs.writeLocalFile.mockImplementationOnce(() => { fs.writeLocalFile.mockImplementationOnce(() => {
throw new Error('not found'); throw new Error('not found');
}); });
@ -265,8 +273,9 @@ describe('.updateArtifacts()', () => {
}) })
).toMatchSnapshot(); ).toMatchSnapshot();
}); });
it('catches unmet requirements errors', async () => { it('catches unmet requirements errors', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
fs.writeLocalFile.mockImplementationOnce(() => { fs.writeLocalFile.mockImplementationOnce(() => {
throw new Error( throw new Error(
'fooYour requirements could not be resolved to an installable set of packages.bar' 'fooYour requirements could not be resolved to an installable set of packages.bar'
@ -281,8 +290,9 @@ describe('.updateArtifacts()', () => {
}) })
).toMatchSnapshot(); ).toMatchSnapshot();
}); });
it('throws for disk space', async () => { it('throws for disk space', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
fs.writeLocalFile.mockImplementationOnce(() => { fs.writeLocalFile.mockImplementationOnce(() => {
throw new Error( throw new Error(
'vendor/composer/07fe2366/sebastianbergmann-php-code-coverage-c896779/src/Report/Html/Renderer/Template/js/d3.min.js: write error (disk full?). Continue? (y/n/^C) ' 'vendor/composer/07fe2366/sebastianbergmann-php-code-coverage-c896779/src/Report/Html/Renderer/Template/js/d3.min.js: write error (disk full?). Continue? (y/n/^C) '
@ -297,10 +307,11 @@ describe('.updateArtifacts()', () => {
}) })
).rejects.toThrow(); ).rejects.toThrow();
}); });
it('disables ignorePlatformReqs', async () => { it('disables ignorePlatformReqs', async () => {
fs.readLocalFile.mockResolvedValueOnce('Current composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{}');
const execSnapshots = mockExecAll(exec); const execSnapshots = mockExecAll(exec);
fs.readLocalFile.mockReturnValueOnce('New composer.lock' as any); fs.readLocalFile.mockResolvedValueOnce('{ }');
git.getRepoStatus.mockResolvedValue({ git.getRepoStatus.mockResolvedValue({
...repoStatus, ...repoStatus,
modified: ['composer.lock'], modified: ['composer.lock'],

19
lib/manager/composer/artifacts.ts
View file

@ -25,7 +25,11 @@ import { getRepoStatus } from '../../util/git';
import * as hostRules from '../../util/host-rules'; import * as hostRules from '../../util/host-rules';
import type { UpdateArtifact, UpdateArtifactsResult } from '../types'; import type { UpdateArtifact, UpdateArtifactsResult } from '../types';
import type { AuthJson } from './types'; import type { AuthJson } from './types';
import { composerVersioningId, getConstraint } from './utils'; import {
composerVersioningId,
extractContraints,
getConstraint,
} from './utils';
function getAuthJson(): string | null { function getAuthJson(): string | null {
const authJson: AuthJson = {}; const authJson: AuthJson = {};
@ -82,7 +86,7 @@ export async function updateArtifacts({
); );
const lockFileName = packageFileName.replace(/\.json$/, '.lock'); const lockFileName = packageFileName.replace(/\.json$/, '.lock');
const existingLockFileContent = await readLocalFile(lockFileName); const existingLockFileContent = await readLocalFile(lockFileName, 'utf8');
if (!existingLockFileContent) { if (!existingLockFileContent) {
logger.debug('No composer.lock found'); logger.debug('No composer.lock found');
return null; return null;
@ -93,6 +97,15 @@ export async function updateArtifacts({
await ensureLocalDir(vendorDir); await ensureLocalDir(vendorDir);
try { try {
await writeLocalFile(packageFileName, newPackageFileContent); await writeLocalFile(packageFileName, newPackageFileContent);
const constraints = {
...extractContraints(
JSON.parse(newPackageFileContent),
JSON.parse(existingLockFileContent)
),
...config.constraints,
};
if (config.isLockFileMaintenance) { if (config.isLockFileMaintenance) {
await deleteLocalFile(lockFileName); await deleteLocalFile(lockFileName);
} }
@ -105,7 +118,7 @@ export async function updateArtifacts({
}, },
docker: { docker: {
image: 'composer', image: 'composer',
tagConstraint: getConstraint(config), tagConstraint: getConstraint(constraints),
tagScheme: composerVersioningId, tagScheme: composerVersioningId,
}, },
}; };

3
lib/manager/composer/extract.ts
View file

@ -12,7 +12,6 @@ import type {
ComposerManagerData, ComposerManagerData,
Repo, Repo,
} from './types'; } from './types';
import { extractContraints } from './utils';
/** /**
* The regUrl is expected to be a base URL. GitLab composer repository installation guide specifies * The regUrl is expected to be a base URL. GitLab composer repository installation guide specifies
@ -116,8 +115,6 @@ export async function extractPackageFile(
res.registryUrls = registryUrls; res.registryUrls = registryUrls;
} }
res.constraints = extractContraints(composerJson, lockParsed);
const deps = []; const deps = [];
const depTypes = ['require', 'require-dev']; const depTypes = ['require', 'require-dev'];
for (const depType of depTypes) { for (const depType of depTypes) {

4
lib/manager/composer/utils.spec.ts
View file

@ -4,9 +4,7 @@ import { extractContraints, getConstraint } from './utils';
describe(getName(), () => { describe(getName(), () => {
describe('getConstraint', () => { describe('getConstraint', () => {
it('returns from config', () => { it('returns from config', () => {
expect(getConstraint({ constraints: { composer: '1.1.0' } })).toEqual( expect(getConstraint({ composer: '1.1.0' })).toEqual('1.1.0');
'1.1.0'
);
}); });
it('returns from null', () => { it('returns from null', () => {

4
lib/manager/composer/utils.ts
View file

@ -1,12 +1,10 @@
import { logger } from '../../logger'; import { logger } from '../../logger';
import { api, id as composerVersioningId } from '../../versioning/composer'; import { api, id as composerVersioningId } from '../../versioning/composer';
import type { UpdateArtifactsConfig } from '../types';
import type { ComposerConfig, ComposerLock } from './types'; import type { ComposerConfig, ComposerLock } from './types';
export { composerVersioningId }; export { composerVersioningId };
export function getConstraint(config: UpdateArtifactsConfig): string { export function getConstraint(constraints: Record<string, string>): string {
const { constraints = {} } = config;
const { composer } = constraints; const { composer } = constraints;
if (composer) { if (composer) {