renovatebot_renovate/lib/modules/manager/composer/utils.spec.ts

import { mockDeep } from 'vitest-mock-extended';
import { GlobalConfig } from '../../../config/global';
import * as hostRules from '../../../util/host-rules';
import { Lockfile, PackageFile } from './schema';
import {
  extractConstraints,
  getComposerArguments,
  getComposerUpdateArguments,
  requireComposerDependencyInstallation,
} from './utils';

vi.mock('../../datasource', () => mockDeep());

describe('modules/manager/composer/utils', () => {
  beforeEach(() => {
    hostRules.clear();
  });

  describe('extractConstraints', () => {
    it('returns from require', () => {
      const file = PackageFile.parse({
        require: { php: '>=5.3.2', 'composer/composer': '1.1.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        php: '>=5.3.2',
        composer: '1.1.0',
      });
    });

    it('returns platform php version', () => {
      const file = PackageFile.parse({
        config: { platform: { php: '7.4.27' } },
        require: { php: '~7.4 || ~8.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        composer: '1.*',
        php: '<=7.4.27',
      });
    });

    it('returns platform 0 minor php version', () => {
      const file = PackageFile.parse({
        config: { platform: { php: '7.0.5' } },
        require: { php: '^7.0 || ~8.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        composer: '1.*',
        php: '<=7.0.5',
      });
    });

    it('returns platform 0 patch php version', () => {
      const file = PackageFile.parse({
        config: { platform: { php: '7.4.0' } },
        require: { php: '^7.0 || ~8.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        composer: '1.*',
        php: '<=7.4.0',
      });
    });

    it('returns platform lowest minor php version', () => {
      const file = PackageFile.parse({
        config: { platform: { php: '7' } },
        require: { php: '^7.0 || ~8.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        composer: '1.*',
        php: '<=7.0.0',
      });
    });

    it('returns platform lowest patch php version', () => {
      const file = PackageFile.parse({
        config: { platform: { php: '7.4' } },
        require: { php: '~7.4 || ~8.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        composer: '1.*',
        php: '<=7.4.0',
      });
    });

    it('returns from require-dev', () => {
      const file = PackageFile.parse({
        'require-dev': { 'composer/composer': '1.1.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({ composer: '1.1.0' });
    });

    it('returns from composer platform require', () => {
      const file = PackageFile.parse({
        require: { php: '^8.1', composer: '2.2.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({
        php: '^8.1',
        composer: '2.2.0',
      });
    });

    it('returns from composer platform require-dev', () => {
      const file = PackageFile.parse({ 'require-dev': { composer: '^2.2' } });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({ composer: '^2.2' });
    });

    it('returns from composer-runtime-api', () => {
      const file = PackageFile.parse({
        require: { 'composer-runtime-api': '^1.1.0' },
      });
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({ composer: '^1.1' });
    });

    it('returns from plugin-api-version', () => {
      const file = PackageFile.parse({});
      const lockfile = Lockfile.parse({ 'plugin-api-version': '1.1.0' });
      expect(extractConstraints(file, lockfile)).toEqual({
        composer: '^1.1',
      });
    });

    it('fallback to 1.*', () => {
      const file = PackageFile.parse({});
      const lockfile = Lockfile.parse({});
      expect(extractConstraints(file, lockfile)).toEqual({ composer: '1.*' });
    });
  });

  describe('getComposerArguments', () => {
    afterEach(() => {
      GlobalConfig.reset();
    });

    it('disables scripts and plugins by default', () => {
      expect(
        getComposerArguments({}, { toolName: 'composer', constraint: '1.*' }),
      ).toBe(
        ' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });

    it('disables platform requirements', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '1.*' },
        ),
      ).toBe(
        ' --ignore-platform-reqs --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });

    it('disables all platform requirements with 2.1.0', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '2.1.0' },
        ),
      ).toBe(
        ' --ignore-platform-reqs --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });

    it('disables only extension and library platform requirements with ^2.1', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '^2.1' },
        ),
      ).toBe(
        " --ignore-platform-req='ext-*' --ignore-platform-req='lib-*' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins",
      );
    });

    it('disables only extension and library platform requirements with 2.2.0', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '2.2.0' },
        ),
      ).toBe(
        " --ignore-platform-req='ext-*' --ignore-platform-req='lib-*' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins",
      );
    });

    it('disables only extension and library platform requirements with ^2.2', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '^2.2' },
        ),
      ).toBe(
        " --ignore-platform-req='ext-*' --ignore-platform-req='lib-*' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins",
      );
    });

    it('disables only extension and library platform requirements with 2.3.0', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '2.3.0' },
        ),
      ).toBe(
        " --ignore-platform-req='ext-*' --ignore-platform-req='lib-*' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins",
      );
    });

    it('disables only extension and library platform requirements with ^2.3', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: [],
          },
          { toolName: 'composer', constraint: '^2.3' },
        ),
      ).toBe(
        " --ignore-platform-req='ext-*' --ignore-platform-req='lib-*' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins",
      );
    });

    it('disables single platform requirement', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: ['ext-intl'],
          },
          { toolName: 'composer', constraint: '1.*' },
        ),
      ).toBe(
        ' --ignore-platform-req ext-intl --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });

    it('disables multiple platform requirement', () => {
      expect(
        getComposerArguments(
          {
            composerIgnorePlatformReqs: ['ext-intl', 'ext-icu'],
          },
          { toolName: 'composer', constraint: '1.*' },
        ),
      ).toBe(
        ' --ignore-platform-req ext-intl --ignore-platform-req ext-icu --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });

    it('allows scripts when configured', () => {
      GlobalConfig.set({
        allowScripts: true,
      });
      expect(
        getComposerArguments({}, { toolName: 'composer', constraint: '1.*' }),
      ).toBe(' --no-ansi --no-interaction --no-plugins');
    });

    it('disables scripts when configured locally', () => {
      GlobalConfig.set({
        allowScripts: true,
      });
      expect(
        getComposerArguments(
          {
            ignoreScripts: true,
          },
          { toolName: 'composer', constraint: '1.*' },
        ),
      ).toBe(
        ' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });

    it('allows plugins when configured', () => {
      GlobalConfig.set({
        allowPlugins: true,
      });
      expect(
        getComposerArguments({}, { toolName: 'composer', constraint: '1.*' }),
      ).toBe(' --no-ansi --no-interaction --no-scripts --no-autoloader');
    });

    it('disables plugins when configured locally', () => {
      GlobalConfig.set({
        allowPlugins: true,
      });
      expect(
        getComposerArguments(
          {
            ignorePlugins: true,
          },
          { toolName: 'composer', constraint: '1.*' },
        ),
      ).toBe(
        ' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
      );
    });
  });

  describe('getComposerUpdateArguments', () => {
    it.each`
      constraint
      ${'2.6.0'}
      ${'<=2.6'}
      ${'<2.7'}
    `(
      'does not request an update with minimal changes with $constraint',
      ({ constraint }) => {
        expect(
          getComposerUpdateArguments({}, { toolName: 'composer', constraint }),
        ).toBe(
          ' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins',
        );
      },
    );

    it.each`
      constraint
      ${'2.7.0'}
      ${'2.8.0'}
      ${'3.0.0'}
      ${'^2.6'}
      ${'^2.7'}
      ${'^2.8'}
      ${'^3.0'}
      ${'>=2.6'}
      ${'>=2.7'}
      ${'>=2.8'}
      ${'>=3.0'}
    `(
      'requests an update with minimal changes with $constraint',
      ({ constraint }) => {
        expect(
          getComposerUpdateArguments({}, { toolName: 'composer', constraint }),
        ).toBe(
          ' --no-ansi --no-interaction --no-scripts --no-autoloader --no-plugins --minimal-changes',
        );
      },
    );
  });

  describe('requireComposerDependencyInstallation', () => {
    it('returns true when symfony/flex has been installed', () => {
      const lockfile = Lockfile.parse({
        packages: [{ name: 'symfony/flex', version: '1.17.1' }],
      });
      expect(requireComposerDependencyInstallation(lockfile)).toBeTrue();
    });

    it('returns true when symfony/flex has been installed as dev dependency', () => {
      const lockfile = Lockfile.parse({
        'packages-dev': [{ name: 'symfony/flex', version: '1.17.1' }],
      });
      expect(requireComposerDependencyInstallation(lockfile)).toBeTrue();
    });

    it('returns false when symfony/flex has not been installed', () => {
      const lockfile = Lockfile.parse({
        packages: [{ name: 'symfony/console', version: '5.4.0' }],
      });
      expect(requireComposerDependencyInstallation(lockfile)).toBeFalse();
    });
  });
});