renovate/lib/modules/manager/copier/artifacts.spec.ts

import type { Stats } from 'node:fs';
import upath from 'upath';
import { mockDeep } from 'vitest-mock-extended';
import { mockExecAll } from '~test/exec-util.ts';
import { fs, git, hostRules, partial } from '~test/util.ts';
import { GlobalConfig } from '../../../config/global.ts';
import type {
  InternalGlobalConfigOptions,
  RepoGlobalConfig,
} from '../../../config/types.ts';
import { logger } from '../../../logger/index.ts';
import type { StatusResult } from '../../../util/git/types.ts';
import * as _datasource from '../../datasource/index.ts';
import type { UpdateArtifactsConfig, Upgrade } from '../types.ts';
import { updateArtifacts } from './index.ts';

const datasource = vi.mocked(_datasource);

vi.mock('../../../util/fs/index.ts');
vi.mock('../../datasource/index.ts', () => mockDeep());

process.env.CONTAINERBASE = 'true';

const config: UpdateArtifactsConfig = {
  ignoreScripts: true,
};

const upgrades: Upgrade[] = [
  {
    depName: 'https://github.com/foo/bar',
    currentValue: '1.0.0',
    newValue: '1.1.0',
  },
];

const adminConfig: RepoGlobalConfig & InternalGlobalConfigOptions = {
  localDir: upath.join('/tmp/github/some/repo'),
  cacheDir: upath.join('/tmp/cache'),
  containerbaseDir: upath.join('/tmp/renovate/cache/containerbase'),
  allowScripts: false,
  binarySource: 'global',
};

describe('modules/manager/copier/artifacts', () => {
  beforeEach(() => {
    GlobalConfig.set(adminConfig);
    hostRules.clear();

    // Mock git repo status
    git.getRepoStatus.mockResolvedValue(
      partial<StatusResult>({
        conflicted: [],
        modified: ['.copier-answers.yml'],
        not_added: [],
        deleted: [],
        renamed: [],
      }),
    );
  });

  describe('updateArtifacts()', () => {
    it('returns null if newVersion is not provided', async () => {
      const execSnapshots = mockExecAll();

      const invalidUpgrade = [
        { ...upgrades[0], newValue: undefined, newVersion: undefined },
      ];

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: invalidUpgrade,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          artifactError: {
            fileName: '.copier-answers.yml',
            stderr: 'Missing copier template version to update to',
          },
        },
      ]);
      expect(execSnapshots).toEqual([]);
    });

    it('uses newValue for vcs-ref when both newValue and newVersion are provided', async () => {
      const execSnapshots = mockExecAll();

      const upgradeWithPrefixedTag = [
        {
          depName: 'https://github.com/foo/bar',
          currentValue: 'foobar-v1.0.0',
          newValue: 'foobar-v1.2.3',
          newVersion: '1.2.3',
        },
      ];

      await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgradeWithPrefixedTag,
        newPackageFileContent: '',
        config: {},
      });

      expect(execSnapshots).toMatchObject([
        {
          cmd: 'copier update --skip-answered --defaults --answers-file .copier-answers.yml --vcs-ref foobar-v1.2.3',
          options: {
            cwd: '/tmp/github/some/repo',
          },
        },
      ]);
    });

    it('reports an error if no upgrade is specified', async () => {
      const execSnapshots = mockExecAll();

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: [],
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          artifactError: {
            fileName: '.copier-answers.yml',
            stderr: 'Unexpected number of dependencies: 0 (should be 1)',
          },
        },
      ]);
      expect(execSnapshots).toEqual([]);
    });

    it('reports an error updated deps is undefined', async () => {
      const execSnapshots = mockExecAll();

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: null as never,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          artifactError: {
            fileName: '.copier-answers.yml',
            stderr:
              'Unexpected number of dependencies: undefined (should be 1)',
          },
        },
      ]);
      expect(execSnapshots).toEqual([]);
    });

    it('invokes copier update with the correct options by default', async () => {
      const execSnapshots = mockExecAll();

      await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config: {},
      });

      expect(execSnapshots).toMatchObject([
        {
          cmd: 'copier update --skip-answered --defaults --answers-file .copier-answers.yml --vcs-ref 1.1.0',
          options: {
            cwd: '/tmp/github/some/repo',
          },
        },
      ]);
    });

    it('propagates Git environment from hostRules', async () => {
      const execSnapshots = mockExecAll();

      hostRules.add({
        hostType: 'github',
        matchHost: 'github.com',
        token: 'abc123',
      });
      hostRules.add({
        hostType: 'git-tags',
        matchHost: 'gittags.com',
        username: 'git-tags-user',
        password: 'git-tags-password',
      });

      await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config: {},
      });

      expect(execSnapshots).toMatchObject([
        {
          cmd: 'copier update --skip-answered --defaults --answers-file .copier-answers.yml --vcs-ref 1.1.0',
          options: {
            cwd: '/tmp/github/some/repo',
            env: {
              GIT_CONFIG_COUNT: '6',
              GIT_CONFIG_KEY_0: 'url.https://ssh:abc123@github.com/.insteadOf',
              GIT_CONFIG_KEY_1: 'url.https://git:abc123@github.com/.insteadOf',
              GIT_CONFIG_KEY_2: 'url.https://abc123@github.com/.insteadOf',
              GIT_CONFIG_KEY_3:
                'url.https://git-tags-user:git-tags-password@gittags.com/.insteadOf',
              GIT_CONFIG_KEY_4:
                'url.https://git-tags-user:git-tags-password@gittags.com/.insteadOf',
              GIT_CONFIG_KEY_5:
                'url.https://git-tags-user:git-tags-password@gittags.com/.insteadOf',
              GIT_CONFIG_VALUE_0: 'ssh://git@github.com/',
              GIT_CONFIG_VALUE_1: 'git@github.com:',
              GIT_CONFIG_VALUE_2: 'https://github.com/',
              GIT_CONFIG_VALUE_3: 'ssh://git@gittags.com/',
              GIT_CONFIG_VALUE_4: 'git@gittags.com:',
              GIT_CONFIG_VALUE_5: 'https://gittags.com/',
            },
          },
        },
      ]);
    });

    it('invokes copier update with nested destination and answer file', async () => {
      const execSnapshots = mockExecAll();

      await updateArtifacts({
        packageFileName: 'apps/my-app/.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config: {},
      });

      expect(execSnapshots).toMatchObject([
        {
          cmd: 'copier update --skip-answered --defaults --answers-file .copier-answers.yml --vcs-ref 1.1.0',
          options: {
            cwd: '/tmp/github/some/repo/apps/my-app',
          },
        },
      ]);
    });

    it.each`
      pythonConstraint | copierConstraint
      ${null}          | ${null}
      ${'3.11.3'}      | ${null}
      ${null}          | ${'9.1.0'}
      ${'3.11.3'}      | ${'9.1.0'}
    `(
      `supports dynamic install with constraints python=$pythonConstraint copier=$copierConstraint`,
      async ({ pythonConstraint, copierConstraint }) => {
        GlobalConfig.set({ ...adminConfig, binarySource: 'install' });
        const constraintConfig = {
          python: pythonConstraint ?? '',
          copier: copierConstraint ?? '',
        };
        if (!pythonConstraint) {
          datasource.getPkgReleases.mockResolvedValueOnce({
            releases: [{ version: '3.12.4' }],
          });
        }
        if (!copierConstraint) {
          datasource.getPkgReleases.mockResolvedValueOnce({
            releases: [{ version: '9.2.0' }],
          });
        }
        const execSnapshots = mockExecAll();

        await expect(
          updateArtifacts({
            packageFileName: '.copier-answers.yml',
            updatedDeps: upgrades,
            newPackageFileContent: '',
            config: {
              ...config,
              constraints: constraintConfig,
            },
          }),
        ).resolves.not.toBeNull();

        expect(execSnapshots).toMatchObject([
          { cmd: `install-tool python ${pythonConstraint ?? '3.12.4'}` },
          { cmd: `install-tool copier ${copierConstraint ?? '9.2.0'}` },
          {
            cmd: 'copier update --skip-answered --defaults --answers-file .copier-answers.yml --vcs-ref 1.1.0',
          },
        ]);
      },
    );

    it('includes --trust when allowScripts is true and ignoreScripts is false', async () => {
      GlobalConfig.set({ ...adminConfig, allowScripts: true });
      const execSnapshots = mockExecAll();

      const trustConfig = {
        ...config,
        ignoreScripts: false,
      };

      await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config: trustConfig,
      });

      expect(execSnapshots).toMatchObject([
        {
          cmd: 'copier update --skip-answered --defaults --trust --answers-file .copier-answers.yml --vcs-ref 1.1.0',
        },
      ]);
    });

    it('does not include --trust when ignoreScripts is true', async () => {
      GlobalConfig.set({ ...adminConfig, allowScripts: true });
      const execSnapshots = mockExecAll();

      await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(execSnapshots).toMatchObject([
        {
          cmd: 'copier update --skip-answered --defaults --answers-file .copier-answers.yml --vcs-ref 1.1.0',
        },
      ]);
    });

    it('handles exec errors', async () => {
      mockExecAll(new Error('exec exception'));
      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          artifactError: {
            fileName: '.copier-answers.yml',
            stderr: 'exec exception',
          },
        },
      ]);
    });

    it('does not report changes if answers-file was not changed', async () => {
      mockExecAll();

      git.getRepoStatus.mockResolvedValueOnce(
        partial<StatusResult>({
          conflicted: [],
          modified: [],
          not_added: ['new_file.py'],
          deleted: ['old_file.py'],
          renamed: [],
        }),
      );

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(result).toBeNull();
    });

    it('returns updated artifacts if repo status has changes', async () => {
      mockExecAll();

      git.getRepoStatus.mockResolvedValueOnce(
        partial<StatusResult>({
          conflicted: [],
          modified: ['.copier-answers.yml'],
          not_added: ['new_file.py'],
          deleted: ['old_file.py'],
          renamed: [{ from: 'renamed_old.py', to: 'renamed_new.py' }],
        }),
      );

      fs.readLocalFile.mockResolvedValueOnce(
        '_src: https://github.com/foo/bar\n_commit: 1.1.0',
      );
      fs.readLocalFile.mockResolvedValueOnce('new file contents');
      fs.readLocalFile.mockResolvedValueOnce('renamed file contents');

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          file: {
            type: 'addition',
            path: '.copier-answers.yml',
            contents: '_src: https://github.com/foo/bar\n_commit: 1.1.0',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'new_file.py',
            contents: 'new file contents',
          },
        },
        {
          file: {
            type: 'deletion',
            path: 'old_file.py',
          },
        },
        {
          file: {
            type: 'deletion',
            path: 'renamed_old.py',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'renamed_new.py',
            contents: 'renamed file contents',
          },
        },
      ]);
    });

    it('marks files executable when the owner execute bit is set', async () => {
      mockExecAll();

      git.isFileModeEnabled.mockResolvedValue(true);
      git.getRepoStatus.mockResolvedValueOnce(
        partial<StatusResult>({
          conflicted: [],
          modified: ['.copier-answers.yml'],
          not_added: ['bin/deploy.sh'],
          deleted: [],
          renamed: [{ from: 'renamed_old.sh', to: 'renamed_new.sh' }],
        }),
      );

      fs.readLocalFile.mockResolvedValueOnce(
        '_src: https://github.com/foo/bar\n_commit: 1.1.0',
      );
      fs.readLocalFile.mockResolvedValueOnce('new script contents');
      fs.readLocalFile.mockResolvedValueOnce('renamed script contents');
      fs.statLocalFile.mockImplementation((path) =>
        Promise.resolve(
          partial<Stats>({
            isFile: () => true,
            mode: path === '.copier-answers.yml' ? 0o644 : 0o744,
          }),
        ),
      );

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          file: {
            type: 'addition',
            path: '.copier-answers.yml',
            contents: '_src: https://github.com/foo/bar\n_commit: 1.1.0',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'bin/deploy.sh',
            contents: 'new script contents',
            isExecutable: true,
          },
        },
        {
          file: {
            type: 'deletion',
            path: 'renamed_old.sh',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'renamed_new.sh',
            contents: 'renamed script contents',
            isExecutable: true,
          },
        },
      ]);
    });

    it('does not mark files executable if they cannot be inspected', async () => {
      mockExecAll();

      git.isFileModeEnabled.mockResolvedValue(true);
      git.getRepoStatus.mockResolvedValueOnce(
        partial<StatusResult>({
          conflicted: [],
          modified: ['.copier-answers.yml'],
          not_added: ['submodule'],
          deleted: [],
          renamed: [],
        }),
      );

      fs.readLocalFile.mockResolvedValueOnce(
        '_src: https://github.com/foo/bar\n_commit: 1.1.0',
      );
      fs.readLocalFile.mockResolvedValueOnce(null);
      fs.statLocalFile.mockImplementation((path) =>
        Promise.resolve(
          path === 'submodule'
            ? partial<Stats>({ isFile: () => false, mode: 0o744 })
            : null,
        ),
      );

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          file: {
            type: 'addition',
            path: '.copier-answers.yml',
            contents: '_src: https://github.com/foo/bar\n_commit: 1.1.0',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'submodule',
            contents: null,
          },
        },
      ]);
    });

    it('does not inspect file modes when file mode tracking is disabled', async () => {
      mockExecAll();

      git.isFileModeEnabled.mockResolvedValue(false);
      fs.readLocalFile.mockResolvedValueOnce(
        '_src: https://github.com/foo/bar\n_commit: 1.1.0',
      );

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(result).toEqual([
        {
          file: {
            type: 'addition',
            path: '.copier-answers.yml',
            contents: '_src: https://github.com/foo/bar\n_commit: 1.1.0',
          },
        },
      ]);
      expect(fs.statLocalFile).not.toHaveBeenCalled();
    });

    it('reports an error, but adds conflicts', async () => {
      mockExecAll();

      git.getRepoStatus.mockResolvedValueOnce(
        partial<StatusResult>({
          conflicted: ['conflict_file.py'],
          modified: ['.copier-answers.yml'],
          not_added: ['new_file.py'],
          deleted: ['old_file.py'],
          renamed: [],
        }),
      );

      fs.readLocalFile.mockResolvedValueOnce(
        '_src: https://github.com/foo/bar\n_commit: 1.1.0',
      );
      fs.readLocalFile.mockResolvedValueOnce('new file contents');
      fs.readLocalFile.mockResolvedValueOnce('conflict file contents');

      const result = await updateArtifacts({
        packageFileName: '.copier-answers.yml',
        updatedDeps: upgrades,
        newPackageFileContent: '',
        config,
      });

      expect(logger.debug).toHaveBeenCalledWith(
        {
          depName: 'https://github.com/foo/bar',
          packageFileName: '.copier-answers.yml',
        },
        'Updating the Copier template yielded 1 merge conflicts. Please check the proposed changes carefully! Conflicting files:\n  * conflict_file.py',
      );
      expect(result).toEqual([
        {
          artifactError: {
            fileName: '.copier-answers.yml',
            stderr:
              'Updating the Copier template yielded 1 merge conflicts. Please check the proposed changes carefully! Conflicting files:\n  * conflict_file.py',
          },
        },
        {
          file: {
            type: 'addition',
            path: '.copier-answers.yml',
            contents: '_src: https://github.com/foo/bar\n_commit: 1.1.0',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'new_file.py',
            contents: 'new file contents',
          },
        },
        {
          file: {
            type: 'addition',
            path: 'conflict_file.py',
            contents: 'conflict file contents',
          },
          notice: {
            file: 'conflict_file.py',
            message:
              'This file had merge conflicts. Please check the proposed changes carefully!',
          },
        },
        {
          file: {
            type: 'deletion',
            path: 'old_file.py',
          },
        },
      ]);
    });
  });
});